LaraDock

LaraDock helps you run your Laravel App on Docker real quick.
It's like Laravel Homestead but for Docker instead of Vagrant.

With LaraDock, use Docker first and learn about it later.

## Contents

• Intro
  • Features
  • Supported Containers
  • What is Docker
  • What is Laravel
  • Why Docker not Vagrant
  • LaraDock VS Homestead
• Demo Video
• Requirements
• Installation
• Usage
• Documentation
  • Docker
    • List current running Containers
    • Close all running Containers
    • Delete all existing Containers
    • Enter a Container (SSH into a running Container)
    • Edit default container configuration
    • Edit a Docker Image
    • Build/Re-build Containers
    • Add more Software's (Docker Images)
    • View the Log files
  • Laravel:
    • Install Laravel from a Docker Container
    • Run Artisan Commands
    • Use Redis
    • Use Mongo
  • PHP
    • Install PHP Extensions
    • Change the PHP-FPM Version
    • Change the PHP-CLI Version
    • Install xDebug
  • Misc
    • Run a Docker Virtual Host
    • Find your Docker IP Address
    • Use custom Domain
    • Enable Global Composer Build Install
    • Install Prestissimo
    • Install Node + NVM
    • Debugging
• Help & Questions

Intro

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.

Usage Overview: Run NGINX, MySQL and Redis.

docker-compose up  nginx mysql redis

Features

• Easy switch between PHP versions: 7.0, 5.6, 5.5...
• Choose your favorite database engine: MySQL, Postgres, MariaDB...
• Run your own combination of software's: 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 for Laravel.
• Data container, to keep Data safe and accessible.
• 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.
• More to come every week..

Supported Containers

• PHP-FPM (7.0 - 5.6 - 5.5)
• NGINX
• HHVM
• MySQL
• PostgreSQL
• MariaDB
• MongoDB
• Neo4j
• Redis
• Memcached
• Caddy
• Beanstalkd
• Beanstalkd Console
• Workspace (contains: Composer, PHP7-CLI, Laravel Installer, Git, Node, Gulp, Bower, SQLite, Vim, Nano, cURL and much more)
• Data (Databases Data Container)
• Application (Application Code Container)

If you can't find your container, build it yourself and add it to this list. Contributions are welcomed :)

What is Docker?

Docker 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 on Linux, Mac OS and Windows.

What is Laravel?

Seriously!!!

Why Docker not Vagrant!?

Vagrant 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).

LaraDock VS Homestead

LaraDock and 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 & Docker Compose official commands). And Docker manages your Virtual Containers.

Running a virtual Container is much faster than running a full virtual Machine. Thus LaraDock is much faster than Homestead.

Requirements

Linux	Windows & MAC
Laravel	Laravel
Git	Git
Docker Engine	Docker Toolbox OR Native Docker
Docker Compose

Demo Video

What's better than a Demo Video :)

Installation

1 - Clone the LaraDock repository:

A) If you already have a Laravel project, clone this repository on your Laravel root direcotry:

git submodule add https://github.com/LaraDock/laradock.git

If you are not already using Git for your Laravel project, you can use git clone instead of git submodule.

B) If you don't have a Laravel project, and you want to install Laravel from Docker, clone this repo anywhere on your machine:

git clone https://github.com/LaraDock/laradock.git

Usage

1 - For Windows & MAC users only: If you are not using the native Docker-Engine Beta, make sure you have a running Docker Virtual Host on your machine. How to run a Docker Virtual Host? (Linux users don't need a Virtual Host, so skip this step).

2 - Run some Containers: *(Make sure you are in the `laradock` folder before running the `docker-compose` commands).*

Example: Running NGINX and MySQL:

docker-compose up -d  nginx mysql

You can select your own combination of container form this list:

nginx, hhvm ,mysql, redis, postgres, mariadb, neo4j, mongo, memcached, beanstalkd, beanstalkd-console, caddy, workspace, data, php-fpm, application.

Note: workspace, data, php-fpm and application will run automatically in most of the cases.

3 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, ...).

docker exec -it {Workspace-Container-Name} bash

Replace {Workspace-Container-Name} with your Workspace container name.
To find the containers names type docker-compose ps.

4 - Edit the Laravel configurations.

If you don't have a Laravel project installed yet, see How to Install Laravel in a Docker Container.

