ExternalVendorCode/devilbox
1
0
Fork 0
mirror of https://github.com/cytopia/devilbox.git synced 2024-12-21 21:57:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

External links

Browse Source
This commit is contained in:
cytopia 2018-07-24 09:41:41 +02:00
parent 74f71a9f59
commit a419efe9c4
No known key found for this signature in database
GPG Key ID: 6D56EDB8695128A2
11 changed files with 147 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/_includes/all.rst
View File

@ -23,11 +23,14 @@
.. include:: /_includes/links/apps.rst
.. include:: /_includes/links/dns.rst
.. include:: /_includes/links/documentation.rst
.. include:: /_includes/links/docker.rst
.. include:: /_includes/links/docker-compose.rst
.. include:: /_includes/links/docker-images.rst
.. include:: /_includes/links/examples.rst
.. include:: /_includes/links/git.rst
.. include:: /_includes/links/ssh.rst
.. include:: /_includes/links/ssl.rst
.. include:: /_includes/links/tools.rst
.. include:: /_includes/links/uid.rst
.. include:: /_includes/links/xdebug.rst

24
docs/_includes/links/dns.rst
View File

@ -3,3 +3,27 @@
<a target="_blank" href="https://wiki.archlinux.org/index.php/Dhcpcd#resolv.conf">
Archlinux Wiki: resolv.conf <img src="/_static/img/icons/ext-link.svg" />
</a>
.. |ext_lnk_wikipedia_cname| raw:: html
<a target="_blank" href="https://en.wikipedia.org/wiki/CNAME_record">
CNAME <img src="/_static/img/icons/ext-link.svg" />
</a>
.. |ext_lnk_domain_dev| raw:: html
<a target="_blank" href="https://icannwiki.org/.dev">
Google (ICANN) <img src="/_static/img/icons/ext-link.svg" />
</a>
.. |ext_lnk_domain_rfc_localhost| raw:: html
<a target="_blank" href="https://tools.ietf.org/html/draft-west-let-localhost-be-localhost-06">
RFC Draft: localhost <img src="/_static/img/icons/ext-link.svg" />
</a>
.. |ext_lnk_domain_docker_rel_notes_localhost| raw:: html
<a target="_blank" href="https://docs.docker.com/docker-for-mac/release-notes/#docker-community-edition-17120-ce-mac46-2018-01-09">
Docker Release notes: 17.12.0-ce-mac46 <img src="/_static/img/icons/ext-link.svg" />
</a>

12
docs/_includes/links/docker-compose.rst
View File

@ -67,3 +67,15 @@
<a target="_blank" href="https://docs.docker.com/compose/env-file/">
Declare default environment variables in file <img src="/_static/img/icons/ext-link.svg" />
</a>
.. |ext_lnk_docker_compose_env| raw:: html
<a target="_blank" href="https://docs.docker.com/compose/env-file/">
.env <img src="/_static/img/icons/ext-link.svg" />
</a>
.. |ext_lnk_docker_compose_extra_hosts| raw:: html
<a target="_blank" href="https://docs.docker.com/compose/compose-file/#external_links">
Docker Compose: extra_hosts <img src="/_static/img/icons/ext-link.svg" />
</a>

35
docs/_includes/links/docker-images.rst Normal file
View File

