From 16a319ba5cfa19f35d25cfeca3f751b0b850912d Mon Sep 17 00:00:00 2001
From: "Gallenkamp, Fabian (bax1489)" <fabian.gallenkamp@uni-hamburg.de>
Date: Mon, 29 Jul 2019 17:09:52 +0200
Subject: [PATCH] First draft of readme.

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index e69de29..1203571 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,24 @@
+# ansible script to setup otree instances
+
+## preparation
+
+### place ssl/tls certificates and key-file (unfortunately not scriptable)
+
+### install ansible and clone this project
+``sudo apt install ansible git``
+
+``git clone https://gitlab.rrz.uni-hamburg.de/bax1489/otree-ansible.git``
+
+### configure playbook
+Adapt your ``group_vars/otree_servers.yml`` from the provided example accordingly:
+
+### (optional) upload otree project
+If no git-repository with your otree project is provided, you can place a copy in ``files/<otree_username>/``.
+
+And now run the playbook.
+
+## change the configuration
+Adapt ``group_vars/otree_servers.yml`` and run the playbook again
+
+## run the playbook
+Run ``ansible-playbook site.yml``.
\ No newline at end of file
-- 
GitLab