Skip to content

Commit e0e4616

Browse files
committed
update installation steps in the docs (.env)
1 parent c00fe5d commit e0e4616

22 files changed

Lines changed: 519 additions & 328 deletions

File tree

docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ services:
77
applications:
88
image: tianon/true
99
volumes:
10-
- ${APPLICATIONS_HOST_DIR}:/var/www
10+
- ${APPLICATION_1}:/var/www
1111

1212
### Workspace Utilities Container ###########################
1313

docs/_settings/content/contributing/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Your contribution is more than welcome.
99

1010
## Got a Question or Problem?
1111

12-
If you have questions about how to use LaraDock, please direct your questions to the discussion on [Gitter](https://gitter.im/LaraDock/laradock). If you believe your question could help others, then consider opening an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as Question).
12+
If you have questions about how to use Laradock, please direct your questions to the discussion on [Gitter](https://gitter.im/Laradock/laradock). If you believe your question could help others, then consider opening an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as Question).
1313

1414
## Found an Issue?
1515
If you find a bug in the source code or a mistake in the documentation, you can help us by
@@ -62,7 +62,7 @@ Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Ma
6262
* Edit the files you want to update.
6363

6464
* **Note:** If you want to edit the base image of the `Workspace` or the `php-fpm` Containers,
65-
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the LaraDock repository.
65+
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.
6666

6767
* Make sure to update the `Readme` in case you made any changes.
6868

docs/_settings/content/documentation/index.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ For information on how to configure xDebug with your IDE and work it out, check
329329

330330
By installing xDebug, you are enabling it to run on startup by default.
331331

332-
To control the behavior of xDebug (in the `php-fpm` Container), you can run the following commands from the LaraDock root folder, (at the same prompt where you run docker-compose):
332+
To control the behavior of xDebug (in the `php-fpm` Container), you can run the following commands from the Laradock root folder, (at the same prompt where you run docker-compose):
333333

334334
- Stop xDebug from running by default: `./xdebugPhpFpm stop`.
335335
- Start xDebug by default: `./xdebugPhpFpm start`.
@@ -381,10 +381,10 @@ It should be like this:
381381

382382

383383
<br>
384-
<a name="LaraDock-for-Production"></a>
385-
## Prepare LaraDock for Production
384+
<a name="Laradock-for-Production"></a>
385+
## Prepare Laradock for Production
386386

387-
It's recommended for production to create a custom `docker-compose.yml` file. For that reason, LaraDock is shipped with `production-docker-compose.yml` which should contain only the containers you are planning to run on production (usage example: `docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...`).
387+
It's recommended for production to create a custom `docker-compose.yml` file. For that reason, Laradock is shipped with `production-docker-compose.yml` which should contain only the containers you are planning to run on production (usage example: `docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...`).
388388

389389
Note: The Database (MySQL/MariaDB/...) ports should not be forwarded on production, because Docker will automatically publish the port on the host, which is quite insecure, unless specifically told not to. So make sure to remove these lines:
390390

@@ -439,7 +439,7 @@ For more about the Laravel installation click [here](https://laravel.com/docs/ma
439439

440440
3 - Edit `docker-compose.yml` to Map the new application path:
441441

442-
By default, LaraDock assumes the Laravel application is living in the parent directory of the laradock folder.
442+
By default, Laradock assumes the Laravel application is living in the parent directory of the laradock folder.
443443

444444
Since the new Laravel application is in the `my-cool-app` folder, we need to replace `../:/var/www` with `../my-cool-app/:/var/www`, as follow:
445445

@@ -456,7 +456,7 @@ Since the new Laravel application is in the `my-cool-app` folder, we need to rep
456456
cd my-cool-app
457457
```
458458

459-
5 - Go back to the LaraDock installation steps to see how to edit the `.env` file.
459+
5 - Go back to the Laradock installation steps to see how to edit the `.env` file.
460460

461461

462462

@@ -581,7 +581,7 @@ composer require predis/predis:^1.0
581581
5 - You can manually test it from Laravel with this code:
582582

583583
```php
584-
\Cache::store('redis')->put('LaraDock', 'Awesome', 10);
584+
\Cache::store('redis')->put('Laradock', 'Awesome', 10);
585585
```
586586

587587

@@ -893,7 +893,7 @@ docker-compose up -d minio
893893
<a name="Install-CodeIgniter"></a>
894894
## Install CodeIgniter
895895

896-
To install CodeIgniter 3 on LaraDock all you have to do is the following simple steps:
896+
To install CodeIgniter 3 on Laradock all you have to do is the following simple steps:
897897

898898
1 - Open the `docker-compose.yml` file.
899899

@@ -1198,7 +1198,7 @@ It should be like this:
11981198
<a name="Common-Aliases"></a>
11991199
<br>
12001200
## Common Terminal Aliases
1201-
When you start your docker container, LaraDock will copy the `aliases.sh` file located in the `laradock/workspace` directory and add sourcing to the container `~/.bashrc` file.
1201+
When you start your docker container, Laradock will copy the `aliases.sh` file located in the `laradock/workspace` directory and add sourcing to the container `~/.bashrc` file.
12021202

12031203
You are free to modify the `aliases.sh` as you see fit, adding your own aliases (or function macros) to suit your requirements.
12041204

@@ -1292,10 +1292,10 @@ Remote debug Laravel web and phpunit tests.
12921292

12931293

12941294
<br>
1295-
<a name="keep-tracking-LaraDock"></a>
1296-
## Keep track of your LaraDock changes
1295+
<a name="keep-tracking-Laradock"></a>
1296+
## Keep track of your Laradock changes
12971297

1298-
1. Fork the LaraDock repository.
1298+
1. Fork the Laradock repository.
12991299
2. Use that fork as a submodule.
13001300
3. Commit all your changes to your fork.
13011301
4. Pull new stuff from the main repository from time to time.
@@ -1308,14 +1308,14 @@ Remote debug Laravel web and phpunit tests.
13081308

13091309
<br>
13101310
<a name="upgrading-laradock"></a>
1311-
## Upgrading LaraDock
1311+
## Upgrading Laradock
13121312

1313-
Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading LaraDock from v3.* to v4.*:
1313+
Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading Laradock from v3.* to v4.*:
13141314

13151315
1. Stop the docker VM `docker-machine stop {default}`
13161316
2. Install Docker for [Mac](https://docs.docker.com/docker-for-mac/) or [Windows](https://docs.docker.com/docker-for-windows/).
1317-
3. Upgrade LaraDock to `v4.*.*` (`git pull origin master`)
1318-
4. Use LaraDock as you used to do: `docker-compose up -d nginx mysql`.
1317+
3. Upgrade Laradock to `v4.*.*` (`git pull origin master`)
1318+
4. Use Laradock as you used to do: `docker-compose up -d nginx mysql`.
13191319

13201320
**Note:** If you face any problem with the last step above: rebuild all your containers
13211321
`docker-compose build --no-cache`
@@ -1454,4 +1454,4 @@ This error sometimes happens because your Laravel application isn't running on t
14541454
1. Check your running Laravel application IP by dumping `Request::ip()` variable using `dd(Request::ip())` anywhere on your application. The result is the IP of your Laravel container.
14551455
2. Change the `DB_HOST` variable on env with the IP that you received from previous step.
14561456
* Option B
1457-
1. Change the `DB_HOST` value to the same name as the MySQL docker container. The LaraDock docker-compose file currently has this as `mysql`
1457+
1. Change the `DB_HOST` value to the same name as the MySQL docker container. The Laradock docker-compose file currently has this as `mysql`

docs/_settings/content/getting-started/index.md

Lines changed: 44 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,35 @@ weight: 2
1919

2020
Choose the setup the best suits your needs.
2121

22-
#### A) Setup for Single Project:
23-
*(In case you want a Docker environment for each project)*
22+
- [A) Setup for Single Project](#A)
23+
- [A.1) Already have a PHP project](#A1)
24+
- [A.2) Don't have a PHP project yet](#A2)
25+
- [B) Setup for Multiple Projects](#B)
2426

25-
##### A.1) Setup environment in existing Project:
26-
*(In case you already have a project, and you want to setup an environment to run it)*
2727

28-
1 - Clone this repository on your project root directory:
28+
<a name="A"></a>
29+
#### A) Setup for Single Project
30+
> (Follow these steps if you want a separate Docker environment for each project)
31+
32+
33+
<a name="A1"></a>
34+
##### A.1) Already have a PHP project:
35+
> (Follow these steps if you already have a PHP project, and all you need is an environment to run it)
36+
37+
1 - Clone laradock on your project root directory:
2938

3039
```bash
3140
git submodule add https://github.com/Laradock/laradock.git
3241
```
3342

34-
*Note 1: If you are not yet using Git for your PHP project, you can use `git clone https://github.com/Laradock/laradock.git` instead.*
43+
**Notes:**
44+
45+
- If you are not using Git yet for your project, you can use `git clone` instead of `git submodule `.
3546

36-
*Note 2: To keep track of your LaraDock changes, between your projects and also keep LaraDock updated. [Check this](#keep-tracking-LaraDock)*
47+
- Note 2: To keep track of your Laradock changes, between your projects and also keep Laradock updated. [Check this](#keep-tracking-Laradock)
3748

38-
*Note 3: In this case the folder structure will be like this:*
49+
50+
Your folder structure should look like this:
3951

4052
```
4153
- project1
@@ -44,15 +56,18 @@ git submodule add https://github.com/Laradock/laradock.git
4456
- laradock
4557
```
4658

47-
##### A.2) Setup environment first then create project:
48-
*(In case you don't have a project, and you want to create your project inside the Docker environment)*
59+
60+
<a name="A2"></a>
61+
##### A.2) Don't have a PHP project yet:
62+
> (Follow these steps if you don't have a PHP project yet, and you need an environment to create the project)
4963
5064
1 - Clone this repository anywhere on your machine:
5165

5266
```bash
5367
git clone https://github.com/laradock/laradock.git
5468
```
55-
Note: In this case the folder structure will be like this:
69+
70+
Your folder structure should look like this:
5671

5772
```
5873
- projects
@@ -68,20 +83,20 @@ Note: In this case the folder structure will be like this:
6883
docker-compose stop && docker-compose up -d XXXX YYYY ZZZZ ....
6984
```
7085

71-
86+
<a name="B"></a>
7287
#### B) Setup for Multiple Projects:
88+
> (Follow these steps if you want a single Docker environment for all project)
7389
7490
1 - Clone this repository anywhere on your machine:
7591

7692
```bash
7793
git clone https://github.com/laradock/laradock.git
7894
```
7995

80-
2 - Edit the `docker-compose.yml` file to map to your projects directories:
96+
2 - Edit the `docker-compose.yml` (or the `.env`) file to map to your projects directories:
8197

8298
```
8399
applications:
84-
image: tianon/true
85100
volumes:
86101
- ../project1/:/var/www/project1
87102
- ../project2/:/var/www/project2
@@ -120,12 +135,12 @@ Do the same for each project `project2.conf`, `project3.conf`,...
120135

121136
If you are using **Docker Toolbox** (VM), do one of the following:
122137

123-
- Upgrade to Docker [Native](https://www.docker.com/products/docker) for Mac/Windows (Recommended). Check out [Upgrading LaraDock](#upgrading-laradock)
124-
- Use LaraDock v3.* (Visit the `LaraDock-ToolBox` [Branch](https://github.com/laradock/laradock/tree/LaraDock-ToolBox)).
138+
- Upgrade to Docker [Native](https://www.docker.com/products/docker) for Mac/Windows (Recommended). Check out [Upgrading Laradock](#upgrading-laradock)
139+
- Use Laradock v3.* (Visit the `Laradock-ToolBox` [Branch](https://github.com/laradock/laradock/tree/Laradock-ToolBox)).
125140

126141
<br>
127142

128-
>**Warning:** If you used an older version of LaraDock it's highly recommended to rebuild the containers you need to use [see how you rebuild a container](#Build-Re-build-Containers) in order to prevent errors as much as possible.
143+
>**Warning:** If you used an older version of Laradock it's highly recommended to rebuild the containers you need to use [see how you rebuild a container](#Build-Re-build-Containers) in order to prevent as much errors as possible.
129144
130145
<br>
131146

@@ -143,7 +158,9 @@ docker-compose up -d nginx mysql
143158

144159
You can select your own combination of Containers form the list below:
145160

146-
`nginx`, `hhvm`, `php-fpm`, `mysql`, `redis`, `postgres`, `mariadb`, `neo4j`, `mongo`, `apache2`, `caddy`, `memcached`, `beanstalkd`, `beanstalkd-console`, `rabbitmq`, `workspace`, `phpmyadmin`, `aerospike`, `pgadmin`, `elasticsearch`, `rethinkdb`.
161+
`nginx`, `hhvm`, `php-fpm`, `mysql`, `redis`, `postgres`, `mariadb`, `neo4j`, `mongo`, `apache2`, `caddy`, `memcached`, `beanstalkd`, `beanstalkd-console`, `rabbitmq`, `beanstalkd-console`, `workspace`, `phpmyadmin`, `aerospike`, `pgadmin`, `elasticsearch`, `rethinkdb`, `postgres-postgis`, `certbot`, `mailhog`, `minio` and more...!
162+
163+
*(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).*
147164

148165

149166
<br>
@@ -159,7 +176,13 @@ Alternatively, for Windows PowerShell users: execute the following command to en
159176
docker exec -it {workspace-container-id} bash
160177
```
161178

162-
**Note:** You can add `--user=laradock` (example `docker-compose exec --user=laradock workspace bash`) to have files created as your host's user. (you can change the PUID (User id) and PGID (group id) variables from the `docker-compose.yml`).
179+
**Note:** You can add `--user=laradock` to have files created as your host's user. Example:
180+
181+
```shell
182+
docker-compose exec --user=laradock workspace bash
183+
```
184+
185+
*You can change the PUID (User id) and PGID (group id) variables from the `docker-compose.yml` or the `.env`)*
163186

164187
<br>
165188
3 - Edit your project configurations.
@@ -170,12 +193,7 @@ Open your `.env` file and set the `DB_HOST` to `mysql`:
170193
DB_HOST=mysql
171194
```
172195

173-
*If you want to use Laravel and you don't have it installed yet, see [How to Install Laravel in a Docker Container](#Install-Laravel).*
196+
*If you want to install Laravel as PHP project, see [How to Install Laravel in a Docker Container](#Install-Laravel).*
174197

175198
<br>
176-
4 - Open your browser and visit your localhost address (`http://localhost/`).
177-
178-
<br>
179-
**Debugging**: if you are facing any problem here check the [Debugging](#debugging) section.
180-
181-
If you need a special support. Contact me, more details in the [Help & Questions](#Help) section.
199+
4 - Open your browser and visit your localhost address `http://localhost/`.

docs/_settings/content/help/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ type: index
44
weight: 5
55
---
66

7-
Join the chat room on [Gitter](https://gitter.im/LaraDock/laradock) and get help and support from the community.
7+
Join the chat room on [Gitter](https://gitter.im/Laradock/laradock) and get help and support from the community.
88

9-
You can as well can open an [issue](https://github.com/laradock/laradock/issues) on Github (will be labeled as Question) and discuss it with people on [Gitter](https://gitter.im/LaraDock/laradock).
9+
You can as well can open an [issue](https://github.com/laradock/laradock/issues) on Github (will be labeled as Question) and discuss it with people on [Gitter](https://gitter.im/Laradock/laradock).

docs/_settings/content/introduction/index.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ type: index
44
weight: 1
55
---
66

7-
LaraDock strives to make the PHP development experience easier and faster.
7+
Laradock strives to make the PHP development experience easier and faster.
88

99
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 machines.
1010

11-
LaraDock is configured to run Laravel Apps by default, and it can be modified to run all kinds of PHP Apps (Symfony, CodeIgniter, WordPress, Drupal...).
11+
Laradock is configured to run Laravel Apps by default, and it can be modified to run all kinds of PHP Apps (Symfony, CodeIgniter, WordPress, Drupal...).
1212

1313

1414

@@ -17,19 +17,25 @@ LaraDock is configured to run Laravel Apps by default, and it can be modified to
1717

1818
Let's see how easy it is to install `NGINX`, `PHP`, `Composer`, `MySQL`, `Redis` and `beanstalkd`:
1919

20-
1 - Clone LaraDock inside your PHP project:
20+
1 - Clone Laradock inside your PHP project:
2121

2222
```shell
2323
git clone https://github.com/Laradock/laradock.git
2424
```
2525

26-
2 - Enter the laradock folder and run this command:
26+
2 - Enter the laradock folder and rename `env-example` to `.env`.
27+
28+
```shell
29+
cp env-example .env
30+
```
31+
32+
3 - Run your containers:
2733

2834
```shell
2935
docker-compose up -d nginx mysql redis beanstalkd
3036
```
3137

32-
3 - Open your `.env` file and set the following:
38+
3 - Open your project's `.env` file and set the following:
3339

3440
```shell
3541
DB_HOST=mysql
@@ -76,17 +82,17 @@ Most importantly Docker can run on Development and on Production (same environme
7682
7783
7884
<a name="laradock-vs-homestead"></a>
79-
## LaraDock VS Homestead (For Laravel Developers)
85+
## Laradock VS Homestead (For Laravel Developers)
8086
81-
> LaraDock It's like Laravel Homestead but for Docker instead of Vagrant.
87+
> Laradock It's like Laravel Homestead but for Docker instead of Vagrant.
8288

83-
LaraDock and [Homestead](https://laravel.com/docs/master/homestead) both give you complete virtual development environments. (Without the need to install and configure every single software on your own Operating System).
89+
Laradock and [Homestead](https://laravel.com/docs/master/homestead) both give you complete virtual development environments. (Without the need to install and configure every single software on your own Operating System).
8490

8591
- Homestead is a tool that controls Vagrant for you (using Homestead special commands). And Vagrant manages your Virtual Machine.
8692

87-
- LaraDock is a tool that controls Docker for you (using Docker & Docker Compose official commands). And Docker manages your Virtual Containers.
93+
- Laradock is a tool that controls Docker for you (using Docker & Docker Compose official commands). And Docker manages your Virtual Containers.
8894

89-
Running a virtual container is much faster than running a full virtual Machine. Thus **LaraDock is much faster than Homestead**.
95+
Running a virtual container is much faster than running a full virtual Machine. Thus **Laradock is much faster than Homestead**.
9096

9197

9298

@@ -100,10 +106,10 @@ Running a virtual container is much faster than running a full virtual Machine.
100106

101107
What's better than a **Demo Video**:
102108
103-
- LaraDock [v4.*](https://www.youtube.com/watch?v=TQii1jDa96Y)
104-
- LaraDock [v2.*](https://www.youtube.com/watch?v=-DamFMczwDA)
105-
- LaraDock [v0.3](https://www.youtube.com/watch?v=jGkyO6Is_aI)
106-
- LaraDock [v0.1](https://www.youtube.com/watch?v=3YQsHe6oF80)
109+
- Laradock [v4.*](https://www.youtube.com/watch?v=TQii1jDa96Y)
110+
- Laradock [v2.*](https://www.youtube.com/watch?v=-DamFMczwDA)
111+
- Laradock [v0.3](https://www.youtube.com/watch?v=jGkyO6Is_aI)
112+
- Laradock [v0.1](https://www.youtube.com/watch?v=3YQsHe6oF80)
107113
108114
109115
@@ -139,11 +145,12 @@ What's better than a **Demo Video**:
139145
140146
- **Database Engines:**
141147
- MySQL
142-
- PostgreSQL
143148
- MariaDB
144149
- MongoDB
145150
- Neo4j
146151
- RethinkDB
152+
- PostgreSQL
153+
- Postgres Postgis
147154
- **Cache Engines:**
148155
- Redis
149156
- Memcached
@@ -165,6 +172,8 @@ What's better than a **Demo Video**:
165172
- PgAdmin
166173
- ElasticSearch
167174
- Selenium
175+
- Certbot
176+
- Mailhog
168177
- Minio
169178
- Workspace
170179
- PHP7-CLI
@@ -194,4 +203,4 @@ What's better than a **Demo Video**:
194203

195204
You are welcome to join our chat room on Gitter.
196205

197-
[![Gitter](https://badges.gitter.im/LaraDock/laradock.svg)](https://gitter.im/LaraDock/laradock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
206+
[![Gitter](https://badges.gitter.im/Laradock/laradock.svg)](https://gitter.im/Laradock/laradock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

0 commit comments

Comments
 (0)