devilbox/docs/index.rst

235 lines
5.6 KiB
ReStructuredText
Raw Normal View History

2018-07-03 13:47:58 +00:00
.. :hidden:
2018-07-08 16:22:43 +00:00
.. include:: /_includes/all.rst
2018-07-03 13:47:58 +00:00
2018-03-10 21:27:14 +00:00
**********************
2018-07-03 13:47:58 +00:00
Devilbox documentation
2018-03-10 21:27:14 +00:00
**********************
2018-07-03 13:47:58 +00:00
|img_banner|
2018-03-10 21:27:14 +00:00
The Devilbox is a modern dockerized LAMP and MEAN stack for local development on Linux, MacOS
and Windows.
It allows you to have an unlimited number of projects ready without having to install
2018-04-03 00:06:12 +00:00
any external software and without having to configure any virtual hosts. As well as providing a
very flexible development stack that you can run offline. (Internet is only required to initially
pull docker container).
The only thing you will have to do is to create a new directory on the filesystem and your virtual
host is ready to be served with your custom domain.
2019-02-28 11:37:47 +00:00
.. raw:: html
<img src="https://raw.githubusercontent.com/devilbox/artwork/master/submissions_diagrams/cytopia/01/png/architecture-full.png" />
2018-03-11 13:57:10 +00:00
.. important::
:ref:`read_first`
2018-07-03 13:47:58 +00:00
Ensure you have read this document to understand how this documentation works.
2018-03-10 21:27:14 +00:00
2018-04-03 00:06:12 +00:00
2018-03-11 13:57:10 +00:00
.. toctree::
:maxdepth: 2
2018-07-03 13:47:58 +00:00
read-first
features
devilbox-purpose
2018-03-10 21:27:14 +00:00
.. toctree::
2018-07-03 13:47:58 +00:00
:caption: Getting started
2018-03-10 21:27:14 +00:00
:maxdepth: 2
:numbered:
2018-07-03 13:47:58 +00:00
getting-started/prerequisites
2018-03-11 10:26:03 +00:00
getting-started/install-the-devilbox
2018-03-10 21:27:14 +00:00
getting-started/start-the-devilbox
2018-07-03 13:47:58 +00:00
getting-started/devilbox-intranet
2018-03-16 08:25:51 +00:00
getting-started/directory-overview
2018-03-10 21:27:14 +00:00
getting-started/create-your-first-project
2018-03-17 09:14:50 +00:00
getting-started/enter-the-php-container
2018-07-03 13:47:58 +00:00
getting-started/change-container-versions
2019-03-02 19:40:45 +00:00
getting-started/important
2018-07-03 13:47:58 +00:00
.. toctree::
:caption: Intermediate
:maxdepth: 2
:numbered:
intermediate/setup-auto-dns
intermediate/setup-valid-https
intermediate/configure-php-xdebug
intermediate/enable-disable-php-modules
intermediate/read-log-files
intermediate/email-catch-all
intermediate/add-custom-environment-variables
intermediate/work-inside-the-php-container
intermediate/source-code-analysis
intermediate/best-practice
.. toctree::
:caption: Advanced
:maxdepth: 2
:numbered:
2018-07-06 07:30:52 +00:00
advanced/customize-php-globally
advanced/customize-webserver-globally
advanced/connect-to-host-os
advanced/connect-to-other-docker-container
2018-07-03 13:47:58 +00:00
advanced/connect-to-external-hosts
2018-07-08 07:26:52 +00:00
advanced/add-custom-cname-records
2018-07-03 13:47:58 +00:00
advanced/add-your-own-docker-image
advanced/overwrite-existing-docker-image
2018-07-06 07:30:52 +00:00
.. toctree::
:caption: Autostart commands
:maxdepth: 2
autostart/custom-scripts-per-php-version
autostart/custom-scripts-globally
autostart/autostarting-nodejs-apps
2018-07-06 07:30:52 +00:00
.. toctree::
:caption: vhost-gen
:maxdepth: 2
2018-08-06 19:42:03 +00:00
vhost-gen/virtual-host-templates
vhost-gen/customize-all-virtual-hosts-globally
2018-07-06 07:30:52 +00:00
vhost-gen/customize-specific-virtual-host
vhost-gen/virtual-host-vs-reverse-proxy
2018-07-06 07:30:52 +00:00
vhost-gen/example-add-subdomains
.. toctree::
:caption: reverse-proxy
:maxdepth: 2
reverse-proxy/reverse-proxy-with-https
reverse-proxy/reverse-proxy-for-custom-docker
2018-08-12 11:20:17 +00:00
.. toctree::
2018-08-15 17:54:20 +00:00
:caption: Enable custom container
2018-08-12 11:20:17 +00:00
:maxdepth: 2
2018-08-15 17:54:20 +00:00
custom-container/enable-all-container
2022-04-14 09:28:54 +00:00
custom-container/enable-php-community
2018-08-19 10:27:42 +00:00
custom-container/enable-blackfire
custom-container/enable-elk-stack
2018-08-15 17:54:20 +00:00
custom-container/enable-mailhog
2019-03-06 13:10:04 +00:00
custom-container/enable-ngrok
2020-03-24 08:21:30 +00:00
custom-container/enable-python-flask
2018-08-15 17:54:20 +00:00
custom-container/enable-rabbitmq
2018-08-18 11:51:35 +00:00
custom-container/enable-solr
2019-02-16 20:12:34 +00:00
custom-container/enable-varnish
2018-08-12 11:20:17 +00:00
2018-07-06 07:30:52 +00:00
.. toctree::
:caption: Corporate Usage
:maxdepth: 2
corporate-usage/shared-devilbox-server-in-lan
2018-07-12 06:48:17 +00:00
corporate-usage/use-external-databases
2019-03-06 13:10:04 +00:00
corporate-usage/showcase-over-the-internet
2018-07-12 06:48:17 +00:00
..
corporate-usage/deploy-devilbox-via-ansible
2018-07-08 10:23:57 +00:00
corporate-usage/access-colleagues-devilbox
2018-07-06 07:30:52 +00:00
corporate-usage/access-devilbox-from-android
corporate-usage/access-devilbox-from-iphone
2018-03-10 21:27:14 +00:00
.. toctree::
:caption: Maintenance
:maxdepth: 2
2018-07-03 13:47:58 +00:00
maintenance/checkout-different-devilbox-release
maintenance/remove-stopped-container
maintenance/update-the-devilbox
maintenance/remove-the-devilbox
maintenance/backup-and-restore-mysql
maintenance/backup-and-restore-pgsql
maintenance/backup-and-restore-mongo
2018-03-10 21:27:14 +00:00
.. toctree::
2018-07-03 13:47:58 +00:00
:caption: Configuration files
2018-03-10 21:27:14 +00:00
:maxdepth: 2
2018-07-03 13:47:58 +00:00
configuration-files/env-file
configuration-files/docker-compose-yml
configuration-files/docker-compose-override-yml
configuration-files/apache-conf
configuration-files/nginx-conf
configuration-files/php-ini
configuration-files/php-fpm-conf
configuration-files/my-cnf
configuration-files/bashrc-sh
2018-03-10 21:27:14 +00:00
.. toctree::
:maxdepth: 2
:caption: Examples
examples/setup-cakephp
2018-05-21 08:52:37 +00:00
examples/setup-codeigniter
2022-10-19 04:11:55 +00:00
examples/setup-codeigniter4
2019-03-07 13:22:21 +00:00
examples/setup-contao
examples/setup-craftcms
2018-03-10 21:27:14 +00:00
examples/setup-drupal
2020-03-19 15:27:04 +00:00
examples/setup-expressionengine
2018-03-10 21:27:14 +00:00
examples/setup-joomla
examples/setup-laravel
examples/setup-magento2
2018-03-10 21:27:14 +00:00
examples/setup-phalcon
2018-05-14 22:30:00 +00:00
examples/setup-photon-cms
2018-07-31 18:21:56 +00:00
examples/setup-presta-shop
2019-04-20 09:56:14 +00:00
examples/setup-processwire
2018-07-07 09:10:04 +00:00
examples/setup-shopware
2018-03-10 21:27:14 +00:00
examples/setup-symfony
2018-07-03 14:27:00 +00:00
examples/setup-typo3
2018-03-10 21:27:14 +00:00
examples/setup-wordpress
examples/setup-yii
examples/setup-zend
examples/setup-other-frameworks
2018-03-10 21:27:14 +00:00
.. toctree::
:maxdepth: 2
:caption: Examples - reverse proxy
examples/setup-reverse-proxy-nodejs
examples/setup-reverse-proxy-sphinx-docs
2020-03-24 08:21:30 +00:00
examples/setup-reverse-proxy-python-flask
2018-03-10 21:27:14 +00:00
2018-03-11 14:26:58 +00:00
.. toctree::
:caption: Readings
:maxdepth: 2
2018-07-03 13:47:58 +00:00
readings/syncronize-container-permissions
2018-03-11 14:26:58 +00:00
readings/available-container
2018-03-17 11:21:46 +00:00
readings/available-tools
2018-03-10 21:27:14 +00:00
2018-03-10 10:31:23 +00:00
.. toctree::
2018-03-10 21:27:14 +00:00
:caption: Support
2018-07-03 13:47:58 +00:00
:maxdepth: 1
2018-03-10 10:31:23 +00:00
2019-01-03 16:57:35 +00:00
Devilbox Forums <https://devilbox.discourse.group/>
2018-07-03 13:47:58 +00:00
support/troubleshooting
support/faq
support/howto
2019-01-03 16:57:35 +00:00
support/blogs-videos-and-use-cases
support/artwork
.. toctree::
:caption: 3rd party projects
:maxdepth: 1
third-party/devilbox-cli
third-party/nginx-acme