verbis-admin
/
bridgehead
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated Readme

This commit is contained in:
Patrick Skowronek 2022-01-10 14:32:40 +01:00
parent 33b2c80aa8
commit 77773a0990
1 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -2,41 +2,43 @@
This repository contains all information and tools to deploy a bridgehead. If you have any questions about deploying a bridgehead, please contact us. This repository contains all information and tools to deploy a bridgehead. If you have any questions about deploying a bridgehead, please contact us.
There are some prerequisites, which need to be meet befor starting a bridgehead. If you runnig a Windows or Mac OS maschine you should read starting a bridgehead. If you running a Linux maschine you can do start and install a bridgehead. There are some prerequisites, which need to be meet befor starting a bridgehead. If you runnig a Windows or Mac OS maschine you should read starting a bridgehead. If you running a Linux maschine you can start or install a bridgehead.
## Starting
## Install ## Setup
Create the dir /src/docker and clone the repository. Clone this repository to /srv/docker
The first step is to copy the site.conf file. It contains some configuration and secrets for your bridgehead. The first step is to copy the site.conf . It contains some configuration and secrets for your bridgehead.
With cp site.dev.conf site.conf you can clone the template. You need to set the project accoriding to the which bridgehead you want to start. It's either a GBN/BBMRI-ERIC, DKTK or C4 Bridgehead. With cp site.dev.conf site.conf you can clone the template. You need to set the project accoriding to the which bridgehead you want to start. It's either a GBN/BBMRI-ERIC, DKTK or C4 Bridgehead.
In this file you can put important varibales Each Project needs it own .env file where all the settings are located. Each Project has a template for it in there respective folder. We offer you to setup the file with and also to manage it.
### DKTK ### DKTK
For DKTK set in the site.conf the project to "dkkt". Also you need to set many settings in the env file. For the API keys for the psuenomisation you need to contact the Mainzelliste Team.
### GBA/BBMRI-ERIC ### GBA/BBMRI-ERIC
For an GBN/BBMRI-ERIC deployment set the project to gbn. When you already deployed a bridgehead you can reuse the env file for it.
### C4 ### C4
The following vairbales need to be set For C4 project it is similar to DKTK. Set the ldm_base_url in the configuration table to null.
C4_SAMPLY_STORE_PASS ### Git repository
C4_CONNECTOR_POSTGRES_PASSWORD
If you already have a git config repositpory you can clone it with
The next step is creating a configuration for your bridghead. We can provide you a configuration git repository for bridgehead, just ask us. When you have a DKTK or C4 Bridgehead you propably need some configuration from us anyways.
git submodule add -f https://"$git_username":"$git_access_token"@code.mitro.dkfz.de/scm/bd/"$site_name_lowercase"-config.git ./site-config git submodule add -f https://"$git_username":"$git_access_token"@code.mitro.dkfz.de/scm/bd/"$site_name_lowercase"-config.git ./site-config
If you want to manage the configuration your self you need to copy a env file from the respective project folder into a site-config folder. ## Starting your bridgehead
Step 3 is determind your prefered start method. You can can just start the docker container with start-bridgehead and stop it. Alternatively, we advice to use the install script. This script add a systemd service to your system which starts the bridgehead, it also stops and starts the system in the event of a reboot. Also it contains a service for automatic updating your bridgehead. It will check at 3:00 am if there are any updates and will apply them. There two methods to start the bridgehead. For Windows, Linux and Mac OS you can use the start-bridgehead.sh to deploy it wit docker-compose. If will also check some other setting of your system.
Step 4 is checking your bridgehead. The second methods is using the systemd management tool you start, stop and update your bridgehead.
Just run the install-bridgehead and thats it.