mirror of
https://github.com/cytopia/devilbox.git
synced 2025-03-01 12:21:54 +00:00
REL-0.9 Updating README.md
This commit is contained in:
cytopia
parent
04c079c625
commit
e1fe843299
93
README.md
93
README.md
@ -1,16 +1,5 @@
|
||||
#  The devilbox
|
||||
|
||||
**General Note:**
|
||||
|
||||
Always check out the latest git tag. The master branch is experimental and likely to not work.
|
||||
|
||||
**Note for OSX:**
|
||||
|
||||
There is currently a huge annoyance with Docker on OSX resulting in very slow file access, because of directory mounts. Read about the ticket here [Docker Forums #8076](https://forums.docker.com/t/file-access-in-mounted-volumes-extremely-slow-cpu-bound/8076).
|
||||
|
||||
**Latest feature:** `MySQL 8.0`
|
||||
|
||||
----
|
||||
|
||||
[Usage](https://github.com/cytopia/devilbox#usage) |
|
||||
[Documentation](https://github.com/cytopia/devilbox#documentation) |
|
||||
@ -22,9 +11,12 @@ There is currently a huge annoyance with Docker on OSX resulting in very slow fi
|
||||
[Contributing](https://github.com/cytopia/devilbox#contributing) |
|
||||
[Todo](https://github.com/cytopia/devilbox/blob/master/CONTRIBUTING.md)
|
||||
|
||||
|
||||
|
||||
|
||||
[](https://travis-ci.org/cytopia/devilbox)  [](https://www.docker.com/) [](https://opensource.org/licenses/MIT)
|
||||
|
||||
The devilbox is a modern and highly customizable alternative for [XAMPP](https://www.apachefriends.org). It is based on `docker-compose` with presets for all kinds of versions for webservers, database servers and PHP.
|
||||
The devilbox is a modern and highly customizable alternative for [XAMPP](https://www.apachefriends.org). It is based on `docker-compose` with presets for all kinds of versions for webservers, database servers and php.
|
||||
|
||||
Configuration is not necessary, as everything is pre-setup with mass virtual hosting.
|
||||
|
||||
@ -38,36 +30,24 @@ Configuration is not necessary, as everything is pre-setup with mass virtual hos
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
## Quick start
|
||||
|
||||
You are up and running in three simple steps:
|
||||
|
||||
```bash
|
||||
# (optional) check out latest stable release
|
||||
$ git checkout $(git describe --abbrev=0 --tags)
|
||||
|
||||
```shell
|
||||
# Copy the example configuration file
|
||||
$ cp env-example .env
|
||||
|
||||
# Edit your configuration
|
||||
$ vim .env
|
||||
|
||||
# Start the containers (base-stack)
|
||||
# Start all containers
|
||||
$ docker-compose up
|
||||
|
||||
# Or instead of the above base-stack, you can also additionally load the
|
||||
# optional stack.
|
||||
# Use this command instead:
|
||||
$ docker-compose -f docker-compose.optional.yml up
|
||||
# Alternatively only start what you need
|
||||
$ docker-compose up httpd php mysql redis
|
||||
```
|
||||
|
||||
## Updates
|
||||
|
||||
In case you update this repository locally on the master branch (e.g.: `git pull origin master`), make sure to repull all Docker containers as they very likely have also been up updated.
|
||||
Otherwise you might run into problems.
|
||||
|
||||
[What is the `.env` file?](https://docs.docker.com/compose/env-file/)
|
||||
|
||||
## Documentation
|
||||
|
||||
**Video Tutorials**
|
||||
@ -85,44 +65,45 @@ Select your prefered setup.
|
||||
|
||||
No need to install and configure different versions locally. Simply choose your required LAMP/LEMP stack combination during startup and it is up and running instantly.
|
||||
|
||||
**Note:** Some Docker container combinations might not work well. See the overall build-matrix for possible problems: \[ [](https://travis-ci.org/cytopia/devilbox) \]
|
||||
### 1/3 Base stack (required)
|
||||
|
||||
**Base stack**
|
||||
|
||||
If you only want to use the base stack, use `docker-compose.yml` (default):
|
||||
```shell
|
||||
$ docker-compose up
|
||||
```
|
||||
|
||||
| Webserver | MySQL | PostgreSQL | PHP |
|
||||
|-----------|-------|------------|-----|
|
||||
| [](https://travis-ci.org/cytopia/docker-apache-2.2) [Apache 2.2](https://github.com/cytopia/docker-apache-2.2) | [](https://travis-ci.org/cytopia/docker-mysql-5.5) [MySQL 5.5](https://github.com/cytopia/docker-mysql-5.5) | [](https://travis-ci.org/docker-library/postgres/branches) [PgSQL 9.2](https://hub.docker.com/_/postgres/) | [](https://travis-ci.org/cytopia/docker-php-fpm-5.4) [PHP 5.4](https://github.com/cytopia/docker-php-fpm-5.4) |
|
||||
| [](https://travis-ci.org/cytopia/docker-apache-2.4) [Apache 2.4](https://github.com/cytopia/docker-apache-2.4) | [](https://travis-ci.org/cytopia/docker-mysql-5.6) [MySQL 5.6](https://github.com/cytopia/docker-mysql-5.6) | [](https://travis-ci.org/docker-library/postgres/branches) [PgSQL 9.3](https://hub.docker.com/_/postgres/) | [](https://travis-ci.org/cytopia/docker-php-fpm-5.5) [PHP 5.5](https://github.com/cytopia/docker-php-fpm-5.5) |
|
||||
| [](https://travis-ci.org/cytopia/docker-nginx-stable) [Nginx stable](https://github.com/cytopia/docker-nginx-stable) | [](https://travis-ci.org/cytopia/docker-mysql-5.7) [MySQL 5.7](https://github.com/cytopia/docker-mysql-5.7) | [](https://travis-ci.org/docker-library/postgres/branches) [PgSQL 9.4](https://hub.docker.com/_/postgres/) | [](https://travis-ci.org/cytopia/docker-php-fpm-5.6) [PHP 5.6](https://github.com/cytopia/docker-php-fpm-5.6) |
|
||||
| [](https://travis-ci.org/cytopia/docker-nginx-mainline) [Nginx mainline](https://github.com/cytopia/docker-nginx-mainline) | [](https://travis-ci.org/cytopia/docker-mysql-8.0) [MySQL 8.0](https://github.com/cytopia/docker-mysql-8.0) | [](https://travis-ci.org/docker-library/postgres/branches) [PgSQL 9.5](https://hub.docker.com/_/postgres/) | [](https://travis-ci.org/cytopia/docker-php-fpm-7.0) [PHP 7.0](https://github.com/cytopia/docker-php-fpm-7.0) |
|
||||
| | [](https://travis-ci.org/cytopia/docker-mariadb-5.5) [MariaDB 5.5](https://github.com/cytopia/docker-mariadb-5.5) | [](https://travis-ci.org/docker-library/postgres/branches) [PgSQL 9.6](https://hub.docker.com/_/postgres/) | [](https://travis-ci.org/cytopia/docker-php-fpm-7.1) [PHP 7.1](https://github.com/cytopia/docker-php-fpm-7.1) |
|
||||
| | [](https://travis-ci.org/cytopia/docker-mariadb-10.0) [MariaDB 10.0](https://github.com/cytopia/docker-mariadb-10.0) | | [](https://travis-ci.org/cytopia/docker-hhvm-latest) [HHVM latest](https://github.com/cytopia/docker-hhvm-latest)
|
||||
| | [](https://travis-ci.org/cytopia/docker-mariadb-10.1) [MariaDB 10.1](https://github.com/cytopia/docker-mariadb-10.1) | |
|
||||
| | [](https://travis-ci.org/cytopia/docker-mariadb-10.2) [MariaDB 10.2](https://github.com/cytopia/docker-mariadb-10.2) | |
|
||||
| | [](https://travis-ci.org/cytopia/docker-mariadb-10.3) [MariaDB 10.3](https://github.com/cytopia/docker-mariadb-10.3) | |
|
||||
| Webserver | PHP |
|
||||
|-----------|-----|
|
||||
| [](https://travis-ci.org/cytopia/docker-apache-2.2) [Apache 2.2](https://github.com/cytopia/docker-apache-2.2) | [](https://travis-ci.org/cytopia/docker-php-fpm-5.4) [PHP 5.4](https://github.com/cytopia/docker-php-fpm-5.4) |
|
||||
| [](https://travis-ci.org/cytopia/docker-apache-2.4) [Apache 2.4](https://github.com/cytopia/docker-apache-2.4) | [](https://travis-ci.org/cytopia/docker-php-fpm-5.5) [PHP 5.5](https://github.com/cytopia/docker-php-fpm-5.5) |
|
||||
| [](https://travis-ci.org/cytopia/docker-nginx-stable) [Nginx stable](https://github.com/cytopia/docker-nginx-stable) | [](https://travis-ci.org/cytopia/docker-php-fpm-5.6) [PHP 5.6](https://github.com/cytopia/docker-php-fpm-5.6) |
|
||||
| [](https://travis-ci.org/cytopia/docker-nginx-mainline) [Nginx mainline](https://github.com/cytopia/docker-nginx-mainline) | [](https://travis-ci.org/cytopia/docker-php-fpm-7.0) [PHP 7.0](https://github.com/cytopia/docker-php-fpm-7.0) |
|
||||
| | [](https://travis-ci.org/cytopia/docker-php-fpm-7.1) [PHP 7.1](https://github.com/cytopia/docker-php-fpm-7.1) |
|
||||
| | [](https://travis-ci.org/cytopia/docker-hhvm-latest) [HHVM latest](https://github.com/cytopia/docker-hhvm-latest)
|
||||
|
||||
|
||||
**Optional NoSQL stack**
|
||||
### 2/3 SQL stack (optional)
|
||||
|
||||
In order to also use the Docker containers below, use the `docker-compose.optional.yml` instead:
|
||||
```shell
|
||||
$ docker-compose -f docker-compose.optional.yml up
|
||||
```
|
||||
| MySQL | PostgreSQL |
|
||||
|-------|------------|
|
||||
| [](https://travis-ci.org/cytopia/docker-mysql-5.5) [MySQL 5.5](https://github.com/cytopia/docker-mysql-5.5) | [](https://travis-ci.org/docker-library/postgres/branches) [PgSQL 9.2](https://hub.docker.com/_/postgres/) |
|
||||
| [](https://travis-ci.org/cytopia/docker-mysql-5.6) [MySQL 5.6](https://github.com/cytopia/docker-mysql-5.6) | [](https://travis-ci.org/docker-library/postgres/branches) [PgSQL 9.3](https://hub.docker.com/_/postgres/) |
|
||||
| [](https://travis-ci.org/cytopia/docker-mysql-5.7) [MySQL 5.7](https://github.com/cytopia/docker-mysql-5.7) | [](https://travis-ci.org/docker-library/postgres/branches) [PgSQL 9.4](https://hub.docker.com/_/postgres/) |
|
||||
| [](https://travis-ci.org/cytopia/docker-mysql-8.0) [MySQL 8.0](https://github.com/cytopia/docker-mysql-8.0) | [](https://travis-ci.org/docker-library/postgres/branches) [PgSQL 9.5](https://hub.docker.com/_/postgres/) |
|
||||
| [](https://travis-ci.org/cytopia/docker-mariadb-5.5) [MariaDB 5.5](https://github.com/cytopia/docker-mariadb-5.5) | [](https://travis-ci.org/docker-library/postgres/branches) [PgSQL 9.6](https://hub.docker.com/_/postgres/) |
|
||||
| [](https://travis-ci.org/cytopia/docker-mariadb-10.0) [MariaDB 10.0](https://github.com/cytopia/docker-mariadb-10.0) | |
|
||||
| [](https://travis-ci.org/cytopia/docker-mariadb-10.1) [MariaDB 10.1](https://github.com/cytopia/docker-mariadb-10.1) | |
|
||||
| [](https://travis-ci.org/cytopia/docker-mariadb-10.2) [MariaDB 10.2](https://github.com/cytopia/docker-mariadb-10.2) | |
|
||||
| [](https://travis-ci.org/cytopia/docker-mariadb-10.3) [MariaDB 10.3](https://github.com/cytopia/docker-mariadb-10.3) | |
|
||||
|
||||
|
||||
### 3/3 NoSQL stack (optional)
|
||||
|
||||
| Cassandra | CouchDB | Memcached | MongoDB | Redis |
|
||||
|-----------|---------|-----------|---------|-------|
|
||||
| Cassandra 2.1 | CouchDB 1.6 | Memcached latest | MongoDB 2.6 | [](https://travis-ci.org/docker-library/redis/branches) [Redis 2.8](https://github.com/docker-library/redis) |
|
||||
| Cassandra 2.1 | CouchDB 1.6 | [](https://travis-ci.org/docker-library/memcached/branches) Memcached latest | MongoDB 2.6 | [](https://travis-ci.org/docker-library/redis/branches) [Redis 2.8](https://github.com/docker-library/redis) |
|
||||
| Cassandra 2.2 | CouchDB 2.0 | | MongoDB 3.0 | [](https://travis-ci.org/docker-library/redis/branches) [Redis 3.0](https://github.com/docker-library/redis) |
|
||||
| Cassandra 3.0 | | | MongoDB 3.2 | [](https://travis-ci.org/docker-library/redis/branches) [Redis 3.2](https://github.com/docker-library/redis) |
|
||||
| | | | MongoDB 3.4 | |
|
||||
|
||||
<sub>**Note:** Entries without links or without build-status are not yet available, but are coming soon. See [ROADMAP](https://github.com/cytopia/devilbox/issues/23) for tasks and upcoming features.</sub>
|
||||
|
||||
|
||||
<!--
|
||||
**Optional search stack**
|
||||
|
||||
@ -175,7 +156,7 @@ The devilbox comes with a pre-configured intranet on `http://localhost`
|
||||
|
||||
## Screenshots
|
||||
|
||||
**Homepage with host / Docker information**
|
||||
**Homepage with host / docker information**
|
||||
|
||||
The homepage shows you the status of your current configured setup.
|
||||
|
||||
@ -215,5 +196,5 @@ Shows you all the emails that have been sent. No email will actually be sent out
|
||||
|
||||
There is quite a lot todo and planned. If you like to contribute, view [CONTRIBUTING.md](https://github.com/cytopia/devilbox/blob/master/CONTRIBUTING.md) and [ROADMAP](https://github.com/cytopia/devilbox/issues/23).
|
||||
|
||||
Contributors will be credited within the intranet and on the GitHub page.
|
||||
Contributors will be credited within the intranet and on the github page.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user