medAL-suite documentation

User Tools

Site Tools

Trace:
medal-hub

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
medal-hub [2021/12/16 14:49] – arnaud_polettomedal-hub [2022/01/14 16:27] (current) – Alan Vonlanthen
Line 1: Line 1:
 ====== medAL-hub Documentation ====== ====== medAL-hub Documentation ======
  
-==== About medAL-hub  ==== +The purpose of medAL-//hub// is 3-fold: 
- +
-The purpose of medAL-hub is 3-fold: +
   - Relay between the tablets, thus allowing to start a consultation on a tablet and finish it on another one (client-server).   - Relay between the tablets, thus allowing to start a consultation on a tablet and finish it on another one (client-server).
   - Local database for the clinical data.   - Local database for the clinical data.
-  - Hub for the data synchronisation with the National server (medAL-data) . +  - Hub for the data synchronisation with the National server (medAL-//data//).
- +
- +
- +
- +
-==== medAL-hub Installation ==== +
- +
-=== Prerequisite === +
- +
-Follow the procedure given in [[internet-setup|Internet setup]]. At this point, you should be able to connect to the following Wi-Fi network: \\ +
-ssid: //health_facility_dynamic// \\ +
-password: //SbqCdzBoW8amSx// \\ +
-If your setup does not allow you to have direct access to the internet using the above network, you should still be able to connect to the following mobile network regularly: \\ +
-ssid: //mobile_dynamic// \\ +
-password: //yicoxZ8afL2MX6// +
- +
- +
- +
- +
-=== Material === +
- +
-You will need the following material: +
-  * Raspberry PI 4 (For convenience and ease, it will be shortened to RasPi [[https://www.amazon.com/dp/B07TC2BK1X]] +
-  * A MicroSD card [[https://www.amazon.com/dp/B06XWMQ81P]] +
-  * An SD card reader for the PC [[https://www.amazon.com/dp/B07G5JV2B5]] +
-  * An HDMI to micro-HDMI cable (NOT mini) [[https://www.amazon.com/dp/B00Z07JYLE]] +
-  * A PowerBank (5Vx3A (15W) output) [[https://www.amazon.com/dp/B01JIWQPMW]] +
-  * A Power Adapter (USB + Power) [[https://www.amazon.com/dp/B07K1K1F65]] +
-  * An internet connection (either cable or Wi-Fi) +
-  * A PC connected to internet, with admin rights +
-  * A screen with HDMI connection +
-  * A USB keyboard +
- +
- +
- +
- +
-=== SD Card Setup === +
- +
-  - Download and open BalenaEtcher from: https://www.balena.io/etcher/ +
-  - Download the HypriotOS image: https://blog.hypriot.com/downloads/  +
-  - Plug in your SD card inside the SD card reader. +
-  - In BalenaEtcher, click on //Flash from file// and select the HypriotOS image. +
-  - Click on //Select target// and select your SD card. +
-  - Click on //Flash!//, and wait until the flash is complete. +
- +
- +
- +
- +
-=== RasPI Setup === +
- +
-  - Put the SD card back in the RasPI. +
-  - Connect the RasPI to the following: +
-    * HDMI (0) \\ {{::raspi_hdmi_connect.jpg?400|}} +
-    * Ethernet (if present) +
-    * A Keyboard +
-    * A Screen +
-    * The PowerBank +
-  - Wait until you see “login” and a blinking underscore (after about 4 minutes). That means you are ready to start. If no login then repeat steps above. +
- +
-=== Wi-Fi Setup === +
- +
-Enter the credentials (press //Enter// between each and be careful: **the keyboard is UK by default**): \\ +
-Username: //pirate// \\ +
-Password: //hypriot// +
- +
-The next step is to create the ''wpa_supplicant.conf'' file that contains the SSIDs and passwords (do not forget the ''–a'' option for the second execution of the tee command). Make sure that you already set up the router and Wi-Fi as explained in section Set up router and Wi-Fi and configure username and password.  +
- +
-<code>wpa_passphrase health_facility_dynamic SbqCdzBoW8amSx | sudo tee /etc/wpa_supplicant.conf</code> +
- +
-If you are configuring the hub for an offline facility, also add the following line:  +
-<code>wpa_passphrase mobile_dynamic yicoxZ8afL2MX6 | sudo tee –a /etc/wpa_supplicant.conf</code> +
- +
-After that, we have to give a name to each of the network configurations. In order to do that, open ''/etc/wpa_supplicant.conf'': +
-<code>sudo nano /etc/wpa_supplicant.conf </code> +
- +
-And add the two ''id_str'' lines (do not change the rest of the content): +
-<code>network={ +
- ssid=”health_facility_dynamic” +
- #psk=”...” +
- psk=… +
- id_str=”hf” +
-} +
-network={ +
- ssid=”mobile_dynamic” +
- #psk=”...” +
- psk=… +
- id_str=”mobile” +
-} +
-</code> +
- +
-Save file using 1. //Ctrl-X// 2. Confirm //Y// 3. Press //Enter// +
-After that, we have to link the ''wpa_supplicant.conf'' configuration to the wlan0 interface. Open ''/etc/network/interfaces'': +
-<code>sudo nano /etc/network/interfaces</code> +
- +
-And edit the file to make it exactly as below: +
-<code> +
-#source /etc/network/interfaces.d/* +
- +
-allow-hotplug wlan0 +
-iface wlan0 inet manual +
-wpa-roam /etc/wpa_supplicant.conf +
- +
-iface hf inet dhcp  +
-iface mobile inet dhcp +
-</code> +
- +
-Save file using 1. //Ctrl-X// 2. Confirm //Y// 3. Press //Enter// +
- +
-After that, we can activate the wlan0 interface: +
-<code>sudo ifup wlan0</code> +
- +
-Make sure to save the changes and reboot: +
-<code>sudo shutdown –r now</code> +
- +
-The device should now be connected to the internet.  Run: +
-<code>sudo ping google.com </code> +
- +
-in order to verify this. (//Ctrl-C// to exit ''ping'' command). +
-Now that the connection is established, we have to take note of some of the connection details in order to establish a connection with a static IP. Run: +
-<code>ifconfig</code> +
- +
-and take note of the following values (under wlan0 interface) +
-  * inet +
-  * netmask +
-  * broadcast  +
-These values will be useful later. Run: +
-<code>cat /etc/resolv.conf </code> +
- +
-And take note of the nameserver address (the first address that appears). +
-Run: +
-<code>sudo nano /etc/network/interfaces </code> +
- +
-Make the necessary changes (under hf interface):  +
-<code>#source /etc/network/interfaces.d/* +
- +
-allow-hotplug wlan0 +
-iface wlan0 inet manual +
-wpa-roam /etc/wpa_supplicant.conf +
- +
-iface hf inet static +
- address 178.17.54.136 +
- netmask 255.255.255.0 +
- network 178.17.54.0 +
- broadcast 178.17.54.255 +
- gateway 178.17.54.1 +
- dns-nameservers 178.17.54.1 +
-iface mobile inet dhcp  +
-</code> +
- +
-Replace the relevant values with the ones from the previous step. The ''network'' value is the bitwise AND of ''address'' and ''netmask''. The ''gateway'' value is usually the ''network'' value with a 1 at the end. The ''dns-nameservers'' address is the address that we saw in ''/etc/resolv.conf''. +
- +
-Make sure to save the changes and reboot: +
-<code>sudo shutdown –r now</code> +
- +
-The connection should now be established (again). +
- +
- +
- +
- +
-=== Application Setup === +
- +
-Clone the repository and checkout the ''master'' branch: +
-<code>git clone https://bitbucket.org/wavemind_swiss/liwi-local-data.git +
-cd liwi-local-data +
-git checkout master  +
-</code> +
- +
-Create the environment file: +
-<code>cp .env.example .env +
-nano .env +
-</code> +
- +
-And set the health facility ID to the desired value by updating the ''HEALTH_FACILITY_ID'' variable: +
-<code> +
-sudo nano .env +
-</code> +
-Save file using 1. //Ctrl-X// 2. Confirm //Y// 3. Press //Enter// +
- +
-Install //nginx//, //php// and other requirements: +
-<code> +
-sudo apt update +
-sudo apt upgrade +
-sudo apt install nginx php composer php-zip php-xml php-fpm php-pgsql +
-</code> +
- +
-Restart: +
-<code>sudo shutdown –r now</code> +
- +
-Start the docker container, install pendencies and prepare the database: +
-<code>docker-compose up –d +
-composer install +
-php artisan key:generate +
-php artisan migrate +
-</code> +
- +
-Open the nginx configuration file: +
-<code>sudo nano /etc/nginx/nginx.conf</code> +
- +
-And insert the following server block (right after the //# Virtual Host Configs//): \\ +
-The two ''#include'' statements after the server block should be commented out. +
-<code> +
-#include /etc/nginx/conf.d/*.conf; +
-#include /etc/nginx/sites-enabled/*; +
-server { +
-        listen 80; +
-       listen 443 ssl; +
-        ssl_certificate /home/pirate/liwi-local-data/docker-compose/nginx/srv.crt; +
-        ssl_certificate_key /home/pirate/liwi-local-data/docker-compose/nginx/srv.key; +
-        #server_name example.com; +
-        root /home/pirate/liwi-local-data/public; +
-        add_header X-Frame-Options "SAMEORIGIN"; +
-        add_header X-Content-Type-Options "nosniff"; +
-        index index.php; +
-        charset utf-8; +
-        location / { +
-            try_files $uri $uri/ /index.php?$query_string; +
-        } +
-        location = /favicon.ico { access_log off; log_not_found off; } +
-        location = /robots.txt  { access_log off; log_not_found off; } +
-        error_page 404 /index.php; +
-        client_max_body_size 0; +
-        location ~ \.php$ { +
-            fastcgi_pass unix:/var/run/php/php7.3-fpm.sock; +
-            fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name; +
-            include fastcgi_params; +
-        } +
-        location ~ /\.(?!well-known).* { +
-            deny all; +
-        } +
-    }  +
-</code> +
- +
-We can verify that the nginx configuration is valid using the following command: +
-<code>sudo nginx -t</code> +
- +
-After that, we have to change the permissions of the project folder so that each component of the application (the web server and the database) can access the required files: +
-<code>sudo chown -R www-data:www-data /home/pirate/liwi-local-data +
-sudo chown -R root:root /home/pirate/liwi-local-data/postgres-data +
-sudo usermod -a -G www-data pirate +
-</code> +
- +
-Restart the docker container: +
-<code>docker-compose down +
-docker-compose up -d +
-</code> +
- +
-Restart nginx: +
-<code>sudo systemctl restart nginx</code> +
- +
-Go to [[http://<server-ip>/api/medical_cases]] and make sure the server is running (it should return an error 406 //"API is only willing to format data as application\/json"//) +
- +
- +
- +
- +
-==== medAL-hub Maintenance Setup ==== +
- +
-=== Update Script === +
- +
-We are now going to create a script to update the application from the git repository: +
-<code> +
-touch ~/update.sh +
-chmod +x ~/update.sh +
-nano ~/update.sh +
-</code> +
- +
-The content of the script should look like this:  +
-<code> +
-#!/bin/sh +
-cd /home/pirate/liwi-local-data +
-docker-compose down +
-git pull +
-docker-compose up -d  +
-composer install +
-php artisan key:generate +
-php artisan migrate +
-</code> +
- +
- +
- +
- +
-=== Crontab Setup === +
- +
-We need to configure cron jobs so that Laravel can run synchronization jobs and that the update script gets executed everyday.  +
-Open crontab: +
-<code>sudo crontab –e</code>+
  
-And add the following jobs: 
-<code> 
-* * * * * php /home/pirate/liwi-local-data/artisan schedule:run 
-30 16 * * * /home/pirate/update.sh >> /home/pirate/update.log 2>&1 
-</code> 
  
-The exact time of the update can be adjusted based on the health facility requirements (in this example it is set to update at 16:30 everyday). 
  
  
 +===== medAL-hub Setup and Management =====
  
 +  * [[medal-hub:setup|medAL-hub setup]]
 +  * [[medal-hub:step-ca-setup|medAL-hub self-signed certificates setup]]
  
-=== Sync Configuration === 
  
-Open the configuration file for synchronization: 
-<code>sudo nano config/synchronization.php</code>  
  
-And choose the appropriate configuration options. 
  
-  * ''offline_mode'' and ''daily_sync_time'' +===== medAL-hub User Guide and Troubleshooting =====
-    * Choose ''false'' for ''offline_mode'' if a reliable connection is expected to be available throughout the day. In that case, the hub makes one attempt of pushing the cases to main data every day at a fixed time. The exact time at which the synchronization happens can be configured with ''daily_sync_time''.  +
-    * Choose ''true'' if a reliable connection is only available from time to time, e.g. during a few minutes each day. In that case, the hub will attempt to push the cases as soon as a connection can be established with the main data server. +
-  * ''sync_url'' and ''sync_domain'' +
-    * These values are used to reach the main data server. +
-  * ''offline_outofsync_thr'' and ''online_outofsync_thr'' +
-    * This value is the number of hours after which the cases are considered out-of-sync (starting from creation time). Synchronization will be triggered as soon as any closed case is out-of-sync and connection is available. The value for online mode should to be much higher than the one for offline mode because a reliable connection is expected to be available in online mode. For this reason, cases in online mode only become out-of-sync when the daily scheduled synchronization cannot take place for some reason.+
  
 +  * [[medal-hub:user-guide| medAL-hub user guide]]
 +  * [[medal-hub:troubleshooting-guide| medAL-hub troubleshooting guide]]
  
  
 +===== medAL-hub Data Sync Schedule =====
 +There are 2 scripts on the hub for syncing:
 +  - script #1 runs everyday at 4PM and sends all the cases closed but unsynced to the server
 +  - script #2 runs every minute and sends all the cases closed for more than 25 hours that have not yet been sent to the server
 +  * huge caveat :!:: the raspberry pi does not have a physical clock. Meaning, everytime it loses power, it does not know what time it is until it gets the time from the internet
  
-=== Synchronization Using a Mobile Hotspot (Offline facilities) === 
-In the case where no connection is available at the health facility, it is possible to perform a synchronization with the help of a mobile phone with a mobile internet connection that can act as a hotspot. The procedure is the following: 
-  - Check that the hotspot is already configured with the ssid and the password specified in ''wpa_supplicant.conf''. The raspberry will automatically connect to a network with this configuration. 
-  - As soon as the connection is established, the hub will push the cases to the main server. 
-  - In order to make sure that the transaction completed successfully, logs are available under ''liwi_local_data/storage/logs/laravel.log'': \\ <code>sudo nano liwi_local_data/storage/logs/laravel.log</code> You should see at the end of the export: \\ <code>Upload successful!</code> 
  
  
  
  
-DELETEME 
-== Credentials == 
-  * HypriotOS credentials: \\ username: //pirate// \\ password: //hypriot// 
-  * Local router's network credentials: \\ ssid: //health_facility_dynamic// \\ password: //SbqCdzBoW8amSx// 
-  * Mobile hotspot's network credentials: \\ ssid: //mobile_dynamic// \\ password_ //yicoxZ8afL2MX6// 
  
  
  
medal-hub.1639662578.txt.gz · Last modified: 2021/12/16 14:49 by arnaud_poletto