From dc641b9298cb35d925fa8e55a3203c41fafd096f Mon Sep 17 00:00:00 2001 From: cytopia Date: Sun, 11 Mar 2018 18:30:07 +0100 Subject: [PATCH] Add files to ToC --- docs/index.rst | 2 + docs/installation/docker-toolbox.rst | 77 ++++++++++++++++++++-------- 2 files changed, 59 insertions(+), 20 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 0fcda4d9..e67bc7a4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -100,6 +100,8 @@ devilbox documentation :caption: Readings :maxdepth: 2 + installation/docker-installation + installation/docker-toolbox readings/available-container readings/syncronize-container-permissions diff --git a/docs/installation/docker-toolbox.rst b/docs/installation/docker-toolbox.rst index f738000b..87f7e02d 100644 --- a/docs/installation/docker-toolbox.rst +++ b/docs/installation/docker-toolbox.rst @@ -7,6 +7,35 @@ Docker Toolbox .. contents:: :local: +Installation +============ + +.. warning:: + The minimum required ``Docker Toolbox`` version is ``1.12.0``. Make sure not to install older versions. + +Docker Toolbox on Windows +------------------------- + +Refer to the official `Docker Toolbox on Windows documentation `_ for how to install ``Docker Toolbox`` on Windows. + +Docker Toolbox on MacOS +------------------------- + +Refer to the official `Docker Toolbox on MacOS documentation `_ for how to install ``Docker Toolbox`` on MacOS. + +Docker Compose +-------------- + +When installing ``Docker Compose``, make sure you do that **inside the virtual machine**. + +.. seealso:: + :ref:`install_docker_compose` + Have a look at this page to help you install ``Docker Compose`` for your operating system. + + +Additional steps +================ + ``Docker Toolbox`` is a legacy solution to bring ``Docker`` to systems which don't natively support Docker itself. This is achieved by starting a virtualized Linux (e.g.: on VirtualBox) and have Docker run inside. @@ -18,38 +47,46 @@ This however has several disadvantages as the forwarded Docker ports are only vi virtualized Linux and not on the host computer. Therefore the web server port cannot be reached on your host machine and you are not able to view any projects. -This can be overcome by forwarding all ports from your virtual machine to your host computer. +Listening address +----------------- -.. warning:: - The minimum required ``Docker Toolbox`` version is ``1.12.0``. Make sure not to install older versions. - -.. todo:: - - This section needs more details. +First thing you need to make sure is that the ``LOCAL_LISTEN_ADDR`` variable from your ``.env`` file is +empty. When it is empty all services bind to all IP addresses inside the virtual machine and thus +being able to be seen from outside (your host operating system). -Docker Toolbox on Windows -========================= +You can verifiy that the variable is actually empty by checking your ``.env`` file: -Refer to the official `Docker Toolbox on Windows documentation `_ for how to install ``Docker Toolbox`` on Windows. +.. code-block:: bash + + host> grep ^LOCAL_LISTEN_ADDR .env + + LOCAL_LISTEN_ADDR= + +Port forwarding +--------------- + +Additionally I would suggest that you port-forward the virtual machines port 80 (which itself +points to the docker container inside) to your host computers ``127.0.0.1`` address. This way you +can reach the devilbox via ``http://127.0.0.1`` or ``http://localhost``. + +If you do not port-forward it to your host machines localhost, you will have to adjust all project +DNS entries that are described in this documentation to go to ``127.0.0.1`` to the IP address of +your virtual machine. -Docker Toolbox on MacOS -======================= +Auto-DNS +-------- -Refer to the official `Docker Toolbox on MacOS documentation `_ for how to install ``Docker Toolbox`` on MacOS. +I am currently not aware that Auto-DNS will work with ``Docker Toolbox``. If you are willing to +spent some time there, let me know. There is currently an open ticket which is addressing this: +https://github.com/cytopia/devilbox/issues/101 -Docker Compose -============== -When installing ``Docker Compose``, make sure you do that **inside the virtual machine**. - -.. seealso:: - :ref:`install_docker_compose` - Have a look at this page to help you install ``Docker Compose`` for your operating system. Checklist ========= 1. ``Docker Toolbox`` is installed at minimum required version 2. ``Docker Compose`` is installed inside the virtual machine at minimum required version +3. ``LOCAL_LISTEN_ADDR`` is empty in the ``.env`` file