laradock logo

1. Introduction

Laradock is a full PHP development environment based on Docker.

Supporting a variety of common services, all pre-configured to provide a full PHP development environment.


  • Easy switch between PHP versions: 7.4, 7.3, 7.2, 7.1, 5.6…
  • Choose your favorite database engine: MySQL, Postgres, MariaDB…
  • Run your own stack: Memcached, HHVM, RabbitMQ…
  • Each software runs on its own 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.

Use Docker First - Then Learn About It Later


Support Laradock with your organization.
Your logo will show up on the github repository index page and the documentation main page.
For more info contact [email protected].

Quick Overview

Let’s see how easy it is to setup our demo stack PHP, NGINX, MySQL, Redis and Composer:

1 - Clone Laradock inside your PHP project:

git clone

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 phpmyadmin redis workspace 

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


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

That's it! enjoy :)

Supported Software (Docker Images)

Laradock, adheres to the ‘separation of concerns’ principle, thus it runs each software on its own Docker Container. You can turn On/Off as many instances as you want without worrying about the configurations.

To run a chosen container from the list below, run docker-compose up -d {container-name}. The container name {container-name} is the same as its folder name. Example to run the “PHP FPM” container use the name “php-fpm”.

  • Web Servers:

    • NGINX
    • Apache2
    • Caddy
  • Load Balancers:

    • HAProxy
    • Traefik
  • PHP Compilers:

    • PHP FPM
    • HHVM
  • Database Management Systems:

    • MySQL
    • PostgreSQL
      • PostGIS
    • MariaDB
    • Percona
    • MSSQL
    • MongoDB
      • MongoDB Web UI
    • Neo4j
    • CouchDB
    • RethinkDB
    • Cassandra
  • Database Management Apps:

    • PhpMyAdmin
    • Adminer
    • PgAdmin
  • Cache Engines:

    • Redis
      • Redis Web UI
      • Redis Cluster
    • Memcached
    • Aerospike
    • Varnish
  • Message Brokers:

    • RabbitMQ
      • RabbitMQ Admin Console
    • Beanstalkd
      • Beanstalkd Admin Console
    • Eclipse Mosquitto
    • PHP Worker
    • Laravel Horizon
    • Gearman
  • Mail Servers:

    • Mailu
    • Mailhog
    • MailDev
  • Log Management:

    • GrayLog
  • Testing:

    • Selenium
  • Monitoring:

    • Grafana
    • NetData
  • Search Engines:

    • ElasticSearch
    • Apache Solr
    • Manticore Search
  • IDE’s

    • ICE Coder
    • Theia
    • Web IDE
  • Miscellaneous:

    • Workspace (Laradock container that includes a rich set of pre-configured useful tools)
      • PHP CLI
      • Composer
      • Git
      • Vim
      • xDebug
      • Linuxbrew
      • Node
      • V8JS
      • Gulp
      • SQLite
      • Laravel Envoy
      • Deployer
      • Yarn
      • SOAP
      • Drush
      • Wordpress CLI
    • Apache ZooKeeper (Centralized service for distributed systems to a hierarchical key-value store)
    • Kibana (Visualize your Elasticsearch data and navigate the Elastic Stack)
    • LogStash (Server-side data processing pipeline that ingests data from a multitude of sources simultaneously)
    • Jenkins (automation server, that provides plugins to support building, deploying and automating any project)
    • Certbot (Automatically enable HTTPS on your website)
    • Swoole (Production-Grade Async programming Framework for PHP)
    • SonarQube (continuous inspection of code quality to perform automatic reviews with static analysis of code to detect bugs and more)
    • Gitlab (A single application for the entire software development lifecycle)
    • PostGIS (Database extender for PostgreSQL. It adds support for geographic objects allowing location queries to be run in SQL)
    • Blackfire (Empowers all PHP developers and IT/Ops to continuously verify and improve their app’s performance)
    • Laravel Echo (Bring the power of WebSockets to your Laravel applications)
    • Phalcon (A PHP web framework based on the model–view–controller pattern)
    • Minio (Cloud storage server released under Apache License v2, compatible with Amazon S3)
    • AWS EB CLI (CLI that helps you deploy and manage your AWS Elastic Beanstalk applications and environments)
    • Thumbor (Photo thumbnail service)
    • IPython (Provides a rich architecture for interactive computing)
    • Jupyter Hub (Jupyter notebook for multiple users)
    • Portainer (Build and manage your Docker environments with ease)
    • Docker Registry (The Docker Registry implementation for storing and distributing Docker images)
    • Docker Web UI (A browser-based solution for browsing and modifying a private Docker registry)

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

Chat with us

You are welcome to join our chat room on Gitter.


Laradock exists thanks to all the people who contribute.

Project Maintainers

Mahmoud Zalt

Bo-Yi Wu

Philippe Trépanier

Mike Erickson

Dwi Fahni Denni

Thor Erik

Winfried van Loon

TJ Miller

Yu-Lung Shao (Allen)

Milan Urukalo