@ -0,0 +1,35 @@
.. |ext_lnk_docker_image_cockroach| raw:: html
<a target="_blank" href="https://hub.docker.com/r/cockroachdb/cockroach">
Cockroachc DB <img src="/_static/img/icons/ext-link.svg" />
</a>
.. |ext_lnk_docker_image_grafana| raw:: html
<a target="_blank" href="https://hub.docker.com/r/grafana/grafana">
Grafana <img src="/_static/img/icons/ext-link.svg" />
</a>
.. |ext_lnk_docker_image_postgres| raw:: html
<a target="_blank" href="https://hub.docker.com/_/postgres">
PostgreSQL <img src="/_static/img/icons/ext-link.svg" />
</a>
.. |ext_lnk_docker_image_redis| raw:: html
<a target="_blank" href="https://hub.docker.com/_/redis">
Redis <img src="/_static/img/icons/ext-link.svg" />
</a>
.. |ext_lnk_docker_image_memcached| raw:: html
<a target="_blank" href="https://hub.docker.com/_/memcached">
Memcached <img src="/_static/img/icons/ext-link.svg" />
</a>
.. |ext_lnk_docker_image_mongodb| raw:: html
<a target="_blank" href="https://hub.docker.com/_/mongo">
MongoDB <img src="/_static/img/icons/ext-link.svg" />
</a>

23
docs/_includes/links/documentation.rst Normal file
View File

@ -0,0 +1,23 @@
.. |ext_lnk_doc_mysql_query_log| raw:: html
<a target="_blank" href="https://dev.mysql.com/doc/refman/5.7/en/query-log.html">
MySQL query log documentation <img src="/_static/img/icons/ext-link.svg" />
</a>
.. |ext_lnk_doc_bind_ttl| raw:: html
<a target="_blank" href="http://www.zytrax.com/books/dns/apa/ttl.html">
BIND TTL <img src="/_static/img/icons/ext-link.svg" />
</a>
.. |ext_lnk_doc_bind_soa| raw:: html
<a target="_blank" href="http://www.zytrax.com/books/dns/ch8/soa.html">
BIND SOA <img src="/_static/img/icons/ext-link.svg" />
</a>
.. |ext_lnk_doc_wiki_database_timezones| raw:: html
<a target="_blank" href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">
Wikipedia: List of database timezones <img src="/_static/img/icons/ext-link.svg" />
</a>

11
docs/_includes/links/ssl.rst Normal file
View File

@ -0,0 +1,11 @@
.. |ext_lnk_ssl_wiki_hsts| raw:: html
<a target="_blank" href="https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security">
HSTS header <img src="/_static/img/icons/ext-link.svg" />
</a>
.. |ext_lnk_ssl_blog_chrome_dev_hsts| raw:: html
<a target="_blank" href="https://ma.ttias.be/chrome-force-dev-domains-https-via-preloaded-hsts">
Chrome & Firefox now force .dev domains to HTTPS via preloaded HSTS <img src="/_static/img/icons/ext-link.svg" />
</a>

12
docs/_includes/links/tools.rst
View File

@ -206,3 +206,15 @@
<a target="_blank" href="https://github.com/amnuts/opcache-gui">
OpcacheGui <img src="/_static/img/icons/ext-link.svg" />
</a>
..
============================================================
Projects
============================================================
.. |ext_lnk_project_vhost_gen| raw:: html
<a target="_blank" href="https://github.com/devilbox/vhost-gen">
vhost-gen <img src="/_static/img/icons/ext-link.svg" />
</a>

4
docs/advanced/add-custom-cname-records.rst
View File

@ -1,3 +1,5 @@
.. include:: /_includes/all.rst
.. _add_custom_cname_records:
****************************
@ -5,7 +7,7 @@ Add custom CNAME DNS entries
****************************
You can add an infinite number of custom
`CNAME <https://en.wikipedia.org/wiki/CNAME_record>`_ records that will be available in your
|ext_lnk_wikipedia_cname| records that will be available in your
running Docker container.
If Auto-DNS is turned on, those records will be available on your host operating system as well.

4
docs/advanced/add-your-own-docker-image.rst
View File

@ -1,3 +1,5 @@
.. include:: /_includes/all.rst
.. _add_your_own_docker_image:
*************************
@ -118,7 +120,7 @@ Two new services
CockroachDB example
-------------------
Gather the requirements for the `Cockroach DB <https://hub.docker.com/r/cockroachdb/cockroach/>`_
Gather the requirements for the |ext_lnk_docker_image_cockroach|
Docker image:
1. Name: ``cockroach``

