|
|
|
@ -1,6 +1,6 @@
|
|
|
|
|
# LaraDock
|
|
|
|
|
|
|
|
|
|
[](http://www.zalt.me)
|
|
|
|
|
[](http://zalt.me)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
LaraDock helps you run your **Laravel** App on **Docker** real quick.
|
|
|
|
@ -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,86 @@ 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
|
|
|
|
|
- Redis
|
|
|
|
|
- MySQL
|
|
|
|
|
- PostgreSQL
|
|
|
|
|
- Redis
|
|
|
|
|
- MariaDB
|
|
|
|
|
- Beanstalkd
|
|
|
|
|
- Beanstalkd Console
|
|
|
|
|
- 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
|
|
|
|
@ -88,7 +142,7 @@ Instead of providing a full Virtual Machines, like you get with Vagrant, Docker
|
|
|
|
|
git clone https://github.com/LaraDock/laradock.git docker
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Instead of `git clone` you can use `git submodule add` in case you are already using Git for your Laravel project *(Recommended)*:
|
|
|
|
|
You can use `git submodule add` instead of `git clone` if you are already using Git for your Laravel project *(Recommended)*:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
git submodule add https://github.com/LaraDock/laradock.git docker
|
|
|
|
@ -97,12 +151,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>
|
|
|
|
@ -121,7 +178,7 @@ DB_HOST=xxx.xxx.xxx.xxx
|
|
|
|
|
> Running PHP, NGINX and MySQL:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
docker-compose up -d php nginx mysql
|
|
|
|
|
docker-compose up -d php nginx mysql redis
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Note: you can choose your own combination of software's (containers), another example:
|
|
|
|
@ -129,10 +186,10 @@ Note: you can choose your own combination of software's (containers), another ex
|
|
|
|
|
> Running PHP, NGINX, Postgres and Redis:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
docker-compose up -d php nginx postgres redis
|
|
|
|
|
docker-compose up -d php nginx beanstalkd postgres
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Supported Containers: `php`, `nginx`, `mysql`, `postgres`, `redis`, `data`.
|
|
|
|
|
Supported Containers: `nginx`, `mysql`, `redis`, `postgres`, `mariadb`, `beanstalkd`, `beanstalkd-console`, `data`, `php`.
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
3 - Open your browser and visit your `{Docker-IP}` address (`http://xxx.xxx.xxx.xxx`).
|
|
|
|
@ -172,10 +229,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 +256,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 +304,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 +402,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,26 +409,20 @@ 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)
|
|
|
|
|
|
|
|
|
|
1 - first list the current running containers with `docker ps`
|
|
|
|
|
|
|
|
|
|
2 - enter any container with:
|
|
|
|
|
|
|
|
|
|
Example: enter the `php` container
|
|
|
|
|
2 - enter any container using:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
docker exec -it php bash
|
|
|
|
|
docker exec -it {container-name-or-id} bash
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Example: enter the `nginx` container
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
docker exec -it nginx bash
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
3 - to exit a container, type `exit`.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
@ -363,6 +432,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
|
|
|
|
|