You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ Your contribution is more than welcome. Let's keep LaraDock amazing.
5
5
6
6
### Got a Question or Problem?
7
7
8
-
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 beleave your question could help others, then consider opening an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as Question).
8
+
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).
9
9
10
10
### Found an Issue?
11
11
If you find a bug in the source code or a mistake in the documentation, you can help us by
Copy file name to clipboardExpand all lines: README.md
+32-32Lines changed: 32 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
Laradock is a Docker PHP development environment. It facilitate running **PHP** Apps on **Docker**.
8
8
9
-
Laradock is configured to run Laravel Apps by default, and it can be modifyed to run all kinds of PHP Apps (Symfony, Codeigniter, Wordpress, Drupal...).
9
+
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...).
10
10
11
11
>Use Docker first and learn about it later.
12
12
@@ -41,7 +41,7 @@ Laradock is configured to run Laravel Apps by default, and it can be modifyed to
41
41
- [Change the PHP-FPM Version](#Change-the-PHP-FPM-Version)
42
42
- [Change the PHP-CLI Version](#Change-the-PHP-CLI-Version)
43
43
- [Install xDebug](#Install-xDebug)
44
-
- [Start/Stop xDebug](#Controll-xDebug)
44
+
- [Start/Stop xDebug](#Control-xDebug)
45
45
- [Production](#Production)
46
46
- [Prepare LaraDock for Production](#LaraDock-for-Production)
47
47
- [Setup Laravel and Docker on Digital Ocean](#Digital-Ocean)
@@ -53,8 +53,8 @@ Laradock is configured to run Laravel Apps by default, and it can be modifyed to
53
53
- [Use phpMyAdmin](#Use-phpMyAdmin)
54
54
- [Use pgAdmin](#Use-pgAdmin)
55
55
- [Use ElasticSearch](#Use-ElasticSearch)
56
-
- [Codeigniter](#Codeigniter):
57
-
- [Install Codeigniter](#Install-Codeigniter)
56
+
- [CodeIgniter](#CodeIgniter):
57
+
- [Install CodeIgniter](#Install-CodeIgniter)
58
58
- [Misc](#Misc)
59
59
- [Change the timezone](#Change-the-timezone)
60
60
- [Cron jobs](#CronJobs)
@@ -393,7 +393,7 @@ If you need a special support. Contact me, more details in the [Help & Questions
393
393
```bash
394
394
docker ps
395
395
```
396
-
You can also use the this command if you want to see only this project containers:
396
+
You can also use the following command if you want to see only this project containers:
397
397
398
398
```bash
399
399
docker-compose ps
@@ -438,9 +438,9 @@ docker-compose down
438
438
<aname="Enter-Container"></a>
439
439
### Enter a Container (run commands in a running Container)
440
440
441
-
1 - first list the current running containers with `docker ps`
441
+
1 - First list the current running containers with `docker ps`
@@ -597,7 +597,7 @@ The PHP-CLI extensions should be installed in `workspace/Dockerfile`.
597
597
### Change the (PHP-FPM) Version
598
598
By default **PHP-FPM 7.0** is running.
599
599
600
-
>The PHP-FPM is responsible of serving your application code, you don't have to change the PHP-CLI version if you are planing to run your application on different PHP-FPM version.
600
+
>The PHP-FPM is responsible of serving your application code, you don't have to change the PHP-CLI version if you are planning to run your application on different PHP-FPM version.
601
601
602
602
#### A) Switch from PHP `7.0` to PHP `5.6`
603
603
@@ -656,7 +656,7 @@ We do not natively support PHP 5.5 anymore, but you can get it in few steps:
656
656
### Change the PHP-CLI Version
657
657
By default **PHP-CLI 7.0** is running.
658
658
659
-
>Note: it's not very essential to edit the PHP-CLI verion. The PHP-CLI is only used for the Artisan Commands & Composer. It doesn't serve your Application code, this is the PHP-FPM job.
659
+
>Note: it's not very essential to edit the PHP-CLI version. The PHP-CLI is only used for the Artisan Commands & Composer. It doesn't serve your Application code, this is the PHP-FPM job.
660
660
661
661
The PHP-CLI is installed in the Workspace container. To change the PHP-CLI version you need to edit the `workspace/Dockerfile`.
662
662
@@ -712,12 +712,12 @@ For information on how to configure xDebug with your IDE and work it out, check
712
712
713
713
714
714
<br>
715
-
<aname="Controll-xDebug"></a>
715
+
<aname="Control-xDebug"></a>
716
716
### Start/Stop xDebug:
717
717
718
718
By installing xDebug, you are enabling it to run on startup by default.
719
719
720
-
To controll 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):
720
+
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):
721
721
722
722
- Stop xDebug from running by default: `./xdebugPhpFpm stop`.
723
723
- Start xDebug by default: `./xdebugPhpFpm start`.
@@ -737,7 +737,7 @@ To controll the behavior of xDebug (in the `php-fpm` Container), you can run the
737
737
<aname="LaraDock-for-Production"></a>
738
738
### Prepare LaraDock for Production
739
739
740
-
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 exampe: `docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...`).
740
+
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 exampe: `docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...`).
741
741
742
742
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:
743
743
@@ -797,7 +797,7 @@ For more about the Laravel installation click [here](https://laravel.com/docs/ma
797
797
798
798
3 - Edit `docker-compose.yml` to Map the new application path:
799
799
800
-
By default LaraDock assumes the Laravel application is living in the parent directory of the laradock folder.
800
+
By default, LaraDock assumes the Laravel application is living in the parent directory of the laradock folder.
801
801
802
802
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:
803
803
@@ -814,7 +814,7 @@ Since the new Laravel application is in the `my-cool-app` folder, we need to rep
814
814
cd my-cool-app
815
815
```
816
816
817
-
5 - Go back to the laraDock installation steps to see how to edit the `.env` file.
817
+
5 - Go back to the LaraDock installation steps to see how to edit the `.env` file.
818
818
819
819
820
820
@@ -873,7 +873,7 @@ docker-compose up -d redis
873
873
REDIS_HOST=redis
874
874
```
875
875
876
-
If you don't find the `REDIS_HOST` variable in your `.env` file. Go to the database config file `config/database.php` and replace the default `127.0.0.1` IP with `redis` for Redis like this:
876
+
If you don't find the `REDIS_HOST` variable in your `.env` file. Go to the database configuration file `config/database.php` and replace the default `127.0.0.1` IP with `redis` for Redis like this:
877
877
878
878
```php
879
879
'redis' => [
@@ -953,7 +953,7 @@ docker-compose up -d mongo
953
953
```
954
954
955
955
956
-
4 - Add the MongoDB configurations to the `config/database.php`config file:
956
+
4 - Add the MongoDB configurations to the `config/database.php`configuration file:
To install Codeigniter 3 on Laradock all you have to do is the following simple steps:
1076
+
To install CodeIgniter 3 on Laradock all you have to do is the following simple steps:
1077
1077
1078
1078
1 - Open the `docker-compose.yml` file.
1079
1079
@@ -1175,7 +1175,7 @@ Modify the `mysql/my.cnf` file to set your port number, `1234` is used as an exa
1175
1175
port=1234
1176
1176
```
1177
1177
1178
-
If you need <ahref="#MySQL-access-from-host">MySQL access from your host</a>, do not forget to change the internal port number (`"3306:3306"` -> `"3306:1234"`) in the docker-compose config file.
1178
+
If you need <ahref="#MySQL-access-from-host">MySQL access from your host</a>, do not forget to change the internal port number (`"3306:3306"` -> `"3306:1234"`) in the docker-compose configuration file.
1179
1179
1180
1180
<aname="Use-custom-Domain"></a>
1181
1181
### Use custom Domain (instead of the Docker IP)
@@ -1191,7 +1191,7 @@ Assuming your custom domain is `laravel.dev`
1191
1191
2 - Open your browser and visit `{http://laravel.dev}`
1192
1192
1193
1193
1194
-
Optionally you can define the server name in the nginx config file, like this:
1194
+
Optionally you can define the server name in the nginx configuration file, like this:
1195
1195
1196
1196
```conf
1197
1197
server_name laravel.dev;
@@ -1205,9 +1205,9 @@ server_name laravel.dev;
1205
1205
1206
1206
Enabling Global Composer Install during the build for the container allows you to get your composer requirements installed and available in the container after the build is done.
1207
1207
1208
-
1 - open the `docker-compose.yml` file
1208
+
1 - Open the `docker-compose.yml` file
1209
1209
1210
-
2 - search for the `COMPOSER_GLOBAL_INSTALL` argument under the Workspace Container and set it to `true`
1210
+
2 - Search for the `COMPOSER_GLOBAL_INSTALL` argument under the Workspace Container and set it to `true`
1211
1211
1212
1212
It should be like this:
1213
1213
@@ -1219,9 +1219,9 @@ It should be like this:
1219
1219
- COMPOSER_GLOBAL_INSTALL=true
1220
1220
...
1221
1221
```
1222
-
3 - now add your dependencies to `workspace/composer.json`
1222
+
3 - Now add your dependencies to `workspace/composer.json`
1223
1223
1224
-
4 - rebuild the Workspace Container `docker-compose build workspace`
1224
+
4 - Re-build the Workspace Container `docker-compose build workspace`
1225
1225
1226
1226
1227
1227
@@ -1238,11 +1238,11 @@ Click on this [Enable Global Composer Build Install](#Enable-Global-Composer-Bui
1238
1238
1239
1239
2 - Add prestissimo as requirement in Composer:
1240
1240
1241
-
a - now open the `workspace/composer.json` file
1241
+
a - Now open the `workspace/composer.json` file
1242
1242
1243
-
b - add`"hirak/prestissimo": "^0.3"` as requirement
1243
+
b - Add`"hirak/prestissimo": "^0.3"` as requirement
1244
1244
1245
-
c - rebuild the Workspace Container `docker-compose build workspace`
1245
+
c - Re-build the Workspace Container `docker-compose build workspace`
1246
1246
1247
1247
1248
1248
@@ -1378,7 +1378,7 @@ Make sure the ports for the services that you are trying to run (22, 80, 443, 33
1378
1378
1379
1379
#### I get Mysql connection refused
1380
1380
1381
-
This error is sometimes happens because your Laravel application isn't running on the container localhost IP (Which is 127.0.0.1). Steps to fix it:
1381
+
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:
1382
1382
1383
1383
* Option A
1384
1384
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.
@@ -1414,7 +1414,7 @@ Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requ
1414
1414
<br>
1415
1415
## Contributing
1416
1416
1417
-
This little project was built by one man who has a full time job and many responsibilities, so if you like this project and you find that it needs a bug fix or support for new software or upgrade any container, or anything else.. Do not hesitate to contribute, you are more than welcome :)
1417
+
This little project was built by one man who has a full time job and many responsibilities, so if you like this project and you find that it needs a bug fix or support for new software or upgrade any container, or anything else, do not hesitate to contribute, you are more than welcome :)
1418
1418
1419
1419
#### Read the [Contribution Guidelines](https://github.com/LaraDock/laradock/blob/master/CONTRIBUTING.md).
0 commit comments