diff --git a/docs/_static/img/devilbox-database.png b/docs/_static/img/devilbox-database.png new file mode 100644 index 00000000..43b8284c Binary files /dev/null and b/docs/_static/img/devilbox-database.png differ diff --git a/docs/_static/img/devilbox-email-catch-all.png b/docs/_static/img/devilbox-email-catch-all.png new file mode 100644 index 00000000..e8f1b430 Binary files /dev/null and b/docs/_static/img/devilbox-email-catch-all.png differ diff --git a/docs/_static/img/devilbox-emails.png b/docs/_static/img/devilbox-emails.png new file mode 100644 index 00000000..7e72a8cc Binary files /dev/null and b/docs/_static/img/devilbox-emails.png differ diff --git a/docs/_static/img/devilbox-index.png b/docs/_static/img/devilbox-index.png new file mode 100644 index 00000000..0d9443fb Binary files /dev/null and b/docs/_static/img/devilbox-index.png differ diff --git a/docs/_static/img/devilbox-info-mysql.png b/docs/_static/img/devilbox-info-mysql.png new file mode 100644 index 00000000..cf59d40a Binary files /dev/null and b/docs/_static/img/devilbox-info-mysql.png differ diff --git a/docs/_static/img/devilbox-info-php.png b/docs/_static/img/devilbox-info-php.png new file mode 100644 index 00000000..a3222bff Binary files /dev/null and b/docs/_static/img/devilbox-info-php.png differ diff --git a/docs/_static/img/devilbox-vhosts.png b/docs/_static/img/devilbox-vhosts.png new file mode 100644 index 00000000..205185f1 Binary files /dev/null and b/docs/_static/img/devilbox-vhosts.png differ diff --git a/docs/configuration-files/env-file.rst b/docs/configuration-files/env-file.rst index d786e3eb..5d3576a7 100644 --- a/docs/configuration-files/env-file.rst +++ b/docs/configuration-files/env-file.rst @@ -46,7 +46,7 @@ DOCKER_LOGS ----------- This variable controls the output of logs. Logs can either go to file and will be available -under ``./logs/`` inside the Devilbox git directory or they can be forwarded to Docker logs +under ``./log/`` inside the Devilbox git directory or they can be forwarded to Docker logs and will then be send to stdout and stderr. +-------------------+----------------+---------------+ @@ -56,10 +56,10 @@ and will then be send to stdout and stderr. +-------------------+----------------+---------------+ When ``DOCKER_LOGS`` is set to ``1``, output will go to Docker logs, otherwise if it is set to -``0`` the log output will go to files under ``./logs/``. +``0`` the log output will go to files under ``./log/``. The ``./log/`` directory itself will contain subdirectories in the form ``-`` -which will then hold all available log files. +which will then hold all available log files. .. note:: Log directories do not exist until you start the Devilbox and will only be created for @@ -351,7 +351,7 @@ and report as unsuccessful. The default is ``1`` second, wich should be fairly s +-----------------------+----------------+-------------------+ - +.. _env_devilbox_ui_protect: DEVILBOX_UI_PROTECT ------------------- @@ -371,6 +371,8 @@ everybody to have access to the intranet itself, just to the projects you actual ``DEVILBOX_UI_PASSWORD``. +.. _env_devilbox_ui_password: + DEVILBOX_UI_PASSWORD -------------------- @@ -384,6 +386,8 @@ password by which it will be protected. +--------------------------+----------------+-------------------+ +.. _env_devilbox_ui_disable: + DEVILBOX_UI_DISABLE ------------------- diff --git a/docs/getting-started/the-intranet.rst b/docs/getting-started/the-intranet.rst new file mode 100644 index 00000000..3096ee15 --- /dev/null +++ b/docs/getting-started/the-intranet.rst @@ -0,0 +1,136 @@ +************ +The Intranet +************ + +The intranet is your command & control center showing all kinds of information and settings +currently in effect. It also offers third-party projects to do all sorts of database +manipulation. + + +**Table of Contents** + +.. contents:: :local: + + +Devilbox tools +============== + +Overview +-------- + +The start page is there to check if everything works as expected. It shows all desired Docker +containers you wanted to start and if they succeeded, as well as their ports, mount points and +special settings applied via ``.env``. + +.. image:: /_static/img/devilbox-index.png + + +Virtual hosts +------------- + +The virtual host page displays all available projects and let's you know if their configuration +is correct, such as DNS settings or document root. + +.. image:: /_static/img/devilbox-vhosts.png + + +Emails +------ + +The email page displays all emails that would have been sent, but were caught by the integrated +email catch-all functionality. + +.. image:: /_static/img/devilbox-emails.png + + +Databases +--------- + +There are several database pages for MySQL and NoSQL databases giving you an overview about +what is currently in place, how many databases/schemas and or recors and what size they take up. + +The following example shows the database page for MySQL: + +.. image:: /_static/img/devilbox-database.png + + +Info pages +---------- + +Info pages also exist for every Docker container which show various settings which are +currently applied. + +The following example shows you the info page for PHP. + +.. image:: /_static/img/devilbox-info-php.png + +The following example shows you the info page for MySQL: + +.. image:: /_static/img/devilbox-info-mysql.png + + +Third-party tools +================= + +phpMyAdmin +---------- + +`phpMyAdmin `_ is a free software tool written in PHP, +intended to handle the administration of MySQL over the Web. phpMyAdmin supports a wide range +of operations on MySQL and MariaDB. Frequently used operations (managing databases, tables, +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. + + +Adminer +------- + +`Adminer `_ (formerly phpMinAdmin) is a full-featured database +management tool written in PHP. Conversely to phpMyAdmin, it consist of a single file ready to +deploy to the target server. Adminer is available for MySQL, MariaDB, PostgreSQL, SQLite, MS SQL, +Oracle, Firebird, SimpleDB, Elasticsearch and MongoDB. + + +OpcacheGUI +---------- + +`OpcacheGui `_ is a clean and responsive interface for +Zend OPcache information, showing statistics, settings and cached files, and providing a real-time +update for the information (using jQuery and React). + + +Settings +======== + +Password protect the intranet +----------------------------- + +If you share your projects over a LAN, but do not want anybody to view the Devilbox intranet, +you can also password protect it. + +.. seealso:: + In order to do so, have a look at the following ``.env`` variables: + + * :ref:`env_devilbox_ui_protect` + * :ref:`env_devilbox_ui_password` + + +Disable the intranet +-------------------- + +If you want a more production-like setup, you can also fully disable the Devilbox intranet. +This is achieved internally by removing the default virtual host which serves the intranet. +When the intranet is disabled, there is no way to access it. + +.. seealso:: + In order to do so, have a look at the following ``.env`` variable: + + * :ref:`env_devilbox_ui_disable` + + +Checklist +========= + +1. You know what tools are provided by the Devilbox intranet +2. You know how to password protect the Devilbox intranet +3. You know how to disable the Devilbox intranet