Introduction

A full PHP development environment for Docker.

Includes pre-packaged Docker Images, all pre-configured to provide a wonderful PHP development environment.

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…

Quick Overview

Let’s see how easy it is to install NGINX, PHP, Composer, MySQL, Redis and Beanstalkd:

1 - Clone Laradock inside your PHP project:

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

2 - Enter the laradock folder and rename env-example to .env.

cp env-example .env

3 - Run your containers:

docker-compose up -d nginx mysql redis beanstalkd

4 - Open your project’s .env file and set the following:

DB_HOST=mysql
REDIS_HOST=redis
QUEUE_HOST=beanstalkd

5 - Open your browser and visit localhost: http://localhost.

That's it! enjoy :)

Features

  • Easy switch between PHP versions: 7.1, 7.0, 5.6…
  • 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.
  • 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..

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.

  • Database Engines: MySQL - MariaDB - Percona - MongoDB - Neo4j - RethinkDB - MSSQL - PostgreSQL - Postgres-PostGIS.
  • Database Management: PhpMyAdmin - Adminer - PgAdmin
  • Cache Engines: Redis - Memcached - Aerospike
  • PHP Servers: NGINX - Apache2 - Caddy
  • PHP Compilers: PHP FPM - HHVM
  • Message Queueing: Beanstalkd - RabbitMQ - PHP Worker
  • Queueing Management: Beanstalkd Console - RabbitMQ Console
  • Random Tools: HAProxy - Certbot - Blackfire - Selenium - Jenkins - ElasticSearch - Kibana - Mailhog - Minio - Varnish - Swoole - Laravel Echo…

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.

Workspace Image Tools PHP CLI - Composer - Git - Linuxbrew - Node - V8JS - Gulp - SQLite - xDebug - Envoy - Deployer - Vim - Yarn - SOAP - Drush…

You can choose, which tools to install in your workspace container and other containers, from the .env file.

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.

If you can’t find your Software in the list, build it yourself and submit it. Contributions are welcomed :)

What is Docker?

Docker 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 Docker’s methodologies for shipping, testing, and deploying code quickly, you can significantly reduce the delay between writing code and running it in production.

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

Demo Video

What’s better than a Demo Video:

  • Laradock v5.* (should be next!)
  • Laradock v4.*
  • Laradock v2.*
  • Laradock v0.3
  • Laradock v0.1

Chat with us

You are welcome to join our chat room on Gitter.

Gitter

Getting Started

Requirements

Installation

Choose the setup the best suits your needs.

A) Setup for Single Project

(Follow these steps if you want a separate Docker environment for each project)

A.1) Already have a PHP project:

1 - Clone laradock on your project root directory:

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

Note: If you are not using Git yet for your project, you can use git clone instead of git submodule.

To keep track of your Laradock changes, between your projects and also keep Laradock updated check these docs

Your folder structure should look like this:

+ project-a
  + laradock-a
+ project-b
  + laradock-b

(It’s important to rename the laradock folders to unique name in each project, if you want to run laradock per project).

Now jump to the Usage section.

A.2) Don’t have a PHP project yet:

1 - Clone this repository anywhere on your machine:

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

Your folder structure should look like this:

+ laradock
+ project-z

2 - Edit your web server sites configuration.

We’ll need to do step 1 of the Usage section now to make this happen.

cp env-example .env

At the top, change the APPLICATION variable to your project path.

APPLICATION=../project-z/

Make sure to replace project-z with your project folder name.

Now jump to the Usage section.

B) Setup for Multiple Projects:

(Follow these steps if you want a single Docker environment for all your project)

1 - Clone this repository anywhere on your machine (similar to Steps A.2. from above):

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

Your folder structure should look like this:

+ laradock
+ project-1
+ project-2

2 - Go to nginx/sites and create config files to point to different project directory when visiting different domains.

Laradock by default includes project-1.conf and project-2.conf as working samples.

3 - change the default names project-n:

You can rename the config files, project folders and domains as you like, just make sure the root in the config files, is pointing to the correct project folder name.

4 - Add the domains to the hosts files.

127.0.0.1  project-1.dev
127.0.0.1  project-2.dev

Now jump to the Usage section.

Usage

Read Before starting:

If you are using Docker Toolbox (VM), do one of the following:


We recommend using a Docker version which is newer than 1.13.


Warning: If you used an older version of Laradock it’s highly recommended to rebuild the containers you need to use see how you rebuild a container in order to prevent as much errors as possible.


1 - Enter the laradock folder and copy env-example to .env

cp env-example .env

You can edit the .env file to chose which software’s you want to be installed in your environment. You can always refer to the docker-compose.yml file to see how those variables are been used.

2 - Build the enviroment and run it using docker-compose

In this example we’ll see how to run NGINX (web server) and MySQL (database engine) to host a PHP Web Scripts:

docker-compose up -d nginx mysql

Note: The workspace and php-fpm will run automatically in most of the cases, so no need to specify them in the up command. If you couldn’t find them running then you need specify them as follow: docker-compose up -d nginx php-fpm mysql workspace.

You can select your own combination of containers form this list.

(Please note that sometimes we forget to update the docs, so check the docker-compose.yml file to see an updated list of all available containers).


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