Vince Chu

Huadong Zuo

Lan Phan


< Join Us >

Code Contributors

Financial Contributors

Contribute and help us sustain the project.

Option 1: Donate directly to Paypal.


Option 2: Support us via BeerPay.


Option 3: Become a backer on Open Collective.

2. Getting Started

2.1 Requirements

2.2 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

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

2 - Make sure 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).

3 - Go to the Usage section.

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

1 - Clone this repository anywhere on your machine:

git clone

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 APP_CODE_PATH_HOST variable to your project path.


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

3 - Go to the Usage section.

B) Setup for Multiple Projects:

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

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

git clone

Your folder structure should look like this:

+ laradock
+ project-1
+ project-2

2 - Go to your web server and create config files to point to different project directory when visiting different domains:

For Nginx go to nginx/sites, for Apache2 apache2/sites.

Laradock by default includes some sample files for you to copy app.conf.example, laravel.conf.example and symfony.conf.example.

3 - change the default names *.conf:

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.  project-1.test  project-2.test

If you use Chrome 63 or above for development, don’t use .dev. Why?. Instead use .localhost, .invalid, .test, or .example.

4 - Go to the Usage section.

2.3 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 choose 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 being used.

Depending on the host’s operating system you may need to change the value given to COMPOSE_FILE. When you are running Laradock on Mac OS the correct file separator to use is :. When running Laradock from a Windows environment multiple files must be separated with ;.

By default the containers that will be created have the current directory name as suffix (e.g. laradock_workspace_1). This can cause mixture of data inside the container volumes if you use laradock in multiple projects. In this case, either read the guide for multiple projects or change the variable COMPOSE_PROJECT_NAME to something unique like your project name.

2 - Build the environment 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: All the web server containers nginx, apache ..etc depends on php-fpm, which means if you run any of them, they will automatically launch the php-fpm container for you, so no need to explicitly specify it in the up command. If you have to do so, you may need to run them as follows: docker-compose up -d nginx php-fpm mysql.

You can select your own combination of containers from 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 configuration 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:


You need to use the Laradock’s default DB credentials which can be found in the .env file (ex: MYSQL_USER=). Or you can change them and rebuild the container.

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.

If you followed the multiple projects setup, you can visit http://project-1.test/ and http://project-2.test/.


Make sure you add use the right port number as provided by your running server. Ex: NGINX uses port 8080 by default while Apache2 uses 80.

3. 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 -udefault -psecret

3 - To exit a container, type exit.

Edit default container configuration

Open the docker-compose.yml and change anything you want.


Change MySQL Database Name:

        MYSQL_DATABASE: laradock

Change Redis default port to 1111:

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

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 first whether you need FPM or CLI, because each of them has it’s own 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 the latest stable PHP versin is configured to run.

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.2 to PHP 5.6

1 - Open the .env.

2 - Search for PHP_VERSION.

3 - Set the desired version number:


4 - Finally rebuild the image

docker-compose build php-fpm

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

Change the PHP-CLI Version

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 simply change the PHP_VERSION in te .env file as follow:

1 - Open the .env.

2 - Search for PHP_VERSION.

3 - Set the desired version number:


4 - Finally rebuild the image

docker-compose build workspace

Install xDebug

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

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

For information on how to configure xDebug with your IDE and work it out, check this Repository or follow up on the next section if you use linux and PhpStorm.

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 phpdbg

Install phpdbg in the Workspace and the PHP-FPM Containers:

1 - Open the .env.


3 - Set value to true

4 - Do the same for PHP_FPM_INSTALL_PHPDBG


Install ionCube Loader

1 - First install ionCube Loader in the Workspace and the PHP-FPM Containers:
a) open the .env file
b) search for the WORKSPACE_INSTALL_IONCUBE argument under the Workspace Container
c) set it to true
d) search for the PHP_FPM_INSTALL_IONCUBE argument under the PHP-FPM Container
e) set it to true

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

Always download the latest version of Loaders for ionCube .

Install Deployer (Deployment tool for PHP)

1 - Open the .env file
2 - Search for the WORKSPACE_INSTALL_DEPLOYER argument under the Workspace Container
3 - Set it to true

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

Deployer Documentation Here

Install SonarQube (automatic code review tool)

SonarQube® is an automatic code review tool to detect bugs, vulnerabilities and code smells in your code. It can integrate with your existing workflow to enable continuous code inspection across your project branches and pull requests.
1 - Open the .env file
2 - Search for the argument
3 - Set it to your-domain
4 - docker-compose up -d sonarqube
5 - Open your browser: http://localhost:9000/


if you encounter a database error:

docker-compose exec --user=root postgres
source docker-entrypoint-initdb.d/

If you encounter logs error:

docker-compose run --user=root --rm sonarqube chown sonarqube:sonarqube /opt/sonarqube/logs

SonarQube Documentation Here

Prepare Laradock for Production

It’s recommended for production to create a custom docker-compose.yml file, for example production-docker-compose.yml

