18 KiB
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
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.
Usage Overview: Run NGINX and MySQL.
docker-compose up nginx mysql
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: Memcached - MariaDB ...
- Every software runs on a separate container: PHP-FPM - 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.
- Data container, to keep Data safe and accessible.
- 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.
Supported Containers
- PHP-FPM (7.0 - 5.6 - 5.5)
- NGINX
- MySQL
- PostgreSQL
- MariaDB
- Redis
- Memcached
- Beanstalkd
- Beanstalkd Console
- Workspace (includes: Composer, PHP7-CLI, Laravel Installer, Git, Vim, Nano and cURL)
- Data Volume (Databases Data Container)
- Application (Application Code Container)
If you can't find your container, 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.
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.
Requirements
| Linux | Windows & MAC |
|---|---|
| Laravel | Laravel |
| Git | Git |
| Docker Engine | Docker Toolbox |
| Docker Compose |
Installation
A - In existing Laravel Projects:
1 - Clone the LaraDock repository, inside your Laravel project root direcotry:
git submodule add https://github.com/LaraDock/laradock.git
2 - That's it, jump to the Usage section now.
If you are not already using Git for your Laravel project, you can use git clone instead of git submodule.
#### B - From scratch (Install LaraDock and Laravel):
If you don't have any Laravel project yet, and you want to start your Laravel project with Docker.
1 - Clone the LaraDock repository anywhere on your machine:
git clone https://github.com/LaraDock/laradock.git
2 - Go to the Uage section below and do the steps 1 and 3 then come back here.
3 - Enter the Workspace container. (assuming you have the Workspace container running):
docker exec -it {Workspace-Container-Name} bash
Replace {Workspace-Container-Name} with your Workspace container name. To get the name type docker-compose ps and copy it.
4 - Install Laravel anyway you like.
Example using the Laravel Installer:
laravel new my-cool-app
For more about this check out this link.
5 - 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 should replace ../:/var/www/laravel with ../my-cool-app/:/var/www/laravel, as follow:
application:
build: ./application
volumes:
- ../my-cool-app/:/var/www/laravel
6 - finally go to the Usage section below again and do steps 2 and 4.
Usage
1 - 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?
2 - 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?
3 - Run the Containers, (you can select the software's (containers) that you wish to run)
*Make sure you are in the `laradock` folder before running the `docker-compose` command.*
Example: Running NGINX, MySQL, Redis and the Workspace:
docker-compose up -d nginx mysql redis workspace
Note: the PHP-FPM, Application and Data Containers will automatically run.
Supported Containers: workspace, nginx, mysql, redis, postgres, mariadb, memcached, beanstalkd, beanstalkd-console, data, php-fpm, application.
4 - 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
## Documentation
Docker
List current running Containers
docker ps
You can also use the this 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 ```
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):
#### 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} 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
If you find any bug or you have and suggestion that can improve the performance of any image, please consider contributing. Thanks in advance.
#### 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}
#### 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.
#### 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}
### Laravel
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 exec -it {workspace-container-name} bash
4 - Run anything you want :)
php artisan
Composer update
phpunit
laravel new blog
#### 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);
### PHP
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 planing to run your application on different PHP-FPM version.
1 - Open the docker-compose.yml.
2 - Search for Dockerfile-70 in the PHP container section.
3 - Change the version number.
Example to select version 5.6 instead of 7.0 you have to replace Dockerfile-70 with Dockerfile-56.
Sample:
php-fpm:
build:
context: ./php-fpm
dockerfile: Dockerfile-70
Supported Versions:
- For (PHP 7.0.*) use
Dockerfile-70 - For (PHP 5.6.*) use
Dockerfile-56 - For (PHP 5.5.*) use
Dockerfile-55
4 - Finally rebuild the container
docker-compose build php
For more details about the PHP base image, visit the official PHP docker images.
#### Change the PHP-CLI Version By default **PHP-CLI 7.0** is running.
Note: it's not very essential to edit the PHP-CLI verion. 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).
### Misc
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).
#### 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;
## 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
