From 5497ac374e02abfd76f62cf9d2ec222495131f6b Mon Sep 17 00:00:00 2001
From: Jan Eitzinger <jan.eitzinger@fau.de>
Date: Wed, 19 May 2021 14:56:25 +0200
Subject: [PATCH] Update readme

---
 README.md          | 34 +++++++++++++++++++++++++++++++---
 docker-compose.yml |  4 ++--
 2 files changed, 33 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index addbe81..425d0ba 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,38 @@
 # cc-docker
-A configurable docker compose setup for easy deployment of ClusterCockpit
+WARNING: This does not yet work!
 
-Desired modes:
+This is a setup for `docker compose` to deploy a complete ClusterCockpit Application Stack including all external components.
+
+At the end it will create containers for:
+* mysql
+* influxdb
+* php-fpm (including the Symfony application)
+* phpmyadmin
+* nginx
+
+Everything is configured in `.env`.
+
+There exist multiple persistent (shared) volumes:
+* `symfony` mapping to `/var/www/symfony` for the ClusterCockpit source tree
+* `sql` mapping to `/var/lib/mysql`
+* `influxdb/data` mapping to `/var/lib/influxdb2`
+* `influxdb/config` mapping to `/etc//influxdb2`
+* `logs/nginx` mapping to `/var/log/nginx`
+* `logs/symfony` mapping to `/var/www/symfony/var/log`
+
+The containers are build and started using the command:
+```
+docker compose up
+```
+
+Desired modes for the future are:
 
 * Demo: Includes everything to try out ClusterCockpit including initial Database Fixtures. No SSL and no reverse Proxy.
 * Develop: Only includes all external components of ClusterCockpit. A functional PHP environment and the ClusterCockpit source must be maintained on host machine.
 * Production: Includes everything to run ClusterCockpit in a Production environment including SSL and traefic reverse proxy and container orchestration.
 
- 
+TODOS (There are probably a lot more!):
+* Some of the Volume directories need to be created first, others (influxdb) not
+* The main problem is currently the checkout of the ClusterCockpit tree to the existing directory `/var/www/symfony`, the directory is non-empty. Maybe because of caching
+* ClusterCockpit is at the moment still using the influxDB V1 API, the InfluxDB container is already V2
+* For a running demo database fixtures for MySQL and InfluxDB are missing
diff --git a/docker-compose.yml b/docker-compose.yml
index ff80f97..19eeb62 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -79,5 +79,5 @@ services:
             - NGINX_ENVSUBST_TEMPLATE_SUFFIX=.template
             - NGINX_SYMFONY_SERVER_NAME=${NGINX_SYMFONY_SERVER_NAME}
         volumes:
-            - ./logs/nginx:/var/log/nginx:cached
-            - ./symfony:/var/www/symfony:cached
+            - ./logs/nginx:/var/log/nginx
+            - ./symfony:/var/www/symfony