Open your Laravel's .env file and set the DB_HOST to your {Docker-IP}:

DB_HOST=xxx.xxx.xxx.xxx

How to find my Docker IP Address?

5 - Open your browser and visit your `{Docker-IP}` address (`http://xxx.xxx.xxx.xxx`).
**Debugging**: if you are facing any problem here check the [Debugging](#debugging) section.

If you need a special support. Contact me, more details in the Help & Questions section.

## Documentation

Note: this documentation doesn't cover the Docker Beta (Native Docker on MAC and Windows). However, the commands are very similar. We are planning to cover the Docker Beta soon.

[Docker]

List current running Containers

docker ps

You can also use the this command if you want to see only this project containers:

docker-compose ps

### Close all running Containers ```bash docker-compose stop ```

To stop single container do:

docker-compose stop {container-name}

### Delete all existing Containers ```bash docker-compose down ```

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):

### Enter a Container (SSH into a running Container)

1 - first list the current running containers with docker ps

2 - enter any container using:

docker exec -it {container-name} bash

3 - to exit a container, type exit.

### Edit default container configuration Open the `docker-compose.yml` and change anything you want.

Examples:

Change MySQL Database Name:

  environment:
    MYSQL_DATABASE: laradock

Change Redis defaut port to 1111:

  ports:
    - "1111:6379"

### Edit a Docker Image

1 - Find the dockerfile of the image you want to edit,
example for mysql it will be mysql/Dockerfile.

2 - Edit the file the way you want.

3 - Re-build the container:

docker-compose build mysql

If you find any bug or you have and suggestion that can improve the performance of any image, please consider contributing. Thanks in advance.

### Build/Re-build Containers

If you do any change to any dockerfile make sure you run this command, for the changes to take effect:

docker-compose build

Optionally you can specify which container to rebuild (instead of rebuilding all the containers):

docker-compose build {container-name}

### 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.

### View the Log files The Nginx Log file is stored in the `logs/nginx` directory.

However to view the logs of all the other containers (MySQL, PHP-FPM,...) you can run this:

docker logs {container-name}

### [Laravel]

Install Laravel from a Docker Container

1 - First you need to enter the Workspace Container.

2 - Install Laravel.

Example using Composer

composer create-project laravel/laravel my-cool-app "5.2.*"

We recommand using composer create-project instead of the Laravel installer, to install Laravel.

For more about the Laravel installation click here.

3 - Edit docker-compose.yml to Map the new application path:

By default LaraDock assumes the Laravel application is living in the parent directory of the laradock folder.

Since the new Laravel application is in the my-cool-app folder, we need to replace ../:/var/www/laravel with ../my-cool-app/:/var/www/laravel, as follow:

    application:
        build: ./application
        volumes:
            - ../my-cool-app/:/var/www/laravel

4 - Go to that folder and start working..

cd my-cool-app

### Run Artisan Commands

You can run artisan commands and many other Terminal commands from the Workspace container.

1 - Make sure you have the workspace container running.

docker-compose up -d workspace // ..and all your other containers

2 - Find the Workspace container name:

docker-compose ps

3 - Enter the Workspace container:

docker exec -it {workspace-container-name} bash

4 - Run anything you want :)

php artisan

Composer update

phpunit

### Use Redis

1 - First make sure you run the Redis Container (redis) with the docker-compose up command.

docker-compose up -d redis

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.

REDIS_HOST=xxx.xxx.xxx.xxx

If you don't find the REDIS_HOST variable in your .env file. Go to the database config file config/database.php and replace the default 127.0.0.1 IP with your Docker-IP for Redis like this:

'redis' => [
    'cluster' => false,
    'default' => [
        'host'     => 'xxx.xxx.xxx.xxx',
        'port'     => 6379,
        'database' => 0,
    ],
],

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.

CACHE_DRIVER=redis
SESSION_DRIVER=redis

4 - Finally make sure you have the predis/predis package (~1.0) installed via Composer:

composer require predis/predis:^1.0

5 - You can manually test it from Laravel with this code:

\Cache::store('redis')->put('LaraDock', 'Awesome', 10);

### Use Mongo