In your new production docker-compose.yml file you should contain only the containers you are planning to run in 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:

    - "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 .env 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:


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

Note: Should add --user=laradock (example docker-compose exec --user=laradock workspace bash) to have files created as your host’s user to prevent issue owner of log file will be changed to root then laravel website cannot write on log file if using rotated log and new log file not existed

4 - Run anything you want :)

php artisan
composer update

Run Laravel Queue Worker

1 - Create supervisor configuration file (for ex., named laravel-worker.conf) for Laravel Queue Worker in php-worker/supervisord.d/ by simply copy from laravel-worker.conf.example

2 - Start everything up

docker-compose up -d php-worker

Run Laravel Scheduler

Laradock provides 2 ways to run Laravel Scheduler 1 - Using cron in workspace container. Most of the time, when you start Laradock, it’ll automatically start workspace container with cron inside, along with setting to run schedule:run command every minute.

2 - Using Supervisord in php-worker to run schedule:run. This way is suggested when you don’t want to start workspace in production environment.
a) Comment out cron setting in workspace container, file workspace/crontab/laradock

# * * * * * laradock /usr/bin/php /var/www/artisan schedule:run >> /dev/null 2>&1

b) Create supervisor configuration file (for ex., named laravel-scheduler.conf) for Laravel Scheduler in php-worker/supervisord.d/ by simply copy from laravel-scheduler.conf.example
c) Start php-worker container

docker-compose up -d php-worker

Use Mailu

1 - You need register a domain.

2 - Required RECAPTCHA for signup email HERE

2 - modify following environment variable in .env file


2 - Open your browser and visit http://YOUR_DOMAIN.

Use NetData

1 - Run the NetData Container (netdata) with the docker-compose up command. Example:

docker-compose up -d netdata

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

Use Metabase

1 - Run the Metabase Container (metbase) with the docker-compose up command. Example:

docker-compose up -d metabase

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

3 - You can use environment to configure Metabase container. See docs in: Running Metabase on Docker

Use Jenkins

1) Boot the container docker-compose up -d jenkins. To enter the container type docker-compose exec jenkins bash.

2) Go to http://localhost:8090/ (if you didn’t change your default port mapping)

3) Authenticate from the web app.

  • Default username is admin.
  • Default password is docker-compose exec jenkins cat /var/jenkins_home/secrets/initialAdminPassword.

(To enter container as root type docker-compose exec --user root jenkins bash).

4) Install some plugins.

5) Create your first Admin user, or continue as Admin.

Note: to add user go to http://localhost:8090/securityRealm/addUser and to restart it from the web app visit http://localhost:8090/restart.

You may wanna change the default security configuration, so go to http://localhost:8090/configureSecurity/ under Authorization and choosing “Anyone can do anything” or “Project-based Matrix Authorization Strategy” or anything else.

Use Redis

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

docker-compose up -d redis

To execute redis commands, enter the redis container first docker-compose exec redis bash then enter the redis-cli.

2 - Open your Laravel’s .env file and set the REDIS_HOST to redis


If you’re using Laravel, and 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 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.


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 Redis Cluster

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

docker-compose up -d redis-cluster

2 - Open your Laravel’s config/database.php and set the redis cluster configuration. Below is example configuration with phpredis.

Read the Laravel official documentation for more details.

'redis' => [
    'client' => 'phpredis',
    'options' => [
        'cluster' => 'redis',
    'clusters' => [
        'default' => [
                'host' => 'redis-cluster',
                'password' => null,
                'port' => 7000,
                'database' => 0,

Use Mongo

1 - First install mongo in the Workspace and the PHP-FPM Containers:
a) open the .env file
b) search for the WORKSPACE_INSTALL_MONGO argument under the Workspace Container
c) set it to true
d) search for the PHP_FPM_INSTALL_MONGO argument under the PHP-FPM Container
e) set it to 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 Gitlab

1 - Run the Gitlab Container (gitlab) with the docker-compose up command. Example:

docker-compose up -d gitlab

2 - Open your browser and visit the localhost on port 8989: http://localhost:8989
Note: You may change GITLAB_DOMAIN_NAME to your own domain name like default is http://localhost

Use Gitlab Runner

1 - Retrieve the registration token in your gitlab project (Settings > CI / CD > Runners > Set up a specific Runner manually)

2 - Open the .env file and set the following changes:

# so that gitlab container will pass the correct domain to gitlab-runner container


# so that gitlab-runner container will send POST request for registration to correct domain

3 - Open the docker-compose.yml file and add the following changes:

      environment: # these values will be used during `gitlab-runner register`
        - RUNNER_EXECUTOR=docker # change from shell (default)
        - DOCKER_IMAGE=alpine
        - DOCKER_NETWORK_MODE=laradock_backend
        - backend # connect to network where gitlab service is connected

4 - Run the Gitlab-Runner Container (gitlab-runner) with the docker-compose up command. Example:

docker-compose up -d gitlab-runner

5 - Register the gitlab-runner to the gitlab container

docker-compose exec gitlab-runner bash
gitlab-runner register

