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

Use absolute paths

Browse Source
This commit is contained in:
cytopia 2018-07-08 12:42:04 +02:00
parent 04e9854470
commit b9c52925f9
No known key found for this signature in database
GPG Key ID: 6D56EDB8695128A2
18 changed files with 52 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/advanced/connect-to-host-os.rst
View File

@ -1,4 +1,4 @@
.. include:: ../_includes/global/links.rst .. include:: /_includes/global/links.rst
.. _connect_to_host_os: .. _connect_to_host_os:

12
docs/getting-started/create-your-first-project.rst
View File

@ -28,7 +28,7 @@ http://127.0.0.1/vhosts.php
It should look like the screenshot below and will actually already provide the information needed to create a new project. It should look like the screenshot below and will actually already provide the information needed to create a new project.
.. include:: ../_includes/figures/devilbox/devilbox-intranet-vhosts-empty.rst .. include:: /_includes/figures/devilbox/devilbox-intranet-vhosts-empty.rst
Step 2: create a project directory Step 2: create a project directory
@ -53,7 +53,7 @@ In your Devilbox git directory, navigate to ``./data/www`` and create a new dire
Visit the vhost page again and see what has changed: http://localhost/vhosts.php Visit the vhost page again and see what has changed: http://localhost/vhosts.php
.. include:: ../_includes/figures/devilbox/devilbox-intranet-vhosts-missing-htdocs.rst .. include:: /_includes/figures/devilbox/devilbox-intranet-vhosts-missing-htdocs.rst
**So what has happened?** **So what has happened?**
@ -81,7 +81,7 @@ Navigate to your newly created project directory and create a directory named `h
Vist the vhost page again and see what has changed: http://localhost/vhosts.php Vist the vhost page again and see what has changed: http://localhost/vhosts.php
.. include:: ../_includes/figures/devilbox/devilbox-intranet-vhosts-missing-dns.rst .. include:: /_includes/figures/devilbox/devilbox-intranet-vhosts-missing-dns.rst
**So what has happened?** **So what has happened?**
@ -123,7 +123,7 @@ into your ``/etc/hosts`` (or ``C:\Windows\System32\drivers\etc`` for Windows).
Vist the vhost page again and see what has changed: http://localhost/vhosts.php Vist the vhost page again and see what has changed: http://localhost/vhosts.php
.. include:: ../_includes/figures/devilbox/devilbox-intranet-vhosts-working.rst .. include:: /_includes/figures/devilbox/devilbox-intranet-vhosts-working.rst
**So what has happened?** **So what has happened?**
@ -137,7 +137,7 @@ Step 5: visit your project
On the intranet, click on your project link. This will open your project in a new Browser tab or On the intranet, click on your project link. This will open your project in a new Browser tab or
visit http://project-1.loc visit http://project-1.loc
.. include:: ../_includes/figures/devilbox/devilbox-project-missing-index.rst .. include:: /_includes/figures/devilbox/devilbox-project-missing-index.rst
**So what has happened?** **So what has happened?**
@ -170,7 +170,7 @@ Alternatively create an ``index.php`` file in ``data/www/project-1/htdocs`` with
Visit your project url again and see what has changed: http://project-1.loc Visit your project url again and see what has changed: http://project-1.loc
.. include:: ../_includes/figures/devilbox/devilbox-project-hello-world.rst .. include:: /_includes/figures/devilbox/devilbox-project-hello-world.rst
Checklist Checklist

12
docs/getting-started/devilbox-intranet.rst
View File

@ -22,7 +22,7 @@ The start page is there to check if everything works as expected. It shows all d
containers you wanted to start and if they succeeded, as well as their ports, mount points and containers you wanted to start and if they succeeded, as well as their ports, mount points and
special settings applied via ``.env``. special settings applied via ``.env``.
.. include:: ../_includes/figures/devilbox/devilbox-intranet-index.rst .. include:: /_includes/figures/devilbox/devilbox-intranet-index.rst
Virtual hosts Virtual hosts
@ -31,7 +31,7 @@ Virtual hosts
The virtual host page displays all available projects and let's you know if their configuration 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. is correct, such as DNS settings or document root.
.. include:: ../_includes/figures/devilbox/devilbox-intranet-vhosts.rst .. include:: /_includes/figures/devilbox/devilbox-intranet-vhosts.rst
Emails Emails
@ -40,7 +40,7 @@ Emails
The email page displays all emails that would have been sent, but were caught by the integrated The email page displays all emails that would have been sent, but were caught by the integrated
email catch-all functionality. email catch-all functionality.
.. include:: ../_includes/figures/devilbox/devilbox-intranet-emails.rst .. include:: /_includes/figures/devilbox/devilbox-intranet-emails.rst
Databases Databases
@ -51,7 +51,7 @@ what is currently in place, how many databases/schemas and or recors and what si
The following example shows the database page for MySQL: The following example shows the database page for MySQL:
.. include:: ../_includes/figures/devilbox/devilbox-intranet-mysql-databases.rst .. include:: /_includes/figures/devilbox/devilbox-intranet-mysql-databases.rst
Info pages Info pages
@ -62,11 +62,11 @@ currently applied.
The following example shows you the info page for PHP. The following example shows you the info page for PHP.
.. include:: ../_includes/figures/devilbox/devilbox-intranet-php-info.rst .. include:: /_includes/figures/devilbox/devilbox-intranet-php-info.rst
The following example shows you the info page for MySQL: The following example shows you the info page for MySQL:
.. include:: ../_includes/figures/devilbox/devilbox-intranet-mysql-info.rst .. include:: /_includes/figures/devilbox/devilbox-intranet-mysql-info.rst
Third-party tools Third-party tools

2
docs/getting-started/install-the-devilbox.rst
View File

@ -1,4 +1,4 @@
.. include:: ../_includes/global/links.rst .. include:: /_includes/global/links.rst
.. _install_the_devilbox: .. _install_the_devilbox:

4
docs/getting-started/prerequisites.rst
View File

@ -1,5 +1,5 @@
.. include:: ../_includes/global/links.rst .. include:: /_includes/global/links.rst
.. include:: ../_includes/global/images.rst .. include:: /_includes/global/images.rst
.. _prerequisites: .. _prerequisites:

4
docs/getting-started/start-the-devilbox.rst
View File

@ -122,8 +122,8 @@ http://127.0.0.1.
The Intranet start page will also show you all running and failed containers: The Intranet start page will also show you all running and failed containers:
.. include:: ../_includes/figures/devilbox/devilbox-intranet-dash-all.rst .. include:: /_includes/figures/devilbox/devilbox-intranet-dash-all.rst
.. include:: ../_includes/figures/devilbox/devilbox-intranet-dash-selective.rst .. include:: /_includes/figures/devilbox/devilbox-intranet-dash-selective.rst
.. important:: .. important::
:ref:`howto_find_docker_toolbox_ip_address` :ref:`howto_find_docker_toolbox_ip_address`

2
docs/howto/docker-toolbox/docker-toolbox-and-the-devilbox.rst
View File

@ -1,6 +1,6 @@
:orphan: :orphan:
.. include:: ../../_includes/global/links.rst .. include:: /_includes/global/links.rst
.. _howto_docker_toolbox_and_the_devilbox: .. _howto_docker_toolbox_and_the_devilbox:

2
docs/howto/docker-toolbox/ssh-into-docker-toolbox.rst
View File

@ -1,6 +1,6 @@
:orphan: :orphan:
.. include:: ../../_includes/global/links.rst .. include:: /_includes/global/links.rst
.. _howto_ssh_into_docker_toolbox: .. _howto_ssh_into_docker_toolbox:

2
docs/howto/docker-toolbox/ssh-port-forward-from-docker-toolbox-to-host.rst
View File

@ -1,6 +1,6 @@
:orphan: :orphan:
.. include:: ../../_includes/global/links.rst .. include:: /_includes/global/links.rst
.. _howto_ssh_port_forward_from_docker_toolbox_to_host: .. _howto_ssh_port_forward_from_docker_toolbox_to_host:

2
docs/howto/docker-toolbox/ssh-port-forward-from-host-to-docker-toolbox.rst
View File

@ -1,6 +1,6 @@
:orphan: :orphan:
.. include:: ../../_includes/global/links.rst .. include:: /_includes/global/links.rst
.. _howto_ssh_port_forward_from_host_to_docker_toolbox: .. _howto_ssh_port_forward_from_host_to_docker_toolbox:

4
docs/howto/terminal/open-terminal-on-mac.rst
View File

@ -1,6 +1,6 @@
:orphan: :orphan:
.. include:: ../../_includes/global/links.rst .. include:: /_includes/global/links.rst
.. _howto_open_terminal_on_mac: .. _howto_open_terminal_on_mac:
@ -36,7 +36,7 @@ Via Launcher
1. Open the **Launchpad** and locate the Docker Quickstart Terminal icon. 1. Open the **Launchpad** and locate the Docker Quickstart Terminal icon.
.. include:: ../../_includes/figures/terminal/docker-toolbox-terminal-mac-quickstart-launchpad.rst .. include:: /_includes/figures/terminal/docker-toolbox-terminal-mac-quickstart-launchpad.rst
2. Click the icon to launch a Docker Quickstart Terminal window. 2. Click the icon to launch a Docker Quickstart Terminal window.

6
docs/howto/terminal/open-terminal-on-win.rst
View File

@ -1,6 +1,6 @@
:orphan: :orphan:
.. include:: ../../_includes/global/links.rst .. include:: /_includes/global/links.rst
.. _howto_open_terminal_on_win: .. _howto_open_terminal_on_win:
@ -36,14 +36,14 @@ Docker Toolbox
1. On your Desktop, find the Docker QuickStart Terminal icon. 1. On your Desktop, find the Docker QuickStart Terminal icon.
.. include:: ../../_includes/figures/terminal/docker-toolbox-terminal-win-quickstart-shortcut.rst .. include:: /_includes/figures/terminal/docker-toolbox-terminal-win-quickstart-shortcut.rst
2. Click the Docker QuickStart icon to launch a pre-configured Docker Toolbox terminal. 2. Click the Docker QuickStart icon to launch a pre-configured Docker Toolbox terminal.
If the system displays a **User Account Control** prompt to allow VirtualBox to make changes to If the system displays a **User Account Control** prompt to allow VirtualBox to make changes to
your computer. Choose **Yes**. your computer. Choose **Yes**.
.. include:: ../../_includes/figures/terminal/docker-toolbox-terminal-win-quickstart-terminal.rst .. include:: /_includes/figures/terminal/docker-toolbox-terminal-win-quickstart-terminal.rst
.. ..

2
docs/index.rst
View File

@ -1,6 +1,6 @@
.. :hidden: .. :hidden:
.. include:: _includes/global/images.rst .. include:: /_includes/global/images.rst
********************** **********************
Devilbox documentation Devilbox documentation

6
docs/intermediate/configure-php-xdebug.rst
View File

@ -269,16 +269,16 @@ Linux
Enable Xdebug for the port set in ``xdebug.ini``: Enable Xdebug for the port set in ``xdebug.ini``:
.. include:: ../_includes/figures/xdebug/phpstorm-settings.rst .. include:: /_includes/figures/xdebug/phpstorm-settings.rst
Create a new PHP server and set a path mapping. This tutorial assumes your local Devilbox projects Create a new PHP server and set a path mapping. This tutorial assumes your local Devilbox projects
to be in ``./data/www`` of the Devilbox git directory: to be in ``./data/www`` of the Devilbox git directory:
.. include:: ../_includes/figures/xdebug/phpstorm-path-mapping.rst .. include:: /_includes/figures/xdebug/phpstorm-path-mapping.rst
Set DBGp proxy settings: Set DBGp proxy settings:
.. include:: ../_includes/figures/xdebug/phpstorm-dbgp-proxy.rst .. include:: /_includes/figures/xdebug/phpstorm-dbgp-proxy.rst
MacOS (Docker for Mac) MacOS (Docker for Mac)

2
docs/intermediate/email-catch-all.rst
View File

@ -11,7 +11,7 @@ all outgoing mails and puts them into a local mailbox by the user ``devilbox``.
In order to view sent emails open up the devilbox intranet http://localhost/mail.php. In order to view sent emails open up the devilbox intranet http://localhost/mail.php.
There you can also test email sending and verify that they really stay locally. There you can also test email sending and verify that they really stay locally.
.. include:: ../_includes/figures/devilbox/devilbox-intranet-emails.rst .. include:: /_includes/figures/devilbox/devilbox-intranet-emails.rst
In the above image from the intranet you can see that all emails sent to whatever recipient In the above image from the intranet you can see that all emails sent to whatever recipient
have been caught by the Devilbox and are available to be read. have been caught by the Devilbox and are available to be read.

26
docs/intermediate/setup-valid-https.rst
View File

@ -10,7 +10,7 @@ projects.
SSL certificates are generated automatically and there is nothing to do from your side. SSL certificates are generated automatically and there is nothing to do from your side.
.. include:: ../_includes/figures/https/https-ssl-address-bar.rst .. include:: /_includes/figures/https/https-ssl-address-bar.rst
**Table of Contents** **Table of Contents**
@ -75,28 +75,28 @@ Chrome / Chromium
Open Chrome settings, scroll down to the very bottom and click on ``Advanced`` to expand the Open Chrome settings, scroll down to the very bottom and click on ``Advanced`` to expand the
advanced settings. advanced settings.
.. include:: ../_includes/figures/https/chrome-settings.rst .. include:: /_includes/figures/https/chrome-settings.rst
Find the setting ``Manage certificates`` and open it. Find the setting ``Manage certificates`` and open it.
.. include:: ../_includes/figures/https/chrome-advanced-settings.rst .. include:: /_includes/figures/https/chrome-advanced-settings.rst
Navigate to the tab setting ``AUTHORITIES`` and click on ``IMPORT``. Navigate to the tab setting ``AUTHORITIES`` and click on ``IMPORT``.
.. include:: ../_includes/figures/https/chrome-manage-certificates.rst .. include:: /_includes/figures/https/chrome-manage-certificates.rst
Select ``devilbox-ca.crt`` from within the Devilbox ``./ca`` directory: Select ``devilbox-ca.crt`` from within the Devilbox ``./ca`` directory:
.. include:: ../_includes/figures/https/file-manager-import-ca.rst .. include:: /_includes/figures/https/file-manager-import-ca.rst
As the last step you are asked what permissions you want to grant the newly importat CA. As the last step you are asked what permissions you want to grant the newly importat CA.
To make sure it works everywhere, check all options and proceed with ``OK``. To make sure it works everywhere, check all options and proceed with ``OK``.
.. include:: ../_includes/figures/https/chrome-set-trust.rst .. include:: /_includes/figures/https/chrome-set-trust.rst
Now you are all set and all generated SSL certificates will be valid from now on. Now you are all set and all generated SSL certificates will be valid from now on.
.. include:: ../_includes/figures/https/https-ssl-address-bar.rst .. include:: /_includes/figures/https/https-ssl-address-bar.rst
Firefox Firefox
@ -104,28 +104,28 @@ Firefox
Open Firefox settings and click on ``Privacy & Security``. Open Firefox settings and click on ``Privacy & Security``.
.. include:: ../_includes/figures/https/firefox-preferences.rst .. include:: /_includes/figures/https/firefox-preferences.rst
At the very bottom click on the button ``View Certificates``. At the very bottom click on the button ``View Certificates``.
.. include:: ../_includes/figures/https/firefox-privacy-and-security.rst .. include:: /_includes/figures/https/firefox-privacy-and-security.rst
In the ``Authories`` tab, click on ``Import``. In the ``Authories`` tab, click on ``Import``.
.. include:: ../_includes/figures/https/firefox-certificate-manager.rst .. include:: /_includes/figures/https/firefox-certificate-manager.rst
Select ``devilbox-ca.crt`` from within the Devilbox ``./ca`` directory: Select ``devilbox-ca.crt`` from within the Devilbox ``./ca`` directory:
.. include:: ../_includes/figures/https/file-manager-import-ca.rst .. include:: /_includes/figures/https/file-manager-import-ca.rst
As the last step you are asked what permissions you want to grant the newly importat CA. As the last step you are asked what permissions you want to grant the newly importat CA.
To make sure it works everywhere, check all options and proceed with ``OK``. To make sure it works everywhere, check all options and proceed with ``OK``.
.. include:: ../_includes/figures/https/firefox-set-trust.rst .. include:: /_includes/figures/https/firefox-set-trust.rst
Now you are all set and all generated SSL certificates will be valid from now on. Now you are all set and all generated SSL certificates will be valid from now on.
.. include:: ../_includes/figures/https/https-ssl-address-bar.rst .. include:: /_includes/figures/https/https-ssl-address-bar.rst
Further Reading Further Reading

4
docs/support/blogs-videos-and-use-cases.rst
View File

@ -10,8 +10,8 @@ Official videos
The official videos might be a bit old, but are still valid and a good start, The official videos might be a bit old, but are still valid and a good start,
even if the intranet UI has changed a bit. even if the intranet UI has changed a bit.
.. include:: ../_includes/figures/blogs/youtube-setup-and-workflow.rst .. include:: /_includes/figures/blogs/youtube-setup-and-workflow.rst
.. include:: ../_includes/figures/blogs/youtube-email-catch-all.rst .. include:: /_includes/figures/blogs/youtube-email-catch-all.rst
Blog posts Blog posts

10
docs/support/howto.rst
View File

@ -15,26 +15,26 @@ The How to section gathers information about various topics, that might need to
:maxdepth: 1 :maxdepth: 1
:glob: :glob:
../howto/dns/* /howto/dns/*
../howto/uid-and-gid/* /howto/uid-and-gid/*
.. toctree:: .. toctree::
:caption: Devilbox :caption: Devilbox
:maxdepth: 1 :maxdepth: 1
:glob: :glob:
../howto/devilbox/* /howto/devilbox/*
.. toctree:: .. toctree::
:caption: Docker Toolbox :caption: Docker Toolbox
:maxdepth: 1 :maxdepth: 1
:glob: :glob:
../howto/docker-toolbox/* /howto/docker-toolbox/*
.. toctree:: .. toctree::
:caption: Terminal :caption: Terminal
:maxdepth: 1 :maxdepth: 1
:glob: :glob:
../howto/terminal/* /howto/terminal/*