From 9c689a5e2d0db083ae1ae32a394faefdec171f40 Mon Sep 17 00:00:00 2001 From: cytopia Date: Sat, 20 May 2017 21:39:57 +0200 Subject: [PATCH] REL-0.9 Improve documentation --- README.md | 36 ++++++++++++++++++++++++++++++++---- doc/Configuration.md | 2 +- doc/Emails.md | 2 +- doc/FAQ.md | 2 +- doc/Info.md | 2 +- doc/Intranet.md | 2 +- doc/Logs.md | 4 +++- doc/PHP_Projects.md | 2 +- doc/README.md | 4 ++-- doc/Updating.md | 2 +- doc/Usage.md | 2 +- 11 files changed, 45 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index b6631aa4..034a7b3b 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Configuration is not necessary, as everything is pre-setup with mass virtual hos You are up and running in three simple steps: ```shell -# Copy the example configuration file +# Create docker-compose environment file $ cp env-example .env # Edit your configuration @@ -49,22 +49,50 @@ $ docker-compose up The above will start all containers, you can however also just start the containers you actually need. This is achieved by simply specifying them in the docker-compose command. Here are a few examples to get you started. -``` +```shell $ docker-compose up httpd php mysql redis ``` ![Devilbox](doc/img/devilbox-dash-01.png) -``` +```shell $ docker-compose up httpd php mysql pgsql redis memcd ``` ![Devilbox](doc/img/devilbox-dash-02.png) -``` +```shell $ docker-compose up httpd php pgsql memcd ``` ![Devilbox](doc/img/devilbox-dash-03.png) +### Run different versions + +Every single attachable container comes with many different versions (see **[runtime-matrix](#run-time-matrix)** below). In order to select the desired version for a container, simply edit the `.env` file and uncomment the version of choice. + +The following example shows how to set Memcached to version `1.4.28`: +```shell +$ vim .env + +... +#MEMCD_SERVER=1.4.21 +#MEMCD_SERVER=1.4.22 +#MEMCD_SERVER=1.4.23 +#MEMCD_SERVER=1.4.24 +#MEMCD_SERVER=1.4.25 +#MEMCD_SERVER=1.4.26 +#MEMCD_SERVER=1.4.27 +MEMCD_SERVER=1.4.28 +#MEMCD_SERVER=1.4.29 +#MEMCD_SERVER=1.4.30 +#MEMCD_SERVER=1.4.31 +#MEMCD_SERVER=1.4.32 +#MEMCD_SERVER=1.4.33 +#MEMCD_SERVER=1.4.34 +#MEMCD_SERVER=1.4.35 +#MEMCD_SERVER=1.4.36 +#MEMCD_SERVER=latest +``` + ## Feature overview diff --git a/doc/Configuration.md b/doc/Configuration.md index 7bc1b72f..d976893b 100644 --- a/doc/Configuration.md +++ b/doc/Configuration.md @@ -1,4 +1,4 @@ -# Configuration +# Devilbox Documentation [Home](https://github.com/cytopia/devilbox) | [Overview](README.md) | diff --git a/doc/Emails.md b/doc/Emails.md index 6f3c5bf3..017e50e3 100644 --- a/doc/Emails.md +++ b/doc/Emails.md @@ -1,4 +1,4 @@ -# Documentation +# Devilbox Documentation [Home](https://github.com/cytopia/devilbox) | [Overview](README.md) | diff --git a/doc/FAQ.md b/doc/FAQ.md index 4672244b..954bfd8f 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -1,4 +1,4 @@ -# Documentation +# Devilbox Documentation [Home](https://github.com/cytopia/devilbox) | [Overview](README.md) | diff --git a/doc/Info.md b/doc/Info.md index 62b8e962..4c82785a 100644 --- a/doc/Info.md +++ b/doc/Info.md @@ -1,4 +1,4 @@ -# Documentation +# Devilbox Documentation [Home](https://github.com/cytopia/devilbox) | [Overview](README.md) | diff --git a/doc/Intranet.md b/doc/Intranet.md index 1789b681..efe73570 100644 --- a/doc/Intranet.md +++ b/doc/Intranet.md @@ -1,4 +1,4 @@ -# Documentation +# Devilbox Documentation [Home](https://github.com/cytopia/devilbox) | [Overview](README.md) | diff --git a/doc/Logs.md b/doc/Logs.md index 6046d6a3..6639267e 100644 --- a/doc/Logs.md +++ b/doc/Logs.md @@ -1,4 +1,4 @@ -# Documentation +# Devilbox Documentation [Home](https://github.com/cytopia/devilbox) | [Overview](README.md) | @@ -54,3 +54,5 @@ All output that is produced to stdout or stderr by the started service will be a ```shell docker-compose logs -f ``` + +Docker logs are currently only being used to display the initial startup including the chosen settings. All other logging is written to file and mounted to the docker host. diff --git a/doc/PHP_Projects.md b/doc/PHP_Projects.md index 2696cb1d..937dbd82 100644 --- a/doc/PHP_Projects.md +++ b/doc/PHP_Projects.md @@ -1,4 +1,4 @@ -# Documentation +# Devilbox Documentation [Home](https://github.com/cytopia/devilbox) | [Overview](README.md) | diff --git a/doc/README.md b/doc/README.md index e97d11ae..5de09c73 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,4 +1,4 @@ -# Documentation +# Devilbox Documentation [Home](https://github.com/cytopia/devilbox) | Overview | @@ -14,7 +14,7 @@ Overview | ---- -## Documentation Overview +## Overview This is a brief overview to get you started as quick as possible. For in-depth documentation use the navigation above. diff --git a/doc/Updating.md b/doc/Updating.md index f2a6be1f..aeb59d97 100644 --- a/doc/Updating.md +++ b/doc/Updating.md @@ -1,4 +1,4 @@ -# Documentation +# Devilbox Documentation [Home](https://github.com/cytopia/devilbox) | [Overview](README.md) | diff --git a/doc/Usage.md b/doc/Usage.md index 824642fb..203927c1 100644 --- a/doc/Usage.md +++ b/doc/Usage.md @@ -1,4 +1,4 @@ -# Documentation +# Devilbox Documentation [Home](https://github.com/cytopia/devilbox) | [Overview](README.md) |