blackbirdchess/blackbirdchess-docker-dev

Mahmoud Zalt 12587bc712 Support Beanstalkd and Beanstalkd Console

Closes feature #38

2016-05-09 05:02:15 +03:00

14 KiB

Raw Blame History

LaraDock

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

## Contents

Intro
Supported Containers
Requirements
Installation
Usage
Documentation

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.

Features

Easy switch between PHP versions: 7.0 - 5.6 - 5.5 - ...
Choose your favorite database engine: MySQL - Postgres - Redis - ...
Run your own combination of software's: PHP - NGINX - MySQL - ...
Every software runs on a separate container: PHP - NGINX - ...
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. And very easy to update.
Using of a Data container, to keep the Data safe and accessible at anytime.
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.
Best practices everywhere.

What is Docker?

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

What is Laravel?

Seriously!!!

Why Docker not Vagrant!?

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

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

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

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

LaraDock VS Homestead

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

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

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

Supported Containers

PHP (7.0 - 5.6 - 5.5)
NGINX
Redis
MySQL
PostgreSQL
MariaDB
Beanstalkd
Beanstalkd Console
Data Volume

Cannot find your container! we would love to have it as well. Consider contributing your container and adding it to this list.

Requirements

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

Installation

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

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

You can use git submodule add instead of git clone if 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

0 - For Windows & MAC users only: make sure you have a running Docker Virtual Host on your machine. (Linux users don't need a Virtual Host, so skip this step).
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, (you can select the software's (containers) that you wish to run)
*Make sure you are in the `docker` folder before running the `docker-compose` command.*

Running PHP, NGINX and MySQL:

docker-compose up -d   php nginx mysql redis

Note: you can choose your own combination of software's (containers), another example:

Running PHP, NGINX, Postgres and Redis:

docker-compose up -d   php nginx beanstalkd postgres

Supported Containers: nginx, mysql, redis, postgres, mariadb, beanstalkd, beanstalkd-console, data, php.

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

To stop single container do:

docker-compose stop {container-name}

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

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

#### Use Redis

1 - First make sure you run the Redis Container with the docker-compose command.

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

REDIS_HOST=xxx.xxx.xxx.xxx

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

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

3 - To enable Redis Caching and/or for Sessions Management. Also from the .env file set CACHE_DRIVER and SESSION_DRIVER to redis instead of the default file.

CACHE_DRIVER=redis
SESSION_DRIVER=redis

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

composer require predis/predis:^1.0

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

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

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

3 - Finally rebuild the container

docker-compose build php

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

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

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

docker exec -it {container-name-or-id} bash

3 - to exit a container, type exit.

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

License

MIT License (MIT)

14 KiB Raw Blame History