6 - Create a .gitlab-ci.yml file for your pipeline

  - echo Hello!

    - echo job1

7 - Push changes to gitlab

8 - Verify that pipeline is run successful

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 Portainer

1 - Run the Portainer Container (portainer) with the docker-compose up command. Example:

docker-compose up -d portainer

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

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

3 - At login page use default credentials:

Username : [email protected]

Password : admin

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/

Note: You can customize the port on which beanstalkd console is listening by changing BEANSTALKD_CONSOLE_HOST_PORT in .env. The default value is 2080.

3 - Add the server

  • Host: beanstalkd
  • Port: 11300

4 - Done.

Use Confluence

1 - Run the Confluence Container (confluence) with the docker-compose up command. Example:

docker-compose up -d confluence

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

Note: Confluence is a licensed application - an evaluation licence can be obtained from Atlassian.

You can set custom confluence version in CONFLUENCE_VERSION. Find more info in section ‘Versioning’

Confluence usage with Nginx and SSL.
  1. Find an instance configuration file in nginx/sites/confluence.conf.example and replace sample domain with yours.

  2. Configure ssl keys to your domain.

Keep in mind that Confluence is still accessible on 8090 anyway.

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

The default username is elastic and the default password is changeme.

Install ElasticSearch Plugin

1 - Install an ElasticSearch plugin.

docker-compose exec elasticsearch /usr/share/elasticsearch/bin/plugin install {plugin-name}

2 - Restart elasticsearch container

docker-compose restart elasticsearch

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.

Additional Notes

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:


Use Thumbor

Thumbor is a smart imaging service. It enables on-demand crop, resizing and flipping of images. (Thumbor)

1 - Configure Thumbor: - Checkout all the options under the thumbor settings

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

docker-compose up -d thumbor

3 - Navigate to an example image on http://localhost:8000/unsafe/300x300/

For more documentation on Thumbor visit the Thumbor documenation page


1 - Configure AWS: - make sure to add your SSH keys in aws/ssh_keys folder

2 - Run the Aws Container (aws) with the docker-compose up command. Example:

docker-compose up -d aws

3 - Access the aws container with docker-compose exec aws bash

4 - To start using eb cli inside the container, initialize your project first by doing ‘eb init’. Read the aws eb cli docs for more details.

Use Grafana

1 - Configure Grafana: Change Port using GRAFANA_PORT if you wish to. Default is port 3000.

2 - Run the Grafana Container (grafana) with the docker-compose upcommand:

docker-compose up -d grafana

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

4 - Login using the credentials User = admin, Password = admin. Change the password in the web interface if you want to.

Use Graylog

1 - Boot the container docker-compose up -d graylog

2 - Open your Laravel’s .env file and set the GRAYLOG_PASSWORD to some passsword, and GRAYLOG_SHA256_PASSWORD to the sha256 representation of your password (GRAYLOG_SHA256_PASSWORD is what matters, GRAYLOG_PASSWORD is just a reminder of your password).

Your password must be at least 16 characters long You can generate sha256 of some password with the following command echo -n somesupersecretpassword | sha256sum


3 - Go to http://localhost:9000/ (if your port is not changed)

4 - Authenticate from the app.

Username: admin Password: somesupersecretpassword (if you haven’t changed the password)

5 - Go to the system->inputs and launch new input

Use Traefik

To use Traefik you need to do some changes in traefik/trafik.toml and docker-compose.yml.

1 - Open traefik.toml and change the e-mail property in acme section.

2 - Change your domain in For example: main = ""

2.1 - If you have subdomains, you must add them to sans property in section.

  main = ""
  sans = ["", ""]

