Merge pull request #487 from cytopia/documentation-docker-compose-override

Documentation docker compose override

.devilbox/www/config.php

@@ -14,7 +14,7 @@ putenv('RES_OPTIONS=retrans:1 retry:1 timeout:1 attempts:1');
 
 
 $DEVILBOX_VERSION = 'v0.15';
-$DEVILBOX_DATE = '2019-01-28';
+$DEVILBOX_DATE = '2019-01-29';
 $DEVILBOX_API_PAGE = 'devilbox-api/status.json';
 
 //

docs/configuration-files/docker-compose-override-yml.rst

@@ -16,6 +16,24 @@ By default, this file does not exist and you must create it. You can either copy
 .. contents:: :local:
 
 
+.. _docker_compose_override_yml_how_does_it_work:
+
+How does docker-compose.override.yml work?
+==========================================
+
+When you run ``docker-compose up``, it searches for a file named ``docker-compose.yml`` and reads
+all configured services, networks, volumes etc to create your Docker stack. If you also
+additionally have a file named ``docker-compose.override.yml`` this will be read as well and used
+as an override file to complement. It works in the following order:
+
+1. All definitions from ``docker-compose.yml`` will be used
+2. All definitions that are also defined in ``docker-compose.override.yml`` will automatically
+   overwrite the settings from ``docker-compose.yml``
+3. All definitions only available in ``docker-compose.override.yml`` will be added additionally.
+
+For starting up your Docker Compose stack there are no additional steps or command line arguments
+required. If both files exist, they will be read automatically.
+
 .. seealso:: |ext_lnk_docker_compose_extends|
 
 

docs/custom-container/enable-all-container.rst

@@ -9,6 +9,8 @@ Enable all additional container
 Besides providing basic LAMP/MEAN stack container, which are well integrated into the Devilbox
 intranet, the Devilbox also ships additional pre-configured container that can easily be enabled.
 
+.. seealso:: :ref:`docker_compose_override_yml_how_does_it_work`
+
 
 **Table of Contents**
 

docs/custom-container/enable-blackfire.rst

@@ -12,6 +12,7 @@ This section will guide you through getting Blackfire integrated into the Devilb
    * |ext_lnk_blackfire_github|
    * |ext_lnk_blackfire_dockerhub|
    * :ref:`custom_container_enable_all_additional_container`
+   * :ref:`docker_compose_override_yml_how_does_it_work`
 
 
 **Table of Contents**

docs/custom-container/enable-mailhog.rst

@@ -12,6 +12,7 @@ This section will guide you through getting MailHog integrated into the Devilbox
    * |ext_lnk_mailhog_github|
    * |ext_lnk_mailhog_dockerhub|
    * :ref:`custom_container_enable_all_additional_container`
+   * :ref:`docker_compose_override_yml_how_does_it_work`
 
 
 **Table of Contents**

docs/custom-container/enable-rabbitmq.rst

@@ -12,6 +12,7 @@ This section will guide you through getting RabbitMQ integrated into the Devilbo
    * |ext_lnk_rabbitmq_github|
    * |ext_lnk_rabbitmq_dockerhub|
    * :ref:`custom_container_enable_all_additional_container`
+   * :ref:`docker_compose_override_yml_how_does_it_work`
 
 
 **Table of Contents**

docs/custom-container/enable-solr.rst

@@ -12,6 +12,7 @@ This section will guide you through getting Solr integrated into the Devilbox.
    * |ext_lnk_solr_github|
    * |ext_lnk_solr_dockerhub|
    * :ref:`custom_container_enable_all_additional_container`
+   * :ref:`docker_compose_override_yml_how_does_it_work`
 
 
 **Table of Contents**