-
-
-
- -
-
- getFooter(); ?>
-
-
diff --git a/.devilbox/www/htdocs/support.php b/.devilbox/www/htdocs/support.php
index a44bec37..dc609390 100644
--- a/.devilbox/www/htdocs/support.php
+++ b/.devilbox/www/htdocs/support.php
@@ -66,6 +66,10 @@
vhost-gen:
--
- -
-
-
-
-
-
-
- - .conf - -
-
- -
- The Virtual Host "" does not exist.
- - getVhostgenTemplatePath($vhost); ?> - -No custom vhost-gen configuration found for "".
- -Note: If the resulting virtual host config does not reflect the vhost-gen template changes, you will need to restart the Devilbox.
- Overview-
virtual host config
- - .conf - -
vhost-gen config
-
- -
amd64 and arm64)amd64 and arm64)amd64 and arm64)+
+The main goal is to provide a reproducible development environment that runs on all major platforms and is able to switch and combine any version you need. +It supports an unlimited number of projects for which vhosts, SSL certificates and DNS records are created automatically. +Email interception and popular development tools will be at your service as well. Configuration is not necessary, as everything is already pre-setup. +
+
+All created projects (frontend or backend) will be able to communicate with one another to support the emulation of a complete microservice architecture or an API landscape. +
+
+**Available Architectures:** `amd64`, `arm64`
+**Available PHP Versions:** `5.2`, `5.3`, `5.4`, `5.5`, `5.6`, `7.0`, `7.1`, `7.2`, `7.3`, `7.4`, `8.0`, `8.1`, `8.2` -Furthermore, the Devilbox provides an **identical** and **reproducible development environment** for different host operating systems. -**Requirements** + +## ๐ Quickstart + +
โ System Requirements
++The Devilbox runs on all major operating systems and its only requirement is
Docker and Docker Compose:     +
* [Docker Engine 17.06.0+](https://docs.docker.com/compose/compose-file/compose-versioning/#version-23) * [Docker Compose 1.16.0+](https://docs.docker.com/compose/compose-file/compose-versioning/#version-23) +
๐ Install and Run: Linux
-The Devilbox aims to be a swiss army knife for local development by providing you all the services -you would ever need. To get an idea about the architecture behind it and to also see what's available -have a look at the following diagrams and tables. +Linux: Install
+ +1. Download the Devilbox + ```bash + git clone https://github.com/cytopia/devilbox + ``` +2. Enter the Devilbox git directory + ```bash + cd devilbox + ``` +3. Copy the default environment file + ```bash + cp env-example .env + ``` + +Linux: Run
+ +> :warning: Important: Ensure that nothing is listening on port80 and 443 on your host system. These ports are required by the Devilbox webserver.
+
++ +1. Start `httpd`, `php` and `mysql` container + ```bash + # This step may take a few minutes as required + # Docker images have to be pulled initially. + + # Inside the Devilbox git directory + docker-compose up httpd php mysql + ``` +2. Visit http://localhost in your browser + +
+
๐ Install and Run: MacOS
+ +MacOS: Install
+ +1. Download the Devilbox + ```bash + git clone https://github.com/cytopia/devilbox + ``` +2. Enter the Devilbox git directory + ```bash + cd devilbox + ``` +3. Copy the default environment file + ```bash + cp env-example .env + ``` + +MacOS: Run
+ +> :warning: Important: Ensure that nothing is listening on port80 and 443 on your host system. These ports are required by the Devilbox webserver.
+
++ +1. Start `httpd`, `php` and `mysql` container + ```bash + # This step may take a few minutes as required + # Docker images have to be pulled initially. + + # Inside the Devilbox git directory + docker-compose up httpd php mysql + ``` +2. Visit http://localhost in your browser + +
+
๐ Install and Run: Windows
++Note: If you are using
WSL2, refer to the Linux guide instead.
++ +
Windows: Install
+ +1. Clonehttps://github.com/cytopia/devilbox to C:\devilbox with Git for Windows
+2. Copy C:\devilbox\env-example to C:\devilbox\.env
+
+
+Windows: Run
+ +> :warning: Important: Ensure that nothing is listening on port80 and 443 on your host system. These ports are required by the Devilbox webserver.
+
+Open a terminal on Windows and start `httpd`, `php` and `mysql` container:
++ +1. Start `httpd`, `php` and `mysql` container + ```bash + # This step may take a few minutes as required + # Docker images have to be pulled initially. + + # Inside the Devilbox git directory + docker-compose up httpd php mysql + ``` +2. Visit http://localhost in your browser + +
+
๐ป Enter the work container
+Enter the work container
+ +The Devilbox allows you to work on your projects on the host system as well as inside the work container. Your project files will be available at both locations. The workflow ususally is: + +1. Use your prefered IDE (e.g. PhpStorm) on your host system to add and alter files +2. Work inside the container to run common cli tools such as `node`, `composer`, `npm`, `phpcs`, `webpack` and many more. + +To enter the work container, simply run `./shell.sh` + +1. On Linux, MacOS and Windows with WSL2 + ```bash + # Inside the Devilbox git directory + ./shell.sh + ``` +2. On Windows without WSL2 + ```bash + # Inside the Devilbox git directory + ./shell.bat + ``` + +Example: Dummy Project
+ +1. Start the container you need: + ```bash + docker-compose up httpd php mysql + ``` +2. Enter the work container: + ```bash + ./shell.sh + ``` +3. Navigate to `/shared/httpd`: + ```bash + cd /shared/httpd + ``` +4. Create your project directory + ```bash + mkdir dummy-project + ``` +5. Visit http://localhost/vhosts.php+ You will notice that you need to create a `htdocs/` directory
+
+6. Create `htdocs/` directory
+ ```bash
+ # Navigate to your project directory
+ cd /shared/httpd/dummy-project
+
+ # Create htdocs dir
+ mkdir htdocs
+ ```
+7. Visit http://localhost/vhosts.php+ You will see that everything is now setup and your project is created and available
+
+8. Create an `index.php` file
+ ```bash
+ # Navigate to your project htdocs directory
+ cd /shared/httpd/dummy-project/htdocs
+
+ # Create a simple index.php file
+ echo ' index.php
+ ```
+9. View your project in the browser: http://dummy-project.dvl.to
+
++
Example: PHP Framework
+ +Find all the examples in the documentation: + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ Automation + :star: Automated Project creation+ :star: Automated SSL+ :star: Automated DNS+ :star: Host permission sync+ |
+
+ Modes + :star: Static files+ :star: PHP files+ :star: Reverse Proxy+ :star: Websockets+ |
+
+ Backends + :star: PHP-FPM+ :star: NodeJS+ :star: Python+ :star: Golang+ :star: ...+ |
+
+ Profiling + :star: Blackfire+ :star: Xdebug+ :star: XHProf+ |
+
|
+ Projects + :star: Unlimited Projects+ :star: Inter-Project Communication+ :star: Custom Project domains+ :star: Valid browser HTTPS+ |
+
+ Intranet + :star: Virtual Hosts+ :star: C&C+ :star: Email Reader+ :star: OpCache Gui+ |
+
+ Batteries + :star: Adminer+ :star: phpMyAdmin+ :star: phpPgAdmin+ :star: phpRedMind+ |
+
+ Services + :star: SQL+ :star: NoSQL+ :star: Cache+ :star: ...+ |
+
The Devilbox Stack
+
+The Devilbox aims to be a swiss army knife for local development by providing you all the services you would ever need. To get an idea about the architecture behind it and to also see what's available have a look at its components and usage.
๐ป Modes of operation
+ +Modes of operation
+ +You can startup and operate the Devilbox in three different ways via `docker-compose`: + +1. Selective startup +2. On Demand (add/remove container while running) +3. Full startup + +#### Selective startup + +If you already know what kind of container you need before starting the Devilbox, you can just specify them explicitly. + +```bash +# Inside the Devilbox git directory start httpd php mysql and redis +docker-compose up httpd php mysql redis +``` + +The Intranet will show you what container you have currently running: + + + + +#### On Demand + +If the Devilbox is already started you can attach more container on-the-fly, + +```bash +# Inside the Devilbox git directory attach mongo and memcached +docker-compose up mongo memcd +``` + +You can also shut down specific containers that you do not need + +```bash +# Inside the Devilbox git directory shutdown redis +docker-compose stop redis +``` + +#### Full startup + +If you just want to start everything, run `docker-compose up` without any arguments + +```bash +# Inside the Devilbox git directory start them all +docker-compose up +``` + +The Intranet will show you what container you have currently running: + + + +If you prefer a visual guide, have a look at the two introduction videos on Youtube: ++
+
+
+
+> **Documentation:**
+> [Install the Devilbox](https://devilbox.readthedocs.io/en/latest/getting-started/install-the-devilbox.html) |
+> [Start the Devilbox](https://devilbox.readthedocs.io/en/latest/getting-started/start-the-devilbox.html) |
+> [.env file](https://devilbox.readthedocs.io/en/latest/configuration-files/env-file.html)
+
++
๐ Available Container
+ +Available Container
The following table lists all integrated and pre-configured Docker container shipped by the Devilbox. Only the webserver and PHP container are mandatory, all others are optional and don't need to be started. @@ -103,117 +459,23 @@ Each of them is also available in multiple different versions in order to reflec | | | | PerconaDB | Redis | | Kibana | MailHog | | | | | PostgreSQL | | | | Ngrok | ++ > **Documentation:** > [Available Container](https://devilbox.readthedocs.io/en/latest/readings/available-container.html) -## Community +
+
๐ Version Matrix
-๐ Docs |
- ๐ฎ Discord |
- ๐ช Forum |
- ๐ฅ Flames |
-
|---|---|---|---|
-
- 
-
- |
-
-
- 
-
- |
-
-
- 
-
- |
-
-
- 
-
- |
-
| devilbox.readthedocs.io | -discord/devilbox | -devilbox.discourse.group | -github.com/devilbox/flames | -
| Linux and MacOS | -Windows | -
|---|---|
-# Get the Devilbox
-git clone https://github.com/cytopia/devilbox# Create docker-compose environment file
-cd devilbox
-cp env-example .env# Edit your configuration
-vim .env# Start all container
-docker-compose up |
-
- 1. Clone https://github.com/cytopia/devilbox to C:\devilbox with Git for Windows- 2. Copy C:\devilbox\env-example to C:\devilbox\.env- 3. Edit C:\devilbox\.env- 4. Open a terminal on Windows and type: - # Start all container -C:\devilbox> docker-compose up- |
-
Version Matrix
Every single attachable container comes with many different versions. In order to select the desired version for a container, simply edit the `.env` file and uncomment the version of choice. Any combination is possible. +#### Run different versions +[1] PHP 5.2 is available to use, but it is not officially supported. The Devilbox intranet does not work with this version as PHP 5.2 does not support namespaces. Furthermore PHP 5.2 does only work with Apache 2.4, Nginx stable and Nginx mainline. It does not work with Apache 2.2. Use at your own risk. @@ -462,263 +725,18 @@ Additionally to the default stack, there are a variety of other services that ca
-## License
+## ๐ License
**[MIT License](LICENSE.md)**
Copyright (c) 2016 **[cytopia](https://github.com/cytopia)**
+
+
+