3 - If you need to add basic authentication (, you just need to add the following text after [entryPoints.https.tls]:

  users = ["user:password"]

4 - You need to change the docker-compose.yml file to match the Traefik needs. If you want to use Traefik, you must not expose the ports of each container to the internet, but specify some labels.

4.1 For example, let’s try with NGINX. You must have:

    context: ./nginx
    - ${NGINX_HOST_LOG_PATH}:/var/log/nginx
    - ${NGINX_SITES_PATH}:/etc/nginx/sites-available
    - php-fpm
    - frontend
    - backend
    - traefik.backend=nginx
    - traefik.port=80

instead of

    context: ./nginx
    - ${NGINX_HOST_LOG_PATH}:/var/log/nginx
    - ${NGINX_SITES_PATH}:/etc/nginx/sites-available
    - ${NGINX_SSL_PATH}:/etc/nginx/ssl
    - "${NGINX_HOST_HTTP_PORT}:80"
    - "${NGINX_HOST_HTTPS_PORT}:443"
    - php-fpm
    - frontend
    - backend

Use Mosquitto (MQTT Broker)

1 - Configure Mosquitto: Change Port using MOSQUITTO_PORT if you wish to. Default is port 9001.

2 - Run the Mosquitto Container (mosquitto) with the docker-compose upcommand:

docker-compose up -d mosquitto

3 - Open your command line and use a MQTT Client (Eg. to subscribe a topic and publish a message.

4 - Subscribe: mqtt sub -t 'test' -h localhost -p 9001 -C 'ws' -v

5 - Publish: mqtt pub -t 'test' -h localhost -p 9001 -C 'ws' -m 'Hello!'

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.

Install Powerline

1 - Open the .env file and set WORKSPACE_INSTALL_POWERLINE and WORKSPACE_INSTALL_PYTHON to true.

2 - Run docker-compose build workspace, after the step above.

Powerline is required python

Install Symfony

1 - Open the .env file and set WORKSPACE_INSTALL_SYMFONY to true.

2 - Run docker-compose build workspace, after the step above.

3 - The NGINX sites include a default config file for your Symfony project symfony.conf.example, so edit it and make sure the root is pointing to your project web directory.

4 - Run docker-compose restart if the container was already running, before the step above.

5 - Visit symfony.test


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:

            context: ./workspace
                - TZ=America/New_York

We also recommend setting the timezone in Laravel.

Add locales to PHP-FPM

To add locales to the container:

1 - Open the .env file and set PHP_FPM_INSTALL_ADDITIONAL_LOCALES to true.

2 - Add locale codes to PHP_FPM_ADDITIONAL_LOCALES.

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

4 - Check enabled locales with docker-compose exec php-fpm locale -a

Adding cron jobs

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

* * * * * laradock /usr/bin/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).

If you are on Windows, verify that the line endings for this file are LF only, otherwise the cron jobs will silently fail.

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:

			- "2222:22" # Edit this line

Then login using:

ssh -o PasswordAuthentication=no    \
    -o StrictHostKeyChecking=no     \
    -o UserKnownHostsFile=/dev/null \
    -p 2222                         \
    -i workspace/insecure_id_rsa    \
    [email protected]

To login as root, replace [email protected] with [email protected]

Change the (MySQL) Version

By default MySQL 8.0 is running.

MySQL 8.0 is a development release. You may prefer to use the latest stable version, or an even older release. If you wish, you can change the MySQL image that is used.

Open up your .env file and set the MYSQL_VERSION variable to the version you would like to install.


Available versions are: 5.5, 5.6, 5.7, 8.0, or latest. See for more information.

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


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

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

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

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

server_name laravel.test;

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 .env file

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

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

4 - Re-build the Workspace Container docker-compose build workspace

Add authentication credential for Magento 2

1 - Open the .env file

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

3 - Now add your credentials to workspace/auth.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 .env file

2 - Search for the WORKSPACE_INSTALL_NODE argument under the Workspace Container and set it to 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 .env file

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

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

Install NPM GULP toolkit

To install NPM GULP toolkit in the Workspace container

1 - Open the .env file

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

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

Install NPM BOWER package manager

To install NPM BOWER package manager in the Workspace container

1 - Open the .env file

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

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


To install NPM VUE CLI in the Workspace container

1 - Open the .env file

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

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


To install NPM ANGULAR CLI in the Workspace container

1 - Open the .env file

2 - Search for the WORKSPACE_INSTALL_NPM_ANGULAR_CLI argument under the Workspace Container and set it to 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 .env file

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

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

Install FFMPEG

To install FFMPEG in the Workspace container

1 - Open the .env file

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

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

4 - If you use the php-worker container too, please follow the same steps above especially if you have conversions that have been queued.

PS Don’t forget to install the binary in the php-fpm container too by applying the same steps above to its container, otherwise the you’ll get an error when running the php-ffmpeg binary.

Install GNU Parallel

GNU Parallel is a command line tool to run multiple processes in parallel.


To install GNU Parallel in the Workspace container

1 - Open the .env file

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

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

Install Supervisor

Supervisor is a client/server system that allows its users to monitor and control a number of processes on UNIX-like operating systems.


To install Supervisor in the Workspace container

1 - Open the .env file


3 - Re-build the container docker-compose build workspace Or docker-composer up --build -d workspace

Common Terminal Aliases

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

You are free to modify the 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 .env file
b) search for the WORKSPACE_INSTALL_AEROSPIKE argument under the Workspace Container
c) set it to true
d) search for the PHP_FPM_INSTALL_AEROSPIKE argument under the PHP-FPM Container
e) set it to true

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

Install Laravel Envoy (Envoy Task Runner)

1 - Open the .env file
2 - Search for the WORKSPACE_INSTALL_LARAVEL_ENVOY argument under the Workspace Container
3 - Set it to true

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

Laravel Envoy Documentation Here

Install php calendar extension

1 - Open the .env file
2 - Search for the PHP_FPM_INSTALL_CALENDAR argument under the PHP-FPM container
3 - Set it to true
4 - Re-build the containers docker-compose build php-fpm

Install libfaketime in the php-fpm container

