Compare commits

...

29 Commits

Author SHA1 Message Date
18bf12bfde Merge pull request #74 from abyshakes/master
Issue #73 unable to install workspace container
2016-05-26 21:17:51 +03:00
d829482a06 Issue #73 unable to install workspace container 2016-05-25 22:33:29 +05:30
86c6389650 Merge pull request #70 from Gummibeer/patch-2
Issue #69
2016-05-24 19:49:35 +03:00
991e28046d Issue #69
add memcached to php-cli
2016-05-24 16:44:52 +02:00
ccbc73c6bc update the readme file 2016-05-24 14:01:07 +03:00
246c7366ba Merge pull request #68 from Gummibeer/patch-1
Issue #67
2016-05-24 13:23:13 +03:00
762e2ec07b Issue #67
Issue #67
simpler docker IP-Address get command
2016-05-24 11:54:07 +02:00
adaaa25f47 remove the Laravel installer from the workspace container 2016-05-23 23:32:59 +03:00
11a13a0c33 Merge pull request #66 from AminMkh/workspace-postgres-driver
added postgres driver
2016-05-23 23:24:27 +03:00
c642560993 added postgres driver
added postgres driver to workspace container.
2016-05-23 23:20:07 +03:00
ea9f5c635f Merge pull request #64 from AminMkh/master
Update docker-compose.yml
2016-05-23 23:00:09 +03:00
fd4253afb6 Update docker-compose.yml 2016-05-23 22:23:10 +03:00
73310e45e8 Merge pull request #62 from AminMkh/master
Update README.MD
2016-05-23 21:53:55 +03:00
7f91fc9798 Update README.MD 2016-05-23 21:45:38 +03:00
a8a7685a40 basic changes to the readme format 2016-05-21 19:19:03 +03:00
06c4c19a6f replace official neo4j image with tpires/neo4j
because of this wired error
(https://github.com/neo4j/docker-neo4j/issues/33)
2016-05-20 21:21:19 +03:00
8bff7656f6 add neo4j support to the readme file 2016-05-20 20:37:00 +03:00
5c9eb97db5 Support Neo4j DB (beta) 2016-05-20 20:35:10 +03:00
588819ab6d turn errors and access logs on by default for nginx 2016-05-20 20:32:33 +03:00
170b63a3ba edit redis volume 2016-05-20 09:26:29 +03:00
19813e48c3 add demo video to the readme 2016-05-20 09:24:26 +03:00
be7b8ee056 update the readme (installation steps) 2016-05-19 21:40:25 +03:00
01a056dd25 make the workspace container run automatically 2016-05-19 20:49:16 +03:00
70e1b0fe41 update readme file 2016-05-19 18:04:53 +03:00
0959b25c05 add sqlite support to the readme 2016-05-19 03:42:36 +03:00
1d8336a9e1 add cleaning to free some space during provisioning the workspace
Fixing E: You don't have enough free space in /var/cache/apt/archives/
2016-05-19 03:25:02 +03:00
f0e2d83618 add sqlite in the workspace
it could be removed to it’s own container later
2016-05-19 03:06:34 +03:00
7f1deb0342 update how to get IP address on Linux, in the readme 2016-05-19 02:49:07 +03:00
703887a2a6 add Node, Gulp and Bower to the readme 2016-05-18 22:54:46 +03:00
6 changed files with 202 additions and 135 deletions

253
README.md
View File

@ -21,6 +21,7 @@ It's like Laravel Homestead but for Docker instead of Vagrant.
- [What is Laravel](#what-is-laravel)
- [Why Docker not Vagrant](#why-docker-not-vagrant)
- [LaraDock VS Homestead](#laradock-vs-homestead)
- [Demo Video](#Demo)
- [Requirements](#Requirements)
- [Installation](#Installation)
- [Usage](#Usage)
@ -36,6 +37,7 @@ It's like Laravel Homestead but for Docker instead of Vagrant.
- [Add more Software's (Docker Images)](#Add-Docker-Images)
- [View the Log files](#View-the-Log-files)
- [Laravel](#Laravel):
- [Install Laravel from a Docker Container](#Install-Laravel)
- [Run Artisan Commands](#Run-Artisan-Commands)
- [Use Redis](#Use-Redis)
- [PHP](#PHP)
@ -46,7 +48,7 @@ It's like Laravel Homestead but for Docker instead of Vagrant.
- [Run a Docker Virtual Host](#Run-Docker-Virtual-Host)
- [Find your Docker IP Address](#Find-Docker-IP-Address)
- [Use custom Domain](#Use-custom-Domain)
- [Help & Questions](#Help)
@ -57,10 +59,10 @@ 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`.
**Usage Overview:** Run `NGINX`, `MySQL` and `Redis`.
```shell
docker-compose up nginx mysql
docker-compose up nginx mysql redis
```
<a name="features"></a>
@ -88,12 +90,13 @@ docker-compose up nginx mysql
- MySQL
- PostgreSQL
- MariaDB
- Neo4j
- Redis
- Memcached
- Beanstalkd
- Beanstalkd Console
- Workspace (includes: Composer, PHP7-CLI, Laravel Installer, Git, Vim, Nano and cURL)
- Data Volume *(Databases Data Container)*
- Workspace (contains: Composer, PHP7-CLI, Laravel Installer, Git, Node, Gulp, Bower, SQLite, Vim, Nano and cURL)
- Data *(Databases Data Container)*
- Application *(Application Code Container)*
@ -151,117 +154,103 @@ Running a virtual Container is much faster than running a full virtual Machine.
| [Docker Compose](https://docs.docker.com/compose/install) | |
<a name="Demo"></a>
## Demo Video
What's better than a [**Demo Video**](https://www.youtube.com/watch?v=-DamFMczwDA) :)
<a name="Installation"></a>
## Installation
#### A - In existing Laravel Projects:
1 - Clone the `LaraDock` repository, inside your `Laravel` project root direcotry:
1 - Clone the `LaraDock` repository.
**A)** If you already have a Laravel project, clone this repository on your `Laravel` root direcotry:
```bash
git submodule add https://github.com/LaraDock/laradock.git
```
>If you are not already using Git for your Laravel project, you can use `git clone` instead of `git submodule`.
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`.*
<br>
#### 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:
**B)** If you don't have a Laravel project, and you want to install Laravel from Docker, clone this repo anywhere on your machine:
```bash
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):
```bash
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:
```bash
laravel new my-cool-app
```
For more about this check out this [link](https://laravel.com/docs/master#installing-laravel).
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:
```yaml
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.
<a name="Usage"></a>
## Usage
1 - For **Windows & MAC** users only: make sure you have a running Docker Virtual Host on your machine.
1 - For **Windows & MAC** users only: If you are not using the native Docker-Engine `Beta`, make sure you have a running Docker Virtual Host on your machine.
(**Linux** users don't need a Virtual Host, so skip this step).
<br>
[How to run a Docker Virtual Host?](#Run-Docker-Virtual-Host)
<br>
2 - Open your Laravel's `.env` file and set the `DB_HOST` to your `{Docker-IP}`:
2 - Run the Containers, (you can select the containers that you wish to run)
<br>
*Make sure you are in the `laradock` folder before running the `docker-compose` command.*
**Example:** Running NGINX and MySQL:
```bash
docker-compose up -d nginx mysql
```
*Note: the PHP-FPM, Workspace, Application and Data Containers will automatically run.*
Supported Containers: `nginx`, `mysql`, `redis`, `postgres`, `mariadb`, `neo4j`, `memcached`, `beanstalkd`, `beanstalkd-console`, `workspace`, `data`, `php-fpm`, `application`.
<br>
3 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, ...).
```bash
docker exec -it {Workspace-Container-Name} bash
```
Replace `{Workspace-Container-Name}` with your Workspace container name.
<br>
To find the containers names type `docker-compose ps`.
<br>
4 - Edit the Laravel configurations.
If you don't have a Laravel project installed yet, see [How to Install Laravel in a Docker Container](#Install-Laravel).
Open your Laravel's `.env` file and set the `DB_HOST` to your `{Docker-IP}`:
```env
DB_HOST=xxx.xxx.xxx.xxx
```
[How to find my Docker IP Address?](#Find-Docker-IP-Address)
<br>
3 - Run the Containers, (you can select the software's (containers) that you wish to run)
<br>
*Make sure you are in the `laradock` folder before running the `docker-compose` command.*
**Example:** Running NGINX, MySQL, Redis and the Workspace:
```bash
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`.
<br>
4 - Open your browser and visit your `{Docker-IP}` address (`http://xxx.xxx.xxx.xxx`).
5 - Open your browser and visit your `{Docker-IP}` address (`http://xxx.xxx.xxx.xxx`).
<br>
**Debugging**: in case you faced an error here, run this command from the Laravel root directory:
```bash
sudo chmod -R 777 storage && sudo chmod -R 777 bootstrap/cache
sudo chmod -R 777 storage bootstrap/cache
```
<br>
[Follow @Mahmoud_Zalt](https://twitter.com/Mahmoud_Zalt)
If you have any problem, or need a special support. Feel free to contact me, more details in the [Help & Questions](#Help) secion.
<br>
@ -271,12 +260,12 @@ sudo chmod -R 777 storage && sudo chmod -R 777 bootstrap/cache
<a name="Docker"></a>
### Docker
### [Docker]
<a name="List-current-running-Containers"></a>
#### List current running Containers
### List current running Containers
```bash
docker ps
```
@ -292,7 +281,7 @@ docker-compose ps
<br>
<a name="Close-all-running-Containers"></a>
#### Close all running Containers
### Close all running Containers
```bash
docker-compose stop
```
@ -310,7 +299,7 @@ docker-compose stop {container-name}
<br>
<a name="Delete-all-existing-Containers"></a>
#### Delete all existing Containers
### Delete all existing Containers
```bash
docker-compose down
```
@ -325,7 +314,7 @@ docker-compose down
<br>
<a name="Enter-Container"></a>
#### Enter a Container (SSH into a running Container)
### Enter a Container (SSH into a running Container)
1 - first list the current running containers with `docker ps`
@ -344,7 +333,7 @@ docker exec -it {container-name} bash
<br>
<a name="Edit-Container"></a>
#### Edit default container configuration
### Edit default container configuration
Open the `docker-compose.yml` and change anything you want.
Examples:
@ -372,7 +361,7 @@ Change Redis defaut port to 1111:
<br>
<a name="Edit-a-Docker-Image"></a>
#### Edit a Docker Image
### Edit a Docker Image
1 - Find the `dockerfile` of the image you want to edit,
<br>
@ -399,7 +388,7 @@ docker-compose build mysql
<br>
<a name="Build-Re-build-Containers"></a>
#### Build/Re-build Containers
### Build/Re-build Containers
If you do any change to any `dockerfile` make sure you run this command, for the changes to take effect:
@ -419,7 +408,7 @@ docker-compose build {container-name}
<br>
<a name="Add-Docker-Images"></a>
#### Add more Software's (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](https://docs.docker.com/compose/compose-file/).
@ -433,7 +422,7 @@ To add an image (software), just edit the `docker-compose.yml` and add your cont
<br>
<a name="View-the-Log-files"></a>
#### View the Log files
### 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:
@ -448,13 +437,52 @@ docker logs {container-name}
<br>
<a name="Laravel"></a>
### Laravel
### [Laravel]
<a name="Install-Laravel"></a>
### Install Laravel from a Docker Container
1 - First you need to enter the Workspace Container.
2 - Install Laravel.
Example using Composer
```bash
composer create-project laravel/laravel my-cool-app "5.2.*"
```
> We recommand using `composer create-project` instead of the Laravel installer, to install Laravel.
For more about the Laravel installation click [here](https://laravel.com/docs/master#installing-laravel).
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/laravel` with `../my-cool-app/:/var/www/laravel`, as follow:
```yaml
application:
build: ./application
volumes:
- ../my-cool-app/:/var/www/laravel
```
4 - Go to that folder and start working..
```bash
cd my-cool-app
```
<br>
<a name="Run-Artisan-Commands"></a>
#### Run Artisan Commands
### Run Artisan Commands
You can run artisan commands and many other Terminal commands from the Workspace container.
@ -500,7 +528,7 @@ laravel new blog
<br>
<a name="Use-Redis"></a>
#### Use Redis
### Use Redis
1 - First make sure you run the Redis Container with the `docker-compose` command.
@ -553,7 +581,7 @@ composer require predis/predis:^1.0
<br>
<a name="PHP"></a>
### PHP
### [PHP]
@ -561,7 +589,7 @@ composer require predis/predis:^1.0
<a name="Install-PHP-Extensions"></a>
#### Install PHP Extensions
### 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.
@ -579,7 +607,7 @@ The PHP-CLI extensions should be installed in `workspace/Dockerfile`.
<br>
<a name="Change-the-PHP-FPM-Version"></a>
#### Change the PHP-FPM Version
### 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.
@ -626,7 +654,7 @@ For more details about the PHP base image, visit the [official PHP docker images
<br>
<a name="Change-the-PHP-CLI-Version"></a>
#### Change the PHP-CLI Version
### 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.
@ -647,14 +675,14 @@ Right now you have to manually edit the `Dockerfile` or create a new one like it
<br>
<a name="Misc"></a>
### Misc
### [Misc]
<a name="Run-Docker-Virtual-Host"></a>
#### Run a Docker Virtual Host
### Run a Docker Virtual Host
These steps are only for **Windows & MAC** users *(Linux users don't need a virtual host)*:
@ -684,30 +712,39 @@ eval $(docker-machine env)
<br>
<a name="Find-Docker-IP-Address"></a>
#### Find your Docker IP Address
### Find your Docker IP Address
**On Windows & MAC:**
Run this command in your terminal:
```bash
docker-machine ip default
```
If your Host name is different then `default`, you have to specify it (`docker-machine ip my-host`).
*(The default IP is 192.168.99.100)*
**On Linux:**
Your IP Address is `127.0.0.1`
<br>
> **boot2docker** users: run `boot2docker ip` *(when boot2docker is up)*.
<br>
**On Linux:**
Run this command in your terminal:
```shell
ifconfig docker0 | grep 'inet' | cut -d: -f2 | awk '{ print $1}' | head -n1
```
*(The default IP is 172.17.0.1)*
<br>
<a name="Use-custom-Domain"></a>
#### Use custom Domain (instead of the Docker IP)
### 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`.
@ -747,27 +784,33 @@ server_name laravel.dev;
<br>
## 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](https://github.com/LaraDock)
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 :)
## Support
[Issues](https://github.com/laradock/laradock/issues) on Github.
To suggest a features or report a bug, open a new [Issue](https://github.com/laradock/laradock/issues).
### Questions?
If you have any question, send me a direct message on LaraChat, my username is `mahmoud_zalt`.
<a name="Help"></a>
## Help & Questions
If you need help with anything related to this project, shedule a live call with me on [Codementor](https://www.codementor.io/mahmoudz), I'd love to help.
If you have a short question, send me a direct message on LaraChat, my username is `mahmoud_zalt`. Or send me an email on `mahmoud@zalt.me`.
## Credits
[![Mahmoud Zalt](https://img.shields.io/badge/Author-Mahmoud%20Zalt-orange.svg)](http://www.zalt.me)
Twitter: [@Mahmoud_Zalt](https://twitter.com/Mahmoud_Zalt)
<br>
Website: [http://zalt.me](http://zalt.me)
<br>
Email: `mahmoud@zalt.me`
## License
[MIT License (MIT)](https://github.com/laradock/laradock/blob/master/LICENSE)
[]([]())
[MIT License](https://github.com/laradock/laradock/blob/master/LICENSE) (MIT)

View File

@ -12,6 +12,8 @@ services:
- application
expose:
- "9000"
links:
- workspace
### Laravel Application Code Container ######################
@ -30,6 +32,7 @@ services:
- /var/lib/mariadb
- /var/lib/redis
- /var/lib/memcached
- /var/lib/neo4j/data
### Nginx Server Container ##################################
@ -58,8 +61,6 @@ services:
MYSQL_USER: homestead
MYSQL_PASSWORD: secret
MYSQL_ROOT_PASSWORD: root
links:
- php-fpm
### PostgreSQL Container ####################################
@ -73,8 +74,6 @@ services:
POSTGRES_DB: homestead
POSTGRES_USER: homestead
POSTGRES_PASSWORD: secret
links:
- php-fpm
### MariaDB Container #######################################
@ -89,8 +88,18 @@ services:
MYSQL_USER: homestead
MYSQL_PASSWORD: secret
MYSQL_ROOT_PASSWORD: root
links:
- php-fpm
### Neo4j Container #########################################
neo4j:
build: ./neo4j
ports:
- "7474:7474"
- "1337:1337"
environment:
- NEO4J_AUTH=homestead:secret
volumes_from:
- data
### Redis Container #########################################
@ -100,8 +109,6 @@ services:
- data
ports:
- "6379:6379"
links:
- php-fpm
### Memcached Container #####################################

7
neo4j/Dockerfile Normal file
View File

@ -0,0 +1,7 @@
FROM tpires/neo4j
MAINTAINER Mahmoud Zalt <mahmoud@zalt.me>
VOLUME /var/lib/neo4j/data
EXPOSE 7474 1337

View File

@ -17,8 +17,8 @@ http {
types_hash_max_size 2048;
include /etc/nginx/mime.types;
default_type application/octet-stream;
access_log off;
error_log off;
access_log on;
error_log on;
gzip on;
gzip_disable "msie6";
include /etc/nginx/conf.d/*.conf;

View File

@ -4,6 +4,8 @@ MAINTAINER Mahmoud Zalt <mahmoud@zalt.me>
#COPY redis.conf /usr/local/etc/redis/redis.conf
VOLUME /var/lib/redis
CMD [ "redis-server" ]
EXPOSE 6379

View File

@ -11,14 +11,16 @@ ENV LC_CTYPE=UTF-8
ENV LANG=en_US.UTF-8
ENV TERM xterm
# Install "software-properties-common" (for add-apt-repository) and add the "PHP 7" ppa
RUN apt-get update \
&& apt-get install -y software-properties-common \
&& add-apt-repository -y ppa:ondrej/php
# Install "software-properties-common" (for the "add-apt-repository")
RUN apt-get update && apt-get install -y \
software-properties-common
# Install PHP-CLI 7 and some useful Tools
RUN apt-get update \
&& apt-get install -y \
# Add the "PHP 7" ppa
RUN add-apt-repository -y \
ppa:ondrej/php
# Install PHP-CLI 7, some PHP extentions and some useful Tools with APT
RUN apt-get update && apt-get install -y --force-yes \
php7.0-cli \
php7.0-common \
php7.0-curl \
@ -27,7 +29,13 @@ RUN apt-get update \
php7.0-mbstring \
php7.0-mcrypt \
php7.0-mysql \
php7.0-pgsql \
php7.0-sqlite \
php7.0-sqlite3 \
php7.0-zip \
php7.0-memcached \
sqlite3 \
libsqlite3-dev \
git \
curl \
vim \
@ -36,29 +44,29 @@ RUN apt-get update \
nodejs-dev \
npm
# Install Composer
RUN curl -s http://getcomposer.org/installer | php \
&& mv composer.phar /usr/local/bin/ \
&& echo "alias composer='/usr/local/bin/composer.phar'" >> ~/.bashrc
# Clean up, to free some space
RUN apt-get clean
# Install the Laravel Installer
RUN composer.phar global require "laravel/installer" \
&& echo "export PATH='~/.composer/vendor/bin:$PATH'" >> ~/.bashrc
# Install gulp and bower with NPM
RUN npm install -g \
gulp \
bower
# Install gulp and bower
RUN npm install -g gulp bower
# Add a symbolic link
# Add a symbolic link for Node
RUN ln -s /usr/bin/nodejs /usr/bin/node
# Add an alias for PHPUnit
RUN echo "alias phpunit='./vendor/bin/phpunit'" >> ~/.bashrc
# Install Composer
RUN curl -s http://getcomposer.org/installer | php \
&& mv composer.phar /usr/local/bin/ \
&& echo "alias composer='/usr/local/bin/composer.phar'" >> ~/.bashrc
# Source the bash
RUN . ~/.bashrc
# Clean up
RUN apt-get autoclean && apt-get clean \
&& rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
RUN apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
WORKDIR /var/www/laravel