blackbirdchess/blackbirdchess-docker-dev

Edmund Luong 2fc3919598 Added service container for Selenium standalone with Chrome (#519 )

* Added service container for Selenium standalone with Chrome

2017-01-01 10:22:01 -05:00

40 KiB

Raw Blame History

Laradock

Laradock is a Docker PHP development environment. It facilitate running PHP Apps on Docker.

Laradock is configured to run Laravel Apps by default, and it can be modified to run all kinds of PHP Apps (Symfony, CodeIgniter, Wordpress, Drupal...).

Use Docker first and learn about it later.

Readme Languages
- English (Default)
- Chinese
Intro
Demo Video
Requirements
Installation
Usage
Documentation
Related Projects
Help & Questions

Intro

Laradock strives to make the PHP development experience easier and faster.

It contains pre-packaged Docker Images that provides you a wonderful development environment without requiring you to install PHP, NGINX, MySQL, REDIS, and any other software on your machines.

Usage Overview:

Let's see how easy it is to install NGINX, PHP, Composer, MySQL and Redis. Then run Laravel.

Get LaraDock inside your Laravel project:
git clone https://github.com/LaraDock/laradock.git.
Enter the laradock folder and run only these Containers:
docker-compose up -d nginx mysql redis
Open your .env file and set DB_HOST to mysql and REDIS_HOST to redis.
Open your browser and visit the localhost: http://localdock

Features

Easy switch between PHP versions: 7.0, 5.6, 5.5...
Choose your favorite database engine: MySQL, Postgres, MariaDB...
Run your own combination of software: Memcached, HHVM, Beanstalkd...
Every software runs on a separate container: PHP-FPM, NGINX, PHP-CLI...
Easy to customize any container, with simple edit to the dockerfile.
All Images extends from an official base Image. (Trusted base Images).
Pre-configured Nginx for Laravel.
Easy to apply configurations inside containers.
Clean and well structured Dockerfiles (dockerfile).
Latest version of the Docker Compose file (docker-compose).
Everything is visible and editable.
Fast Images Builds.
More to come every week..

Supported Software (Containers)

Database Engines:
- MySQL
- PostgreSQL
- MariaDB
- MongoDB
- Neo4j
- RethinkDB
Cache Engines:
- Redis
- Memcached
- Aerospike
PHP Servers:
- NGINX
- Apache2
- Caddy
PHP Compilers:
- PHP-FPM
- HHVM
Message Queueing Systems:
- Beanstalkd (+ Beanstalkd Console)
- RabbitMQ (+ RabbitMQ Console)
Tools:
- Workspace (PHP7-CLI, Composer, Git, Node, Gulp, SQLite, xDebug, Envoy, Vim...)
- PhpMyAdmin
- PgAdmin
- ElasticSearch

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

What is Docker?

Docker is an open-source project that automates the deployment of applications inside software containers, by providing an additional layer of abstraction and automation of operating-system-level virtualization on Linux, Mac OS and Windows.

Why Docker not Vagrant!?

Vagrant creates Virtual Machines in minutes while Docker creates Virtual Containers in seconds.

Instead of providing a full Virtual Machines, like you get with Vagrant, Docker provides you lightweight Virtual Containers, that share the same kernel and allow to safely execute independent processes.

In addition to the speed, Docker gives tons of features that cannot be achieved with Vagrant.

Most importantly Docker can run on Development and on Production (same environment everywhere). While Vagrant is designed for Development only, (so you have to re-provision your server on Production every time).

Laradock VS Homestead (For Laravel Developers)

Laradock It's like Laravel Homestead but for Docker instead of Vagrant.

Laradock and Homestead both give you complete virtual development environments. (Without the need to install and configure every single software on your own Operating System).

Homestead is a tool that controls Vagrant for you (using Homestead special commands). And Vagrant manages your Virtual Machine.
LaraDock is a tool that controls Docker for you (using Docker & Docker Compose official commands). And Docker manages your Virtual Containers.

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

Demo Video

What's better than a Demo Video:

LaraDock v4.*
LaraDock v2.*
LaraDock v0.3
LaraDock v0.1

Requirements

Git
Docker >= 1.12

Installation

Choose the setup the best suits your needs.

A) Setup for Single Project:

(In case you want a Docker environment for each project)

A.1) Setup environment in existing Project:

(In case you already have a project, and you want to setup an environment to run it)

1 - Clone this repository on your project root directory:

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

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

Note: In this case the folder structure will be like this:

- project1
	- laradock
- project2
	- laradock

A.2) Setup environment first then create project:

(In case you don't have a project, and you want to create your project inside the Docker environment)

1 - Clone this repository anywhere on your machine:

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

Note: In this case the folder structure will be like this:

- projects
	- laradock
	- myProject

2 - Edit the docker-compose.yml file to map to your project directory once you have it (example: - ../myProject:/var/www).

3 - Stop and re-run your docker-compose command for the changes to take place.

docker-compose stop && docker-compose up -d XXXX YYYY ZZZZ ....

B) Setup for Multiple Projects:

1 - Clone this repository anywhere on your machine:

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

2 - Edit the docker-compose.yml file to map to your projects directories:

    applications:
        image: tianon/true
        volumes:
            - ../project1/:/var/www/project1
            - ../project2/:/var/www/project2

3 - You can access all sites by visiting http://localhost/project1/public and http://localhost/project2/public but of course that's not very useful so let's setup nginx quickly.