Libfaketime allows you to control the date and time that is returned from the operating system. It can be used by specifying a special string in the PHP_FPM_FAKETIME variable in the .env file. For example: PHP_FPM_FAKETIME=-1d will set the clock back 1 day. See ( for more information.

1 - Open the .env file
2 - Search for the PHP_FPM_INSTALL_FAKETIME argument under the PHP-FPM container
3 - Set it to true
4 - Search for the PHP_FPM_FAKETIME argument under the PHP-FPM container
5 - Set it to the desired string
6 - Re-build the containers docker-compose build php-fpm

Install YAML PHP extension in the php-fpm container

YAML PHP extension allows you to easily parse and create YAML structured data. I like YAML because it’s well readable for humans. See and for more info.

1 - Open the .env file
2 - Search for the PHP_FPM_INSTALL_YAML argument under the PHP-FPM container
3 - Set it to true
4 - Re-build the container docker-compose build php-fpm

Install AST PHP extension

AST exposes the abstract syntax tree generated by PHP 7+. This extension is required by tools such as Phan, a static analyzer for PHP.

1 - Open the .env file

2 - Search for the WORKSPACE_INSTALL_AST argument under the Workspace Container

3 - Set it to true

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

Note If you need a specific version of AST then search for the WORKSPACE_AST_VERSION argument under the Workspace Container and set it to the desired version and continue step 4.

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.

Improve speed on MacOS

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.

So since 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

You can use the d4m-nfs solution in 2 ways, the first is by using the built-in Laradock integration, and the second is using the tool separately. Below is show case of both methods:

B.1: using the built in d4m-nfs integration

In simple terms, docker-sync creates a docker container with a copy of all the application files that can be accessed very quickly from the other containers. On the other hand, docker-sync runs a process on the host machine that continuously tracks and updates files changes from the host to this intermediate container.

Out of the box, it comes pre-configured for OS X, but using it on Windows is very easy to set-up by modifying the DOCKER_SYNC_STRATEGY on the .env


Laradock comes with, an optional bash script, that automates installing, running and stopping docker-sync. Note that to run the bash script you may need to change the permissions chmod 755

1) Configure your Laradock environment as you would normally do and test your application to make sure that your sites are running correctly.

2) Make sure to set DOCKER_SYNC_STRATEGY on the .env. Read the syncing strategies for details.

# osx: 'native_osx' (default)
# windows: 'unison'
# linux: docker-sync not required


3) set APP_CODE_CONTAINER_FLAG to APP_CODE_CONTAINER_FLAG=:nocopy in the .env file

4) Install the docker-sync gem on the host-machine:

./ install

5) Start docker-sync and the Laradock environment. Specify the services you want to run, as you would normally do with docker-compose up

./ up nginx mysql

Please note that the first time docker-sync runs, it will copy all the files to the intermediate container and that may take a very long time (15min+). 6) To stop the environment and docker-sync do:

./ down

Setting up Aliases (optional)

You may create bash profile aliases to avoid having to remember and type these commands for everyday development. Add the following lines to your ~/.bash_profile:

alias devup="cd /PATH_TO_LARADOCK/laradock; ./ up nginx mysql" #add your services
alias devbash="cd /PATH_TO_LARADOCK/laradock; ./ bash"
alias devdown="cd /PATH_TO_LARADOCK/laradock; ./ down"

Now from any location on your machine, you can simply run devup, devbash and devdown.

Additional Commands

Opening bash on the workspace container (to run artisan for example):

 ./ bash

Manually triggering the synchronization of the files:

./ sync

Removing and cleaning up the files and the docker-sync container. Use only if you want to rebuild or remove docker-sync completely. The files on the host will be kept untouched.

./ clean

Additional Notes

  • You may run laradock with or without docker-sync at any time using with the same .env and docker-compose.yml, because the configuration is overridden automatically when docker-sync is used.
  • You may inspect the script to learn each of the commands and even add custom ones.
  • If a container cannot access the files on docker-sync, you may need to set a user on the Dockerfile of that container with an id of 1000 (this is the UID that nginx and php-fpm have configured on laradock). Alternatively, you may change the permissions to 777, but this is not recommended.

Visit the docker-sync documentation for more details.

B.2: using the d4m-nfs tool

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 ~/d4m-nfs

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


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

6) Run the script (might need Sudo):


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.

Upgrade 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!”

4. 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 [email protected]

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:

[email protected]:~# docker

Set Up Your Laravel Project

[email protected]:~# apt-get install git
[email protected]:~# git clone
[email protected]:~# cd laravel
[email protected]:~/laravel/ git submodule add
[email protected]:~/laravel/ cd laradock

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

[email protected]:~/laravel/laradock# cp env-example .env

Create Your Laradock Containers

[email protected]:~/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

Execute commands

If you want to only execute some command and don’t want to enter bash, you can execute docker-compose run workspace <command>.

docker-compose run workspace php artisan migrate

Prepare for Visual Studio Code remote development

If you want to use Visual Studio Code for remote development directly on your workspace container, copy file devcontainer.example.json to devcontainer.json and customize it (see devcontainer.json reference for more options):

cd .devcontainer
cp devcontainer.example.json devcontainer.json

