Devilbox documentation

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 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

Read first

Ensure you have read this document to understand how this documentation works.

• Read first
  • Shell commands
  • Examples
  • Checklists
  • Where to start?
• Features
  • Projects
  • Service and version choice
  • Configuration
  • Intranet
  • Dockerized
  • Others
• Devilbox purpose
  • Why did I built this?
  • Automation is key
  • Issues with Docker encountered
  • Today’s state
  • Tomorrow’s state

Getting started

• 1. Prerequisites
  • 1.1. Supported host OS
  • 1.2. Required software
  • 1.3. Docker installation
  • 1.4. Post installation
  • 1.5. Optional previous knowledge
• 2. Install the Devilbox
  • 2.1. Download the Devilbox
  • 2.2. Create .env file
  • 2.3. Set uid and gid
  • 2.4. OS specific setup
  • 2.5. Checklist
• 3. Start the Devilbox
  • 3.1. The Devilbox startup explained
  • 3.2. Start all container
  • 3.3. Start some container
  • 3.4. Stop and Restart
  • 3.5. Open Devilbox intranet
  • 3.6. Checklist
• 4. Devilbox intranet
  • 4.1. Devilbox tools
  • 4.2. Third-party tools
  • 4.3. Settings
  • 4.4. Checklist
• 5. Directory overview
  • 5.1. Data directory
  • 5.2. Project directory
  • 5.3. Docroot directory
  • 5.4. Domain suffix
  • 5.5. Making sense of it
  • 5.6. Checklist
• 6. Create your first project
  • 6.1. Step 1: visit Intranet vhost page
  • 6.2. Step 2: create a project directory
  • 6.3. Step 3: create a docroot directory
  • 6.4. Step 4: create a DNS entry
  • 6.5. Step 5: visit your project
  • 6.6. Step 6: create a hello world file
  • 6.7. Checklist
  • 6.8. Further examples
• 7. Enter the PHP container
  • 7.1. How to enter
  • 7.2. How to become root
  • 7.3. Tools
  • 7.4. Advanced
  • 7.5. Checklist
• 8. Change container versions
  • 8.1. Implications
  • 8.2. Examples
  • 8.3. Gotchas
  • 8.4. Checklist
• 9. IMPORTANT
  • 9.1. Starting
  • 9.2. Backups

Intermediate

• 1. Setup Auto DNS
  • 1.1. Native Docker
  • 1.2. Docker Toolbox
• 2. Setup valid HTTPS
  • 2.1. TL;DR
  • 2.2. How does it work
  • 2.3. Import the CA into your browser
  • 2.4. Further Reading
• 3. Configure PHP Xdebug
  • 3.1. Introduction
  • 3.2. Configure Xdebug
• 4. Enable/disable PHP modules
  • 4.1. Enabled PHP modules
  • 4.2. Disable PHP modules
  • 4.3. Roadmap
• 5. Read log files
  • 5.1. Mounted logs
  • 5.2. Docker logs
  • 5.3. Checklist
• 6. Email catch-all
  • 6.1. Devilbox Intranet
  • 6.2. MailHog
• 7. Add custom environment variables
  • 7.1. Add custom environment variables
  • 7.2. Use custom environment variables
• 8. Work inside the PHP container
  • 8.1. Enter the container
  • 8.2. Inside the container
  • 8.3. Leave the container
  • 8.4. Host to Container mappings
  • 8.5. Checklist
• 9. Source Code Analysis
  • 9.1. Awesome-ci
  • 9.2. PHPCS
  • 9.3. ESLint
• 10. Best practice
  • 10.1. Move data out of Devilbox directory
  • 10.2. PHP project hostname settings
  • 10.3. Timezone

Advanced

• 1. Customize PHP globally
  • 1.1. Configure PHP settings globally
  • 1.2. Configure non-overwritable settings globally
  • 1.3. Configure loaded PHP modules
  • 1.4. Configure PHP-FPM service
• 2. Customize web server globally
  • 2.1. Configure Apache
  • 2.2. Configure Nginx
  • 2.3. Devilbox specific settings
• 3. Connect to host OS
  • 3.1. Prerequisites
  • 3.2. Docker on Linux
  • 3.3. Docker for Mac
  • 3.4. Docker for Windows
  • 3.5. Docker Toolbox
• 4. Connect to other Docker container
  • 4.1. Any Docker container on host os
  • 4.2. Add Docker container to Devilbox network
  • 4.3. Add Docker container to Devilbox stack
• 5. Connect to external hosts
• 6. Add custom CNAME DNS entries
  • 6.1. Why and what?
  • 6.2. How?
• 7. Add your own Docker image
  • 7.1. Prerequisites
  • 7.2. What information do you need?
  • 7.3. How to add a new service?
  • 7.4. How to start the new service?
  • 7.5. Further reading
• 8. Overwrite existing Docker image
  • 8.1. Prerequisites
  • 8.2. What information do you need?
  • 8.3. How to overwrite a service?
  • 8.4. Further reading

Autostart commands

• Custom scripts per PHP version
  • General
  • Examples
• Custom scripts globally
  • General
  • Examples
• Autostarting NodeJS Apps
  • Self-built
  • Pre-built
  • Reverse proxy NodeJS

vhost-gen