4 - Go to nginx/sites and copy sample.conf.example to project1.conf then to project2.conf

5 - Open the project1.conf file and edit the server_name and the root as follow:

    server_name project1.dev;
    root /var/www/project1/public;

Do the same for each project project2.conf, project3.conf,...

6 - Add the domains to the hosts files.

127.0.0.1  project1.dev

7 - Create your project Databases. Right now you have to do it manually by entering your DB container, until we automate it soon.

Usage

Read Before starting:

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

Upgrade to Docker Native for Mac/Windows (Recommended). Check out Upgrading Laradock
Use LaraDock v3.* (Visit the LaraDock-ToolBox Branch).

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 errors as much as possible.

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

Example: Running NGINX and MySQL:

docker-compose up -d nginx mysql

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 the list below:

nginx, hhvm, php-fpm, mysql, redis, postgres, mariadb, neo4j, mongo, apache2, caddy, memcached, beanstalkd, beanstalkd-console, rabbitmq, workspace, phpmyadmin, aerospike, pgadmin, elasticsearch.

2 - 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 (example docker-compose exec --user=laradock workspace bash) to have files created as your host's user. (you can change the PUID (User id) and PGID (group id) variables from the docker-compose.yml).

3 - Edit your project configurations.

Open your .env file and set the DB_HOST to mysql:

DB_HOST=mysql

If you want to use Laravel and you don't have it installed yet, see How to Install Laravel in a Docker Container.

4 - Open your browser and visit your localhost address (`http://localhost/`).
**Debugging**: if you are facing any problem here check the [Debugging](#debugging) section.

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

## Documentation

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 ```bash docker-compose stop ```

To stop single container do:

docker-compose stop {container-name}

### Delete all existing Containers ```bash 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

3 - To exit a container, type exit.

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

Examples:

Change MySQL Database Name:

    environment:
        MYSQL_DATABASE: laradock
    ...

Change Redis defaut port to 1111:

    ports:
        - "1111:6379"
    ...

### Edit a Docker Image

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

2 - Edit the file the way you want.

3 - Re-build the container:

docker-compose build mysql

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 logs {container-name}

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

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: ./xdebugPhpFpm stop.
Start xDebug by default: ./xdebugPhpFpm start.
See the status: ./xdebugPhpFpm status.

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

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

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

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

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

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

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.

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

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 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_EXTENSION argument under the Workspace Container
c) set it to true
d) search for the INSTALL_AEROSPIKE_EXTENSION argument under the PHP-FPM Container
e) set it to true

It should be like this:

    workspace:
        build:
            context: ./workspace
            args:
                - INSTALL_AEROSPIKE_EXTENSION=true
    ...
    php-fpm:
        build:
            context: ./php-fpm
            args:
                - INSTALL_AEROSPIKE_EXTENSION=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

### Use RethinkDB Container

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.

PHPStorm

Remote debug Laravel web and phpunit tests.

####Full Guide Here

Miscellaneous

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.

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

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

### Upgrading LaraDock

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

Stop the docker vm docker-machine stop {default}
Install Docker for Mac or Windows.
Upgrade LaraDock to v4.*.* (git pull origin master)
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 "Warnning Containers Data might be lost!"

## Contributing

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

Read the Contribution Guidelines.

## Related Projects

LaraDock related projects:

LaraDock CLI by LorinLee
LaraDock Env by BAGArt
Klaradock by Kim Hsiao
Ansible Laradock Kubernetes by Sifat Rahim

These Docker Compose projects have piqued our interest:

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

## Help & Questions

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

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

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

Credits

Creator:

Mahmoud Zalt [ Twitter | Personal Site | Linkedin ]

Admins:

Bo-Yi Wu (appleboy)
Philippe Trépanier (philtrep)

Main Contributors:

Francis Lavoie (francislavoie)
luciano-jr
Zhqagp
Tim B. (tjb328)
MidasCodeBreaker
Larry Eitel
Suteepat (tianissimo)
David (davidavz)
Lialosiu
Eric Pfeiffer (computerfr33k)
Orette
Jack Fletcher (Kauhat)
Amin Mkh
Matthew Tonkin Dunn (mattythebatty)
Zhivitsa Kirill (zhikiri)
Benmag
Cristian Mello (cristiancmello)

Other Contributors & Supporters:

License

MIT License (MIT)

40 KiB Raw Blame History

Laradock

Contents

Intro

Features

Supported Software (Containers)

What is Docker?

Why Docker not Vagrant!?

Laradock VS Homestead (For Laravel Developers)

Demo Video

Requirements

Installation

A) Setup for Single Project:

A.1) Setup environment in existing Project:

A.2) Setup environment first then create project:

B) Setup for Multiple Projects:

Usage

List current running Containers

Install PHP Extensions

A) Switch from PHP 7.0 to PHP 5.6

B) Switch from PHP 7.0 or 5.6 to PHP 5.5

Install Laravel from a Docker Container

Install ElasticSearch Plugin

Install CodeIgniter

Change the timezone

Adding cron jobs

Access workspace via ssh

MySQL access from host

MySQL root access

Change MySQL port

Use custom Domain (instead of the Docker IP)

PHPStorm

Miscellaneous

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

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

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

I get Nginx error 404 Not Found on Windows.

I get Mysql connection refused

Read the Contribution Guidelines.

Credits

License

40 KiB

Raw Blame History

A) Switch from PHP `7.0` to PHP `5.6`

B) Switch from PHP `7.0` or `5.6` to PHP `5.5`

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