From dd2fcaa28da111ec3373d8b920cb46eaf632a10a Mon Sep 17 00:00:00 2001
From: Patrick Jentsch <p.jentsch@uni-bielefeld.de>
Date: Mon, 26 Aug 2019 10:26:37 +0200
Subject: [PATCH] Some updates for README

---
 README.md | 39 +++++++++++++++++++++++++--------------
 1 file changed, 25 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 390f4081..c3c187d6 100644
--- a/README.md
+++ b/README.md
@@ -7,30 +7,41 @@
 
 ## Setup
 
-In order to run jobs, Opaque needs access to a Docker swarm manager. Currently it's not possible to specify a dedicated Docker host, instead Opaque expects the executing system to to be a swarm manager.
+1. Create Docker swarm
 
-1. Get the source code and navigate into the code directory
+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 swarm with at least one dedicated worker machine. The [swarm setup](https://docs.docker.com/engine/swarm/swarm-tutorial/) process is described best in the Docker documentation.
+
+
+2. Create shared network storage
+
+
+
+
+
+2. Get the source code and navigate into the code directory
 ```
 git clone https://gitlab.ub.uni-bielefeld.de/sfb1288inf/opaque.git
 cd opaque
 ```
 
-2. Create Docker swarm
-
-2.1. Local
+2.1 Create a configuration file
 ```
-# Set the variable values in setup_local_swarm.sh (nano setup_local_swarm.sh)
-./setup_local_swarm.sh
+touch .env
+# Account information of a mail account for sending emails to opaque users.
+echo "MAIL_USERNAME=opaque@example.com" >> .env
+echo "MAIL_PASSWORD=password" >> .env
+echo "MAIL_SERVER=smtp.example.com" >> .env
+echo "MAIL_PORT=587" >> .env
+echo "MAIL_USE_TLS=true" >> .env
+# A user registering with this email address will automatically promoted as an admin.
+echo "OPAQUE_ADMIN=admin.opaque@example.com" >> .env
+# Absolut path to an existing directory to save all opaque files.
+echo "OPAQUE_STORAGE=/opaque/storage" >> .env
 ```
 
-2.2. Distributed
+2.2
 
-2.2.1. Initialize swarm on manager machine
-```
-docker swarm init
-```
-
-3. Create Python virtual environment, activate it and install the required python packages.
+Create Python virtual environment, activate it and install the required python packages.
 ```
 python3 -m venv venv
 source venv/bin/activate