1 - First install mongo in the Workspace and the PHP-FPM Containers:
a) open the docker-compose.yml file
b) search for the INSTALL_MONGO argument under the Workspace Container
c) set it to true
d) search for the INSTALL_MONGO argument under the PHP-FPM Container
e) set it to true

It should be like this:

    workspace:
        build:
            context: ./workspace
            args:
                - INSTALL_MONGO=true
    ...
    php-fpm:
        build:
            context: ./php-fpm
            args:
                - INSTALL_MONGO=true
    ...

2 - Re-build the containers docker-compose build workspace php-fpm

3 - Run the MongoDB Container (mongo) with the docker-compose up command.

docker-compose up -d mongo

4 - Add the MongoDB configurations to the config/database.php config file:

'connections' => [

    'mongodb' => [
        'driver'   => 'mongodb',
        'host'     => env('DB_HOST', 'localhost'),
        'port'     => env('DB_PORT', 27017),
        'database' => env('DB_DATABASE', 'database'),
        'username' => '',
        'password' => '',
        'options'  => [
            'database' => '',
        ]
    ],

	// ...

],

5 - Open your Laravel's .env file and update the following variables:

• set the DB_HOST to your Docker-IP.
• set the DB_PORT to 27017.
• set the DB_DATABASE to database.

6 - Finally make sure you have the jenssegers/mongodb package installed via Composer and its Service Provider is added.

composer require jenssegers/mongodb

More details about this here.

7 - Test it:

• First let your Models extend from the Mongo Eloquent Model. Check the documentation.
• Enter the Workspace Container docker exec -it laradock_workspace_1 bash.
• Migrate the Database php artisan migrate.

### [PHP]

Install PHP Extensions

Before installing PHP extensions, you have to decide whether you need for the FPM or CLI because each lives on a different container, if you need it for both you have to edit both containers.

The PHP-FPM extensions should be installed in php-fpm/Dockerfile-XX. (replace XX with your default PHP version number).
The PHP-CLI extensions should be installed in workspace/Dockerfile.

### Change the (PHP-FPM) Version By default **PHP-FPM 7.0** is running.

The PHP-FPM is responsible of serving your application code, you don't have to change the PHP-CLI version if you are planing to run your application on different PHP-FPM version.

A) Switch from PHP 7.0 to PHP 5.6

1 - Open the docker-compose.yml.

2 - Search for Dockerfile-70 in the PHP container section.

3 - Change the version number, by replacing Dockerfile-70 with Dockerfile-5, like this:

php-fpm:
    build:
        context: ./php-fpm
        dockerfile: Dockerfile-70

4 - Finally rebuild the container

docker-compose build php

B) Switch from PHP 7.0 or 5.6 to PHP 5.5

1 - Follow the steps of (Switch from PHP 7.0 to PHP 5.6) except the last one "rebuilding container".

2 - Open the docker-compose.yml again and make sure you are using Dockerfile-5 like this:

php-fpm:
    build:
        context: ./php-fpm
        dockerfile: Dockerfile-5

3 - Open php-fpm/Dockerfile-5 file and on the first line replace the PHP version from (FROM php:5.6-fpm) to (FROM php:5.5-fpm).

4 - Now you can rebuild the container

docker-compose build php

For more details about the PHP base image, visit the official PHP docker images.

### Change the PHP-CLI Version By default **PHP-CLI 7.0** is running.

Note: it's not very essential to edit the PHP-CLI verion. The PHP-CLI is only used for the Artisan Commands & Composer. It doesn't serve your Application code, this is the PHP-FPM job.

The PHP-CLI is installed in the Workspace container. To change the PHP-CLI version you need to edit the workspace/Dockerfile.

Right now you have to manually edit the Dockerfile or create a new one like it's done for the PHP-FPM. (consider contributing).

### Install xDebug

1 - First install xDebug in the Workspace and the PHP-FPM Containers:
a) open the docker-compose.yml file
b) search for the INSTALL_XDEBUG argument under the Workspace Container
c) set it to true
d) search for the INSTALL_XDEBUG argument under the PHP-FPM Container
e) set it to true

It should be like this:

    workspace:
        build:
            context: ./workspace
            args:
                - INSTALL_XDEBUG=true
    ...
    php-fpm:
        build:
            context: ./php-fpm
            args:
                - INSTALL_XDEBUG=true
    ...

2 - Re-build the containers docker-compose build workspace php-fpm

