@@ -32,7 +32,6 @@ Choose the setup the best suits your needs.
<aname="A1"></a>
### A.1) Already have a PHP project:
> (Follow these steps if you already have a PHP project, and all you need is an environment to run it)
1 - Clone laradock on your project root directory:
...
...
@@ -56,11 +55,12 @@ Your folder structure should look like this:
+ laradock-b
```
(It's important to rename the folders differently in each project)
(It's important to rename the folders differently in each project.)
> **Now jump to the [Usage](#Usage) section.**
<aname="A2"></a>
### A.2) Don't have a PHP project yet:
> (Follow these steps if you don't have a PHP project yet, and you need an environment to create the project)
1 - Clone this repository anywhere on your machine:
...
...
@@ -82,10 +82,10 @@ Your folder structure should look like this:
*Or you can keep `default.conf` as it is, and create a separate config `my-site.conf` file for it.*
**In case of Apache:** :P
<br>
3 - Run your `docker-compose up` command and you're ready to go.
*Note: if you already had your containers up, you might need to take them down first and rebuild them for the changes to take effect.*
> **Now jump to the [Usage](#Usage) section.**
<aname="B"></a>
...
...
@@ -121,9 +121,7 @@ You can rename the config files, project folders and domains as you like, just m
127.0.0.1 project-2.dev
```
5 - Visit `http://project-1.dev/` and `http://project-2.dev/`.
> **Now jump to the [Usage](#Usage) section.**
...
...
@@ -131,6 +129,7 @@ You can rename the config files, project folders and domains as you like, just m
<aname="Usage"></a>
## Usage
**Read Before starting:**
...
...
@@ -146,10 +145,18 @@ If you are using **Docker Toolbox** (VM), do one of the following:
<br>
1 - Run Containers: *(Make sure you are in the `laradock` folder before running the `docker-compose` commands).*
1 - Enter the laradock folder and rename `env-example` to `.env`
```shell
cp env-example .env
```
**Example:** Running NGINX and MySQL:
You can edit the `.env` file to chose which software's you want to be installed in your environment. You can always refer to the `docker-compose.yml` file to see how those variables are been used.
2 - Build the enviroment and run it using `docker-compose`
In this example we'll see how to run NGINX (web server) and MySQL (database engine) to host a PHP Web Scripts:
```bash
docker-compose up -d nginx mysql
...
...
@@ -158,21 +165,21 @@ docker-compose up -d nginx mysql
**Note**: The `workspace` and `php-fpm` will run automatically in most of the cases, so no need to specify them in the `up` command. If you couldn't find them running then you need specify them as follow: `docker-compose up -d nginx php-fpm mysql workspace`.
You can select your own combination of Containers form the list below:
You can select your own combination of containers form the list below:
*(Please note that sometimes we forget to update the docs, so check the `docker-compose.yml` file to see an updated list of all available containers).*
<br>
2 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, ...).
3 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, ...)
```bash
docker-compose exec workspace bash
```
Alternatively, for Windows PowerShell users: execute the following command to enter any running container:
*Alternatively, for Windows PowerShell users: execute the following command to enter any running container:*
*You can change the PUID (User id) and PGID (group id) variables from the `docker-compose.yml` or the `.env`)*
*You can change the PUID (User id) and PGID (group id) variables from the `.env` file)*
<br>
3 - Edit your project configurations.
4 - Update your project configurations to use the database host
Open your `.env` file and set the`DB_HOST` to `mysql`:
Open your PHP project's `.env` file or whichever configuration file you are reading from, and set the database host`DB_HOST` to `mysql`:
```env
DB_HOST=mysql
...
...
@@ -198,4 +205,6 @@ DB_HOST=mysql
*If you want to install Laravel as PHP project, see [How to Install Laravel in a Docker Container](#Install-Laravel).*
<br>
4 - Open your browser and visit your localhost address `http://localhost/`.
5 - Open your browser and visit your localhost address `http://localhost/`. If you followed the multiple projects setup, you can visit `http://project-1.dev/` and `http://project-2.dev/`. But first don't
<p>You can edit the <code>.env</code> file to chose which software’s you want to be installed in your environment. You can always refer to the <code>docker-compose.yml</code> file to see how those variables are been used.</p>
<p>2 - Build the enviroment and run it using <code>docker-compose</code></p>
<p><strong>Example:</strong> Running NGINX and MySQL:</p>
<p>In this example we’ll see how to run NGINX (web server) and MySQL (database engine) to host a PHP Web Scripts:</p>
<pre><codeclass="language-bash">docker-compose up -d nginx mysql
</code></pre>
<p><strong>Note</strong>: The <code>workspace</code> and <code>php-fpm</code> will run automatically in most of the cases, so no need to specify them in the <code>up</code> command. If you couldn’t find them running then you need specify them as follow: <code>docker-compose up -d nginx php-fpm mysql workspace</code>.</p>
<p>You can select your own combination of Containers form the list below:</p>
<p>You can select your own combination of containers form the list below:</p>
<p><em>(Please note that sometimes we forget to update the docs, so check the <code>docker-compose.yml</code> file to see an updated list of all available containers).</em></p>
<p><br>
2 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, …).</p>
3 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, …)</p>
<p><em>You can change the PUID (User id) and PGID (group id) variables from the <code>docker-compose.yml</code> or the <code>.env</code>)</em></p>
<p><em>You can change the PUID (User id) and PGID (group id) variables from the <code>.env</code> file)</em></p>
<p><br>
3 - Edit your project configurations.</p>
4 - Update your project configurations to use the database host</p>
<p>Open your <code>.env</code> file and set the<code>DB_HOST</code> to <code>mysql</code>:</p>
<p>Open your PHP project’s <code>.env</code> file or whichever configuration file you are reading from, and set the database host<code>DB_HOST</code> to <code>mysql</code>:</p>
<pre><codeclass="language-env">DB_HOST=mysql
</code></pre>
...
...
@@ -503,7 +513,7 @@
<p><em>If you want to install Laravel as PHP project, see <ahref="#Install-Laravel">How to Install Laravel in a Docker Container</a>.</em></p>
<p><br>
4 - Open your browser and visit your localhost address <code>http://localhost/</code>.</p>
5 - Open your browser and visit your localhost address <code>http://localhost/</code>. If you followed the multiple projects setup, you can visit <code>http://project-1.dev/</code> and <code>http://project-2.dev/</code>. But first don’t</p>
<p><em>Or you can keep <code>default.conf</code> as it is, and create a separate config <code>my-site.conf</code> file for it.</em></p>
<p><strong>In case of Apache:</strong> :P</p>
<p><strong>In case of Apache:</strong> :P
<br></p>
<p>3 - Run your <code>docker-compose up</code> command and you&rsquo;re ready to go.</p>
<p><em>Note: if you already had your containers up, you might need to take them down first and rebuild them for the changes to take effect.</em></p>
<blockquote>
<p><strong>Now jump to the <a href="#Usage">Usage</a> section.</strong></p>
<p>1 - Run Containers: <em>(Make sure you are in the <code>laradock</code> folder before running the <code>docker-compose</code> commands).</em></p>
<p>1 - Enter the laradock folder and rename <code>env-example</code> to <code>.env</code></p>
<p>You can edit the <code>.env</code> file to chose which software&rsquo;s you want to be installed in your environment. You can always refer to the <code>docker-compose.yml</code> file to see how those variables are been used.</p>
<p>2 - Build the enviroment and run it using <code>docker-compose</code></p>
<p><strong>Example:</strong> Running NGINX and MySQL:</p>
<p>In this example we&rsquo;ll see how to run NGINX (web server) and MySQL (database engine) to host a PHP Web Scripts:</p>
<pre><code class="language-bash">docker-compose up -d nginx mysql
</code></pre>
<p><strong>Note</strong>: The <code>workspace</code> and <code>php-fpm</code> will run automatically in most of the cases, so no need to specify them in the <code>up</code> command. If you couldn&rsquo;t find them running then you need specify them as follow: <code>docker-compose up -d nginx php-fpm mysql workspace</code>.</p>
<p>You can select your own combination of Containers form the list below:</p>
<p>You can select your own combination of containers form the list below:</p>
<p><em>(Please note that sometimes we forget to update the docs, so check the <code>docker-compose.yml</code> file to see an updated list of all available containers).</em></p>
<p><br>
2 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, &hellip;).</p>
3 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, &hellip;)</p>
<p><em>You can change the PUID (User id) and PGID (group id) variables from the <code>docker-compose.yml</code> or the <code>.env</code>)</em></p>
<p><em>You can change the PUID (User id) and PGID (group id) variables from the <code>.env</code> file)</em></p>
<p><br>
3 - Edit your project configurations.</p>
4 - Update your project configurations to use the database host</p>
<p>Open your <code>.env</code> file and set the<code>DB_HOST</code> to <code>mysql</code>:</p>
<p>Open your PHP project&rsquo;s <code>.env</code> file or whichever configuration file you are reading from, and set the database host<code>DB_HOST</code> to <code>mysql</code>:</p>
<p><em>If you want to install Laravel as PHP project, see <a href="#Install-Laravel">How to Install Laravel in a Docker Container</a>.</em></p>
<p><br>
4 - Open your browser and visit your localhost address <code>http://localhost/</code>.</p>
5 - Open your browser and visit your localhost address <code>http://localhost/</code>. If you followed the multiple projects setup, you can visit <code>http://project-1.dev/</code> and <code>http://project-2.dev/</code>. But first don&rsquo;t</p>
<p>You can edit the <code>.env</code> file to chose which software’s you want to be installed in your environment. You can always refer to the <code>docker-compose.yml</code> file to see how those variables are been used.</p>
<p>2 - Build the enviroment and run it using <code>docker-compose</code></p>
<p>In this example we’ll see how to run NGINX (web server) and MySQL (database engine) to host a PHP Web Scripts:</p>
<pre><codeclass="language-bash">docker-compose up -d nginx mysql
</code></pre>
<p><strong>Note</strong>: The <code>workspace</code> and <code>php-fpm</code> will run automatically in most of the cases, so no need to specify them in the <code>up</code> command. If you couldn’t find them running then you need specify them as follow: <code>docker-compose up -d nginx php-fpm mysql workspace</code>.</p>
<p>You can select your own combination of Containers form the list below:</p>
<p>You can select your own combination of containers form the list below:</p>
<p><em>(Please note that sometimes we forget to update the docs, so check the <code>docker-compose.yml</code> file to see an updated list of all available containers).</em></p>
<p><br>
2 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, …).</p>
3 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, …)</p>
<p><em>You can change the PUID (User id) and PGID (group id) variables from the <code>docker-compose.yml</code> or the <code>.env</code>)</em></p>
<p><em>You can change the PUID (User id) and PGID (group id) variables from the <code>.env</code> file)</em></p>
<p><br>
3 - Edit your project configurations.</p>
4 - Update your project configurations to use the database host</p>
<p>Open your <code>.env</code> file and set the<code>DB_HOST</code> to <code>mysql</code>:</p>
<p>Open your PHP project’s <code>.env</code> file or whichever configuration file you are reading from, and set the database host<code>DB_HOST</code> to <code>mysql</code>:</p>
<pre><codeclass="language-env">DB_HOST=mysql
</code></pre>
...
...
@@ -701,7 +711,7 @@ QUEUE_HOST=beanstalkd
<p><em>If you want to install Laravel as PHP project, see <ahref="#Install-Laravel">How to Install Laravel in a Docker Container</a>.</em></p>
<p><br>
4 - Open your browser and visit your localhost address <code>http://localhost/</code>.</p>
5 - Open your browser and visit your localhost address <code>http://localhost/</code>. If you followed the multiple projects setup, you can visit <code>http://project-1.dev/</code> and <code>http://project-2.dev/</code>. But first don’t</p>
<p><em>Or you can keep <code>default.conf</code> as it is, and create a separate config <code>my-site.conf</code> file for it.</em></p>
<p><strong>In case of Apache:</strong> :P</p>
<p>3 - Run your <code>docker-compose up</code> command and you&rsquo;re ready to go.</p>
<p><strong>In case of Apache:</strong> :P
<br></p>
<p><em>Note: if you already had your containers up, you might need to take them down first and rebuild them for the changes to take effect.</em></p>
<blockquote>
<p><strong>Now jump to the <a href="#Usage">Usage</a> section.</strong></p>
<p>1 - Run Containers: <em>(Make sure you are in the <code>laradock</code> folder before running the <code>docker-compose</code> commands).</em></p>
<p>1 - Enter the laradock folder and rename <code>env-example</code> to <code>.env</code></p>
<p><strong>Example:</strong> Running NGINX and MySQL:</p>
<p>You can edit the <code>.env</code> file to chose which software&rsquo;s you want to be installed in your environment. You can always refer to the <code>docker-compose.yml</code> file to see how those variables are been used.</p>
<p>2 - Build the enviroment and run it using <code>docker-compose</code></p>
<p>In this example we&rsquo;ll see how to run NGINX (web server) and MySQL (database engine) to host a PHP Web Scripts:</p>
<pre><code class="language-bash">docker-compose up -d nginx mysql
</code></pre>
<p><strong>Note</strong>: The <code>workspace</code> and <code>php-fpm</code> will run automatically in most of the cases, so no need to specify them in the <code>up</code> command. If you couldn&rsquo;t find them running then you need specify them as follow: <code>docker-compose up -d nginx php-fpm mysql workspace</code>.</p>
<p>You can select your own combination of Containers form the list below:</p>
<p>You can select your own combination of containers form the list below:</p>
<p><em>(Please note that sometimes we forget to update the docs, so check the <code>docker-compose.yml</code> file to see an updated list of all available containers).</em></p>
<p><br>
2 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, &hellip;).</p>
3 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, &hellip;)</p>
<p><em>You can change the PUID (User id) and PGID (group id) variables from the <code>docker-compose.yml</code> or the <code>.env</code>)</em></p>
<p><em>You can change the PUID (User id) and PGID (group id) variables from the <code>.env</code> file)</em></p>
<p><br>
3 - Edit your project configurations.</p>
4 - Update your project configurations to use the database host</p>
<p>Open your <code>.env</code> file and set the<code>DB_HOST</code> to <code>mysql</code>:</p>
<p>Open your PHP project&rsquo;s <code>.env</code> file or whichever configuration file you are reading from, and set the database host<code>DB_HOST</code> to <code>mysql</code>:</p>
<p><em>If you want to install Laravel as PHP project, see <a href="#Install-Laravel">How to Install Laravel in a Docker Container</a>.</em></p>
<p><br>
4 - Open your browser and visit your localhost address <code>http://localhost/</code>.</p>
5 - Open your browser and visit your localhost address <code>http://localhost/</code>. If you followed the multiple projects setup, you can visit <code>http://project-1.dev/</code> and <code>http://project-2.dev/</code>. But first don&rsquo;t</p>