Documentation: do not use official domains for TLD_SUFFIX

This commit is contained in:
cytopia 2018-08-04 14:21:27 +02:00
parent 306107d1c6
commit d50f9c5c24
No known key found for this signature in database
GPG Key ID: 6D56EDB8695128A2
3 changed files with 50 additions and 21 deletions

View File

@ -223,12 +223,6 @@ this project visible to everyone in your corporate LAN.
+-------------+----------------+---------------------------+ +-------------+----------------+---------------------------+
| www.test | ``local`` | ``http://www.test.local`` | | www.test | ``local`` | ``http://www.test.local`` |
+-------------+----------------+---------------------------+ +-------------+----------------+---------------------------+
| my-test | ``net`` | ``http://my-test.net`` |
+-------------+----------------+---------------------------+
| example | ``com`` | ``http://example.com`` |
+-------------+----------------+---------------------------+
| www.test | ``org`` | ``http://www.test.org`` |
+-------------+----------------+---------------------------+
.. warning:: .. warning::
Do not use ``dev`` as a domain suffix (I know, it's tempting). Do not use ``dev`` as a domain suffix (I know, it's tempting).
@ -246,6 +240,15 @@ this project visible to everyone in your corporate LAN.
**See also:** |ext_lnk_domain_rfc_localhost| and |ext_lnk_domain_docker_rel_notes_localhost| **See also:** |ext_lnk_domain_rfc_localhost| and |ext_lnk_domain_docker_rel_notes_localhost|
.. warning::
**Do not use official domain endings** such as ``.com``, ``.org``, ``.net``, etc.
If you do, all name resolutions to any ``.com`` address (e.g.: google.com) will be resolved
to the Devilbox's PHP server IP address.
The bundled DNS server does a catch-all on the given TLD_SUFFIX and resolves everything
below it to the PHP container.
.. _env_extra_hosts: .. _env_extra_hosts:
EXTRA_HOSTS EXTRA_HOSTS

View File

@ -136,6 +136,32 @@ This error occurs when using ``localhost`` as the :ref:`env_tld_suffix`.
* https://github.com/cytopia/devilbox/issues/291 * https://github.com/cytopia/devilbox/issues/291
SSL issues
==========
unable to get local issuer certificate
--------------------------------------
.. code-block:: bash
Errors occurred when trying to connect to www.example.com:
cURL error 77: error setting certificate verify locations: CAfile: certificate ./ca/cacert.pem CApath: /etc/ssl/certs
This issue might arise if you set :ref:`env_tld_suffix` to an official top level domain such as ``.com``.
What happens is that the bundled DNS server does a catch-all on the TLD and redirects all name
resolution to the Devilbox's PHP container IP address.
If you want to access ``https://www.example.com`` in that case, the request goes to the PHP
container which does not have a valid SSL certificate for that domain.
**Do not user official TLD's** for :ref:`env_tld_suffix`.
.. seealso::
* :ref:`env_tld_suffix`
* https://github.com/cytopia/devilbox/issues/275
Web server issues Web server issues
================= =================

View File

@ -22,21 +22,21 @@ Simple sub domains for one project
When you just want to serve your project under different sub domains, you simply name your project When you just want to serve your project under different sub domains, you simply name your project
directory by the name of it. See the following examples how you build up your project URL. directory by the name of it. See the following examples how you build up your project URL.
+----------------+----------------+-------------------------------+ +----------------+----------------+---------------------------------+
| Project dir | ``TLD_SUFFIX`` | Project URL | | Project dir | ``TLD_SUFFIX`` | Project URL |
+================+================+===============================+ +================+================+=================================+
| my-test | ``loc`` | ``http://my-test.loc`` | | my-test | ``loc`` | ``http://my-test.loc`` |
+----------------+----------------+-------------------------------+ +----------------+----------------+---------------------------------+
| www.my-test | ``loc`` | ``http://www.my-test.loc`` | | www.my-test | ``loc`` | ``http://www.my-test.loc`` |
+----------------+----------------+-------------------------------+ +----------------+----------------+---------------------------------+
| t1.www.my-test | ``loc`` | ``http://t1.www.my-test.loc`` | | t1.www.my-test | ``loc`` | ``http://t1.www.my-test.loc`` |
+----------------+----------------+-------------------------------+ +----------------+----------------+---------------------------------+
| my-test | ``com`` | ``http://my-test.com`` | | my-test | ``local`` | ``http://my-test.local`` |
+----------------+----------------+-------------------------------+ +----------------+----------------+---------------------------------+
| www.my-test | ``com`` | ``http://www.my-test.com`` | | www.my-test | ``local`` | ``http://www.my-test.local`` |
+----------------+----------------+-------------------------------+ +----------------+----------------+---------------------------------+
| t2.www.my-test | ``com`` | ``http://t2.www.my-test.com`` | | t2.www.my-test | ``local`` | ``http://t2.www.my-test.local`` |
+----------------+----------------+-------------------------------+ +----------------+----------------+---------------------------------+
Whatever name you want to have in front of the ``TLD_SUFFIX`` is actually just the directory you Whatever name you want to have in front of the ``TLD_SUFFIX`` is actually just the directory you
create. Generically, it looks like this: create. Generically, it looks like this: