sporada/nopaque
1
0
Fork 0
mirror of https://gitlab.ub.uni-bielefeld.de/sfb1288inf/nopaque.git synced 2024-12-24 10:34:17 +00:00
Code Issues Projects Releases Wiki Activity

Add information about securing the docker API in README

Browse Source
This commit is contained in:
Patrick Jentsch 2020-01-07 15:07:08 +01:00
parent 08a277d967
commit 3532fdc8a4
1 changed files with 3 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -20,8 +20,7 @@ As a last step texts can be loaded into an information retrieval system to query
1. **Create Docker swarm:** 1. **Create Docker swarm:**
The generated computational workload is handled by a [Docker](https://docs.docker.com/) swarm. A swarm is a group of machines that are running Docker and joined into a cluster. It consists out of two different kinds of members, managers and workers. Currently it is not possible to specify a dedicated Docker host, instead Opaque expects the executing system to be a swarm manager of a cluster with at least one dedicated worker machine. The swarm setup process is described best in the [Docker documentation](https://docs.docker.com/engine/swarm/swarm-tutorial/). The generated computational workload is handled by a [Docker](https://docs.docker.com/) swarm. A swarm is a group of machines that are running Docker and joined into a cluster. It consists out of two different kinds of members, managers and workers. Currently it is not possible to specify a dedicated Docker host, instead Opaque expects the executing system to be a swarm manager of a cluster with at least one dedicated worker machine. The swarm setup process is described best in the [Docker documentation](https://docs.docker.com/engine/swarm/swarm-tutorial/).
2. **Create a network storage:**
2. **Create a network storage**
A shared network space is necessary so that all swarm members have access to all the data. To achieve this a [Samba](https://www.samba.org/) can be used. A shared network space is necessary so that all swarm members have access to all the data. To achieve this a [Samba](https://www.samba.org/) can be used.
``` bash ``` bash
# Example: Create a Samba share via Docker # Example: Create a Samba share via Docker
@ -36,25 +35,22 @@ $ docker run \
-s storage.nopaque;/srv/nopaque/storage;no;no;no;nopaque \ -s storage.nopaque;/srv/nopaque/storage;no;no;no;nopaque \
-u nopaque;nopaque -u nopaque;nopaque
# Mount the Samba share on all swarm member nodes with the following code # Mount the Samba share on all swarm member nodes with the following code
$ sudo mkdir /mnt/nopaque $ sudo mkdir /mnt/nopaque
$ sudo mount --types cifs --options gid=${USER},password=nopaque,uid=${USER},user=nopaque,vers=3.0 //<YOUR IP>/storage.nopaque /mnt/nopaque $ sudo mount --types cifs --options gid=${USER},password=nopaque,uid=${USER},user=nopaque,vers=3.0 //<YOUR IP>/storage.nopaque /mnt/nopaque
``` ```
3. **Download Opaque** 3. **Download Opaque**
``` bash ``` bash
$ git clone https://gitlab.ub.uni-bielefeld.de/sfb1288inf/opaque.git $ git clone https://gitlab.ub.uni-bielefeld.de/sfb1288inf/opaque.git
$ cd opaque $ cd opaque
$ docker-compose pull $ docker-compose pull
``` ```
4. **Configure your instance:**
4. **Configure your instance** For production environments it is recommended to activate and secure the Docker HTTP API. You can read more [here](https://gitlab.ub.uni-bielefeld.de/sfb1288inf/opaque_daemon).
``` bash ``` bash
$ cp nopaque.env.tpl nopaque.env $ cp nopaque.env.tpl nopaque.env
$ <YOUR EDITOR> nopaque.env # Fill out the empty variables within this file. $ <YOUR EDITOR> nopaque.env # Fill out the empty variables within this file.
``` ```
5. **Start your instance** 5. **Start your instance**
``` bash ``` bash
# Execute the following 3 steps only on first startup # Execute the following 3 steps only on first startup