Compare commits

..

7 Commits

Author SHA1 Message Date
5190da831a remove containers names from docker-compose
to void conflict while scalling using the scale command
2016-05-08 13:39:43 +03:00
fdaa983e77 update readme, put requirements in table 2016-05-08 11:25:43 +03:00
e52f8f5613 update readme file, add more details on linux 2016-05-08 10:54:10 +03:00
f9c13090c6 general updates to the readme file 2016-05-07 19:59:59 +03:00
bfa0d54b5a add features list to the readme file 2016-05-07 19:51:45 +03:00
7f80888fc1 add more info to the readme file 2016-05-07 18:48:27 +03:00
31793a3cc9 general updates to the readme file 2016-05-07 05:58:20 +03:00
2 changed files with 135 additions and 66 deletions

195
README.md
View File

@ -15,6 +15,11 @@ It's like Laravel Homestead but for Docker instead of Vagrant.
- [Intro](#Intro)
- [Features](#features)
- [What is Docker](#what-is-docker)
- [What is Laravel](#what-is-laravel)
- [Why Docker not Vagrant](#why-docker-not-vagrant)
- [LaraDock VS Homestead](#laradock-vs-homestead)
- [Supported Containers](#Supported-Containers)
- [Requirements](#Requirements)
- [Installation](#Installation)
@ -25,11 +30,11 @@ It's like Laravel Homestead but for Docker instead of Vagrant.
- [Delete all existing Containers](#Delete-all-existing-Containers)
- [Build/Re-build Containers](#Build-Re-build-Containers)
- [Use Redis](#Use-Redis)
- [Use custom Domain](Use-custom-Domain)
- [Change the PHP Version](#Change-the-PHP-Version)
- [Add/Remove a Docker Container](#AddRemove-a-Docker-Container)
- [Add more Software's (Docker Images)](#Add-Docker-Images)
- [Edit a Docker Container](#Edit-a-Docker-Container)
- [Edit default container configuration](#Edit-Container)
- [Use custom Domain](Use-custom-Domain)
- [View the Log files](#View-the-Log-files)
- [Enter a Container (SSH into a running Container)](#Enter-Container)
- [Edit a Docker Image](#Edit-a-Docker-Image)
@ -47,37 +52,83 @@ LaraDock strives to make the development experience easier.
It contains pre-packaged Docker Images that provides you a wonderful development environment without requiring you to install PHP, NGINX, MySQL, REDIS, and any other software on your local machine.
<a name="features"></a>
### Features
- Easy switch between PHP versions: 7.0 - 5.6 - 5.5 - ...
- Choose your favorite database engine: MySQL - Postgres - Redis - ...
- Run your own combination of software's: PHP - NGINX - MySQL - ...
- Every software runs on a separate container: PHP - NGINX - ...
- 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 for Laravel. And very easy to update.
- Using of a Data container, to keep the Data safe and accessible at anytime.
- Easy to apply configurations inside containers.
- Clean and well structured Dockerfiles (`dockerfile`).
- Latest version of the Docker Compose file (`docker-compose`).
- Everything is visible and editable.
- Best practices everywhere.
<a name="what-is-docker"></a>
### What is Docker?
[Docker](https://www.docker.com) is an open-source project that automates the deployment of applications inside software containers, by providing an additional layer of abstraction and automation of [operating-system-level virtualization](https://en.wikipedia.org/wiki/Operating-system-level_virtualization) on Linux, Mac OS and Windows.
<a name="what-is-laravel"></a>
### What is Laravel?
Seriously!!!
<a name="why-docker-not-vagrant"></a>
### Why Docker not Vagrant!?
[Vagrant](https://www.vagrantup.com) gives you Virtual Machines in minutes while Docker gives you Virtual Containers in seconds.
[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 tens 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).
<a name="laradock-vs-homestead"></a>
### LaraDock VS Homestead
LaraDock and [Homestead](https://laravel.com/docs/master/homestead) both gives you a complete virtual development environments. (Without the need to install and configure every single software on your own Operating System).
- Homestead is a tool that controls Vagrant for you (using Homestead special commands). And Vagrant manages your Virtual Machine.
- LaraDock is a tool that controls Docker for you (using Docker Compose official commands). And Docker manages you Virtual Containers.
Running a virtual Container is much faster than running a full virtual Machine.
<br>Thus **LaraDock is much faster than Homestead**.
<a name="Supported-Containers"></a>
## Supported Containers
- PHP
- PHP (7.0 - 5.6 - 5.5)
- NGINX
- MySQL
- PostgreSQL
- Redis
- Data Volume
Cannot find your container! we would love to have it as well. Consider contributing your container and adding it to this list.
<a name="Requirements"></a>
## Requirements
- Laravel ([Download](https://laravel.com/docs/master/installation))
- Docker Toolbox ([Download](https://www.docker.com/toolbox))
- Git ([Download](https://git-scm.com/downloads))
- Composer ([Download](https://getcomposer.org/download/))
| Linux | Windows & MAC |
|-----------------------------------------------------------------------------------------|---------------------------------------------------------|
| [Laravel](https://laravel.com/docs/master/installation) | [Laravel](https://laravel.com/docs/master/installation) |
| [Git](https://git-scm.com/downloads) | [Git](https://git-scm.com/downloads) |
| [Docker Engine](https://docs.docker.com/engine/installation/linux/ubuntulinux/#install) | [Docker Toolbox](https://www.docker.com/toolbox) |
| [Docker Compose](https://docs.docker.com/compose/install) | |
<a name="Installation"></a>
## Installation
@ -97,12 +148,15 @@ git submodule add https://github.com/LaraDock/laradock.git docker
>These commands should create a `docker` folder, on the root directory of your Laravel project.
<a name="Usage"></a>
## Usage
>**(Windows & MAC users)** Make sure you have a running Docker Virtual Host on your machine first.
><br>
>[How to run a Docker Virtual Host?](#Run-Docker-Virtual-Host)
0 - For **Windows & MAC** users only: make sure you have a running Docker Virtual Host on your machine.
(**Linux** users don't need a Virtual Host, so skip this step)
<br>
[How to run a Docker Virtual Host?](#Run-Docker-Virtual-Host)
<br>
@ -172,10 +226,12 @@ docker-compose stop
To stop single container do:
```php
```bash
docker-compose stop {container-name}
```
<br>
<a name="Delete-all-existing-Containers"></a>
#### Delete all existing Containers
@ -197,10 +253,10 @@ If you do any change to any `dockerfile` make sure you run this command, for the
```bash
docker-compose build
```
Optionally you can specify which container to rebuild (instead of rebuilding all the containers), example rebuilding `PHP`:
Optionally you can specify which container to rebuild (instead of rebuilding all the containers):
```bash
docker-compose build php
docker-compose build {container-name}
```
@ -245,7 +301,68 @@ composer require predis/predis:^1.0
5 - You can manually test it from Laravel with this code:
```php
\Cache::store('redis')->put('laradock', 'awesome', 10);
\Cache::store('redis')->put('LaraDock', 'Awesome', 10);
```
<br>
<a name="Change-the-PHP-Version"></a>
#### Change the PHP Version
By default **PHP 7.0** is running.
<br>
To change the default PHP version:
1 - Open the `dockerfile` of the `php` folder.
2 - Change the PHP version number in the first line,
```txt
FROM php:7.0-fpm
```
Supported Versions:
- For (PHP 7.0.*) use `php:7.0-fpm`
- For (PHP 5.6.*) use `php:5.6-fpm`
- For (PHP 5.5.*) use `php:5.5-fpm`
For more details visit the [official PHP docker images](https://hub.docker.com/_/php/).
3 - Finally rebuild the container
```bash
docker-compose build php
```
<br>
<a name="Add-Docker-Images"></a>
#### Add more Software's (Docker Images)
To add an image (software), just edit the `docker-compose.yml` and add your container details, to do so you need to be familiar with the [docker compose file syntax](https://docs.docker.com/compose/compose-file/).
<br>
<a name="Edit-Container"></a>
#### Edit default container configuration
Open the `docker-compose.yml` and change anything you want.
Examples:
Change MySQL Database Name:
```yml
environment:
MYSQL_DATABASE: laradock
```
Change Redis defaut port to 1111:
```yml
ports:
- "1111:6379"
```
@ -282,51 +399,6 @@ server_name laravel.dev;
<br>
<a name="Change-the-PHP-Version"></a>
#### Change the PHP Version
By default **PHP 7.0** is running.
<br>
To change the default PHP version:
1 - Open the `dockerfile` of the `php` folder.
2 - Change the PHP version number in the first line,
```txt
FROM php:7.0-fpm
```
Supported Versions:
- For (PHP 7.0.*) use `php:7.0-fpm`
- For (PHP 5.6.*) use `php:5.6-fpm`
- For (PHP 5.5.*) use `php:5.5-fpm`
For more details visit the [official PHP docker images](https://hub.docker.com/_/php/).
<br>
<a name="Add-Docker-Images"></a>
#### Add more Software's (Docker Images)
To add an image (software), just edit the `docker-compose.yml` and add your container details, to do so you need to be familiar with the [docker compose file syntax](https://docs.docker.com/compose/compose-file/).
<br>
<a name="Edit-a-Docker-Container"></a>
#### Edit a Docker Container (change Ports or Volumes)
To modify a container you can simply open the `docker-compose.yml` and change everything you want.
Example: if you want to set the MySQL port to 3333, just replace the default port with yours:
```yml
ports:
- "3333:3306"
```
<br>
<a name="View-the-Log-files"></a>
@ -334,6 +406,8 @@ Example: if you want to set the MySQL port to 3333, just replace the default por
The Log files are stored in the `docker/logs` directory.
<br>
<a name="Enter-Container"></a>
#### Enter a Container (SSH into a running Container)
@ -363,6 +437,7 @@ To prevent a container (software) from running, open the `docker-compose.yml` fi
<br>
<a name="Edit-a-Docker-Image"></a>
#### Edit a Docker Image

View File

@ -5,7 +5,6 @@ services:
nginx:
build: ./nginx
container_name: nginx
volumes_from:
- php
volumes:
@ -19,7 +18,6 @@ services:
php:
build: ./php
container_name: php
volumes:
- ../:/var/www/laravel
- ./logs/php/:/usr/local/var/log
@ -30,7 +28,6 @@ services:
data:
build: ./data
container_name: data
volumes:
- /var/lib/mysql
- /var/lib/postgresql/data
@ -40,7 +37,6 @@ services:
mysql:
build: ./mysql
container_name: mysql
volumes_from:
- data
ports:
@ -57,7 +53,6 @@ services:
postgres:
build: ./postgres
container_name: postgres
volumes_from:
- data
ports:
@ -73,7 +68,6 @@ services:
redis:
build: ./redis
container_name: redis
volumes_from:
- data
ports: