ExternalVendorCode/devilbox
1
0
Fork 0
mirror of https://github.com/cytopia/devilbox.git synced 2025-01-18 10:46:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

DVL-016 Overview

Browse Source
This commit is contained in:
cytopia 2017-06-10 13:33:28 +02:00
parent e2b44d2a55
commit 6e14f36735
No known key found for this signature in database
GPG Key ID: 6D56EDB8695128A2
1 changed files with 52 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
docs/README.md
View File

@ -14,15 +14,45 @@
## Overview
1. [Supported Host OS](#1-supported-host-os)
2. [Requirements](#2-requirements)
3. [Docker documentation](#3-docker-documentation)
4. [Devilbox documentation](#4-devilbox-documentation)
5. [Video Tutorials](#5-video-tutorials)
1. [Main idea](#1-main-idea)
2. [Supported Host OS](#2-supported-host-os)
3. [Requirements](#3-requirements)
4. [Docker documentation](#4-docker-documentation)
5. [Devilbox documentation](#5-devilbox-documentation)
6. [Video Tutorials](#6-video-tutorials)
7. [Supported Frameworks and CMS](#7-supported-frameworks-and-cms)
---
### 1. Supported Host OS
### 1. Main idea
The devilbox allows you to have an unlimitted number of projects ready without having to install any external software and without having to configure any virtual hosts.
The only thing you will have to do is to create a new folder on the filesystem and your virtual host is ready to be served with your custom domain.
The default project catch-all domain is `*.dev` (can be changed). Let's see an example:
```shell
# Inside your main project folder
$ ls -l
drwxr-xr-x 3 cytopia 4096 Jun 10 13:10 my-drupal
drwxr-xr-x 3 cytopia 4096 Jun 10 13:10 my-wordpress
drwxr-xr-x 3 cytopia 4096 Jun 10 13:10 project1
drwxr-xr-x 3 cytopia 4096 Jun 10 13:10 project2
drwxr-xr-x 3 cytopia 4096 Jun 10 13:10 yii-test
```
By having the above folders, the devilbox will automatically be able to serve the following vhosts:
* http://my-drupal.dev
* http://my-wordpress.dev
* http://project1.dev
* http://project2.dev
* http://yii-test.dev
New folders can be created, deleted and removed during run-time and corresponding virtual hosts will be available instantly without having to restart anything.
### 2. Supported Host OS
The devilbox runs on all major operating systems. Below you can quickly check the recommended docker versions and current issues per OS.
@ -42,7 +72,7 @@ The devilbox runs on all major operating systems. Below you can quickly check th
[osx-issues]: https://github.com/cytopia/devilbox/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3A%22host%3Aosx%22
### 2. Requirements
### 3. Requirements
* **Internet connection** - only required during initial setup for cloning the devilbox repository and pulling the required docker container. Afterwards you can always work offline.
* [Docker Engine 1.12.0+](https://docs.docker.com/compose/compose-file/compose-versioning/#version-21)
@ -51,12 +81,12 @@ The devilbox runs on all major operating systems. Below you can quickly check th
* On OSX use [Docker for Mac][d4m] (not tested on [Docker Toolbox][dtb])
### 3. Docker documentation
### 4. Docker documentation
If you have never worked with docker/docker-compose before, you should check up on their documentation to get you started: [docker docs](https://docs.docker.com/).
### 4. Devilbox documentation
### 5. Devilbox documentation
| Topic | Description |
|-------------------------|-------------|
@ -70,9 +100,20 @@ If you have never worked with docker/docker-compose before, you should check up
| **[FAQ](FAQ.md)** | Questions and Troubleshooting |
### 5. Video Tutorials
### 6. Video Tutorials
Have a look at youtube to see all the features in action.
Have a look at youtube to see some the features in action.
[![Devilbox setup and workflow](img/devilbox_01-setup-and-workflow.png "devilbox - setup and workflow")](https://www.youtube.com/watch?v=reyZMyt2Zzo)
[![Devilbox email catch-all](img/devilbox_02-email-catch-all.png "devilbox - email catch-all")](https://www.youtube.com/watch?v=e-U-C5WhxGY)
### 7. Supported Frameworks and CMS
As far as tested there are no limitations and you can use any Framework or CMS just as you would on your live environment. Below are a few examples of extensively tested Frameworks and CMS:
![CakePHP](img/logos/cake.png)
![Drupal](img/logos/drupal.png)
![Phalcon](img/logos/phalcon.png)
![Wordpress](img/logos/wordpress.png)
![Yii](img/logos/yii.png)