From 6f35ce264d351ec21f0696273723948766a28fe9 Mon Sep 17 00:00:00 2001 From: cytopia Date: Fri, 9 Jun 2017 09:23:26 +0200 Subject: [PATCH] DVL-016 Documentation structure --- docs/Examples.md | 16 ++++++++-------- docs/FAQ.md | 19 ++++++++++++++----- docs/Hacking.md | 23 +++++++++++++++++++++++ docs/README.md | 19 +++++++++---------- docs/Usage.md | 41 ++++++++++++++--------------------------- 5 files changed, 68 insertions(+), 50 deletions(-) create mode 100644 docs/Hacking.md diff --git a/docs/Examples.md b/docs/Examples.md index deb4baac..7a861902 100644 --- a/docs/Examples.md +++ b/docs/Examples.md @@ -1,22 +1,22 @@ # Devilbox Documentation -| -**Overview** | +**[Overview](README.md)** | **Installing** | **Updating** | **Configuration** | -[**Usage**](Usage.md) | -Examples | +**[Usage](Usage.md)** | +**Examples** | **Technical** | -[**FAQ**](FAQ.md) | +**[Hacking](Hacking.md)** | +**[FAQ](FAQ.md)** --- ## Examples -1. Setup Wordpress -2. Setup Drupal -3. Setup Yii +1. [Setup Wordpress](#1-setup-wordpress) +2. [Setup Drupal](#2-setup-drupal) +3. [Setup Yii](#3-setup-yii) --- diff --git a/docs/FAQ.md b/docs/FAQ.md index 7c4805ba..46b71bf9 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -1,14 +1,14 @@ # Devilbox Documentation -| -[**Overview**](README.md) | +**[Overview](README.md)** | **Installing** | **Updating** | **Configuration** | -[**Usage**](Usage.md) | -[**Examples**](Examples.md) | +**[Usage](Usage.md)** | +**[Examples](Examples.md)** | **Technical** | -FAQ | +**[Hacking](Hacking.md)** | +**FAQ** --- @@ -33,3 +33,12 @@ See: *Why are mounted MySQL data directories separated by version?* **Why do the user/group permissions of log/ or cfg/ directories show 1000?** Uid and Gid are set to 1000 by default. You can alter them to match the uid/gid of your current user. Open the `.env` file and change the sections `NEW_UID` and `NEW_GID`. When you start up the devilbox, the php-container will use these values for its user. + +**Can I not just comment out the service in the `.env` file?** + +No, don't do this. This will lead to unexpected behaviour (different versions will be loaded). +The `.env` file allows you to configure the devilbox, but not to start services selectively. + +**Are there any required services that must/will always be started?** + +Yes. `http` and `php` will automatically always be started (due to dependencies inside `docker-compose.yml`) if you specify them or not. diff --git a/docs/Hacking.md b/docs/Hacking.md new file mode 100644 index 00000000..94542440 --- /dev/null +++ b/docs/Hacking.md @@ -0,0 +1,23 @@ +# Devilbox Documentation + +**[Overview](README.md)** | +**Installing** | +**Updating** | +**Configuration** | +**[Usage](Usage.md)** | +**[Examples](Examples.md)** | +**Technical** | +**Hacking** | +**[FAQ](FAQ.md)** + +--- + +## Hacking + +1. [Adding your own docker container](#) + +--- + +### 1. Adding your own docker container + + diff --git a/docs/README.md b/docs/README.md index a86cb537..d98830a2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,14 +1,14 @@ # Devilbox Documentation -| -Overview | +**Overview** | **Installing** | **Updating** | **Configuration** | -[**Usage**](Usage.md) | -[**Examples**](Examples.md) | +**[Usage](Usage.md)** | +**[Examples](Examples.md)** | **Technical** | -[**FAQ**](FAQ.md) | +**[Hacking](Hacking.md)** | +**[FAQ](FAQ.md)** --- @@ -28,10 +28,8 @@ The devilbox runs on all major operating systems. Below you can quickly check th | | ![linux][lin-logo] | ![windows][win-logo] | ![osx][osx-logo] | |-------------|----------------------|---------------------------|----------------------| -| **Version** | normal | [Docker for Windows][d4w] | [Docker dor Mac][d4m]| -| **Issues** | [here][lin-issues] | [here][win-issues] | [here][osx-issues] | - -**Note:** There is also the deprecated [Docker Toolbox][dtb] (for Windows and OSX). It is however not recommended to use with the devilbox. +| **Docker Version** | normal | [Docker for Windows][d4w] | [Docker dor Mac][d4m]| +| **Current Issues** | [here][lin-issues] | [here][win-issues] | [here][osx-issues] | [win-logo]: https://raw.githubusercontent.com/cytopia/icons/master/64x64/windows.png [lin-logo]: https://raw.githubusercontent.com/cytopia/icons/master/64x64/linux.png @@ -46,6 +44,7 @@ The devilbox runs on all major operating systems. Below you can quickly check th ### 2. Requirements +* **Internet connection** - only required during initial setup for cloning the devilbox repository and pulling the required docker container. Afterwards you can always work offline. * [Docker Engine 1.12.0+](https://docs.docker.com/compose/compose-file/compose-versioning/#version-21) * [Docker Compose 1.6.0+](https://docs.docker.com/compose/compose-file/compose-versioning/#version-2) * On Windows use [Docker for Windows][d4w] (not tested on [Docker Toolbox][dtb]) @@ -64,7 +63,7 @@ If you have never worked with docker/docker-compose before, you should check up | **Installing** | How to install docker, docker-compose and the devilbox | | **Updating** | Update best practise | | **Configuration** | How to configure the devilbox, switch versions (PHP, MySQL, PgSQL, ...) and how to set custom options (php.ini, my.cnf, httpd.conf, ...) | -| **[Usage](Usage.md)** | How to create projects, Email and DNS usage, tools (`composer`, `npm`, `node`, `drush`, ...), entering the container, Log files, Xdebug, ...| +| **[Usage](Usage.md)** | How to create projects, Email and DNS usage, tools (`composer`, `npm`, `node`, `drush`, ...), entering the container, Log files, Xdebug, Backups, Intranet, ...| | **[Examples](Examples.md)** | Some project examples for popular CMS/Frameworks. How to setup Wordpress, Drupal, Yii, ... | | **Technical** | Technical background information | | **[FAQ](FAQ.md)** | Questions and Troubleshooting | diff --git a/docs/Usage.md b/docs/Usage.md index 30799069..72471618 100644 --- a/docs/Usage.md +++ b/docs/Usage.md @@ -1,14 +1,14 @@ # Devilbox Documentation -| -**Overview** | +**[Overview](README.md)** | **Installing** | **Updating** | **Configuration** | -Usage | -[**Examples**](Examples.md) | +**Usage** | +**[Examples](Examples.md)** | **Technical** | -[**FAQ**](FAQ.md) | +**[Hacking](Hacking.md)** | +**[FAQ](FAQ.md)** --- @@ -27,14 +27,17 @@ Usage | 3. [Available tools](#) 4. [Available URLs](#) 3. [Creating Projects](#) - 1. Creating projects on the docker host - 2. Creating projects from within the PHP container -4. [DNS](#) + 1. [Creating projects on the docker host](#) + 2. [Creating projects from inside the PHP container](#) +4. [Backups](#) + 1. [Backup MySQL database](#) + 2. [Backup PgSQL database](#) +5. [DNS](#) 1. [/etc/hosts](#) 2. [Auto-DNS](#) -5. [Intranet](#) -6. [Emails](#) -7. [Log files](#) +6. [Intranet](#) +7. [Emails](#) +8. [Log files](#) --- @@ -154,19 +157,3 @@ The `php` container mounts your project files (the path of `HOST_PATH_TO_WWW_DOC So enter the container as described above and once inside the `php` container cd into `/shared/httpd`. ----- - -### Hints - -**A. How do I know the name of the container I can start?** - -Refer to the **[Info](Info.md)** section or look it up in the `docker-compose.yml` file. - -**B. Can I not just comment out the service in the `.env` file?** - -No, don't do this. This will lead to unexpected behaviour (different versions will be loaded). -The `.env` file allows you to configure the devilbox, but not to start services selectively. - -**C. Are there any required services that must/will always be started?** - -Yes. `http` and `php` will automatically always be started (due to dependencies inside `docker-compose.yml`) if you specify them or not.