Extending support section

docs/support/faq.rst

@@ -7,8 +7,8 @@ FAQ
 Find common questions and answers here.
 
 .. seealso::
-   * :ref:`troubleshooting`
    * :ref:`howto`
+   * :ref:`troubleshooting`
 
 
 **Table of Contents**

docs/support/howto.rst

@@ -7,6 +7,10 @@ How To
 The How to section gathers information about various things that are not directly related to the
 Devilbox, but need to be done at some point throughout the installation and configuration.
 
+.. seealso::
+   * :ref:`faq`
+   * :ref:`troubleshooting`
+
 .. toctree::
    :caption: Administration
    :maxdepth: 1

docs/support/troubleshooting.rst

@@ -7,7 +7,9 @@ Troubleshooting
 This section will contain common problems and how to resolve them.
 It will grow over time once there are more issues reported.
 
-.. seealso:: :ref:`howto`
+.. seealso::
+   * :ref:`howto`
+   * :ref:`faq`
 
 
 **Table of Contents**
@@ -15,6 +17,118 @@ It will grow over time once there are more issues reported.
 .. contents:: :local:
 
 
+General
+=======
+
+Sudden unexplained problems on Windows
+--------------------------------------
+
+In case something stopped working for no reason, check out other Docker container. If you
+experience similar issues as well, check for any unattended Windows updates or
+updates to Docker itself. If those exist, try to revert them and see if that was the cause.
+
+I heard many bug stories from fellow Windows users so far.
+A good contact point for that is the Docker forum itself: https://forums.docker.com/c/docker-for-windows
+
+Address already in use
+----------------------
+
+One of the Docker container wants to bind to a port on the host system which is already taken.
+Figure out what service is listening on your host system and shut it down or change the port
+of the affected service in the Devilbox ``.env`` file.
+
+Unable to finish Pulling as unauthorized: incorrect username or password
+------------------------------------------------------------------------
+
+This error might occur if you are already logged into a different Docker repository.
+To fix this error, sign out of your currently logged in repository and try again.
+
+.. seealso:: https://github.com/cytopia/devilbox/issues/223
+
+
+localhost or 127.0.0.1 not found
+--------------------------------
+
+If you are using Docker Toolbox, the Devilbox intranet is not available on localhost or 127.0.0.1,
+but rather on the IP address of the Docker Toolbox machine.
+
+.. seealso:: :ref:`howto_find_docker_toolbox_ip_address`
+
+
+ERROR: Version in "./docker-compose.yml" is unsupported
+-------------------------------------------------------
+
+This simply means your Docker and/or Docker Compose versions are outdated.
+
+.. seealso:: :ref:`prerequisites`
+
+DNS issues
+==========
+
+zone 'localhost': already exists previous definition
+----------------------------------------------------
+
+.. code-block:: bash
+
+   bind_1 | /etc/bind/devilbox-wildcard_dns.localhost.conf:1:
+   zone 'localhost': already exists previous definition:
+   /etc/bind/named.conf.default-zones:10
+
+This error occurs when using ``localhost`` as the :ref:`env_tld_suffix`.
+
+.. seealso::
+
+   * :ref:`env_tld_suffix`
+   * https://github.com/cytopia/devilbox/issues/291
+
+
+Web server issues
+=================
+
+403 forbidden
+-------------
+
+This error might occur for the Devilbox intranet or custom created projects.
+
+File and directory permissions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+On of the cause could be wrongly set file and directory permissions.
+
+First ensure the cloned git directory is readable for users, groups and others.
+
+For the Devilbox intranet, ensure the ``.devilbox/`` directory is readable for users, groups and
+others. Also check files and directories within.
+
+For projects, ensure an ``index.php`` or ``index.html`` exists and that all files and directories
+are readable for users, groups and others.
+
+Shared volumes
+^^^^^^^^^^^^^^
+
+This might additionally occur on MacOS or Windows due to the Devilbox and/or its projects not
+being in the standard location of Docker Shared volumes.
+
+Check your Docker settings to allow shared volumes for the path of the Devilbox and its projects.
+
+
+504 Gateway timeout
+-------------------
+
+This error occurs when the upstream PHP-FPM server takes longer to execute a script,
+than the timeout value set in the web server for PHP-FPM to answer.
+
+For that to fix one must increase the PHP-FPM/Proxy timeout settings on the virtual host.
+
+.. seealso::
+
+   * https://github.com/cytopia/devilbox/issues/280
+   * https://github.com/cytopia/devilbox/issues/234
+
+
+Database issues
+===============
+
 Invalid bind mount spec
 -----------------------
 
@@ -26,7 +140,6 @@ Removing the container is sufficient as they will always be created during run i
 
 In order to remove the container do the following:
 
-
 .. code-block:: bash
 
    host> cd path/to/devilbox
@@ -38,13 +151,12 @@ In order to remove the container do the following:
 
 .. seealso:: :ref:`remove_stopped_container`
 
-
 [Warning] World-writable config file '/etc/mysql/docker-default.d/my.cnf' is ignored
 ------------------------------------------------------------------------------------
 
-This warning might occur when using :ref:`howto_docker_toolbox_and_the_devilbox` on Windows and trying to apply custom
+This warning might occur when using :ref:`howto_docker_toolbox_and_the_devilbox` on Windows and
-MySQL configuration files. This will also result in the configuration file not being source
+trying to apply custom MySQL configuration files. This will also result in the configuration file
-by the MySQL server.
+not being source by the MySQL server.
 
 To fix this issue, you will have to change the file permission of your custom configuration files
 to read-only by applying the following ``chmod`` command.