4
docs/advanced/connect-to-other-docker-container.rst
View File

@ -1,3 +1,5 @@
.. include:: /_includes/all.rst
.. _connect_to_other_docker_container:
*********************************
@ -24,7 +26,7 @@ Any Docker container on host os
2. Once you are able to connect to the host os, start any other Docker container and make its
port that you want to access available to your host os by specifying ``-p``.
An example with e.g. an external `Grafana <https://hub.docker.com/r/grafana/grafana/>`_ container
An example with e.g. an external |ext_lnk_docker_image_grafana| container
might look like this:
.. code-block:: bash

39
docs/configuration-files/env-file.rst
View File

@ -13,7 +13,7 @@ If this file does not exist at the root of your Devilbox git directory, then cop
to ``.env`` to initially create it with sane defaults.
.. seealso::
what is the `.env <https://docs.docker.com/compose/env-file/>`_ file?
what is the |ext_lnk_docker_compose_env| file?
.. note::
Use your browsers search function to quickly find the desired variable name.
@ -233,11 +233,10 @@ this project visible to everyone in your corporate LAN.
.. warning::
Do not use ``dev`` as a domain suffix (I know, it's tempting).
It has been registered by
`Google <https://icannwiki.org/.dev>`_ and they advertise the
`HSTS header <https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security>`_
|ext_lnk_domain_dev| and they advertise the |ext_lnk_ssl_wiki_hsts|
which makes your browser redirect every http request to https.
**See also:** `This blog post <https://ma.ttias.be/chrome-force-dev-domains-https-via-preloaded-hsts>`_
**See also:** |ext_lnk_ssl_blog_chrome_dev_hsts|
.. warning::
Do not use ``localhost`` as a domain suffix.
@ -245,9 +244,7 @@ this project visible to everyone in your corporate LAN.
should be redirected to the systems loopback interface.
Docker has already released a commit preventing the use of ``localhost`` on MacOS.
**See also:** `RFC Draft <https://tools.ietf.org/html/draft-west-let-localhost-be-localhost-06>`_
and
`Docker Release notes <https://docs.docker.com/docker-for-mac/release-notes/#docker-community-edition-17120-ce-mac46-2018-01-09>`_
**See also:** |ext_lnk_domain_rfc_localhost| and |ext_lnk_domain_docker_rel_notes_localhost|
.. _env_extra_hosts:
@ -314,7 +311,7 @@ A few examples for adding extra hosts:
.. seealso::
This resembles the feature of `Docker Compose: extra_hosts <https://docs.docker.com/compose/compose-file/#external_links>`_ to add external links.
This resembles the feature of |ext_lnk_docker_compose_extra_hosts| to add external links.
.. seealso:: :ref:`connect_to_external_hosts`
@ -399,7 +396,7 @@ This is especially useful to keep PHP and database timezones in sync.
| ``TIMEZONE`` | valid timezone | ``Europe/Berlin`` |
+-----------------------+----------------+-------------------+
Have a look at Wikipedia to get a list of valid timezones: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
Have a look at Wikipedia to get a list of valid timezones: |ext_lnk_doc_wiki_database_timezones|
.. note::
It is always a good practice not to assume a specific timezone anyway and store all values
@ -646,7 +643,7 @@ All values are already available in the ``.env`` file and just need to be commen
.. note::
This is the official PostgreSQL server which might already have other tags available,
check their official website for even more versions.
https://hub.docker.com/_/postgres/
|ext_lnk_docker_image_postgres|
.. _env_redis_server:
@ -678,7 +675,7 @@ All values are already available in the ``.env`` file and just need to be commen
.. note::
This is the official Redis server which might already have other tags available,
check their official website for even more versions.
https://hub.docker.com/_/redis/
|ext_lnk_docker_image_redis|
.. _env_memcd_server:
@ -729,7 +726,7 @@ All values are already available in the ``.env`` file and just need to be commen
.. note::
This is the official Memcached server which might already have other tags available,
check their official website for even more versions.
https://hub.docker.com/_/memcached/
|ext_lnk_docker_image_memcached|
.. _env_mongo_server:
@ -762,7 +759,7 @@ All values are already available in the ``.env`` file and just need to be commen
.. note::
This is the official MongoDB server which might already have other tags available,
check their official website for even more versions.
https://hub.docker.com/_/mongo/
|ext_lnk_docker_image_mongodb|
Docker host mounts
@ -1380,7 +1377,7 @@ servers virtual host to anything from adding rewrite rules, overwriting director
changing the server name or adding locations to other assets.
.. seealso::
The whole process is based on a project called `vhost-gen <https://github.com/devilbox/vhost-gen>`_.
The whole process is based on a project called |ext_lnk_project_vhost_gen|.
A virtual host generator for Apache 2.2, Apache 2.4 and any Nginx version.
.. seealso::
@ -1431,7 +1428,7 @@ As the Devilbox is intended to be used for development, this feature is turned o
**MySQL documentation:**
"The general query log is a general record of what mysqld is doing. The server writes information to this log when clients connect or disconnect, and it logs each SQL statement received from clients. The general query log can be very useful when you suspect an error in a client and want to know exactly what the client sent to mysqld."
-- https://dev.mysql.com/doc/refman/5.7/en/query-log.html
-- |ext_lnk_doc_mysql_query_log|
PostgreSQL
----------
@ -1550,8 +1547,8 @@ This variable controls the DNS TTL in seconds. If empty or removed it will fallb
.. seealso::
* `BIND TTL <http://www.zytrax.com/books/dns/apa/ttl.html>`_
* `BIND SOA <http://www.zytrax.com/books/dns/ch8/soa.html>`_
* |ext_lnk_doc_bind_ttl|
* |ext_lnk_doc_bind_soa|
BIND_REFRESH_TIME
^^^^^^^^^^^^^^^^^
@ -1564,7 +1561,7 @@ This variable controls the DNS Refresh time in seconds. If empty or removed it w
| ``BIND_REFRESH_TIME`` | integer | empty |
+--------------------------+----------------------+---------------------+
.. seealso:: `BIND SOA <http://www.zytrax.com/books/dns/ch8/soa.html>`_
.. seealso:: |ext_lnk_doc_bind_soa|
BIND_RETRY_TIME
^^^^^^^^^^^^^^^
@ -1577,7 +1574,7 @@ This variable controls the DNS Retry time in seconds. If empty or removed it wil
| ``BIND_RETRY_TIME`` | integer | empty |
+--------------------------+----------------------+---------------------+
.. seealso:: `BIND SOA <http://www.zytrax.com/books/dns/ch8/soa.html>`_
.. seealso:: |ext_lnk_doc_bind_soa|
BIND_EXPIRY_TIME
^^^^^^^^^^^^^^^^
@ -1590,7 +1587,7 @@ This variable controls the DNS Expiry time in seconds. If empty or removed it wi
| ``BIND_EXPIRY_TIME`` | integer | empty |
+--------------------------+----------------------+---------------------+
.. seealso:: `BIND SOA <http://www.zytrax.com/books/dns/ch8/soa.html>`_
.. seealso:: |ext_lnk_doc_bind_soa|
BIND_MAX_CACHE_TIME
^^^^^^^^^^^^^^^^^^^
@ -1603,4 +1600,4 @@ This variable controls the DNS Max Cache time in seconds. If empty or removed it
| ``BIND_MAX_CACHE_TIME`` | integer | empty |
+--------------------------+----------------------+---------------------+
.. seealso:: `BIND SOA <http://www.zytrax.com/books/dns/ch8/soa.html>`_
.. seealso:: |ext_lnk_doc_bind_soa|