Merge pull request #524 from cytopia/documentation-contao

Documentation Contao CMS

CHANGELOG.md

@@ -69,14 +69,15 @@ major versions.
     - `rdkafka`
     - `sqlsrv`
 - Framework documentation:
-    - Shopware CMS
-    - Presta Shop
-    - Photon CMS
     - Codeignitor
-    - Typo3
+    - Contao CMS
     - Craft CMS
     - NodeJS Reverse proxy
+    - Photon CMS
+    - Presta Shop
+    - Shopware CMS
     - Sphinx documentation Reverse proxy
+    - Typo3
 - GitHub Issue templates
 - Discourse forum link: https://devilbox.discourse.group
 

README.md

@@ -802,6 +802,7 @@ As far as tested there are no limitations and you can use any Framework or CMS j
 
 <a target="_blank" title="CakePHP" href="https://cakephp.org"><img width="64" style="width:64px" src="docs/img/logo_fw/cake.png" alt="Devilbox"/></a>
 <a target="_blank" title="CodeIgniter" href="https://www.codeigniter.com"><img width="64" style="width:64px" src="docs/img/logo_fw/codeigniter.png" alt="Devilbox"/></a>
+<a target="_blank" title="Contao" href="https://contao.org/en/"><img width="64" style="width:64px" src="docs/img/logo_fw/contao.png" alt="Devilbox"/></a>
 <a target="_blank" title="CraftCMS" href="https://craftcms.com/"><img width="64" style="width:64px" src="docs/img/logo_fw/craftcms.png" alt="Devilbox"/></a>
 <a target="_blank" title="Drupal" href="https://www.drupal.org"><img width="64" style="width:64px" src="docs/img/logo_fw/drupal.png" alt="Devilbox"/></a>
 <a target="_blank" title="Joomla" href="https://www.joomla.org"><img width="64" style="width:64px" src="docs/img/logo_fw/joomla.png" alt="Devilbox"/></a>