Then open your laradock folder in Visual Studio Code and click on popup button Reopen in Container.

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.

$ [email protected]:/var/www# composer install
$ [email protected]:/var/www# cp .env.example .env
$ [email protected]:/var/www# php artisan key:generate
$ [email protected]:/var/www# exit
[email protected]:~/laravel/laradock# cd ..
[email protected]:~/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:

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:

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


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

Serving Site With NGINX (HTTP ONLY)

Go back to command line.

[email protected]:~/laravel/laradock# cd nginx
[email protected]:~/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;

Rebuild Your Nginx

[email protected]:~/laravel/laradock# docker-compose down
[email protected]:~/laravel/laradock# docker-compose build nginx

Re Run Your Containers MYSQL and NGINX

[email protected]:~/laravel/laradock/nginx# docker-compose up -d nginx mysql

View Your Site with HTTP ONLY (

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

[email protected]:~/laravel/laradock# cd caddy
[email protected]:~/laravel/laradock/caddy# vim Caddyfile

root /var/www/public

and replace with your
root /var/www/public

uncomment tls

#tls self-signed

and replace self-signed with your email address

tls [email protected]

This is needed Prior to Creating Let’s Encypt

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

[email protected]:~/laravel/laradock# 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               |
caddy_1               | Activating privacy features... done.
caddy_1               |
caddy_1               |

After it finishes, press Ctrl + C to exit.

Stop All Containers and ReRun Caddy and Other Containers on Background

[email protected]:~/laravel/laradock# docker-compose down
[email protected]:~/laravel/laradock# docker-compose up -d mysql caddy

View your Site in the Browser Securely Using HTTPS (

Note that Certificate will be Automatically Renew By Caddy


Running Laravel Dusk Tests

Option 1: Without Selenium


This is a guide to run Dusk tests in your workspace container with headless google-chrome and chromedriver. It has been tested with Laravel 5.4 and 5.5.

Workspace Setup

Update your .env with following entries:

# Install Laravel installer bin to setup demo app
# Install all the necessary dependencies for running Dusk tests

Then run below to build your workspace.

docker-compose build workspace

Application Setup

Run a workspace container and you will be inside the container at /var/www directory.

docker-compose run workspace bash

/var/www#> _

Create new Laravel application named dusk-test and install Laravel Dusk package.

/var/www> laravel new dusk-test
/var/www> cd dusk-test
/var/www/dusk-test> composer require --dev laravel/dusk
/var/www/dusk-test> php artisan dusk:install

Create .env.dusk.local by copying from .env file.

/var/www/dusk-test> cp .env .env.dusk.local

Update the APP_URL entry in .env.dusk.local to local Laravel server.


You will need to run chromedriver with headless and no-sandbox flag. In Laravel Dusk 2.x it is already set headless so you just need to add no-sandbox flag. If you on previous version 1.x, you will need to update your DustTestCase#driver as shown below.



abstract class DuskTestCase extends BaseTestCase

    * Update chrome driver with below flags
    protected function driver()
        $options = (new ChromeOptions)->addArguments([

        return RemoteWebDriver::create(
            'http://localhost:9515', DesiredCapabilities::chrome()->setCapability(
                ChromeOptions::CAPABILITY, $options

Choose Chrome Driver Version (Optional)

You could choose to use either:

  1. Chrome Driver shipped with Laravel Dusk. (Default)
  2. Chrome Driver installed in workspace container. (Required tweak on DuskTestCase class)

For Laravel Dusk 2.x, you need to update DuskTestCase#prepare method if you wish to go with option #2.


abstract class DuskTestCase extends BaseTestCase
    public static function prepare()
        // Only add this line if you wish to use chrome driver installed in workspace container.
        // You might want to read the file path from env file.


For Laravel Dusk 1.x, you need to add DuskTestCase#buildChromeProcess method if you wish to go with option #2.


use Symfony\Component\Process\ProcessBuilder;

abstract class DuskTestCase extends BaseTestCase

    * Only add this method if you wish to use chrome driver installed in workspace container
    protected static function buildChromeProcess()
        return (new ProcessBuilder())


Run Dusk Tests

Run local server in workspace container and run Dusk tests.

# alias to run Laravel server in the background (php artisan serve --quiet &)
/var/www/dusk-test> serve
# alias to run Dusk tests (php artisan dusk)
/var/www/dusk-test> dusk

PHPUnit 6.4.0 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 837 ms, Memory: 6.00MB

Option 2: With Selenium


Setting up Laravel Dusk tests to run with Laradock appears be something that eludes most Laradock users. This guide is designed to show you how to wire them up to work together. This guide is written with macOS and Linux in mind. As such, it’s only been tested on macOS. Feel free to create pull requests to update the guide for Windows-specific instructions.

This guide assumes you know how to use a DNS forwarder such as dnsmasq or are comfortable with editing the /etc/hosts file for one-off DNS changes.

DNS Setup

According to RFC-2606, only four TLDs are reserved for local testing1:

  • .test
  • .example
  • .invalid
  • .localhost

A common TLD used for local development is .dev, but newer versions of Google Chrome (such as the one bundled with the Selenium Docker image), will fail to resolve that DNS as there will appear to be a name collision.

The recommended extension is .test for your Laravel web apps because you’re running tests. Using a DNS forwarder such as dnsmasq or by editing the /etc/hosts file, configure the host to point to localhost.

For example, in your /etc/hosts file:

# Host Database
# localhost is used to configure the loopback interface
# when the system is booting.  Do not change this entry.
##       localhost broadcasthost
::1             localhost       myapp.test

This will ensure that when navigating to myapp.test, it will route the request to which will be handled by Nginx in Laradock.

Docker Compose setup

In order to make the Selenium container talk to the Nginx container appropriately, the docker-compose.yml needs to be edited to accommodate this. Make the following changes:

  - nginx
  - nginx:<your_domain>

This allows network communication between the Nginx and Selenium containers and it also ensures that when starting the Selenium container, the Nginx container starts up first unless it’s already running. This allows the Selenium container to make requests to the Nginx container, which is necessary for running Dusk tests. These changes also link the nginx environment variable to the domain you wired up in your hosts file.

Laravel Dusk Setup

In order to make Laravel Dusk make the proper request to the Selenium container, you have to edit the DuskTestCase.php file that’s provided on the initial installation of Laravel Dusk. The change you have to make deals with the URL the Remote Web Driver attempts to use to set up the Selenium session.

One recommendation for this is to add a separate config option in your .env.dusk.local so it’s still possible to run your Dusk tests locally should you want to.

abstract class DuskTestCase extends BaseTestCase
    protected function driver()
        if (env('USE_SELENIUM', 'false') == 'true') {
            return RemoteWebDriver::create(
                'http://selenium:4444/wd/hub', DesiredCapabilities::chrome()
        } else {
            return RemoteWebDriver::create(
                'http://localhost:9515', DesiredCapabilities::chrome()

Running Laravel Dusk Tests

Now that you have everything set up, to run your Dusk tests, you have to SSH into the workspace container as you normally would: docker-compose exec --user=laradock workspace bash

Once inside, you can change directory to your application and run:

php artisan dusk

One way to make this easier from your project is to create a helper script. Here’s one such example:

#!/usr/bin/env sh



docker-compose exec --user=laradock workspace bash -c "cd my-project && php artisan dusk && exit"

This invokes the Dusk command from inside the workspace container but when the script completes execution, it returns your session to your project directory.

PHPStorm XDebug Setup


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.


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


  • 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: 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.


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

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

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

            context: ./php-fpm
                - INSTALL_XDEBUG=true

Edit xdebug.ini files

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

Set the following variables:


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.

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" ]; then
      docker rm $processes

    images=`docker images -q -f dangling=true`
    if [ -n "$images" ]; then
      docker rmi $images
  • 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
	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

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   mysqld   Up>3306/tcp
laradock_nginx_1            nginx                         Up>443/tcp,>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>22/tcp

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
PHP 7.0.9 (cli) (built: Aug 10 2016 19:45:48) ( NTS )
Copyright (c) 1997-2016 The PHP Group
Zend Engine v3.0.0, Copyright (c) 1998-2016 Zend Technologies
    with Xdebug v2.4.1, Copyright (c) 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.


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 [email protected] 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 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

Setup remote debugging for PhpStorm on Linux

  • Make sure you have followed the steps above in the Install Xdebug section.

  • Make sure Xdebug accepts connections and listens on port 9000. (Should be default configuration).

Debug Configuration.

  • Create a server with name laradock (matches PHP_IDE_CONFIG key in environment file) and make sure to map project root path with server correctly.

Server Configuration.

  • Start listening for debug connections, place a breakpoint and you are good to go !

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

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

I get stuck when building nginx on fetch

As stated on #749, Already fixed,just set CHANGE_SOURCE to false.

Custom composer repo packagist url and npm registry url

In China, the origin source of composer and npm is very slow. You can add WORKSPACE_NPM_REGISTRY and WORKSPACE_COMPOSER_REPO_PACKAGIST config in .env to use your custom source.



I get Module build failed: Error: write EPIPE while compiling react application

When you run npm build or yarn dev building a react application using webpack with elixir you may receive a Error: write EPIPE while processing .jpg images.

This is caused of an outdated library for processing .jpg files in ubuntu 16.04.

To fix the problem you can follow those steps

1 - Open the .env.

2 - Search for WORKSPACE_INSTALL_LIBPNG or add the key if missing.

3 - Set the value to true:


4 - Finally rebuild the workspace image

docker-compose build workspace

6. Related Projects

Laradock related projects:

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

7. 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 you have an issue or you found a typo in the documentation, you can help us by opening 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 helps us 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)

  • Fork 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 update the Documentation, add as much information.

  • Submit a Pull Request, to the master branch.

Edit supported Software (Edit a Container)

  • Fork 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 organizations.

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

8. License

MIT License (MIT)