Skip to content

Commit 8246863

Browse files
Partly reverting 690137a
1 parent d448730 commit 8246863

11 files changed

Lines changed: 235 additions & 229 deletions

File tree

DOCUMENTATION/content/getting-started/index.md

Lines changed: 32 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -4,45 +4,42 @@ type: index
44
weight: 2
55
---
66

7-
## Requirements
7+
# Requirements
88

99
- [Git](https://git-scm.com/downloads)
1010
- [Docker](https://www.docker.com/products/docker/) `>= 1.12`
1111

12+
# Installation
1213

14+
Choose the setup the best suits your needs.
1315

16+
- [A) Setup for Single Project](#A)
1417

18+
- [A.1) Already have a PHP project](#A1)
1519

20+
- [A.2) Don't have a PHP project yet](#A2)
1621

17-
18-
## Installation
19-
20-
Choose the setup the best suits your needs.
21-
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)
2522
- [B) Setup for Multiple Projects](#B)
2623

24+
[]()
25+
26+
## A) Setup for Single Project
2727

28-
<a name="A"></a>
29-
### A) Setup for Single Project
3028
> (Follow these steps if you want a separate Docker environment for each project)
3129
30+
[]()
3231

33-
<a name="A1"></a>
34-
### A.1) Already have a PHP project:
32+
## A.1) Already have a PHP project:
3533

3634
1 - Clone laradock on your project root directory:
3735

3836
```bash
3937
git submodule add https://github.com/Laradock/laradock.git
4038
```
4139

42-
Note: If you are not using Git yet for your project, you can use `git clone` instead of `git submodule `.
43-
44-
*To keep track of your Laradock changes, between your projects and also keep Laradock updated [check these docs](/documentation/#keep-track-of-your-laradock-changes)*
40+
Note: If you are not using Git yet for your project, you can use `git clone` instead of `git submodule`.
4541

42+
_To keep track of your Laradock changes, between your projects and also keep Laradock updated [check these docs](/documentation/#keep-track-of-your-laradock-changes)_
4643

4744
Your folder structure should look like this:
4845

@@ -53,12 +50,13 @@ Your folder structure should look like this:
5350
+ laradock-b
5451
```
5552

56-
*(It's important to rename the laradock folders to unique name in each project, if you want to run laradock per project).*
53+
_(It's important to rename the laradock folders to unique name in each project, if you want to run laradock per project)._
5754

5855
> **Now jump to the [Usage](#Usage) section.**
5956
60-
<a name="A2"></a>
61-
### A.2) Don't have a PHP project yet:
57+
[]()
58+
59+
## A.2) Don't have a PHP project yet:
6260

6361
1 - Clone this repository anywhere on your machine:
6462

@@ -84,19 +82,20 @@ cp env-example .env
8482
At the top, change the `APPLICATION` variable to your project path.
8583

8684
```
87-
APPLICATION=../project-z/public/
85+
APPLICATION=../project-z/
8886
```
8987

9088
Make sure to replace `project-z` with your project folder name.
9189

9290
> **Now jump to the [Usage](#Usage) section.**
9391
92+
[]()
93+
94+
## B) Setup for Multiple Projects:
9495

95-
<a name="B"></a>
96-
### B) Setup for Multiple Projects:
9796
> (Follow these steps if you want a single Docker environment for all your project)
9897
99-
1 - Clone this repository anywhere on your machine (similar to [Steps A.2. from above](#A2)):
98+
1 - Clone this repository anywhere on your machine (similar to [Steps A.2\. from above](#A2)):
10099

101100
```bash
102101
git clone https://github.com/laradock/laradock.git
@@ -127,25 +126,20 @@ You can rename the config files, project folders and domains as you like, just m
127126

128127
> **Now jump to the [Usage](#Usage) section.**
129128
129+
[]()
130130

131-
132-
133-
134-
135-
136-
<a name="Usage"></a>
137-
## Usage
131+
# Usage
138132

139133
**Read Before starting:**
140134

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

143137
- Upgrade to Docker [Native](https://www.docker.com/products/docker) for Mac/Windows (Recommended). Check out [Upgrading Laradock](/documentation/#upgrading-laradock)
144-
- Use Laradock v3.\*. Visit the [Laradock-ToolBox](https://github.com/laradock/laradock/tree/Laradock-ToolBox) branch. *(outdated)*
138+
- Use Laradock v3.*. Visit the [Laradock-ToolBox](https://github.com/laradock/laradock/tree/Laradock-ToolBox) branch. _(outdated)_
145139

146140
<br>
147141

148-
>**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.
142+
> **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.
149143
150144
<br>
151145

@@ -157,7 +151,6 @@ cp env-example .env
157151

158152
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.
159153

160-
161154
2 - Build the enviroment and run it using `docker-compose`
162155

163156
In this example we'll see how to run NGINX (web server) and MySQL (database engine) to host a PHP Web Scripts:
@@ -168,11 +161,9 @@ docker-compose up -d nginx mysql
168161

169162
**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`.
170163

171-
172164
You can select your own combination of containers form [this list](http://laradock.io/introduction/#supported-software-images).
173165

174-
*(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).*
175-
166+
_(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)._
176167

177168
<br>
178169
3 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, ...)
@@ -181,19 +172,19 @@ You can select your own combination of containers form [this list](http://larado
181172
docker-compose exec workspace bash
182173
```
183174

184-
*Alternatively, for Windows PowerShell users: execute the following command to enter any running container:*
175+
_Alternatively, for Windows PowerShell users: execute the following command to enter any running container:_
185176

186177
```bash
187178
docker exec -it {workspace-container-id} bash
188179
```
189180

190-
**Note:** You can add `--user=laradock` to have files created as your host's user. Example:
181+
**Note:** You can add `--user=laradock` to have files created as your host's user. Example:
191182

192183
```shell
193184
docker-compose exec --user=laradock workspace bash
194185
```
195186

196-
*You can change the PUID (User id) and PGID (group id) variables from the `.env` file)*
187+
_You can change the PUID (User id) and PGID (group id) variables from the `.env` file)_
197188

198189
<br>
199190
4 - Update your project configurations to use the database host
@@ -204,9 +195,7 @@ Open your PHP project's `.env` file or whichever configuration file you are read
204195
DB_HOST=mysql
205196
```
206197

207-
*If you want to install Laravel as PHP project, see [How to Install Laravel in a Docker Container](#Install-Laravel).*
198+
_If you want to install Laravel as PHP project, see [How to Install Laravel in a Docker Container](#Install-Laravel)._
208199

209200
<br>
210-
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
211-
212-
201+
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

0 commit comments

Comments
 (0)