Note: Container need to be re-created after changing this value. | - -This is the base path that will be prepended to all mount paths specified in `.env`. -You will usually not need to change this value.. - -**IMPORTANT:** When changing this path, it will affect the paths of all other mounted DATA directories. You must therefore also remove any stopped container so that they will be re-created with new different mount points during the next run. In order to accomplish this obey the following precedure: - -```shell -# Stop the container -$ docker-compose stop - -# Remove the stopped container (IMPORTANT!) -# After the removal it will be re-created during next run -$ docker-compose rm -f - -# Edit any path variables -$ vim .env - -# Start your stack -$ docker-compose up -d -``` - -#### 2.3 Host computer listening address - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| LOCAL_LISTEN_ADDRESS | `127.0.0.1:` | Address for every service to listen on the Docker host.
Pay attention to the **`:`** after the IP address | - -This determines the Host address your webserver and all other daemons should listen on. - -In case it is not `127.0.0.1` (because you are using a VirtualBox Docker setup) change it to the IP address of the VirtualBox host. Otherwise you will not need to change this value. - -1. When you remove it completely, it will listen on all interfaces. -2. When you use specific address, you must add a **`:`** at the end. - -You can for example change it to `0.0.0.0:` or make it empty in order to listen on all interfaces. This enables it for other people inside your network to access the devilbox. Or you can even install the devilbox on a different computer and access it remotely. - -## 3. Project settings - -#### 3.1 Project domain - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| TLD_SUFFIX | `loc` | Domain suffix for all your project. Can also be a subdomain such `work.loc` | - -Each project will be served by `http://
Note: Container need to be re-created after changing this value. | - -This is the file system path on your host computer which will hold the Project Folders. - -**IMPORTANT:** When changing this path, you must re-create any affected Docker container explicitly. This can be accomplished by doing the following: - -```shell -# Stop the container -$ docker-compose stop - -# Remove the stopped container (IMPORTANT!) -# After the removal it will be re-created during next run -$ docker-compose rm -f - -# Start your stack -$ docker-compose up -d -``` - -#### 3.3 Project htdocs directory - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| HTTPD_DOCROOT_DIR | `htdocs` | A sub directory inside your project directory from which the web server will serve your files.
The full path to the document root would be: `${HOST_PATH_HTTPD_DATADIR}/
Note: Container need to be re-created after changing this value. | - -This is the file system path on your host computer which will hold the MySQL data. - -**Note:** A sub directory will be created inside this path for each MySQL version. This separation is there to make sure that higher versions do not upgrade the database irrevocably. (e.g.: MySQL 8.0 can read data from MySQL 5.5, but not the other way round). - -The automatic folder structure will look something like this: - -```shell -$ ls -l ./data/mysql/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 mariadb-10.0/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 mariadb-10.1/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 mariadb-10.2/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 mariadb-10.3/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 mysql-5.5/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 mysql-5.6/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 mysql-5.7/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 mysql-8.0/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 percona-5.5/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 percona-5.6/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 percona-5.7/ -``` - -**IMPORTANT:** When changing this path, you must re-create any affected Docker container explicitly. This can be accomplished by doing the following: - -```shell -# Stop the container -$ docker-compose stop - -# Remove the stopped container (IMPORTANT!) -# After the removal it will be re-created during next run -$ docker-compose rm -f - -# Start your stack -$ docker-compose up -d -``` - - -##### 4.4.6 my.cnf - -`my.cnf` settings can be configured for each MySQL/MariaDB version separately. Container-based configuration is done inside the `./cfg/` directory. - -```shell -$ ls -l ./cfg/ | grep -E 'mysql|maria' -drwxrwxr-x 2 cytopia 4096 Jun 1 08:44 mariadb-10.0/ -drwxrwxr-x 2 cytopia 4096 Jun 1 08:44 mariadb-10.1/ -drwxrwxr-x 2 cytopia 4096 Jun 1 08:44 mariadb-10.2/ -drwxrwxr-x 2 cytopia 4096 Jun 1 08:44 mariadb-10.3/ -drwxrwxr-x 2 cytopia 4096 Jun 13 13:18 mysql-5.5/ -drwxrwxr-x 2 cytopia 4096 Jun 1 08:44 mysql-5.6/ -drwxrwxr-x 2 cytopia 4096 Jun 1 08:44 mysql-5.7/ -drwxrwxr-x 2 cytopia 4096 Jun 1 08:44 mysql-8.0/ -drwxrwxr-x 2 cytopia 4096 Jun 1 08:44 percona-5.5/ -drwxrwxr-x 2 cytopia 4096 Jun 1 08:44 percona-5.6/ -drwxrwxr-x 2 cytopia 4096 Jun 1 08:44 percona-5.7/ -``` - -Each of the above folders will hold an example configuration file named `devilbox-custom.cnf-example` which shows some example settings but will **not have** any effect yet. Only files ending by **`.cnf`** will be sourced and applied, so you must copy it (or create a new file) to something that ends by `*.cnf`. - -In order to edit settings for MySQL 5.5, go into that folder, copy the example file and adjust it: - -```shell -# Copy to file ending by *.ini -$ cd cfg/mysql-5.5 -$ cp devilbox-custom.cnf-example devilbox-custom.cnf - -# Edit settings -$ vi devilbox-custom.cnf -``` - -Change will take effect after restarting the devilbox. - -#### 4.5 PostgreSQL - -##### 4.5.1 Select PostgreSQL version - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| PGSQL_SERVER | `9.6` | Change the PostgreSQL Docker container | - -1. Open the `.env` file in your favorite editor -2. Find the `PGSQL_SERVER=` block - -**Important:** Each version has a different data directory. This is a security precautions. Imagine you startup PostgreSQL 9.1 for the first time. New databases will be created. Now you startup PostgreSQL 9.6. All existing databases would be upgraded to work flawlessly with PostgreSQL 9.6, however this is not downwards compatible. So by startup up PostgreSQL 9.1 again, it would say the database is corrupt. - -##### 4.5.2 Root user - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| PGSQL_ROOT_USER | `postgres` | Root username for PostgreSQL | - -If you start a PostgreSQL container for the first time, it will setup PostgreSQL itself with a specified username and password. If you do change the root username or password to something else, make sure to also set it accordingly in `.env`, otherwise the devilbox will not be able to connect to PostgreSQL and will not be able to display information inside the bundled intranet. - -See also: Root password - -##### 4.5.3 Root password - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| PGSQL_ROOT_PASSWORD | `` | Root user password for PostgreSQL | - -If you start a PostgreSQL container for the first time, it will setup PostgreSQL itself with a specified username and password. If you do change the root username or password to something else, make sure to also set it accordingly in `.env`, otherwise the devilbox will not be able to connect to PostgreSQL and will not be able to display information inside the bundled intranet. - -See also: Root user - -##### 4.5.4 Host port - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| HOST_PORT_PGSQL | `5432`| Host computer listening port for the PostgreSQL server | - -By default the PostgreSQL server will listen on port 5432 (on your Host computer). You can change this to any other port (in case port 5432 is already taken). - -If you also want to change the listening address (default: 127.0.0.1) to something else, see above or search this document for `LOCAL_LISTEN_ADDRESS`. - -##### 4.5.5 Data path - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| HOST_PATH_PGSQL_DATADIR | `./data/pgsql` | Can be absolute or relative path. A relative path starts inside the devilbox git directory.
Note: Container need to be re-created after changing this value. | - -This is the file system path on your host computer which will hold the PostgreSQL data. - -**Note:** A sub directory will be created inside this path for each PostgreSQL version. This separation is there to make sure that higher versions do not upgrade the database irrevocably. (e.g.: PostgreSQL 9.6 can read data from PostgreSQL 9.1, but maybe not the other way round). - -The automatic folder structure will look something like this: - -```shell -$ ls -l ./data/pgsql/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 9.1/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 9.2/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 9.3/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 9.4/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 9.5/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 9.6/ -``` - -**IMPORTANT:** When changing this path, you must re-create any affected Docker container explicitly. This can be accomplished by doing the following: - -```shell -# Stop the container -$ docker-compose stop - -# Remove the stopped container (IMPORTANT!) -# After the removal it will be re-created during next run -$ docker-compose rm -f - -# Start your stack -$ docker-compose up -d -``` - - -#### 4.6 Redis - -##### 4.6.1 Select Redis version - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| REDIS_SERVER | `3.2` | Change the Redis Docker container | - -1. Open the `.env` file in your favorite editor -2. Find the `REDIS_SERVER=` block - -There is nothing to pay attention to here. - -##### 4.6.2 Host port - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| HOST_PORT_REDIS | `6379`| Host computer listening port for the Redis server | - -By default the Redis server will listen on port 6379 (on your Host computer). You can change this to any other port (in case port 6379 is already taken). - -If you also want to change the listening address (default: 127.0.0.1) to something else, see above or search this document for `LOCAL_LISTEN_ADDRESS`. - -#### 4.7 Memcached - -##### 4.7.1 Select Memcached version - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| MEMCD_SERVER | `1.4.21` | Change the Memcached Docker container | - -1. Open the `.env` file in your favorite editor -2. Find the `MEMCD_SERVER=` block - -There is nothing to pay attention to here. - -##### 4.7.2 Host port - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| HOST_PORT_MEMCD | `11211`| Host computer listening port for the Memcached server | - -By default the Memcached server will listen on port 11211 (on your Host computer). You can change this to any other port (in case port 11211 is already taken). - -If you also want to change the listening address (default: 127.0.0.1) to something else, see above or search this document for `LOCAL_LISTEN_ADDRESS`. - -#### 4.8 MongoDB - -##### 4.8.1 Select MongoDB version - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| MONGO_SERVER | `3.4` | Change the MongoDB Docker container | - -1. Open the `.env` file in your favorite editor -2. Find the `MONGO_SERVER=` block - -**Important:** Each version has a different data directory. This is a security precautions. Imagine you startup MongoDB 2.8 for the first time. New databases will be created. Now you startup MongoDB 3.5. All existing databases would be upgraded to work flawlessly with MongoDB 3.5, however this is not downwards compatible. So by startup up MongoDB 2.8 again, it would say the database is corrupt. - -##### 4.8.2 Host port - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| HOST_PORT_MONGO | `27017`| Host computer listening port for the MongoDB server | - -By default the Memcached server will listen on port 27017 (on your Host computer). You can change this to any other port (in case port 27017 is already taken). - -If you also want to change the listening address (default: 127.0.0.1) to something else, see above or search this document for `LOCAL_LISTEN_ADDRESS`. - -##### 4.8.3 Data path - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| HOST_PATH_MONGO_DATADIR | `./data/mongo` | Can be absolute or relative path. A relative path starts inside the devilbox git directory.
Note: Container need to be re-created after changing this value. | - -This is the file system path on your host computer which will hold the MongoDB data. - -**Note:** A sub directory will be created inside this path for each MongoDB version. This separation is there to make sure that higher versions do not upgrade the database irrevocably. (e.g.: MongoDB 3.5 can read data from MongoDB 2.8, but maybe not the other way round). - -The automatic folder structure will look something like this: - -```shell -$ ls -l ./data/mongo/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 2.8/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 3.0/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 3.2/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 3.4/ -drwxrwxr-x 6 48 48 4096 Jun 21 08:47 3.5/ -``` - -**IMPORTANT:** When changing this path, you must re-create any affected Docker container explicitly. This can be accomplished by doing the following: - -```shell -# Stop the container -$ docker-compose stop - -# Remove the stopped container (IMPORTANT!) -# After the removal it will be re-created during next run -$ docker-compose rm -f - -# Start your stack -$ docker-compose up -d -``` - - -#### 4.9 Bind - -##### 4.9.1 Upstream resolver - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| BIND_DNS_RESOLVER | `8.8.8.8,8.8.4.4` | Comma separated list of IP addresses of DNS servers. By default using Google's DNS server as they are pretty fast. | - -The devilbox is using its own DNS server internally (your host computer can also use it for Auto-DNS) in order to resolve custom project domains defined by `TLD_SUFFIX`. To also be able to reach the internet from within the Container there must be some kind of upstream DNS server to ask for queries. - -If you don't trust the Google DNS server, then set it to something else. If you already have a DNS server inside your LAN and also want your custom DNS (if any) to be available inside the containers, set the value to its IP address. - -##### 4.9.2 Host port - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| HOST_PORT_BIND | `1053`| Host computer listening port for the Bind DNS server | - -By default the Bind DNS server will listen on port 1053 (on your Host computer). You can change this to any other port (in case port 1053 is already taken). - -If you also want to change the listening address (default: 127.0.0.1) to something else, see above or search this document for `LOCAL_LISTEN_ADDRESS`. - - -## 5. Intranet settings - -#### 5.1 DNS check timeout - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| DNS_CHECK_TIMEOUT | `1` | DNS timeout in seconds for unresolvable Domains | - -`TLD_SUFFIX` domains are checked if they are set in the host computer /etc/hosts or available via attached DNS server. Timeout is done on vhosts.php (intranet) via ajax calls. In order to keep performance, set this to a low value. DNS checks might not succeed in time on slow machines. If DNS is valid, but timeout is expired, set this to a higher value. - -`DNS_CHECK_TIMEOUT` value is how many seconds to time out. - -#### 5.2 Password protection - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| DEVILBOX_UI_PROTECT | `0` | Enable or disable devilbox's Intranet password protection | -| DEVILBOX_UI_PASSWORD | `` | Choose the password to login. (Default username: `devilbox`) | - -If you wish, you can password-protect the devilbox intranet (not the vhost projects). - -> You could for example allow people from your local network to access the projects hosted on your devilbox (When changing `LOCAL_LISTEN_ADDRESS` to also listen on your external LAN side). -> However, the devilbox intranet might give away too much information, what other people should not see, such as databases or others. -> In that case, you should enable password protection. - -#### 5.3 Disable Intranet - -| `.env` file variable name | Default | Note | -|---------------------------|---------|------| -| DEVILBOX_UI_DISABLE | `0` | Enable or disable devilbox's Intranet completely. | - -If you wish, you can disable the built-in intranet completely. Set this variable to `1` which will remove the vhost that servers the Intranet. All that will be left are your custom project based virtual hosts. - - -## 6. Host computer - -#### 6.1 /etc/hosts - -In the `/etc/hosts` file you will have to configure your project DNS. - -Each project is available in your browser via `http://
+
diff --git a/docs/Examples.md b/docs/Examples.md
new file mode 100644
index 00000000..eb54e139
--- /dev/null
+++ b/docs/Examples.md
@@ -0,0 +1,7 @@
+# Devilbox Documentation
+
+#### Devilbox documentation has moved to [devilbox.readthedocs.io](https://devilbox.readthedocs.io)
+
+
+
+
diff --git a/docs/FAQ.md b/docs/FAQ.md
index 7b156b1f..eb54e139 100644
--- a/docs/FAQ.md
+++ b/docs/FAQ.md
@@ -1,207 +1,7 @@
# Devilbox Documentation
-[Overview](README.md) |
-[Quickstart](Quickstart.md) |
-[Install](Install.md) |
-[Update](Update.md) |
-[Configure](Configure.md) |
-[Run](Run.md) |
-[Usage](Usage.md) |
-[OS](OS.md) |
-[Backups](Backups.md) |
-[Examples](Examples.md) |
-[Technical](Technical.md) |
-[Hacking](Hacking.md) |
-FAQ
+#### Devilbox documentation has moved to [devilbox.readthedocs.io](https://devilbox.readthedocs.io)
----
-
-## FAQ
-
-1. **[General](#1-general)**
- - [Are there any differences between Linux, Windows and OSX?](#are-there-any-differences-between-linux-windows-and-osx)
- - [Why are mounted MySQL data directories separated by version?](#why-are-mounted-mysql-data-directories-separated-by-version)
- - [Why are mounted PostgreSQL data directories separated by version?](#why-are-mounted-postgresql-data-directories-separated-by-version)
- - [Why are mounted MongoDB data directories separated by version?](#why-are-mounted-mongodb-data-directories-separated-by-version)
- - [Why do the user/group permissions of log/ or cfg/ directories show 1000?](#why-do-the-usergroup-permissions-of-log-or-cfg-directories-show-1000)
- - [Can I not just comment out the service in the .env file?](#can-i-not-just-comment-out-the-service-in-the-env-file)
- - [Are there any required services that must/will always be started?](#are-there-any-required-services-that-mustwill-always-be-started)
- - [What PHP Modules are available?](#what-php-modules-are-available)
- - [Can I load custom PHP modules without rebuilding the Docker container?](#can-i-load-custom-php-modules-without-rebuilding-the-docker-container)
-2. **[Configuration](#2-configuration)**
- - [Can I change the MySQL root password?](#can-i-change-the-mysql-root-password)
- - [Can I add other PHP Modules?](#can-i-add-other-php-modules)
- - [Can I change php.ini?](#can-i-change-phpini)
- - [Can I change my.cnf?](#can-i-change-mycnf)
- - [Can I switch HHVM between PHP 5.6 and PHP 7 mode?](#can-i-switch-hhvm-between-php-56-and-php-7-mode)
- - [Can I change the project virtual host domain .loc?](#can-i-change-the-project-virtual-host-domain-loc)
- - [Can I just start PHP and MySQL instead of all container?](#can-i-just-start-php-and-mysql-instead-of-all-container)
- - [Do I always have to edit /etc/hosts for new projects?](#do-i-always-have-to-edit-etchosts-for-new-projects)
-3. **[Usage](#3-usage)**
- - [Does it work with CakePHP?](#does-it-work-with-cakephp)
- - [Does it work with Drupal?](#does-it-work-with-drupal)
- - [Does it work with Joomla?](#does-it-work-with-joomla)
- - [Does it work with Laravel?](#does-it-work-with-laravel)
- - [Does it work with PhalconPHP?](#does-it-work-with-phalconphp)
- - [Does it work with Symfony?](#does-it-work-with-symfony)
- - [Does it work with Wordpress?](#does-it-work-with-wordpress)
- - [Does it work with Yii?](#does-it-work-with-yii)
- - [Does it work with Zend Framework?](#does-it-work-with-zend-framework)
-4. **[Troubleshooting](#4-troubleshooting)**
- - [Invalid bind mount spec after changing the path of MySQL, PgSQL, Mongo or the Data dir.](#invalid-bind-mount-spec-after-changing-the-path-of-mysql-pgsql-mongo-or-the-data-dir)
-
----
-
-## 1. General
-
-#### Are there any differences between Linux, Windows and OSX?
-
-Yes, have a look at **[OS](OS.md)** to read up about the differences.
-
-#### Why are mounted MySQL data directories separated by version?
-
-This is just a pre-caution. Imagine they would link to the same datadir. You start the devilbox with mysql 5.5, create a database and add some data. Now you decide to switch to mysql 5.7 and restart the devilbox. The newer mysql version will probably upgrade the data leaving it unable to start with older mysql versions.
-
-#### Why are mounted PostgreSQL data directories separated by version?
-
-See: *Why are mounted MySQL data directories separated by version?*
-
-#### Why are mounted MongoDB data directories separated by version?
-
-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.
-
-#### What PHP Modules are available?
-
-The devilbox is a development stack, so it is made sure that a lot of PHP modules are available out of the box in order to work with many different frameworks.
-
-> *apc, apcu, bcmath, bz2, calendar, Core, ctype, curl, date, dom, ereg, exif, fileinfo, filter, ftp, gd, gettext, gmp, hash, iconv, igbinary, imagick, imap, intl, json, ldap, libxml, magickwand, mbstring, mcrypt, memcache, memcached, mhash, mongodb, msgpack, mysql, mysqli, mysqlnd, openssl, pcntl, pcre, PDO, pdo_mysql, pdo_pgsql, pdo_sqlite, pgsql, phalcon, Phar, posix, pspell, readline, recode, redis, Reflection, session, shmop, SimpleXML, soap, sockets, SPL, sqlite3, standard, sysvmsg, sysvsem, sysvshm, tidy, tokenizer, uploadprogress, wddx, xdebug, xml, xmlreader, xmlrpc, xmlwriter, xsl, Zend OPcache, zip, zlib*
-
-There will however be slight differences between the versions and especially with HHVM. To see the exact bundled modules for each version visit the corresponding docker repositories on Github:
-
-[PHP 5.4](https://github.com/cytopia/docker-php-fpm-5.4) |
-[PHP 5.5](https://github.com/cytopia/docker-php-fpm-5.5) |
-[PHP 5.6](https://github.com/cytopia/docker-php-fpm-5.6) |
-[PHP 7.0](https://github.com/cytopia/docker-php-fpm-7.0) |
-[PHP 7.1](https://github.com/cytopia/docker-php-fpm-7.1) |
-[PHP 7.2](https://github.com/cytopia/docker-php-fpm-7.2) |
-[HHVM](https://github.com/cytopia/docker-hhvm-latest)
-
-#### Can I load custom PHP modules without rebuilding the Docker container?
-
-Yes. You can load custom PHP modules for each PHP version separately. See [Custom PHP Modules](Configure.md#425-custom-php-modules) in the Configuration documentation.
-
-
-## 2. Configuration
-
-#### Can I change the MySQL root password?
-
-Yes, you can change the password of the MySQL root user. If you do so, you must also set the new password in your `.env` file. See **[Configure](Configure.md)** for how to change the values.
-
-#### Can I add other PHP Modules?
-
-Yes, if there are any PHP modules you require that are not yet available in the PHP Docker container, you can install it during run-time, or create your own container. See **[Hacking](Hacking.md)** for more information.
-
-#### Can I change php.ini?
-
-Yes, php.ini directives can be changes on a per PHP version base. Go to `./cfg/` inside devilbox git diretory. There you will find configuration directories for each php version. Just put a \*.ini file there and restart the devilbox.
-
-#### Can I change my.cnf?
-
-Yes, my.cnf directives can be changes on a per MySQL version base. Go to `./cfg/` inside devilbox git diretory. There you will find configuration directories for each MySQL version. Just put a \*.cnf file there and restart the devilbox.
-
-#### Can I switch HHVM between PHP 5.6 and PHP 7 mode?
-
-Yes, this can be done by adding a \*.ini file to `./cfg/hhvm-latest/` with the following content to disable PHP 7 mode:
-
-```ini
-hhvm.php7.all = 0
-```
-The default is to use PHP 7 mode.
-
-#### Can I change the project virtual host domain `.loc`?
-
-Yes, the `.env` variable `TLD_SUFFIX` can be adjusted with whatever domain or subdomain your require. A few examples to get you started:
-
-| Project folder | TLD_SUFFIX | Project URL |
-|----------------|------------|--------------------------|
-| project1 | loc | http://project1.loc |
-| project1 | local | http://project1.local |
-| project1 | dev | http://project1.dev |
-| project1 | work.loc | http://project1.work.loc |
-
-#### Can I just start PHP and MySQL instead of all container?
-
-Yes, every Docker container is optional. The devilbox allows for selective startup. See **[Run: selective start](Run.md#13-selective-start)** for more detail.
-
-#### Do I always have to edit `/etc/hosts` for new projects?
-
-You need a valid DNS entry for every project that points to the Httpd server. As those records don't exists by default, you will have to create them. However, the devilbox has a bundled DNS server that can automate this for you. The only thing you have to do for that to work is to add this DNS server's IP address to your `/etc/resolv.conf`. See **[Configure: AutoDNS](Configure.md#62-auto-dns)** for instructions.
-
-
-## 3. Usage
-
-#### Does it work with CakePHP?
-
-Yes, see **[How to setup CakePHP](Examples.md#21-setup-cakephp)**.
-
-#### Does it work with Drupal?
-
-Yes, see **[How to setup Drupal](Examples.md#22-setup-drupal)**.
-
-#### Does it work with Joomla?
-
-Yes, see **[How to setup Joomla](Examples.md#23-setup-joomla)**.
-
-#### Does it work with Laravel?
-
-Yes, see **[How to setup Laravel](Examples.md#24-setup-laravel)**.
-
-#### Does it work with PhalconPHP?
-
-Yes, see **[How to setup Phalcon](Examples.md#25-setup-phalcon)**.
-
-#### Does it work with Symfony?
-
-Yes, see **[How to setup Symfony](Examples.md#26-setup-symfony)**.
-
-#### Does it work with Wordpress?
-
-Yes, see **[How to setup Wordpress](Examples.md#27-setup-wordpress)**.
-
-#### Does it work with Yii?
-
-Yes, see **[How to setup Yii](Examples.md#28-setup-yii)**.
-
-#### Does it work with Zend Framework?
-
-Yes, see **[How to setup Zend](Examples.md#29-setup-zend)**.
-
-
-## 4. Troubleshooting
-
-#### `Invalid bind mount spec` after changing the path of MySQL, PgSQL, Mongo or the Data dir.
-
-When you change any paths inside `.env` that affect Docker mountpoints, the container need to be *removed* and re-created during the next startup. *Removing* the container is sufficient as they will always be created during run if they don't exist.
-
-In order to *remove* the container do the following:
-
-```shell
-$ docker-compose stop
-
-# Remove the stopped container (IMPORTANT!)
-# After the removal it will be re-created during next run
-$ docker-compose rm -f
-```
+
+
+
diff --git a/docs/Hacking.md b/docs/Hacking.md
index 1b9fab79..eb54e139 100644
--- a/docs/Hacking.md
+++ b/docs/Hacking.md
@@ -1,156 +1,7 @@
# Devilbox Documentation
-[Overview](README.md) |
-[Quickstart](Quickstart.md) |
-[Install](Install.md) |
-[Update](Update.md) |
-[Configure](Configure.md) |
-[Run](Run.md) |
-[Usage](Usage.md) |
-[OS](OS.md) |
-[Backups](Backups.md) |
-[Examples](Examples.md) |
-[Technical](Technical.md) |
-Hacking |
-[FAQ](FAQ.md)
+#### Devilbox documentation has moved to [devilbox.readthedocs.io](https://devilbox.readthedocs.io)
----
-
-## Hacking
-
-1. [Rebuilding bundled Docker container](#1-rebuilding-bundled-docker-container)
- 1. [Why rebuild yourself?](#11-why-rebuild-yourself)
- 2. [How to rebuild yourself?](#12-how-to-rebuild-yourself)
- 3. [How to use the rebuild container?](#13-how-to-use-the-rebuild-container)
-2. [Customizing the bundled Docker container](#2-customizing-the-bundled-docker-container)
-3. [Adding your own Docker container](#3-adding-your-own-docker-container)
- 1. [What information will you need?](#31-what-information-will-you-need)
- 2. [How to add your service?](#32-how-to-add-your-service)
- 3. [How to start your service?](#33-how-to-start-your-service)
-
----
-
-## 1. Rebuilding bundled Docker container
-
-The devilbox Docker container are rebuild frequently and pushed to [dockerhub](https://hub.docker.com/r/cytopia/). However there might be cases in which you want to rebuild right away in order to use a new minor version of a tool inside the container.
-
-#### 1.1 Why rebuild yourself?
-
-Imagine for example you are using the [PHP 7.1](https://github.com/cytopia/docker-php-fpm-7.1) container which currently is available with the version 7.1.6. You found that PHP 7.1.7 has just been released, but the container wasn't yet updated to that version. If you can't wait and need that version now, you can just update the container to that version yourself.
-
-#### 1.2 How to rebuild yourself?
-
-Rebuilding yourself has been made pretty easy. The devilbox docker container repositories come with two scripts for automatic rebuilding. `build/docker-build.sh` and `build/docker-rebuild.sh`.
-
-1. *Clone* or *fork and clone* the desired docker repository to your computer
-2. Run `build/docker-build.sh` (cached build) or `build/docker-rebuild.sh` (uncached build)
-
-Either of the two above scripts will rebuild the desired docker container with the latest available versions. The rebuild docker container will then be available locally by the tag `latest`
-
-#### 1.3 How to use the rebuild container?
-
-##### 1.3.1 Tagged devilbox repository
-
-If your devilbox git repository is checked out on a `git tag`, then also the docker container are bound to specific docker tags. It will look like this in `docker-compose.yml`:
-
-```yml
- php:
- image: cytopia/${PHP_SERVER:-php-fpm-7.0}:0.10
-```
-
-Your newly rebuild `latest` docker container will not yet be available for the next run. You still need to change the `docker-compose.yml` and set the container to `latest`:
-
-```yml
- php:
- image: cytopia/${PHP_SERVER:-php-fpm-7.0}:latest
-```
-
-##### 1.3.2 devilbox repository on master branch
-
-If your devilbox git repository is checkout out on the `master` branch, then all docker container are always bound to the `latest` docker tag inside `docker-compose.yml` and you do not need to change anything. Just rebuilding the container is enough to be picked up for the next start.
-
-
-## 2. Customizing the bundled Docker container
-
-Customizing a Docker container is almost as simple as rebuilding it.
-
-1. Fork the desired docker repository
-2. Clone your forked docker repository locally
-3. Edit `Dockerfile` with your customization
-4. Run `build/docker-build.sh` (cached build) or `build/docker-rebuild.sh` (uncached build)
-5. Read the rebuild section above to apply necessary steps
-
-
-## 3. Adding your own Docker container
-
-You can add your custom docker container including its configuration to `docker-compose.yml`.
-
-#### 3.1 What information will you need?
-
-1. A name that you can use to refer to in the docker-compose command
-2. The Docker image name
-3. The Docker image version or `latest`
-4. An unused IP address from the devilbox network
-
-#### 3.2 How to add your service?
-
-##### 3.2.1 General example
-
-1. Open `docker-compose.yml`
-2. Paste the following snippet with your replaced values just below the `services:` line (with one level of indentation)
-
-```yml
-...
-services:
- # Your custom Docker container here:
-
+
diff --git a/docs/Install.md b/docs/Install.md
index 1eb19c47..eb54e139 100644
--- a/docs/Install.md
+++ b/docs/Install.md
@@ -1,83 +1,7 @@
# Devilbox Documentation
-[Overview](README.md) |
-[Quickstart](Quickstart.md) |
-Install |
-[Update](Update.md) |
-[Configure](Configure.md) |
-[Run](Run.md) |
-[Usage](Usage.md) |
-[OS](OS.md) |
-[Backups](Backups.md) |
-[Examples](Examples.md) |
-[Technical](Technical.md) |
-[Hacking](Hacking.md) |
-[FAQ](FAQ.md)
+#### Devilbox documentation has moved to [devilbox.readthedocs.io](https://devilbox.readthedocs.io)
----
-
-## Install
-
-1. [Install Docker](#1-install-docker)
- 1. [Linux](#11-linux)
- 2. [Windows](#12-windows)
- 3. [OSX](#13-osx)
-2. [Install Devilbox](#2-install-devilbox)
- 1. [Latest git tag](#21-latest-git-tag)
- 2. [Current master branch](#22-current-master-branch)
-
----
-
-## 1. Install Docker
-
-Only requirement for the devilbox is to have docker and docker-compose installed, everything else is bundled and provided within the Docker container.
-
-#### 1.1 Linux
-
-Refer to the official [Docker for Linux documentation](https://docs.docker.com/engine/installation/#supported-platforms) for how to install Docker on your distribution.
-
-#### 1.2 Windows
-
-Refer to the official [Docker for Windows documentation](https://docs.docker.com/docker-for-windows/install/) for how to install Docker.
-
-**Note:** You should install the [Native Windows Docker](https://docs.docker.com/docker-for-windows/install/) and not the [Docker Toolbox](https://docs.docker.com/toolbox/overview/).
-
-#### 1.3 OSX
-
-Refer to the official [Docker for Mac documentation](https://docs.docker.com/docker-for-mac/install/) for how to install Docker.
-
-**Note:** You should install the [Native Mac Docker](https://docs.docker.com/docker-for-mac/install/) and not the [Docker Toolbox](https://docs.docker.com/toolbox/overview/).
-
-
-## 2. Install Devilbox
-
-Just clone the devilbox repository and copy the configuration file.
-
-```shell
-$ git clone https://github.com/cytopia/devilbox
-$ cd devilbox
-$ cp env-example .env
-```
-
-You are all set now and can continue with [configuring the devilbox](Configure.md).
-
-#### 2.1 Latest git tag
-
-If you always want a stable development environment, you should stay on the latest git tag. However devilbox git tags are tied to specific Docker container tags. That means you will only get new Docker versions once you switch to the next devilbox git tag.
-
-To check out the latest git tag, issue the following command:
-
-```shell
-$ git checkout "$(git describe --abbrev=0 --tags)"
-```
-
-When updating git tags, you do not need to explicitly pull new Docker images, as this will be done automatically once starting up the devilbox. The only thing you will have to do is to compare your current configuration file `.env` with possible new options in `env-example`. Refer to [Update](Update.md) For more information about how to update the devilbox properly.
-
-#### 2.2 Current master branch
-
-The devilbox master branch will always reflect the latest changes. However, no commits are pushed directly to master and everything merged into this branch has to go through various tests to make sure the master branch stays as stable as it can get.
-The master branch ties each Docker container to their `latest` Docker tags. That means you can regularily `docker-compose pull` in order to obtain updated Docker container.
-
-**Note:** Always do `git pull origin master` and `docker-compose pull` together. Do not just do one of them.
-
-For the installation routine, there is nothing else to do here. After cloning you are automatically on the master branch. There are however a few things to pay attention to when updating the master branch. Refer to [Update](Update.md) For more information about how to update the devilbox properly.
+
+
+
diff --git a/docs/OS.md b/docs/OS.md
index 46d57a17..eb54e139 100644
--- a/docs/OS.md
+++ b/docs/OS.md
@@ -1,53 +1,7 @@
# Devilbox Documentation
-[Overview](README.md) |
-[Quickstart](Quickstart.md) |
-[Install](Install.md) |
-[Update](Update.md) |
-[Configure](Configure.md) |
-[Run](Run.md) |
-[Usage](Usage.md) |
-OS |
-[Backups](Backups.md) |
-[Examples](Examples.md) |
-[Technical](Technical.md) |
-[Hacking](Hacking.md) |
-[FAQ](FAQ.md)
+#### Devilbox documentation has moved to [devilbox.readthedocs.io](https://devilbox.readthedocs.io)
----
-
-## Operating System differences
-
-1. [Linux](#1-linux)
-2. [Windows](#2-windows)
- 1. [/etc/hosts](#21-etchosts)
- 1. [/etc/resolv.conf](#22-etcresolvconf)
-3. [OSX](#3-osx)
-
----
-
-## 1. Linux
-
-Documentation is written from a Linux point of view, so there will be no differences.
-
-
-## 2. Windows
-
-On Windows you will have to edit different files on the Docker host than on Linux or OSX.
-
-#### 2.1 `/etc/hosts`
-
-To set custom DNS entries on windows you will have to edit `C:\WINDOWS\system32\drivers\etc` instead.
-
-#### 2.2 `/etc/resolv.conf`
-
-In order to add a custom DNS resolver in Windows, you will have to use the GUI tools of your network interfaces.
-
-Check out this blog entry for how to adjust it:
-
-http://www.pc-freak.net/blog/configure-equivalent-linux-etcresolvconf-search-domaincom-ms-windows-dns-suffixes/
-
-
-## 3. OSX
-
-OSX behaves the same as Linux and will not have any differences from the documentation.
+
+
+
diff --git a/docs/Quickstart.md b/docs/Quickstart.md
index f96eec07..eb54e139 100644
--- a/docs/Quickstart.md
+++ b/docs/Quickstart.md
@@ -1,219 +1,7 @@
# Devilbox Documentation
-[Overview](README.md) |
-Quickstart |
-[Install](Install.md) |
-[Update](Update.md) |
-[Configure](Configure.md) |
-[Run](Run.md) |
-[Usage](Usage.md) |
-[OS](OS.md) |
-[Backups](Backups.md) |
-[Examples](Examples.md) |
-[Technical](Technical.md) |
-[Hacking](Hacking.md) |
-[FAQ](FAQ.md)
+#### Devilbox documentation has moved to [devilbox.readthedocs.io](https://devilbox.readthedocs.io)
----
-
-## Quickstart
-
-1. [Installation](#1-installation)
-2. [Update](#2-update)
- 1. [Tagged release](#21-tagged-release)
- 2. [Master branch](#22-master-branch)
-3. [Configuration](#3-configuration)
- 1. [.env](#31-env)
- 2. [Services](#32-services)
-4. [Run](#4-run)
- 1. [Run all](#41-run-all)
- 2. [Run selection](#42-run-selection)
-5. [Project setup](#5-project-setup)
- 1. [General setup](#51-general-setup)
- 2. [Specific Frameworks](#52-specific-frameworks)
-6. [Enter the PHP Docker container](#6-enter-the-php-docker-container)
-
----
-
-## 1. Installation
-
-Installing the devilbox is as easy as this:
-
-```shell
-$ git clone https://github.com/cytopia/devilbox
-$ cd devilbox/
-$ cp env-example .env
-```
-
-To find out in more detail for different operating systems have a look at **[Install](Install.md)**.
-
-## 2. Update
-
-You will have the choice to stay on stable git tags or on the latest master branch. Both options have slightly different update procedures. View the quick instructions below and for more information have a look at **[Update](Update.md)**
-
-#### 2.1 Tagged release
-
-```shell
-$ docker-compose stop
-$ docker-compose rm
-$ git fetch --all
-$ git checkout "$(git describe --abbrev=0 --tags)"
-```
-
-#### 2.2 Master branch
-
-```shell
-$ docker-compose stop
-$ docker-compose rm
-$ git fetch --all
-$ git pull origin master
-$ ./update-docker.sh
-```
-
-
-## 3. Configuration
-
-The devilbox will work out-of-the box after the above installation routine has been done. However there are lots of options to configure. Read up on it on **[Configure](Configure.md)**. A brief overview is shown below.
-
-#### 3.1 .env
-
-Edit all general settings inside the .env file (file paths, what version to run, debug, timezeon, etc). The `.env` file is well documented and self-explanatory.
-
-```shell
-$ vim .env
-```
-
-**Important:** When changing any path variables, you will have to stop all container, delete them so that they can be re-created during the next startup.
-
-```shell
-$ docker-compose stop
-
-# Remove the stopped container (IMPORTANT!)
-# After the removal it will be re-created during next run
-$ docker-compose rm -f
-```
-
-#### 3.2 Services
-
-Additionally to configure the devilbox in general, you can also configure each service separately by adding/altering service specific configuration files.
-
-**Example:** Configure PHP 5.6
-```shell
-$ cd cfg/
-$ echo "max_execution_time = 180" > php-fpm-5.6/config.ini
-```
-
-**Example:** Configure MySQL 5.5
-```shell
-$ cd cfg/
-$ echo "[mysqld]\nslow_query_log = 1" > mysql-5.5/config.cnf
-```
-
-
-## 4. Run
-
-Starting up the devilbox is done via docker-compose commands. You will have the choice to start-up everything or just a selection of the services you need. To get more more information about this view **[Run](Run.md)**.
-
-#### 4.1 Run all
-
-```shell
-$ docker-compose up -d
-```
-
-#### 4.2 Run selection
-
-```shell
-$ docker-compose up -d httpd php mysql redis
-```
-
-
-## 5. Project setup
-
-The heart of the devilbox is the easy configuration of an unlimitted numbder of projects. Most stuff configures itself automatically in the background, but a few things are still left up to you. The following will give you a kick-start for setting up a few projects. To find out in more detail view **[Usage](Usage.md)**.
-
-#### 5.1 General setup
-
-**Assumption:**
-
-1. HOST_PATH_TO_HTTPD_DATADIR=**./data/www**
-2. TLD_SUFFIX=**loc**
-3. Three Projects: project1, project2 and wordpress
-
-**Folder setup on your Host system:**
-
-| VirtualHost directory | DocumentRoot directory | URL |
-|-----------------------|-----------------------------|------------------------|
-| ./data/www/project1 | ./data/www/project1/htdocs | `http://project1.loc` |
-| ./data/www/project2 | ./data/www/project2/htdocs | `http://project2.loc` |
-| ./data/www/wordpress| ./data/www/wordpress/htdocs | `http://wordpress.loc` |
-
-Each VirtualHost will serve files from the **htdocs/** folder.
-
-**DNS setup on your Host system:**
-
-| Project folder | `/etc/hosts` entry |
-|----------------|----------------------------|
-| project1 | `127.0.0.1 project1.loc` |
-| project2 | `127.0.0.1 project2.loc` |
-| wordpress | `127.0.0.1 wordpress.loc`|
-
-Some frameworks have a nested www directory and require you to use a symlink instead of explicitly setting a **htdocs/** folder. See the CakePHP folder setup below:
-
-```shell
-$ ls -l
-drwxrwxr-x 2 cytopia 4096 Jun 14 08:29 cakephp
-lrwxrwxrwx 1 cytopia 11 Jun 14 08:29 htdocs -> cakephp/app/webroot/
-```
-
-#### 5.2 Specific Frameworks
-
-One example of the above mentioned nested directory structure is CakePHP. Its actual www dats is serveed from:
-
-```shell
-
+
diff --git a/docs/README.md b/docs/README.md
index 1c23bb4b..295f7e7c 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,192 +1,37 @@
# Devilbox Documentation
-Overview |
-[Quickstart](Quickstart.md) |
-[Install](Install.md) |
-[Update](Update.md) |
-[Configure](Configure.md) |
-[Run](Run.md) |
-[Usage](Usage.md) |
-[OS](OS.md) |
-[Backups](Backups.md) |
-[Examples](Examples.md) |
-[Technical](Technical.md) |
-[Hacking](Hacking.md) |
-[FAQ](FAQ.md)
+The Devilbox documentation is build via [sphinx](http://www.sphinx-doc.org/en/master) and
+automatically updated on [readthedocs](https://devilbox.readthedocs.io) by every git push.
----
-## Overview
+## Documentation
-1. [Main idea](#1-main-idea)
-2. [Features](#2-features)
-3. [Supported Host OS](#3-supported-host-os)
-4. [Requirements](#4-requirements)
-5. [Docker documentation](#5-docker-documentation)
-6. [Devilbox documentation](#6-devilbox-documentation)
-7. [Video Tutorials](#7-video-tutorials)
-8. [Available PHP Modules](#8-available-php-modules)
-9. [Supported Frameworks and CMS](#9-supported-frameworks-and-cms)
+The documentation is available online: https://devilbox.readthedocs.io
----
+
+
+
-## 1. Main idea
-The devilbox allows you to have an unlimited number of projects ready without having to install any external software and without having to configure any virtual hosts. As well as providing a very flexible development stack that you can run offline. (Internet is only required to initially pull docker container).
+## Local setup
-The only thing you will have to do is to create a new folder on the filesystem and your virtual host is ready to be served with your custom domain.
+You can also build the documentation locally before pushing to ensure everything looks fine:
-The default project catch-all domain is `*.loc` (see [Configure](Configure.md) for how to change it). Let's view an example:
+#### Requirements
-```shell
-# Inside your main project folder
-$ ls -l
-drwxr-xr-x 3 cytopia 4096 Jun 10 13:10 my-drupal
-drwxr-xr-x 3 cytopia 4096 Jun 10 13:10 my-wordpress
-drwxr-xr-x 3 cytopia 4096 Jun 10 13:10 project1
-drwxr-xr-x 3 cytopia 4096 Jun 10 13:10 project2
-drwxr-xr-x 3 cytopia 4096 Jun 10 13:10 yii-test
+```
+sudo pip install sphinx sphinx-autobuild
+sudo pip install sphinx_rtd_theme
```
-By having the above folders, the devilbox will automatically be able to serve the following vhosts:
+#### How to build
+```
+cd docs/
+sphinx-autobuild . _build/html
+```
-* http://my-drupal.loc
-* http://my-wordpress.loc
-* http://project1.loc
-* http://project2.loc
-* http://yii-test.loc
+#### How to view
-New folders can be created, deleted and removed during run-time and corresponding virtual hosts will be available instantly without having to restart anything.
+Open you browser on http://127.0.0.1:8000
-## 2. Features
-
-| Feature | Description |
-|---------|-------------|
-| **Internet** | |
-| No always-on | Internet connection is only required during initial setup or update (to pull containers), afterwards you can always work offline. |
-| **Projects** | |
-| Unlimited Projects | Add as many Projects as you need. |
-| Auto VirtualHosts | New VirtualHosts are added instantly without a restart or reload. Just create a new directory and you are ready to go. |
-| Auto DNS | Use the built-in DNS server to stop worrying about `/etc/hosts` setup per project. |
-| Email catch-all | All outgoing emails are intercepted and stored locally. Use the intranet to view any sent email. |
-| Custom VirtualHost domains | Whatever project domain you desire: `*.dev`, `*.loc`, `*.local` or even subdomains like `*.sub.example` - you can adjust it to your needs. |
-| **Run** | |
-| Selective start | Run only the Docker container you actually need. |
-| Version choice | Use your development stack with whatever version combination needed. |
-| Stack choice | Attach SQL or NoSQL container and use Nginx or Apache to simulate your live env. |
-| Log files | Log files are available for each chosen version. |
-| **Configuration** | |
-| HHVM | You can choose between PHP 5.6 and PHP 7 mode for HHVM |
-| php.ini | You an overwrite PHP settings for each PHP version. |
-| Custom PHP modules | You can add any custom PHP modules without having to rebuild the Docker container. |
-| my.cnf | You an overwrite MySQL settings for each MySQL version. |
-| **Intranet** | |
-| phpMyAdmin | Manage your MySQL databases here. |
-| Adminer | Manage your SQL and NoSQL databases here. |
-| OpCacheGUI | Visualize the state of opcache usage. |
-| EmailGUI | See all sent emails at a glance |
-| **Docker Tools**|
-| Work inside container | You can completely work inside the PHP container and use all bundled tools in order to keep your host system clean. |
-| **Hacking** |
-| Add custom container | You can add any other Docker container to `docker-compose.yml` and start using them in your development stack. |
-
-
-## 3. Supported Host OS
-
-The devilbox runs on all major operating systems. Below you can quickly check the recommended docker versions and current issues per OS.
-
-| | ![linux][lin-logo] | ![windows][win-logo] | ![osx][osx-logo] |
-|-------------|----------------------|---------------------------|----------------------|
-| **Docker Version** | normal | [Docker for Windows][d4w] | [Docker for 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
-[osx-logo]: https://raw.githubusercontent.com/cytopia/icons/master/64x64/osx.png
-[d4w]: https://docs.docker.com/docker-for-windows/install/
-[d4m]: https://docs.docker.com/docker-for-mac/install/
-[dtb]: https://docs.docker.com/toolbox/overview/
-[win-issues]: https://github.com/cytopia/devilbox/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3A%22host%3Awindows%22
-[lin-issues]: https://github.com/cytopia/devilbox/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3A%22host%3Alinux%22
-[osx-issues]: https://github.com/cytopia/devilbox/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3A%22host%3Aosx%22
-
-**How about FreeBSD?**
-
-The devilbox has not been tested on FreeBSD yet. Current milestones include to make it rock-solid on the above listed operating systems. However, if you want it to run on FreeBSD open up an issue on Github and you will receive support making it work on FreeBSD.
-
-
-## 4. 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.9.0+](https://docs.docker.com/compose/compose-file/compose-versioning/#version-21)
-* On Windows use [Docker for Windows][d4w] (not tested on [Docker Toolbox][dtb])
-* On OSX use [Docker for Mac][d4m] (not tested on [Docker Toolbox][dtb])
-
-
-## 5. Docker documentation
-
-If you have never worked with docker/docker-compose before, you should check up on their documentation to get you started: [docker docs](https://docs.docker.com/).
-
-
-## 6. Devilbox documentation
-
-| Topic | Description |
-|-------------------------|-------------|
-| **[Quickstart](Quickstart.md)** | Command overview to get you started quickly |
-| **[Install](Install.md)** | How to install docker, docker-compose and the devilbox |
-| **[Update](Update.md)** | Update best practise |
-| **[Configure](Configure.md)** | How to configure the devilbox, switch versions (PHP, MySQL, PgSQL, ...) and how to set custom options (php.ini, my.cnf, httpd.conf, ...) |
-| **[Run](Run.md)** | How to operate the devilbox, start and stop all or only required Docker container. |
-| **[Usage](Usage.md)** | How to create projects, Email and DNS usage, tools (`composer`, `npm`, `node`, `drush`, ...), entering the container, Log files, Xdebug, Backups, Intranet, ...|
-| **[OS](OS.md)** | Operating System differences between Linux, Windows and OSX. |
-| **[Backups](Backups.md)** | How to backup and restore your databases for different versions. |
-| **[Examples](Examples.md)** | Some project examples for popular CMS/Frameworks. How to setup Wordpress, Drupal, Yii, ... |
-| **[Technical](Technical.md)** | Technical background information |
-| **[Hacking](Hacking.md)** | How to extend the devilbox with your own docker container |
-| **[FAQ](FAQ.md)** | Questions and Troubleshooting |
-
-
-## 7. Video Tutorials
-
-Have a look at youtube to see some the features in action.
-
-[](https://www.youtube.com/watch?v=reyZMyt2Zzo)
-[](https://www.youtube.com/watch?v=e-U-C5WhxGY)
-
-
-## 8. Available PHP Modules
-
-The devilbox is a development stack, so it is made sure that a lot of PHP modules are available out of the box in order to work with many different frameworks.
-
-> *apc, apcu, bcmath, bz2, calendar, Core, ctype, curl, date, dom, ereg, exif, fileinfo, filter, ftp, gd, gettext, gmp, hash, iconv, igbinary, imagick, imap, intl, json, ldap, libxml, magickwand, mbstring, mcrypt, memcache, memcached, mhash, mongodb, msgpack, mysql, mysqli, mysqlnd, openssl, pcntl, pcre, PDO, pdo_mysql, pdo_pgsql, pdo_sqlite, pgsql, phalcon, Phar, posix, pspell, readline, recode, redis, Reflection, session, shmop, SimpleXML, soap, sockets, SPL, sqlite3, standard, sysvmsg, sysvsem, sysvshm, tidy, tokenizer, uploadprogress, wddx, xdebug, xml, xmlreader, xmlrpc, xmlwriter, xsl, Zend OPcache, zip, zlib*
-
-There will however be slight differences between the versions and especially with HHVM. To see the exact bundled modules for each version visit the corresponding docker repositories on Github:
-
-[PHP 5.4](https://github.com/cytopia/docker-php-fpm-5.4) |
-[PHP 5.5](https://github.com/cytopia/docker-php-fpm-5.5) |
-[PHP 5.6](https://github.com/cytopia/docker-php-fpm-5.6) |
-[PHP 7.0](https://github.com/cytopia/docker-php-fpm-7.0) |
-[PHP 7.1](https://github.com/cytopia/docker-php-fpm-7.1) |
-[PHP 7.2](https://github.com/cytopia/docker-php-fpm-7.2) |
-[HHVM](https://github.com/cytopia/docker-hhvm-latest)
-
-** Custom PHP Modules**
-
-Apart from asking for new modules to be bundled with each Docker container, you can simply also just place any missing modules into `mod/(php-fpm|hhvm)-
+
diff --git a/docs/Technical.md b/docs/Technical.md
new file mode 100644
index 00000000..eb54e139
--- /dev/null
+++ b/docs/Technical.md
@@ -0,0 +1,7 @@
+# Devilbox Documentation
+
+#### Devilbox documentation has moved to [devilbox.readthedocs.io](https://devilbox.readthedocs.io)
+
+
+
+
diff --git a/docs/Update.md b/docs/Update.md
index 7895af56..eb54e139 100644
--- a/docs/Update.md
+++ b/docs/Update.md
@@ -1,166 +1,7 @@
# Devilbox Documentation
-[Overview](README.md) |
-[Quickstart](Quickstart.md) |
-[Install](Install.md) |
-Update |
-[Configure](Configure.md) |
-[Run](Run.md) |
-[Usage](Usage.md) |
-[OS](OS.md) |
-[Backups](Backups.md) |
-[Examples](Examples.md) |
-[Technical](Technical.md) |
-[Hacking](Hacking.md) |
-[FAQ](FAQ.md)
+#### Devilbox documentation has moved to [devilbox.readthedocs.io](https://devilbox.readthedocs.io)
----
-
-## Update
-
-1. [TL;DR](#1-tldr)
-2. [Git tag vs master branch](#2-git-tag-vs-master-branch)
- 1. [Git tag](#21-git-tag)
- 2. [Git master branch](#22-git-master-branch)
-3. [Compare .env file](#3-compare-env-file)
-4. [Pull new Docker container (Important!)](#4-pull-new-docker-container-important)
-5. [Remove anonymous volumes](#5-remove-anonymous-volumes)
-
----
-
-## 1. TL;DR
-
-Shutdown, update and startup.
-
-```shell
-# Stop container, remove deprecated volumes and update git
-$ docker-compose down
-$ docker-compose rm
-$ git fetch --all
-$ git pull origin master
-
-# Check for changes
-$ vimdiff .env env-example
-
-# Pull all available container
-$ ./update-docker.sh
-# Or just pull currently enabled versions in .env
-$ docker-compose pull
-
-# Ready and run
-$ docker-compose up
-```
-
-Do not forget to read: [Pull new Docker container (Important!)](#4-pull-new-docker-container-important)
-
-
-## 2. Git tag vs master branch
-
-#### 2.1 Git tag
-
-Git tags tie each Docker container to a stable Docker tag. This will look like this in the `docker-compose.yml`
-
-```shell
-$ grep '^[[:space:]]*image:' docker-compose.yml
-
- image: cytopia/bind:0.9
- image: cytopia/${PHP_SERVER:-php-fpm-7.0}:0.9
- image: cytopia/${HTTPD_SERVER:-nginx-stable}:0.9
- image: cytopia/${MYSQL_SERVER:-mariadb-10.1}:0.9
-```
-
-That means within your current git tag, you will not receive any Docker container updates, because the devilbox is bound to specific Docker tagged versions.
-
-When a new devilbox tag is released, the `docker-compose.yml` file will have new Docker tags. There is no manuall action required. If you start up the devilbox for the first time, it will see that the container with those tags are not available locally and automatically start downloading them.
-
-So the update procedure is as follows:
-
-```shell
-$ git fetch --all
-$ git checkout "$(git describe --abbrev=0 --tags)"
-```
-
-**Note:** If you want to pre-download all available versions for later offline-usage, run the `update-docker.sh` script.
-
-```shell
-$ ./update-docker.sh
-```
-
-#### 2.2 Git master branch
-
-The git master branch ties each Docker container to their `latest` tag. Latest tagged Docker container always reflect the latest changes and can be compared with a master branch of a git repository. This will look like this in the `docker-compose.yml`
-
-```shell
-$ grep '^[[:space:]]*image:' docker-compose.yml
-
- image: cytopia/bind:latest
- image: cytopia/${PHP_SERVER:-php-fpm-7.0}:latest
- image: cytopia/${HTTPD_SERVER:-nginx-stable}:latest
- image: cytopia/${MYSQL_SERVER:-mariadb-10.1}:latest
-```
-
-When you update the devilbox repository by `git pull origin master`, the Docker tags are still `latest` and you will continue using the current version of Docker container. You must also issue `docker-compose pull` in order to also update your Docker container.
-
-So the update procedure is as follows:
-
-```shell
-$ git fetch --all
-$ git pull origin master
-$ docker-compose pull
-```
-
-**Note:** If you want to pre-download all available versions for later offline-usage, run the `update-docker.sh` script.
-
-```shell
-$ ./update-docker.sh
-```
-
-
-## 3. Compare .env file
-
-New devilbox releases will most likeley receive new or improved functionality and features and therefore will have an altered `env-example` file. (This is an example configuration file which holds all current configuration options).
-The effective configuration for docker-compose is stored in the `.env` file. However, the `.env` file is ignored by git, so that you can do changes without setting the git state dirty.
-
-So when you update (master branch or tag) you will always have to compare your current `.env` settings with the new `env-example` file. If you are familiar with vim, just do the following:
-
-```shell
-$ vimdiff .env env-example
-```
-
-Make sure to transfer all new options from `env-example` to your current `.env` file.
-
-
-## 4. Pull new Docker container (Important!)
-
-As described above, for git master branch updates you will always have to pull new Docker container. **However, there is something very important to keep in mind:**
-
-1. You have just updated the master branch and pulled new Docker container
-2. You edit the `.env` file to switch to a different PHP version
-3. You start up the devilbox. Is your new PHP Docker up to date?
-
-No! You will have to `docker-compose pull` again. Why?
-
-Lets have another look into `docker-compose.yml`:
-
-```yml
-image: cytopia/${PHP_SERVER:-php-fpm-7.0}:latest
-image: cytopia/${HTTPD_SERVER:-nginx-stable}:latest
-image: cytopia/${MYSQL_SERVER:-mariadb-10.1}:latest
-```
-
-As you can see, the Docker container names are variablized. If you updated `php-fpm-5.4:latest`, you still have to update `php-fpm-5.5:latest` (and all others) as they were not yet enabled/visible in `docker-compose.yml`.
-
-So instead of pulling everything manually, use the bundled update script to do that for all available Docker container. That will also allow you to work offline, as every available docker image will be download in their latest version.
-
-```shell
-$ ./update-docker.sh
-```
-
-
-## 5. Remove anonymous volumes
-
-The devilbox is not yet at a feature-ready stable release and volumes mounts might change from release to release until version 1.0 will be released. This can cause errors during startup. To solve those issues after updating, you should remove all anonymouse volumes with the following command:
-
-```shell
-$ docker-compose rm
-```
+
+
+
diff --git a/docs/Usage.md b/docs/Usage.md
index e6cdc081..eb54e139 100644
--- a/docs/Usage.md
+++ b/docs/Usage.md
@@ -1,403 +1,7 @@
# Devilbox Documentation
-[Overview](README.md) |
-[Quickstart](Quickstart.md) |
-[Install](Install.md) |
-[Update](Update.md) |
-[Configure](Configure.md) |
-[Run](Run.md) |
-Usage |
-[OS](OS.md) |
-[Backups](Backups.md) |
-[Examples](Examples.md) |
-[Technical](Technical.md) |
-[Hacking](Hacking.md) |
-[FAQ](FAQ.md)
+#### Devilbox documentation has moved to [devilbox.readthedocs.io](https://devilbox.readthedocs.io)
----
-
-## Usage
-
-1. [Mounted directories](#1-mounted-directories)
-2. [Work on the Docker host](#2-work-on-the-docker-host)
-3. [Work inside the PHP container](#3-work-inside-the-php-container)
- 1. [As devilbox user](#31-as-devilbox-user)
- 2. [As root user](#32-as-root-user)
- 3. [Available tools](#33-available-tools)
- 4. [Available URLs](#34-available-urls)
-4. [Managing Projects explained](#4-managing-projects-explained)
- 1. [How does it work?](#41-how-does-it-work)
- 2. [Directory structure explained](#42-directory-structure-explained)
-5. [Creating new Projects](#5-creating-new-projetcs)
- 1. [From Docker Host](#51-from-docker-host)
- 2. [From inside the PHP container](#52-from-inside-the-php-container)
- 3. [Using symlinks](#53-using-symlinks)
- 4. [Adding DNS records](#54-adding-dns-record)
- 1. [/etc/hosts](#541-etchosts)
- 2. [Auto-DNS](#542-auto-dns)
-6. [Switching container versions](#6-switching-container-versions)
- 1. [Httpd versions](#61-httpd-versions)
- 2. [PHP versions](#62-php-versions)
- 2. [SQL versions](#63-sql-versions)
- 3. [NoSQL versions](#64-nosql-versions)
-7. [Emails](#7-emails)
-8. [Log files](#8-log-files)
- 1. [Mounted logs](#81-mounted-logs)
- 2. [Docker logs](#82-docker-logs)
-9. [Intranet](#9-intranet)
- 1. [Overview](#91-overview)
- 2. [vHosts](#92-vhosts)
- 3. [Tools](#93-tools)
-
----
-
-## 1. Mounted directories
-
-Mounted directories are the bridge between the container and your host computer.
-All your projects will be available on your host computer as well as inside the Docker container.
-
-That makes it possible to work from the Docker host, by for example editing your files with your favorite editor/IDE and to run any commands, such as `npm`, `composer` or others inside the PHP container with the correct PHP version.
-
-
-## 2. Work on the Docker host
-
-If you do not need to run any command line tools manually (composer, node, etc), it is sufficient to stay on the host. All you need is a browser and an editor/IDE.
-
-1. Open your browser at http://localhost
-2. Open your project inside your editor
-3. Start coding
-
-
-**Note:** If you want to do some command-line PHP tasks and you have PHP installed on your host, make sure it is the same version as your currently started PHP Docker container. If not, just enter the PHP Docker and do the tasks there.
-
-You could however also invoke the Docker's PHP executeable (or any other binary) from your host via:
-
-```shell
-# Call a generic command
-$ docker-compose exec --user devilbox php ./data/www/project1 | ./data/www/project1/htdocs | `http://project1.loc` |
-| ./data/www/project2 | ./data/www/project2/htdocs | `http://project2.loc` |
-| ./data/www/wordpress| ./data/www/wordpress/htdocs | `http://wordpress.loc` |
-
-The VirtualHost directory make a new VirtualHost available under the specified URL. However the actual files that will be served are always expected to be in a subfolder called `htdocs/`. By having an additional sub-directory for the Document root you are able to store non-www files inside the project folder and even **symlink** you www dir to htdocs.
-
-
-## 5. Creating new Projetcs
-
-This is a general overview about creating projects. If you want to see some real examples how to setup **Wordpress**, **Drupal**, **CakePHP**, **Yii**, **Symfony** and others, visit the [Example Section](Examples.md).
-
-#### 5.1 From Docker host
-
-The following will create a VirtualHost for `http://project1.loc`.
-
-```shell
-# replace HOST_PATH_TO_HTTPD_DATADIR with the actual project base dir
-$ cd HOST_PATH_TO_HTTPD_DATADIR
-$ mkdir project1
-$ mkdir project1/htdocs
-```
-
-If you want to know how to change the TLD_SUFFIX `loc` to something else, refer to [Configure](Configure.md).
-
-#### 5.2 From inside the PHP container
-
-If you prefer to work directly inside the PHP Docker container, you can do the same. The following will create a VirtualHost for `http://project1.loc`.
-
-```shell
-$ cd /shared/httpd
-$ mkdir project1
-$ mkdir project1/htdocs
-```
-
-If you want to know how to go into the PHP container, check the section above **2. Work inside the PHP container**.
-
-#### 5.3 Using symlinks
-
-Instead of creating a **htdocs/** folder explicitly, you can also make a symlink by the same name. This is required as some frameworks have nested www folders.
-
-Keep the actual versioned wordpress name and symlink it to htdocs.
-```shell
-$ ls -l
-drwxrwxr-x 2 cytopia 4096 Jun 14 08:29 wordpress-4.8
-lrwxrwxrwx 1 cytopia 11 Jun 14 08:29 htdocs -> wordpress-4.8/
-```
-
-CakePHP serves its files from a nested folder, a symlink is required here.
-```shell
-$ ls -l
-drwxrwxr-x 2 cytopia 4096 Jun 14 08:29 cakephp
-lrwxrwxrwx 1 cytopia 11 Jun 14 08:29 htdocs -> cakephp/app/webroot/
-```
-
-#### 5.4 Adding DNS record
-
-In order to actually visit the newly created project in your browser, there must be a DNS entry pointing to the webserver's listening IP address. This can either be done automatically by a DNS server or you can do it manually for each project by editing your `/etc/hosts` file every time you create a new project.
-
-##### 5.4.1 /etc/hosts
-
-If you have not setup Auto-DNS, you will need to create your own DNS records for every project. Let's assume your `TLD_SUFFIX` is set to `loc`.
-
-| Project folder | `/etc/hosts` entry |
-|----------------|-------------------------------|
-| my-project1 | `127.0.0.1 my-project1.loc` |
-| drupal-test | `127.0.0.1 drupal-test.loc` |
-| playground | `127.0.0.1 playground.loc` |
-
-##### 5.4.2 Auto-DNS
-
-When using the devilbox built-in DNS server, there is nothing to do. DNS catch-all records for your `TLD_SUFFIX` exist and will always point to `127.0.0.1`. See [Configure](Configure.md) for how to setup Auto-DNS.
-
-
-## 6. Switching container versions
-
-Being able to combine all kinds of different container version is one of the main goals of the devilbox. Changing the versions is kept simple and consistent for all container.
-
-1. Open the `.env` file in your favorite editor
-2. Find the `*_SERVER=` block for the container to change the version
-3. Comment all lines you do not want to activate
-4. Uncomment the one line you want to use.
-5. Restart the devilbox for the changes to take effect
-
-Be aware that if multiple lines are uncommented, the last one takes effect.
-
-For an in-depth explanation about how to configure each service, you should have a look at [Configure](Configure.md).
-
-#### 6.1 Httpd versions
-
-1. Open the `.env` file in your favorite editor
-2. Find the `HTTPD_SERVER=` block
-
-You can choose between Apache and Nginx in different version. All of them are configured to work the same, there is nothing to worry about when changing them.
-
-#### 6.2 PHP versions
-
-1. Open the `.env` file in your favorite editor
-2. Find the `PHP_SERVER=` block
-
-You can choose between different PHP versions and HHVM.
-
-**Important:** Keep in mind that if you have a custom php.ini config at `./cfg/php-*/`, it is only effective for one version. Custom php configurations are separted per version.
-
-#### 6.3 SQL versions
-
-1. Open the `.env` file in your favorite editor
-2. Find the `MYSQL_SERVER=` or `PGSQL_SERVER=` block
-
-**Important:** Each version has a different data directory. This is a security precautions. Imagine you startup MySQL 5.5 for the first time. New databases will be created. Now you startup MySQL 8. All existing databases would be upgraded to work flawlessly with MySQL 8, however this is not downwards compatible. So by startup up MySQL 5.5 again, it would say the database is corrupt.
-
-#### 6.4 NoSQL versions
-
-1. Open the `.env` file in your favorite editor
-2. Find the `MONGO_SERVER=`, 'MEMCD_SERVER=` or `REDIS_SERVER=` block
-
-There is nothing to pay attention to here.
-
-
-## 7. Emails
-
-All your projects can send emails to whatever recipient. You do not have to worry that they will actually being sent. Each PHP container runs a local postfix mailserver that intercepts all outgoing mails and puts them all in the local devilbox user mail account.
-
-In order to view sent emails open up the devilbox intranet http://localhost/mail.php. There you can also test email sending and verify that they really stay locally.
-
-
-## 8. Log files
-
-#### 8.1 Mounted logs
-
-Log files are available on the Host system and separated per service version. See `./log/` (inside devilbox git directory). The `./log/` folder itself will contain subdirectories in the form `
+
diff --git a/docs/conf.py b/docs/conf.py
index 9c6234d4..03bf4333 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -55,12 +55,12 @@ templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
-source_suffix = ['.rst', '.md']
-#source_suffix = '.rst'
-
-source_parsers = {
- '.md': CommonMarkParser,
-}
+source_suffix = '.rst'
+# Exclude Markdown files for now
+#source_suffix = ['.rst', '.md']
+#source_parsers = {
+# '.md': CommonMarkParser,
+#}
# The master toctree document.
master_doc = 'index'