The docker environment for developing Blackbird Chess
Go to file
Mahmoud Zalt 22f11e03ee Merge pull request #34 from benmag/master
Add support for postgres
2016-05-07 04:34:27 +03:00
data Major updates. 2016-05-06 17:04:02 +03:00
mysql Major updates. 2016-05-06 17:04:02 +03:00
nginx Major updates. 2016-05-06 17:04:02 +03:00
php Major updates. 2016-05-06 17:04:02 +03:00
postgres Add support for postgres 2016-05-07 11:16:06 +10:00
redis Major updates. 2016-05-06 17:04:02 +03:00
.gitignore Major updates. 2016-05-06 17:04:02 +03:00
docker-compose.yml Add support for postgres 2016-05-07 11:16:06 +10:00
LICENSE update the readme file 2016-03-11 10:11:24 +02:00
README.md upgrade the readme.md to reflect the last changes 2016-05-06 18:33:09 +03:00

LaraDock

forthebadge

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


## Contents

Intro

LaraDock strives to make the development experience easier. It contains pre-packaged Docker Images that provides you a wonderful development environment without requiring you to install PHP, NGINX, MySQL, REDIS, and any other software on your local machine.

What is Docker?

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

What is Laravel?

Seriously!!!

Why Docker not Vagrant!?

Vagrant gives you Virtual Machines in minutes while Docker gives you 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.

Default Containers

  • PHP
  • NGINX
  • MySQL
  • Redis
  • Data Volume

Requirements

Installation

1 - Clone the LaraDock repository, in any of your Laravel projects:

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

Instead of git clone you can use git submodule add in case you are already using Git for your Laravel project (Recommended):

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

These commands should create a docker folder, on the root directory of your Laravel project.

Usage

(Windows & MAC users) Make sure you have a running Docker Virtual Host on your machine first.
How to run a Docker Virtual Host?


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

How to find my Docker IP Address?


2 - Run the containers:
*(Make sure you are in the `docker` folder before running this command)*
docker-compose up -d

Only the first time you run this command, it will take up to 5 minutes (depend on your connection speed) to download the Docker Images on your local machine.


3 - Open your browser and visit your `{Docker-IP}` address (`http://xxx.xxx.xxx.xxx`).

Debugging: in case you faced an error here, run this command from the Laravel root directory:
sudo chmod -R 777 storage && sudo chmod -R 777 bootstrap/cache


Follow @Mahmoud_Zalt


## Documentation

List current running Containers

docker ps

#### Close all running Containers ```bash docker-compose stop ```
#### Delete all existing Containers ```bash docker-compose rm -f ```

Note: Careful with this command as it will delete your Data Volume Container as well. (if you want to keep your Database data than you should stop each container by itself as follow):

docker stop {container-name}


#### Build/Re-build Containers ```bash docker-compose build ```
#### Use Redis in Laravel

Open your Laravel's .env file and set the REDIS_HOST to your Docker-IP instead of the default 127.0.0.1 IP.

REDIS_HOST=xxx.xxx.xxx.xxx

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

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

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

Finally make sure you have the predis/predis package (~1.0) installed via Composer first.

composer require predis/predis:^1.0

You can manually test it with:

\Cache::store('redis')->put('laradock', 'awesome', 10);

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

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

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

xxx.xxx.xxx.xxx    laravel.dev

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

DB_HOST=xxx.xxx.xxx.xxx

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

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

server_name laravel.dev;

#### Change the PHP Version By default **PHP 7.0** is running.
To change the default PHP version:

1 - Open the dockerfile of the php folder.

2 - Change the PHP version number in the first line,

FROM php:7.0-fpm

Supported Versions:

  • For (PHP 7.0.*) use php:7.0-fpm
  • For (PHP 5.6.*) use php:5.6-fpm
  • For (PHP 5.5.*) use php:5.5-fpm

For more details visit the official PHP docker images.


#### Add more Software's (Docker Images)

To add an image (software), just edit the docker-compose.yml and add your container details, to do so you need to be familiar with the docker compose file syntax.


#### Edit a Docker Container (change Ports or Volumes) To modify a container you can simply open the `docker-compose.yml` and change everything you want.

Example: if you want to set the MySQL port to 3333, just replace the default port with yours:

  ports:
    - "3333:3306"

#### View the Log files The Log files are stored in the `docker/logs` directory.
#### Enter a Container (SSH into a running Container)

1 - first list the current running containers with docker ps

2 - enter any container with:

Example: enter the php container

docker exec -it php bash

Example: enter the nginx container

docker exec -it nginx bash

#### Add/Remove a Docker Container To prevent a container (software) from running, open the `docker-compose.yml` file, and comment out the container section or remove it entirely.
#### Edit a Docker Image

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

2 - Edit the file the way you want.

3 - Re-build the container:

docker-compose build

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


#### Run a Docker Virtual Host

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

1 - Run the default Host:

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

  • docker-machine create -d virtualbox default
    

2 - Run this command to configure your shell:

eval $(docker-machine env)

#### Find your Docker IP Address

On Windows & MAC:

docker-machine ip default

(The default IP is 192.168.99.100)

On Linux:

Your IP Address is 127.0.0.1

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


## 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 for the current containers, or anything else.. Do not hesitate to contribute, you are more than welcome :)

All Docker Images can be found at https://github.com/LaraDock

Support

Issues on Github.

Questions?

If you have any question, send me a direct message on LaraChat, my username is mahmoud_zalt.

Credits

Mahmoud Zalt

License

MIT License (MIT)