### [Misc]

Run a Docker Virtual Host

These steps are only for Windows & MAC users (Linux users don't need a virtual host):

1 - Run the default Host:

docker-machine start default

• If the host "default" does not exist, create one using the command below, else skip it:

• docker-machine create -d virtualbox default
  

2 - Run this command to configure your shell:

eval $(docker-machine env)

### Find your Docker IP Address

On Windows & MAC:

Run this command in your terminal:

docker-machine ip default

If your Host name is different then default, you have to specify it (docker-machine ip my-host).

(The default IP is 192.168.99.100)

boot2docker users: run boot2docker ip (when boot2docker is up).

**On Linux:**

Run this command in your terminal:

ifconfig docker0 | grep 'inet' | cut -d: -f2 | awk '{ print $1}' | head -n1

(The default IP is 172.17.0.1)

### Use custom Domain (instead of the Docker IP)

Assuming your custom domain is laravel.dev and your current Docker-IP is xxx.xxx.xxx.xxx.

1 - Open your /etc/hosts file and map your Docker IP to the laravel.dev domain, by adding the following:

xxx.xxx.xxx.xxx    laravel.dev

2 - Open your Laravel's .env file and replace the 127.0.0.1 default values with your {Docker-IP}.
Example:

DB_HOST=xxx.xxx.xxx.xxx

3 - Open your browser and visit {http://laravel.dev}

Optionally you can define the server name in the nginx config file, like this:

server_name laravel.dev;

### Enable Global Composer Build Install

To enable Running Global Composer Install during the Build:

1 - open the docker-compose.yml file

2 - search for the COMPOSER_GLOBAL_INSTALL argument under the Workspace Container and set it to true

It should be like this:

    workspace:
        build:
            context: ./workspace
            args:
                - COMPOSER_GLOBAL_INSTALL=true
    ...

3 - now add your dependencies to workspace/composer.json

4 - rebuild the Workspace Container docker-compose build workspace

### Install Prestissimo

Prestissimo is a plugin for composer which enables parallel install functionality.

1 - Enable Running Global Composer Install during the Build:

Click on this Enable Global Composer Build Install and do steps 1 and 2 only then continue here.

2 - Add prestissimo as requirement in Composer:

a - now open the workspace/composer.json file

b - add "hirak/prestissimo": "^0.3" as requirement

c - rebuild the Workspace Container docker-compose build workspace

Install Node + NVM

To install NVM and NodeJS in the Workspace container

1 - Open the docker-compose.yml file

2 - Search for the INSTALL_NODE argument under the Workspace Container and set it to true

It should be like this:

    workspace:
        build:
            context: ./workspace
            args:
                - INSTALL_NODE=true
    ...

3 - Re-build the container docker-compose build workspace

### Debugging

Here's a list of the common problems you might face, and the possible solutions.

I see a blank (white) page instead of the Laravel 'Welcome' page!

Run the following command from the Laravel root directory:

sudo chmod -R 777 storage bootstrap/cache

I see "Welcome to nginx" instead of the Laravel App!

Use http://127.0.0.1 (or your Docker IP) instead of http://localhost in your browser.

I see an error message containing address already in use

Make sure the ports for the services that you are trying to run (80, 3306, etc.) are not being used already by other programs, such as a built in apache/httpd service or other development tools you have installed.

## Contributing

This little project was built by one man who has a full time job and many responsibilities, so if you like this project and you find that it needs a bug fix or support for new software or upgrade any container, or anything else.. Do not hesitate to contribute, you are more than welcome :)

Help & Questions

Join the chat room on Gitter and get help and support from the community.

You can as well can open an issue on Github (will be labeled as Question) and discuss it with people on Gitter.

For special help with Docker and/or Laravel, you can schedule a live call with the creator of this project at Codementor.io.

Credits

Creator:

• Mahmoud Zalt (Twitter @Mahmoud_Zalt)

Main Contributors:

• Eric Pfeiffer (computerfr33k)
• Orette
• Jack Fletcher (Kauhat)
• Bo-Yi Wu (appleboy)
• Amin Mkh (AminMkh)
• Matthew Tonkin Dunn (mattythebatty)
• Zhivitsa Kirill (zhikiri)
• Benmag

Awesome People:

• Contributors
• Supporters

License

MIT License (MIT)