ExternalVendorCode/devilbox
1
0
Fork 0
mirror of https://github.com/cytopia/devilbox.git synced 2025-04-16 15:09:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation: Finish feature section

Browse Source
This commit is contained in:
cytopia 2018-04-11 09:03:36 +02:00
parent 76a825b887
commit 5eee20877a
No known key found for this signature in database
GPG Key ID: 6D56EDB8695128A2
1 changed files with 70 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

114
docs/about/features.rst
View File

@ -15,110 +15,136 @@ This section gives you a brief overview about the available features.
Projects
========
**Unlimited 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**
and they become automatically 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**
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**
Email catch-all
^^^^^^^^^^^^^^^
All outgoing emails originating from your projects are intercepted, stored locally and
can be viewed within the bundled intranet.
can be viewed within the bundled intranet. This removes the need to create developer DNS records
in ``/etc/hosts``.
Log files
^^^^^^^^^
Log files for every service are available. Either in the form of Docker logs or as actual log files
mounted into the Devilbox git directory. The web and PHP server offer log files for each project
separetely.
Virtual host domains
^^^^^^^^^^^^^^^^^^^^
Each of your virtual host will have its own domain. TLD can be freely chosen, such as ``*.loc``,
``*.local``, ``*.com``, ``*.org`` or whatever you require.
Service and version choice
==========================
**Selective start**
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**
they are needed. So you could first startup PHP and MySQL only and in case you would require
a Redis server you can attach it later to the Devilbox stack without having to restart anything.
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**
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**
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.
``php.ini``, ``php-fpm.conf``, ``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**
Version specific configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Each version of PHP can have its own ``php.ini`` and ``php-fpm.conf`` 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.
settings via `vhost-gen <https://github.com/devilbox/vhost-gen>`_.
Intranet
========
**Command & Control Center**
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.
Third-party tools
^^^^^^^^^^^^^^^^^
Mandatory web projects are also shipped:
`phpMyAdmin <https://www.phpmyadmin.net>`_,
`Adminer <https://www.adminer.org>`_ and
`OpcacheGui <https://github.com/amnuts/opcache-gui>`_ as well as a web GUI to view all sent emails.
Dockerized
==========
**Portable**
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**
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**
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**
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**
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
=========
Others
======
Work offline
^^^^^^^^^^^^
The Devilbox only requires internet initially to pull the required Docker images, once this is done
you can work completely offline. No need for an active internet connection.
Hacking
^^^^^^^
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.