Compare commits

...

14 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
5d84c6481f revers the dependancies between php and the db
to prevent running all the db engines when php is running
2016-05-07 05:29:48 +03:00
26229e150d Merge pull request #35 from benmag/master
link postgres service to php service
2016-05-07 05:14:01 +03:00
2b98b0b82e update the readme, include supported containers 2016-05-07 05:10:57 +03:00
457c5d4b1b update the readme file
Support selecting your own containers in the docker compose command.
2016-05-07 05:03:07 +03:00
cd97ac0aa6 link postgres service to php service 2016-05-07 11:55:00 +10:00
22f11e03ee Merge pull request #34 from benmag/master
Add support for postgres
2016-05-07 04:34:27 +03:00
5d62ec1e67 Add support for postgres 2016-05-07 11:16:06 +10:00
3 changed files with 214 additions and 90 deletions

254
README.md
View File

@ -15,7 +15,12 @@ It's like Laravel Homestead but for Docker instead of Vagrant.
- [Intro](#Intro)
- [Default Containers](#Default-Containers)
- [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)
- [Usage](#Usage)
@ -24,12 +29,12 @@ It's like Laravel Homestead but for Docker instead of Vagrant.
- [Close all running Containers](#Close-all-running-Containers)
- [Delete all existing Containers](#Delete-all-existing-Containers)
- [Build/Re-build Containers](#Build-Re-build-Containers)
- [Use Redis in Laravel](#Use-Redis-in-Laravel)
- [Use custom Domain](Use-custom-Domain)
- [Use Redis](#Use-Redis)
- [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.
<a name="Default-Containers"></a>
## Default Containers
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).
- PHP
<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 (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>
@ -114,23 +168,36 @@ DB_HOST=xxx.xxx.xxx.xxx
[How to find my Docker IP Address?](#Find-Docker-IP-Address)
<br>
2 - Run the containers:
2 - Run the Containers, (you can select the software's (containers) that you wish to run)
<br>
*(Make sure you are in the `docker` folder before running this command)*
*Make sure you are in the `docker` folder before running the `docker-compose` command.*
> Running PHP, NGINX and MySQL:
```bash
docker-compose up -d
docker-compose up -d php nginx mysql
```
>*Only the first time you run this command, it will take up to 5 minutes (depend on your connection speed) to download the Docker Images on your local machine.*
Note: you can choose your own combination of software's (containers), another example:
> Running PHP, NGINX, Postgres and Redis:
```bash
docker-compose up -d php nginx postgres redis
```
Supported Containers: `php`, `nginx`, `mysql`, `postgres`, `redis`, `data`.
<br>
3 - Open your browser and visit your `{Docker-IP}` address (`http://xxx.xxx.xxx.xxx`).
> **Debugging**: in case you faced an error here, run this command from the Laravel root directory:
> <br>
> `sudo chmod -R 777 storage && sudo chmod -R 777 bootstrap/cache`
<br>
**Debugging**: in case you faced an error here, run this command from the Laravel root directory:
```bash
sudo chmod -R 777 storage && sudo chmod -R 777 bootstrap/cache
```
<br>
@ -157,6 +224,14 @@ docker ps
docker-compose stop
```
To stop single container do:
```bash
docker-compose stop {container-name}
```
<br>
<a name="Delete-all-existing-Containers"></a>
#### Delete all existing Containers
@ -166,23 +241,32 @@ docker-compose rm -f
*Note: Careful with this command as it will delete your Data Volume Container as well. (if you want to keep your Database data than you should stop each container by itself as follow):*
`docker stop {container-name}`
<br>
<a name="Build-Re-build-Containers"></a>
#### Build/Re-build Containers
If you do any change to any `dockerfile` make sure you run this command, for the changes to take effect:
```bash
docker-compose build
```
Optionally you can specify which container to rebuild (instead of rebuilding all the containers):
```bash
docker-compose build {container-name}
```
<br>
<a name="Use-Redis-in-Laravel"></a>
#### Use Redis in Laravel
<a name="Use-Redis"></a>
#### Use Redis
Open your Laravel's `.env` file and set the `REDIS_HOST` to your `Docker-IP` instead of the default `127.0.0.1` IP.
1 - First make sure you run the Redis Container with the `docker-compose` command.
2 - Open your Laravel's `.env` file and set the `REDIS_HOST` to your `Docker-IP` instead of the default `127.0.0.1` IP.
```env
REDIS_HOST=xxx.xxx.xxx.xxx
@ -201,26 +285,88 @@ If you don't find the `REDIS_HOST` variable in your `.env` file. Go to the datab
],
```
To enable Redis Caching and/or for Sessions Management. Also from the `.env` file set `CACHE_DRIVER` and `SESSION_DRIVER` to `redis` instead of the default `file`.
3 - To enable Redis Caching and/or for Sessions Management. Also from the `.env` file set `CACHE_DRIVER` and `SESSION_DRIVER` to `redis` instead of the default `file`.
```env
CACHE_DRIVER=redis
SESSION_DRIVER=redis
```
Finally make sure you have the `predis/predis` package `(~1.0)` installed via Composer first.
4 - Finally make sure you have the `predis/predis` package `(~1.0)` installed via Composer first.
```bash
composer require predis/predis:^1.0
```
You can manually test it with:
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"
```
<br>
<a name="Use-custom-Domain"></a>
#### Use custom Domain (instead of the Docker IP)
@ -253,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>
@ -305,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)
@ -334,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,20 +18,25 @@ services:
php:
build: ./php
container_name: php
volumes:
- ../:/var/www/laravel
- ./logs/php/:/usr/local/var/log
expose:
- "9000"
links:
- mysql
### DATA Container ##########################################
data:
build: ./data
volumes:
- /var/lib/mysql
- /var/lib/postgresql/data
- /var/lib/redis
### MySQL Container #########################################
mysql:
build: ./mysql
container_name: mysql
volumes_from:
- data
ports:
@ -42,24 +46,31 @@ services:
MYSQL_USER: homestead
MYSQL_PASSWORD: secret
MYSQL_ROOT_PASSWORD: root
links:
- php
### PostgreSQL Container ####################################
postgres:
build: ./postgres
volumes_from:
- data
ports:
- "5432:5432"
environment:
POSTGRES_DB: homestead
POSTGRES_USER: homestead
POSTGRES_PASSWORD: secret
links:
- php
### Redis Container #########################################
redis:
build: ./redis
container_name: redis
volumes_from:
- data
ports:
- "6379:6379"
### DATA Container ##########################################
data:
build: ./data
container_name: data
volumes:
- /var/lib/mysql
- /var/lib/redis
### Add more Containers below ###############################

9
postgres/Dockerfile Normal file
View File

@ -0,0 +1,9 @@
FROM postgres:latest
MAINTAINER Ben M <git@bmagg.com>
VOLUME /var/lib/postgresql/data
CMD ["postgres"]
EXPOSE 5432