docker-compose exec workspace bash

Alternatively, for Windows PowerShell users: execute the following command to enter any running container:

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

Note: You can add --user=laradock to have files created as your host’s user. Example:

docker-compose exec --user=laradock workspace bash

You can change the PUID (User id) and PGID (group id) variables from the .env file)


4 - Update your project configurations to use the database host

Open your PHP project’s .env file or whichever configuration file you are reading from, and set the database host DB_HOST to mysql:

DB_HOST=mysql

If you want to install Laravel as PHP project, see How to Install Laravel in a Docker Container.


5 - Open your browser and visit your localhost address http://localhost/. If you followed the multiple projects setup, you can visit http://project-1.dev/ and http://project-2.dev/.

Documentation

List current running Containers

docker ps

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

docker-compose ps


Close all running Containers

docker-compose stop

To stop single container do:

docker-compose stop {container-name}


Delete all existing Containers

docker-compose down


Enter a Container (run commands in a running Container)

1 - First list the current running containers with docker ps

2 - Enter any container using:

docker-compose exec {container-name} bash

Example: enter MySQL container

docker-compose exec mysql bash

Example: enter to MySQL prompt within MySQL container

docker-compose exec mysql mysql -u homestead -psecret

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 default 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

More info on Containers rebuilding here.


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}

You might use the --no-cache option if you want full rebuilding (docker-compose build --no-cache {container-name}).


Docker-Sync

Docker on the Mac is slow, at the time of writing. Especially for larger projects, this can be a problem. The problem is older than March 2016 - as it’s a such a long-running issue, we’re including it in the docs here.

The problem originates in bind-mount performance on MacOS. Docker for Mac uses osxfs by default. This is not without reason, it has a lot of advantages.

Solutions to resolve this issue are easily installed however, we’re hoping it’ll be fixed by Docker themselves over time. They are currently adding “cached and delegated” options, which is partly available for Docker Edge.

Options are to switch over to NFS which is the simplest. The fastest option is Docker-Sync “native” which is still quite easy to install.

Clone this repo to your machine, copy default/docker-sync.yml to your Laradock directory and run docker-sync-stack start. Be sure to use docker-sync-stack clean to stop and docker-compose build to rebuild. More information can be found in the Docker-sync docs.


Add more Software (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-compose logs {container-name}
docker-compose logs -f {container-name}

More options


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 planning 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-56, like this:

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

4 - Finally rebuild the container

docker-compose build php-fpm

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

B) Switch from PHP 7.0 or 5.6 to PHP 5.5

We do not natively support PHP 5.5 anymore, but you can get it in few steps:

1 - Clone https://github.com/laradock/php-fpm.

3 - Rename Dockerfile-56 to Dockerfile-55.

3 - Edit the file FROM php:5.6-fpm to FROM php:5.5-fpm.

4 - Build an image from Dockerfile-55.

5 - Open the docker-compose.yml file.

6 - Point php-fpm to your Dockerfile-55 file.


Change the PHP-CLI Version

By default PHP-CLI 7.0 is running.

Note: it’s not very essential to edit the PHP-CLI version. 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

3 - Open laradock/workspace/xdebug.ini and/or laradock/php-fpm/xdebug.ini and enable at least the following configurations:

xdebug.remote_autostart=1
xdebug.remote_enable=1
xdebug.remote_connect_back=1

For information on how to configure xDebug with your IDE and work it out, check this Repository.


Start/Stop xDebug:

By installing xDebug, you are enabling it to run on startup by default.

To control the behavior of xDebug (in the php-fpm Container), you can run the following commands from the Laradock root folder, (at the same prompt where you run docker-compose):

  • Stop xDebug from running by default: .php-fpm/xdebug stop.
  • Start xDebug by default: .php-fpm/xdebug start.
  • See the status: .php-fpm/xdebug status.

Note: If .php-fpm/xdebug doesn’t execute and gives Permission Denied error the problem can be that file xdebug doesn’t have execution access. This can be fixed by running chmod command with desired access permissions.


Install Deployer (Deployment tool for PHP)

1 - Open the docker-compose.yml file
2 - Search for the INSTALL_DEPLOYER argument under the Workspace Container
3 - Set it to true

It should be like this:

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

4 - Re-build the containers docker-compose build workspace

Deployer Documentation Here



Prepare Laradock for Production

It’s recommended for production to create a custom docker-compose.yml file. For that reason, Laradock is shipped with production-docker-compose.yml which should contain only the containers you are planning to run on production (usage example: docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...).

Note: The Database (MySQL/MariaDB/…) ports should not be forwarded on production, because Docker will automatically publish the port on the host, which is quite insecure, unless specifically told not to. So make sure to remove these lines:

ports:
    - "3306:3306"

To learn more about how Docker publishes ports, please read this excellent post on the subject.


Setup Laravel and Docker on Digital Ocean

Full Guide Here


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 recommend 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 with ../my-cool-app/:/var/www, as follow:

    application:
		 image: tianon/true
        volumes:
            - ../my-cool-app/:/var/www
    ...

4 - Go to that folder and start working..

cd my-cool-app

5 - Go back to the Laradock installation steps to see how to edit the .env file.


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-compose exec workspace bash

