Changes for Directory sync PR 53

* Change docker-compose.yml to reduce the number of environment
  variables being passed to Directory sync.
* Improve documentation.
This commit is contained in:
Croft 2023-03-14 09:59:37 +01:00
parent 068125c062
commit bedad57f41
2 changed files with 4 additions and 19 deletions

View File

@ -133,11 +133,11 @@ Your Bridgehead's actual data is not stored in the above directories, but in nam
### Directory sync
This is an optional feature for bbmri projects. It keeps the [BBMRI Directory](https://directory.bbmri-eric.eu/) up to date with the number of samples, etc. kept in your biobank. It also updates the local FHIR store with the latest contact details etc. from the Directory. You must explicitly enable this feature if you want to make use of it.
This is an optional feature for bbmri projects. It keeps the [BBMRI Directory](https://directory.bbmri-eric.eu/) up to date with your local data eg. number of samples. It also updates the local FHIR store with the latest contact details etc. from the Directory. You must explicitly set your country specific directory url, username and password to enable this feature.
Full details can be found in [directory_sync_service](https://github.com/samply/directory_sync_service).
To enable it, you will need to add some extra variables to the ```bbmri.conf``` file in your GitLab repository, for example:
To enable it, you will need to set these variables to the ```bbmri.conf``` file of your GitLab repository. Here is an example config:
```
### Directory sync service
@ -148,21 +148,9 @@ DS_TIMER_CRON="0 22 * * *"
```
You must contact the Directory for your national node to find the URL, and to register as a user.
Additionally, you should choose when you want Directory sync to run. In the example above, this is set to happen at 10 pm every evening. You can modify this to suit your requirements. The timer specification should follow the cron convention.
Additionally, you should choose when you want Directory sync to run. In the example above, this is set to happen at 10 pm every evening. You can modify this to suit your requirements. The timer specification should follow the [cron](https://crontab.guru) convention.
Once you have made the changes, update your local configuration:
```shell
cd /etc/bridgehead
sudo git pull
sudo chown -R bridgehead * .git*
```
Then restart the Bridgehead:
```shell
sudo systemctl restart bridgehead@bbmri.service
```
Once you edited the gitlab config. The bridgehead will autoupdate the config with the values and will sync the data.
There will be a delay before the effects of Directory sync become visible. First, you will need to wait until the time you have specified in ```TIMER_CRON```. Second, the information will then be synchronized from your national node with the central European Directory. This can take up to 24 hours.

View File

@ -110,10 +110,7 @@ services:
DS_DIRECTORY_URL: ${DS_DIRECTORY_URL}
DS_DIRECTORY_USER_NAME: ${DS_DIRECTORY_USER_NAME}
DS_DIRECTORY_PASS_CODE: ${DS_DIRECTORY_PASS_CODE}
DS_FHIR_STORE_URL: "http://bridgehead-bbmri-blaze:8080"
DS_TIMER_CRON: ${DS_TIMER_CRON}
DS_RETRY_MAX: ${DS_RETRY_MAX}
DS_RETRY_INTERVAL: ${DS_RETRY_INTERVAL}
volumes:
blaze-data: