diff --git a/README.md b/README.md index a5549bda..35d9d06f 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ nopaque bundles various tools and services that provide humanities scholars with ## Prerequisites and requirements -1. Install docker for your system. Following the official instructions. (LINK) -2. Install docker-compose. Following the official instructions. (LINK) +1. Install docker for your system. Following the official instructions. +2. Install docker-compose. Following the official instructions. ## Configuration and startup @@ -20,19 +20,18 @@ A shared network space is necessary so that all swarm members have access to all ``` bash # Example: Create a Samba share via Docker # More details can be found under https://hub.docker.com/r/dperson/samba/ -username@hostname:~$ sudo mkdir -p /srv/nopaque/storage +username@hostname:~$ sudo mkdir -p /srv/samba/nopaque username@hostname:~$ docker run \ --name opaque_storage \ - -v /srv/nopaque/storage:/srv/nopaque/storage \ + -v /srv/samba/nopaque:/srv/samba/nopaque \ + -p 139:139 \ -p 445:445 \ dperson/samba \ - -p \ - -s storage.nopaque;/srv/nopaque/storage;no;no;no;nopaque \ - -u nopaque;nopaque + -p -s "nopaque;/srv/samba/nopaque;no;no;no;nopaque" -u "nopaque;nopaque" # Mount the Samba share on all swarm nodes (managers and workers) username@hostname:~$ sudo mkdir /mnt/nopaque -username@hostname:~$ sudo mount --types cifs --options gid=${USER},password=nopaque,uid=${USER},user=nopaque,vers=3.0 ///storage.nopaque /mnt/nopaque +username@hostname:~$ sudo mount --types cifs --options gid=${USER},password=nopaque,uid=${USER},user=nopaque,vers=3.0 ///nopaque /mnt/nopaque ``` ### **Download, configure and build nopaque** @@ -43,28 +42,17 @@ username@hostname:~$ git clone https://gitlab.ub.uni-bielefeld.de/sfb1288inf/nop username@hostname:~$ cp .env.tpl .env # Fill out the variables within this file. username@hostname:~$ .env -username@hostname:~$ cp docker-compose.override.yml.tpl docker-compose.override.yml -# Tweak the docker-compose.override.yml to satisfy your needs. +username@hostname:~$ touch docker-compose.override.yml +# Tweak the docker-compose.override.yml to satisfy your needs. (You can find examples in docker-compose..yml) username@hostname:~$ docker-compose.override.yml # Build docker images username@hostname:~$ docker-compose build ``` -#### Configuration variables in detail - -The variables prefixed with **DOCKER** should only be filled out if you want to use the Docker HTTP API. Check the [Docker Documentation](https://docs.docker.com/engine/security/https/) to see how to create certificates, configure and activate the Docker HTTP API. - -The variables prefixed with **GITLAB** hold your login information of this GitLab instance. Either use your credentials (not recommended) or create an access token with the read_registry scope. - -The value of the **NOPAQUE_MAIL_SENDER** variable is shown as a sender of emails generated by nopaque. - -On registration the email address stored in the **NOPAQUE_ADMIN** variable will automatically be granted the administrator role. - -The email address stored in **NOPAQUE_CONTACT** will be used within the contact button of the footer within the websites. - - ### Start your instance ``` bash +# Create log files +touch nopaque.log nopaqued.log # For background execution add the -d flag and to scale the app, add --scale web= username@hostname:~$ docker-compose up ```