Add --user=laradock (example docker-compose exec --user=laradock workspace bash) to have files created as your host’s user.

4 - Run anything you want :)

php artisan
Composer update
phpunit


Run Laravel Queue Worker

1 - First add php-worker container. It will be similar as like PHP-FPM Container.
a) open the docker-compose.yml file
b) add a new service container by simply copy-paste this section below PHP-FPM container

    php-worker:
      build:
        context: ./php-fpm
        dockerfile: Dockerfile-70 # or Dockerfile-56, choose your PHP-FPM container setting
      volumes_from:
        - applications
      command: php artisan queue:work

2 - Start everything up

docker-compose up -d php-worker


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 redis

REDIS_HOST=redis

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

'redis' => [
    'cluster' => false,
    'default' => [
        'host'     => 'redis',
        '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 configuration 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 mongo.
  • 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.
  • Migrate the Database php artisan migrate.


Use PhpMyAdmin

1 - Run the phpMyAdmin Container (phpmyadmin) with the docker-compose up command. Example:

# use with mysql
docker-compose up -d mysql phpmyadmin

# use with mariadb
docker-compose up -d mariadb phpmyadmin

Note: To use with MariaDB, open .env and set PMA_DB_ENGINE=mysql to PMA_DB_ENGINE=mariadb.

2 - Open your browser and visit the localhost on port 8080: http://localhost:8080


Use Adminer

1 - Run the Adminer Container (adminer) with the docker-compose up command. Example:

docker-compose up -d adminer  

2 - Open your browser and visit the localhost on port 8080: http://localhost:8080

Note: We’ve locked Adminer to version 4.3.0 as at the time of writing it contained a major bug preventing PostgreSQL users from logging in. If that bug is fixed (or if you’re not using PostgreSQL) feel free to set Adminer to the latest version within the Dockerfile: FROM adminer:latest


Use PgAdmin

1 - Run the pgAdmin Container (pgadmin) with the docker-compose up command. Example:

docker-compose up -d postgres pgadmin

2 - Open your browser and visit the localhost on port 5050: http://localhost:5050


Use Beanstalkd

1 - Run the Beanstalkd Container:

docker-compose up -d beanstalkd

2 - Configure Laravel to connect to that container by editing the config/queue.php config file.

a. first set beanstalkd as default queue driver b. set the queue host to beanstalkd : QUEUE_HOST=beanstalkd

beanstalkd is now available on default port 11300.

3 - Require the dependency package pda/pheanstalk using composer.

Optionally you can use the Beanstalkd Console Container to manage your Queues from a web interface.

1 - Run the Beanstalkd Console Container:

docker-compose up -d beanstalkd-console

2 - Open your browser and visit http://localhost:2080/

3 - Add the server

  • Host: beanstalkd
  • Port: 11300

4 - Done.


Use ElasticSearch

1 - Run the ElasticSearch Container (elasticsearch) with the docker-compose up command:

docker-compose up -d elasticsearch

2 - Open your browser and visit the localhost on port 9200: http://localhost:9200

Install ElasticSearch Plugin

1 - Install the ElasticSearch plugin like delete-by-query.

docker exec {container-name} /usr/share/elasticsearch/bin/plugin install delete-by-query

2 - Restart elasticsearch container

docker restart {container-name}


Use Selenium

1 - Run the Selenium Container (selenium) with the docker-compose up command. Example:

docker-compose up -d selenium

2 - Open your browser and visit the localhost on port 4444 at the following URL: http://localhost:4444/wd/hub


Use RethinkDB

The RethinkDB is an open-source Database for Real-time Web (RethinkDB). A package (Laravel RethinkDB) is being developed and was released a version for Laravel 5.2 (experimental).

1 - Run the RethinkDB Container (rethinkdb) with the docker-compose up command.

docker-compose up -d rethinkdb

2 - Access the RethinkDB Administration Console http://localhost:8090/#tables for create a database called database.

3 - Add the RethinkDB configurations to the config/database.php configuration file:

'connections' => [

	'rethinkdb' => [
		'name'      => 'rethinkdb',
		'driver'    => 'rethinkdb',
		'host'      => env('DB_HOST', 'rethinkdb'),
		'port'      => env('DB_PORT', 28015),
		'database'  => env('DB_DATABASE', 'test'),
	]

	// ...

],

4 - Open your Laravel’s .env file and update the following variables:

  • set the DB_CONNECTION to your rethinkdb.
  • set the DB_HOST to rethinkdb.
  • set the DB_PORT to 28015.
  • set the DB_DATABASE to database.


Use Minio

1 - Configure Minio: - On the workspace container, change INSTALL_MC to true to get the client - Set MINIO_ACCESS_KEY and MINIO_ACCESS_SECRET if you wish to set proper keys

2 - Run the Minio Container (minio) with the docker-compose up command. Example:

docker-compose up -d minio

3 - Open your browser and visit the localhost on port 9000 at the following URL: http://localhost:9000

4 - Create a bucket either through the webui or using the mc client:

  mc mb minio/bucket

5 - When configuring your other clients use the following details:

  S3_HOST=http://minio
  S3_KEY=access
  S3_SECRET=secretkey
  S3_REGION=us-east-1
  S3_BUCKET=bucket



Install CodeIgniter

To install CodeIgniter 3 on Laradock all you have to do is the following simple steps:

1 - Open the docker-compose.yml file.

2 - Change CODEIGNITER=false to CODEIGNITER=true.

3 - Re-build your PHP-FPM Container docker-compose build php-fpm.


Miscellaneous


Change the timezone

To change the timezone for the workspace container, modify the TZ build argument in the Docker Compose file to one in the TZ database.

For example, if I want the timezone to be New York:

    workspace:
        build:
            context: ./workspace
            args:
                - TZ=America/New_York
    ...

We also recommend setting the timezone in Laravel.


Adding cron jobs

You can add your cron jobs to workspace/crontab/root after the php artisan line.

* * * * * php /var/www/artisan schedule:run >> /dev/null 2>&1

# Custom cron
* * * * * root echo "Every Minute" > /var/log/cron.log 2>&1

Make sure you change the timezone if you don’t want to use the default (UTC).


Access workspace via ssh

You can access the workspace container through localhost:2222 by setting the INSTALL_WORKSPACE_SSH build argument to true.

To change the default forwarded port for ssh:

    workspace:
		ports:
			- "2222:22" # Edit this line
    ...


MySQL access from host

You can forward the MySQL/MariaDB port to your host by making sure these lines are added to the mysql or mariadb section of the docker-compose.yml or in your environment specific Compose file.

ports:
    - "3306:3306"


MySQL root access

The default username and password for the root MySQL user are root and root.

1 - Enter the MySQL container: docker-compose exec mysql bash.

2 - Enter mysql: mysql -uroot -proot for non root access use mysql -uhomestead -psecret.

3 - See all users: SELECT User FROM mysql.user;

4 - Run any commands show databases, show tables, select * from......


Create Multiple Databases (MySQL)

Create createdb.sql from mysql/docker-entrypoint-initdb.d/createdb.sql.example in mysql/docker-entrypoint-initdb.d/* and add your SQL syntax as follow:

CREATE DATABASE IF NOT EXISTS `your_db_1` COLLATE 'utf8_general_ci' ;
GRANT ALL ON `your_db_1`.* TO 'mysql_user'@'%' ;


Change MySQL port

Modify the mysql/my.cnf file to set your port number, 1234 is used as an example.

[mysqld]
port=1234

If you need MySQL access from your host, do not forget to change the internal port number ("3306:3306" -> "3306:1234") in the docker-compose configuration file.


Use custom Domain (instead of the Docker IP)

Assuming your custom domain is laravel.dev

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

127.0.0.1    laravel.dev

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

Optionally you can define the server name in the NGINX configuration file, like this:

server_name laravel.dev;


Enable Global Composer Build Install

Enabling Global Composer Install during the build for the container allows you to get your composer requirements installed and available in the container after the build is done.

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 - Re-build 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 - Re-build 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


Install Node + YARN

Yarn is a new package manager for JavaScript. It is so faster than npm, which you can find here.To install NodeJS and Yarn in the Workspace container:

1 - Open the docker-compose.yml file

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

It should be like this:

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

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


Install Linuxbrew

Linuxbrew is a package manager for Linux. It is the Linux version of MacOS Homebrew and can be found here. To install Linuxbrew in the Workspace container:

1 - Open the docker-compose.yml file

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

It should be like this:

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

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



Common Terminal Aliases

When you start your docker container, Laradock will copy the aliases.sh file located in the laradock/workspace directory and add sourcing to the container ~/.bashrc file.

You are free to modify the aliases.sh as you see fit, adding your own aliases (or function macros) to suit your requirements.


Install Aerospike extension

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

It should be like this:

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

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


Install Laravel Envoy (Envoy Task Runner)

1 - Open the docker-compose.yml file
2 - Search for the INSTALL_LARAVEL_ENVOY argument under the Workspace Container
3 - Set it to true

It should be like this:

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

4 - Re-build the containers docker-compose build workspace

Laravel Envoy Documentation Here


PHPStorm Debugging Guide

Remote debug Laravel web and phpunit tests.

Debugging Guide Here


Keep track of your Laradock changes

  1. Fork the Laradock repository.
  2. Use that fork as a submodule.
  3. Commit all your changes to your fork.
  4. Pull new stuff from the main repository from time to time.


Upgrading Laradock

Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading Laradock from v3.* to v4.*:

  1. Stop the docker VM docker-machine stop {default}
  2. Install Docker for Mac or Windows.
  3. Upgrade Laradock to v4.*.* (git pull origin master)
  4. Use Laradock as you used to do: docker-compose up -d nginx mysql.

Note: If you face any problem with the last step above: rebuild all your containers docker-compose build --no-cache “Warning Containers Data might be lost!”


Improve speed on MacOS

Sharing code into Docker containers with osxfs have very poor performance compared to Linux. Likely there are some workarounds:

Workaround A: using dinghy

Dinghy creates its own VM using docker-machine, it will not modify your existing docker-machine VMs.

Quick Setup giude, (we recommend you check their docs)

1) brew tap codekitchen/dinghy

2) brew install dinghy

3) dinghy create --provider virtualbox (must have virtualbox installed, but they support other providers if you prefer)

4) after the above command is done it will display some env variables, copy them to the bash profile or zsh or.. (this will instruct docker to use the server running inside the VM)

5) docker-compose up ...

Workaround B: using d4m-nfs

D4m-nfs automatically mount NFS volume instead of osxfs one.

1) Update the Docker [File Sharing] preferences:

Click on the Docker Icon > Preferences > (remove everything form the list except /tmp).

2) Restart Docker.

3) Clone the d4m-nfs repository to your home directory.

git clone https://github.com/IFSight/d4m-nfs ~/d4m-nfs

4) Create (or edit) the file ~/d4m-nfs/etc/d4m-nfs-mounts.txt, and write the follwing configuration in it:

/Users:/Users

5) Create (or edit) the file /etc/exports, make sure it exists and is empty. (There may be collisions if you come from Vagrant or if you already executed the d4m-nfs.sh script before).

6) Run the d4m-nfs.sh script (might need Sudo):

~/d4m-nfs/d4m-nfs.sh

That’s it! Run your containers.. Example:

docker-compose up ...

Note: If you faced any errors, try restarting Docker, and make sure you have no spaces in the d4m-nfs-mounts.txt file, and your /etc/exports file is clear.

Other good workarounds:

More details about this issue here.


Common Problems

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 instead of http://localhost in your browser.


I see an error message containing address already in use or port is already allocated

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


I get NGINX error 404 Not Found on Windows.

  1. Go to docker Settings on your Windows machine.
  2. Click on the Shared Drives tab and check the drive that contains your project files.
  3. Enter your windows username and password.
  4. Go to the reset tab and click restart docker.


The time in my services does not match the current time

  1. Make sure you’ve changed the timezone.
  2. Stop and rebuild the containers (docker-compose up -d --build <services>)


I get MySQL connection refused

This error sometimes happens because your Laravel application isn’t running on the container localhost IP (Which is 127.0.0.1). Steps to fix it:

  • Option A
    1. Check your running Laravel application IP by dumping Request::ip() variable using dd(Request::ip()) anywhere on your application. The result is the IP of your Laravel container.
    2. Change the DB_HOST variable on env with the IP that you received from previous step.
  • Option B
    1. Change the DB_HOST value to the same name as the MySQL docker container. The Laradock docker-compose file currently has this as mysql

Guides

Production Setup on Digital Ocean

Install Docker

  • Visit DigitalOcean and login.
  • Click the Create Droplet button.
  • Open the One-click apps tab.
  • Select Docker with your preferred version.
  • Continue creating the droplet as you normally would.
  • If needed, check your e-mail for the droplet root password.

SSH to your Server

Find the IP address of the droplet in the DigitalOcean interface. Use it to connect to the server.

ssh root@ipaddress

You may be prompted for a password. Type the one you found within your e-mailbox. It’ll then ask you to change the password.

You can now check if Docker is available:

$root@server:~# docker

Set Up Your Laravel Project

$root@server:~# apt-get install git
$root@server:~# git clone https://github.com/laravel/laravel
$root@server:~# cd laravel
$root@server:~/laravel/ git submodule add https://github.com/Laradock/laradock.git
$root@server:~/laravel/ cd laradock

Install docker-compose command

$root@server:~/laravel/laradock# curl -L https://github.com/docker/compose/releases/download/1.8.0/run.sh > /usr/local/bin/docker-compose
$root@server:~/chmod +x /usr/local/bin/docker-compose

Enter the laradock folder and rename env-example to .env.

$root@server:~/laravel/laradock# cp env-example .env

Create Your Laradock Containers

$root@server:~/laravel/laradock# docker-compose up -d nginx mysql

Note that more containers are available, find them in the docs or the docker-compose.yml file.

Go to Your Workspace

docker-compose exec workspace bash

Install and configure Laravel

Let’s install Laravel’s dependencies, add the .env file, generate the key and give proper permissions to the cache folder.

$ root@workspace:/var/www# composer install
$ root@workspace:/var/www# cp .env.example .env
$ root@workspace:/var/www# php artisan key:generate
$ root@workspace:/var/www# exit
$root@server:~/laravel/laradock# cd ..
$root@server:~/laravel# sudo chmod -R 777 storage bootstrap/cache

You can then view your Laravel site by visiting the IP address of your server in your browser. For example:

http://192.168.1.1

It should show you the Laravel default welcome page.

However, we want it to show up using your custom domain name, as well.

Using Your Own Domain Name

Login to your DNS provider, such as Godaddy, Namecheap.

Point the Custom Domain Name Server to:

ns1.digitalocean.com
ns2.digitalocean.com
ns3.digitalocean.com

Within DigitalOcean, you’ll need to change some settings, too.

Visit: https://cloud.digitalocean.com/networking/domains

Add your domain name and choose the server IP you’d provision earlier.

Serving Site With NGINX (HTTP ONLY)

Go back to command line.

$root@server:~/laravel/laradock# cd nginx
$root@server:~/laravel/laradock/nginx# vim laravel.conf

Remove default_server

    listen 80 default_server;
    listen [::]:80 default_server ipv6only=on;

And add server_name (your custom domain)

    listen 80;
    listen [::]:80 ipv6only=on;
    server_name yourdomain.com;

Rebuild Your Nginx

$root@server:~/laravel/laradock# docker-compose down
$root@server:~/laravel/laradock# docker-compose build nginx

Re Run Your Containers MYSQL and NGINX

$root@server:~/laravel/laradock/nginx# docker-compose up -d nginx mysql

View Your Site with HTTP ONLY (http://yourdomain.com)

Run Site on SSL with Let’s Encrypt Certificate

Note: You need to Use Caddy here Instead of Nginx

To go Caddy Folders and Edit CaddyFile

$root@server:~/laravel/laradock# cd caddy
$root@server:~/laravel/laradock/caddy# vim Caddyfile

Remove 0.0.0.0:80

0.0.0.0:80
root /var/www/public

and replace with your https://yourdomain.com

https://yourdomain.com
root /var/www/public

uncomment tls

#tls self-signed

and replace self-signed with your email address

tls serverbreaker@gmai.com

This is needed Prior to Creating Let’s Encypt

Run Your Caddy Container without the -d flag and Generate SSL with Let’s Encrypt

$root@server:~/laravel/laradock/caddy# docker-compose up  caddy

You’ll be prompt here to enter your email… you may enter it or not

Attaching to laradock_mysql_1, laradock_caddy_1
caddy_1               | Activating privacy features...
caddy_1               | Your sites will be served over HTTPS automatically using Let's Encrypt.
caddy_1               | By continuing, you agree to the Let's Encrypt Subscriber Agreement at:
caddy_1               |   https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf
caddy_1               | Activating privacy features... done.
caddy_1               | https://yourdomain.com
caddy_1               | http://yourdomain.com

After it finishes, press Ctrl + C to exit.

Stop All Containers and ReRun Caddy and Other Containers on Background

$root@server:~/laravel/laradock/caddy# docker-compose down
$root@server:~/laravel/laradock/caddy# docker-compose up -d mysql caddy

View your Site in the Browser Securely Using HTTPS (https://yourdomain.com)

Note that Certificate will be Automatically Renew By Caddy

References:






PHPStorm XDebug Setup

Intro

Wiring up Laravel, Laradock [Laravel+Docker] and PHPStorm to play nice together complete with remote xdebug’ing as icing on top! Although this guide is based on PHPStorm Windows, you should be able to adjust accordingly. This guide was written based on Docker for Windows Native.

Installation

  • This guide assumes the following:
    • you have already installed and are familiar with Laravel, Laradock and PHPStorm.
    • you have installed Laravel as a parent of laradock. This guide assumes /c/_dk/laravel.

hosts

  • Add laravel to your hosts file located on Windows 10 at C:\Windows\System32\drivers\etc\hosts. It should be set to the IP of your running container. Mine is: 10.0.75.2 On Windows you can find it by opening Windows Hyper-V Manager.

    • Windows Hyper-V Manager
  • Hosts File Editor makes it easy to change your hosts file.

    • Set laravel to your docker host IP. See Example.

Firewall

Your PHPStorm will need to be able to receive a connection from PHP xdebug either your running workspace or php-fpm containers on port 9000. This means that your Windows Firewall should either enable connections from the Application PHPStorm OR the port.

  • It is important to note that if the Application PHPStorm is NOT enabled in the firewall, you will not be able to recreate a rule to override that.
  • Also be aware that if you are installing/upgrade different versions of PHPStorm, you MAY have orphaned references to PHPStorm in your Firewall! You may decide to remove orphaned references however in either case, make sure that they are set to receive public TCP traffic.

Edit laradock/docker-compose.yml

Set the following variables:

### Workspace Utilities Container ###############

    workspace:
        build:
            context: ./workspace
            args:
                - INSTALL_XDEBUG=true
                - INSTALL_WORKSPACE_SSH=true
                ...


### PHP-FPM Container #####################

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

Edit xdebug.ini files

  • laradock/workspace/xdebug.ini
  • laradock/php-fpm/xdebug.ini

Set the following variables:

xdebug.remote_autostart=1
xdebug.remote_enable=1
xdebug.remote_connect_back=1
xdebug.cli_color=1

Need to clean house first?

Make sure you are starting with a clean state. For example, do you have other Laradock containers and images? Here are a few things I use to clean things up.

  • Delete all containers using grep laradock_ on the names, see: Remove all containers based on docker image name. docker ps -a | awk '{ print $1,$2 }' | grep laradock_ | awk '{print $1}' | xargs -I {} docker rm {}

  • Delete all images containing laradock. docker images | awk '{print $1,$2,$3}' | grep laradock_ | awk '{print $3}' | xargs -I {} docker rmi {} Note: This will only delete images that were built with Laradock, NOT laradock/* which are pulled down by Laradock such as laradock/workspace, etc. Note: Some may fail with: Error response from daemon: conflict: unable to delete 3f38eaed93df (cannot be forced) - image has dependent child images

  • I added this to my .bashrc to remove orphaned images.

    dclean() {
        processes=`docker ps -q -f status=exited`
        if [ -n "$processes" ]; thend
          docker rm $processes
        fi
    
        images=`docker images -q -f dangling=true`
        if [ -n "$images" ]; then
          docker rmi $images
        fi
    }
    
  • If you frequently switch configurations for Laradock, you may find that adding the following and added to your .bashrc or equivalent useful: ```

    remove laravel* containers

    remove laravel_* images

    dcleanlaradockfunction() { echo ‘Removing ALL containers associated with laradock’ docker ps -a | awk ‘{ print $1,$2 }’ | grep laradock | awk ‘{print $1}’ | xargs -I {} docker rm {}

# remove ALL images associated with laradock_ # does NOT delete laradock/* which are hub images echo ‘Removing ALL images associated with laradock‘ docker images | awk ‘{print $1,$2,$3}’ | grep laradock | awk ‘{print $3}’ | xargs -I {} docker rmi {}

echo ‘Listing all laradock docker hub images…’ docker images | grep laradock

echo ‘dcleanlaradock completed’ }

associate the above function with an alias

so can recall/lookup by typing ‘alias’

alias dcleanlaradock=dcleanlaradockfunction


<a name="InstallLaradockDialTone"></a>
## Let's get a dial-tone with Laravel

barebones at this point

docker-compose up -d nginx mysql

run

docker-compose ps

Should see:

      Name                        Command             State                     Ports

laradock_mysql_1 docker-entrypoint.sh mysqld Up 0.0.0.0:3306->3306/tcp laradock_nginx_1 nginx Up 0.0.0.0:443->443/tcp, 0.0.0.0:80->80/tcp laradock_php-fpm_1 php-fpm Up 9000/tcp laradock_volumes_data_1 true Exit 0 laradock_volumes_source_1 true Exit 0 laradock_workspace_1 /sbin/my_init Up 0.0.0.0:2222->22/tcp


<a name="enablePhpXdebug"></a>
## Enable xDebug on php-fpm
In a host terminal sitting in the laradock folder, run: `.php-fpm/xdebug status`
You should see something like the following:

xDebug status laradock_php-fpm_1 PHP 7.0.9 (cli) (built: Aug 10 2016 19:45:48) ( NTS ) Copyright © 1997-2016 The PHP Group Zend Engine v3.0.0, Copyright © 1998-2016 Zend Technologies with Xdebug v2.4.1, Copyright © 2002-2016, by Derick Rethans `` Other commands include.php-fpm/xdebug start | stop`.

If you have enabled xdebug=true in docker-compose.yml/php-fpm, xdebug will already be running when php-fpm is started and listening for debug info on port 9000.

PHPStorm Settings

  • Here are some settings that are known to work:

    • Settings/BuildDeploymentConnection

      • Settings/BuildDeploymentConnection
    • Settings/BuildDeploymentConnectionMappings

      • Settings/BuildDeploymentConnectionMappings
    • Settings/BuildDeploymentDebugger

      • Settings/BuildDeploymentDebugger
    • Settings/EditRunConfigurationRemoteWebDebug

      • Settings/EditRunConfigurationRemoteWebDebug
    • Settings/EditRunConfigurationRemoteExampleTestDebug

      • Settings/EditRunConfigurationRemoteExampleTestDebug
    • Settings/LangsPHPDebug

      • Settings/LangsPHPDebug
    • Settings/LangsPHPInterpreters

      • Settings/LangsPHPInterpreters
    • Settings/LangsPHPPHPUnit

      • Settings/LangsPHPPHPUnit
    • Settings/LangsPHPServers

      • Settings/LangsPHPServers
    • RemoteHost To switch on this view, go to: Menu/Tools/Deployment/Browse Remote Host.

      • RemoteHost
    • RemoteWebDebug

      • DebugRemoteOn
    • EditRunConfigurationRemoteWebDebug Go to: Menu/Run/Edit Configurations.

      • EditRunConfigurationRemoteWebDebug
    • EditRunConfigurationRemoteExampleTestDebug Go to: Menu/Run/Edit Configurations.

      • EditRunConfigurationRemoteExampleTestDebug
    • WindowsFirewallAllowedApps Go to: Control Panel\All Control Panel Items\Windows Firewall\Allowed apps.

      • WindowsFirewallAllowedApps.png
    • hosts Edit: C:\Windows\System32\drivers\etc\hosts.

Usage

Run ExampleTest

  • right-click on tests/ExampleTest.php
    • Select: Run 'ExampleTest.php' or Ctrl+Shift+F10.
    • Should pass!! You just ran a remote test via SSH!

Debug ExampleTest

  • Open to edit: tests/ExampleTest.php
  • Add a BreakPoint on line 16: $this->visit('/')
  • right-click on tests/ExampleTest.php
    • Select: Debug 'ExampleTest.php'.
    • Should have stopped at the BreakPoint!! You are now debugging locally against a remote Laravel project via SSH!
    • Remote Test Debugging Success

Debug WebSite

  • In case xDebug is disabled, from the laradock folder run: .php-fpm/xdebug start.

    • To switch xdebug off, run: .php-fpm/xdebug stop
  • Start Remote Debugging

    • DebugRemoteOn
  • Open to edit: bootstrap/app.php

  • Add a BreakPoint on line 14: $app = new Illuminate\Foundation\Application(

  • Reload Laravel Site

    • Should have stopped at the BreakPoint!! You are now debugging locally against a remote Laravel project via SSH!
    • Remote Debugging Success

Let’s shell into workspace

Assuming that you are in laradock folder, type: ssh -i workspace/insecure_id_rsa -p2222 root@laravel Cha Ching!!!! - workspace/insecure_id_rsa.ppk may become corrupted. In which case: - fire up puttygen - import workspace/insecure_id_rsa - save private key to workspace/insecure_id_rsa.ppk

KiTTY

Kitty KiTTY is a fork from version 0.67 of PuTTY.

  • Here are some settings that are working for me:
    • Session
    • Terminal
    • Window
    • WindowAppearance
    • Connection
    • ConnectionData
    • ConnectionSSH
    • ConnectionSSHAuth
    • TerminalShell

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.

Related Projects

Laradock related projects:

If you want your project listed here, please open an issue.

Contributing

Have a Question

If you have questions about how to use Laradock, please direct your questions to the discussion on Gitter. If you believe your question could help others, then consider opening an Issue (it will be labeled as Question) And you can still seek help on Gitter for it.

Found an Issue

If have an issue or you found a typo in the documentation, you can help us by opnening an Issue.

Steps to do before opening an Issue:

  1. Before you submit your issue search the archive, maybe your question was already answered couple hours ago (search in the closed Issues as well).

  2. Decide if the Issue belongs to this project or to Docker itself! or even the tool you are using such as Nginx or MongoDB…

If your issue appears to be a bug, and hasn’t been reported, then open a new issue.

This Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.

Want a Feature

You can request a new feature by submitting an Issue (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request yourself.

Update the Documentation (Site)

Laradock uses Hugo as website generator tool, with the Material Docs theme. You might need to check their docs quickly.

Go the DOCUMENTATION/content and search for the markdown file you want to edit

Note: Every folder represents a section in the sidebar “Menu”. And every page and sidebar has a weight number to show it’s position in the site.

To update the sidebar or add a new section to it, you can edit this DOCUMENTATION/config.toml toml file.

The site will be auto-generated in the docs/ folder by Travis CI.

Host the documentation locally

  1. Install Hugo on your machine.
  2. Edit the DOCUMENTATION/content.
  3. Delete the /docs folder from the root.
  4. After you finish the editing, go to DOCUMENTATION/ and run the hugo command to generate the HTML docs (inside a new /docs folder).

Support new Software (Add new Container)

  • Forke the repo and clone the code.

  • Create folder as the software name (example: mysql - nginx).

  • Add your Dockerfile in the folder “you may add additional files as well”.

  • Add the software to the docker-compose.yml file.

  • Make sure you follow the same code/comments style.

  • Add the environment variables to the env-example if you have any.

  • MOST IMPORTANTLY updated the Documentation, add as much information.

  • Submit a Pull Request, to the master branch.

Edit supported Software (Edit a Container)

  • Forke the repo and clone the code.

  • Open the software (container) folder (example: mysql - nginx).

  • Edit the files.

  • Make sure to update the Documentation in case you made any changes.

  • Submit a Pull Request, to the master branch.

Edit Base Image

  • Open any dockerfile, copy the base image name (example: FROM phusion/baseimage:latest).

  • Search for the image in the Docker Hub and find the source..

Most of the image in Laradock are offical images, these projects live in other repositories and maintainer by other orgnizations.

Note: Laradock has two base images for (Workspace and php-fpm, mainly made to speed up the build time on your machine.

  • Find the dockerfiles, edit them and submit a Pull Request.

  • When updating a Laradock base image (Workspace or php-fpm), ask a project maintainer “Admin” to build a new image after your PR is merged.

Note: after the base image is updated, every dockerfile that uses that image, needs to update his base image tag to get the updated code.


Submit Pull Request Instructions

1. Before Submitting a Pull Request (PR)

Always Test everything and make sure its working:

  • Pull the latest updates (or fork of you don’t have permission)
  • Before editing anything:
    • Test building the container (docker-compose build –no-cache container-name) build with no cache first.
    • Test running the container with some other containers in real app and see of everything is working fine.
  • Now edit the container (edit section by section and test rebuilding the container after every edited section)
    • Testing building the container (docker-compose build container-name) with no errors.
    • Test it in a real App if possible.

2. Submitting a PR

Consider the following guidelines:

  • Search GitHub for an open or closed Pull Request that relates to your submission. You don’t want to duplicate efforts.

  • Make your changes in a new git branch:

     git checkout -b my-fix-branch master
    
  • Commit your changes using a descriptive commit message.

  • Push your branch to GitHub:

    git push origin my-fix-branch
    
  • In GitHub, send a pull request to laradock:master.

  • If we suggest changes then:

    • Make the required updates.
    • Commit your changes to your branch (e.g. my-fix-branch).
    • Push the changes to your GitHub repository (this will update your Pull Request).

If the PR gets too outdated we may ask you to rebase and force push to update the PR:

git rebase master -i
git push origin my-fix-branch -f

WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments on code that were previously made by you and others in your commits.

3. After your PR is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin --delete my-fix-branch
    
  • Check out the master branch:

    git checkout master -f
    
  • Delete the local branch:

    git branch -D my-fix-branch
    
  • Update your master with the latest upstream version:

    git pull --ff upstream master
    


Happy Coding :)

License

MIT License (MIT)