Documentation: various

This commit is contained in:
cytopia 2018-04-03 02:06:12 +02:00
parent b445e9f4e2
commit 2a4316079a
No known key found for this signature in database
GPG Key ID: 6D56EDB8695128A2
4 changed files with 142 additions and 0 deletions

124
docs/about/features.rst Normal file
View File

@ -0,0 +1,124 @@
.. _features:
********
Features
********
This section gives you a brief overview about the available features.
**Table of Contents**
.. contents:: :local:
Projects
========
**Unlimited projects**
The number of projects you can add are so to speak unlimited. Simply add new project directories
and they become available in no time.
**Automated virtual hosts**
Creating a new project is literally done by creating a new directory on the file system.
Everything else is automatically taken care of in the background. Virtual hosts are added
instantly without having to restart any services.
**Automated DNS records**
The built-in DNS server will automatically make any DNS record available to your host system by
using a wild-card DNS record.
**Email catch-all**
All outgoing emails originating from your projects are intercepted, stored locally and
can be viewed within the bundled intranet.
Service and version choice
==========================
**Selective start**
Run only the Docker container you actually need, but be able to reload others on the fly once
they are needed.
**Version choice**
Each provided service (such as PHP, MySQL, PostgreSQL, etc) comes in many different versions.
You can enable any combination that matches your perfect development stack.
**LAMP and MEAN stack**
Run a full LAMP stack with Apache or Nginx and even attach MEAN stack services such as MongoDB.
Configuration
=============
**Global configuration**
All services can be configured globally by including your very own customized
``php.ini``, ``my.cnf``, ``nginx.conf``. ``apache.conf`` and other configuration files.
**Version specific configuration**
Each version of PHP can have its own ``php.ini`` files, each version of MySQL, MariaDB or
PerconaDB can have its own ``my.cnf`` files, each Apache..., each Nginx... you get the idea.
**Project specific configuration**
Even down to projects, the Devilbox allows for full customization when it comes to virtual host
settings.
Intranet
========
**Command & Control Center**
The intranet is your Command & Control Center showing you all applied settings, mount points,
port exposures, hostnames and any errors including how they can be resolved.
**Third-party tools**
Mandatory web projects are also shipped: phpMyAdmin, Adminer and OpcacheGui.
Dockerized
==========
**Portable**
Docker container run on Linux, Windows and MacOS, so does the Devilbox. This ensures that no
matter what operating system you are currently on, you can always run your development stack.
**Built nightly**
Docker images (at least official Devilbox Docker images) are built nightly and pushed to
Dockerhub to ensure to always have the latest versions installed and be up-to-date with any
security patches that are available.
**Ships popular development tools**
The Devilbox is also designed to be a development environment offering many tools used for
everyday web development, no matter if frontend or backend.
**Work inside the container**
Instead of working on you host operating system, you can do everything inside the container.
This allows you to have all tools pre-installed and a working unix environment ready.
**Work inside and outside the container interchangeably**
No matter if you work on your host operating system or inside the Docker container. Special
mount points and port-forwards are already in place to make both look the same to you.
Customize
=========
Last but not least, the Devilbox is bascially just a ``docker-compose.yml`` file and you can
easily add any Docker images you are currently missing in the Devilbox setup.

View File

@ -5,15 +5,26 @@ devilbox documentation
.. image:: img/banner.png
The Devilbox allows you to have an unlimited number of projects ready without having to install
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.
.. important::
:ref:`read_first`
Ensure you have read this document to understand how this documentation works.
.. toctree::
:maxdepth: 2
:caption: About
about/read-first
about/features
.. toctree::
:maxdepth: 2
@ -139,6 +150,7 @@ devilbox documentation
support/faq
support/troubleshooting
support/hacking
support/contributing
support/blogs-videos-and-use-cases
support/artwork

View File

@ -6,6 +6,8 @@ FAQ
Find common questions and answers here.
.. seealso:: :ref:`troubleshooting`
**Table of Contents**

View File

@ -1,3 +1,5 @@
.. _troubleshooting:
***************
Troubleshooting
***************
@ -5,6 +7,8 @@ Troubleshooting
This section will contain common problems and how to resolve them.
It will grow over time once there are more issues reported.
.. seealso:: :ref:`faq`
**Table of Contents**