Merge pull request #27 from samply/feature/documentation

Update README.md
This commit is contained in:
DavidCroftDKFZ 2022-10-28 16:44:15 +02:00 committed by GitHub
commit 8c239afaec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 5 deletions

View File

@ -20,6 +20,7 @@ TOC
- [docker](#dockerhttpsdocsdockercomget-docker) - [docker](#dockerhttpsdocsdockercomget-docker)
- [systemd](#systemd) - [systemd](#systemd)
2. [Getting Started](#getting-started) 2. [Getting Started](#getting-started)
- [Quick Start](#quick-start)
- [DKTK](#dktkc4) - [DKTK](#dktkc4)
- [C4](#c4) - [C4](#c4)
- [GBA/BBMRI-ERIC](#gbabbmri-eric) - [GBA/BBMRI-ERIC](#gbabbmri-eric)
@ -132,7 +133,8 @@ If systemd is not installed, you can start the bridgehead. However, for producti
## Getting Started ## Getting Started
### Installation ### Quick Start
If your system passed all checks from ["Requirements" section], you are now ready to download the bridgehead. If your system passed all checks from ["Requirements" section], you are now ready to download the bridgehead.
@ -145,10 +147,6 @@ sudo git clone https://github.com/samply/bridgehead.git /srv/docker/bridgehead;
It is recomended to create a user for the bridgehead service. This should be done after clone the repository. Since not all linux distros support ```adduser```, we provide an action for the systemcall ```useradd```. You should try the first one, when the systm can't create the user you should try the second one. It is recomended to create a user for the bridgehead service. This should be done after clone the repository. Since not all linux distros support ```adduser```, we provide an action for the systemcall ```useradd```. You should try the first one, when the systm can't create the user you should try the second one.
``` shell
adduser --no-create-home --disabled-login --ingroup docker --gecos "" bridgehead
```
``` shell ``` shell
useradd -M -g docker -N -s /sbin/nologin bridgehead useradd -M -g docker -N -s /sbin/nologin bridgehead
``` ```
@ -158,6 +156,25 @@ After adding the User you need to change the ownership of the directory to the b
``` shell ``` shell
chown bridgehead /srv/docker/bridgehead/ -R chown bridgehead /srv/docker/bridgehead/ -R
``` ```
Download the configuration repository:
``` shell
sudo git clone https://github.com/samply/bridgehead-config.git -b fix/bbmri-config /etc/bridgehead;
```
Change ownership:
``` shell
chown bridgehead /etc/bridgehead/ -R
```
Modify SITE_ID and SITE_NAME in bbmri.conf
RUN:
```shell
sudo /etc/bridgehead/bridgehead enroll bbmri
```
```shell
sudo /srv/docker/bridgehead/bridgehead start bbmri
```
### Configuration ### Configuration