simplify the usage steps and create installation steps

This commit is contained in:
Mahmoud Zalt 2016-04-11 07:50:33 +03:00
parent b335364591
commit d98cf4754b

View File

@ -19,6 +19,7 @@ It's like Laravel Homestead but for Docker instead of Vagrant.
- [Intro](#Intro) - [Intro](#Intro)
- [Supported Software (Docker Images)](#Supported-Software) - [Supported Software (Docker Images)](#Supported-Software)
- [Requirements](#Requirements) - [Requirements](#Requirements)
- [Installation](#Installation)
- [Usage](#Usage) - [Usage](#Usage)
- [Documentation](#Documentation) - [Documentation](#Documentation)
- [List current running Containers](#List-current-running-Containers) - [List current running Containers](#List-current-running-Containers)
@ -33,9 +34,8 @@ It's like Laravel Homestead but for Docker instead of Vagrant.
- [View the Log files](#View-the-Log-files) - [View the Log files](#View-the-Log-files)
- [Upgrade the Docker Images](#Upgrade-the-Docker-Images) - [Upgrade the Docker Images](#Upgrade-the-Docker-Images)
- [Edit a Docker Image](#Edit-a-Docker-Image) - [Edit a Docker Image](#Edit-a-Docker-Image)
- [Find your Docker IP Address](#Find-Docker-IP-Address)
- [Run a Docker Virtual Host](#Run-Docker-Virtual-Host)
@ -86,64 +86,50 @@ The Images links on [Docker Hub](https://hub.docker.com/u/laradock/)
- Git ([Download](https://git-scm.com/downloads)) - Git ([Download](https://git-scm.com/downloads))
- Composer ([Download](https://getcomposer.org/download/)) - Composer ([Download](https://getcomposer.org/download/))
<a name="Installation"></a>
## Installation
<a name="Usage"></a> 1 - Clone the `LaraDock` repository, in any of your `Laravel` projects *(using this command)*:
## Usage
1 - Install any version of Laravel, or use any of your existing Laravel projects.
<br>
2 - Clone the LaraDock repository, inside a `docker` folder, on the root directory of your Laravel project:
```bash ```bash
git clone https://github.com/LaraDock/laradock.git docker git clone https://github.com/LaraDock/laradock.git docker
``` ```
<br> >This should create a `docker` folder, on the root directory of your Laravel project.
3 - Run a Docker Virtual host on your machine, if you haven't already:
- **On Windows & MAC:** run `docker-machine start default`
>If the host "default" does not exist, create it using:
<a name="Usage"></a>
## Usage
>**(Windows & MAC users)** Make sure you have a running Docker Virtual Host on your machine first.
><br> ><br>
>`docker-machine create -d virtualbox default` >[How to run a Docker Virtual Host?](#Run-Docker-Virtual-Host)
- **On Linux:** skip this step :) you don't need a virtual host, since Docker runs locally on your machine.
<br>
4 - Find your Docker IP address:
- **On Windows & MAC:** run `docker-machine ip default`
<br>
*(The default IP is 192.168.99.100)*
- **On Linux:** your IP Address is `127.0.0.1`
> For **boot2docker** users: run `boot2docker ip` *(when boot2docker is up)*.
<br> <br>
5 - Open your Laravel's `.env` file and set the `DB_HOST` to your `{Docker-IP}` instead of the default `127.0.0.1`: 1 - Open your Laravel's `.env` file and set the `DB_HOST` to your `{Docker-IP}`:
```env ```env
DB_HOST=xxx.xxx.xxx.xxx DB_HOST=xxx.xxx.xxx.xxx
``` ```
[How to find my Docker IP Address?](#Find-Docker-IP-Address)
> I am representing the `{Docker-IP}` with `xxx.xxx.xxx.xxx` for the purpos of this documentation.
<br> <br>
6 - Finally let's run the containers. **Make sure you are in the `docker` folder** before running this command: 2 - Run the containers:
<br>
*(Make sure you are in the `docker` folder before running this command)*
```bash ```bash
docker-compose up -d docker-compose up -d
``` ```
*"Note: 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 to your local machine.* *"Note: 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.*
> Debugging: in case you faced a problem with the docker mahcine here, run this command in your current terminal session `eval "$(docker-machine env default)"` > Debugging: in case you faced a problem with the docker mahcine here, run this command in your current terminal session `eval "$(docker-machine env default)"`
<br> <br>
7 - Open your browser and visit your `{Docker-IP}` address (`http://xxx.xxx.xxx.xxx`). 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: > Debugging: in case you faced an error here, run this command from the Laravel root directory:
@ -225,7 +211,6 @@ composer require predis/predis:^1.0
``` ```
<br> <br>
<a name="Use-custom-Domain"></a> <a name="Use-custom-Domain"></a>
#### Use custom Domain (instead of the Docker IP) #### Use custom Domain (instead of the Docker IP)
@ -264,10 +249,6 @@ server_name laravel.dev;
> - "laravel.dev:xxx.xxx.xxx.xxx" > - "laravel.dev:xxx.xxx.xxx.xxx"
>``` >```
<br>
> Don't forget to replace the `xxx.xxx.xxx.xxx` with your Docker IP Address.
<br> <br>
@ -323,7 +304,6 @@ The Log files are stored in the `docker/logs` directory.
<br> <br>
<a name="Upgrade-the-Docker-Images"></a> <a name="Upgrade-the-Docker-Images"></a>
#### Upgrade the Docker Images #### Upgrade the Docker Images
@ -358,6 +338,34 @@ All the images are open source and hosted on the [Docker Hub](https://hub.docker
<br>
<a name="Find-Docker-IP-Address"></a>
#### Find your Docker IP Address
- **On Windows & MAC:** run `docker-machine ip default`
<br>
*(The default IP is 192.168.99.100)*
- **On Linux:** your IP Address is `127.0.0.1`
> For **boot2docker** users: run `boot2docker ip` *(when boot2docker is up)*.
<br>
<a name="Run-Docker-Virtual-Host"></a>
#### Run a Docker Virtual Host
- **On Windows & MAC:** run `docker-machine start default`
>If the host "default" does not exist, create it using:
><br>
>`docker-machine create -d virtualbox default`
- **On Linux:** you don't need a virtual host, since Docker runs locally on your machine.
<br> <br>
## Contributing ## Contributing