blackbirdchess-docker-dev/DOCUMENTATION/content/introduction/index.md

215 lines
8.1 KiB
Markdown
Raw Normal View History

2017-02-23 05:08:54 +01:00
---
title: Introduction
type: index
weight: 1
---
2017-04-14 23:46:35 +02:00
A full PHP development environment for Docker.
2017-02-23 05:08:54 +01:00
2017-04-14 23:46:35 +02:00
Includes pre-packaged Docker Images, all pre-configured to provide a wonderful PHP development environment.
2017-02-23 05:08:54 +01:00
2017-04-14 23:46:35 +02:00
Laradock is well known in the Laravel community, as the project started with single focus on running Laravel projects on Docker. Later and due to the large adoption from the PHP community, it started supporting other PHP projects like Symfony, CodeIgniter, WordPress, Drupal...
![](https://s19.postimg.org/jblfytw9f/laradock-logo.jpg)
2017-02-23 05:08:54 +01:00
## Quick Overview
2017-04-14 20:55:45 +02:00
Let's see how easy it is to install `NGINX`, `PHP`, `Composer`, `MySQL`, `Redis` and `Beanstalkd`:
2017-02-23 05:08:54 +01:00
1 - Clone Laradock inside your PHP project:
2017-02-23 05:08:54 +01:00
```shell
git clone https://github.com/Laradock/laradock.git
```
2 - Enter the laradock folder and rename `env-example` to `.env`.
```shell
cp env-example .env
```
3 - Run your containers:
2017-02-23 05:08:54 +01:00
```shell
2018-04-05 15:43:22 +02:00
docker-compose up -d nginx mysql phpmyadmin redis workspace
2017-02-23 05:08:54 +01:00
```
4 - Open your project's `.env` file and set the following:
2017-02-23 05:08:54 +01:00
```shell
DB_HOST=mysql
REDIS_HOST=redis
QUEUE_HOST=beanstalkd
```
5 - Open your browser and visit localhost: `http://localhost`.
2017-02-23 05:08:54 +01:00
```shell
That's it! enjoy :)
```
2017-04-14 23:46:35 +02:00
<a name="features"></a>
## Features
2017-02-23 05:08:54 +01:00
- Easy switch between PHP versions: 7.1, 7.0, 5.6...
2017-04-14 23:46:35 +02:00
- Choose your favorite database engine: MySQL, Postgres, MariaDB...
- Run your own combination of software: Memcached, HHVM, Beanstalkd...
- Every software runs on a separate container: PHP-FPM, NGINX, PHP-CLI...
- Easy to customize any container, with simple edit to the `Dockerfile`.
- All Images extends from an official base Image. (Trusted base Images).
- Pre-configured NGINX to host any code at your root directory.
- Can use Laradock per project, or single Laradock for all projects.
- Easy to install/remove software's in Containers using environment variables.
2017-04-14 23:46:35 +02:00
- Clean and well structured Dockerfiles (`Dockerfile`).
- Latest version of the Docker Compose file (`docker-compose`).
- Everything is visible and editable.
- Fast Images Builds.
- More to come every week..
2017-02-23 05:08:54 +01:00
2017-04-14 23:46:35 +02:00
<a name="Supported-Containers"></a>
## Supported Software (Images)
In adhering to the separation of concerns principle as promoted by Docker, Laradock runs each software on its own Container.
You can turn On/Off as many instances of as any container without worrying about the configurations, everything works like a charm.
2017-02-23 05:08:54 +01:00
2017-04-14 23:46:35 +02:00
- **Database Engines:**
2017-06-09 16:33:10 +02:00
MySQL - MariaDB - Percona - MongoDB - Neo4j - RethinkDB - MSSQL - PostgreSQL - Postgres-PostGIS.
- **Database Management:**
PhpMyAdmin - Adminer - PgAdmin
2017-04-14 23:46:35 +02:00
- **Cache Engines:**
Redis - Memcached - Aerospike
- **PHP Servers:**
NGINX - Apache2 - Caddy
- **PHP Compilers:**
PHP FPM - HHVM
2017-06-09 16:33:10 +02:00
- **Message Queueing:**
Beanstalkd - RabbitMQ - PHP Worker
- **Queueing Management:**
Beanstalkd Console - RabbitMQ Console
- **Random Tools:**
HAProxy - Certbot - Blackfire - Selenium - Jenkins - ElasticSearch - Kibana - Grafana - Mailhog - MailDev - Minio - Varnish - Swoole - Laravel Echo...
2017-02-23 05:08:54 +01:00
2017-04-14 23:46:35 +02:00
Laradock introduces the **Workspace** Image, as a development environment.
It contains a rich set of helpful tools, all pre-configured to work and integrate with almost any combination of Containers and tools you may choose.
2017-02-23 05:08:54 +01:00
2017-04-14 23:46:35 +02:00
**Workspace Image Tools**
PHP CLI - Composer - Git - Linuxbrew - Node - V8JS - Gulp - SQLite - xDebug - Envoy - Deployer - Vim - Yarn - SOAP - Drush...
2017-02-23 05:08:54 +01:00
2017-04-14 23:46:35 +02:00
You can choose, which tools to install in your workspace container and other containers, from the `.env` file.
2017-02-23 05:08:54 +01:00
2017-04-14 23:46:35 +02:00
> If you modify `docker-compose.yml`, `.env` or any `dockerfile` file, you must re-build your containers, to see those effects in the running instance.
2017-02-23 05:08:54 +01:00
2017-05-23 07:52:19 +02:00
If you can't find your Software in the list, build it yourself and submit it. Contributions are welcomed :)
2017-02-23 05:08:54 +01:00
2017-11-08 08:01:40 +01:00
## Sponsors
Support this project by becoming a sponsor.
Your logo will show up on the [github repository](https://github.com/laradock/laradock/) index page and the [documentation](http://laradock.io/) main page, with a link to your website. [[Become a sponsor](https://opencollective.com/laradock#sponsor)]
<a href="https://opencollective.com/laradock/sponsor/0/website" target="_blank"><img src="https://opencollective.com/laradock/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/laradock/sponsor/1/website" target="_blank"><img src="https://opencollective.com/laradock/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/laradock/sponsor/2/website" target="_blank"><img src="https://opencollective.com/laradock/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/laradock/sponsor/3/website" target="_blank"><img src="https://opencollective.com/laradock/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/laradock/sponsor/4/website" target="_blank"><img src="https://opencollective.com/laradock/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/laradock/sponsor/5/website" target="_blank"><img src="https://opencollective.com/laradock/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/laradock/sponsor/6/website" target="_blank"><img src="https://opencollective.com/laradock/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/laradock/sponsor/7/website" target="_blank"><img src="https://opencollective.com/laradock/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/laradock/sponsor/8/website" target="_blank"><img src="https://opencollective.com/laradock/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/laradock/sponsor/9/website" target="_blank"><img src="https://opencollective.com/laradock/sponsor/9/avatar.svg"></a>
2017-02-23 05:08:54 +01:00
2017-04-14 23:46:35 +02:00
<a name="what-is-docker"></a>
## What is Docker?
2017-02-23 05:08:54 +01:00
2017-04-22 22:25:25 +02:00
[Docker](https://www.docker.com) is an open platform for developing, shipping, and running applications.
Docker enables you to separate your applications from your infrastructure so you can deliver software quickly.
With Docker, you can manage your infrastructure in the same ways you manage your applications.
By taking advantage of Dockers methodologies for shipping, testing, and deploying code quickly, you can significantly reduce the delay between writing code and running it in production.
2017-02-23 05:08:54 +01:00
2017-04-14 23:46:35 +02:00
<a name="why-docker-not-vagrant"></a>
## Why Docker not Vagrant!?
[Vagrant](https://www.vagrantup.com) creates Virtual Machines in minutes while Docker creates Virtual Containers in seconds.
Instead of providing a full Virtual Machines, like you get with Vagrant, Docker provides you **lightweight** Virtual Containers, that share the same kernel and allow to safely execute independent processes.
In addition to the speed, Docker gives tons of features that cannot be achieved with Vagrant.
Most importantly Docker can run on Development and on Production (same environment everywhere). While Vagrant is designed for Development only, (so you have to re-provision your server on Production every time).
2017-02-23 05:08:54 +01:00
<a name="Demo"></a>
## Demo Video
What's better than a **Demo Video**:
2017-06-09 16:33:10 +02:00
- Laradock v5.* (should be next!)
- Laradock [v4.*](https://www.youtube.com/watch?v=TQii1jDa96Y)
- Laradock [v2.*](https://www.youtube.com/watch?v=-DamFMczwDA)
- Laradock [v0.3](https://www.youtube.com/watch?v=jGkyO6Is_aI)
- Laradock [v0.1](https://www.youtube.com/watch?v=3YQsHe6oF80)
2017-02-23 05:08:54 +01:00
<a name="Chat"></a>
## Chat with us
You are welcome to join our chat room on Gitter.
[![Gitter](https://badges.gitter.im/Laradock/laradock.svg)](https://gitter.im/Laradock/laradock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
2017-11-08 04:16:50 +01:00
<a name="Donations"></a>
## Donations
2017-11-08 08:01:40 +01:00
> Help keeping the project development going, by [contributing](http://laradock.io/contributing) or donating a little.
> Thanks in advance.
Donate directly via [Paypal](https://www.paypal.me/mzalt)
2017-11-08 04:16:50 +01:00
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/mzalt)
or become a backer on [Open Collective](https://opencollective.com/laradock#backer)
<a href="https://opencollective.com/laradock#backers" target="_blank"><img src="https://opencollective.com/laradock/backers.svg?width=890"></a>
2017-11-08 08:01:40 +01:00
or show your support via [Beerpay](https://beerpay.io/laradock/laradock)
[![Beerpay](https://beerpay.io/laradock/laradock/badge.svg?style=flat)](https://beerpay.io/laradock/laradock)