• Virtual host templates
  • Overview
  • Virtual host Templates
  • Reverse proxy Templates
• Customize all virtual hosts globally
  • Prerequisite
  • Apply templates globally to all vhosts
• Customize specific virtual host
  • vhost-gen
  • Templates explained
  • Apply Changes
  • Further readings
• Virtual host vs Reverse Proxy
  • Motivation
  • Benefits
  • Creating a reverse proxy
• Example: add sub domains
  • Simple sub domains for one project
  • Complex sub domains for one project

reverse-proxy

• Reverse Proxy with HTTPS
  • Walkthrough
• Reverse Proxy for custom Docker
  • Walkthrough

Enable custom container

• Enable all additional container
  • Available additional container
  • Enable all additional container
  • Configure additional container
• Enable and configure PHP Community
  • Overview
  • Instructions
  • TL;DR
• Enable and configure Blackfire
  • Overview
  • Instructions
  • TL;DR
• Enable and configure ELK Stack
  • Overview
  • Instructions
  • TL;DR
• Enable and configure MailHog
  • Overview
  • Instructions
  • TL;DR
• Enable and configure Meilisearch
  • Overview
  • Instructions
  • TL;DR
• Enable and configure Ngrok
  • Overview
  • Instructions
  • TL;DR
• Enable and configure Python Flask
  • Overview
  • Instructions
  • TL;DR
• Enable and configure RabbitMQ
  • Overview
  • Instructions
  • TL;DR
• Enable and configure Solr
  • Overview
  • Instructions
  • TL;DR
• Enable and configure Varnish
  • Overview
  • Instructions
  • TL;DR

Corporate Usage

• Shared Devilbox server in LAN
  • Prerequisites
  • Project access
  • Handle DNS records
  • Share Devilbox CA
• Use external databases
  • Why
  • Database on host os
  • Database on network
  • Database on internet
• Showcase over the internet
  • Why
  • How

Maintenance

• Checkout different Devilbox release
• Remove stopped container
  • Why should I?
  • How to do it?
  • When to do it?
• Update the Devilbox
  • Update git repository
  • Update Docker images
  • Checklist git repository
  • Checklist Docker images
• Remove the Devilbox
  • Backups
  • Remove the Devilbox
  • Revert your system changes
• Backup and restore MySQL
  • Backup
  • Restore
• Backup and restore PostgreSQL
  • Backup
  • Restore
• Backup and restore MongoDB
  • Backup
  • Restore

Configuration files

• .env file
  • Core settings
  • Intranet settings
  • Docker image versions
  • Docker host mounts
  • Docker host ports
  • Container settings
• docker-compose.yml
• docker-compose.override.yml
  • How does docker-compose.override.yml work?
  • Create docker-compose.override.yml
  • Further reading
• apache.conf
  • General
  • Examples
• nginx.conf
  • General
  • Examples
• php.ini
  • General
  • Examples
• php-fpm.conf
  • General
  • Examples
• my.cnf
  • General
  • Examples
• bashrc.sh
  • Directory mapping
  • Examples

Examples

• Setup CakePHP
  • Overview
  • Walk through
  • Next steps
• Setup CodeIgniter
  • Overview
  • Walk through
  • Next steps
• Setup CodeIgniter4
  • Overview
  • Walk through
  • Next steps
• Setup Contao
  • Overview
  • Walk through
  • Next steps
• Setup CraftCMS
  • Overview
  • Walk through
  • Next steps
• Setup Drupal
  • Overview
  • Walk through
  • Next steps
• Setup ExpressionEngine
  • Overview
  • Walk through
  • Next steps
• Setup Joomla
  • Overview
  • Walk through
  • Next steps
• Setup Laravel
  • Overview
  • Walk through
  • Next steps
• Setup Magento 2
  • Overview
  • Requirements
  • Walk through
  • Next steps
• Setup Phalcon
  • Overview
  • Walk through
  • Next steps
• Setup Photon CMS
  • Overview
  • Walk through
  • Next steps
• Setup PrestaShop
  • Overview
  • Walk through
  • Next steps
• Setup ProcessWire
  • Overview
  • Walk through
  • Next steps
• Setup Shopware
  • Overview
  • Walk through
  • Encountered problems
  • Next steps
• Setup Symfony
  • Overview
  • Walk through
  • Next steps
• Setup TYPO3
  • Overview
  • Walk through
  • Next steps
• Setup WordPress
  • Overview
  • Walk through
  • Next steps
• Setup Yii
  • Overview
  • Walk through
  • Next steps
• Setup Zend
  • Overview
  • Walk through
  • Next steps
• Setup other Frameworks

Examples - reverse proxy

• Setup reverse proxy NodeJS
  • Overview
  • Walk through
  • Managing NodeJS
  • Next steps
• Setup reverse proxy Sphinx docs
  • Overview
  • Walk through
  • Next steps
• Setup reverse proxy Python Flask
  • Overview
  • Walk through
  • Next steps

Readings

• Syncronize container permissions
  • Unsyncronized permissions
  • It gets even worse
  • The solution
• Available container
  • Core container
  • Additional container
• Available tools

Support

• Devilbox Forums
• Troubleshooting
• FAQ
• How To
• Blogs, Videos and Use-cases
• Artwork

3rd party projects

• Devilbox CLI
• Nginx ACME (letsencrypt)