diff --git a/.gitignore b/.gitignore index 0888f64d..a10fc659 100644 --- a/.gitignore +++ b/.gitignore @@ -39,6 +39,11 @@ /cfg/php-fpm-7.1/*.ini /cfg/hhvm-latest/*.ini +# gh-pages +docs/Gemfile +docs/Gemfile.lock +docs/_site/ +docs/view-page.sh ###################################### diff --git a/docs/README.md b/docs/README.md index c813d6cc..e43cec02 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,28 +1,32 @@ -# Devilbox Documentation +# Devilbox -[Home](https://github.com/cytopia/devilbox) | -Overview | -[Configuration](Configuration.md) | -[Usage](Usage.md) | -[Updating](Updating.md) | -[Info](Info.md) | -[PHP Projects](PHP_Projects.md) | -[Emails](Emails.md) | -[Logs](Logs.md) | -[Intranet](Intranet.md) | -[FAQ](FAQ.md) +| **Overview** | **Installing** | **Updating** | **Configuration** | **Usage** | **Technical** | **FAQ** | ----- +--- -## Overview -![Devilbox](img/devilbox-dash.png) +### Dockerized LAMP/MEAN stack -This is a brief overview to get you started as quick as possible. For in-depth documentation use the navigation above. +
The devilbox is a modern and highly customisable LAMP and MEAN stack replacement based purely on docker and docker-compose running on all major platforms. It supports an unlimited number of projects for which vhosts and DNS records are created automatically. Email catch-all and popular development tools will be at your service as well.
+ + + + +### Supported Host OS + +Don't worry about switching computers. The devilbox will run on all major operating systems.
+ +Your whole development stack is up and running in a few simple steps.
+ ```shell # Get the soures $ git clone https://github.com/cytopia/devilbox @@ -32,56 +36,124 @@ $ cd devilbox $ cp env-example .env $ vim .env -# Start your container +# Start your daemons $ docker-compose up ``` -### Create projects -Inside the `.env` file you will find two important variables: -1. `HOST_PATH_HTTPD_DATADIR` -2. `TLD_SUFFIX` +### Run exactly what you need -The first one defines the root path for all your projects and the second one defines your desired domain suffix (default: `loc`). Inside the `HOST_PATH_HTTPD_DATADIR` folder you will have to create the following generic directory structure: `Choose your required daemons and select a version. Any combination is possible.
This will allow you, to always exactly simulate your production environment locally during development.
You are not forced to load the whole stack everytime. Only bring up what you really need.
It is also possible to add or remove daemons while the stack is already running.
Head over to youtube for a quick introduction and see for yourself how easily new projects can be created.
+ + + + +### Batteries included + +No need to download external tools. Everything is bundled, up-to-date and available inside the containers.
+ + + + +### Supported Frameworks and CMS + +There is nothing special about the devilbox, so any framework or CMS that will work with normal LAMP/MEAN stacks will work here as well. However in order to make double sure, a few popular applications have been explicitly tested.
+ + + + +### Devilbox Intranet + +Once the devilbox is up and running, you can visit the bundled intranet on http://localhost.
The intranet is not just a simple dash, it provides many useful tools:
Be aware that the docker service is running with root privileges on your system (like any other webserver for example). The devilbox is using a mix of official docker images and custom images. All integrated containers are available on Github and can be reviewed at any time.
+ + +### Up-to-dateness + +Docker containers are pushed to Docker Hub frequently.
It should be enough for you to pull updated images on a regeular basis.
However, if a new minor version (PHP for example) has just been released and you want to use it right away with the devilbox, you can simply *git clone* the docker repository and rebuild the container. Each container repository contains a shell script for easy building.
+ +```shell +# Download PHP 7.1 repository +$ git clone https://github.com/cytopia/docker-php-fpm-7.1 + +# Rebuild the container in order to get the latest minor/patch version +$ cd docker-php-fpm-7.1 +$ ./build/docker-rebuild.sh +``` + + +### Integration Tests + + + +In order to make sure everything always runs stable and as expected, the devilbox makes heavy use of integration tests. You can head over to Travis-CI and have a look at stable and nightly builds.
diff --git a/docs/_config.yml b/docs/_config.yml index c7418817..34f21e0b 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1 +1,4 @@ -theme: jekyll-theme-slate \ No newline at end of file +theme: jekyll-theme-slate +kramdown: + input: GFM + hard_wrap: false diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html new file mode 100644 index 00000000..1793825c --- /dev/null +++ b/docs/_layouts/default.html @@ -0,0 +1,62 @@ + + + + + + + + + + + +