Skip to content

Commit 8f44a08

Browse files
committed
add Keep track of your Laradock changes section to the docs
1 parent 9348dd9 commit 8f44a08

1 file changed

Lines changed: 79 additions & 56 deletions

File tree

README.md

Lines changed: 79 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ Laradock is configured to run Laravel Apps by default, and it can be modified to
5959
- [Change the PHP-CLI Version](#Change-the-PHP-CLI-Version)
6060
- [Install xDebug](#Install-xDebug)
6161
- [Start/Stop xDebug](#Control-xDebug)
62+
- [Install Deployer](#Install-Deployer)
6263
- [Production](#Production)
6364
- [Prepare LaraDock for Production](#LaraDock-for-Production)
6465
- [Setup Laravel and Docker on Digital Ocean](#Digital-Ocean)
@@ -90,17 +91,19 @@ Laradock is configured to run Laravel Apps by default, and it can be modified to
9091
- [Install Node + YARN](#Install-Yarn)
9192
- [Install Linuxbrew](#Install-Linuxbrew)
9293
- [Common Terminal Aliases](#Common-Aliases)
93-
- [Install Deployer](#Install-Deployer)
94-
- [Debugging](#debugging)
94+
- [Install Aerospike extension](#Install-Aerospike-Extension)
95+
- [Install Laravel Envoy](#Install-Laravel-Envoy)
96+
- [PHPStorm Debugging Guide](#phpstorm-debugging)
97+
- [Keep track of your Laradock changes](#keep-tracking-Laradock)
9598
- [Upgrading LaraDock](#upgrading-laradock)
99+
- [Common Problems](#Common-Problems)
96100
- [Related Projects](#related-projects)
97101
- [Help & Questions](#Help)
98102

99103

100104

101105

102106

103-
104107
### Quick Overview:
105108

106109
Let's see how easy it is to install `NGINX`, `PHP`, `Composer`, `MySQL`, `Redis` and `Beanstalkd`:
@@ -279,7 +282,6 @@ What's better than a **Demo Video**:
279282

280283

281284

282-
283285
<a name="Installation"></a>
284286
## Installation
285287

@@ -294,11 +296,14 @@ Choose the setup the best suits your needs.
294296
1 - Clone this repository on your project root directory:
295297

296298
```bash
297-
git submodule add https://github.com/LaraDock/laradock.git
299+
git submodule add https://github.com/Laradock/laradock.git
298300
```
299-
>If you are not already using Git for your PHP project, you can use `git clone` instead of `git submodule`.
300301

301-
Note: In this case the folder structure will be like this:
302+
*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.*
303+
304+
*Note 2: To keep track of your Laradock changes, between your projects and also keep Laradock updated. [Check this](#keep-tracking-Laradock)*
305+
306+
*Note 3: In this case the folder structure will be like this:*
302307

303308
```
304309
- project1
@@ -794,6 +799,36 @@ To control the behavior of xDebug (in the `php-fpm` Container), you can run the
794799
795800
796801
802+
<br>
803+
<a name="Install-Deployer"></a>
804+
### Install Deployer (Deployment tool for PHP)
805+
806+
1 - Open the `docker-compose.yml` file
807+
<br>
808+
2 - Search for the `INSTALL_DEPLOYER` argument under the Workspace Container
809+
<br>
810+
3 - Set it to `true`
811+
<br>
812+
813+
It should be like this:
814+
815+
```yml
816+
workspace:
817+
build:
818+
context: ./workspace
819+
args:
820+
- INSTALL_DEPLOYER=true
821+
...
822+
```
823+
824+
4 - Re-build the containers `docker-compose build workspace`
825+
826+
######[Deployer Documentation Here](https://deployer.org/docs)
827+
828+
829+
830+
831+
797832
<br>
798833
<a name="Production"></a>
799834
@@ -1299,6 +1334,7 @@ To install CodeIgniter 3 on Laradock all you have to do is the following simple
12991334
13001335
<br>
13011336
<a name="Misc"></a>
1337+
## Miscellaneous
13021338
13031339
13041340
@@ -1660,61 +1696,65 @@ It should be like this:
16601696

16611697
4 - Re-build the containers `docker-compose build workspace`
16621698

1663-
####[Laravel Envoy Documentation Here](https://laravel.com/docs/5.3/envoy)
1699+
######[Laravel Envoy Documentation Here](https://laravel.com/docs/5.3/envoy)
1700+
16641701

16651702

16661703

16671704

1668-
<br>
16691705

1670-
<a name="Install-Deployer"></a>
1671-
### Install Deployer (Deployment tool for PHP)
16721706

1673-
1 - Open the `docker-compose.yml` file
1674-
<br>
1675-
2 - Search for the `INSTALL_DEPLOYER` argument under the Workspace Container
1676-
<br>
1677-
3 - Set it to `true`
16781707
<br>
1708+
<a name="phpstorm-debugging"></a>
1709+
### PHPStorm Debugging Guide
1710+
Remote debug Laravel web and phpunit tests.
1711+
1712+
######[Debugging Guide Here](https://github.com/LaraDock/laradock/blob/master/_guides/phpstorm.md)
1713+
16791714

1680-
It should be like this:
16811715

1682-
```yml
1683-
workspace:
1684-
build:
1685-
context: ./workspace
1686-
args:
1687-
- INSTALL_DEPLOYER=true
1688-
...
1689-
```
16901716

1691-
4 - Re-build the containers `docker-compose build workspace`
16921717

1693-
####[Deployer Documentation Here](https://deployer.org/docs)
16941718

16951719

16961720

16971721
<br>
1722+
<a name="keep-tracking-Laradock"></a>
1723+
### Keep track of your Laradock changes
16981724

1725+
1. Fork the Lardock repository.
1726+
2. Use that fork as a submodule.
1727+
3. Commit all your changes to your fork.
1728+
4. Pull new stuff from the main repo from time to time.
16991729

1700-
<a name="debugging"></a>
17011730

17021731

1703-
### PHPStorm
1704-
Remote debug Laravel web and phpunit tests.
17051732

1706-
####[Full Guide Here](https://github.com/LaraDock/laradock/blob/master/_guides/phpstorm.md)
17071733

17081734

17091735
<br>
1710-
<a name="Misc"></a>
1736+
<a name="upgrading-laradock"></a>
1737+
### Upgrading LaraDock
1738+
1739+
Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading LaraDock from v3.* to v4.*:
1740+
1741+
1. Stop the docker vm `docker-machine stop {default}`
1742+
2. Install Docker for [Mac](https://docs.docker.com/docker-for-mac/) or [Windows](https://docs.docker.com/docker-for-windows/).
1743+
3. Upgrade LaraDock to `v4.*.*` (`git pull origin master`)
1744+
4. Use LaraDock as you used to do: `docker-compose up -d nginx mysql`.
17111745

1746+
**Note:** If you face any problem with the last step above: rebuild all your containers
1747+
`docker-compose build --no-cache`
1748+
"Warnning Containers Data might be lost!"
17121749

17131750

17141751

17151752

17161753

1717-
### Miscellaneous
1754+
1755+
<br>
1756+
<a name="Common-Problems"></a>
1757+
## Common Problems
17181758

17191759
*Here's a list of the common problems you might face, and the possible solutions.*
17201760
@@ -1723,6 +1763,7 @@ Remote debug Laravel web and phpunit tests.
17231763
17241764
17251765
1766+
<br>
17261767
#### I see a blank (white) page instead of the Laravel 'Welcome' page!
17271768
17281769
Run the following command from the Laravel root directory:
@@ -1735,7 +1776,7 @@ sudo chmod -R 777 storage bootstrap/cache
17351776
17361777
17371778
1738-
1779+
<br>
17391780
#### I see "Welcome to nginx" instead of the Laravel App!
17401781
17411782
Use `http://127.0.0.1` instead of `http://localhost` in your browser.
@@ -1744,7 +1785,7 @@ Use `http://127.0.0.1` instead of `http://localhost` in your browser.
17441785
17451786
17461787
1747-
1788+
<br>
17481789
#### I see an error message containing `address already in use` or `port is already allocated`
17491790
17501791
Make sure the ports for the services that you are trying to run (22, 80, 443, 3306, etc.) are not being used already by other programs on the host, such as a built in `apache`/`httpd` service or other development tools you have installed.
@@ -1753,7 +1794,7 @@ Make sure the ports for the services that you are trying to run (22, 80, 443, 33
17531794
17541795
17551796
1756-
1797+
<br>
17571798
#### I get Nginx error 404 Not Found on Windows.
17581799
17591800
1. Go to docker Settings on your Windows machine.
@@ -1764,14 +1805,15 @@ Make sure the ports for the services that you are trying to run (22, 80, 443, 33
17641805
17651806
17661807
1808+
<br>
17671809
#### The time in my services does not match the current time
17681810
17691811
1. Make sure you've [changed the timezone](#Change-the-timezone).
17701812
2. Stop and rebuild the containers (`docker-compose up -d --build <services>`)
17711813

17721814

17731815

1774-
1816+
<br>
17751817
#### I get Mysql connection refused
17761818

17771819
This error sometimes happens because your Laravel application isn't running on the container localhost IP (Which is 127.0.0.1). Steps to fix it:
@@ -1787,25 +1829,6 @@ This error sometimes happens because your Laravel application isn't running on t
17871829
17881830
17891831
1790-
<br>
1791-
<a name="upgrading-laradock"></a>
1792-
### Upgrading LaraDock
1793-
1794-
Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading LaraDock from v3.* to v4.*:
1795-
1796-
1. Stop the docker vm `docker-machine stop {default}`
1797-
2. Install Docker for [Mac](https://docs.docker.com/docker-for-mac/) or [Windows](https://docs.docker.com/docker-for-windows/).
1798-
3. Upgrade LaraDock to `v4.*.*` (`git pull origin master`)
1799-
4. Use LaraDock as you used to do: `docker-compose up -d nginx mysql`.
1800-
1801-
**Note:** If you face any problem with the last step above: rebuild all your containers
1802-
`docker-compose build --no-cache`
1803-
"Warnning Containers Data might be lost!"
1804-
1805-
1806-
1807-
1808-
18091832
18101833
<br>
18111834
## Contributing

0 commit comments

Comments
 (0)