@@ -820,6 +821,7 @@ As far as tested there are no limitations and you can use any Framework or CMS j
 > **Documentation:**<br/>
 > [Setup CakePHP](https://devilbox.readthedocs.io/en/latest/examples/setup-cakephp.html) |
 > [Setup CodeIgniter](https://devilbox.readthedocs.io/en/latest/examples/setup-codeigniter.html) |
+> [Setup Contao](https://devilbox.readthedocs.io/en/latest/examples/setup-contao.html) |
 > [Setup CraftCMS](https://devilbox.readthedocs.io/en/latest/examples/setup-craftcms.html) |
 > [Setup Drupal](https://devilbox.readthedocs.io/en/latest/examples/setup-drupal.html) |
 > [Setup Joomla](https://devilbox.readthedocs.io/en/latest/examples/setup-joomla.html) |

docs/_includes/figures/examples/contao/01-frontend.rst

@@ -0,0 +1,4 @@
+.. figure:: /_includes/figures/examples/contao/01-frontend.png
+   :width: 400px
+
+   Contao installation: Installation incomplete note

docs/_includes/figures/examples/contao/02-license.rst

@@ -0,0 +1,4 @@
+.. figure:: /_includes/figures/examples/contao/02-license.png
+   :width: 400px
+
+   Contao installation: Accept license

docs/_includes/figures/examples/contao/03-install-tool-password.rst

@@ -0,0 +1,4 @@
+.. figure:: /_includes/figures/examples/contao/03-install-tool-password.png
+   :width: 400px
+
+   Contao installation: Set install tool password

docs/_includes/figures/examples/contao/04-database-setup.rst

@@ -0,0 +1,4 @@
+.. figure:: /_includes/figures/examples/contao/04-database-setup.png
+   :width: 400px
+
+   Contao installation: Database setup

docs/_includes/figures/examples/contao/05-update-database.rst

@@ -0,0 +1,4 @@
+.. figure:: /_includes/figures/examples/contao/05-update-database.png
+   :width: 400px
+
+   Contao installation: Update database

docs/_includes/figures/examples/contao/06-create-admin-user.rst

@@ -0,0 +1,4 @@
+.. figure:: /_includes/figures/examples/contao/06-create-admin-user.png
+   :width: 400px
+
+   Contao installation: Create admin user

docs/_includes/figures/examples/contao/07-finished.rst

@@ -0,0 +1,4 @@
+.. figure:: /_includes/figures/examples/contao/07-finished.png
+   :width: 400px
+
+   Contao installation: Installation successfully finished

docs/_includes/figures/examples/contao/08-login-screen.rst

@@ -0,0 +1,4 @@
+.. figure:: /_includes/figures/examples/contao/08-login-screen.png
+   :width: 400px
+
+   Contao installation: Go to login screen

docs/_includes/links/examples.rst

@@ -10,6 +10,12 @@
      Official CodeIgniter Documentation <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
    </a>
 
+.. |ext_lnk_example_contao_documentation| raw:: html
+
+   <a target="_blank" href="https://docs.contao.org/books/manual/current/en/01-installation/installing-contao.html">
+     Official Contao Documentation <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
+   </a>
+
 .. |ext_lnk_example_craftcms_documentation| raw:: html
 
    <a target="_blank" href="https://docs.craftcms.com/v3/installation.html#step-1-download-craft">

docs/_includes/snippets/__ANNOUNCEMENTS__.rst

@@ -0,0 +1,7 @@
+.. raw:: html
+
+   <div style="background-color:#dddcb7; border: 3px solid #DA111A; padding:10px 20px; margin-bottom:20px;">
+       <h1 style="margin-bottom:15px;">Important Announcement</h1>
+       <p style="margin:5px;">Everybody is strongly encouraged to switch to the upcoming v1.0.0 release version to prevent unforseen issues upon merge to master.</p>
+       <p style="margin:5px;"><strong>Instructions here:</strong> <a target="_blank" href="https://github.com/cytopia/devilbox/pull/416">https://github.com/cytopia/devilbox/pull/416</a>.</p>
+   </div>

docs/_includes/snippets/examples/next-steps.rst

@@ -0,0 +1,44 @@
+Once everything is installed and setup correctly, you might be interested in a few follow-up topics.
+
+Use bundled batteries
+---------------------
+
+The Devilbox ships most common Web UIs accessible from the intranet.
+
+.. seealso::
+   * :ref:`devilbox_intranet_adminer`
+   * :ref:`devilbox_intranet_phpmyadmin`
+   * :ref:`devilbox_intranet_phppgadmin`
+   * :ref:`devilbox_intranet_phpredmin`
+
+Enhance the Devilbox
+--------------------
+
+Go ahead and make the Devilbox more smoothly by setting up its core features.
+
+.. seealso::
+   * :ref:`setup_valid_https`
+   * :ref:`setup_auto_dns`
+   * :ref:`configure_php_xdebug`
+
+Add services
+------------
+
+In case your framework/CMS requires it, attach caching, queues, database or performance tools.
+
+.. seealso::
+
+   * :ref:`custom_container_enable_blackfire`
+   * :ref:`custom_container_enable_rabbitmq`
+   * :ref:`custom_container_enable_solr`
+   * :ref:`custom_container_enable_varnish`
+
+Container tools
+---------------
+
+Stay inside the container and use what's available.
+
+.. seealso::
+
+   * :ref:`available_tools`
+   * :ref:`source_code_analysis`

docs/advanced/add-custom-cname-records.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _add_custom_cname_records:
 

docs/advanced/add-your-own-docker-image.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _add_your_own_docker_image:
 

docs/advanced/connect-to-external-hosts.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _connect_to_external_hosts:
 
 *************************

docs/advanced/connect-to-host-os.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _connect_to_host_os:
 

docs/advanced/connect-to-other-docker-container.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _connect_to_other_docker_container:
 

docs/advanced/customize-php-globally.rst

@@ -1,5 +1,6 @@
-.. _customize_php_globally:
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
+.. _customize_php_globally:
 
 **********************
 Customize PHP globally

docs/advanced/customize-webserver-globally.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 *****************************
 Customize web server globally
 *****************************

docs/advanced/overwrite-existing-docker-image.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _overwrite_existing_docker_image:
 
 *******************************

docs/autostart/autostarting-nodejs-apps.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _autostarting_nodejs_apps:
 

docs/autostart/custom-scripts-globally.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _custom_scripts_globally:
 
 ***********************

docs/autostart/custom-scripts-per-php-version.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _custom_scripts_per_php_version:
 
 ******************************

docs/configuration-files/apache-conf.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _apache_conf:
 
 ***********

docs/configuration-files/bashrc-sh.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _bashrc_sh:
 
 *********

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

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _docker_compose_override_yml:
 

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

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _docker_compose_yml:
 
 ******************

docs/configuration-files/env-file.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _env_file:
 

docs/configuration-files/my-cnf.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _my_cnf:
 
 ******

docs/configuration-files/nginx-conf.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _nginx_conf:
 
 **********

docs/configuration-files/php-fpm-conf.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _php_fpm_conf:
 
 ************

docs/configuration-files/php-ini.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _php_ini:
 
 *******

docs/corporate-usage/shared-devilbox-server-in-lan.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _shared_devilbox_server_in_lan:
 
 *****************************

docs/corporate-usage/showcase-over-the-internet.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _showcase_over_the_internet:
 

docs/corporate-usage/use-external-databases.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _use_external_databases:
 

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

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _custom_container_enable_all_additional_container:
 

docs/custom-container/enable-blackfire.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _custom_container_enable_blackfire:
 

docs/custom-container/enable-elk-stack.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _custom_container_enable_elk_stack:
 

docs/custom-container/enable-mailhog.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _custom_container_enable_mailhog:
 

docs/custom-container/enable-ngrok.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _custom_container_enable_ngrok:
 

docs/custom-container/enable-rabbitmq.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _custom_container_enable_rabbitmq:
 

docs/custom-container/enable-solr.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _custom_container_enable_solr:
 

docs/custom-container/enable-varnish.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _custom_container_enable_varnish:
 

docs/devilbox-purpose.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 ****************
 Devilbox purpose
 ****************

docs/examples/setup-cakephp.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_cakephp:
 
@@ -8,6 +9,13 @@ Setup CakePHP
 
 This example will use ``composer`` to install CakePHP from within the Devilbox PHP container.
 
+.. important::
+   Using ``composer`` requires the underlying file system to support symlinks. If you
+   use **Docker Toolbox** you need to explicitly allow/enable this.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 After completing the below listed steps, you will have a working CakePHP setup ready to be
 served via http and https.
 
@@ -134,6 +142,12 @@ How does the directory structure look after symlinking:
 As you can see from the above directory structure, ``htdocs`` is available in its expected
 path and points to the frameworks entrypoint.
 
+.. important::
+   When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 
 5. Add MySQL Database
 ---------------------
@@ -203,4 +217,8 @@ host operating systems ``/etc/hosts`` file (or ``C:\Windows\System32\drivers\etc
 
 All set now, you can visit http://my-cake.loc or https://my-cake.loc in your browser.
 
-.. seealso:: :ref:`setup_valid_https`
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-codeigniter.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_codeigniter:
 
@@ -137,6 +138,12 @@ How does the directory structure look after symlinking:
 As you can see from the above directory structure, ``htdocs`` is available in its expected
 path and points to the frameworks entrypoint.
 
+.. important::
+   When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 
 5. Add MySQL Database
 ---------------------
@@ -208,3 +215,9 @@ host operating systems ``/etc/hosts`` file (or ``C:\Windows\System32\drivers\etc
 All set now, you can visit http://my-ci.loc or https://my-ci.loc in your browser.
 
 .. seealso:: :ref:`setup_valid_https`
+
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-contao.rst

@@ -0,0 +1,264 @@
+.. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
+.. _example_setup_contao:
+
+************
+Setup Contao
+************
+
+This example will use ``composer`` to install Contao CMS from within the Devilbox PHP container.
+
+.. important::
+   Using ``composer`` requires the underlying file system to support symlinks. If you
+   use **Docker Toolbox** you need to explicitly allow/enable this.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
+After completing the below listed steps, you will have a working Contao CMS setup ready to be
+served via http and https.
+
+.. seealso:: |ext_lnk_example_contao_documentation|
+
+
+**Table of Contents**
+
+.. contents:: :local:
+
+
+Overview
+========
+
+The following configuration will be used:
+
++--------------+--------------------------+-------------+------------+-------------------------------------------------+
+| Project name | VirtualHost directory    | Database    | TLD_SUFFIX | Project URL                                     |
++==============+==========================+=============+============+=================================================+
+| my-contao    | /shared/httpd/my-contao  | my_contao   | loc        | http://my-contao.loc |br| https://my-contao.loc |
++--------------+--------------------------+-------------+------------+-------------------------------------------------+
+
+.. note::
+   * Inside the Devilbox PHP container, projects are always in ``/shared/httpd/``.
+   * On your host operating system, projects are by default in ``./data/www/`` inside the
+     Devilbox git directory. This path can be changed via :ref:`env_httpd_datadir`.
+
+The following Devilbox configuration is required:
+
++-----------+--------------+------------------------------------------------------------------------------------------------+
+| Service   | Version      | Implications                                                                                   |
++===========+==============+================================================================================================+
+| Webserver | Apache 2.4   | Apache is required instead of Nginx as Contao provides default ``.htaccess`` files for routing |
++-----------+--------------+------------------------------------------------------------------------------------------------+
+| PHP       | PHP-FPM 7.2  | Chosen for this example as it is the Devilbox default version                                  |
++-----------+--------------+------------------------------------------------------------------------------------------------+
+| Database  | MariaDB 10.3 | Chosen for this example as it is the Devilbox default version                                  |
++-----------+--------------+------------------------------------------------------------------------------------------------+
+
+.. note:: If you want to use Nginx instead, you will need to adjust the vhost congfiguration accordingly to Contao CMS requirements.
+
+
+Walk through
+============
+
+It will be ready in eight simple steps:
+
+1. Enter the PHP container
+2. Create a new VirtualHost directory
+3. Install Contao via ``composer``
+4. Symlink webroot directory
+5. Add MySQL database
+6. Setup DNS record
+7. Visit http://my-contao.loc in your browser
+
+
+1. Enter the PHP container
+--------------------------
+
+All work will be done inside the PHP container as it provides you with all required command line
+tools.
+
+Navigate to the Devilbox git directory and execute ``shell.sh`` (or ``shell.bat`` on Windows) to
+enter the running PHP container.
+
+.. code-block:: bash
+
+   host> ./shell.sh
+
+.. seealso::
+   * :ref:`enter_the_php_container`
+   * :ref:`work_inside_the_php_container`
+   * :ref:`available_tools`
+
+
+2. Create new vhost directory
+-----------------------------
+
+The vhost directory defines the name under which your project will be available. |br|
+( ``<vhost dir>.TLD_SUFFIX`` will be the final URL ).
+
+.. code-block:: bash
+
+   devilbox@php-7.2.15 in /shared/httpd $ mkdir my-contao
+
+.. seealso:: :ref:`env_tld_suffix`
+
+
+3. Install Contao
+-----------------
+
+Navigate into your newly created vhost directory and install Contao with ``composer``.
+
+.. code-block:: bash
+
+   devilbox@php-7.2.15 in /shared/httpd $ cd my-contao
+   devilbox@php-7.2.15 in /shared/httpd/my-contao $ composer create-project contao/managed-edition contao
+
+How does the directory structure look after installation:
+
+.. code-block:: bash
+
+   devilbox@php-7.2.15 in /shared/httpd/my-contao $ tree -L 1
+   .
+   └── contao
+
+   1 directory, 0 files
+
+
+4. Symlink web
+--------------
+
+Symlinking the actual webroot directory to ``htdocs`` is important. The web server expects every
+project's document root to be in ``<vhost dir>/htdocs/``. This is the path where it will serve
+the files. This is also the path where your frameworks entrypoint (usually ``index.php``) should
+be found.
+
+Some frameworks however provide its actual content in nested directories of unknown levels.
+This would be impossible to figure out by the web server, so you manually have to symlink it back
+to its expected path.
+
+.. code-block:: bash
+
+   devilbox@php-7.2.15 in /shared/httpd/my-contao $ ln -s contao/web/ htdocs
+
+How does the directory structure look after symlinking:
+
+.. code-block:: bash
+
+   devilbox@php-7.2.15 in /shared/httpd/my-contao $ tree -L 1
+   .
+   ├── contao
+   └── htdocs -> contao/web
+
+   2 directories, 0 files
+
+As you can see from the above directory structure, ``htdocs`` is available in its expected
+path and points to the frameworks entrypoint.
+
+.. important::
+   When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
+
+5. Add MySQL Database
+---------------------
+
+.. code-block:: bash
+
+   devilbox@php-7.2.15 in /shared/httpd/my-contao $ mysql -u root -h mysql -p -e 'CREATE DATABASE my_contao;'
+
+
+6. DNS record
+-------------
+
+If you **have** Auto DNS configured already, you can skip this section, because DNS entries will
+be available automatically by the bundled DNS server.
+
+If you **don't have** Auto DNS configured, you will need to add the following line to your
+host operating systems ``/etc/hosts`` file (or ``C:\Windows\System32\drivers\etc`` on Windows):
+
+.. code-block:: bash
+   :caption: /etc/hosts
+
+   127.0.0.1 my-contao.loc
+
+.. seealso::
+
+   * :ref:`howto_add_project_hosts_entry_on_mac`
+   * :ref:`howto_add_project_hosts_entry_on_win`
+   * :ref:`setup_auto_dns`
+
+
+7. Open your browser
+--------------------
+
+Open your browser at http://my-contao.loc or https://my-contao.loc and follow the installation steps.
+
+7.1 Frontend page
+^^^^^^^^^^^^^^^^^
+
+.. include:: /_includes/figures/examples/contao/01-frontend.rst
+
+* Follow the presented instructions and go to:
+    - either http://my-contao.loc/contao/install
+    - or https://my-contao.loc/contao/install
+
+7.2 Accept license
+^^^^^^^^^^^^^^^^^^
+
+Accept the license by clicking on ``Accept license``
+
+.. include:: /_includes/figures/examples/contao/02-license.rst
+
+7.3 Set install tool password
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Set a password for the install tool itself
+
+.. include:: /_includes/figures/examples/contao/03-install-tool-password.rst
+
+7.4 Database setup
+^^^^^^^^^^^^^^^^^^
+
+* Database host: ``mysql``
+* Database port: ``3306``
+* Database user: ``root``
+* Database pass: empty (if not otherwise set during Devilbox configuration)
+
+.. include:: /_includes/figures/examples/contao/04-database-setup.rst
+
+7.5 Update database
+^^^^^^^^^^^^^^^^^^^
+
+Click on ``update database`` to populate the database.
+
+.. include:: /_includes/figures/examples/contao/05-update-database.rst
+
+7.6 Set admin user
+^^^^^^^^^^^^^^^^^^
+
+The admin user is required to setup Contao itself and to gain access to the backend.
+
+.. include:: /_includes/figures/examples/contao/06-create-admin-user.rst
+
+7.7 Finished
+^^^^^^^^^^^^
+
+Installation is done, click on the ``Contao back end`` to continue to setup the CMS itself.
+
+.. include:: /_includes/figures/examples/contao/07-finished.rst
+
+7.8 Login
+^^^^^^^^^
+
+Use the admin user credentials created earlier to login in.
+
+.. include:: /_includes/figures/examples/contao/08-login-screen.rst
+
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-craftcms.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_craftcms:
 
@@ -8,6 +9,13 @@ Setup CraftCMS
 
 This example will use ``composer`` to install CraftCMS from within the Devilbox PHP container.
 
+.. important::
+   Using ``composer`` requires the underlying file system to support symlinks. If you
+   use **Docker Toolbox** you need to explicitly allow/enable this.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 After completing the below listed steps, you will have a working CraftCMS setup ready to be
 served via http and https.
 
@@ -134,6 +142,12 @@ How does the directory structure look after symlinking:
 As you can see from the above directory structure, ``htdocs`` is available in its expected
 path and points to the frameworks entrypoint.
 
+.. important::
+   When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 
 5. Add MySQL Database
 ---------------------
@@ -228,4 +242,8 @@ To open the setup wizard, visit: http://my-craft.loc/admin/install or https://my
 
 All set now, you can visit http://my-craft.loc or https://my-craft.loc in your browser.
 
-.. seealso:: :ref:`setup_valid_https`
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-drupal.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_drupal:
 
@@ -132,6 +133,12 @@ How does the directory structure look after symlinking:
 As you can see from the above directory structure, ``htdocs`` is available in its expected
 path and points to the frameworks entrypoint.
 
+.. important::
+   When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 
 5. DNS record
 -------------
@@ -163,4 +170,8 @@ installation steps.
 .. note::
    When asked about MySQL hostname, choose ``127.0.0.1``.
 
-.. seealso:: :ref:`setup_valid_https`
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-joomla.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_joomla:
 
@@ -136,6 +137,12 @@ How does the directory structure look after symlinking it:
 As you can see from the above directory structure, ``htdocs`` is available in its expected
 path and points to the frameworks entrypoint.
 
+.. important::
+   When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 
 5. DNS record
 -------------
@@ -162,4 +169,8 @@ host operating systems ``/etc/hosts`` file (or ``C:\Windows\System32\drivers\etc
 
 All set now, you can visit http://my-joomla.loc or https://my-joomla.loc in your browser.
 
-.. seealso:: :ref:`setup_valid_https`
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-laravel.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_laravel:
 
@@ -133,6 +134,12 @@ How does the directory structure look after symlinking:
 As you can see from the above directory structure, ``htdocs`` is available in its expected
 path and points to the frameworks entrypoint.
 
+.. important::
+   When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 
 5. DNS record
 -------------
@@ -164,4 +171,8 @@ This will ensure that your host operating system's browser will direct any calls
 
 Open your browser at http://my-laravel.loc or https://my-laravel.loc
 
-.. seealso:: :ref:`setup_valid_https`
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-magento2.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_magento:
 
@@ -8,6 +9,13 @@ Setup Magento 2
 
 This example will use ``git`` and ``composer`` to install Magento 2 from within the Devilbox PHP container.
 
+.. important::
+   Using ``composer`` requires the underlying file system to support symlinks. If you
+   use **Docker Toolbox** you need to explicitly allow/enable this.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 After completing the below listed steps, you will have a working Magento 2 setup ready to be
 served via http and https.
 
@@ -156,6 +164,12 @@ How does the directory structure look after symlinking:
 As you can see from the above directory structure, ``htdocs`` is available in its expected
 path and points to the frameworks entrypoint.
 
+.. important::
+   When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 
 5. Add MySQL Database
 ---------------------
@@ -195,4 +209,8 @@ and follow the installation steps.
 .. important::
    Use ``127.0.0.1`` for the MySQL database hostname.
 
-.. seealso:: :ref:`setup_valid_https`
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-other-frameworks.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _example_setup_other_frameworks:
 
 **********************

docs/examples/setup-phalcon.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_phalcon:
 
@@ -133,6 +134,12 @@ How does the directory structure look after symlinking:
 As you can see from the above directory structure, ``htdocs`` is available in its expected
 path and points to the frameworks entrypoint.
 
+.. important::
+   When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 
 5. DNS record
 -------------
@@ -160,8 +167,6 @@ host operating systems ``/etc/hosts`` file (or ``C:\Windows\System32\drivers\etc
 
 Open your browser at http://my-phalcon.loc or https://my-phalcon.loc
 
-.. seealso:: :ref:`setup_valid_https`
-
 
 7. Create custom vhost config file (Nginx Only)
 -----------------------------------------------
@@ -185,3 +190,9 @@ to
 ``location ~ [^/]\.php(/|$) {``
 
 save the file as nginx.yml and ensure not to use any tabs in the file or devilbox will not use the custom configuration. You can use ``yamllint nginx.yml`` whilst inside the Devilbox shell to check the file before restarting devilbox.
+
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-photon-cms.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_photon_cms:
 
@@ -141,6 +142,12 @@ How does the directory structure look after symlinking:
 As you can see from the above directory structure, ``htdocs`` is available in its expected
 path and points to the frameworks entrypoint.
 
+.. important::
+   When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 
 5. DNS record
 -------------
@@ -168,4 +175,8 @@ host operating systems ``/etc/hosts`` file (or ``C:\Windows\System32\drivers\etc
 
 Open your browser at http://my-photon.loc or https://my-photon.loc
 
-.. seealso:: :ref:`setup_valid_https`
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-presta-shop.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_presta_shop:
 
@@ -9,6 +10,13 @@ Setup PrestaShop
 This example will use ``git`` and ``composer`` to install PrestaShop from within the Devilbox
 PHP container.
 
+.. important::
+   Using ``composer`` requires the underlying file system to support symlinks. If you
+   use **Docker Toolbox** you need to explicitly allow/enable this.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 After completing the below listed steps, you will have a working PrestaShop setup ready to be
 served via http and https.
 
@@ -144,6 +152,12 @@ How does the directory structure look after symlinking:
 As you can see from the above directory structure, ``htdocs`` is available in its expected
 path and points to the frameworks entrypoint.
 
+.. important::
+   When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 
 5. Add MySQL Database
 ---------------------
@@ -180,4 +194,8 @@ host operating systems ``/etc/hosts`` file (or ``C:\Windows\System32\drivers\etc
 All set now, you can visit http://my-presta.loc or https://my-presta.loc in your browser and
 follow the installation steps.
 
-.. seealso:: :ref:`setup_valid_https`
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-reverse-proxy-nodejs.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_reverse_proxy_nodejs:
 
@@ -409,9 +410,6 @@ All set now, you can visit http://my-node.loc or https://my-node.loc in your bro
 The NodeJS application has been started up automatically and the reverse proxy will direct all
 requests to it.
 
-.. seealso:: :ref:`setup_valid_https`
-
-
 
 Managing NodeJS
 ===============
@@ -438,3 +436,8 @@ with the available commands. A quick guide is below:
    │ index    │ 0  │ N/A     │ fork │ 1906 │ online │ 0       │ 42h    │ 0%  │ 39.7 MB   │ devilbox │ disabled │
    └──────────┴────┴─────────┴──────┴──────┴────────┴─────────┴────────┴─────┴───────────┴──────────┴──────────┘
 
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-reverse-proxy-sphinx-docs.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_reverse_proxy_sphinx_docs:
 
@@ -422,7 +423,8 @@ All set now, you can visit http://my-sphinx.loc or https://my-sphinx.loc in your
 The Sphinx application has been started up automatically and the reverse proxy will direct all
 requests to it.
 
-.. seealso:: :ref:`setup_valid_https`
-
 
+Next steps
+==========
 
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-shopware.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_shopware:
 
@@ -135,6 +136,12 @@ How does the directory structure look after symlinking:
 As you can see from the above directory structure, ``htdocs`` is available in its expected
 path and points to the frameworks entrypoint.
 
+.. important::
+   When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 
 5. Add MySQL Database
 ---------------------
@@ -179,8 +186,6 @@ installation steps as described in the |ext_lnk_example_shopware_documentation|:
    * Database pass: by default the root password is empty
    * Database name: ``my_sw``
 
-.. seealso:: :ref:`setup_valid_https`
-
 
 Encountered problems
 ====================
@@ -189,3 +194,9 @@ By the time of writing (2018-07-07) Shopware had loading issues with the combina
 and ``Apache 2.4``. Use any other combination.
 
 .. seealso:: https://github.com/cytopia/devilbox/issues/300
+
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-symfony.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_symfony:
 
@@ -133,6 +134,12 @@ How does the directory structure look after symlinking:
 As you can see from the above directory structure, ``htdocs`` is available in its expected
 path and points to the frameworks entrypoint.
 
+.. important::
+   When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 
 5. Enable Symfony prod (``app.php``)
 ------------------------------------
@@ -169,4 +176,8 @@ host operating systems ``/etc/hosts`` file (or ``C:\Windows\System32\drivers\etc
 
 Open your browser at http://my-symfony.loc or https://my-symfony.loc
 
-.. seealso:: :ref:`setup_valid_https`
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-typo3.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_typo3:
 
@@ -8,6 +9,13 @@ Setup Typo3
 
 This example will use ``composer`` to install Typo3 from within the Devilbox PHP container.
 
+.. important::
+   Using ``composer`` requires the underlying file system to support symlinks. If you
+   use **Docker Toolbox** you need to explicitly allow/enable this.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 After completing the below listed steps, you will have a working Laravel setup ready to be
 served via http and https.
 
@@ -134,6 +142,12 @@ How does the directory structure look after symlinking:
 As you can see from the above directory structure, ``htdocs`` is available in its expected
 path and points to the frameworks entrypoint.
 
+.. important::
+   When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 
 5. DNS record
 -------------
@@ -172,8 +186,6 @@ To continue installing via the guided web install, you need to create a file cal
 
 Open your browser at http://my-typo.loc or https://my-typo.loc.
 
-.. seealso:: :ref:`setup_valid_https`
-
 
 8. Step through guided web installation
 ---------------------------------------
@@ -199,3 +211,9 @@ Open your browser at http://my-typo.loc or https://my-typo.loc.
 4. Installation complete
 
    * Create empty starting page
+
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-wordpress.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_wordpress:
 
@@ -133,6 +134,12 @@ How does the directory structure look after symlinking:
 As you can see from the above directory structure, ``htdocs`` is available in its expected
 path and points to the frameworks entrypoint.
 
+.. important::
+   When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 
 5. Add MySQL Database
 ---------------------
@@ -168,8 +175,6 @@ host operating systems ``/etc/hosts`` file (or ``C:\Windows\System32\drivers\etc
 
 Open your browser at http://my-wp.loc or https://my-wp.loc and follow the installation steps.
 
-.. seealso:: :ref:`setup_valid_https`
-
 **(1/7) Choose your desired Wordpress language**
 
 .. include:: /_includes/figures/examples/wordpress/01-choose-language.rst
@@ -199,3 +204,9 @@ Open your browser at http://my-wp.loc or https://my-wp.loc and follow the instal
 **(7/7) Login to Admin panel**
 
 .. include:: /_includes/figures/examples/wordpress/07-login.rst
+
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-yii.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_yii:
 
@@ -8,6 +9,13 @@ Setup Yii
 
 This example will use ``composer`` to install Yii from within the Devilbox PHP container.
 
+.. important::
+   Using ``composer`` requires the underlying file system to support symlinks. If you
+   use **Docker Toolbox** you need to explicitly allow/enable this.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 After completing the below listed steps, you will have a working Yii setup ready to be
 served via http and https.
 
@@ -132,6 +140,12 @@ How does the directory structure look after symlinking:
 As you can see from the above directory structure, ``htdocs`` is available in its expected
 path and points to the frameworks entrypoint.
 
+.. important::
+   When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 
 5. DNS record
 -------------
@@ -159,4 +173,8 @@ host operating systems ``/etc/hosts`` file (or ``C:\Windows\System32\drivers\etc
 
 Open your browser at http://my-yii.loc or https://my-yii.loc
 
-.. seealso:: :ref:`setup_valid_https`
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/examples/setup-zend.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _example_setup_zend:
 
@@ -8,6 +9,13 @@ Setup Zend
 
 This example will use ``composer`` to install Zend from within the PHP container.
 
+.. important::
+   Using ``composer`` requires the underlying file system to support symlinks. If you
+   use **Docker Toolbox** you need to explicitly allow/enable this.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 .. seealso:: |ext_lnk_example_zend_documentation|
 
 
@@ -129,6 +137,12 @@ How does the directory structure look after symlinking:
 As you can see from the above directory structure, ``htdocs`` is available in its expected
 path and points to the frameworks entrypoint.
 
+.. important::
+   When using **Docker Toolbox**, you need to **explicitly allow** the usage of **symlinks**.
+   See below for instructions:
+
+   * Docker Toolbox and :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
+
 
 5. DNS record
 -------------
@@ -156,4 +170,8 @@ host operating systems ``/etc/hosts`` file (or ``C:\Windows\System32\drivers\etc
 
 Open your browser at http://my-zend.loc or https://my-zend.loc
 
-.. seealso:: :ref:`setup_valid_https`
+
+Next steps
+==========
+
+.. include:: /_includes/snippets/examples/next-steps.rst

docs/features.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _features:
 

docs/getting-started/change-container-versions.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 *************************
 Change container versions
 *************************

docs/getting-started/create-your-first-project.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _getting_started_create_your_first_project:
 
 *************************

docs/getting-started/devilbox-intranet.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _devilbox_intranet:
 
@@ -76,6 +77,8 @@ The following example shows you the info page for MySQL:
 Third-party tools
 =================
 
+.. _devilbox_intranet_adminer:
+
 Adminer
 -------
 
@@ -84,6 +87,7 @@ management tool written in PHP. Conversely to phpMyAdmin, it consist of a single
 deploy to the target server. Adminer is available for MySQL, MariaDB, PostgreSQL, SQLite, MS SQL,
 Oracle, Firebird, SimpleDB, Elasticsearch and MongoDB.
 
+.. _devilbox_intranet_phpmyadmin:
 
 phpMyAdmin
 ----------
@@ -94,6 +98,7 @@ of operations on MySQL and MariaDB. Frequently used operations (managing databas
 columns, relations, indexes, users, permissions, etc) can be performed via the user interface,
 while you still have the ability to directly execute any SQL statement.
 
+.. _devilbox_intranet_phppgadmin:
 
 phpPgAdmin
 ----------
@@ -101,6 +106,7 @@ phpPgAdmin
 |ext_lnk_tool_phppgadmin| is a web-based administration tool for PostgreSQL. It is perfect for
 PostgreSQL DBAs, newbies, and hosting services.
 
+.. _devilbox_intranet_phpredmin:
 
 phpRedMin
 ----------

docs/getting-started/directory-overview.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _getting_started_directory_overview:
 
 ******************

docs/getting-started/enter-the-php-container.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _enter_the_php_container:
 
 ***********************

docs/getting-started/important.rst

@@ -1,3 +1,5 @@
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 *********
 IMPORTANT
 *********

docs/getting-started/install-the-devilbox.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _install_the_devilbox:
 

docs/getting-started/prerequisites.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _prerequisites:
 

docs/getting-started/start-the-devilbox.rst

@@ -1,4 +1,5 @@
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _start_the_devilbox:
 

docs/howto/devilbox/find-docker-and-docker-compose-version.rst

@@ -1,5 +1,7 @@
 :orphan:
 
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _howto_find_docker_and_docker_compose_version:
 
 **************************************

docs/howto/devilbox/move-projects-to-different-directory.rst

@@ -1,5 +1,7 @@
 :orphan:
 
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _howto_move_projects_to_a_different_directory:
 
 **************************************

docs/howto/dns/add-custom-dns-server-on-android.rst

@@ -1,6 +1,7 @@
 :orphan:
 
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _howto_add_custom_dns_server_on_android:
 

docs/howto/dns/add-custom-dns-server-on-iphone.rst

@@ -1,6 +1,7 @@
 :orphan:
 
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _howto_add_custom_dns_server_on_iphone:
 

docs/howto/dns/add-custom-dns-server-on-linux.rst

@@ -1,6 +1,7 @@
 :orphan:
 
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _howto_add_custom_dns_server_on_linux:
 

docs/howto/dns/add-custom-dns-server-on-mac.rst

@@ -1,5 +1,7 @@
 :orphan:
 
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _howto_add_custom_dns_server_on_mac:
 
 ******************************

docs/howto/dns/add-custom-dns-server-on-win.rst

@@ -1,5 +1,7 @@
 :orphan:
 
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _howto_add_custom_dns_server_on_win:
 
 ********************************

docs/howto/dns/add-project-dns-entry-on-linux.rst

@@ -1,5 +1,7 @@
 :orphan:
 
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _howto_add_project_hosts_entry_on_linux:
 
 ********************************

docs/howto/dns/add-project-dns-entry-on-mac.rst

@@ -1,5 +1,7 @@
 :orphan:
 
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _howto_add_project_hosts_entry_on_mac:
 
 ********************************

docs/howto/dns/add-project-dns-entry-on-win.rst

@@ -1,5 +1,7 @@
 :orphan:
 
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _howto_add_project_hosts_entry_on_win:
 
 **********************************

docs/howto/docker-toolbox/docker-toolbox-and-the-devilbox.rst

@@ -1,6 +1,7 @@
 :orphan:
 
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _howto_docker_toolbox_and_the_devilbox:
 

docs/howto/docker-toolbox/find-docker-toolbox-ip-address.rst

@@ -1,5 +1,7 @@
 :orphan:
 
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
+
 .. _howto_find_docker_toolbox_ip_address:
 
 ******************************

docs/howto/docker-toolbox/ssh-into-docker-toolbox.rst

@@ -1,6 +1,7 @@
 :orphan:
 
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _howto_ssh_into_docker_toolbox:
 

docs/howto/docker-toolbox/ssh-port-forward-on-docker-toolbox-from-host.rst

@@ -1,6 +1,7 @@
 :orphan:
 
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _howto_ssh_port_forward_on_docker_toolbox_from_host:
 

docs/howto/docker-toolbox/ssh-port-forward-on-host-to-docker-toolbox.rst

@@ -1,6 +1,7 @@
 :orphan:
 
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _howto_ssh_port_forward_on_host_to_docker_toolbox:
 

docs/howto/terminal/open-terminal-on-mac.rst

@@ -1,6 +1,7 @@
 :orphan:
 
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _howto_open_terminal_on_mac:
 

docs/howto/terminal/open-terminal-on-win.rst

@@ -1,6 +1,7 @@
 :orphan:
 
 .. include:: /_includes/all.rst
+.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
 
 .. _howto_open_terminal_on_win: