Compare commits

...

225 Commits

Author SHA1 Message Date
f3598c3c97 Merge pull request #805 from bestlong/fixing-php-fpm-ghostscript
Fixing php fpm ghostscript
2017-04-14 03:24:54 -04:00
4fd73ac512 Fix build error in php-fpm containers, after updating the base image 2017-04-14 03:23:19 -04:00
747f956d01 update php-fpm base image tags {requires rebuild} 2017-04-14 03:12:00 -04:00
1519d2c64c Update Dockerfile-71
fixing unexpected message "/bin/sh: 1: [: =: unexpected operator", #798.
2017-04-14 10:09:44 +08:00
43f4f80836 Update Dockerfile-70
fixing unexpected message "/bin/sh: 1: [: =: unexpected operator", #798.
2017-04-14 10:08:44 +08:00
ca7726c441 Update Dockerfile-56
fixing unexpected message "/bin/sh: 1: [: =: unexpected operator", #798.
2017-04-14 10:08:11 +08:00
c78eb5228a Merge pull request #803 from activeobjects/master
Added support for jenkins official container
2017-04-13 11:48:57 -04:00
81053c0868 Added support for jenkins official container 2017-04-12 15:54:42 +00:00
b1367d237f Merge pull request #800 from chrissiboi/master
Update Dockerfile-70
2017-04-12 10:19:34 +02:00
603207cc2b Update Dockerfile-70
fixes a built crash because of an unexpected &&
2017-04-12 10:17:06 +02:00
43e2b3e403 Merge pull request #795 from hounded/master
pdo_dblib
2017-04-12 00:53:51 -04:00
f69422e82f Merge branch 'master' into master 2017-04-12 00:53:43 -04:00
96e82d4115 Merge pull request #793 from winfried-van-loon/php-fpm-56-args
Fixing not-consumed buildargs php-fpm-56
2017-04-11 18:36:13 -07:00
6d4a2c4cc4 Merge pull request #789 from winfried-van-loon/php-fpm-cleanup
Fixing whitespaces and tailing spaces
2017-04-11 18:35:17 -07:00
f8e5f73e18 Merge pull request #794 from winfried-van-loon/xdebug-config
Moving php-fpm xdebug config to proper location
2017-04-11 18:35:03 -07:00
cdc2811d7b Merge pull request #796 from winfried-van-loon/already-loaded-warnings
Fixing the php ext already loaded warnings
2017-04-11 18:34:45 -07:00
32d26c3e10 Merge pull request #799 from winfried-van-loon/787-workspace-soap-warning
Fixing soap already loaded warning in workspace
2017-04-11 18:33:37 -07:00
b482d4d901 Merge pull request #783 from winfried-van-loon/php-fpm-71
Bringing Dockerfile 71 up-to-date with 70
2017-04-11 18:33:09 -07:00
ad00284a22 Removing ext enable aerospike error 2017-04-12 00:35:11 +02:00
a835c9e709 Fixing soap already loaded warning in workspace 2017-04-12 00:28:54 +02:00
597f922db7 Update Dockerfile-70 2017-04-12 09:20:06 +12:00
cdb456a9b5 Fixing indentation 2017-04-11 23:19:58 +02:00
714902d12a Moving php-fpm xdebug config to proper location 2017-04-11 23:17:21 +02:00
657d8535a6 Fixing not-consumed buildargs php-fpm-56
Should fix the following warning:
```
[Warning] One or more build-args [INSTALL_INTL INSTALL_PHPREDIS INSTALL_GHOSTSCRIPT] were not consumed
```
2017-04-11 23:15:09 +02:00
0594681760 Fixing the php ext already loaded warnings
Example:
```
warning: exif (exif.so) is already loaded!
```
2017-04-11 23:10:41 +02:00
f5478cfef5 Merge pull request #790 from winfried-van-loon/645-php-fpm-ghostscript
Fixing ghostscript env option
2017-04-11 12:57:44 -07:00
e10217c64d Fixing ghostscript env option
Forgot something :(.
2017-04-11 21:52:34 +02:00
f91def64d7 Fixing whitespaces and tailing spaces 2017-04-11 21:22:57 +02:00
f991123545 Merge pull request #788 from laradock/575-php-fpm-exif
Adding exif/redis to php-fpm 56 and 71
2017-04-11 15:01:43 -04:00
86ebbfbdd3 Adding exif/redis to php-fpm 56 and 71 2017-04-11 20:48:42 +02:00
a35287b367 Merge pull request #785 from winfried-van-loon/690-php-fpm-intl
Fixing INTL ext in php-fpm for php71
2017-04-11 13:24:43 -04:00
ddabb4620e Merge pull request #784 from winfried-van-loon/645-php-fpm-ghostscript
Fixing ghostscript env option
2017-04-11 13:24:29 -04:00
b86211d2d8 Merge pull request #781 from winfried-van-loon/764-780-php-fpm-mysql
Merging removed MySQL ext into MySQLi setting
2017-04-11 13:23:45 -04:00
0b414813aa Merge pull request #777 from bestlong/patch-1
use PHP71 build workspace get ERROR
2017-04-11 13:23:33 -04:00
7dbe65e5f8 Bringing Dockerfile 71 up-to-date with 70 2017-04-11 16:47:38 +02:00
ef38dd1532 Fixing ghostscript env option 2017-04-11 16:45:20 +02:00
4b91fb1212 Fixing INTL ext in php-fpm for php71 2017-04-11 16:42:27 +02:00
80a60d58cf Merging removed MySQL ext into MySQLi setting 2017-04-11 13:22:07 +02:00
1257f8830a use PHP71 build workspace get ERROR
fix #752, has a wrong comment string
2017-04-10 15:20:10 +08:00
8ed8bfdc2a Merge pull request #772 from winfried-van-loon/746-log-directories
Adding log directories to prevent errors
2017-04-09 18:56:47 -07:00
042eb9e5e8 Merge pull request #775 from bestlong/patch-1
Fixing can't login to PHPMyAdmin
2017-04-09 18:55:55 -07:00
15cac480fe Fixing can't login to PHPMyAdmin
fix #754, login to PHPMyAdmin get "#2005 - Unknown MySQL server host 'mysql' (-2)" error.
2017-04-10 09:50:53 +08:00
02e867c17d Adding log directories to prevent errors 2017-04-09 21:58:05 +02:00
d51cd31ebc Merge pull request #770 from mikeerickson/bugfix/769-linuxbrew-deployer
bugfix/769 fix linuxbrew, deployer configuration
2017-04-09 11:45:10 -07:00
ea354cf035 Update readme add: Winfried van Loon as Admin 2017-04-09 14:43:46 -04:00
0d4bacecd8 bugfix/769 fix linuxbrew, deployer configuration 2017-04-09 11:42:44 -07:00
86197c9b62 update docs: Improve docker speed on MAC using dinghy 2017-04-09 14:39:25 -04:00
f8fd92fb0a Merge pull request #766 from BrianDGLS/patch-1
fix typo in README.md
2017-04-09 12:26:41 -04:00
61b038e0d9 fix typo in README.md 2017-04-09 09:42:28 +01:00
5b60b7ffb8 Merge pull request #760 from bestlong/patch-1
fix php-fpm PHP56 can't enabled MySQL Support
2017-04-07 11:27:39 -04:00
6e1911bdd5 Merge pull request #758 from hounded/master
MySQL fix
2017-04-07 11:27:32 -04:00
d376074936 fix #759, php-fpm can't enabled MySQL Support
lost passthru parameter
2017-04-07 15:14:15 +08:00
64b985f005 Update docker-compose.yml 2017-04-07 14:27:15 +12:00
cc50339bcb Update docker-compose.yml 2017-04-07 14:25:40 +12:00
8820501644 Update Dockerfile 2017-04-07 14:24:15 +12:00
07021b01f4 Delete startup 2017-04-07 14:23:02 +12:00
13891a52dd Merge pull request #757 from hounded/master
Symfony support in workspace
2017-04-06 20:12:19 -04:00
a1bbe23800 Merge pull request #755 from if-kenn/master
remove /Volumes and /private entries for d4m-nfs from docs
2017-04-06 20:12:10 -04:00
2b5fdc00ee Update Dockerfile-70
install symfony and add alias for symfony
2017-04-07 10:22:26 +12:00
68ff573904 Update docker-compose.yml
Added Install_symfony
2017-04-07 10:20:19 +12:00
3a62814fdc Update env-example
added install symfony to workspace
2017-04-07 10:19:23 +12:00
da043ee0c4 remove /Volumes and /private entries
The /Volumes entry is not good with how NFS exports hierarchically.
The /private entry should not just be included by default.

45f1628be6
2017-04-06 09:20:22 -07:00
5cd6ea41f9 Merge pull request #751 from david-perez/master
Fix PHP Zip library installation
2017-04-05 20:54:17 -04:00
d321be888c Fix PHP Zip library installation 2017-04-05 15:06:47 +02:00
7230b11d3b Fixing specified Dockerfile name (#745) 2017-04-05 13:45:29 +08:00
7b9ec17d8d Merge pull request #743 from tjlytle/feature-nginx-logs
 Sending logs to docker `stdout` and `stderr`.
2017-04-04 20:48:18 -04:00
18b38db037 Merge pull request #742 from winfried-van-loon/patch-1
Updating the DigitalOcean guide
2017-04-04 20:47:52 -04:00
adfb468913 Merge pull request #741 from winfried-van-loon/714-workspace-php-version
Updating env to switch workspace php version
2017-04-04 20:46:14 -04:00
43f4211abb Merge pull request #740 from winfried-van-loon/724-php-version
Simplifying PHP_FPM version
2017-04-04 20:44:58 -04:00
b1b8585518 Merge pull request #738 from winfried-van-loon/master
Adding option to install Php5 MySQL extension
2017-04-04 20:43:39 -04:00
d8fd1a5de0 Updating the DigitalOcean guide 2017-04-05 00:32:41 +02:00
585baf0668 Sending logs to docker stdout and stderr. 2017-04-04 18:05:28 -04:00
f99eff3a99 Updating env to switch workspace php version. #714 2017-04-04 23:39:03 +02:00
ff4b913396 Simplifying PHP_FPM version. #724 2017-04-04 23:14:04 +02:00
e861348475 Adding option to install Php5.x MySQL #722 2017-04-04 16:39:53 +02:00
b0831240b1 Merge pull request #737 from winfried-van-loon/master
Fixing MariaDB root password variable. #736
2017-04-03 22:10:39 -04:00
37dee56bb7 Fixing MariaDB root password variable. #736 2017-04-04 00:05:44 +02:00
2b11fc2299 Merge pull request #732 from cjmaxik/patch-4
Update supervisord.conf
2017-04-03 09:56:13 -04:00
754ca4cd4f Merge pull request #730 from partounian/patch-1
Correct Supported Software list bullet points
2017-04-03 09:55:42 -04:00
10e3dc16d2 Merge pull request #729 from innerspirit/master
Marked toolbox as outdated in docs
2017-04-03 09:55:25 -04:00
e23c6dae90 Merge pull request #717 from zeroc0d3/proxy
Merge with Proxy branch
2017-04-03 09:54:27 -04:00
96c1d7c59c Update supervisord.conf
We have project in `/var/www` by default, not in `/var/www/laravel`

https://github.com/laradock/laradock/issues/731
2017-04-03 15:30:41 +10:00
c574943e16 Correct Supported Software list bullet points 2017-03-31 14:01:17 -07:00
3226206267 Fixed some bad links 2017-03-31 13:35:13 -03:00
63543b890a Marked toolbox as outdated in docs 2017-03-31 12:51:08 -03:00
b58f859eff Merge branch 'master' into proxy 2017-03-31 16:42:30 +07:00
170a1efeb1 Merge pull request #727 from partounian/master
Add Adminer container
2017-03-31 00:35:40 -04:00
50e3d1667f Merge pull request #726 from innerspirit/master
Fixed typo
2017-03-31 00:30:31 -04:00
269732d8ea Remove comment about requiring nginx/fastcgi 2017-03-30 18:25:29 -07:00
a11206d4ba Change adminer expose port to 8080
Most webservers default to 80, but Adminer's docker container runs on 8080.
2017-03-30 18:19:06 -07:00
cb78a6c3d6 Merge pull request #1 from innerspirit/doc-typo
Fixed typo
2017-03-30 17:27:27 -03:00
662280c139 Fixed typo 2017-03-30 17:26:20 -03:00
68dd2fd019 Switch from adminer:fastcgi to adminer:latest
This is to allow standalone usage.
2017-03-29 22:50:01 -07:00
c193c5d03b Correct Adminer repo 2017-03-29 22:29:18 -07:00
4efb5b43c6 Add Adminer to docs 2017-03-29 22:23:49 -07:00
3d2eb81cd5 Add necessary Adminer config below PMA sections 2017-03-29 22:13:33 -07:00
a8d7937889 Add ADM_PORT to env-example 2017-03-29 22:12:53 -07:00
98c9fdff24 Create Adminer dockerfile 2017-03-29 22:04:59 -07:00
f05512fd1d update readme 2017-03-29 10:08:55 -04:00
fc460f9497 Remove duplicate mssql & remove network setup for balancer 2017-03-29 13:59:53 +07:00
1fd55d98e1 Changing map network in docker-compose file 2017-03-26 16:31:18 +07:00
4f5746f2a7 Refactoring Maintainer Docker File 2017-03-26 14:56:55 +07:00
3d90a806fa Merge branch 'proxy' of github.com:zeroc0d3/docker-laradock into proxy 2017-03-26 12:33:48 +07:00
cf9abcd5b8 Change env-example varnish backend host to 'workspace' 2017-03-26 12:33:27 +07:00
e1036185ae Fixing from #708 (#715)
* Fixing workspace_yarn_version

* Remove duplicate type MAINTAINER

* Update README.md
2017-03-26 10:47:03 +08:00
d1af24736b Merge branch 'master' into proxy 2017-03-25 21:40:37 -04:00
236665d7d3 Change haproxy port to 8085 2017-03-26 08:13:14 +07:00
c340d851d3 Add mssql volumes 2017-03-26 07:30:59 +07:00
38545cfffd Update env-example for mssql 2017-03-26 07:28:04 +07:00
bf19ecffcb Fixing conflict & add mssql 2017-03-26 07:20:24 +07:00
6fa6d02360 Merge pull request #712 from cabrerabywaters/MSSQL_DATABASE_SUPPORT
adding MsSQL DATABASE support
2017-03-25 16:55:34 -04:00
e588f261f8 Merge pull request #708 from thorerik/fix-yarn-again
fix yarn again after #662 reverted it
2017-03-25 16:55:17 -04:00
5d5545ec9e Update README.md 2017-03-25 20:51:24 +07:00
d152050e29 Update README.md 2017-03-25 20:50:35 +07:00
a0da2c0ea0 Update readme
Add @zeroc0d3 to the maintainers team :)
2017-03-24 19:54:36 -04:00
2e86243d88 Update docker-compose.yml 2017-03-24 13:49:38 -03:00
6b61c7d454 adding MSSQL support 2017-03-24 12:31:38 -03:00
3881a5d66d Remove duplicate type MAINTAINER 2017-03-24 10:13:16 +07:00
69b223a370 Remove duplicate type MAINTAINER 2017-03-24 10:12:42 +07:00
894cb6ea27 🐛 fix yarn again after #662 reverted it
#706
2017-03-23 11:51:59 +01:00
b81e3e8f15 Fixing workspace_yarn_version 2017-03-23 16:32:11 +07:00
7d49f9b820 Fixing workspace_yarn_version 2017-03-23 16:07:59 +07:00
9dad1586af Fixing identitation for docker-compose haproxy 2017-03-23 15:01:32 +07:00
d60178f598 Add expose port for varnish 2017-03-23 14:07:25 +07:00
5d74e10b08 Update docker compose file for load balancer 2017-03-23 13:53:52 +07:00
40422ab4b0 Update environment for varnish & haproxy 2017-03-23 13:53:26 +07:00
b35a23d89e Add docker file varnish 2017-03-23 13:52:30 +07:00
3445b5b1b6 Add docker file haproxy 2017-03-23 13:52:11 +07:00
8315a3872d Merge pull request #662 from zeroc0d3/master
Fixing environment in docker-compose file
2017-03-22 10:14:00 -04:00
6abea8746c Merge branch 'master' into master 2017-03-22 11:43:53 +07:00
09c5ad273c re-position COMPOSE_CONVERT_WINDOWS_PATHS 2017-03-21 10:06:26 -04:00
99b8a45f3b Merge branch 'master' of https://github.com/Laradock/laradock
* 'master' of https://github.com/Laradock/laradock:
  Fixed path variable for windows users
  fixes up so Yarn is installable again
  align file format
  for file format
  use '`' to quote identifier
  use CREATE USER to define account authentication characteristics
  use CREATE USER to define account authentication characteristics
  Updated project example confs to fit nameing convention used in apache example
  Updated project example confs to not have gitignore issues
  docker-71 file now also works with new env-example setup
  Adding Arg to docker-compose
  Adding MSSQL Support
2017-03-21 10:02:10 -04:00
4f416da26b add missing env variable APPLICATION
closes #703
2017-03-21 10:01:37 -04:00
53b73798d3 Merge pull request #704 from Mvzundert/master
Fixed path variable for windows users
2017-03-21 09:59:57 -04:00
c6e9b1ed5d Fixed path variable for windows users 2017-03-21 11:21:26 +01:00
4973dd93be Merge branch 'master' into master 2017-03-21 04:09:11 +07:00
9096737aa7 Merge pull request #694 from Mvzundert/master
Docker-71 and Nginx examples
2017-03-20 13:22:49 -04:00
3429681f2c Merge pull request #670 from cabrerabywaters/MSSQL_SUPPORT
Mssql support
2017-03-20 13:20:08 -04:00
d4c727bb2d Merge pull request #700 from picospuch/master
fix some errors in mysql setup file for latest mysql image
2017-03-20 13:16:05 -04:00
1ae104167a Merge pull request #701 from thorerik/fix-yarn
Fix yarn installation
2017-03-20 13:15:39 -04:00
8869b22a1d fixes up so Yarn is installable again 2017-03-20 10:33:25 +01:00
1650af04cd align file format 2017-03-20 15:41:03 +08:00
bdcc2adf3f for file format 2017-03-20 15:40:07 +08:00
570be592bb use '`' to quote identifier 2017-03-20 15:36:58 +08:00
d94de05fd4 use CREATE USER to define account authentication characteristics 2017-03-20 15:06:45 +08:00
69c180d2e8 use CREATE USER to define account authentication characteristics 2017-03-20 15:01:16 +08:00
134911843a Merge branch 'master' into MSSQL_SUPPORT 2017-03-18 19:11:01 -03:00
d31ccbd268 Conflict resolved docker-compose file 2017-03-18 08:29:14 +07:00
2bbe39cf4a Merge branch 'master' into master 2017-03-18 07:52:45 +07:00
4588685e97 Updated project example confs to fit nameing convention used in apache example 2017-03-17 19:34:32 +01:00
4b2ddfad20 Updated project example confs to not have gitignore issues 2017-03-17 19:32:45 +01:00
516b148dae Merge branch 'master' of github.com:laradock/laradock 2017-03-17 16:56:14 +01:00
0c53eadf34 docker-71 file now also works with new env-example setup 2017-03-17 16:55:53 +01:00
3e61554625 Merge pull request #687 from jefhar/jefhar-patch-1
Jefhar patch 1
2017-03-17 11:09:45 -04:00
6054c2d250 Merge pull request #686 from cjmaxik/patch-3
Update Dockerfile-71
2017-03-17 11:08:29 -04:00
5589a12b9d Merge pull request #691 from davidtaboas/patch-1
Fix Dockerfile-70
2017-03-17 11:07:36 -04:00
e2384e2722 Merge pull request #689 from picospuch/patch-1
Update env-example
2017-03-17 11:07:21 -04:00
d077085595 Merge pull request #688 from Mvzundert/master
re-added .gitignore for nginx dir, still do not want configs in git
2017-03-17 11:07:06 -04:00
53f1032975 Merge pull request #673 from cabrerabywaters/PHP_WORKER
Php worker
2017-03-17 11:05:53 -04:00
875ec23ade Merge pull request #661 from g9308370/add_apache_vhost_conf
Add apache2 vhost & example
2017-03-17 11:01:10 -04:00
cee9de7ed1 Fix Dockerfile-70
Add ;fi to end if INSTALL_INTL block
2017-03-17 10:10:32 +01:00
badad156e1 Merge branch 'master' into add_apache_vhost_conf 2017-03-17 16:37:59 +08:00
8e89725381 Update env-example 2017-03-17 16:37:42 +08:00
2219177eac Merge branch 'master' into master 2017-03-17 14:54:06 +07:00
baf29b1223 re-added .gitignore for nginx dir, still do not want configs in git 2017-03-17 08:48:47 +01:00
5c0933d19a Merge with master branch 2017-03-17 14:36:00 +07:00
8de9eca8ae Fixing the docker-compose.yml 2017-03-17 13:57:54 +07:00
d172180660 Add constant PHP_FPM_INSTALL_INTL=false & APPLICATION 2017-03-17 13:53:04 +07:00
9f78b17fd1 Fixing indent_size=2 from 4 2017-03-17 13:52:19 +07:00
f5e33fb396 Update .gitignore file 2017-03-17 13:49:21 +07:00
9ae6e45dda Merge branch 'master' of https://github.com/Laradock/laradock
* 'master' of https://github.com/Laradock/laradock:
  Update docker-compose.yml
  intl support
2017-03-17 02:46:35 -04:00
94d88e91c5 add missing steps to the docs 2017-03-17 02:46:19 -04:00
8b4901ce57 Closed if
Closed if [] ;fi in Human Language and Character Encoding Support:
2017-03-16 23:28:29 -07:00
08086be4c5 PHP_FPM_INSTALL_INTL env-example
added PHP_FPM_INSTALL_INTL=false to PHP_FPM_INSTALL_INTL=false
2017-03-16 23:26:54 -07:00
f2805bca52 Update docker-compose.yml 2017-03-16 22:21:26 -03:00
033e1b8721 Merge branch 'master' into PHP_WORKER 2017-03-16 21:59:28 -03:00
9e290ffddb Merge pull request #680 from cjmaxik/feature-intl
Adding intl support to php-fpm container
2017-03-16 20:57:47 -04:00
6ada2f1b91 nginx samples sites for multiple projects
- add `project-1.conf` and `project-1.conf` to match the docs.
- keep default to work with both multiple and single projects.
- delete the .gitignore.
- update docker-compose and example-env file to match the new settings
- update the docs
- delete `laravel-https.conf` to replace it with documentation instead
2017-03-16 20:53:14 -04:00
c6e393f5ce Update Dockerfile-71
We have already 7.1 image builded. + intl and ghostscript support 
https://github.com/laradock/laradock/pull/672
https://github.com/laradock/laradock/pull/680
2017-03-17 10:32:04 +10:00
4e443cec09 Merge branch 'master' into feature-intl 2017-03-17 10:08:21 +10:00
528b60eb17 fixing Volumes and Workdir 2017-03-16 21:03:04 -03:00
aedc7c8438 edit the docs 2017-03-16 19:28:01 -04:00
ec4ccb4a20 Move CNAME from the docs to the DOC.. 2017-03-16 18:33:29 -04:00
de6040a14d move the documentation markdown files outside the generated html folder 2017-03-16 17:44:14 -04:00
e0e4616ae0 update installation steps in the docs (.env) 2017-03-16 17:03:05 -04:00
c00fe5d7e0 Merge branch 'multiple-projects-improvement'
* multiple-projects-improvement:
  updated env-example and removed .env.example
  complete missings
  Seperated mysqli and tokenizer as seperate options without putting them under code igniter
  Apache should just go to /var/www not /var/www/public when supporting multiple projects
  fixed example and docker-compose.yml
  Fixed php-fpm variables and example
  Split up mysqli and tokenizer
  Removed homestead entirely this time
  Removed homestead entirely this time
  Removed Homestead reference in all DB containers
  Removed reference to homestead
  Fixed timezone issue in docker-compose.yml
  Added NGINX from env file and updated env-example
  Updated PHP-FPM container to accept .env variables
  Added workspace from env file and updated env-example
  Removed .env file
  Added env-example and adjusted docker-compose yml to support new env file
  Updated gitignore
2017-03-16 16:10:28 -04:00
30cf27e011 Fix nginx: [emerg] BIO_new_file("/var/certs/cert1.pem") failed (SSL: error:02001002:system library:fopen:No such file or directory:fopen('/var/certs/cert1.pem','r') error:2006D080:BIO routines:BIO_new_file:no such file) 2017-03-16 15:56:37 -04:00
dcec8a46a8 replace the links with depends_on in the docker-compose file
closes #636
2017-03-16 15:11:04 -04:00
c62ce7d36f Update docker-compose.yml 2017-03-16 09:59:52 +10:00
8ee2229c84 intl support 2017-03-16 09:59:05 +10:00
f61535427c Merge pull request #677 from Mvzundert/multiple-projects-improvement
updated env-example and removed .env.example
2017-03-15 18:36:49 -04:00
0d41c3d65e updated env-example and removed .env.example 2017-03-15 09:12:07 +01:00
cbd3cf7c20 Adding php-worker container to docker-compose 2017-03-14 11:06:45 -03:00
d505871faf Adding php-worker for Laravel 2017-03-14 11:05:22 -03:00
246814874c Adding Arg to docker-compose 2017-03-14 10:49:44 -03:00
1250668267 Adding MSSQL Support 2017-03-14 10:47:10 -03:00
faa42d8651 Merge branch 'Mvzundert-multiple_frameworks'
* Mvzundert-multiple_frameworks:
  complete missings
  Seperated mysqli and tokenizer as seperate options without putting them under code igniter
  Apache should just go to /var/www not /var/www/public when supporting multiple projects
  fixed example and docker-compose.yml
  Fixed php-fpm variables and example
  Split up mysqli and tokenizer
  Removed homestead entirely this time
  Removed homestead entirely this time
  Removed Homestead reference in all DB containers
  Removed reference to homestead
  Fixed timezone issue in docker-compose.yml
  Added NGINX from env file and updated env-example
  Updated PHP-FPM container to accept .env variables
  Added workspace from env file and updated env-example
  Removed .env file
  Added env-example and adjusted docker-compose yml to support new env file
  Updated gitignore
2017-03-13 21:03:58 -04:00
ab1d5bae95 complete missings 2017-03-13 21:03:31 -04:00
7f27073a4e Merge branch 'multiple_frameworks' of https://github.com/Mvzundert/laradock into Mvzundert-multiple_frameworks
* 'multiple_frameworks' of https://github.com/Mvzundert/laradock:
  Seperated mysqli and tokenizer as seperate options without putting them under code igniter
  Apache should just go to /var/www not /var/www/public when supporting multiple projects
  fixed example and docker-compose.yml
  Fixed php-fpm variables and example
  Split up mysqli and tokenizer
  Removed homestead entirely this time
  Removed homestead entirely this time
  Removed Homestead reference in all DB containers
  Removed reference to homestead
  Fixed timezone issue in docker-compose.yml
  Added NGINX from env file and updated env-example
  Updated PHP-FPM container to accept .env variables
  Added workspace from env file and updated env-example
  Removed .env file
  Added env-example and adjusted docker-compose yml to support new env file
  Updated gitignore
2017-03-13 19:29:30 -04:00
c88e690bb4 Merge branch 'master' into master 2017-03-10 08:09:07 +07:00
c1de398acc Change default phpmyadmin environment for mysql 2017-03-10 07:53:33 +07:00
73f7c88122 Fixing environment in docker-compose file 2017-03-09 19:21:36 +07:00
f7b94ac599 Merge branch 'non-framework' into multiple_frameworks 2017-03-09 09:33:40 +01:00
ff39e6045d Merge branch 'multiple_frameworks' of github.com:Mvzundert/laradock into multiple_frameworks 2017-03-09 09:32:13 +01:00
07ebd5f69b Fixed merge conflicts when merging upstream with master 2017-03-09 09:30:47 +01:00
36fcc6674e Seperated mysqli and tokenizer as seperate options without putting them under code igniter 2017-03-09 09:29:07 +01:00
37ed904f1a add vhost example 2017-03-09 10:26:47 +08:00
7a343f168f Updated with laradock master 2017-03-08 16:08:42 +01:00
0ac0166068 Merge branch 'master' into multiple_frameworks 2017-03-08 11:33:20 +01:00
25c2768557 Apache should just go to /var/www not /var/www/public when supporting multiple projects 2017-03-06 22:26:17 +01:00
1d918a71d8 fixed example and docker-compose.yml 2017-03-06 22:20:31 +01:00
9e3f8dd43d fixed merge conflicts 2017-03-06 21:25:16 +01:00
46fcb9e09c Fixed php-fpm variables and example 2017-03-06 09:31:11 +01:00
603010cbd5 Split up mysqli and tokenizer 2017-03-06 09:03:12 +01:00
b45f395996 Removed homestead entirely this time 2017-03-01 08:29:17 +01:00
59dfacee13 Removed homestead entirely this time 2017-03-01 08:17:34 +01:00
a6e0338245 Removed Homestead reference in all DB containers 2017-03-01 08:08:20 +01:00
f610aa63d1 Removed reference to homestead 2017-02-27 15:58:38 +01:00
966a84fa39 Fixed timezone issue in docker-compose.yml 2017-02-27 14:49:43 +01:00
356dc36fd5 Added NGINX from env file and updated env-example 2017-02-27 14:11:16 +01:00
c112fdffc1 Updated PHP-FPM container to accept .env variables 2017-02-27 14:05:47 +01:00
fa9ac1e471 Added workspace from env file and updated env-example 2017-02-27 13:53:40 +01:00
3f13aa4f50 Removed .env file 2017-02-27 12:36:44 +01:00
474504f1d3 Added env-example and adjusted docker-compose yml to support new env file 2017-02-27 12:35:28 +01:00
ca45806aaa Updated gitignore 2017-02-27 12:34:20 +01:00
130 changed files with 4938 additions and 1367 deletions

View File

@ -9,4 +9,4 @@ charset = utf-8
[{Dockerfile,docker-compose.yml}]
indent_style = space
indent_size = 4
indent_size = 2

1
.env
View File

@ -1 +0,0 @@
COMPOSE_CONVERT_WINDOWS_PATHS=1

2
.gitignore vendored
View File

@ -1,3 +1,5 @@
.idea
/logs
/data
.env
/.project

View File

@ -1,6 +1,6 @@
baseurl = "http://laradock.io/"
languageCode = "en-us"
publishDir = "../"
publishDir = "../../docs"
title = "Laradock"
theme = "hugo-material-docs"
metadataformat = "yaml"

View File

@ -7,41 +7,53 @@ weight: 6
Your contribution is more than welcome.
## Got a Question or Problem?
## I have a Question/Problem
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).
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`) And you can still seek help on Gitter for it.
## Found an Issue?
If you find a bug in the source code or a mistake in the documentation, you can help us by
submitting an [Issue](https://github.com/laradock/laradock/issues). Even better you can submit a Pull Request with a fix.
## I found an Issue
If have an issue or you found a typo in the documentation, you can help us by
opnening an [Issue](https://github.com/laradock/laradock/issues).
## Want a Feature?
You can request a new feature by submitting an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.
**Steps to do before opening an Issue:**
1. Before you submit your issue search the archive, maybe your question was already answered couple hours ago (search in the closed Issues as well).
2. Decide if the Issue belongs to this project or to [Docker](https://github.com/docker) itself! or even the tool you are using such as Nginx or MongoDB...
If your issue appears to be a bug, and hasn't been reported, then open a new issue.
*This Help us to maximize the effort we can spend fixing issues and adding new
features, by not reporting duplicate issues.*
## Update Documentation (Site)
## I want a Feature
You can request a new feature by submitting an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as `Feature Suggestion`). If you would like to implement a new feature then consider submitting a Pull Request yourself.
## I want to update the Documentation (Site)
Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Material Docs theme](http://themes.gohugo.io/theme/material-docs/). You might need to check their docs quickly.
1. Install [Hugo](https://gohugo.io/) on your machine.
2. Clone laradock.
3. Go to `/docs`.
4. Delete everything except the `_settings` folder & the `CNAME` file.
5. Open `docs/_settings` from your terminal and run `hugo serve` to host the website locally.
6. Open the `docs/_settings/content` and search for the folder of the section you want to edit.
7. In each section there's an `index.md` file, that's the file you need to edit.
8. To edit the sidebar (in case you are adding new section) go to `docs/_settings/config.toml` and add the section there.
9. After done editing, run the this command `hugo` to generate the updated site inside the `docs` folder.
10. Go back to the project root directory, commit and push..
1. Install [Hugo](https://gohugo.io/) on your machine (easy thing).
2. Open the `DOCUMENTATION/_settings/content` and search for the markdown file you want to edit (every folder represents a section in the menu).
3. Delete the `/docs` folder from the root.
4. When you finish editing, go to `DOCUMENTATION/_settings/` and run the `hugo` command to generate the HTML docs (inside new `/docs` folder).
### To Host the website locally
Go to `DOCUMENTATION/_settings` in your terminal and run `hugo serve` to host the website locally.
### Edit the sidebar
To add a new section to the sidebar or edit existing one, you need to edit this file `DOCUMENTATION/_settings/config.toml`.
## Coding Guidelines
## Support new Software
## How to support new Software (Add new Container)
* Create folder with the software name.
@ -53,30 +65,23 @@ Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Ma
* Make sure you follow our commenting style.
* Add the software in the `Readme`.
* Add the software in the `Documentation`.
## Edit existing Software
## Edit existing Software (Edit a Container)
* Open the software (container) folder.
* Edit the files you want to update.
* **Note:** If you want to edit the base image of the `Workspace` or the `php-fpm` Containers,
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the LaraDock repository.
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.
* Make sure to update the `Readme` in case you made any changes.
## Issue/PR Submission Guidelines
## Submitting an Issue
Before you submit your issue search the archive, maybe your question was already answered.
If your issue appears to be a bug, and hasn't been reported, open a new issue.
Help us to maximize the effort we can spend fixing issues and adding new
features, by not reporting duplicate issues.
* Make sure to update the `Documentation` in case you made any changes.
## Before Submitting a Pull Request (PR)
## Pull Request
### 1. Before Submitting a Pull Request (PR)
Always Test everything and make sure its working:
@ -86,13 +91,13 @@ Always Test everything and make sure its working:
- Test running the container with some other containers in real app and see of everything is working fine.
- Now edit the container (edit section by section and test rebuilding the container after every edited section)
- Testing building the container (docker-compose build container-name) with no errors.
- Test it in real App.
- Test it in a real App if possible.
## Submitting a PR
### 2. Submitting a PR
Consider the following guidelines:
* Search [GitHub](https://github.com/laradock/laradock/pulls) for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
* Search [GitHub](https://github.com/laradock/laradock/pulls) for an open or closed Pull Request that relates to your submission. You don't want to duplicate efforts.
* Make your changes in a new git branch:
@ -123,14 +128,9 @@ git push origin my-fix-branch -f
*WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments on code that were previously made by you and others in your commits.*
### 3. After your PR is merged
## After your PR is merged
After your pull request is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository:
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
@ -161,4 +161,4 @@ from the main (upstream) repository:
<br>
## Happy Coding :)
#### Happy Coding :)

View File

@ -176,6 +176,11 @@ However to view the logs of all the other containers (MySQL, PHP-FPM,...) you ca
docker logs {container-name}
```
More [options](https://docs.docker.com/compose/reference/logs/)
```bash
docker logs -f {container-name}
```
@ -329,7 +334,7 @@ For information on how to configure xDebug with your IDE and work it out, check
By installing xDebug, you are enabling it to run on startup by default.
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):
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):
- Stop xDebug from running by default: `./xdebugPhpFpm stop`.
- Start xDebug by default: `./xdebugPhpFpm start`.
@ -381,10 +386,10 @@ It should be like this:
<br>
<a name="LaraDock-for-Production"></a>
## Prepare LaraDock for Production
<a name="Laradock-for-Production"></a>
## Prepare Laradock for Production
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 ...`).
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 ...`).
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:
@ -439,7 +444,7 @@ For more about the Laravel installation click [here](https://laravel.com/docs/ma
3 - Edit `docker-compose.yml` to Map the new application path:
By default, LaraDock assumes the Laravel application is living in the parent directory of the laradock folder.
By default, Laradock assumes the Laravel application is living in the parent directory of the laradock folder.
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:
@ -456,7 +461,7 @@ Since the new Laravel application is in the `my-cool-app` folder, we need to rep
cd my-cool-app
```
5 - Go back to the LaraDock installation steps to see how to edit the `.env` file.
5 - Go back to the Laradock installation steps to see how to edit the `.env` file.
@ -581,7 +586,7 @@ composer require predis/predis:^1.0
5 - You can manually test it from Laravel with this code:
```php
\Cache::store('redis')->put('LaraDock', 'Awesome', 10);
\Cache::store('redis')->put('Laradock', 'Awesome', 10);
```
@ -701,6 +706,23 @@ docker-compose up -d mariadb phpmyadmin
<br>
<a name="Use-Adminer"></a>
## Use Adminer
1 - Run the Adminer Container (`adminer`) with the `docker-compose up` command. Example:
```bash
docker-compose up -d adminer
```
2 - Open your browser and visit the localhost on port **8080**: `http://localhost:8080`
<br>
<a name="Use-pgAdmin"></a>
## Use PgAdmin
@ -893,7 +915,7 @@ docker-compose up -d minio
<a name="Install-CodeIgniter"></a>
## Install CodeIgniter
To install CodeIgniter 3 on LaraDock all you have to do is the following simple steps:
To install CodeIgniter 3 on Laradock all you have to do is the following simple steps:
1 - Open the `docker-compose.yml` file.
@ -1198,7 +1220,7 @@ It should be like this:
<a name="Common-Aliases"></a>
<br>
## Common Terminal Aliases
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.
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.
You are free to modify the `aliases.sh` as you see fit, adding your own aliases (or function macros) to suit your requirements.
@ -1292,10 +1314,10 @@ Remote debug Laravel web and phpunit tests.
<br>
<a name="keep-tracking-LaraDock"></a>
## Keep track of your LaraDock changes
<a name="keep-tracking-Laradock"></a>
## Keep track of your Laradock changes
1. Fork the LaraDock repository.
1. Fork the Laradock repository.
2. Use that fork as a submodule.
3. Commit all your changes to your fork.
4. Pull new stuff from the main repository from time to time.
@ -1308,14 +1330,14 @@ Remote debug Laravel web and phpunit tests.
<br>
<a name="upgrading-laradock"></a>
## Upgrading LaraDock
## Upgrading Laradock
Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading LaraDock from v3.* to v4.*:
Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading Laradock from v3.* to v4.*:
1. Stop the docker VM `docker-machine stop {default}`
2. Install Docker for [Mac](https://docs.docker.com/docker-for-mac/) or [Windows](https://docs.docker.com/docker-for-windows/).
3. Upgrade LaraDock to `v4.*.*` (`git pull origin master`)
4. Use LaraDock as you used to do: `docker-compose up -d nginx mysql`.
3. Upgrade Laradock to `v4.*.*` (`git pull origin master`)
4. Use Laradock as you used to do: `docker-compose up -d nginx mysql`.
**Note:** If you face any problem with the last step above: rebuild all your containers
`docker-compose build --no-cache`
@ -1327,15 +1349,36 @@ Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requ
<br>
<a name="Speed-MacOS"></a>
## Improve speed on MacOS
Sharing code into Docker containers with osxfs have very poor performance compared to Linux. You can get around this issue by using NFS to share your files betwen your host and your container.
Sharing code into Docker containers with osxfs have very poor performance compared to Linux. Likely there are some workarounds:
> How to share files using NFS (d4m-nfs)
### Workaround A: using dinghy
[d4m-nfs](https://github.com/IFSight/d4m-nfs) automatically mount NFS volume instead of osxfs one.
[Dinghy](https://github.com/codekitchen/dinghy) creates its own VM using docker-machine, it will not modify your existing docker-machine VMs.
Quick Setup giude, (we recommend you check their docs)
1) `brew tap codekitchen/dinghy`
2) `brew install dinghy`
3) `dinghy create --provider virtualbox` (must have virtualbox installed, but they support other providers if you prefer)
4) after the above command is done it will display some env variables, copy them to the bash profile or zsh or.. (this will instruct docker to use the server running inside the VM)
5) `docker-compose up ...`
### Workaround B: using d4m-nfs
[D4m-nfs](https://github.com/IFSight/d4m-nfs) automatically mount NFS volume instead of osxfs one.
1) Update the Docker [File Sharing] preferences:
@ -1353,14 +1396,12 @@ git clone https://github.com/IFSight/d4m-nfs ~/d4m-nfs
```txt
/Users:/Users
/Volumes:/Volumes
/private:/private
```
5) Create (or edit) the file `/etc/exports`, make sure it exists and is empty. (There may be collisions if you come from Vagrant or if you already executed the `d4m-nfs.sh` script before).
6) Run the `d4m-nfs.sh` script:
6) Run the `d4m-nfs.sh` script (might need Sudo):
```bash
~/d4m-nfs/d4m-nfs.sh
@ -1369,10 +1410,26 @@ git clone https://github.com/IFSight/d4m-nfs ~/d4m-nfs
That's it! Run your containers.. Example:
```bash
docker-compose up -d nginx mysql
docker-compose up ...
```
**Note:** If you faced any errors, try restarting Docker, and make sure you have no spaces in the `d4m-nfs-mounts.txt` file, and your `/etc/exports` file is clear.
*Note: If you faced any errors, try restarting Docker, and make sure you have no spaces in the `d4m-nfs-mounts.txt` file, and your `/etc/exports` file is clear.*
### Other good workarounds:
- [docker-sync](https://github.com/EugenMayer/docker-sync)
- Add more here..
More details about this issue [here](https://github.com/docker/for-mac/issues/77).
@ -1454,4 +1511,4 @@ This error sometimes happens because your Laravel application isn't running on t
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.
2. Change the `DB_HOST` variable on env with the IP that you received from previous step.
* Option B
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`
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`

View File

@ -0,0 +1,211 @@
---
title: Getting Started
type: index
weight: 2
---
## Requirements
- [Git](https://git-scm.com/downloads)
- [Docker](https://www.docker.com/products/docker/) `>= 1.12`
## Installation
Choose the setup the best suits your needs.
- [A) Setup for Single Project](#A)
- [A.1) Already have a PHP project](#A1)
- [A.2) Don't have a PHP project yet](#A2)
- [B) Setup for Multiple Projects](#B)
<a name="A"></a>
### A) Setup for Single Project
> (Follow these steps if you want a separate Docker environment for each project)
<a name="A1"></a>
### A.1) Already have a PHP project:
1 - Clone laradock on your project root directory:
```bash
git submodule add https://github.com/Laradock/laradock.git
```
**Notes:**
- If you are not using Git yet for your project, you can use `git clone` instead of `git submodule `.
- Note 2: To keep track of your Laradock changes, between your projects and also keep Laradock updated. [Check this](/documentation/#keep-track-of-your-laradock-changes)
Your folder structure should look like this:
```
+ project-a
+ laradock-a
+ project-b
+ laradock-b
```
(It's important to rename the folders differently in each project.)
> **Now jump to the [Usage](#Usage) section.**
<a name="A2"></a>
### A.2) Don't have a PHP project yet:
1 - Clone this repository anywhere on your machine:
```bash
git clone https://github.com/laradock/laradock.git
```
Your folder structure should look like this:
```
+ laradock
+ project-z
```
2 - Edit your web server sites configuration.
**In case of NGINX:** open `nginx/sites/default.conf` and change the `root` from `/var/www/public` to `/var/www/{my-project-folder-name}/public`.
*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>
> **Now jump to the [Usage](#Usage) section.**
<a name="B"></a>
### B) Setup for Multiple Projects:
> (Follow these steps if you want a single Docker environment for all your project)
1 - Clone this repository anywhere on your machine (similar to [Steps A.2. from above](#A2)):
```bash
git clone https://github.com/laradock/laradock.git
```
Your folder structure should look like this:
```
+ laradock
+ project-1
+ project-2
```
2 - Go to `nginx/sites` and create config files to point to different project directory when visiting different domains.
Laradock by default includes `project-1.conf` and `project-2.conf` as working samples.
3 - change the default names `project-n`:
You can rename the config files, project folders and domains as you like, just make sure the `root` in the config files, is pointing to the correct project folder name.
4 - Add the domains to the **hosts** files.
```
127.0.0.1 project-1.dev
127.0.0.1 project-2.dev
```
> **Now jump to the [Usage](#Usage) section.**
<a name="Usage"></a>
## Usage
**Read Before starting:**
If you are using **Docker Toolbox** (VM), do one of the following:
- Upgrade to Docker [Native](https://www.docker.com/products/docker) for Mac/Windows (Recommended). Check out [Upgrading Laradock](/documentation/#upgrading-laradock)
- Use Laradock v3.\*. Visit the [LaraDock-ToolBox](https://github.com/laradock/laradock/tree/LaraDock-ToolBox) branch. *(outdated)*
<br>
>**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.
<br>
1 - Enter the laradock folder and rename `env-example` to `.env`
```shell
cp env-example .env
```
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
```
**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:
> `nginx`, `hhvm`, `php-fpm`, `mysql`, `redis`, `postgres`, `mariadb`, `neo4j`, `mongo`, `apache2`, `caddy`, `memcached`, `beanstalkd`, `beanstalkd-console`, `rabbitmq`, `beanstalkd-console`, `workspace`, `phpmyadmin`, `adminer`, `aerospike`, `pgadmin`, `elasticsearch`, `rethinkdb`, `postgres-postgis`, `certbot`, `mailhog`, `minio` and more...!
*(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>
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:*
```bash
docker exec -it {workspace-container-id} bash
```
**Note:** You can add `--user=laradock` to have files created as your host's user. Example:
```shell
docker-compose exec --user=laradock workspace bash
```
*You can change the PUID (User id) and PGID (group id) variables from the `.env` file)*
<br>
4 - Update your project configurations to use the database host
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
```
*If you want to install Laravel as PHP project, see [How to Install Laravel in a Docker Container](#Install-Laravel).*
<br>
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

View File

@ -4,6 +4,6 @@ type: index
weight: 5
---
Join the chat room on [Gitter](https://gitter.im/LaraDock/laradock) and get help and support from the community.
Join the chat room on [Gitter](https://gitter.im/Laradock/laradock) and get help and support from the community.
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).
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).

View File

@ -4,11 +4,11 @@ type: index
weight: 1
---
LaraDock strives to make the PHP development experience easier and faster.
Laradock strives to make the PHP development experience easier and faster.
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.
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...).
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...).
@ -17,19 +17,25 @@ LaraDock is configured to run Laravel Apps by default, and it can be modified to
Let's see how easy it is to install `NGINX`, `PHP`, `Composer`, `MySQL`, `Redis` and `beanstalkd`:
1 - Clone LaraDock inside your PHP project:
1 - Clone Laradock inside your PHP project:
```shell
git clone https://github.com/Laradock/laradock.git
```
2 - Enter the laradock folder and run this command:
2 - Enter the laradock folder and rename `env-example` to `.env`.
```shell
cp env-example .env
```
3 - Run your containers:
```shell
docker-compose up -d nginx mysql redis beanstalkd
```
3 - Open your `.env` file and set the following:
3 - Open your project's `.env` file and set the following:
```shell
DB_HOST=mysql
@ -76,17 +82,17 @@ Most importantly Docker can run on Development and on Production (same environme
<a name="laradock-vs-homestead"></a>
## LaraDock VS Homestead (For Laravel Developers)
## Laradock VS Homestead (For Laravel Developers)
> LaraDock It's like Laravel Homestead but for Docker instead of Vagrant.
> Laradock It's like Laravel Homestead but for Docker instead of Vagrant.
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).
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).
- Homestead is a tool that controls Vagrant for you (using Homestead special commands). And Vagrant manages your Virtual Machine.
- LaraDock is a tool that controls Docker for you (using Docker & Docker Compose official commands). And Docker manages your Virtual Containers.
- Laradock is a tool that controls Docker for you (using Docker & Docker Compose official commands). And Docker manages your Virtual Containers.
Running a virtual container is much faster than running a full virtual Machine. Thus **LaraDock is much faster than Homestead**.
Running a virtual container is much faster than running a full virtual Machine. Thus **Laradock is much faster than Homestead**.
@ -100,10 +106,10 @@ Running a virtual container is much faster than running a full virtual Machine.
What's better than a **Demo Video**:
- LaraDock [v4.*](https://www.youtube.com/watch?v=TQii1jDa96Y)
- LaraDock [v2.*](https://www.youtube.com/watch?v=-DamFMczwDA)
- LaraDock [v0.3](https://www.youtube.com/watch?v=jGkyO6Is_aI)
- LaraDock [v0.1](https://www.youtube.com/watch?v=3YQsHe6oF80)
- Laradock [v4.*](https://www.youtube.com/watch?v=TQii1jDa96Y)
- Laradock [v2.*](https://www.youtube.com/watch?v=-DamFMczwDA)
- Laradock [v0.3](https://www.youtube.com/watch?v=jGkyO6Is_aI)
- Laradock [v0.1](https://www.youtube.com/watch?v=3YQsHe6oF80)
@ -139,11 +145,12 @@ What's better than a **Demo Video**:
- **Database Engines:**
- MySQL
- PostgreSQL
- MariaDB
- MongoDB
- Neo4j
- RethinkDB
- PostgreSQL
- Postgres Postgis
- **Cache Engines:**
- Redis
- Memcached
@ -162,9 +169,12 @@ What's better than a **Demo Video**:
- RabbitMQ Console
- **Tools:**
- PhpMyAdmin
- Adminer
- PgAdmin
- ElasticSearch
- Selenium
- Certbot
- Mailhog
- Minio
- Workspace
- PHP7-CLI
@ -194,4 +204,4 @@ What's better than a **Demo Video**:
You are welcome to join our chat room on Gitter.
[![Gitter](https://badges.gitter.im/LaraDock/laradock.svg)](https://gitter.im/LaraDock/laradock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![Gitter](https://badges.gitter.im/Laradock/laradock.svg)](https://gitter.im/Laradock/laradock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

View File

@ -4,10 +4,10 @@ type: index
weight: 4
---
LaraDock related projects:
Laradock related projects:
* [LaraDock CLI](https://github.com/lorinlee/laradock-cli) by [LorinLee](https://github.com/lorinlee)
* [LaraDock Env](https://github.com/bagart/laradock_env) by [BAGArt](https://github.com/bagart)
* [Laradock CLI](https://github.com/lorinlee/laradock-cli) by [LorinLee](https://github.com/lorinlee)
* [Laradock Env](https://github.com/bagart/laradock_env) by [BAGArt](https://github.com/bagart)
* [Klaradock](https://github.com/poyhsiao/Klaradock) by [Kim Hsiao](https://github.com/poyhsiao)
* [Ansible Laradock Kubernetes](https://github.com/sifat-rahim/ansible-laradock-kubernetes) by [Sifat Rahim](https://github.com/sifat-rahim)
These Docker Compose projects have piqued our interest:

View File

@ -0,0 +1 @@
laradock.io

View File

Before

Width:  |  Height:  |  Size: 246 KiB

After

Width:  |  Height:  |  Size: 246 KiB

View File

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 84 KiB

View File

Before

Width:  |  Height:  |  Size: 4.3 KiB

After

Width:  |  Height:  |  Size: 4.3 KiB

View File

Before

Width:  |  Height:  |  Size: 254 KiB

After

Width:  |  Height:  |  Size: 254 KiB

View File

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

View File

Before

Width:  |  Height:  |  Size: 145 KiB

After

Width:  |  Height:  |  Size: 145 KiB

View File

@ -4,7 +4,7 @@
[![forthebadge](http://forthebadge.com/images/badges/built-by-developers.svg)](http://zalt.me)
Laradock is a Docker PHP development environment that facilitate running **PHP** Apps on **Docker**.
Laradock is a Docker PHP development environment that facilitates running **PHP** Apps on **Docker**.
## Documentation
@ -12,15 +12,18 @@ Laradock is a Docker PHP development environment that facilitate running **PHP**
## Credits
**Super Admins:**
**Admins / Maintainers:**
- [Mahmoud Zalt](https://github.com/Mahmoudz) (mahmoudz) [ [Twitter](https://twitter.com/Mahmoud_Zalt) | [Personal Site](http://zalt.me) | [LinkedIn](https://www.linkedin.com/in/mahmoudzalt) ]
- [Bo-Yi Wu](https://github.com/appleboy) (appleboy) [ [Twitter](https://twitter.com/appleboy) ]
- [Philippe Trépanier](https://github.com/philtrep) (philtrep)
- [Mike Erickson](https://github.com/mikeerickson) (mikeerickson)
- Join Us!
- [Dwi Fahni Denni](https://github.com/zeroc0d3) (zeroc0d3)
- [Thor Erik](https://github.com/thorerik) (thorerik)
- [Winfried van Loon](https://github.com/winfried-van-loon) (winfried-van-loon)
- Contribute and join us!
**Amazing Contributors:**
**Contributors:**
- [Contributors](https://github.com/laradock/laradock/graphs/contributors)

View File

@ -1,112 +1,118 @@
#### Install Docker
```
Login Digital Ocean
Add Droplet
1 Click Install docker
Choose Droplet
reset ROOT password
check email
```
- Visit [DigitalOcean](https://cloud.digitalocean.com/login) and login.
- Click the `Create Droplet` button.
- Open the `One-click apps` tab.
- Select Docker with your preferred version.
- Continue creating the droplet as you normally would.
- If needed, check your e-mail for the droplet root password.
#### SSH to your Server
Find the IP address of the droplet in the DigitalOcean interface. Use it to connect to the server.
```
ssh root@ipaddress
```
you will be prompt of that password.
type the password you receive in your email
then it will ask to you to change a new password
just change it to the custom root password you want
You may be prompted for a password. Type the one you found within your e-mailbox. It'll then ask you to change the password.
After SSH
you can check that docker command is working by typing
You can now check if Docker is available:
```
$root@midascode:~# docker
$root@server:~# docker
```
#### Set Up Your Laravel Project
```
$root@midascode:~# apt-get install git
$root@midascode:~# git clone https://github.com/laravel/laravel
$root@midascode:~# cd laravel
$root@midascode:~/laravel/ git submodule add https://github.com/LaraDock/laradock.git
$root@midascode:~/laravel/ cd laradock
$root@server:~# apt-get install git
$root@server:~# git clone https://github.com/laravel/laravel
$root@server:~# cd laravel
$root@server:~/laravel/ git submodule add https://github.com/LaraDock/laradock.git
$root@server:~/laravel/ cd laradock
```
#### Install docker-compose command
```
$root@midascode:~/laravel/laradock# curl -L https://github.com/docker/compose/releases/download/1.8.0/run.sh > /usr/local/bin/docker-compose
$root@midascode:~/chmod +x /usr/local/bin/docker-compose
$root@server:~/laravel/laradock# curl -L https://github.com/docker/compose/releases/download/1.8.0/run.sh > /usr/local/bin/docker-compose
$root@server:~/chmod +x /usr/local/bin/docker-compose
```
#### Create Your LaraDock Containers
```
$root@midascode:~/laravel/laradock# docker-compose up -d nginx mysql
$root@server:~/laravel/laradock# docker-compose up -d nginx mysql
```
Note that more containers are available, find them in the [docs](http://laradock.io/introduction/#supported-software-containers) or the `docker-compose.yml` file.
#### Go to Your Workspace
```
docker-compose exec workspace bash
```
#### Install laravel Dependencies, Add .env , generate Key and give proper permission certain folder
#### Install and configure Laravel
Let's install Laravel's dependencies, add the `.env` file, generate the key and give proper permissions to the cache folder.
```
$ root@0e77851d27d3:/var/www# composer install
$ root@0e77851d27d3:/var/www# cp .env.example .env
$ root@0e77851d27d3:/var/www# php artisan key:generate
$ root@0e77851d27d3:/var/www# exit
$root@midascode:~/laravel/laradock# cd ..
$root@midascode:~/laravel# sudo chmod -R 777 storage bootstrap/cache
$ root@workspace:/var/www# composer install
$ root@workspace:/var/www# cp .env.example .env
$ root@workspace:/var/www# php artisan key:generate
$ root@workspace:/var/www# exit
$root@server:~/laravel/laradock# cd ..
$root@server:~/laravel# sudo chmod -R 777 storage bootstrap/cache
```
you can then view your laravel site at your ipaddress
for example
You can then view your Laravel site by visiting the IP address of your server in your browser. For example:
```
192.168.1.1
http://192.168.1.1
```
You will see there Laravel Default Welcome Page
It should show you the Laravel default welcome page.
but if you need to view on your custom domain name
which you would.
However, we want it to show up using your custom domain name, as well.
#### Using Your Own Domain Name
login to your DNS provider
Godaddy, Namecheap what ever...
And Point the Custom Domain Name Server to
Login to your DNS provider, such as Godaddy, Namecheap.
Point the Custom Domain Name Server to:
```
ns1.digitalocean.com
ns2.digitalocean.com
ns3.digitalocean.com
```
In Your Digital Ocean Account go to
```
https://cloud.digitalocean.com/networking/domains
```
add your domain name and choose the server ip you provision earlier
#### Serve Site With NGINX (HTTP ONLY)
Go back to command line
Within DigitalOcean, you'll need to change some settings, too.
Visit: https://cloud.digitalocean.com/networking/domains
Add your domain name and choose the server IP you'd provision earlier.
#### Serving Site With NGINX (HTTP ONLY)
Go back to command line.
```
$root@midascode:~/laravel/laradock# cd nginx
$root@midascode:~/laravel/laradock/nginx# vim laravel.conf
```
remove default_server
$root@server:~/laravel/laradock# cd nginx
$root@server:~/laravel/laradock/nginx# vim laravel.conf
```
Remove `default_server`
```
listen 80 default_server;
listen [::]:80 default_server ipv6only=on;
```
and add server_name (your custom domain)
And add `server_name` (your custom domain)
```
listen 80;
listen [::]:80 ipv6only=on;
@ -114,27 +120,29 @@ remove default_server
```
#### Rebuild Your Nginx
```
$root@midascode:~/laravel/laradock/nginx# docker-compose down
$root@midascode:~/laravel/laradock/nginx# docker-compose build nginx
$root@server:~/laravel/laradock/nginx# docker-compose down
$root@server:~/laravel/laradock/nginx# docker-compose build nginx
```
#### Re Run Your Containers MYSQL and NGINX
```
$root@midascode:~/laravel/laradock/nginx# docker-compose up -d nginx mysql
$root@server:~/laravel/laradock/nginx# docker-compose up -d nginx mysql
```
###### View Your Site with HTTP ONLY (http://yourdomain.com)
**View Your Site with HTTP ONLY (http://yourdomain.com)**
#### Run Site on SSL with Let's Encrypt Certificate
###### Note: You need to Use Caddy here Instead of Nginx
**Note: You need to Use Caddy here Instead of Nginx**
###### To go Caddy Folders and Edit CaddyFile
To go Caddy Folders and Edit CaddyFile
```
$root@midascode:~/laravel/laradock# cd caddy
$root@midascode:~/laravel/laradock/caddy# vim Caddyfile
$root@server:~/laravel/laradock# cd caddy
$root@server:~/laravel/laradock/caddy# vim Caddyfile
```
Remove 0.0.0.0:80
@ -142,32 +150,37 @@ Remove 0.0.0.0:80
```
0.0.0.0:80
root /var/www/public
```
```
and replace with your https://yourdomain.com
```
https://yourdomain.com
root /var/www/public
```
uncomment tls
```
#tls self-signed
```
and replace self-signed with your email address
```
tls midascodebreaker@gmai.com
tls serverbreaker@gmai.com
```
This is needed Prior to Creating Let's Encypt
#### Run Your Caddy Container without the -d flag and Generate SSL with Let's Encrypt
#### Run Your Caddy Container without the -d flag and Generate SSL with Let's Encrypt
```
$root@midascode:~/laravel/laradock/caddy# docker-compose up caddy
$root@server:~/laravel/laradock/caddy# docker-compose up caddy
```
you will be prompt here to enter your email... you may enter it or not
You'll be prompt here to enter your email... you may enter it or not
```
Attaching to laradock_mysql_1, laradock_caddy_1
caddy_1 | Activating privacy features...
@ -179,17 +192,18 @@ caddy_1 | https://yourdomain.com
caddy_1 | http://yourdomain.com
```
After it finish Press Ctrl + C to exit ...
After it finishes, press `Ctrl` + `C` to exit.
#### Stop All Containers and ReRun Caddy and Other Containers on Background
```
$root@midascode:~/laravel/laradock/caddy# docker-compose down
$root@midascode:~/laravel/laradock/caddy# docker-compose up -d mysql caddy
$root@server:~/laravel/laradock/caddy# docker-compose down
$root@server:~/laravel/laradock/caddy# docker-compose up -d mysql caddy
```
View your Site in the Browser Securely Using HTTPS (https://yourdomain.com)
##### Note that Certificate will be Automatically Renew By Caddy
**Note that Certificate will be Automatically Renew By Caddy**
>References:
>
@ -200,14 +214,3 @@ View your Site in the Browser Securely Using HTTPS (https://yourdomain.com)
- [https://caddyserver.com/docs/automatic-https](https://caddyserver.com/docs/automatic-https)
- [https://caddyserver.com/docs/tls](https://caddyserver.com/docs/tls)
- [https://caddyserver.com/docs/caddyfile](https://caddyserver.com/docs/caddyfile)

9
adminer/Dockerfile Normal file
View File

@ -0,0 +1,9 @@
FROM adminer:latest
MAINTAINER Patrick Artounian <partounian@gmail.com>
# Add volume for sessions to allow session persistence
VOLUME /sessions
# We expose Adminer on port 8080 (Adminer's default)
EXPOSE 8080

View File

@ -6,11 +6,13 @@ ARG PHP_SOCKET=php-fpm:9000
ENV WEB_PHP_SOCKET=$PHP_SOCKET
ENV WEB_DOCUMENT_ROOT=/var/www/public
ENV WEB_DOCUMENT_ROOT=/var/www/
EXPOSE 80 443
WORKDIR /var/www/public
WORKDIR /var/www/
ADD vhost.conf /etc/apache2/sites-enabled/vhost.conf
ENTRYPOINT ["/opt/docker/bin/entrypoint.sh"]

3
apache2/sites/.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
*.conf
!default.conf
!default.apache.conf

View File

@ -0,0 +1,16 @@
<VirtualHost *:80>
ServerName laradock.dev
DocumentRoot /var/www/html/
Options Indexes FollowSymLinks
<Directory "/var/www/html/">
AllowOverride All
<IfVersion < 2.4>
Allow from all
</IfVersion>
<IfVersion >= 2.4>
Require all granted
</IfVersion>
</Directory>
</VirtualHost>

View File

@ -0,0 +1,16 @@
<VirtualHost *:80>
ServerName sample.dev
DocumentRoot /var/www/sample/public/
Options Indexes FollowSymLinks
<Directory "/var/www/sample/public/">
AllowOverride All
<IfVersion < 2.4>
Allow from all
</IfVersion>
<IfVersion >= 2.4>
Require all granted
</IfVersion>
</Directory>
</VirtualHost>

1
apache2/vhost.conf Normal file
View File

@ -0,0 +1 @@
Include /etc/apache2/sites-available/*.conf

View File

@ -1,5 +1,7 @@
FROM phusion/baseimage:latest
MAINTAINER Mahmoud Zalt <mahmoud@zalt.me>
COPY run-certbot.sh /root/certbot/run-certbot.sh
RUN apt-get update

View File

@ -5,406 +5,571 @@ services:
### Applications Code Container #############################
applications:
image: tianon/true
volumes:
- ../:/var/www
# - ../sample/:/var/www/sample
image: tianon/true
volumes:
- ${APPLICATION}:/var/www
### Workspace Utilities Container ###########################
workspace:
build:
context: ./workspace
args:
- INSTALL_XDEBUG=false
- INSTALL_SOAP=false
- INSTALL_MONGO=false
- INSTALL_NODE=false
- INSTALL_YARN=false
- INSTALL_DRUSH=false
- INSTALL_AEROSPIKE_EXTENSION=false
- INSTALL_V8JS_EXTENSION=false
- COMPOSER_GLOBAL_INSTALL=false
- INSTALL_WORKSPACE_SSH=false
- INSTALL_LARAVEL_ENVOY=false
- INSTALL_DEPLOYER=false
- INSTALL_LINUXBREW=false
- INSTALL_MC=false
- PUID=1000
- PGID=1000
- NODE_VERSION=stable
- YARN_VERSION=latest
- TZ=UTC
# dockerfile: Dockerfile-71
volumes_from:
- applications
extra_hosts:
# IMPORTANT: Replace with your Docker Host IP (will be appended to /etc/hosts)
- "dockerhost:10.0.75.1"
ports:
- "2222:22"
tty: true
build:
context: ./workspace
args:
- INSTALL_XDEBUG=${WORKSPACE_INSTALL_XDEBUG}
- INSTALL_SOAP=${WORKSPACE_INSTALL_SOAP}
- INSTALL_MONGO=${WORKSPACE_INSTALL_MONGO}
- INSTALL_NODE=${WORKSPACE_INSTALL_NODE}
- INSTALL_YARN=${WORKSPACE_INSTALL_YARN}
- INSTALL_DRUSH=${WORKSPACE_INSTALL_DRUSH}
- INSTALL_AEROSPIKE_EXTENSION=${WORKSPACE_INSTALL_AEROSPIKE_EXTENSION}
- INSTALL_V8JS_EXTENSION=${WORKSPACE_INSTALL_INSTALL_V8JS_EXTENSION}
- COMPOSER_GLOBAL_INSTALL=${WORKSPACE_COMPOSER_GLOBAL_INSTALL}
- INSTALL_WORKSPACE_SSH=${WORKSPACE_INSTALL_WORKSPACE_SSH}
- INSTALL_LARAVEL_ENVOY=${WORKSPACE_INSTALL_LARAVEL_ENVOY}
- INSTALL_DEPLOYER=${WORKSPACE_INSTALL_DEPLOYER}
- INSTALL_LINUXBREW=${WORKSPACE_INSTALL_LINUXBREW}
- INSTALL_MC=${WORKSPACE_INSTALL_MC}
- INSTALL_SYMFONY=${WORKSPACE_INSTALL_SYMFONY}
- PUID=${WORKSPACE_PUID}
- PGID=${WORKSPACE_PGID}
- NODE_VERSION=${WORKSPACE_NODE_VERSION}
- YARN_VERSION=${WORKSPACE_YARN_VERSION}
- TZ=${WORKSPACE_TIMEZONE}
dockerfile: "Dockerfile-${PHP_VERSION}"
volumes_from:
- applications
extra_hosts:
- "dockerhost:${DOCKER_HOST_IP}"
ports:
- "${WORKSPACE_SSH_PORT}:22"
tty: true
networks:
- frontend
- backend
### PHP-FPM Container #######################################
php-fpm:
build:
context: ./php-fpm
args:
- INSTALL_XDEBUG=false
- INSTALL_SOAP=false
- INSTALL_MONGO=false
- INSTALL_ZIP_ARCHIVE=false
- INSTALL_BCMATH=false
- INSTALL_PHPREDIS=false
- INSTALL_MEMCACHED=false
- INSTALL_OPCACHE=false
- INSTALL_EXIF=false
- INSTALL_AEROSPIKE_EXTENSION=false
- CODEIGNITER=false
- GHOSTSCRIPT=false
dockerfile: Dockerfile-70
volumes_from:
- applications
expose:
- "9000"
links:
- workspace
extra_hosts:
# IMPORTANT: Replace with your Docker Host IP (will be appended to /etc/hosts)
- "dockerhost:10.0.75.1"
environment:
# IMPORTANT: Set the Remote Interpreter entry matching name to `laravel`
- PHP_IDE_CONFIG=serverName=laravel
build:
context: ./php-fpm
args:
- INSTALL_XDEBUG=${PHP_FPM_INSTALL_XDEBUG}
- INSTALL_SOAP=${PHP_FPM_INSTALL_SOAP}
- INSTALL_MONGO=${PHP_FPM_INSTALL_MONGO}
- INSTALL_ZIP_ARCHIVE=${PHP_FPM_INSTALL_ZIP_ARCHIVE}
- INSTALL_BCMATH=${PHP_FPM_INSTALL_BCMATH}
- INSTALL_PHPREDIS=${PHP_FPM_INSTALL_PHPREDIS}
- INSTALL_MEMCACHED=${PHP_FPM_INSTALL_MEMCACHED}
- INSTALL_OPCACHE=${PHP_FPM_INSTALL_OPCACHE}
- INSTALL_EXIF=${PHP_FPM_INSTALL_EXIF}
- INSTALL_AEROSPIKE_EXTENSION=${PHP_FPM_INSTALL_AEROSPIKE_EXTENSION}
- INSTALL_MYSQLI=${PHP_FPM_INSTALL_MYSQLI}
- INSTALL_TOKENIZER=${PHP_FPM_INSTALL_TOKENIZER}
- INSTALL_INTL=${PHP_FPM_INSTALL_INTL}
- INSTALL_GHOSTSCRIPT=${PHP_FPM_INSTALL_GHOSTSCRIPT}
dockerfile: "Dockerfile-${PHP_VERSION}"
volumes_from:
- applications
expose:
- "9000"
depends_on:
- workspace
extra_hosts:
- "dockerhost:${DOCKER_HOST_IP}"
environment:
- PHP_IDE_CONFIG=${PHP_IDE_CONFIG}
networks:
- backend
### PHP Worker Container #####################################
php-worker:
build:
context: ./php-worker
volumes_from:
- applications
depends_on:
- workspace
networks:
- backend
### Nginx Server Container ##################################
nginx:
build:
context: ./nginx
args:
- PHP_UPSTREAM=php-fpm
volumes_from:
- applications
volumes:
- ./logs/nginx/:/var/log/nginx
- ./nginx/sites/:/etc/nginx/sites-available
ports:
- "80:80"
- "443:443"
links:
- php-fpm
build:
context: ./nginx
args:
- PHP_UPSTREAM=php-fpm
volumes_from:
- applications
volumes:
- ${NGINX_HOST_LOG_PATH}:/var/log/nginx
- ${NGINX_SITES_PATH}:/etc/nginx/sites-available
ports:
- "${NGINX_HOST_HTTP_PORT}:80"
- "${NGINX_HOST_HTTPS_PORT}:443"
depends_on:
- php-fpm
networks:
- frontend
- backend
### Apache Server Container #################################
apache2:
build:
context: ./apache2
args:
- PHP_SOCKET=php-fpm:9000
volumes_from:
- applications
volumes:
- ./logs/apache2:/var/log/apache2
ports:
- "80:80"
- "443:443"
links:
- php-fpm
build:
context: ./apache2
args:
- PHP_SOCKET=${PHP_SOCKET}
volumes_from:
- applications
volumes:
- ${APACHE_HOST_LOG_PATH}:/var/log/apache2
- ./apache2/sites:/etc/apache2/sites-available
ports:
- "${APACHE_HOST_HTTP_PORT}:80"
- "${APACHE_HOST_HTTPS_PORT}:443"
depends_on:
- php-fpm
networks:
- frontend
- backend
### HHVM Container ##########################################
hhvm:
build: ./hhvm
volumes_from:
- applications
expose:
- "9000"
links:
- workspace
build: ./hhvm
volumes_from:
- applications
expose:
- "9000"
depends_on:
- workspace
networks:
- frontend
- backend
### Minio Container #########################################
minio:
build: ./minio
volumes:
- minio:/export
ports:
- "9000:9000"
environment:
MINIO_ACCESS_KEY: access
MINIO_SECRET_KEY: secretkey
build: ./minio
volumes:
- minio:/export
ports:
- "${MINIO_PORT}:9000"
environment:
- MINIO_ACCESS_KEY=access
- MINIO_SECRET_KEY=secretkey
networks:
- frontend
### MySQL Container #########################################
mysql:
build:
context: ./mysql
args:
- MYSQL_DATABASE=homestead
- MYSQL_USER=homestead
- MYSQL_PASSWORD=secret
- MYSQL_ROOT_PASSWORD=root
volumes:
- mysql:/var/lib/mysql
ports:
- "3306:3306"
build:
context: ./mysql
environment:
- MYSQL_DATABASE=${MYSQL_DATABASE}
- MYSQL_USER=${MYSQL_USER}
- MYSQL_PASSWORD=${MYSQL_PASSWORD}
- MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}
volumes:
- mysql:/var/lib/mysql
ports:
- "${MYSQL_PORT}:3306"
networks:
- backend
### MSSQL Container #########################################
mssql:
build:
context: ./mssql
environment:
- MSSQL_DATABASE=${MSSQL_DATABASE}
- SA_PASSWORD=${MSSQL_PASSWORD}
- ACCEPT_EULA=Y
volumes:
- mssql:/var/opt/mssql
ports:
- "${MSSQL_PORT}:1433"
networks:
- backend
### MariaDB Container #######################################
mariadb:
build: ./mariadb
volumes:
- mariadb:/var/lib/mysql
ports:
- "3306:3306"
environment:
MYSQL_DATABASE: homestead
MYSQL_USER: homestead
MYSQL_PASSWORD: secret
MYSQL_ROOT_PASSWORD: root
build: ./mariadb
volumes:
- mariadb:/var/lib/mysql
ports:
- "${MARIADB_PORT}:3306"
environment:
- MYSQL_DATABASE=${MARIADB_DATABASE}
- MYSQL_USER=${MARIADB_USER}
- MYSQL_PASSWORD=${MARIADB_PASSWORD}
- MYSQL_ROOT_PASSWORD=${MARIADB_ROOT_PASSWORD}
networks:
- backend
### PostgreSQL Container ####################################
postgres:
build: ./postgres
volumes:
- postgres:/var/lib/postgresql/data
ports:
- "5432:5432"
environment:
POSTGRES_DB: homestead
POSTGRES_USER: homestead
POSTGRES_PASSWORD: secret
build: ./postgres
volumes:
- postgres:/var/lib/postgresql/data
ports:
- "${POSTGRES_PORT}:5432"
environment:
- POSTGRES_DB=${POSTGRES_DB}
- POSTGRES_USER=${POSTGRES_USER}
- POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
networks:
- backend
### PostgreSQL PostGis Container ############################
postgres-postgis:
build: ./postgres-postgis
volumes:
- postgres:/var/lib/postgresql/data
ports:
- "5432:5432"
environment:
POSTGRES_DB: homestead
POSTGRES_USER: homestead
POSTGRES_PASSWORD: secret
build: ./postgres-postgis
volumes:
- postgres:/var/lib/postgresql/data
ports:
- "${POSTGRES_PORT}:5432"
environment:
- POSTGRES_DB=${POSTGRES_DB}
- POSTGRES_USER=${POSTGRES_USER}
- POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
networks:
- backend
### Neo4j Container #########################################
neo4j:
build: ./neo4j
ports:
- "7474:7474"
- "1337:1337"
environment:
- NEO4J_AUTH=homestead:secret
volumes:
- neo4j:/var/lib/neo4j/data
build: ./neo4j
ports:
- "7474:7474"
- "1337:1337"
environment:
- NEO4J_AUTH=default:secret
volumes:
- neo4j:/var/lib/neo4j/data
networks:
- backend
### MongoDB Container #######################################
mongo:
build: ./mongo
ports:
- "27017:27017"
volumes:
- mongo:/data/db
build: ./mongo
ports:
- "27017:27017"
volumes:
- mongo:/data/db
networks:
- backend
### RethinkDB Container #######################################
rethinkdb:
build: ./rethinkdb
ports:
- "8090:8080"
volumes:
- rethinkdb:/data/rethinkdb_data
build: ./rethinkdb
ports:
- "8090:8080"
volumes:
- rethinkdb:/data/rethinkdb_data
networks:
- backend
### Redis Container #########################################
redis:
build: ./redis
volumes:
- redis:/data
ports:
- "6379:6379"
build: ./redis
volumes:
- redis:/data
ports:
- "6379:6379"
networks:
- backend
### Aerospike c Container ###################################
aerospike:
build: ./aerospike
volumes_from:
- workspace
volumes:
- aerospike:/opt/aerospike/data
ports:
- "3000:3000"
- "3001:3001"
- "3002:3002"
- "3003:3003"
build: ./aerospike
volumes_from:
- workspace
volumes:
- aerospike:/opt/aerospike/data
ports:
- "3000:3000"
- "3001:3001"
- "3002:3002"
- "3003:3003"
networks:
- backend
### Memcached Container #####################################
memcached:
build: ./memcached
volumes:
- memcached:/var/lib/memcached
ports:
- "11211:11211"
links:
- php-fpm
build: ./memcached
volumes:
- memcached:/var/lib/memcached
ports:
- "${MEMCACHED_HOST_PORT}:11211"
depends_on:
- php-fpm
networks:
- backend
### Beanstalkd Container ####################################
beanstalkd:
build: ./beanstalkd
ports:
- "11300:11300"
privileged: true
links:
- php-fpm
build: ./beanstalkd
ports:
- "${BEANSTALKD_HOST_PORT}:11300"
privileged: true
depends_on:
- php-fpm
networks:
- backend
### RabbitMQ Container ######################################
rabbitmq:
build: ./rabbitmq
ports:
- "5672:5672"
- "15671:15671"
- "8080:15672"
privileged: true
environment:
RABBITMQ_DEFAULT_USER: guest
RABBITMQ_DEFAULT_PASS: guest
links:
- php-fpm
build: ./rabbitmq
ports:
- "${RABBITMQ_NODE_HOST_PORT}:5672"
- "${RABBITMQ_MANAGEMENT_HTTP_HOST_PORT}:15672"
- "${RABBITMQ_MANAGEMENT_HTTPS_HOST_PORT}:15671"
privileged: true
environment:
- RABBITMQ_DEFAULT_USER=${RABBITMQ_DEFAULT_USER}
- RABBITMQ_DEFAULT_PASS=${RABBITMQ_DEFAULT_PASS}
depends_on:
- php-fpm
networks:
- backend
### Beanstalkd Console Container ############################
beanstalkd-console:
build: ./beanstalkd-console
ports:
- "2080:2080"
links:
- beanstalkd
build: ./beanstalkd-console
ports:
- "2080:2080"
depends_on:
- beanstalkd
networks:
- backend
### Caddy Server Container ##################################
caddy:
build: ./caddy
ports:
- "80:80"
- "443:443"
- "2015:2015"
volumes_from:
- applications
volumes:
- ./caddy/Caddyfile:/etc/Caddyfile
- ./logs/caddy:/var/log/caddy
- caddy:/root/.caddy
links:
- php-fpm
build: ./caddy
ports:
- "80:80"
- "443:443"
- "2015:2015"
volumes_from:
- applications
volumes:
- ./caddy/Caddyfile:/etc/Caddyfile
- ./logs/caddy:/var/log/caddy
- caddy:/root/.caddy
depends_on:
- php-fpm
networks:
- frontend
- backend
### phpMyAdmin Container ####################################
phpmyadmin:
build: ./phpmyadmin
environment:
PMA_ARBITRARY: 1
MYSQL_USER: homestead
MYSQL_PASSWORD: secret
MYSQL_ROOT_PASSWORD: root
ports:
- "8080:80"
links:
# for mysql container
- "mysql:db"
# for mariadb container
# - "mariadb:db"
build: ./phpmyadmin
environment:
- PMA_ARBITRARY=1
- MYSQL_USER=${PMA_USER}
- MYSQL_PASSWORD=${PMA_PASSWORD}
- MYSQL_ROOT_PASSWORD=${PMA_ROOT_PASSWORD}
ports:
- "${PMA_PORT}:80"
depends_on:
- "${PMA_DB_ENGINE}"
networks:
- frontend
- backend
### Adminer Container ####################################
adminer:
build: ./adminer
ports:
- "${ADM_PORT}:8080"
depends_on:
- php-fpm
networks:
- frontend
### pgAdmin Container #######################################
pgadmin:
build: ./pgadmin
ports:
- "5050:5050"
links:
- postgres
build: ./pgadmin
ports:
- "5050:5050"
depends_on:
- postgres
networks:
- frontend
### ElasticSearch Container #################################
elasticsearch:
build: ./elasticsearch
volumes:
- elasticsearch-data:/usr/share/elasticsearch/data
- elasticsearch-plugins:/usr/share/elasticsearch/plugins
ports:
- "9200:9200"
- "9300:9300"
links:
- php-fpm
build: ./elasticsearch
volumes:
- elasticsearch-data:/usr/share/elasticsearch/data
- elasticsearch-plugins:/usr/share/elasticsearch/plugins
ports:
- "${ELASTICSEARCH_HOST_HTTP_PORT}:9200"
- "${ELASTICSEARCH_HOST_TRANSPORT_PORT}:9300"
depends_on:
- php-fpm
networks:
- frontend
### Certbot Container ##################################
certbot:
build:
context: ./certbot
volumes:
- ./data/certbot/certs/:/var/certs
- ./certbot/letsencrypt/:/var/www/letsencrypt
environment:
CN: "fake.domain.com"
EMAIL: "fake.email@gmail.com"
build:
context: ./certbot
volumes:
- ./data/certbot/certs/:/var/certs
- ./certbot/letsencrypt/:/var/www/letsencrypt
environment:
- CN="fake.domain.com"
- EMAIL="fake.email@gmail.com"
networks:
- frontend
### Mailhog Container #########################################
mailhog:
build: ./mailhog
ports:
- "1025:1025"
- "8025:8025"
build: ./mailhog
ports:
- "1025:1025"
- "8025:8025"
networks:
- frontend
### Selenium Container #########################################
### Selenium Container ########################################
selenium:
build: ./selenium
ports:
- "4444:4444"
volumes:
# see https://github.com/SeleniumHQ/docker-selenium#running-the-images
- /dev/shm:/dev/shm
build: ./selenium
ports:
- "${SELENIUM_PORT}:4444"
volumes:
- /dev/shm:/dev/shm
networks:
- frontend
### Volumes Setup ###########################################
### Varnish Proxy 1 ##########################################
proxy:
build: ./varnish
expose:
- ${VARNISH_PORT}
environment:
- VARNISH_CONFIG=${VARNISH_CONFIG}
- CACHE_SIZE=${VARNISH_PROXY1_CACHE_SIZE}
- VARNISHD_PARAMS=${VARNISHD_PARAMS}
- VARNISH_PORT=${VARNISH_PORT}
- BACKEND_HOST=${VARNISH_PROXY1_BACKEND_HOST}
- BACKEND_PORT=${VARNISH_BACKEND_PORT}
- VARNISH_SERVER=${VARNISH_PROXY1_SERVER}
links:
- workspace
networks:
- frontend
### Varnish Proxy 2 ##########################################
proxy2:
build: ./varnish
expose:
- ${VARNISH_PORT}
environment:
- VARNISH_CONFIG=${VARNISH_CONFIG}
- CACHE_SIZE=${VARNISH_PROXY2_CACHE_SIZE}
- VARNISHD_PARAMS=${VARNISHD_PARAMS}
- VARNISH_PORT=${VARNISH_PORT}
- BACKEND_HOST=${VARNISH_PROXY2_BACKEND_HOST}
- BACKEND_PORT=${VARNISH_BACKEND_PORT}
- VARNISH_SERVER=${VARNISH_PROXY2_SERVER}
links:
- workspace
networks:
- frontend
### Balancer Haproxy ##########################################
balancer:
build: ./haproxy
ports:
- "${HAPROXY_HOST_HTTP_PORT}:8085"
volumes:
- /var/run/docker.sock:/var/run/docker.sock
links:
- proxy
- proxy2
### Jenkins ###################################################
jenkins:
build: ./jenkins
environment:
JAVA_OPTS: "-Djava.awt.headless=true"
ports:
- "${JENKINS_HOST_SLAVE_AGENT_PORT}:50000"
- "${JENKINS_HOST_HTTP_PORT}:8080"
privileged: true
volumes:
- ${JENKINS_HOME}:/var/jenkins_home
- /var/run/docker.sock:/var/run/docker.sock
### Networks Setup ############################################
networks:
frontend:
driver: "bridge"
backend:
driver: "bridge"
### Volumes Setup #############################################
volumes:
mysql:
driver: "local"
postgres:
driver: "local"
memcached:
driver: "local"
redis:
driver: "local"
neo4j:
driver: "local"
mariadb:
driver: "local"
mongo:
driver: "local"
minio:
driver: "local"
rethinkdb:
driver: "local"
phpmyadmin:
driver: "local"
aerospike:
driver: "local"
caddy:
driver: "local"
elasticsearch-data:
driver: "local"
elasticsearch-plugins:
driver: "local"
sessions: ## nothing is connected to this (- ./data/sessions:/sessions)
driver: "local"
mysql:
driver: "local"
mssql:
driver: "local"
postgres:
driver: "local"
memcached:
driver: "local"
redis:
driver: "local"
neo4j:
driver: "local"
mariadb:
driver: "local"
mongo:
driver: "local"
minio:
driver: "local"
rethinkdb:
driver: "local"
phpmyadmin:
driver: "local"
adminer:
driver: "local"
aerospike:
driver: "local"
caddy:
driver: "local"
elasticsearch-data:
driver: "local"
elasticsearch-plugins:
driver: "local"

View File

@ -1,181 +0,0 @@
---
title: Getting Started
type: index
weight: 2
---
## Requirements
- [Git](https://git-scm.com/downloads)
- [Docker](https://www.docker.com/products/docker/) `>= 1.12`
## Installation
Choose the setup the best suits your needs.
#### A) Setup for Single Project:
*(In case you want a Docker environment for each project)*
##### A.1) Setup environment in existing Project:
*(In case you already have a project, and you want to setup an environment to run it)*
1 - Clone this repository on your project root directory:
```bash
git submodule add https://github.com/Laradock/laradock.git
```
*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.*
*Note 2: To keep track of your LaraDock changes, between your projects and also keep LaraDock updated. [Check this](#keep-tracking-LaraDock)*
*Note 3: In this case the folder structure will be like this:*
```
- project1
- laradock
- project2
- laradock
```
##### A.2) Setup environment first then create project:
*(In case you don't have a project, and you want to create your project inside the Docker environment)*
1 - Clone this repository anywhere on your machine:
```bash
git clone https://github.com/laradock/laradock.git
```
Note: In this case the folder structure will be like this:
```
- projects
- laradock
- myProject
```
2 - Edit the `docker-compose.yml` file to map to your project directory once you have it (example: `- ../myProject:/var/www`).
3 - Stop and re-run your docker-compose command for the changes to take place.
```
docker-compose stop && docker-compose up -d XXXX YYYY ZZZZ ....
```
#### B) Setup for Multiple Projects:
1 - Clone this repository anywhere on your machine:
```bash
git clone https://github.com/laradock/laradock.git
```
2 - Edit the `docker-compose.yml` file to map to your projects directories:
```
applications:
image: tianon/true
volumes:
- ../project1/:/var/www/project1
- ../project2/:/var/www/project2
```
3 - You can access all sites by visiting `http://localhost/project1/public` and `http://localhost/project2/public` but of course that's not very useful so let's setup NGINX quickly.
4 - Go to `nginx/sites` and copy `sample.conf.example` to `project1.conf` then to `project2.conf`
5 - Open the `project1.conf` file and edit the `server_name` and the `root` as follow:
```
server_name project1.dev;
root /var/www/project1/public;
```
Do the same for each project `project2.conf`, `project3.conf`,...
6 - Add the domains to the **hosts** files.
```
127.0.0.1 project1.dev
```
7 - Create your project Databases. Right now you have to do it manually by entering your DB container, until we automate it soon.
## Usage
**Read Before starting:**
If you are using **Docker Toolbox** (VM), do one of the following:
- Upgrade to Docker [Native](https://www.docker.com/products/docker) for Mac/Windows (Recommended). Check out [Upgrading LaraDock](#upgrading-laradock)
- Use LaraDock v3.* (Visit the `LaraDock-ToolBox` [Branch](https://github.com/laradock/laradock/tree/LaraDock-ToolBox)).
<br>
>**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.
<br>
1 - Run Containers: *(Make sure you are in the `laradock` folder before running the `docker-compose` commands).*
**Example:** Running NGINX and MySQL:
```bash
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:
`nginx`, `hhvm`, `php-fpm`, `mysql`, `redis`, `postgres`, `mariadb`, `neo4j`, `mongo`, `apache2`, `caddy`, `memcached`, `beanstalkd`, `beanstalkd-console`, `rabbitmq`, `workspace`, `phpmyadmin`, `aerospike`, `pgadmin`, `elasticsearch`, `rethinkdb`.
<br>
2 - 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:
```bash
docker exec -it {workspace-container-id} bash
```
**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`).
<br>
3 - Edit your project configurations.
Open your `.env` file and set the `DB_HOST` to `mysql`:
```env
DB_HOST=mysql
```
*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).*
<br>
4 - Open your browser and visit your localhost address (`http://localhost/`).
<br>
**Debugging**: if you are facing any problem here check the [Debugging](#debugging) section.
If you need a special support. Contact me, more details in the [Help & Questions](#Help) section.

View File

@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
<meta http-equiv="X-UA-Compatible" content="IE=10" />
<title>Contributing - Laradock</title>
<meta name="generator" content="Hugo 0.18.1" />
<meta name="generator" content="Hugo 0.19" />
<meta name="description" content="Laradock documentations.">
@ -315,39 +315,52 @@
<p>Your contribution is more than welcome.</p>
<h2 id="got-a-question-or-problem">Got a Question or Problem?</h2>
<h2 id="i-have-a-question-problem">I have a Question/Problem</h2>
<p>If you have questions about how to use LaraDock, please direct your questions to the discussion on <a href="https://gitter.im/LaraDock/laradock">Gitter</a>. If you believe your question could help others, then consider opening an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as Question).</p>
<p>If you have questions about how to use Laradock, please direct your questions to the discussion on <a href="https://gitter.im/Laradock/laradock">Gitter</a>. If you believe your question could help others, then consider opening an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as <code>Question</code>) And you can still seek help on Gitter for it.</p>
<h2 id="found-an-issue">Found an Issue?</h2>
<h2 id="i-found-an-issue">I found an Issue</h2>
<p>If you find a bug in the source code or a mistake in the documentation, you can help us by
submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. Even better you can submit a Pull Request with a fix.</p>
<p>If have an issue or you found a typo in the documentation, you can help us by
opnening an <a href="https://github.com/laradock/laradock/issues">Issue</a>.</p>
<h2 id="want-a-feature">Want a Feature?</h2>
<p><strong>Steps to do before opening an Issue:</strong></p>
<p>You can request a new feature by submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.</p>
<ol>
<li><p>Before you submit your issue search the archive, maybe your question was already answered couple hours ago (search in the closed Issues as well).</p></li>
<h2 id="update-documentation-site">Update Documentation (Site)</h2>
<li><p>Decide if the Issue belongs to this project or to <a href="https://github.com/docker">Docker</a> itself! or even the tool you are using such as Nginx or MongoDB&hellip;</p></li>
</ol>
<p>If your issue appears to be a bug, and hasn&rsquo;t been reported, then open a new issue.</p>
<p><em>This Help us to maximize the effort we can spend fixing issues and adding new
features, by not reporting duplicate issues.</em></p>
<h2 id="i-want-a-feature">I want a Feature</h2>
<p>You can request a new feature by submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as <code>Feature Suggestion</code>). If you would like to implement a new feature then consider submitting a Pull Request yourself.</p>
<h2 id="i-want-to-update-the-documentation-site">I want to update the Documentation (Site)</h2>
<p>Laradock uses <a href="https://gohugo.io/">Hugo</a> as website generator tool, with the <a href="http://themes.gohugo.io/theme/material-docs/">Material Docs theme</a>. You might need to check their docs quickly.</p>
<ol>
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine.</li>
<li>Clone laradock.</li>
<li>Go to <code>/docs</code>.</li>
<li>Delete everything except the <code>_settings</code> folder &amp; the <code>CNAME</code> file.</li>
<li>Open <code>docs/_settings</code> from your terminal and run <code>hugo serve</code> to host the website locally.</li>
<li>Open the <code>docs/_settings/content</code> and search for the folder of the section you want to edit.</li>
<li>In each section there&rsquo;s an <code>index.md</code> file, that&rsquo;s the file you need to edit.</li>
<li>To edit the sidebar (in case you are adding new section) go to <code>docs/_settings/config.toml</code> and add the section there.</li>
<li>After done editing, run the this command <code>hugo</code> to generate the updated site inside the <code>docs</code> folder.</li>
<li>Go back to the project root directory, commit and push..</li>
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy thing).</li>
<li>Open the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder represents a section in the menu).</li>
<li>Delete the <code>/docs</code> folder from the root.</li>
<li>When you finish editing, go to <code>DOCUMENTATION/_settings/</code> and run the <code>hugo</code> command to generate the HTML docs (inside new <code>/docs</code> folder).</li>
</ol>
<h2 id="coding-guidelines">Coding Guidelines</h2>
<h3 id="to-host-the-website-locally">To Host the website locally</h3>
<h2 id="support-new-software">Support new Software</h2>
<p>Go to <code>DOCUMENTATION/_settings</code> in your terminal and run <code>hugo serve</code> to host the website locally.</p>
<h3 id="edit-the-sidebar">Edit the sidebar</h3>
<p>To add a new section to the sidebar or edit existing one, you need to edit this file <code>DOCUMENTATION/_settings/config.toml</code>.</p>
<h2 id="how-to-support-new-software-add-new-container">How to support new Software (Add new Container)</h2>
<ul>
<li><p>Create folder with the software name.</p></li>
@ -360,10 +373,10 @@ submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. E
<li><p>Make sure you follow our commenting style.</p></li>
<li><p>Add the software in the <code>Readme</code>.</p></li>
<li><p>Add the software in the <code>Documentation</code>.</p></li>
</ul>
<h2 id="edit-existing-software">Edit existing Software</h2>
<h2 id="edit-existing-software-edit-a-container">Edit existing Software (Edit a Container)</h2>
<ul>
<li><p>Open the software (container) folder.</p></li>
@ -371,22 +384,14 @@ submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. E
<li><p>Edit the files you want to update.</p></li>
<li><p><strong>Note:</strong> If you want to edit the base image of the <code>Workspace</code> or the <code>php-fpm</code> Containers,
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the LaraDock repository.</p></li>
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.</p></li>
<li><p>Make sure to update the <code>Readme</code> in case you made any changes.</p></li>
<li><p>Make sure to update the <code>Documentation</code> in case you made any changes.</p></li>
</ul>
<h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2>
<h2 id="pull-request">Pull Request</h2>
<h2 id="submitting-an-issue">Submitting an Issue</h2>
<p>Before you submit your issue search the archive, maybe your question was already answered.</p>
<p>If your issue appears to be a bug, and hasn&rsquo;t been reported, open a new issue.
Help us to maximize the effort we can spend fixing issues and adding new
features, by not reporting duplicate issues.</p>
<h2 id="before-submitting-a-pull-request-pr">Before Submitting a Pull Request (PR)</h2>
<h3 id="1-before-submitting-a-pull-request-pr">1. Before Submitting a Pull Request (PR)</h3>
<p>Always Test everything and make sure its working:</p>
@ -402,16 +407,16 @@ features, by not reporting duplicate issues.</p>
<ul>
<li>Testing building the container (docker-compose build container-name) with no errors.</li>
<li>Test it in real App.</li>
<li>Test it in a real App if possible.</li>
</ul></li>
</ul>
<h2 id="submitting-a-pr">Submitting a PR</h2>
<h3 id="2-submitting-a-pr">2. Submitting a PR</h3>
<p>Consider the following guidelines:</p>
<ul>
<li><p>Search <a href="https://github.com/laradock/laradock/pulls">GitHub</a> for an open or closed Pull Request that relates to your submission. You don&rsquo;t want to duplicate effort.</p></li>
<li><p>Search <a href="https://github.com/laradock/laradock/pulls">GitHub</a> for an open or closed Pull Request that relates to your submission. You don&rsquo;t want to duplicate efforts.</p></li>
<li><p>Make your changes in a new git branch:</p>
@ -446,10 +451,9 @@ git push origin my-fix-branch -f
<p><em>WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments on code that were previously made by you and others in your commits.</em></p>
<h2 id="after-your-pr-is-merged">After your PR is merged</h2>
<h3 id="3-after-your-pr-is-merged">3. After your PR is merged</h3>
<p>After your pull request is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository:</p>
<p>After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:</p>
<ul>
<li><p>Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:</p>
@ -475,7 +479,7 @@ from the main (upstream) repository:</p>
<p><br></p>
<h2 id="happy-coding">Happy Coding :)</h2>
<h4 id="happy-coding">Happy Coding :)</h4>
<aside class="copyright" role="note">

View File

@ -18,39 +18,52 @@
&lt;p&gt;Your contribution is more than welcome.&lt;/p&gt;
&lt;h2 id=&#34;got-a-question-or-problem&#34;&gt;Got a Question or Problem?&lt;/h2&gt;
&lt;h2 id=&#34;i-have-a-question-problem&#34;&gt;I have a Question/Problem&lt;/h2&gt;
&lt;p&gt;If you have questions about how to use LaraDock, please direct your questions to the discussion on &lt;a href=&#34;https://gitter.im/LaraDock/laradock&#34;&gt;Gitter&lt;/a&gt;. If you believe your question could help others, then consider opening an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt; (it will be labeled as Question).&lt;/p&gt;
&lt;p&gt;If you have questions about how to use Laradock, please direct your questions to the discussion on &lt;a href=&#34;https://gitter.im/Laradock/laradock&#34;&gt;Gitter&lt;/a&gt;. If you believe your question could help others, then consider opening an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt; (it will be labeled as &lt;code&gt;Question&lt;/code&gt;) And you can still seek help on Gitter for it.&lt;/p&gt;
&lt;h2 id=&#34;found-an-issue&#34;&gt;Found an Issue?&lt;/h2&gt;
&lt;h2 id=&#34;i-found-an-issue&#34;&gt;I found an Issue&lt;/h2&gt;
&lt;p&gt;If you find a bug in the source code or a mistake in the documentation, you can help us by
submitting an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt;. Even better you can submit a Pull Request with a fix.&lt;/p&gt;
&lt;p&gt;If have an issue or you found a typo in the documentation, you can help us by
opnening an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt;.&lt;/p&gt;
&lt;h2 id=&#34;want-a-feature&#34;&gt;Want a Feature?&lt;/h2&gt;
&lt;p&gt;&lt;strong&gt;Steps to do before opening an Issue:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You can request a new feature by submitting an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt; (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;&lt;p&gt;Before you submit your issue search the archive, maybe your question was already answered couple hours ago (search in the closed Issues as well).&lt;/p&gt;&lt;/li&gt;
&lt;h2 id=&#34;update-documentation-site&#34;&gt;Update Documentation (Site)&lt;/h2&gt;
&lt;li&gt;&lt;p&gt;Decide if the Issue belongs to this project or to &lt;a href=&#34;https://github.com/docker&#34;&gt;Docker&lt;/a&gt; itself! or even the tool you are using such as Nginx or MongoDB&amp;hellip;&lt;/p&gt;&lt;/li&gt;
&lt;/ol&gt;
&lt;p&gt;If your issue appears to be a bug, and hasn&amp;rsquo;t been reported, then open a new issue.&lt;/p&gt;
&lt;p&gt;&lt;em&gt;This Help us to maximize the effort we can spend fixing issues and adding new
features, by not reporting duplicate issues.&lt;/em&gt;&lt;/p&gt;
&lt;h2 id=&#34;i-want-a-feature&#34;&gt;I want a Feature&lt;/h2&gt;
&lt;p&gt;You can request a new feature by submitting an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt; (it will be labeled as &lt;code&gt;Feature Suggestion&lt;/code&gt;). If you would like to implement a new feature then consider submitting a Pull Request yourself.&lt;/p&gt;
&lt;h2 id=&#34;i-want-to-update-the-documentation-site&#34;&gt;I want to update the Documentation (Site)&lt;/h2&gt;
&lt;p&gt;Laradock uses &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; as website generator tool, with the &lt;a href=&#34;http://themes.gohugo.io/theme/material-docs/&#34;&gt;Material Docs theme&lt;/a&gt;. You might need to check their docs quickly.&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;Install &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; on your machine.&lt;/li&gt;
&lt;li&gt;Clone laradock.&lt;/li&gt;
&lt;li&gt;Go to &lt;code&gt;/docs&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;Delete everything except the &lt;code&gt;_settings&lt;/code&gt; folder &amp;amp; the &lt;code&gt;CNAME&lt;/code&gt; file.&lt;/li&gt;
&lt;li&gt;Open &lt;code&gt;docs/_settings&lt;/code&gt; from your terminal and run &lt;code&gt;hugo serve&lt;/code&gt; to host the website locally.&lt;/li&gt;
&lt;li&gt;Open the &lt;code&gt;docs/_settings/content&lt;/code&gt; and search for the folder of the section you want to edit.&lt;/li&gt;
&lt;li&gt;In each section there&amp;rsquo;s an &lt;code&gt;index.md&lt;/code&gt; file, that&amp;rsquo;s the file you need to edit.&lt;/li&gt;
&lt;li&gt;To edit the sidebar (in case you are adding new section) go to &lt;code&gt;docs/_settings/config.toml&lt;/code&gt; and add the section there.&lt;/li&gt;
&lt;li&gt;After done editing, run the this command &lt;code&gt;hugo&lt;/code&gt; to generate the updated site inside the &lt;code&gt;docs&lt;/code&gt; folder.&lt;/li&gt;
&lt;li&gt;Go back to the project root directory, commit and push..&lt;/li&gt;
&lt;li&gt;Install &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; on your machine (easy thing).&lt;/li&gt;
&lt;li&gt;Open the &lt;code&gt;DOCUMENTATION/_settings/content&lt;/code&gt; and search for the markdown file you want to edit (every folder represents a section in the menu).&lt;/li&gt;
&lt;li&gt;Delete the &lt;code&gt;/docs&lt;/code&gt; folder from the root.&lt;/li&gt;
&lt;li&gt;When you finish editing, go to &lt;code&gt;DOCUMENTATION/_settings/&lt;/code&gt; and run the &lt;code&gt;hugo&lt;/code&gt; command to generate the HTML docs (inside new &lt;code&gt;/docs&lt;/code&gt; folder).&lt;/li&gt;
&lt;/ol&gt;
&lt;h2 id=&#34;coding-guidelines&#34;&gt;Coding Guidelines&lt;/h2&gt;
&lt;h3 id=&#34;to-host-the-website-locally&#34;&gt;To Host the website locally&lt;/h3&gt;
&lt;h2 id=&#34;support-new-software&#34;&gt;Support new Software&lt;/h2&gt;
&lt;p&gt;Go to &lt;code&gt;DOCUMENTATION/_settings&lt;/code&gt; in your terminal and run &lt;code&gt;hugo serve&lt;/code&gt; to host the website locally.&lt;/p&gt;
&lt;h3 id=&#34;edit-the-sidebar&#34;&gt;Edit the sidebar&lt;/h3&gt;
&lt;p&gt;To add a new section to the sidebar or edit existing one, you need to edit this file &lt;code&gt;DOCUMENTATION/_settings/config.toml&lt;/code&gt;.&lt;/p&gt;
&lt;h2 id=&#34;how-to-support-new-software-add-new-container&#34;&gt;How to support new Software (Add new Container)&lt;/h2&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Create folder with the software name.&lt;/p&gt;&lt;/li&gt;
@ -63,10 +76,10 @@ submitting an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&g
&lt;li&gt;&lt;p&gt;Make sure you follow our commenting style.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Add the software in the &lt;code&gt;Readme&lt;/code&gt;.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Add the software in the &lt;code&gt;Documentation&lt;/code&gt;.&lt;/p&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&#34;edit-existing-software&#34;&gt;Edit existing Software&lt;/h2&gt;
&lt;h2 id=&#34;edit-existing-software-edit-a-container&#34;&gt;Edit existing Software (Edit a Container)&lt;/h2&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Open the software (container) folder.&lt;/p&gt;&lt;/li&gt;
@ -74,22 +87,14 @@ submitting an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&g
&lt;li&gt;&lt;p&gt;Edit the files you want to update.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt; If you want to edit the base image of the &lt;code&gt;Workspace&lt;/code&gt; or the &lt;code&gt;php-fpm&lt;/code&gt; Containers,
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the LaraDock repository.&lt;/p&gt;&lt;/li&gt;
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Make sure to update the &lt;code&gt;Readme&lt;/code&gt; in case you made any changes.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Make sure to update the &lt;code&gt;Documentation&lt;/code&gt; in case you made any changes.&lt;/p&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&#34;issue-pr-submission-guidelines&#34;&gt;Issue/PR Submission Guidelines&lt;/h2&gt;
&lt;h2 id=&#34;pull-request&#34;&gt;Pull Request&lt;/h2&gt;
&lt;h2 id=&#34;submitting-an-issue&#34;&gt;Submitting an Issue&lt;/h2&gt;
&lt;p&gt;Before you submit your issue search the archive, maybe your question was already answered.&lt;/p&gt;
&lt;p&gt;If your issue appears to be a bug, and hasn&amp;rsquo;t been reported, open a new issue.
Help us to maximize the effort we can spend fixing issues and adding new
features, by not reporting duplicate issues.&lt;/p&gt;
&lt;h2 id=&#34;before-submitting-a-pull-request-pr&#34;&gt;Before Submitting a Pull Request (PR)&lt;/h2&gt;
&lt;h3 id=&#34;1-before-submitting-a-pull-request-pr&#34;&gt;1. Before Submitting a Pull Request (PR)&lt;/h3&gt;
&lt;p&gt;Always Test everything and make sure its working:&lt;/p&gt;
@ -105,16 +110,16 @@ features, by not reporting duplicate issues.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Testing building the container (docker-compose build container-name) with no errors.&lt;/li&gt;
&lt;li&gt;Test it in real App.&lt;/li&gt;
&lt;li&gt;Test it in a real App if possible.&lt;/li&gt;
&lt;/ul&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&#34;submitting-a-pr&#34;&gt;Submitting a PR&lt;/h2&gt;
&lt;h3 id=&#34;2-submitting-a-pr&#34;&gt;2. Submitting a PR&lt;/h3&gt;
&lt;p&gt;Consider the following guidelines:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Search &lt;a href=&#34;https://github.com/laradock/laradock/pulls&#34;&gt;GitHub&lt;/a&gt; for an open or closed Pull Request that relates to your submission. You don&amp;rsquo;t want to duplicate effort.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Search &lt;a href=&#34;https://github.com/laradock/laradock/pulls&#34;&gt;GitHub&lt;/a&gt; for an open or closed Pull Request that relates to your submission. You don&amp;rsquo;t want to duplicate efforts.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Make your changes in a new git branch:&lt;/p&gt;
@ -149,10 +154,9 @@ git push origin my-fix-branch -f
&lt;p&gt;&lt;em&gt;WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments on code that were previously made by you and others in your commits.&lt;/em&gt;&lt;/p&gt;
&lt;h2 id=&#34;after-your-pr-is-merged&#34;&gt;After your PR is merged&lt;/h2&gt;
&lt;h3 id=&#34;3-after-your-pr-is-merged&#34;&gt;3. After your PR is merged&lt;/h3&gt;
&lt;p&gt;After your pull request is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository:&lt;/p&gt;
&lt;p&gt;After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:&lt;/p&gt;
@ -178,7 +182,7 @@ from the main (upstream) repository:&lt;/p&gt;
&lt;p&gt;&lt;br&gt;&lt;/p&gt;
&lt;h2 id=&#34;happy-coding&#34;&gt;Happy Coding :)&lt;/h2&gt;
&lt;h4 id=&#34;happy-coding&#34;&gt;Happy Coding :)&lt;/h4&gt;
</description>
</item>

View File

@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
<meta http-equiv="X-UA-Compatible" content="IE=10" />
<title>Documentation - Laradock</title>
<meta name="generator" content="Hugo 0.18.1" />
<meta name="generator" content="Hugo 0.19" />
<meta name="description" content="Laradock documentations.">
@ -447,6 +447,11 @@ example for <code>mysql</code> it will be <code>mysql/Dockerfile</code>.</p>
<pre><code class="language-bash">docker logs {container-name}
</code></pre>
<p>More <a href="https://docs.docker.com/compose/reference/logs/">options</a></p>
<pre><code class="language-bash">docker logs -f {container-name}
</code></pre>
<p><br>
<a name="PHP"></a></p>
@ -577,7 +582,7 @@ xdebug.remote_connect_back=1
<p>By installing xDebug, you are enabling it to run on startup by default.</p>
<p>To control the behavior of xDebug (in the <code>php-fpm</code> Container), you can run the following commands from the LaraDock root folder, (at the same prompt where you run docker-compose):</p>
<p>To control the behavior of xDebug (in the <code>php-fpm</code> Container), you can run the following commands from the Laradock root folder, (at the same prompt where you run docker-compose):</p>
<ul>
<li>Stop xDebug from running by default: <code>./xdebugPhpFpm stop</code>.</li>
@ -617,11 +622,11 @@ xdebug.remote_connect_back=1
<a name="Production"></a></p>
<p><br>
<a name="LaraDock-for-Production"></a></p>
<a name="Laradock-for-Production"></a></p>
<h2 id="prepare-laradock-for-production">Prepare LaraDock for Production</h2>
<h2 id="prepare-laradock-for-production">Prepare Laradock for Production</h2>
<p>It&rsquo;s recommended for production to create a custom <code>docker-compose.yml</code> file. For that reason, LaraDock is shipped with <code>production-docker-compose.yml</code> which should contain only the containers you are planning to run on production (usage example: <code>docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...</code>).</p>
<p>It&rsquo;s recommended for production to create a custom <code>docker-compose.yml</code> file. For that reason, Laradock is shipped with <code>production-docker-compose.yml</code> which should contain only the containers you are planning to run on production (usage example: <code>docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...</code>).</p>
<p>Note: The Database (MySQL/MariaDB/&hellip;) 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:</p>
@ -662,7 +667,7 @@ xdebug.remote_connect_back=1
<p>3 - Edit <code>docker-compose.yml</code> to Map the new application path:</p>
<p>By default, LaraDock assumes the Laravel application is living in the parent directory of the laradock folder.</p>
<p>By default, Laradock assumes the Laravel application is living in the parent directory of the laradock folder.</p>
<p>Since the new Laravel application is in the <code>my-cool-app</code> folder, we need to replace <code>../:/var/www</code> with <code>../my-cool-app/:/var/www</code>, as follow:</p>
@ -678,7 +683,7 @@ xdebug.remote_connect_back=1
<pre><code class="language-bash">cd my-cool-app
</code></pre>
<p>5 - Go back to the LaraDock installation steps to see how to edit the <code>.env</code> file.</p>
<p>5 - Go back to the Laradock installation steps to see how to edit the <code>.env</code> file.</p>
<p><br>
<a name="Run-Artisan-Commands"></a></p>
@ -780,7 +785,7 @@ SESSION_DRIVER=redis
<p>5 - You can manually test it from Laravel with this code:</p>
<pre><code class="language-php">\Cache::store('redis')-&gt;put('LaraDock', 'Awesome', 10);
<pre><code class="language-php">\Cache::store('redis')-&gt;put('Laradock', 'Awesome', 10);
</code></pre>
<p><br>
@ -883,6 +888,18 @@ docker-compose up -d mariadb phpmyadmin
<p>2 - Open your browser and visit the localhost on port <strong>8080</strong>: <code>http://localhost:8080</code></p>
<p><br>
<a name="Use-Adminer"></a></p>
<h2 id="use-adminer">Use Adminer</h2>
<p>1 - Run the Adminer Container (<code>adminer</code>) with the <code>docker-compose up</code> command. Example:</p>
<pre><code class="language-bash">docker-compose up -d adminer
</code></pre>
<p>2 - Open your browser and visit the localhost on port <strong>8080</strong>: <code>http://localhost:8080</code></p>
<p><br>
<a name="Use-pgAdmin"></a></p>
@ -1047,7 +1064,7 @@ A package (<a href="https://github.com/duxet/laravel-rethinkdb">Laravel RethinkD
<h2 id="install-codeigniter">Install CodeIgniter</h2>
<p>To install CodeIgniter 3 on LaraDock all you have to do is the following simple steps:</p>
<p>To install CodeIgniter 3 on Laradock all you have to do is the following simple steps:</p>
<p>1 - Open the <code>docker-compose.yml</code> file.</p>
@ -1287,7 +1304,7 @@ port=1234
<h2 id="common-terminal-aliases">Common Terminal Aliases</h2>
<p>When you start your docker container, LaraDock will copy the <code>aliases.sh</code> file located in the <code>laradock/workspace</code> directory and add sourcing to the container <code>~/.bashrc</code> file.</p>
<p>When you start your docker container, Laradock will copy the <code>aliases.sh</code> file located in the <code>laradock/workspace</code> directory and add sourcing to the container <code>~/.bashrc</code> file.</p>
<p>You are free to modify the <code>aliases.sh</code> as you see fit, adding your own aliases (or function macros) to suit your requirements.</p>
@ -1362,12 +1379,12 @@ e) set it to <code>true</code></p>
<p><a href="https://github.com/laradock/laradock/blob/master/_guides/phpstorm.md"><strong>Debugging Guide Here</strong></a></p>
<p><br>
<a name="keep-tracking-LaraDock"></a></p>
<a name="keep-tracking-Laradock"></a></p>
<h2 id="keep-track-of-your-laradock-changes">Keep track of your LaraDock changes</h2>
<h2 id="keep-track-of-your-laradock-changes">Keep track of your Laradock changes</h2>
<ol>
<li>Fork the LaraDock repository.</li>
<li>Fork the Laradock repository.</li>
<li>Use that fork as a submodule.</li>
<li>Commit all your changes to your fork.</li>
<li>Pull new stuff from the main repository from time to time.</li>
@ -1376,15 +1393,15 @@ e) set it to <code>true</code></p>
<p><br>
<a name="upgrading-laradock"></a></p>
<h2 id="upgrading-laradock">Upgrading LaraDock</h2>
<h2 id="upgrading-laradock">Upgrading Laradock</h2>
<p>Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading LaraDock from v3.* to v4.*:</p>
<p>Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading Laradock from v3.* to v4.*:</p>
<ol>
<li>Stop the docker VM <code>docker-machine stop {default}</code></li>
<li>Install Docker for <a href="https://docs.docker.com/docker-for-mac/">Mac</a> or <a href="https://docs.docker.com/docker-for-windows/">Windows</a>.</li>
<li>Upgrade LaraDock to <code>v4.*.*</code> (<code>git pull origin master</code>)</li>
<li>Use LaraDock as you used to do: <code>docker-compose up -d nginx mysql</code>.</li>
<li>Upgrade Laradock to <code>v4.*.*</code> (<code>git pull origin master</code>)</li>
<li>Use Laradock as you used to do: <code>docker-compose up -d nginx mysql</code>.</li>
</ol>
<p><strong>Note:</strong> If you face any problem with the last step above: rebuild all your containers
@ -1396,13 +1413,27 @@ e) set it to <code>true</code></p>
<h2 id="improve-speed-on-macos">Improve speed on MacOS</h2>
<p>Sharing code into Docker containers with osxfs have very poor performance compared to Linux. You can get around this issue by using NFS to share your files betwen your host and your container.</p>
<p>Sharing code into Docker containers with osxfs have very poor performance compared to Linux. Likely there are some workarounds:</p>
<blockquote>
<p>How to share files using NFS (d4m-nfs)</p>
</blockquote>
<h3 id="workaround-a-using-dinghy">Workaround A: using dinghy</h3>
<p><a href="https://github.com/IFSight/d4m-nfs">d4m-nfs</a> automatically mount NFS volume instead of osxfs one.</p>
<p><a href="https://github.com/codekitchen/dinghy">Dinghy</a> creates its own VM using docker-machine, it will not modify your existing docker-machine VMs.</p>
<p>Quick Setup giude, (we recommend you check their docs)</p>
<p>1) <code>brew tap codekitchen/dinghy</code></p>
<p>2) <code>brew install dinghy</code></p>
<p>3) <code>dinghy create --provider virtualbox</code> (must have virtualbox installed, but they support other providers if you prefer)</p>
<p>4) after the above command is done it will display some env variables, copy them to the bash profile or zsh or.. (this will instruct docker to use the server running inside the VM)</p>
<p>5) <code>docker-compose up ...</code></p>
<h3 id="workaround-b-using-d4m-nfs">Workaround B: using d4m-nfs</h3>
<p><a href="https://github.com/IFSight/d4m-nfs">D4m-nfs</a> automatically mount NFS volume instead of osxfs one.</p>
<p>1) Update the Docker [File Sharing] preferences:</p>
@ -1418,23 +1449,30 @@ e) set it to <code>true</code></p>
<p>4) Create (or edit) the file <code>~/d4m-nfs/etc/d4m-nfs-mounts.txt</code>, and write the follwing configuration in it:</p>
<pre><code class="language-txt">/Users:/Users
/Volumes:/Volumes
/private:/private
</code></pre>
<p>5) Create (or edit) the file <code>/etc/exports</code>, make sure it exists and is empty. (There may be collisions if you come from Vagrant or if you already executed the <code>d4m-nfs.sh</code> script before).</p>
<p>6) Run the <code>d4m-nfs.sh</code> script:</p>
<p>6) Run the <code>d4m-nfs.sh</code> script (might need Sudo):</p>
<pre><code class="language-bash">~/d4m-nfs/d4m-nfs.sh
</code></pre>
<p>That&rsquo;s it! Run your containers.. Example:</p>
<pre><code class="language-bash">docker-compose up -d nginx mysql
<pre><code class="language-bash">docker-compose up ...
</code></pre>
<p><strong>Note:</strong> If you faced any errors, try restarting Docker, and make sure you have no spaces in the <code>d4m-nfs-mounts.txt</code> file, and your <code>/etc/exports</code> file is clear.</p>
<p><em>Note: If you faced any errors, try restarting Docker, and make sure you have no spaces in the <code>d4m-nfs-mounts.txt</code> file, and your <code>/etc/exports</code> file is clear.</em></p>
<h3 id="other-good-workarounds">Other good workarounds:</h3>
<ul>
<li><a href="https://github.com/EugenMayer/docker-sync">docker-sync</a></li>
<li>Add more here..</li>
</ul>
<p>More details about this issue <a href="https://github.com/docker/for-mac/issues/77">here</a>.</p>
<p><br>
<a name="Common-Problems"></a></p>
@ -1500,7 +1538,7 @@ e) set it to <code>true</code></p>
<li>Option B
<ol>
<li>Change the <code>DB_HOST</code> value to the same name as the MySQL docker container. The LaraDock docker-compose file currently has this as <code>mysql</code></li>
<li>Change the <code>DB_HOST</code> value to the same name as the MySQL docker container. The Laradock docker-compose file currently has this as <code>mysql</code></li>
</ol></li>
</ul>

View File

@ -150,6 +150,11 @@ example for &lt;code&gt;mysql&lt;/code&gt; it will be &lt;code&gt;mysql/Dockerfi
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;docker logs {container-name}
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;More &lt;a href=&#34;https://docs.docker.com/compose/reference/logs/&#34;&gt;options&lt;/a&gt;&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;docker logs -f {container-name}
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;PHP&#34;&gt;&lt;/a&gt;&lt;/p&gt;
@ -280,7 +285,7 @@ xdebug.remote_connect_back=1
&lt;p&gt;By installing xDebug, you are enabling it to run on startup by default.&lt;/p&gt;
&lt;p&gt;To control the behavior of xDebug (in the &lt;code&gt;php-fpm&lt;/code&gt; Container), you can run the following commands from the LaraDock root folder, (at the same prompt where you run docker-compose):&lt;/p&gt;
&lt;p&gt;To control the behavior of xDebug (in the &lt;code&gt;php-fpm&lt;/code&gt; Container), you can run the following commands from the Laradock root folder, (at the same prompt where you run docker-compose):&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Stop xDebug from running by default: &lt;code&gt;./xdebugPhpFpm stop&lt;/code&gt;.&lt;/li&gt;
@ -320,11 +325,11 @@ xdebug.remote_connect_back=1
&lt;a name=&#34;Production&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;LaraDock-for-Production&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;a name=&#34;Laradock-for-Production&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h2 id=&#34;prepare-laradock-for-production&#34;&gt;Prepare LaraDock for Production&lt;/h2&gt;
&lt;h2 id=&#34;prepare-laradock-for-production&#34;&gt;Prepare Laradock for Production&lt;/h2&gt;
&lt;p&gt;It&amp;rsquo;s recommended for production to create a custom &lt;code&gt;docker-compose.yml&lt;/code&gt; file. For that reason, LaraDock is shipped with &lt;code&gt;production-docker-compose.yml&lt;/code&gt; which should contain only the containers you are planning to run on production (usage example: &lt;code&gt;docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...&lt;/code&gt;).&lt;/p&gt;
&lt;p&gt;It&amp;rsquo;s recommended for production to create a custom &lt;code&gt;docker-compose.yml&lt;/code&gt; file. For that reason, Laradock is shipped with &lt;code&gt;production-docker-compose.yml&lt;/code&gt; which should contain only the containers you are planning to run on production (usage example: &lt;code&gt;docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...&lt;/code&gt;).&lt;/p&gt;
&lt;p&gt;Note: The Database (MySQL/MariaDB/&amp;hellip;) 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:&lt;/p&gt;
@ -365,7 +370,7 @@ xdebug.remote_connect_back=1
&lt;p&gt;3 - Edit &lt;code&gt;docker-compose.yml&lt;/code&gt; to Map the new application path:&lt;/p&gt;
&lt;p&gt;By default, LaraDock assumes the Laravel application is living in the parent directory of the laradock folder.&lt;/p&gt;
&lt;p&gt;By default, Laradock assumes the Laravel application is living in the parent directory of the laradock folder.&lt;/p&gt;
&lt;p&gt;Since the new Laravel application is in the &lt;code&gt;my-cool-app&lt;/code&gt; folder, we need to replace &lt;code&gt;../:/var/www&lt;/code&gt; with &lt;code&gt;../my-cool-app/:/var/www&lt;/code&gt;, as follow:&lt;/p&gt;
@ -381,7 +386,7 @@ xdebug.remote_connect_back=1
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;cd my-cool-app
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;5 - Go back to the LaraDock installation steps to see how to edit the &lt;code&gt;.env&lt;/code&gt; file.&lt;/p&gt;
&lt;p&gt;5 - Go back to the Laradock installation steps to see how to edit the &lt;code&gt;.env&lt;/code&gt; file.&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;Run-Artisan-Commands&#34;&gt;&lt;/a&gt;&lt;/p&gt;
@ -483,7 +488,7 @@ SESSION_DRIVER=redis
&lt;p&gt;5 - You can manually test it from Laravel with this code:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-php&#34;&gt;\Cache::store(&#39;redis&#39;)-&amp;gt;put(&#39;LaraDock&#39;, &#39;Awesome&#39;, 10);
&lt;pre&gt;&lt;code class=&#34;language-php&#34;&gt;\Cache::store(&#39;redis&#39;)-&amp;gt;put(&#39;Laradock&#39;, &#39;Awesome&#39;, 10);
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;br&gt;
@ -586,6 +591,18 @@ docker-compose up -d mariadb phpmyadmin
&lt;p&gt;2 - Open your browser and visit the localhost on port &lt;strong&gt;8080&lt;/strong&gt;: &lt;code&gt;http://localhost:8080&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;Use-Adminer&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h2 id=&#34;use-adminer&#34;&gt;Use Adminer&lt;/h2&gt;
&lt;p&gt;1 - Run the Adminer Container (&lt;code&gt;adminer&lt;/code&gt;) with the &lt;code&gt;docker-compose up&lt;/code&gt; command. Example:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;docker-compose up -d adminer
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;2 - Open your browser and visit the localhost on port &lt;strong&gt;8080&lt;/strong&gt;: &lt;code&gt;http://localhost:8080&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;Use-pgAdmin&#34;&gt;&lt;/a&gt;&lt;/p&gt;
@ -750,7 +767,7 @@ A package (&lt;a href=&#34;https://github.com/duxet/laravel-rethinkdb&#34;&gt;La
&lt;h2 id=&#34;install-codeigniter&#34;&gt;Install CodeIgniter&lt;/h2&gt;
&lt;p&gt;To install CodeIgniter 3 on LaraDock all you have to do is the following simple steps:&lt;/p&gt;
&lt;p&gt;To install CodeIgniter 3 on Laradock all you have to do is the following simple steps:&lt;/p&gt;
&lt;p&gt;1 - Open the &lt;code&gt;docker-compose.yml&lt;/code&gt; file.&lt;/p&gt;
@ -990,7 +1007,7 @@ port=1234
&lt;h2 id=&#34;common-terminal-aliases&#34;&gt;Common Terminal Aliases&lt;/h2&gt;
&lt;p&gt;When you start your docker container, LaraDock will copy the &lt;code&gt;aliases.sh&lt;/code&gt; file located in the &lt;code&gt;laradock/workspace&lt;/code&gt; directory and add sourcing to the container &lt;code&gt;~/.bashrc&lt;/code&gt; file.&lt;/p&gt;
&lt;p&gt;When you start your docker container, Laradock will copy the &lt;code&gt;aliases.sh&lt;/code&gt; file located in the &lt;code&gt;laradock/workspace&lt;/code&gt; directory and add sourcing to the container &lt;code&gt;~/.bashrc&lt;/code&gt; file.&lt;/p&gt;
&lt;p&gt;You are free to modify the &lt;code&gt;aliases.sh&lt;/code&gt; as you see fit, adding your own aliases (or function macros) to suit your requirements.&lt;/p&gt;
@ -1065,12 +1082,12 @@ e) set it to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;&lt;a href=&#34;https://github.com/laradock/laradock/blob/master/_guides/phpstorm.md&#34;&gt;&lt;strong&gt;Debugging Guide Here&lt;/strong&gt;&lt;/a&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;keep-tracking-LaraDock&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;a name=&#34;keep-tracking-Laradock&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h2 id=&#34;keep-track-of-your-laradock-changes&#34;&gt;Keep track of your LaraDock changes&lt;/h2&gt;
&lt;h2 id=&#34;keep-track-of-your-laradock-changes&#34;&gt;Keep track of your Laradock changes&lt;/h2&gt;
&lt;ol&gt;
&lt;li&gt;Fork the LaraDock repository.&lt;/li&gt;
&lt;li&gt;Fork the Laradock repository.&lt;/li&gt;
&lt;li&gt;Use that fork as a submodule.&lt;/li&gt;
&lt;li&gt;Commit all your changes to your fork.&lt;/li&gt;
&lt;li&gt;Pull new stuff from the main repository from time to time.&lt;/li&gt;
@ -1079,15 +1096,15 @@ e) set it to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;upgrading-laradock&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h2 id=&#34;upgrading-laradock&#34;&gt;Upgrading LaraDock&lt;/h2&gt;
&lt;h2 id=&#34;upgrading-laradock&#34;&gt;Upgrading Laradock&lt;/h2&gt;
&lt;p&gt;Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading LaraDock from v3.* to v4.*:&lt;/p&gt;
&lt;p&gt;Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading Laradock from v3.* to v4.*:&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;Stop the docker VM &lt;code&gt;docker-machine stop {default}&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;Install Docker for &lt;a href=&#34;https://docs.docker.com/docker-for-mac/&#34;&gt;Mac&lt;/a&gt; or &lt;a href=&#34;https://docs.docker.com/docker-for-windows/&#34;&gt;Windows&lt;/a&gt;.&lt;/li&gt;
&lt;li&gt;Upgrade LaraDock to &lt;code&gt;v4.*.*&lt;/code&gt; (&lt;code&gt;git pull origin master&lt;/code&gt;)&lt;/li&gt;
&lt;li&gt;Use LaraDock as you used to do: &lt;code&gt;docker-compose up -d nginx mysql&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;Upgrade Laradock to &lt;code&gt;v4.*.*&lt;/code&gt; (&lt;code&gt;git pull origin master&lt;/code&gt;)&lt;/li&gt;
&lt;li&gt;Use Laradock as you used to do: &lt;code&gt;docker-compose up -d nginx mysql&lt;/code&gt;.&lt;/li&gt;
&lt;/ol&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt; If you face any problem with the last step above: rebuild all your containers
@ -1099,13 +1116,27 @@ e) set it to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
&lt;h2 id=&#34;improve-speed-on-macos&#34;&gt;Improve speed on MacOS&lt;/h2&gt;
&lt;p&gt;Sharing code into Docker containers with osxfs have very poor performance compared to Linux. You can get around this issue by using NFS to share your files betwen your host and your container.&lt;/p&gt;
&lt;p&gt;Sharing code into Docker containers with osxfs have very poor performance compared to Linux. Likely there are some workarounds:&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;How to share files using NFS (d4m-nfs)&lt;/p&gt;
&lt;/blockquote&gt;
&lt;h3 id=&#34;workaround-a-using-dinghy&#34;&gt;Workaround A: using dinghy&lt;/h3&gt;
&lt;p&gt;&lt;a href=&#34;https://github.com/IFSight/d4m-nfs&#34;&gt;d4m-nfs&lt;/a&gt; automatically mount NFS volume instead of osxfs one.&lt;/p&gt;
&lt;p&gt;&lt;a href=&#34;https://github.com/codekitchen/dinghy&#34;&gt;Dinghy&lt;/a&gt; creates its own VM using docker-machine, it will not modify your existing docker-machine VMs.&lt;/p&gt;
&lt;p&gt;Quick Setup giude, (we recommend you check their docs)&lt;/p&gt;
&lt;p&gt;1) &lt;code&gt;brew tap codekitchen/dinghy&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;2) &lt;code&gt;brew install dinghy&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;3) &lt;code&gt;dinghy create --provider virtualbox&lt;/code&gt; (must have virtualbox installed, but they support other providers if you prefer)&lt;/p&gt;
&lt;p&gt;4) after the above command is done it will display some env variables, copy them to the bash profile or zsh or.. (this will instruct docker to use the server running inside the VM)&lt;/p&gt;
&lt;p&gt;5) &lt;code&gt;docker-compose up ...&lt;/code&gt;&lt;/p&gt;
&lt;h3 id=&#34;workaround-b-using-d4m-nfs&#34;&gt;Workaround B: using d4m-nfs&lt;/h3&gt;
&lt;p&gt;&lt;a href=&#34;https://github.com/IFSight/d4m-nfs&#34;&gt;D4m-nfs&lt;/a&gt; automatically mount NFS volume instead of osxfs one.&lt;/p&gt;
&lt;p&gt;1) Update the Docker [File Sharing] preferences:&lt;/p&gt;
@ -1121,23 +1152,30 @@ e) set it to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;4) Create (or edit) the file &lt;code&gt;~/d4m-nfs/etc/d4m-nfs-mounts.txt&lt;/code&gt;, and write the follwing configuration in it:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-txt&#34;&gt;/Users:/Users
/Volumes:/Volumes
/private:/private
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;5) Create (or edit) the file &lt;code&gt;/etc/exports&lt;/code&gt;, make sure it exists and is empty. (There may be collisions if you come from Vagrant or if you already executed the &lt;code&gt;d4m-nfs.sh&lt;/code&gt; script before).&lt;/p&gt;
&lt;p&gt;6) Run the &lt;code&gt;d4m-nfs.sh&lt;/code&gt; script:&lt;/p&gt;
&lt;p&gt;6) Run the &lt;code&gt;d4m-nfs.sh&lt;/code&gt; script (might need Sudo):&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;~/d4m-nfs/d4m-nfs.sh
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;That&amp;rsquo;s it! Run your containers.. Example:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;docker-compose up -d nginx mysql
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;docker-compose up ...
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt; If you faced any errors, try restarting Docker, and make sure you have no spaces in the &lt;code&gt;d4m-nfs-mounts.txt&lt;/code&gt; file, and your &lt;code&gt;/etc/exports&lt;/code&gt; file is clear.&lt;/p&gt;
&lt;p&gt;&lt;em&gt;Note: If you faced any errors, try restarting Docker, and make sure you have no spaces in the &lt;code&gt;d4m-nfs-mounts.txt&lt;/code&gt; file, and your &lt;code&gt;/etc/exports&lt;/code&gt; file is clear.&lt;/em&gt;&lt;/p&gt;
&lt;h3 id=&#34;other-good-workarounds&#34;&gt;Other good workarounds:&lt;/h3&gt;
&lt;ul&gt;
&lt;li&gt;&lt;a href=&#34;https://github.com/EugenMayer/docker-sync&#34;&gt;docker-sync&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;Add more here..&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;More details about this issue &lt;a href=&#34;https://github.com/docker/for-mac/issues/77&#34;&gt;here&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;Common-Problems&#34;&gt;&lt;/a&gt;&lt;/p&gt;
@ -1203,7 +1241,7 @@ e) set it to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
&lt;li&gt;Option B
&lt;ol&gt;
&lt;li&gt;Change the &lt;code&gt;DB_HOST&lt;/code&gt; value to the same name as the MySQL docker container. The LaraDock docker-compose file currently has this as &lt;code&gt;mysql&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;Change the &lt;code&gt;DB_HOST&lt;/code&gt; value to the same name as the MySQL docker container. The Laradock docker-compose file currently has this as &lt;code&gt;mysql&lt;/code&gt;&lt;/li&gt;
&lt;/ol&gt;&lt;/li&gt;
&lt;/ul&gt;
</description>

View File

@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
<meta http-equiv="X-UA-Compatible" content="IE=10" />
<title>Getting Started - Laradock</title>
<meta name="generator" content="Hugo 0.18.1" />
<meta name="generator" content="Hugo 0.19" />
<meta name="description" content="Laradock documentations.">
@ -324,88 +324,123 @@
<p>Choose the setup the best suits your needs.</p>
<h4 id="a-setup-for-single-project">A) Setup for Single Project:</h4>
<ul>
<li><a href="#A">A) Setup for Single Project</a>
<p><em>(In case you want a Docker environment for each project)</em></p>
<ul>
<li><a href="#A1">A.1) Already have a PHP project</a></li>
<li><a href="#A2">A.2) Don&rsquo;t have a PHP project yet</a></li>
</ul></li>
<li><a href="#B">B) Setup for Multiple Projects</a></li>
</ul>
<h5 id="a-1-setup-environment-in-existing-project">A.1) Setup environment in existing Project:</h5>
<p><a name="A"></a></p>
<p><em>(In case you already have a project, and you want to setup an environment to run it)</em></p>
<h3 id="a-setup-for-single-project">A) Setup for Single Project</h3>
<p>1 - Clone this repository on your project root directory:</p>
<blockquote>
<p>(Follow these steps if you want a separate Docker environment for each project)</p>
</blockquote>
<p><a name="A1"></a></p>
<h3 id="a-1-already-have-a-php-project">A.1) Already have a PHP project:</h3>
<p>1 - Clone laradock on your project root directory:</p>
<pre><code class="language-bash">git submodule add https://github.com/Laradock/laradock.git
</code></pre>
<p><em>Note 1: If you are not yet using Git for your PHP project, you can use <code>git clone https://github.com/Laradock/laradock.git</code> instead.</em></p>
<p><strong>Notes:</strong></p>
<p><em>Note 2: To keep track of your LaraDock changes, between your projects and also keep LaraDock updated. <a href="#keep-tracking-LaraDock">Check this</a></em></p>
<ul>
<li><p>If you are not using Git yet for your project, you can use <code>git clone</code> instead of <code>git submodule</code>.</p></li>
<p><em>Note 3: In this case the folder structure will be like this:</em></p>
<li><p>Note 2: To keep track of your Laradock changes, between your projects and also keep Laradock updated. <a href="http://laradock.io/documentation/#keep-track-of-your-laradock-changes">Check this</a></p></li>
</ul>
<pre><code>- project1
- laradock
- project2
- laradock
<p>Your folder structure should look like this:</p>
<pre><code>+ project-a
+ laradock-a
+ project-b
+ laradock-b
</code></pre>
<h5 id="a-2-setup-environment-first-then-create-project">A.2) Setup environment first then create project:</h5>
<p>(It&rsquo;s important to rename the folders differently in each project.)</p>
<p><em>(In case you don&rsquo;t have a project, and you want to create your project inside the Docker environment)</em></p>
<blockquote>
<p><strong>Now jump to the <a href="#Usage">Usage</a> section.</strong></p>
</blockquote>
<p><a name="A2"></a></p>
<h3 id="a-2-don-t-have-a-php-project-yet">A.2) Don&rsquo;t have a PHP project yet:</h3>
<p>1 - Clone this repository anywhere on your machine:</p>
<pre><code class="language-bash">git clone https://github.com/laradock/laradock.git
</code></pre>
<p>Note: In this case the folder structure will be like this:</p>
<p>Your folder structure should look like this:</p>
<pre><code>- projects
- laradock
- myProject
<pre><code>+ laradock
+ project-z
</code></pre>
<p>2 - Edit the <code>docker-compose.yml</code> file to map to your project directory once you have it (example: <code>- ../myProject:/var/www</code>).</p>
<p>2 - Edit your web server sites configuration.</p>
<p>3 - Stop and re-run your docker-compose command for the changes to take place.</p>
<p><strong>In case of NGINX:</strong> open <code>nginx/sites/default.conf</code> and change the <code>root</code> from <code>/var/www/public</code> to <code>/var/www/{my-project-folder-name}/public</code>.</p>
<pre><code>docker-compose stop &amp;&amp; docker-compose up -d XXXX YYYY ZZZZ ....
</code></pre>
<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>
<h4 id="b-setup-for-multiple-projects">B) Setup for Multiple Projects:</h4>
<p><strong>In case of Apache:</strong> :P</p>
<p>1 - Clone this repository anywhere on your machine:</p>
<p><br></p>
<blockquote>
<p><strong>Now jump to the <a href="#Usage">Usage</a> section.</strong></p>
</blockquote>
<p><a name="B"></a></p>
<h3 id="b-setup-for-multiple-projects">B) Setup for Multiple Projects:</h3>
<blockquote>
<p>(Follow these steps if you want a single Docker environment for all your project)</p>
</blockquote>
<p>1 - Clone this repository anywhere on your machine (similar to <a href="#A2">Steps A.2. from above</a>):</p>
<pre><code class="language-bash">git clone https://github.com/laradock/laradock.git
</code></pre>
<p>2 - Edit the <code>docker-compose.yml</code> file to map to your projects directories:</p>
<p>Your folder structure should look like this:</p>
<pre><code> applications:
image: tianon/true
volumes:
- ../project1/:/var/www/project1
- ../project2/:/var/www/project2
<pre><code>+ laradock
+ project-1
+ project-2
</code></pre>
<p>3 - You can access all sites by visiting <code>http://localhost/project1/public</code> and <code>http://localhost/project2/public</code> but of course that&rsquo;s not very useful so let&rsquo;s setup NGINX quickly.</p>
<p>2 - Go to <code>nginx/sites</code> and create config files to point to different project directory when visiting different domains.</p>
<p>4 - Go to <code>nginx/sites</code> and copy <code>sample.conf.example</code> to <code>project1.conf</code> then to <code>project2.conf</code></p>
<p>Laradock by default includes <code>project-1.conf</code> and <code>project-2.conf</code> as working samples.</p>
<p>5 - Open the <code>project1.conf</code> file and edit the <code>server_name</code> and the <code>root</code> as follow:</p>
<p>3 - change the default names <code>project-n</code>:</p>
<pre><code> server_name project1.dev;
root /var/www/project1/public;
<p>You can rename the config files, project folders and domains as you like, just make sure the <code>root</code> in the config files, is pointing to the correct project folder name.</p>
<p>4 - Add the domains to the <strong>hosts</strong> files.</p>
<pre><code>127.0.0.1 project-1.dev
127.0.0.1 project-2.dev
</code></pre>
<p>Do the same for each project <code>project2.conf</code>, <code>project3.conf</code>,&hellip;</p>
<blockquote>
<p><strong>Now jump to the <a href="#Usage">Usage</a> section.</strong></p>
</blockquote>
<p>6 - Add the domains to the <strong>hosts</strong> files.</p>
<pre><code>127.0.0.1 project1.dev
</code></pre>
<p>7 - Create your project Databases. Right now you have to do it manually by entering your DB container, until we automate it soon.</p>
<p><a name="Usage"></a></p>
<h2 id="usage">Usage</h2>
@ -414,61 +449,72 @@
<p>If you are using <strong>Docker Toolbox</strong> (VM), do one of the following:</p>
<ul>
<li>Upgrade to Docker <a href="https://www.docker.com/products/docker">Native</a> for Mac/Windows (Recommended). Check out <a href="#upgrading-laradock">Upgrading LaraDock</a></li>
<li>Use LaraDock v3.* (Visit the <code>LaraDock-ToolBox</code> <a href="https://github.com/laradock/laradock/tree/LaraDock-ToolBox">Branch</a>).</li>
<li>Upgrade to Docker <a href="https://www.docker.com/products/docker">Native</a> for Mac/Windows (Recommended). Check out <a href="http://laradock.io/documentation/#upgrading-laradock">Upgrading Laradock</a></li>
<li>Use Laradock v3.*. Visit the <a href="https://github.com/laradock/laradock/tree/LaraDock-ToolBox">LaraDock-ToolBox</a> branch. <em>(outdated)</em></li>
</ul>
<p><br></p>
<blockquote>
<p><strong>Warning:</strong> If you used an older version of LaraDock it&rsquo;s highly recommended to rebuild the containers you need to use <a href="#Build-Re-build-Containers">see how you rebuild a container</a> in order to prevent errors as much as possible.</p>
<p><strong>Warning:</strong> If you used an older version of Laradock it&rsquo;s highly recommended to rebuild the containers you need to use <a href="#Build-Re-build-Containers">see how you rebuild a container</a> in order to prevent as much errors as possible.</p>
</blockquote>
<p><br></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>
<pre><code class="language-shell">cp env-example .env
</code></pre>
<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><code>nginx</code>, <code>hhvm</code>, <code>php-fpm</code>, <code>mysql</code>, <code>redis</code>, <code>postgres</code>, <code>mariadb</code>, <code>neo4j</code>, <code>mongo</code>, <code>apache2</code>, <code>caddy</code>, <code>memcached</code>, <code>beanstalkd</code>, <code>beanstalkd-console</code>, <code>rabbitmq</code>, <code>workspace</code>, <code>phpmyadmin</code>, <code>aerospike</code>, <code>pgadmin</code>, <code>elasticsearch</code>, <code>rethinkdb</code>.</p>
<blockquote>
<p><code>nginx</code>, <code>hhvm</code>, <code>php-fpm</code>, <code>mysql</code>, <code>redis</code>, <code>postgres</code>, <code>mariadb</code>, <code>neo4j</code>, <code>mongo</code>, <code>apache2</code>, <code>caddy</code>, <code>memcached</code>, <code>beanstalkd</code>, <code>beanstalkd-console</code>, <code>rabbitmq</code>, <code>beanstalkd-console</code>, <code>workspace</code>, <code>phpmyadmin</code>, <code>adminer</code>, <code>aerospike</code>, <code>pgadmin</code>, <code>elasticsearch</code>, <code>rethinkdb</code>, <code>postgres-postgis</code>, <code>certbot</code>, <code>mailhog</code>, <code>minio</code> and more&hellip;!</p>
</blockquote>
<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>
<pre><code class="language-bash">docker-compose exec workspace bash
</code></pre>
<p>Alternatively, for Windows PowerShell users: execute the following command to enter any running container:</p>
<p><em>Alternatively, for Windows PowerShell users: execute the following command to enter any running container:</em></p>
<pre><code class="language-bash">docker exec -it {workspace-container-id} bash
</code></pre>
<p><strong>Note:</strong> You can add <code>--user=laradock</code> (example <code>docker-compose exec --user=laradock workspace bash</code>) to have files created as your host&rsquo;s user. (you can change the PUID (User id) and PGID (group id) variables from the <code>docker-compose.yml</code>).</p>
<p><strong>Note:</strong> You can add <code>--user=laradock</code> to have files created as your host&rsquo;s user. Example:</p>
<pre><code class="language-shell">docker-compose exec --user=laradock workspace bash
</code></pre>
<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>
<pre><code class="language-env">DB_HOST=mysql
</code></pre>
<p><em>If you want to use Laravel and you don&rsquo;t have it installed yet, see <a href="#Install-Laravel">How to Install Laravel in a Docker Container</a>.</em></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>
<p><br>
<strong>Debugging</strong>: if you are facing any problem here check the <a href="#debugging">Debugging</a> section.</p>
<p>If you need a special support. Contact me, more details in the <a href="#Help">Help &amp; Questions</a> section.</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>
<aside class="copyright" role="note">

View File

@ -27,88 +27,123 @@
&lt;p&gt;Choose the setup the best suits your needs.&lt;/p&gt;
&lt;h4 id=&#34;a-setup-for-single-project&#34;&gt;A) Setup for Single Project:&lt;/h4&gt;
&lt;ul&gt;
&lt;li&gt;&lt;a href=&#34;#A&#34;&gt;A) Setup for Single Project&lt;/a&gt;
&lt;p&gt;&lt;em&gt;(In case you want a Docker environment for each project)&lt;/em&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;a href=&#34;#A1&#34;&gt;A.1) Already have a PHP project&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href=&#34;#A2&#34;&gt;A.2) Don&amp;rsquo;t have a PHP project yet&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href=&#34;#B&#34;&gt;B) Setup for Multiple Projects&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;h5 id=&#34;a-1-setup-environment-in-existing-project&#34;&gt;A.1) Setup environment in existing Project:&lt;/h5&gt;
&lt;p&gt;&lt;a name=&#34;A&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;p&gt;&lt;em&gt;(In case you already have a project, and you want to setup an environment to run it)&lt;/em&gt;&lt;/p&gt;
&lt;h3 id=&#34;a-setup-for-single-project&#34;&gt;A) Setup for Single Project&lt;/h3&gt;
&lt;p&gt;1 - Clone this repository on your project root directory:&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;(Follow these steps if you want a separate Docker environment for each project)&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;&lt;a name=&#34;A1&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h3 id=&#34;a-1-already-have-a-php-project&#34;&gt;A.1) Already have a PHP project:&lt;/h3&gt;
&lt;p&gt;1 - Clone laradock on your project root directory:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;git submodule add https://github.com/Laradock/laradock.git
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;em&gt;Note 1: If you are not yet using Git for your PHP project, you can use &lt;code&gt;git clone https://github.com/Laradock/laradock.git&lt;/code&gt; instead.&lt;/em&gt;&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Notes:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;&lt;em&gt;Note 2: To keep track of your LaraDock changes, between your projects and also keep LaraDock updated. &lt;a href=&#34;#keep-tracking-LaraDock&#34;&gt;Check this&lt;/a&gt;&lt;/em&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;If you are not using Git yet for your project, you can use &lt;code&gt;git clone&lt;/code&gt; instead of &lt;code&gt;git submodule&lt;/code&gt;.&lt;/p&gt;&lt;/li&gt;
&lt;p&gt;&lt;em&gt;Note 3: In this case the folder structure will be like this:&lt;/em&gt;&lt;/p&gt;
&lt;li&gt;&lt;p&gt;Note 2: To keep track of your Laradock changes, between your projects and also keep Laradock updated. &lt;a href=&#34;http://laradock.io/documentation/#keep-track-of-your-laradock-changes&#34;&gt;Check this&lt;/a&gt;&lt;/p&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;pre&gt;&lt;code&gt;- project1
- laradock
- project2
- laradock
&lt;p&gt;Your folder structure should look like this:&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;+ project-a
+ laradock-a
+ project-b
+ laradock-b
&lt;/code&gt;&lt;/pre&gt;
&lt;h5 id=&#34;a-2-setup-environment-first-then-create-project&#34;&gt;A.2) Setup environment first then create project:&lt;/h5&gt;
&lt;p&gt;(It&amp;rsquo;s important to rename the folders differently in each project.)&lt;/p&gt;
&lt;p&gt;&lt;em&gt;(In case you don&amp;rsquo;t have a project, and you want to create your project inside the Docker environment)&lt;/em&gt;&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;&lt;strong&gt;Now jump to the &lt;a href=&#34;#Usage&#34;&gt;Usage&lt;/a&gt; section.&lt;/strong&gt;&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;&lt;a name=&#34;A2&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h3 id=&#34;a-2-don-t-have-a-php-project-yet&#34;&gt;A.2) Don&amp;rsquo;t have a PHP project yet:&lt;/h3&gt;
&lt;p&gt;1 - Clone this repository anywhere on your machine:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;git clone https://github.com/laradock/laradock.git
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;Note: In this case the folder structure will be like this:&lt;/p&gt;
&lt;p&gt;Your folder structure should look like this:&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;- projects
- laradock
- myProject
&lt;pre&gt;&lt;code&gt;+ laradock
+ project-z
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;2 - Edit the &lt;code&gt;docker-compose.yml&lt;/code&gt; file to map to your project directory once you have it (example: &lt;code&gt;- ../myProject:/var/www&lt;/code&gt;).&lt;/p&gt;
&lt;p&gt;2 - Edit your web server sites configuration.&lt;/p&gt;
&lt;p&gt;3 - Stop and re-run your docker-compose command for the changes to take place.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;In case of NGINX:&lt;/strong&gt; open &lt;code&gt;nginx/sites/default.conf&lt;/code&gt; and change the &lt;code&gt;root&lt;/code&gt; from &lt;code&gt;/var/www/public&lt;/code&gt; to &lt;code&gt;/var/www/{my-project-folder-name}/public&lt;/code&gt;.&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;docker-compose stop &amp;amp;&amp;amp; docker-compose up -d XXXX YYYY ZZZZ ....
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;em&gt;Or you can keep &lt;code&gt;default.conf&lt;/code&gt; as it is, and create a separate config &lt;code&gt;my-site.conf&lt;/code&gt; file for it.&lt;/em&gt;&lt;/p&gt;
&lt;h4 id=&#34;b-setup-for-multiple-projects&#34;&gt;B) Setup for Multiple Projects:&lt;/h4&gt;
&lt;p&gt;&lt;strong&gt;In case of Apache:&lt;/strong&gt; :P&lt;/p&gt;
&lt;p&gt;1 - Clone this repository anywhere on your machine:&lt;/p&gt;
&lt;p&gt;&lt;br&gt;&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;&lt;strong&gt;Now jump to the &lt;a href=&#34;#Usage&#34;&gt;Usage&lt;/a&gt; section.&lt;/strong&gt;&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;&lt;a name=&#34;B&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h3 id=&#34;b-setup-for-multiple-projects&#34;&gt;B) Setup for Multiple Projects:&lt;/h3&gt;
&lt;blockquote&gt;
&lt;p&gt;(Follow these steps if you want a single Docker environment for all your project)&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;1 - Clone this repository anywhere on your machine (similar to &lt;a href=&#34;#A2&#34;&gt;Steps A.2. from above&lt;/a&gt;):&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;git clone https://github.com/laradock/laradock.git
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;2 - Edit the &lt;code&gt;docker-compose.yml&lt;/code&gt; file to map to your projects directories:&lt;/p&gt;
&lt;p&gt;Your folder structure should look like this:&lt;/p&gt;
&lt;pre&gt;&lt;code&gt; applications:
image: tianon/true
volumes:
- ../project1/:/var/www/project1
- ../project2/:/var/www/project2
&lt;pre&gt;&lt;code&gt;+ laradock
+ project-1
+ project-2
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;3 - You can access all sites by visiting &lt;code&gt;http://localhost/project1/public&lt;/code&gt; and &lt;code&gt;http://localhost/project2/public&lt;/code&gt; but of course that&amp;rsquo;s not very useful so let&amp;rsquo;s setup NGINX quickly.&lt;/p&gt;
&lt;p&gt;2 - Go to &lt;code&gt;nginx/sites&lt;/code&gt; and create config files to point to different project directory when visiting different domains.&lt;/p&gt;
&lt;p&gt;4 - Go to &lt;code&gt;nginx/sites&lt;/code&gt; and copy &lt;code&gt;sample.conf.example&lt;/code&gt; to &lt;code&gt;project1.conf&lt;/code&gt; then to &lt;code&gt;project2.conf&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;Laradock by default includes &lt;code&gt;project-1.conf&lt;/code&gt; and &lt;code&gt;project-2.conf&lt;/code&gt; as working samples.&lt;/p&gt;
&lt;p&gt;5 - Open the &lt;code&gt;project1.conf&lt;/code&gt; file and edit the &lt;code&gt;server_name&lt;/code&gt; and the &lt;code&gt;root&lt;/code&gt; as follow:&lt;/p&gt;
&lt;p&gt;3 - change the default names &lt;code&gt;project-n&lt;/code&gt;:&lt;/p&gt;
&lt;pre&gt;&lt;code&gt; server_name project1.dev;
root /var/www/project1/public;
&lt;p&gt;You can rename the config files, project folders and domains as you like, just make sure the &lt;code&gt;root&lt;/code&gt; in the config files, is pointing to the correct project folder name.&lt;/p&gt;
&lt;p&gt;4 - Add the domains to the &lt;strong&gt;hosts&lt;/strong&gt; files.&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;127.0.0.1 project-1.dev
127.0.0.1 project-2.dev
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;Do the same for each project &lt;code&gt;project2.conf&lt;/code&gt;, &lt;code&gt;project3.conf&lt;/code&gt;,&amp;hellip;&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;&lt;strong&gt;Now jump to the &lt;a href=&#34;#Usage&#34;&gt;Usage&lt;/a&gt; section.&lt;/strong&gt;&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;6 - Add the domains to the &lt;strong&gt;hosts&lt;/strong&gt; files.&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;127.0.0.1 project1.dev
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;7 - Create your project Databases. Right now you have to do it manually by entering your DB container, until we automate it soon.&lt;/p&gt;
&lt;p&gt;&lt;a name=&#34;Usage&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h2 id=&#34;usage&#34;&gt;Usage&lt;/h2&gt;
@ -117,61 +152,72 @@
&lt;p&gt;If you are using &lt;strong&gt;Docker Toolbox&lt;/strong&gt; (VM), do one of the following:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Upgrade to Docker &lt;a href=&#34;https://www.docker.com/products/docker&#34;&gt;Native&lt;/a&gt; for Mac/Windows (Recommended). Check out &lt;a href=&#34;#upgrading-laradock&#34;&gt;Upgrading LaraDock&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;Use LaraDock v3.* (Visit the &lt;code&gt;LaraDock-ToolBox&lt;/code&gt; &lt;a href=&#34;https://github.com/laradock/laradock/tree/LaraDock-ToolBox&#34;&gt;Branch&lt;/a&gt;).&lt;/li&gt;
&lt;li&gt;Upgrade to Docker &lt;a href=&#34;https://www.docker.com/products/docker&#34;&gt;Native&lt;/a&gt; for Mac/Windows (Recommended). Check out &lt;a href=&#34;http://laradock.io/documentation/#upgrading-laradock&#34;&gt;Upgrading Laradock&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;Use Laradock v3.*. Visit the &lt;a href=&#34;https://github.com/laradock/laradock/tree/LaraDock-ToolBox&#34;&gt;LaraDock-ToolBox&lt;/a&gt; branch. &lt;em&gt;(outdated)&lt;/em&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;br&gt;&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt; If you used an older version of LaraDock it&amp;rsquo;s highly recommended to rebuild the containers you need to use &lt;a href=&#34;#Build-Re-build-Containers&#34;&gt;see how you rebuild a container&lt;/a&gt; in order to prevent errors as much as possible.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt; If you used an older version of Laradock it&amp;rsquo;s highly recommended to rebuild the containers you need to use &lt;a href=&#34;#Build-Re-build-Containers&#34;&gt;see how you rebuild a container&lt;/a&gt; in order to prevent as much errors as possible.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;&lt;br&gt;&lt;/p&gt;
&lt;p&gt;1 - Run Containers: &lt;em&gt;(Make sure you are in the &lt;code&gt;laradock&lt;/code&gt; folder before running the &lt;code&gt;docker-compose&lt;/code&gt; commands).&lt;/em&gt;&lt;/p&gt;
&lt;p&gt;1 - Enter the laradock folder and rename &lt;code&gt;env-example&lt;/code&gt; to &lt;code&gt;.env&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Example:&lt;/strong&gt; Running NGINX and MySQL:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;cp env-example .env
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;You can edit the &lt;code&gt;.env&lt;/code&gt; file to chose which software&amp;rsquo;s you want to be installed in your environment. You can always refer to the &lt;code&gt;docker-compose.yml&lt;/code&gt; file to see how those variables are been used.&lt;/p&gt;
&lt;p&gt;2 - Build the enviroment and run it using &lt;code&gt;docker-compose&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;In this example we&amp;rsquo;ll see how to run NGINX (web server) and MySQL (database engine) to host a PHP Web Scripts:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;docker-compose up -d nginx mysql
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;: The &lt;code&gt;workspace&lt;/code&gt; and &lt;code&gt;php-fpm&lt;/code&gt; will run automatically in most of the cases, so no need to specify them in the &lt;code&gt;up&lt;/code&gt; command. If you couldn&amp;rsquo;t find them running then you need specify them as follow: &lt;code&gt;docker-compose up -d nginx php-fpm mysql workspace&lt;/code&gt;.&lt;/p&gt;
&lt;p&gt;You can select your own combination of Containers form the list below:&lt;/p&gt;
&lt;p&gt;You can select your own combination of containers form the list below:&lt;/p&gt;
&lt;p&gt;&lt;code&gt;nginx&lt;/code&gt;, &lt;code&gt;hhvm&lt;/code&gt;, &lt;code&gt;php-fpm&lt;/code&gt;, &lt;code&gt;mysql&lt;/code&gt;, &lt;code&gt;redis&lt;/code&gt;, &lt;code&gt;postgres&lt;/code&gt;, &lt;code&gt;mariadb&lt;/code&gt;, &lt;code&gt;neo4j&lt;/code&gt;, &lt;code&gt;mongo&lt;/code&gt;, &lt;code&gt;apache2&lt;/code&gt;, &lt;code&gt;caddy&lt;/code&gt;, &lt;code&gt;memcached&lt;/code&gt;, &lt;code&gt;beanstalkd&lt;/code&gt;, &lt;code&gt;beanstalkd-console&lt;/code&gt;, &lt;code&gt;rabbitmq&lt;/code&gt;, &lt;code&gt;workspace&lt;/code&gt;, &lt;code&gt;phpmyadmin&lt;/code&gt;, &lt;code&gt;aerospike&lt;/code&gt;, &lt;code&gt;pgadmin&lt;/code&gt;, &lt;code&gt;elasticsearch&lt;/code&gt;, &lt;code&gt;rethinkdb&lt;/code&gt;.&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;&lt;code&gt;nginx&lt;/code&gt;, &lt;code&gt;hhvm&lt;/code&gt;, &lt;code&gt;php-fpm&lt;/code&gt;, &lt;code&gt;mysql&lt;/code&gt;, &lt;code&gt;redis&lt;/code&gt;, &lt;code&gt;postgres&lt;/code&gt;, &lt;code&gt;mariadb&lt;/code&gt;, &lt;code&gt;neo4j&lt;/code&gt;, &lt;code&gt;mongo&lt;/code&gt;, &lt;code&gt;apache2&lt;/code&gt;, &lt;code&gt;caddy&lt;/code&gt;, &lt;code&gt;memcached&lt;/code&gt;, &lt;code&gt;beanstalkd&lt;/code&gt;, &lt;code&gt;beanstalkd-console&lt;/code&gt;, &lt;code&gt;rabbitmq&lt;/code&gt;, &lt;code&gt;beanstalkd-console&lt;/code&gt;, &lt;code&gt;workspace&lt;/code&gt;, &lt;code&gt;phpmyadmin&lt;/code&gt;, &lt;code&gt;adminer&lt;/code&gt;, &lt;code&gt;aerospike&lt;/code&gt;, &lt;code&gt;pgadmin&lt;/code&gt;, &lt;code&gt;elasticsearch&lt;/code&gt;, &lt;code&gt;rethinkdb&lt;/code&gt;, &lt;code&gt;postgres-postgis&lt;/code&gt;, &lt;code&gt;certbot&lt;/code&gt;, &lt;code&gt;mailhog&lt;/code&gt;, &lt;code&gt;minio&lt;/code&gt; and more&amp;hellip;!&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;&lt;em&gt;(Please note that sometimes we forget to update the docs, so check the &lt;code&gt;docker-compose.yml&lt;/code&gt; file to see an updated list of all available containers).&lt;/em&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
2 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, &amp;hellip;).&lt;/p&gt;
3 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, &amp;hellip;)&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;docker-compose exec workspace bash
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;Alternatively, for Windows PowerShell users: execute the following command to enter any running container:&lt;/p&gt;
&lt;p&gt;&lt;em&gt;Alternatively, for Windows PowerShell users: execute the following command to enter any running container:&lt;/em&gt;&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;docker exec -it {workspace-container-id} bash
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt; You can add &lt;code&gt;--user=laradock&lt;/code&gt; (example &lt;code&gt;docker-compose exec --user=laradock workspace bash&lt;/code&gt;) to have files created as your host&amp;rsquo;s user. (you can change the PUID (User id) and PGID (group id) variables from the &lt;code&gt;docker-compose.yml&lt;/code&gt;).&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt; You can add &lt;code&gt;--user=laradock&lt;/code&gt; to have files created as your host&amp;rsquo;s user. Example:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;docker-compose exec --user=laradock workspace bash
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;em&gt;You can change the PUID (User id) and PGID (group id) variables from the &lt;code&gt;.env&lt;/code&gt; file)&lt;/em&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
3 - Edit your project configurations.&lt;/p&gt;
4 - Update your project configurations to use the database host&lt;/p&gt;
&lt;p&gt;Open your &lt;code&gt;.env&lt;/code&gt; file and set the &lt;code&gt;DB_HOST&lt;/code&gt; to &lt;code&gt;mysql&lt;/code&gt;:&lt;/p&gt;
&lt;p&gt;Open your PHP project&amp;rsquo;s &lt;code&gt;.env&lt;/code&gt; file or whichever configuration file you are reading from, and set the database host &lt;code&gt;DB_HOST&lt;/code&gt; to &lt;code&gt;mysql&lt;/code&gt;:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-env&#34;&gt;DB_HOST=mysql
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;em&gt;If you want to use Laravel and you don&amp;rsquo;t have it installed yet, see &lt;a href=&#34;#Install-Laravel&#34;&gt;How to Install Laravel in a Docker Container&lt;/a&gt;.&lt;/em&gt;&lt;/p&gt;
&lt;p&gt;&lt;em&gt;If you want to install Laravel as PHP project, see &lt;a href=&#34;#Install-Laravel&#34;&gt;How to Install Laravel in a Docker Container&lt;/a&gt;.&lt;/em&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
4 - Open your browser and visit your localhost address (&lt;code&gt;http://localhost/&lt;/code&gt;).&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;strong&gt;Debugging&lt;/strong&gt;: if you are facing any problem here check the &lt;a href=&#34;#debugging&#34;&gt;Debugging&lt;/a&gt; section.&lt;/p&gt;
&lt;p&gt;If you need a special support. Contact me, more details in the &lt;a href=&#34;#Help&#34;&gt;Help &amp;amp; Questions&lt;/a&gt; section.&lt;/p&gt;
5 - Open your browser and visit your localhost address &lt;code&gt;http://localhost/&lt;/code&gt;. If you followed the multiple projects setup, you can visit &lt;code&gt;http://project-1.dev/&lt;/code&gt; and &lt;code&gt;http://project-2.dev/&lt;/code&gt;. But first don&amp;rsquo;t&lt;/p&gt;
</description>
</item>

View File

@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
<meta http-equiv="X-UA-Compatible" content="IE=10" />
<title>Help &amp; Questions - Laradock</title>
<meta name="generator" content="Hugo 0.18.1" />
<meta name="generator" content="Hugo 0.19" />
<meta name="description" content="Laradock documentations.">
@ -311,9 +311,9 @@
<div class="wrapper">
<h1>Help &amp; Questions </h1>
<p>Join the chat room on <a href="https://gitter.im/LaraDock/laradock">Gitter</a> and get help and support from the community.</p>
<p>Join the chat room on <a href="https://gitter.im/Laradock/laradock">Gitter</a> and get help and support from the community.</p>
<p>You can as well can open an <a href="https://github.com/laradock/laradock/issues">issue</a> on Github (will be labeled as Question) and discuss it with people on <a href="https://gitter.im/LaraDock/laradock">Gitter</a>.</p>
<p>You can as well can open an <a href="https://github.com/laradock/laradock/issues">issue</a> on Github (will be labeled as Question) and discuss it with people on <a href="https://gitter.im/Laradock/laradock">Gitter</a>.</p>
<aside class="copyright" role="note">

View File

@ -14,9 +14,9 @@
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://laradock.io/help/</guid>
<description>&lt;p&gt;Join the chat room on &lt;a href=&#34;https://gitter.im/LaraDock/laradock&#34;&gt;Gitter&lt;/a&gt; and get help and support from the community.&lt;/p&gt;
<description>&lt;p&gt;Join the chat room on &lt;a href=&#34;https://gitter.im/Laradock/laradock&#34;&gt;Gitter&lt;/a&gt; and get help and support from the community.&lt;/p&gt;
&lt;p&gt;You can as well can open an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;issue&lt;/a&gt; on Github (will be labeled as Question) and discuss it with people on &lt;a href=&#34;https://gitter.im/LaraDock/laradock&#34;&gt;Gitter&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;You can as well can open an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;issue&lt;/a&gt; on Github (will be labeled as Question) and discuss it with people on &lt;a href=&#34;https://gitter.im/Laradock/laradock&#34;&gt;Gitter&lt;/a&gt;.&lt;/p&gt;
</description>
</item>

View File

@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
<meta http-equiv="X-UA-Compatible" content="IE=10" />
<title>Laradock</title>
<meta name="generator" content="Hugo 0.18.1" />
<meta name="generator" content="Hugo 0.19" />
<meta name="description" content="Laradock documentations.">
@ -314,27 +314,32 @@
<p>LaraDock strives to make the PHP development experience easier and faster.</p>
<p>Laradock strives to make the PHP development experience easier and faster.</p>
<p>It contains pre-packaged Docker Images that provides you a wonderful <em>development</em> environment without requiring you to install PHP, NGINX, MySQL, Redis, and any other software on your machines.</p>
<p>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&hellip;).</p>
<p>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&hellip;).</p>
<h2 id="quick-overview">Quick Overview</h2>
<p>Let&rsquo;s see how easy it is to install <code>NGINX</code>, <code>PHP</code>, <code>Composer</code>, <code>MySQL</code>, <code>Redis</code> and <code>beanstalkd</code>:</p>
<p>1 - Clone LaraDock inside your PHP project:</p>
<p>1 - Clone Laradock inside your PHP project:</p>
<pre><code class="language-shell">git clone https://github.com/Laradock/laradock.git
</code></pre>
<p>2 - Enter the laradock folder and run this command:</p>
<p>2 - Enter the laradock folder and rename <code>env-example</code> to <code>.env</code>.</p>
<pre><code class="language-shell">cp env-example .env
</code></pre>
<p>3 - Run your containers:</p>
<pre><code class="language-shell">docker-compose up -d nginx mysql redis beanstalkd
</code></pre>
<p>3 - Open your <code>.env</code> file and set the following:</p>
<p>3 - Open your project&rsquo;s <code>.env</code> file and set the following:</p>
<pre><code class="language-shell">DB_HOST=mysql
REDIS_HOST=redis
@ -366,21 +371,21 @@ QUEUE_HOST=beanstalkd
<p><a name="laradock-vs-homestead"></a></p>
<h2 id="laradock-vs-homestead-for-laravel-developers">LaraDock VS Homestead (For Laravel Developers)</h2>
<h2 id="laradock-vs-homestead-for-laravel-developers">Laradock VS Homestead (For Laravel Developers)</h2>
<blockquote>
<p>LaraDock It&rsquo;s like Laravel Homestead but for Docker instead of Vagrant.</p>
<p>Laradock It&rsquo;s like Laravel Homestead but for Docker instead of Vagrant.</p>
</blockquote>
<p>LaraDock and <a href="https://laravel.com/docs/master/homestead">Homestead</a> both give you complete virtual development environments. (Without the need to install and configure every single software on your own Operating System).</p>
<p>Laradock and <a href="https://laravel.com/docs/master/homestead">Homestead</a> both give you complete virtual development environments. (Without the need to install and configure every single software on your own Operating System).</p>
<ul>
<li><p>Homestead is a tool that controls Vagrant for you (using Homestead special commands). And Vagrant manages your Virtual Machine.</p></li>
<li><p>LaraDock is a tool that controls Docker for you (using Docker &amp; Docker Compose official commands). And Docker manages your Virtual Containers.</p></li>
<li><p>Laradock is a tool that controls Docker for you (using Docker &amp; Docker Compose official commands). And Docker manages your Virtual Containers.</p></li>
</ul>
<p>Running a virtual container is much faster than running a full virtual Machine. Thus <strong>LaraDock is much faster than Homestead</strong>.</p>
<p>Running a virtual container is much faster than running a full virtual Machine. Thus <strong>Laradock is much faster than Homestead</strong>.</p>
<p><a name="Demo"></a></p>
@ -389,10 +394,10 @@ QUEUE_HOST=beanstalkd
<p>What&rsquo;s better than a <strong>Demo Video</strong>:</p>
<ul>
<li>LaraDock <a href="https://www.youtube.com/watch?v=TQii1jDa96Y">v4.*</a></li>
<li>LaraDock <a href="https://www.youtube.com/watch?v=-DamFMczwDA">v2.*</a></li>
<li>LaraDock <a href="https://www.youtube.com/watch?v=jGkyO6Is_aI">v0.3</a></li>
<li>LaraDock <a href="https://www.youtube.com/watch?v=3YQsHe6oF80">v0.1</a></li>
<li>Laradock <a href="https://www.youtube.com/watch?v=TQii1jDa96Y">v4.*</a></li>
<li>Laradock <a href="https://www.youtube.com/watch?v=-DamFMczwDA">v2.*</a></li>
<li>Laradock <a href="https://www.youtube.com/watch?v=jGkyO6Is_aI">v0.3</a></li>
<li>Laradock <a href="https://www.youtube.com/watch?v=3YQsHe6oF80">v0.1</a></li>
</ul>
<p><a name="features"></a></p>
@ -424,11 +429,12 @@ QUEUE_HOST=beanstalkd
<ul>
<li>MySQL</li>
<li>PostgreSQL</li>
<li>MariaDB</li>
<li>MongoDB</li>
<li>Neo4j</li>
<li>RethinkDB</li>
<li>PostgreSQL</li>
<li>Postgres Postgis</li>
</ul></li>
<li><strong>Cache Engines:</strong>
@ -462,9 +468,12 @@ QUEUE_HOST=beanstalkd
<ul>
<li>PhpMyAdmin</li>
<li>Adminer</li>
<li>PgAdmin</li>
<li>ElasticSearch</li>
<li>Selenium</li>
<li>Certbot</li>
<li>Mailhog</li>
<li>Minio</li>
<li>Workspace
@ -496,7 +505,7 @@ QUEUE_HOST=beanstalkd
<p>You are welcome to join our chat room on Gitter.</p>
<p><a href="https://gitter.im/LaraDock/laradock?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge"><img src="https://badges.gitter.im/LaraDock/laradock.svg" alt="Gitter" /></a></p>
<p><a href="https://gitter.im/Laradock/laradock?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge"><img src="https://badges.gitter.im/Laradock/laradock.svg" alt="Gitter" /></a></p>
<h1>Getting Started </h1>
@ -514,88 +523,123 @@ QUEUE_HOST=beanstalkd
<p>Choose the setup the best suits your needs.</p>
<h4 id="a-setup-for-single-project">A) Setup for Single Project:</h4>
<ul>
<li><a href="#A">A) Setup for Single Project</a>
<p><em>(In case you want a Docker environment for each project)</em></p>
<ul>
<li><a href="#A1">A.1) Already have a PHP project</a></li>
<li><a href="#A2">A.2) Don&rsquo;t have a PHP project yet</a></li>
</ul></li>
<li><a href="#B">B) Setup for Multiple Projects</a></li>
</ul>
<h5 id="a-1-setup-environment-in-existing-project">A.1) Setup environment in existing Project:</h5>
<p><a name="A"></a></p>
<p><em>(In case you already have a project, and you want to setup an environment to run it)</em></p>
<h3 id="a-setup-for-single-project">A) Setup for Single Project</h3>
<p>1 - Clone this repository on your project root directory:</p>
<blockquote>
<p>(Follow these steps if you want a separate Docker environment for each project)</p>
</blockquote>
<p><a name="A1"></a></p>
<h3 id="a-1-already-have-a-php-project">A.1) Already have a PHP project:</h3>
<p>1 - Clone laradock on your project root directory:</p>
<pre><code class="language-bash">git submodule add https://github.com/Laradock/laradock.git
</code></pre>
<p><em>Note 1: If you are not yet using Git for your PHP project, you can use <code>git clone https://github.com/Laradock/laradock.git</code> instead.</em></p>
<p><strong>Notes:</strong></p>
<p><em>Note 2: To keep track of your LaraDock changes, between your projects and also keep LaraDock updated. <a href="#keep-tracking-LaraDock">Check this</a></em></p>
<ul>
<li><p>If you are not using Git yet for your project, you can use <code>git clone</code> instead of <code>git submodule</code>.</p></li>
<p><em>Note 3: In this case the folder structure will be like this:</em></p>
<li><p>Note 2: To keep track of your Laradock changes, between your projects and also keep Laradock updated. <a href="http://laradock.io/documentation/#keep-track-of-your-laradock-changes">Check this</a></p></li>
</ul>
<pre><code>- project1
- laradock
- project2
- laradock
<p>Your folder structure should look like this:</p>
<pre><code>+ project-a
+ laradock-a
+ project-b
+ laradock-b
</code></pre>
<h5 id="a-2-setup-environment-first-then-create-project">A.2) Setup environment first then create project:</h5>
<p>(It&rsquo;s important to rename the folders differently in each project.)</p>
<p><em>(In case you don&rsquo;t have a project, and you want to create your project inside the Docker environment)</em></p>
<blockquote>
<p><strong>Now jump to the <a href="#Usage">Usage</a> section.</strong></p>
</blockquote>
<p><a name="A2"></a></p>
<h3 id="a-2-don-t-have-a-php-project-yet">A.2) Don&rsquo;t have a PHP project yet:</h3>
<p>1 - Clone this repository anywhere on your machine:</p>
<pre><code class="language-bash">git clone https://github.com/laradock/laradock.git
</code></pre>
<p>Note: In this case the folder structure will be like this:</p>
<p>Your folder structure should look like this:</p>
<pre><code>- projects
- laradock
- myProject
<pre><code>+ laradock
+ project-z
</code></pre>
<p>2 - Edit the <code>docker-compose.yml</code> file to map to your project directory once you have it (example: <code>- ../myProject:/var/www</code>).</p>
<p>2 - Edit your web server sites configuration.</p>
<p>3 - Stop and re-run your docker-compose command for the changes to take place.</p>
<p><strong>In case of NGINX:</strong> open <code>nginx/sites/default.conf</code> and change the <code>root</code> from <code>/var/www/public</code> to <code>/var/www/{my-project-folder-name}/public</code>.</p>
<pre><code>docker-compose stop &amp;&amp; docker-compose up -d XXXX YYYY ZZZZ ....
</code></pre>
<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>
<h4 id="b-setup-for-multiple-projects">B) Setup for Multiple Projects:</h4>
<p><strong>In case of Apache:</strong> :P</p>
<p>1 - Clone this repository anywhere on your machine:</p>
<p><br></p>
<blockquote>
<p><strong>Now jump to the <a href="#Usage">Usage</a> section.</strong></p>
</blockquote>
<p><a name="B"></a></p>
<h3 id="b-setup-for-multiple-projects">B) Setup for Multiple Projects:</h3>
<blockquote>
<p>(Follow these steps if you want a single Docker environment for all your project)</p>
</blockquote>
<p>1 - Clone this repository anywhere on your machine (similar to <a href="#A2">Steps A.2. from above</a>):</p>
<pre><code class="language-bash">git clone https://github.com/laradock/laradock.git
</code></pre>
<p>2 - Edit the <code>docker-compose.yml</code> file to map to your projects directories:</p>
<p>Your folder structure should look like this:</p>
<pre><code> applications:
image: tianon/true
volumes:
- ../project1/:/var/www/project1
- ../project2/:/var/www/project2
<pre><code>+ laradock
+ project-1
+ project-2
</code></pre>
<p>3 - You can access all sites by visiting <code>http://localhost/project1/public</code> and <code>http://localhost/project2/public</code> but of course that&rsquo;s not very useful so let&rsquo;s setup NGINX quickly.</p>
<p>2 - Go to <code>nginx/sites</code> and create config files to point to different project directory when visiting different domains.</p>
<p>4 - Go to <code>nginx/sites</code> and copy <code>sample.conf.example</code> to <code>project1.conf</code> then to <code>project2.conf</code></p>
<p>Laradock by default includes <code>project-1.conf</code> and <code>project-2.conf</code> as working samples.</p>
<p>5 - Open the <code>project1.conf</code> file and edit the <code>server_name</code> and the <code>root</code> as follow:</p>
<p>3 - change the default names <code>project-n</code>:</p>
<pre><code> server_name project1.dev;
root /var/www/project1/public;
<p>You can rename the config files, project folders and domains as you like, just make sure the <code>root</code> in the config files, is pointing to the correct project folder name.</p>
<p>4 - Add the domains to the <strong>hosts</strong> files.</p>
<pre><code>127.0.0.1 project-1.dev
127.0.0.1 project-2.dev
</code></pre>
<p>Do the same for each project <code>project2.conf</code>, <code>project3.conf</code>,&hellip;</p>
<blockquote>
<p><strong>Now jump to the <a href="#Usage">Usage</a> section.</strong></p>
</blockquote>
<p>6 - Add the domains to the <strong>hosts</strong> files.</p>
<pre><code>127.0.0.1 project1.dev
</code></pre>
<p>7 - Create your project Databases. Right now you have to do it manually by entering your DB container, until we automate it soon.</p>
<p><a name="Usage"></a></p>
<h2 id="usage">Usage</h2>
@ -604,61 +648,72 @@ QUEUE_HOST=beanstalkd
<p>If you are using <strong>Docker Toolbox</strong> (VM), do one of the following:</p>
<ul>
<li>Upgrade to Docker <a href="https://www.docker.com/products/docker">Native</a> for Mac/Windows (Recommended). Check out <a href="#upgrading-laradock">Upgrading LaraDock</a></li>
<li>Use LaraDock v3.* (Visit the <code>LaraDock-ToolBox</code> <a href="https://github.com/laradock/laradock/tree/LaraDock-ToolBox">Branch</a>).</li>
<li>Upgrade to Docker <a href="https://www.docker.com/products/docker">Native</a> for Mac/Windows (Recommended). Check out <a href="http://laradock.io/documentation/#upgrading-laradock">Upgrading Laradock</a></li>
<li>Use Laradock v3.*. Visit the <a href="https://github.com/laradock/laradock/tree/LaraDock-ToolBox">LaraDock-ToolBox</a> branch. <em>(outdated)</em></li>
</ul>
<p><br></p>
<blockquote>
<p><strong>Warning:</strong> If you used an older version of LaraDock it&rsquo;s highly recommended to rebuild the containers you need to use <a href="#Build-Re-build-Containers">see how you rebuild a container</a> in order to prevent errors as much as possible.</p>
<p><strong>Warning:</strong> If you used an older version of Laradock it&rsquo;s highly recommended to rebuild the containers you need to use <a href="#Build-Re-build-Containers">see how you rebuild a container</a> in order to prevent as much errors as possible.</p>
</blockquote>
<p><br></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>
<pre><code class="language-shell">cp env-example .env
</code></pre>
<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><code>nginx</code>, <code>hhvm</code>, <code>php-fpm</code>, <code>mysql</code>, <code>redis</code>, <code>postgres</code>, <code>mariadb</code>, <code>neo4j</code>, <code>mongo</code>, <code>apache2</code>, <code>caddy</code>, <code>memcached</code>, <code>beanstalkd</code>, <code>beanstalkd-console</code>, <code>rabbitmq</code>, <code>workspace</code>, <code>phpmyadmin</code>, <code>aerospike</code>, <code>pgadmin</code>, <code>elasticsearch</code>, <code>rethinkdb</code>.</p>
<blockquote>
<p><code>nginx</code>, <code>hhvm</code>, <code>php-fpm</code>, <code>mysql</code>, <code>redis</code>, <code>postgres</code>, <code>mariadb</code>, <code>neo4j</code>, <code>mongo</code>, <code>apache2</code>, <code>caddy</code>, <code>memcached</code>, <code>beanstalkd</code>, <code>beanstalkd-console</code>, <code>rabbitmq</code>, <code>beanstalkd-console</code>, <code>workspace</code>, <code>phpmyadmin</code>, <code>adminer</code>, <code>aerospike</code>, <code>pgadmin</code>, <code>elasticsearch</code>, <code>rethinkdb</code>, <code>postgres-postgis</code>, <code>certbot</code>, <code>mailhog</code>, <code>minio</code> and more&hellip;!</p>
</blockquote>
<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>
<pre><code class="language-bash">docker-compose exec workspace bash
</code></pre>
<p>Alternatively, for Windows PowerShell users: execute the following command to enter any running container:</p>
<p><em>Alternatively, for Windows PowerShell users: execute the following command to enter any running container:</em></p>
<pre><code class="language-bash">docker exec -it {workspace-container-id} bash
</code></pre>
<p><strong>Note:</strong> You can add <code>--user=laradock</code> (example <code>docker-compose exec --user=laradock workspace bash</code>) to have files created as your host&rsquo;s user. (you can change the PUID (User id) and PGID (group id) variables from the <code>docker-compose.yml</code>).</p>
<p><strong>Note:</strong> You can add <code>--user=laradock</code> to have files created as your host&rsquo;s user. Example:</p>
<pre><code class="language-shell">docker-compose exec --user=laradock workspace bash
</code></pre>
<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>
<pre><code class="language-env">DB_HOST=mysql
</code></pre>
<p><em>If you want to use Laravel and you don&rsquo;t have it installed yet, see <a href="#Install-Laravel">How to Install Laravel in a Docker Container</a>.</em></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>
<p><br>
<strong>Debugging</strong>: if you are facing any problem here check the <a href="#debugging">Debugging</a> section.</p>
<p>If you need a special support. Contact me, more details in the <a href="#Help">Help &amp; Questions</a> section.</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>
<h1>Documentation </h1>
@ -799,6 +854,11 @@ example for <code>mysql</code> it will be <code>mysql/Dockerfile</code>.</p>
<pre><code class="language-bash">docker logs {container-name}
</code></pre>
<p>More <a href="https://docs.docker.com/compose/reference/logs/">options</a></p>
<pre><code class="language-bash">docker logs -f {container-name}
</code></pre>
<p><br>
<a name="PHP"></a></p>
@ -929,7 +989,7 @@ xdebug.remote_connect_back=1
<p>By installing xDebug, you are enabling it to run on startup by default.</p>
<p>To control the behavior of xDebug (in the <code>php-fpm</code> Container), you can run the following commands from the LaraDock root folder, (at the same prompt where you run docker-compose):</p>
<p>To control the behavior of xDebug (in the <code>php-fpm</code> Container), you can run the following commands from the Laradock root folder, (at the same prompt where you run docker-compose):</p>
<ul>
<li>Stop xDebug from running by default: <code>./xdebugPhpFpm stop</code>.</li>
@ -969,11 +1029,11 @@ xdebug.remote_connect_back=1
<a name="Production"></a></p>
<p><br>
<a name="LaraDock-for-Production"></a></p>
<a name="Laradock-for-Production"></a></p>
<h2 id="prepare-laradock-for-production">Prepare LaraDock for Production</h2>
<h2 id="prepare-laradock-for-production">Prepare Laradock for Production</h2>
<p>It&rsquo;s recommended for production to create a custom <code>docker-compose.yml</code> file. For that reason, LaraDock is shipped with <code>production-docker-compose.yml</code> which should contain only the containers you are planning to run on production (usage example: <code>docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...</code>).</p>
<p>It&rsquo;s recommended for production to create a custom <code>docker-compose.yml</code> file. For that reason, Laradock is shipped with <code>production-docker-compose.yml</code> which should contain only the containers you are planning to run on production (usage example: <code>docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...</code>).</p>
<p>Note: The Database (MySQL/MariaDB/&hellip;) 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:</p>
@ -1014,7 +1074,7 @@ xdebug.remote_connect_back=1
<p>3 - Edit <code>docker-compose.yml</code> to Map the new application path:</p>
<p>By default, LaraDock assumes the Laravel application is living in the parent directory of the laradock folder.</p>
<p>By default, Laradock assumes the Laravel application is living in the parent directory of the laradock folder.</p>
<p>Since the new Laravel application is in the <code>my-cool-app</code> folder, we need to replace <code>../:/var/www</code> with <code>../my-cool-app/:/var/www</code>, as follow:</p>
@ -1030,7 +1090,7 @@ xdebug.remote_connect_back=1
<pre><code class="language-bash">cd my-cool-app
</code></pre>
<p>5 - Go back to the LaraDock installation steps to see how to edit the <code>.env</code> file.</p>
<p>5 - Go back to the Laradock installation steps to see how to edit the <code>.env</code> file.</p>
<p><br>
<a name="Run-Artisan-Commands"></a></p>
@ -1132,7 +1192,7 @@ SESSION_DRIVER=redis
<p>5 - You can manually test it from Laravel with this code:</p>
<pre><code class="language-php">\Cache::store('redis')-&gt;put('LaraDock', 'Awesome', 10);
<pre><code class="language-php">\Cache::store('redis')-&gt;put('Laradock', 'Awesome', 10);
</code></pre>
<p><br>
@ -1235,6 +1295,18 @@ docker-compose up -d mariadb phpmyadmin
<p>2 - Open your browser and visit the localhost on port <strong>8080</strong>: <code>http://localhost:8080</code></p>
<p><br>
<a name="Use-Adminer"></a></p>
<h2 id="use-adminer">Use Adminer</h2>
<p>1 - Run the Adminer Container (<code>adminer</code>) with the <code>docker-compose up</code> command. Example:</p>
<pre><code class="language-bash">docker-compose up -d adminer
</code></pre>
<p>2 - Open your browser and visit the localhost on port <strong>8080</strong>: <code>http://localhost:8080</code></p>
<p><br>
<a name="Use-pgAdmin"></a></p>
@ -1399,7 +1471,7 @@ A package (<a href="https://github.com/duxet/laravel-rethinkdb">Laravel RethinkD
<h2 id="install-codeigniter">Install CodeIgniter</h2>
<p>To install CodeIgniter 3 on LaraDock all you have to do is the following simple steps:</p>
<p>To install CodeIgniter 3 on Laradock all you have to do is the following simple steps:</p>
<p>1 - Open the <code>docker-compose.yml</code> file.</p>
@ -1639,7 +1711,7 @@ port=1234
<h2 id="common-terminal-aliases">Common Terminal Aliases</h2>
<p>When you start your docker container, LaraDock will copy the <code>aliases.sh</code> file located in the <code>laradock/workspace</code> directory and add sourcing to the container <code>~/.bashrc</code> file.</p>
<p>When you start your docker container, Laradock will copy the <code>aliases.sh</code> file located in the <code>laradock/workspace</code> directory and add sourcing to the container <code>~/.bashrc</code> file.</p>
<p>You are free to modify the <code>aliases.sh</code> as you see fit, adding your own aliases (or function macros) to suit your requirements.</p>
@ -1714,12 +1786,12 @@ e) set it to <code>true</code></p>
<p><a href="https://github.com/laradock/laradock/blob/master/_guides/phpstorm.md"><strong>Debugging Guide Here</strong></a></p>
<p><br>
<a name="keep-tracking-LaraDock"></a></p>
<a name="keep-tracking-Laradock"></a></p>
<h2 id="keep-track-of-your-laradock-changes">Keep track of your LaraDock changes</h2>
<h2 id="keep-track-of-your-laradock-changes">Keep track of your Laradock changes</h2>
<ol>
<li>Fork the LaraDock repository.</li>
<li>Fork the Laradock repository.</li>
<li>Use that fork as a submodule.</li>
<li>Commit all your changes to your fork.</li>
<li>Pull new stuff from the main repository from time to time.</li>
@ -1728,15 +1800,15 @@ e) set it to <code>true</code></p>
<p><br>
<a name="upgrading-laradock"></a></p>
<h2 id="upgrading-laradock">Upgrading LaraDock</h2>
<h2 id="upgrading-laradock">Upgrading Laradock</h2>
<p>Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading LaraDock from v3.* to v4.*:</p>
<p>Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading Laradock from v3.* to v4.*:</p>
<ol>
<li>Stop the docker VM <code>docker-machine stop {default}</code></li>
<li>Install Docker for <a href="https://docs.docker.com/docker-for-mac/">Mac</a> or <a href="https://docs.docker.com/docker-for-windows/">Windows</a>.</li>
<li>Upgrade LaraDock to <code>v4.*.*</code> (<code>git pull origin master</code>)</li>
<li>Use LaraDock as you used to do: <code>docker-compose up -d nginx mysql</code>.</li>
<li>Upgrade Laradock to <code>v4.*.*</code> (<code>git pull origin master</code>)</li>
<li>Use Laradock as you used to do: <code>docker-compose up -d nginx mysql</code>.</li>
</ol>
<p><strong>Note:</strong> If you face any problem with the last step above: rebuild all your containers
@ -1748,13 +1820,27 @@ e) set it to <code>true</code></p>
<h2 id="improve-speed-on-macos">Improve speed on MacOS</h2>
<p>Sharing code into Docker containers with osxfs have very poor performance compared to Linux. You can get around this issue by using NFS to share your files betwen your host and your container.</p>
<p>Sharing code into Docker containers with osxfs have very poor performance compared to Linux. Likely there are some workarounds:</p>
<blockquote>
<p>How to share files using NFS (d4m-nfs)</p>
</blockquote>
<h3 id="workaround-a-using-dinghy">Workaround A: using dinghy</h3>
<p><a href="https://github.com/IFSight/d4m-nfs">d4m-nfs</a> automatically mount NFS volume instead of osxfs one.</p>
<p><a href="https://github.com/codekitchen/dinghy">Dinghy</a> creates its own VM using docker-machine, it will not modify your existing docker-machine VMs.</p>
<p>Quick Setup giude, (we recommend you check their docs)</p>
<p>1) <code>brew tap codekitchen/dinghy</code></p>
<p>2) <code>brew install dinghy</code></p>
<p>3) <code>dinghy create --provider virtualbox</code> (must have virtualbox installed, but they support other providers if you prefer)</p>
<p>4) after the above command is done it will display some env variables, copy them to the bash profile or zsh or.. (this will instruct docker to use the server running inside the VM)</p>
<p>5) <code>docker-compose up ...</code></p>
<h3 id="workaround-b-using-d4m-nfs">Workaround B: using d4m-nfs</h3>
<p><a href="https://github.com/IFSight/d4m-nfs">D4m-nfs</a> automatically mount NFS volume instead of osxfs one.</p>
<p>1) Update the Docker [File Sharing] preferences:</p>
@ -1770,23 +1856,30 @@ e) set it to <code>true</code></p>
<p>4) Create (or edit) the file <code>~/d4m-nfs/etc/d4m-nfs-mounts.txt</code>, and write the follwing configuration in it:</p>
<pre><code class="language-txt">/Users:/Users
/Volumes:/Volumes
/private:/private
</code></pre>
<p>5) Create (or edit) the file <code>/etc/exports</code>, make sure it exists and is empty. (There may be collisions if you come from Vagrant or if you already executed the <code>d4m-nfs.sh</code> script before).</p>
<p>6) Run the <code>d4m-nfs.sh</code> script:</p>
<p>6) Run the <code>d4m-nfs.sh</code> script (might need Sudo):</p>
<pre><code class="language-bash">~/d4m-nfs/d4m-nfs.sh
</code></pre>
<p>That&rsquo;s it! Run your containers.. Example:</p>
<pre><code class="language-bash">docker-compose up -d nginx mysql
<pre><code class="language-bash">docker-compose up ...
</code></pre>
<p><strong>Note:</strong> If you faced any errors, try restarting Docker, and make sure you have no spaces in the <code>d4m-nfs-mounts.txt</code> file, and your <code>/etc/exports</code> file is clear.</p>
<p><em>Note: If you faced any errors, try restarting Docker, and make sure you have no spaces in the <code>d4m-nfs-mounts.txt</code> file, and your <code>/etc/exports</code> file is clear.</em></p>
<h3 id="other-good-workarounds">Other good workarounds:</h3>
<ul>
<li><a href="https://github.com/EugenMayer/docker-sync">docker-sync</a></li>
<li>Add more here..</li>
</ul>
<p>More details about this issue <a href="https://github.com/docker/for-mac/issues/77">here</a>.</p>
<p><br>
<a name="Common-Problems"></a></p>
@ -1852,18 +1945,18 @@ e) set it to <code>true</code></p>
<li>Option B
<ol>
<li>Change the <code>DB_HOST</code> value to the same name as the MySQL docker container. The LaraDock docker-compose file currently has this as <code>mysql</code></li>
<li>Change the <code>DB_HOST</code> value to the same name as the MySQL docker container. The Laradock docker-compose file currently has this as <code>mysql</code></li>
</ol></li>
</ul>
<h1>Related Projects </h1>
<p>LaraDock related projects:</p>
<p>Laradock related projects:</p>
<ul>
<li><a href="https://github.com/lorinlee/laradock-cli">LaraDock CLI</a> by <a href="https://github.com/lorinlee">LorinLee</a></li>
<li><a href="https://github.com/bagart/laradock_env">LaraDock Env</a> by <a href="https://github.com/bagart">BAGArt</a></li>
<li><a href="https://github.com/lorinlee/laradock-cli">Laradock CLI</a> by <a href="https://github.com/lorinlee">LorinLee</a></li>
<li><a href="https://github.com/bagart/laradock_env">Laradock Env</a> by <a href="https://github.com/bagart">BAGArt</a></li>
<li><a href="https://github.com/poyhsiao/Klaradock">Klaradock</a> by <a href="https://github.com/poyhsiao">Kim Hsiao</a></li>
<li><a href="https://github.com/sifat-rahim/ansible-laradock-kubernetes">Ansible Laradock Kubernetes</a> by <a href="https://github.com/sifat-rahim">Sifat Rahim</a>
These Docker Compose projects have piqued our interest:</li>
@ -1877,9 +1970,9 @@ These Docker Compose projects have piqued our interest:</li>
<h1>Help &amp; Questions </h1>
<p>Join the chat room on <a href="https://gitter.im/LaraDock/laradock">Gitter</a> and get help and support from the community.</p>
<p>Join the chat room on <a href="https://gitter.im/Laradock/laradock">Gitter</a> and get help and support from the community.</p>
<p>You can as well can open an <a href="https://github.com/laradock/laradock/issues">issue</a> on Github (will be labeled as Question) and discuss it with people on <a href="https://gitter.im/LaraDock/laradock">Gitter</a>.</p>
<p>You can as well can open an <a href="https://github.com/laradock/laradock/issues">issue</a> on Github (will be labeled as Question) and discuss it with people on <a href="https://gitter.im/Laradock/laradock">Gitter</a>.</p>
<h1>Contributing </h1>
@ -1888,39 +1981,52 @@ These Docker Compose projects have piqued our interest:</li>
<p>Your contribution is more than welcome.</p>
<h2 id="got-a-question-or-problem">Got a Question or Problem?</h2>
<h2 id="i-have-a-question-problem">I have a Question/Problem</h2>
<p>If you have questions about how to use LaraDock, please direct your questions to the discussion on <a href="https://gitter.im/LaraDock/laradock">Gitter</a>. If you believe your question could help others, then consider opening an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as Question).</p>
<p>If you have questions about how to use Laradock, please direct your questions to the discussion on <a href="https://gitter.im/Laradock/laradock">Gitter</a>. If you believe your question could help others, then consider opening an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as <code>Question</code>) And you can still seek help on Gitter for it.</p>
<h2 id="found-an-issue">Found an Issue?</h2>
<h2 id="i-found-an-issue">I found an Issue</h2>
<p>If you find a bug in the source code or a mistake in the documentation, you can help us by
submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. Even better you can submit a Pull Request with a fix.</p>
<p>If have an issue or you found a typo in the documentation, you can help us by
opnening an <a href="https://github.com/laradock/laradock/issues">Issue</a>.</p>
<h2 id="want-a-feature">Want a Feature?</h2>
<p><strong>Steps to do before opening an Issue:</strong></p>
<p>You can request a new feature by submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.</p>
<ol>
<li><p>Before you submit your issue search the archive, maybe your question was already answered couple hours ago (search in the closed Issues as well).</p></li>
<h2 id="update-documentation-site">Update Documentation (Site)</h2>
<li><p>Decide if the Issue belongs to this project or to <a href="https://github.com/docker">Docker</a> itself! or even the tool you are using such as Nginx or MongoDB&hellip;</p></li>
</ol>
<p>If your issue appears to be a bug, and hasn&rsquo;t been reported, then open a new issue.</p>
<p><em>This Help us to maximize the effort we can spend fixing issues and adding new
features, by not reporting duplicate issues.</em></p>
<h2 id="i-want-a-feature">I want a Feature</h2>
<p>You can request a new feature by submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a> (it will be labeled as <code>Feature Suggestion</code>). If you would like to implement a new feature then consider submitting a Pull Request yourself.</p>
<h2 id="i-want-to-update-the-documentation-site">I want to update the Documentation (Site)</h2>
<p>Laradock uses <a href="https://gohugo.io/">Hugo</a> as website generator tool, with the <a href="http://themes.gohugo.io/theme/material-docs/">Material Docs theme</a>. You might need to check their docs quickly.</p>
<ol>
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine.</li>
<li>Clone laradock.</li>
<li>Go to <code>/docs</code>.</li>
<li>Delete everything except the <code>_settings</code> folder &amp; the <code>CNAME</code> file.</li>
<li>Open <code>docs/_settings</code> from your terminal and run <code>hugo serve</code> to host the website locally.</li>
<li>Open the <code>docs/_settings/content</code> and search for the folder of the section you want to edit.</li>
<li>In each section there&rsquo;s an <code>index.md</code> file, that&rsquo;s the file you need to edit.</li>
<li>To edit the sidebar (in case you are adding new section) go to <code>docs/_settings/config.toml</code> and add the section there.</li>
<li>After done editing, run the this command <code>hugo</code> to generate the updated site inside the <code>docs</code> folder.</li>
<li>Go back to the project root directory, commit and push..</li>
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy thing).</li>
<li>Open the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder represents a section in the menu).</li>
<li>Delete the <code>/docs</code> folder from the root.</li>
<li>When you finish editing, go to <code>DOCUMENTATION/_settings/</code> and run the <code>hugo</code> command to generate the HTML docs (inside new <code>/docs</code> folder).</li>
</ol>
<h2 id="coding-guidelines">Coding Guidelines</h2>
<h3 id="to-host-the-website-locally">To Host the website locally</h3>
<h2 id="support-new-software">Support new Software</h2>
<p>Go to <code>DOCUMENTATION/_settings</code> in your terminal and run <code>hugo serve</code> to host the website locally.</p>
<h3 id="edit-the-sidebar">Edit the sidebar</h3>
<p>To add a new section to the sidebar or edit existing one, you need to edit this file <code>DOCUMENTATION/_settings/config.toml</code>.</p>
<h2 id="how-to-support-new-software-add-new-container">How to support new Software (Add new Container)</h2>
<ul>
<li><p>Create folder with the software name.</p></li>
@ -1933,10 +2039,10 @@ submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. E
<li><p>Make sure you follow our commenting style.</p></li>
<li><p>Add the software in the <code>Readme</code>.</p></li>
<li><p>Add the software in the <code>Documentation</code>.</p></li>
</ul>
<h2 id="edit-existing-software">Edit existing Software</h2>
<h2 id="edit-existing-software-edit-a-container">Edit existing Software (Edit a Container)</h2>
<ul>
<li><p>Open the software (container) folder.</p></li>
@ -1944,22 +2050,14 @@ submitting an <a href="https://github.com/laradock/laradock/issues">Issue</a>. E
<li><p>Edit the files you want to update.</p></li>
<li><p><strong>Note:</strong> If you want to edit the base image of the <code>Workspace</code> or the <code>php-fpm</code> Containers,
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the LaraDock repository.</p></li>
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.</p></li>
<li><p>Make sure to update the <code>Readme</code> in case you made any changes.</p></li>
<li><p>Make sure to update the <code>Documentation</code> in case you made any changes.</p></li>
</ul>
<h2 id="issue-pr-submission-guidelines">Issue/PR Submission Guidelines</h2>
<h2 id="pull-request">Pull Request</h2>
<h2 id="submitting-an-issue">Submitting an Issue</h2>
<p>Before you submit your issue search the archive, maybe your question was already answered.</p>
<p>If your issue appears to be a bug, and hasn&rsquo;t been reported, open a new issue.
Help us to maximize the effort we can spend fixing issues and adding new
features, by not reporting duplicate issues.</p>
<h2 id="before-submitting-a-pull-request-pr">Before Submitting a Pull Request (PR)</h2>
<h3 id="1-before-submitting-a-pull-request-pr">1. Before Submitting a Pull Request (PR)</h3>
<p>Always Test everything and make sure its working:</p>
@ -1975,16 +2073,16 @@ features, by not reporting duplicate issues.</p>
<ul>
<li>Testing building the container (docker-compose build container-name) with no errors.</li>
<li>Test it in real App.</li>
<li>Test it in a real App if possible.</li>
</ul></li>
</ul>
<h2 id="submitting-a-pr">Submitting a PR</h2>
<h3 id="2-submitting-a-pr">2. Submitting a PR</h3>
<p>Consider the following guidelines:</p>
<ul>
<li><p>Search <a href="https://github.com/laradock/laradock/pulls">GitHub</a> for an open or closed Pull Request that relates to your submission. You don&rsquo;t want to duplicate effort.</p></li>
<li><p>Search <a href="https://github.com/laradock/laradock/pulls">GitHub</a> for an open or closed Pull Request that relates to your submission. You don&rsquo;t want to duplicate efforts.</p></li>
<li><p>Make your changes in a new git branch:</p>
@ -2019,10 +2117,9 @@ git push origin my-fix-branch -f
<p><em>WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments on code that were previously made by you and others in your commits.</em></p>
<h2 id="after-your-pr-is-merged">After your PR is merged</h2>
<h3 id="3-after-your-pr-is-merged">3. After your PR is merged</h3>
<p>After your pull request is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository:</p>
<p>After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:</p>
<ul>
<li><p>Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:</p>
@ -2048,7 +2145,7 @@ from the main (upstream) repository:</p>
<p><br></p>
<h2 id="happy-coding">Happy Coding :)</h2>
<h4 id="happy-coding">Happy Coding :)</h4>
<h1>License </h1>

View File

@ -16,27 +16,32 @@
<guid>http://laradock.io/introduction/</guid>
<description>
&lt;p&gt;LaraDock strives to make the PHP development experience easier and faster.&lt;/p&gt;
&lt;p&gt;Laradock strives to make the PHP development experience easier and faster.&lt;/p&gt;
&lt;p&gt;It contains pre-packaged Docker Images that provides you a wonderful &lt;em&gt;development&lt;/em&gt; environment without requiring you to install PHP, NGINX, MySQL, Redis, and any other software on your machines.&lt;/p&gt;
&lt;p&gt;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&amp;hellip;).&lt;/p&gt;
&lt;p&gt;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&amp;hellip;).&lt;/p&gt;
&lt;h2 id=&#34;quick-overview&#34;&gt;Quick Overview&lt;/h2&gt;
&lt;p&gt;Let&amp;rsquo;s see how easy it is to install &lt;code&gt;NGINX&lt;/code&gt;, &lt;code&gt;PHP&lt;/code&gt;, &lt;code&gt;Composer&lt;/code&gt;, &lt;code&gt;MySQL&lt;/code&gt;, &lt;code&gt;Redis&lt;/code&gt; and &lt;code&gt;beanstalkd&lt;/code&gt;:&lt;/p&gt;
&lt;p&gt;1 - Clone LaraDock inside your PHP project:&lt;/p&gt;
&lt;p&gt;1 - Clone Laradock inside your PHP project:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;git clone https://github.com/Laradock/laradock.git
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;2 - Enter the laradock folder and run this command:&lt;/p&gt;
&lt;p&gt;2 - Enter the laradock folder and rename &lt;code&gt;env-example&lt;/code&gt; to &lt;code&gt;.env&lt;/code&gt;.&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;cp env-example .env
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;3 - Run your containers:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;docker-compose up -d nginx mysql redis beanstalkd
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;3 - Open your &lt;code&gt;.env&lt;/code&gt; file and set the following:&lt;/p&gt;
&lt;p&gt;3 - Open your project&amp;rsquo;s &lt;code&gt;.env&lt;/code&gt; file and set the following:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;DB_HOST=mysql
REDIS_HOST=redis
@ -68,21 +73,21 @@ QUEUE_HOST=beanstalkd
&lt;p&gt;&lt;a name=&#34;laradock-vs-homestead&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h2 id=&#34;laradock-vs-homestead-for-laravel-developers&#34;&gt;LaraDock VS Homestead (For Laravel Developers)&lt;/h2&gt;
&lt;h2 id=&#34;laradock-vs-homestead-for-laravel-developers&#34;&gt;Laradock VS Homestead (For Laravel Developers)&lt;/h2&gt;
&lt;blockquote&gt;
&lt;p&gt;LaraDock It&amp;rsquo;s like Laravel Homestead but for Docker instead of Vagrant.&lt;/p&gt;
&lt;p&gt;Laradock It&amp;rsquo;s like Laravel Homestead but for Docker instead of Vagrant.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;LaraDock and &lt;a href=&#34;https://laravel.com/docs/master/homestead&#34;&gt;Homestead&lt;/a&gt; both give you complete virtual development environments. (Without the need to install and configure every single software on your own Operating System).&lt;/p&gt;
&lt;p&gt;Laradock and &lt;a href=&#34;https://laravel.com/docs/master/homestead&#34;&gt;Homestead&lt;/a&gt; both give you complete virtual development environments. (Without the need to install and configure every single software on your own Operating System).&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Homestead is a tool that controls Vagrant for you (using Homestead special commands). And Vagrant manages your Virtual Machine.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;LaraDock is a tool that controls Docker for you (using Docker &amp;amp; Docker Compose official commands). And Docker manages your Virtual Containers.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Laradock is a tool that controls Docker for you (using Docker &amp;amp; Docker Compose official commands). And Docker manages your Virtual Containers.&lt;/p&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;Running a virtual container is much faster than running a full virtual Machine. Thus &lt;strong&gt;LaraDock is much faster than Homestead&lt;/strong&gt;.&lt;/p&gt;
&lt;p&gt;Running a virtual container is much faster than running a full virtual Machine. Thus &lt;strong&gt;Laradock is much faster than Homestead&lt;/strong&gt;.&lt;/p&gt;
&lt;p&gt;&lt;a name=&#34;Demo&#34;&gt;&lt;/a&gt;&lt;/p&gt;
@ -91,10 +96,10 @@ QUEUE_HOST=beanstalkd
&lt;p&gt;What&amp;rsquo;s better than a &lt;strong&gt;Demo Video&lt;/strong&gt;:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;LaraDock &lt;a href=&#34;https://www.youtube.com/watch?v=TQii1jDa96Y&#34;&gt;v4.*&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;LaraDock &lt;a href=&#34;https://www.youtube.com/watch?v=-DamFMczwDA&#34;&gt;v2.*&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;LaraDock &lt;a href=&#34;https://www.youtube.com/watch?v=jGkyO6Is_aI&#34;&gt;v0.3&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;LaraDock &lt;a href=&#34;https://www.youtube.com/watch?v=3YQsHe6oF80&#34;&gt;v0.1&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;Laradock &lt;a href=&#34;https://www.youtube.com/watch?v=TQii1jDa96Y&#34;&gt;v4.*&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;Laradock &lt;a href=&#34;https://www.youtube.com/watch?v=-DamFMczwDA&#34;&gt;v2.*&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;Laradock &lt;a href=&#34;https://www.youtube.com/watch?v=jGkyO6Is_aI&#34;&gt;v0.3&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;Laradock &lt;a href=&#34;https://www.youtube.com/watch?v=3YQsHe6oF80&#34;&gt;v0.1&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;a name=&#34;features&#34;&gt;&lt;/a&gt;&lt;/p&gt;
@ -126,11 +131,12 @@ QUEUE_HOST=beanstalkd
&lt;ul&gt;
&lt;li&gt;MySQL&lt;/li&gt;
&lt;li&gt;PostgreSQL&lt;/li&gt;
&lt;li&gt;MariaDB&lt;/li&gt;
&lt;li&gt;MongoDB&lt;/li&gt;
&lt;li&gt;Neo4j&lt;/li&gt;
&lt;li&gt;RethinkDB&lt;/li&gt;
&lt;li&gt;PostgreSQL&lt;/li&gt;
&lt;li&gt;Postgres Postgis&lt;/li&gt;
&lt;/ul&gt;&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;Cache Engines:&lt;/strong&gt;
@ -164,9 +170,12 @@ QUEUE_HOST=beanstalkd
&lt;ul&gt;
&lt;li&gt;PhpMyAdmin&lt;/li&gt;
&lt;li&gt;Adminer&lt;/li&gt;
&lt;li&gt;PgAdmin&lt;/li&gt;
&lt;li&gt;ElasticSearch&lt;/li&gt;
&lt;li&gt;Selenium&lt;/li&gt;
&lt;li&gt;Certbot&lt;/li&gt;
&lt;li&gt;Mailhog&lt;/li&gt;
&lt;li&gt;Minio&lt;/li&gt;
&lt;li&gt;Workspace
@ -198,7 +207,7 @@ QUEUE_HOST=beanstalkd
&lt;p&gt;You are welcome to join our chat room on Gitter.&lt;/p&gt;
&lt;p&gt;&lt;a href=&#34;https://gitter.im/LaraDock/laradock?utm_source=badge&amp;amp;utm_medium=badge&amp;amp;utm_campaign=pr-badge&#34;&gt;&lt;img src=&#34;https://badges.gitter.im/LaraDock/laradock.svg&#34; alt=&#34;Gitter&#34; /&gt;&lt;/a&gt;&lt;/p&gt;
&lt;p&gt;&lt;a href=&#34;https://gitter.im/Laradock/laradock?utm_source=badge&amp;amp;utm_medium=badge&amp;amp;utm_campaign=pr-badge&#34;&gt;&lt;img src=&#34;https://badges.gitter.im/Laradock/laradock.svg&#34; alt=&#34;Gitter&#34; /&gt;&lt;/a&gt;&lt;/p&gt;
</description>
</item>
@ -221,88 +230,123 @@ QUEUE_HOST=beanstalkd
&lt;p&gt;Choose the setup the best suits your needs.&lt;/p&gt;
&lt;h4 id=&#34;a-setup-for-single-project&#34;&gt;A) Setup for Single Project:&lt;/h4&gt;
&lt;ul&gt;
&lt;li&gt;&lt;a href=&#34;#A&#34;&gt;A) Setup for Single Project&lt;/a&gt;
&lt;p&gt;&lt;em&gt;(In case you want a Docker environment for each project)&lt;/em&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;a href=&#34;#A1&#34;&gt;A.1) Already have a PHP project&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href=&#34;#A2&#34;&gt;A.2) Don&amp;rsquo;t have a PHP project yet&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href=&#34;#B&#34;&gt;B) Setup for Multiple Projects&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;h5 id=&#34;a-1-setup-environment-in-existing-project&#34;&gt;A.1) Setup environment in existing Project:&lt;/h5&gt;
&lt;p&gt;&lt;a name=&#34;A&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;p&gt;&lt;em&gt;(In case you already have a project, and you want to setup an environment to run it)&lt;/em&gt;&lt;/p&gt;
&lt;h3 id=&#34;a-setup-for-single-project&#34;&gt;A) Setup for Single Project&lt;/h3&gt;
&lt;p&gt;1 - Clone this repository on your project root directory:&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;(Follow these steps if you want a separate Docker environment for each project)&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;&lt;a name=&#34;A1&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h3 id=&#34;a-1-already-have-a-php-project&#34;&gt;A.1) Already have a PHP project:&lt;/h3&gt;
&lt;p&gt;1 - Clone laradock on your project root directory:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;git submodule add https://github.com/Laradock/laradock.git
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;em&gt;Note 1: If you are not yet using Git for your PHP project, you can use &lt;code&gt;git clone https://github.com/Laradock/laradock.git&lt;/code&gt; instead.&lt;/em&gt;&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Notes:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;&lt;em&gt;Note 2: To keep track of your LaraDock changes, between your projects and also keep LaraDock updated. &lt;a href=&#34;#keep-tracking-LaraDock&#34;&gt;Check this&lt;/a&gt;&lt;/em&gt;&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;If you are not using Git yet for your project, you can use &lt;code&gt;git clone&lt;/code&gt; instead of &lt;code&gt;git submodule&lt;/code&gt;.&lt;/p&gt;&lt;/li&gt;
&lt;p&gt;&lt;em&gt;Note 3: In this case the folder structure will be like this:&lt;/em&gt;&lt;/p&gt;
&lt;li&gt;&lt;p&gt;Note 2: To keep track of your Laradock changes, between your projects and also keep Laradock updated. &lt;a href=&#34;http://laradock.io/documentation/#keep-track-of-your-laradock-changes&#34;&gt;Check this&lt;/a&gt;&lt;/p&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;pre&gt;&lt;code&gt;- project1
- laradock
- project2
- laradock
&lt;p&gt;Your folder structure should look like this:&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;+ project-a
+ laradock-a
+ project-b
+ laradock-b
&lt;/code&gt;&lt;/pre&gt;
&lt;h5 id=&#34;a-2-setup-environment-first-then-create-project&#34;&gt;A.2) Setup environment first then create project:&lt;/h5&gt;
&lt;p&gt;(It&amp;rsquo;s important to rename the folders differently in each project.)&lt;/p&gt;
&lt;p&gt;&lt;em&gt;(In case you don&amp;rsquo;t have a project, and you want to create your project inside the Docker environment)&lt;/em&gt;&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;&lt;strong&gt;Now jump to the &lt;a href=&#34;#Usage&#34;&gt;Usage&lt;/a&gt; section.&lt;/strong&gt;&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;&lt;a name=&#34;A2&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h3 id=&#34;a-2-don-t-have-a-php-project-yet&#34;&gt;A.2) Don&amp;rsquo;t have a PHP project yet:&lt;/h3&gt;
&lt;p&gt;1 - Clone this repository anywhere on your machine:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;git clone https://github.com/laradock/laradock.git
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;Note: In this case the folder structure will be like this:&lt;/p&gt;
&lt;p&gt;Your folder structure should look like this:&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;- projects
- laradock
- myProject
&lt;pre&gt;&lt;code&gt;+ laradock
+ project-z
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;2 - Edit the &lt;code&gt;docker-compose.yml&lt;/code&gt; file to map to your project directory once you have it (example: &lt;code&gt;- ../myProject:/var/www&lt;/code&gt;).&lt;/p&gt;
&lt;p&gt;2 - Edit your web server sites configuration.&lt;/p&gt;
&lt;p&gt;3 - Stop and re-run your docker-compose command for the changes to take place.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;In case of NGINX:&lt;/strong&gt; open &lt;code&gt;nginx/sites/default.conf&lt;/code&gt; and change the &lt;code&gt;root&lt;/code&gt; from &lt;code&gt;/var/www/public&lt;/code&gt; to &lt;code&gt;/var/www/{my-project-folder-name}/public&lt;/code&gt;.&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;docker-compose stop &amp;amp;&amp;amp; docker-compose up -d XXXX YYYY ZZZZ ....
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;em&gt;Or you can keep &lt;code&gt;default.conf&lt;/code&gt; as it is, and create a separate config &lt;code&gt;my-site.conf&lt;/code&gt; file for it.&lt;/em&gt;&lt;/p&gt;
&lt;h4 id=&#34;b-setup-for-multiple-projects&#34;&gt;B) Setup for Multiple Projects:&lt;/h4&gt;
&lt;p&gt;&lt;strong&gt;In case of Apache:&lt;/strong&gt; :P&lt;/p&gt;
&lt;p&gt;1 - Clone this repository anywhere on your machine:&lt;/p&gt;
&lt;p&gt;&lt;br&gt;&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;&lt;strong&gt;Now jump to the &lt;a href=&#34;#Usage&#34;&gt;Usage&lt;/a&gt; section.&lt;/strong&gt;&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;&lt;a name=&#34;B&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h3 id=&#34;b-setup-for-multiple-projects&#34;&gt;B) Setup for Multiple Projects:&lt;/h3&gt;
&lt;blockquote&gt;
&lt;p&gt;(Follow these steps if you want a single Docker environment for all your project)&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;1 - Clone this repository anywhere on your machine (similar to &lt;a href=&#34;#A2&#34;&gt;Steps A.2. from above&lt;/a&gt;):&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;git clone https://github.com/laradock/laradock.git
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;2 - Edit the &lt;code&gt;docker-compose.yml&lt;/code&gt; file to map to your projects directories:&lt;/p&gt;
&lt;p&gt;Your folder structure should look like this:&lt;/p&gt;
&lt;pre&gt;&lt;code&gt; applications:
image: tianon/true
volumes:
- ../project1/:/var/www/project1
- ../project2/:/var/www/project2
&lt;pre&gt;&lt;code&gt;+ laradock
+ project-1
+ project-2
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;3 - You can access all sites by visiting &lt;code&gt;http://localhost/project1/public&lt;/code&gt; and &lt;code&gt;http://localhost/project2/public&lt;/code&gt; but of course that&amp;rsquo;s not very useful so let&amp;rsquo;s setup NGINX quickly.&lt;/p&gt;
&lt;p&gt;2 - Go to &lt;code&gt;nginx/sites&lt;/code&gt; and create config files to point to different project directory when visiting different domains.&lt;/p&gt;
&lt;p&gt;4 - Go to &lt;code&gt;nginx/sites&lt;/code&gt; and copy &lt;code&gt;sample.conf.example&lt;/code&gt; to &lt;code&gt;project1.conf&lt;/code&gt; then to &lt;code&gt;project2.conf&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;Laradock by default includes &lt;code&gt;project-1.conf&lt;/code&gt; and &lt;code&gt;project-2.conf&lt;/code&gt; as working samples.&lt;/p&gt;
&lt;p&gt;5 - Open the &lt;code&gt;project1.conf&lt;/code&gt; file and edit the &lt;code&gt;server_name&lt;/code&gt; and the &lt;code&gt;root&lt;/code&gt; as follow:&lt;/p&gt;
&lt;p&gt;3 - change the default names &lt;code&gt;project-n&lt;/code&gt;:&lt;/p&gt;
&lt;pre&gt;&lt;code&gt; server_name project1.dev;
root /var/www/project1/public;
&lt;p&gt;You can rename the config files, project folders and domains as you like, just make sure the &lt;code&gt;root&lt;/code&gt; in the config files, is pointing to the correct project folder name.&lt;/p&gt;
&lt;p&gt;4 - Add the domains to the &lt;strong&gt;hosts&lt;/strong&gt; files.&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;127.0.0.1 project-1.dev
127.0.0.1 project-2.dev
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;Do the same for each project &lt;code&gt;project2.conf&lt;/code&gt;, &lt;code&gt;project3.conf&lt;/code&gt;,&amp;hellip;&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;&lt;strong&gt;Now jump to the &lt;a href=&#34;#Usage&#34;&gt;Usage&lt;/a&gt; section.&lt;/strong&gt;&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;6 - Add the domains to the &lt;strong&gt;hosts&lt;/strong&gt; files.&lt;/p&gt;
&lt;pre&gt;&lt;code&gt;127.0.0.1 project1.dev
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;7 - Create your project Databases. Right now you have to do it manually by entering your DB container, until we automate it soon.&lt;/p&gt;
&lt;p&gt;&lt;a name=&#34;Usage&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h2 id=&#34;usage&#34;&gt;Usage&lt;/h2&gt;
@ -311,61 +355,72 @@ QUEUE_HOST=beanstalkd
&lt;p&gt;If you are using &lt;strong&gt;Docker Toolbox&lt;/strong&gt; (VM), do one of the following:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Upgrade to Docker &lt;a href=&#34;https://www.docker.com/products/docker&#34;&gt;Native&lt;/a&gt; for Mac/Windows (Recommended). Check out &lt;a href=&#34;#upgrading-laradock&#34;&gt;Upgrading LaraDock&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;Use LaraDock v3.* (Visit the &lt;code&gt;LaraDock-ToolBox&lt;/code&gt; &lt;a href=&#34;https://github.com/laradock/laradock/tree/LaraDock-ToolBox&#34;&gt;Branch&lt;/a&gt;).&lt;/li&gt;
&lt;li&gt;Upgrade to Docker &lt;a href=&#34;https://www.docker.com/products/docker&#34;&gt;Native&lt;/a&gt; for Mac/Windows (Recommended). Check out &lt;a href=&#34;http://laradock.io/documentation/#upgrading-laradock&#34;&gt;Upgrading Laradock&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;Use Laradock v3.*. Visit the &lt;a href=&#34;https://github.com/laradock/laradock/tree/LaraDock-ToolBox&#34;&gt;LaraDock-ToolBox&lt;/a&gt; branch. &lt;em&gt;(outdated)&lt;/em&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;br&gt;&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt; If you used an older version of LaraDock it&amp;rsquo;s highly recommended to rebuild the containers you need to use &lt;a href=&#34;#Build-Re-build-Containers&#34;&gt;see how you rebuild a container&lt;/a&gt; in order to prevent errors as much as possible.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Warning:&lt;/strong&gt; If you used an older version of Laradock it&amp;rsquo;s highly recommended to rebuild the containers you need to use &lt;a href=&#34;#Build-Re-build-Containers&#34;&gt;see how you rebuild a container&lt;/a&gt; in order to prevent as much errors as possible.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;&lt;br&gt;&lt;/p&gt;
&lt;p&gt;1 - Run Containers: &lt;em&gt;(Make sure you are in the &lt;code&gt;laradock&lt;/code&gt; folder before running the &lt;code&gt;docker-compose&lt;/code&gt; commands).&lt;/em&gt;&lt;/p&gt;
&lt;p&gt;1 - Enter the laradock folder and rename &lt;code&gt;env-example&lt;/code&gt; to &lt;code&gt;.env&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Example:&lt;/strong&gt; Running NGINX and MySQL:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;cp env-example .env
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;You can edit the &lt;code&gt;.env&lt;/code&gt; file to chose which software&amp;rsquo;s you want to be installed in your environment. You can always refer to the &lt;code&gt;docker-compose.yml&lt;/code&gt; file to see how those variables are been used.&lt;/p&gt;
&lt;p&gt;2 - Build the enviroment and run it using &lt;code&gt;docker-compose&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;In this example we&amp;rsquo;ll see how to run NGINX (web server) and MySQL (database engine) to host a PHP Web Scripts:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;docker-compose up -d nginx mysql
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;strong&gt;Note&lt;/strong&gt;: The &lt;code&gt;workspace&lt;/code&gt; and &lt;code&gt;php-fpm&lt;/code&gt; will run automatically in most of the cases, so no need to specify them in the &lt;code&gt;up&lt;/code&gt; command. If you couldn&amp;rsquo;t find them running then you need specify them as follow: &lt;code&gt;docker-compose up -d nginx php-fpm mysql workspace&lt;/code&gt;.&lt;/p&gt;
&lt;p&gt;You can select your own combination of Containers form the list below:&lt;/p&gt;
&lt;p&gt;You can select your own combination of containers form the list below:&lt;/p&gt;
&lt;p&gt;&lt;code&gt;nginx&lt;/code&gt;, &lt;code&gt;hhvm&lt;/code&gt;, &lt;code&gt;php-fpm&lt;/code&gt;, &lt;code&gt;mysql&lt;/code&gt;, &lt;code&gt;redis&lt;/code&gt;, &lt;code&gt;postgres&lt;/code&gt;, &lt;code&gt;mariadb&lt;/code&gt;, &lt;code&gt;neo4j&lt;/code&gt;, &lt;code&gt;mongo&lt;/code&gt;, &lt;code&gt;apache2&lt;/code&gt;, &lt;code&gt;caddy&lt;/code&gt;, &lt;code&gt;memcached&lt;/code&gt;, &lt;code&gt;beanstalkd&lt;/code&gt;, &lt;code&gt;beanstalkd-console&lt;/code&gt;, &lt;code&gt;rabbitmq&lt;/code&gt;, &lt;code&gt;workspace&lt;/code&gt;, &lt;code&gt;phpmyadmin&lt;/code&gt;, &lt;code&gt;aerospike&lt;/code&gt;, &lt;code&gt;pgadmin&lt;/code&gt;, &lt;code&gt;elasticsearch&lt;/code&gt;, &lt;code&gt;rethinkdb&lt;/code&gt;.&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;&lt;code&gt;nginx&lt;/code&gt;, &lt;code&gt;hhvm&lt;/code&gt;, &lt;code&gt;php-fpm&lt;/code&gt;, &lt;code&gt;mysql&lt;/code&gt;, &lt;code&gt;redis&lt;/code&gt;, &lt;code&gt;postgres&lt;/code&gt;, &lt;code&gt;mariadb&lt;/code&gt;, &lt;code&gt;neo4j&lt;/code&gt;, &lt;code&gt;mongo&lt;/code&gt;, &lt;code&gt;apache2&lt;/code&gt;, &lt;code&gt;caddy&lt;/code&gt;, &lt;code&gt;memcached&lt;/code&gt;, &lt;code&gt;beanstalkd&lt;/code&gt;, &lt;code&gt;beanstalkd-console&lt;/code&gt;, &lt;code&gt;rabbitmq&lt;/code&gt;, &lt;code&gt;beanstalkd-console&lt;/code&gt;, &lt;code&gt;workspace&lt;/code&gt;, &lt;code&gt;phpmyadmin&lt;/code&gt;, &lt;code&gt;adminer&lt;/code&gt;, &lt;code&gt;aerospike&lt;/code&gt;, &lt;code&gt;pgadmin&lt;/code&gt;, &lt;code&gt;elasticsearch&lt;/code&gt;, &lt;code&gt;rethinkdb&lt;/code&gt;, &lt;code&gt;postgres-postgis&lt;/code&gt;, &lt;code&gt;certbot&lt;/code&gt;, &lt;code&gt;mailhog&lt;/code&gt;, &lt;code&gt;minio&lt;/code&gt; and more&amp;hellip;!&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;&lt;em&gt;(Please note that sometimes we forget to update the docs, so check the &lt;code&gt;docker-compose.yml&lt;/code&gt; file to see an updated list of all available containers).&lt;/em&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
2 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, &amp;hellip;).&lt;/p&gt;
3 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, &amp;hellip;)&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;docker-compose exec workspace bash
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;Alternatively, for Windows PowerShell users: execute the following command to enter any running container:&lt;/p&gt;
&lt;p&gt;&lt;em&gt;Alternatively, for Windows PowerShell users: execute the following command to enter any running container:&lt;/em&gt;&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;docker exec -it {workspace-container-id} bash
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt; You can add &lt;code&gt;--user=laradock&lt;/code&gt; (example &lt;code&gt;docker-compose exec --user=laradock workspace bash&lt;/code&gt;) to have files created as your host&amp;rsquo;s user. (you can change the PUID (User id) and PGID (group id) variables from the &lt;code&gt;docker-compose.yml&lt;/code&gt;).&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt; You can add &lt;code&gt;--user=laradock&lt;/code&gt; to have files created as your host&amp;rsquo;s user. Example:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;docker-compose exec --user=laradock workspace bash
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;em&gt;You can change the PUID (User id) and PGID (group id) variables from the &lt;code&gt;.env&lt;/code&gt; file)&lt;/em&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
3 - Edit your project configurations.&lt;/p&gt;
4 - Update your project configurations to use the database host&lt;/p&gt;
&lt;p&gt;Open your &lt;code&gt;.env&lt;/code&gt; file and set the &lt;code&gt;DB_HOST&lt;/code&gt; to &lt;code&gt;mysql&lt;/code&gt;:&lt;/p&gt;
&lt;p&gt;Open your PHP project&amp;rsquo;s &lt;code&gt;.env&lt;/code&gt; file or whichever configuration file you are reading from, and set the database host &lt;code&gt;DB_HOST&lt;/code&gt; to &lt;code&gt;mysql&lt;/code&gt;:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-env&#34;&gt;DB_HOST=mysql
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;em&gt;If you want to use Laravel and you don&amp;rsquo;t have it installed yet, see &lt;a href=&#34;#Install-Laravel&#34;&gt;How to Install Laravel in a Docker Container&lt;/a&gt;.&lt;/em&gt;&lt;/p&gt;
&lt;p&gt;&lt;em&gt;If you want to install Laravel as PHP project, see &lt;a href=&#34;#Install-Laravel&#34;&gt;How to Install Laravel in a Docker Container&lt;/a&gt;.&lt;/em&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
4 - Open your browser and visit your localhost address (&lt;code&gt;http://localhost/&lt;/code&gt;).&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;strong&gt;Debugging&lt;/strong&gt;: if you are facing any problem here check the &lt;a href=&#34;#debugging&#34;&gt;Debugging&lt;/a&gt; section.&lt;/p&gt;
&lt;p&gt;If you need a special support. Contact me, more details in the &lt;a href=&#34;#Help&#34;&gt;Help &amp;amp; Questions&lt;/a&gt; section.&lt;/p&gt;
5 - Open your browser and visit your localhost address &lt;code&gt;http://localhost/&lt;/code&gt;. If you followed the multiple projects setup, you can visit &lt;code&gt;http://project-1.dev/&lt;/code&gt; and &lt;code&gt;http://project-2.dev/&lt;/code&gt;. But first don&amp;rsquo;t&lt;/p&gt;
</description>
</item>
@ -511,6 +566,11 @@ example for &lt;code&gt;mysql&lt;/code&gt; it will be &lt;code&gt;mysql/Dockerfi
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;docker logs {container-name}
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;More &lt;a href=&#34;https://docs.docker.com/compose/reference/logs/&#34;&gt;options&lt;/a&gt;&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;docker logs -f {container-name}
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;PHP&#34;&gt;&lt;/a&gt;&lt;/p&gt;
@ -641,7 +701,7 @@ xdebug.remote_connect_back=1
&lt;p&gt;By installing xDebug, you are enabling it to run on startup by default.&lt;/p&gt;
&lt;p&gt;To control the behavior of xDebug (in the &lt;code&gt;php-fpm&lt;/code&gt; Container), you can run the following commands from the LaraDock root folder, (at the same prompt where you run docker-compose):&lt;/p&gt;
&lt;p&gt;To control the behavior of xDebug (in the &lt;code&gt;php-fpm&lt;/code&gt; Container), you can run the following commands from the Laradock root folder, (at the same prompt where you run docker-compose):&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Stop xDebug from running by default: &lt;code&gt;./xdebugPhpFpm stop&lt;/code&gt;.&lt;/li&gt;
@ -681,11 +741,11 @@ xdebug.remote_connect_back=1
&lt;a name=&#34;Production&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;LaraDock-for-Production&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;a name=&#34;Laradock-for-Production&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h2 id=&#34;prepare-laradock-for-production&#34;&gt;Prepare LaraDock for Production&lt;/h2&gt;
&lt;h2 id=&#34;prepare-laradock-for-production&#34;&gt;Prepare Laradock for Production&lt;/h2&gt;
&lt;p&gt;It&amp;rsquo;s recommended for production to create a custom &lt;code&gt;docker-compose.yml&lt;/code&gt; file. For that reason, LaraDock is shipped with &lt;code&gt;production-docker-compose.yml&lt;/code&gt; which should contain only the containers you are planning to run on production (usage example: &lt;code&gt;docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...&lt;/code&gt;).&lt;/p&gt;
&lt;p&gt;It&amp;rsquo;s recommended for production to create a custom &lt;code&gt;docker-compose.yml&lt;/code&gt; file. For that reason, Laradock is shipped with &lt;code&gt;production-docker-compose.yml&lt;/code&gt; which should contain only the containers you are planning to run on production (usage example: &lt;code&gt;docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...&lt;/code&gt;).&lt;/p&gt;
&lt;p&gt;Note: The Database (MySQL/MariaDB/&amp;hellip;) 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:&lt;/p&gt;
@ -726,7 +786,7 @@ xdebug.remote_connect_back=1
&lt;p&gt;3 - Edit &lt;code&gt;docker-compose.yml&lt;/code&gt; to Map the new application path:&lt;/p&gt;
&lt;p&gt;By default, LaraDock assumes the Laravel application is living in the parent directory of the laradock folder.&lt;/p&gt;
&lt;p&gt;By default, Laradock assumes the Laravel application is living in the parent directory of the laradock folder.&lt;/p&gt;
&lt;p&gt;Since the new Laravel application is in the &lt;code&gt;my-cool-app&lt;/code&gt; folder, we need to replace &lt;code&gt;../:/var/www&lt;/code&gt; with &lt;code&gt;../my-cool-app/:/var/www&lt;/code&gt;, as follow:&lt;/p&gt;
@ -742,7 +802,7 @@ xdebug.remote_connect_back=1
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;cd my-cool-app
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;5 - Go back to the LaraDock installation steps to see how to edit the &lt;code&gt;.env&lt;/code&gt; file.&lt;/p&gt;
&lt;p&gt;5 - Go back to the Laradock installation steps to see how to edit the &lt;code&gt;.env&lt;/code&gt; file.&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;Run-Artisan-Commands&#34;&gt;&lt;/a&gt;&lt;/p&gt;
@ -844,7 +904,7 @@ SESSION_DRIVER=redis
&lt;p&gt;5 - You can manually test it from Laravel with this code:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-php&#34;&gt;\Cache::store(&#39;redis&#39;)-&amp;gt;put(&#39;LaraDock&#39;, &#39;Awesome&#39;, 10);
&lt;pre&gt;&lt;code class=&#34;language-php&#34;&gt;\Cache::store(&#39;redis&#39;)-&amp;gt;put(&#39;Laradock&#39;, &#39;Awesome&#39;, 10);
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;br&gt;
@ -947,6 +1007,18 @@ docker-compose up -d mariadb phpmyadmin
&lt;p&gt;2 - Open your browser and visit the localhost on port &lt;strong&gt;8080&lt;/strong&gt;: &lt;code&gt;http://localhost:8080&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;Use-Adminer&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h2 id=&#34;use-adminer&#34;&gt;Use Adminer&lt;/h2&gt;
&lt;p&gt;1 - Run the Adminer Container (&lt;code&gt;adminer&lt;/code&gt;) with the &lt;code&gt;docker-compose up&lt;/code&gt; command. Example:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;docker-compose up -d adminer
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;2 - Open your browser and visit the localhost on port &lt;strong&gt;8080&lt;/strong&gt;: &lt;code&gt;http://localhost:8080&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;Use-pgAdmin&#34;&gt;&lt;/a&gt;&lt;/p&gt;
@ -1111,7 +1183,7 @@ A package (&lt;a href=&#34;https://github.com/duxet/laravel-rethinkdb&#34;&gt;La
&lt;h2 id=&#34;install-codeigniter&#34;&gt;Install CodeIgniter&lt;/h2&gt;
&lt;p&gt;To install CodeIgniter 3 on LaraDock all you have to do is the following simple steps:&lt;/p&gt;
&lt;p&gt;To install CodeIgniter 3 on Laradock all you have to do is the following simple steps:&lt;/p&gt;
&lt;p&gt;1 - Open the &lt;code&gt;docker-compose.yml&lt;/code&gt; file.&lt;/p&gt;
@ -1351,7 +1423,7 @@ port=1234
&lt;h2 id=&#34;common-terminal-aliases&#34;&gt;Common Terminal Aliases&lt;/h2&gt;
&lt;p&gt;When you start your docker container, LaraDock will copy the &lt;code&gt;aliases.sh&lt;/code&gt; file located in the &lt;code&gt;laradock/workspace&lt;/code&gt; directory and add sourcing to the container &lt;code&gt;~/.bashrc&lt;/code&gt; file.&lt;/p&gt;
&lt;p&gt;When you start your docker container, Laradock will copy the &lt;code&gt;aliases.sh&lt;/code&gt; file located in the &lt;code&gt;laradock/workspace&lt;/code&gt; directory and add sourcing to the container &lt;code&gt;~/.bashrc&lt;/code&gt; file.&lt;/p&gt;
&lt;p&gt;You are free to modify the &lt;code&gt;aliases.sh&lt;/code&gt; as you see fit, adding your own aliases (or function macros) to suit your requirements.&lt;/p&gt;
@ -1426,12 +1498,12 @@ e) set it to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;&lt;a href=&#34;https://github.com/laradock/laradock/blob/master/_guides/phpstorm.md&#34;&gt;&lt;strong&gt;Debugging Guide Here&lt;/strong&gt;&lt;/a&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;keep-tracking-LaraDock&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;a name=&#34;keep-tracking-Laradock&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h2 id=&#34;keep-track-of-your-laradock-changes&#34;&gt;Keep track of your LaraDock changes&lt;/h2&gt;
&lt;h2 id=&#34;keep-track-of-your-laradock-changes&#34;&gt;Keep track of your Laradock changes&lt;/h2&gt;
&lt;ol&gt;
&lt;li&gt;Fork the LaraDock repository.&lt;/li&gt;
&lt;li&gt;Fork the Laradock repository.&lt;/li&gt;
&lt;li&gt;Use that fork as a submodule.&lt;/li&gt;
&lt;li&gt;Commit all your changes to your fork.&lt;/li&gt;
&lt;li&gt;Pull new stuff from the main repository from time to time.&lt;/li&gt;
@ -1440,15 +1512,15 @@ e) set it to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;upgrading-laradock&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h2 id=&#34;upgrading-laradock&#34;&gt;Upgrading LaraDock&lt;/h2&gt;
&lt;h2 id=&#34;upgrading-laradock&#34;&gt;Upgrading Laradock&lt;/h2&gt;
&lt;p&gt;Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading LaraDock from v3.* to v4.*:&lt;/p&gt;
&lt;p&gt;Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requires upgrading Laradock from v3.* to v4.*:&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;Stop the docker VM &lt;code&gt;docker-machine stop {default}&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;Install Docker for &lt;a href=&#34;https://docs.docker.com/docker-for-mac/&#34;&gt;Mac&lt;/a&gt; or &lt;a href=&#34;https://docs.docker.com/docker-for-windows/&#34;&gt;Windows&lt;/a&gt;.&lt;/li&gt;
&lt;li&gt;Upgrade LaraDock to &lt;code&gt;v4.*.*&lt;/code&gt; (&lt;code&gt;git pull origin master&lt;/code&gt;)&lt;/li&gt;
&lt;li&gt;Use LaraDock as you used to do: &lt;code&gt;docker-compose up -d nginx mysql&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;Upgrade Laradock to &lt;code&gt;v4.*.*&lt;/code&gt; (&lt;code&gt;git pull origin master&lt;/code&gt;)&lt;/li&gt;
&lt;li&gt;Use Laradock as you used to do: &lt;code&gt;docker-compose up -d nginx mysql&lt;/code&gt;.&lt;/li&gt;
&lt;/ol&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt; If you face any problem with the last step above: rebuild all your containers
@ -1460,13 +1532,27 @@ e) set it to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
&lt;h2 id=&#34;improve-speed-on-macos&#34;&gt;Improve speed on MacOS&lt;/h2&gt;
&lt;p&gt;Sharing code into Docker containers with osxfs have very poor performance compared to Linux. You can get around this issue by using NFS to share your files betwen your host and your container.&lt;/p&gt;
&lt;p&gt;Sharing code into Docker containers with osxfs have very poor performance compared to Linux. Likely there are some workarounds:&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;How to share files using NFS (d4m-nfs)&lt;/p&gt;
&lt;/blockquote&gt;
&lt;h3 id=&#34;workaround-a-using-dinghy&#34;&gt;Workaround A: using dinghy&lt;/h3&gt;
&lt;p&gt;&lt;a href=&#34;https://github.com/IFSight/d4m-nfs&#34;&gt;d4m-nfs&lt;/a&gt; automatically mount NFS volume instead of osxfs one.&lt;/p&gt;
&lt;p&gt;&lt;a href=&#34;https://github.com/codekitchen/dinghy&#34;&gt;Dinghy&lt;/a&gt; creates its own VM using docker-machine, it will not modify your existing docker-machine VMs.&lt;/p&gt;
&lt;p&gt;Quick Setup giude, (we recommend you check their docs)&lt;/p&gt;
&lt;p&gt;1) &lt;code&gt;brew tap codekitchen/dinghy&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;2) &lt;code&gt;brew install dinghy&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;3) &lt;code&gt;dinghy create --provider virtualbox&lt;/code&gt; (must have virtualbox installed, but they support other providers if you prefer)&lt;/p&gt;
&lt;p&gt;4) after the above command is done it will display some env variables, copy them to the bash profile or zsh or.. (this will instruct docker to use the server running inside the VM)&lt;/p&gt;
&lt;p&gt;5) &lt;code&gt;docker-compose up ...&lt;/code&gt;&lt;/p&gt;
&lt;h3 id=&#34;workaround-b-using-d4m-nfs&#34;&gt;Workaround B: using d4m-nfs&lt;/h3&gt;
&lt;p&gt;&lt;a href=&#34;https://github.com/IFSight/d4m-nfs&#34;&gt;D4m-nfs&lt;/a&gt; automatically mount NFS volume instead of osxfs one.&lt;/p&gt;
&lt;p&gt;1) Update the Docker [File Sharing] preferences:&lt;/p&gt;
@ -1482,23 +1568,30 @@ e) set it to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
&lt;p&gt;4) Create (or edit) the file &lt;code&gt;~/d4m-nfs/etc/d4m-nfs-mounts.txt&lt;/code&gt;, and write the follwing configuration in it:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-txt&#34;&gt;/Users:/Users
/Volumes:/Volumes
/private:/private
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;5) Create (or edit) the file &lt;code&gt;/etc/exports&lt;/code&gt;, make sure it exists and is empty. (There may be collisions if you come from Vagrant or if you already executed the &lt;code&gt;d4m-nfs.sh&lt;/code&gt; script before).&lt;/p&gt;
&lt;p&gt;6) Run the &lt;code&gt;d4m-nfs.sh&lt;/code&gt; script:&lt;/p&gt;
&lt;p&gt;6) Run the &lt;code&gt;d4m-nfs.sh&lt;/code&gt; script (might need Sudo):&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;~/d4m-nfs/d4m-nfs.sh
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;That&amp;rsquo;s it! Run your containers.. Example:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;docker-compose up -d nginx mysql
&lt;pre&gt;&lt;code class=&#34;language-bash&#34;&gt;docker-compose up ...
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt; If you faced any errors, try restarting Docker, and make sure you have no spaces in the &lt;code&gt;d4m-nfs-mounts.txt&lt;/code&gt; file, and your &lt;code&gt;/etc/exports&lt;/code&gt; file is clear.&lt;/p&gt;
&lt;p&gt;&lt;em&gt;Note: If you faced any errors, try restarting Docker, and make sure you have no spaces in the &lt;code&gt;d4m-nfs-mounts.txt&lt;/code&gt; file, and your &lt;code&gt;/etc/exports&lt;/code&gt; file is clear.&lt;/em&gt;&lt;/p&gt;
&lt;h3 id=&#34;other-good-workarounds&#34;&gt;Other good workarounds:&lt;/h3&gt;
&lt;ul&gt;
&lt;li&gt;&lt;a href=&#34;https://github.com/EugenMayer/docker-sync&#34;&gt;docker-sync&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;Add more here..&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;More details about this issue &lt;a href=&#34;https://github.com/docker/for-mac/issues/77&#34;&gt;here&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;&lt;br&gt;
&lt;a name=&#34;Common-Problems&#34;&gt;&lt;/a&gt;&lt;/p&gt;
@ -1564,7 +1657,7 @@ e) set it to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
&lt;li&gt;Option B
&lt;ol&gt;
&lt;li&gt;Change the &lt;code&gt;DB_HOST&lt;/code&gt; value to the same name as the MySQL docker container. The LaraDock docker-compose file currently has this as &lt;code&gt;mysql&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;Change the &lt;code&gt;DB_HOST&lt;/code&gt; value to the same name as the MySQL docker container. The Laradock docker-compose file currently has this as &lt;code&gt;mysql&lt;/code&gt;&lt;/li&gt;
&lt;/ol&gt;&lt;/li&gt;
&lt;/ul&gt;
</description>
@ -1576,11 +1669,11 @@ e) set it to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://laradock.io/related-projects/</guid>
<description>&lt;p&gt;LaraDock related projects:&lt;/p&gt;
<description>&lt;p&gt;Laradock related projects:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;a href=&#34;https://github.com/lorinlee/laradock-cli&#34;&gt;LaraDock CLI&lt;/a&gt; by &lt;a href=&#34;https://github.com/lorinlee&#34;&gt;LorinLee&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href=&#34;https://github.com/bagart/laradock_env&#34;&gt;LaraDock Env&lt;/a&gt; by &lt;a href=&#34;https://github.com/bagart&#34;&gt;BAGArt&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href=&#34;https://github.com/lorinlee/laradock-cli&#34;&gt;Laradock CLI&lt;/a&gt; by &lt;a href=&#34;https://github.com/lorinlee&#34;&gt;LorinLee&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href=&#34;https://github.com/bagart/laradock_env&#34;&gt;Laradock Env&lt;/a&gt; by &lt;a href=&#34;https://github.com/bagart&#34;&gt;BAGArt&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href=&#34;https://github.com/poyhsiao/Klaradock&#34;&gt;Klaradock&lt;/a&gt; by &lt;a href=&#34;https://github.com/poyhsiao&#34;&gt;Kim Hsiao&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href=&#34;https://github.com/sifat-rahim/ansible-laradock-kubernetes&#34;&gt;Ansible Laradock Kubernetes&lt;/a&gt; by &lt;a href=&#34;https://github.com/sifat-rahim&#34;&gt;Sifat Rahim&lt;/a&gt;
These Docker Compose projects have piqued our interest:&lt;/li&gt;
@ -1599,9 +1692,9 @@ These Docker Compose projects have piqued our interest:&lt;/li&gt;
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://laradock.io/help/</guid>
<description>&lt;p&gt;Join the chat room on &lt;a href=&#34;https://gitter.im/LaraDock/laradock&#34;&gt;Gitter&lt;/a&gt; and get help and support from the community.&lt;/p&gt;
<description>&lt;p&gt;Join the chat room on &lt;a href=&#34;https://gitter.im/Laradock/laradock&#34;&gt;Gitter&lt;/a&gt; and get help and support from the community.&lt;/p&gt;
&lt;p&gt;You can as well can open an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;issue&lt;/a&gt; on Github (will be labeled as Question) and discuss it with people on &lt;a href=&#34;https://gitter.im/LaraDock/laradock&#34;&gt;Gitter&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;You can as well can open an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;issue&lt;/a&gt; on Github (will be labeled as Question) and discuss it with people on &lt;a href=&#34;https://gitter.im/Laradock/laradock&#34;&gt;Gitter&lt;/a&gt;.&lt;/p&gt;
</description>
</item>
@ -1615,39 +1708,52 @@ These Docker Compose projects have piqued our interest:&lt;/li&gt;
&lt;p&gt;Your contribution is more than welcome.&lt;/p&gt;
&lt;h2 id=&#34;got-a-question-or-problem&#34;&gt;Got a Question or Problem?&lt;/h2&gt;
&lt;h2 id=&#34;i-have-a-question-problem&#34;&gt;I have a Question/Problem&lt;/h2&gt;
&lt;p&gt;If you have questions about how to use LaraDock, please direct your questions to the discussion on &lt;a href=&#34;https://gitter.im/LaraDock/laradock&#34;&gt;Gitter&lt;/a&gt;. If you believe your question could help others, then consider opening an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt; (it will be labeled as Question).&lt;/p&gt;
&lt;p&gt;If you have questions about how to use Laradock, please direct your questions to the discussion on &lt;a href=&#34;https://gitter.im/Laradock/laradock&#34;&gt;Gitter&lt;/a&gt;. If you believe your question could help others, then consider opening an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt; (it will be labeled as &lt;code&gt;Question&lt;/code&gt;) And you can still seek help on Gitter for it.&lt;/p&gt;
&lt;h2 id=&#34;found-an-issue&#34;&gt;Found an Issue?&lt;/h2&gt;
&lt;h2 id=&#34;i-found-an-issue&#34;&gt;I found an Issue&lt;/h2&gt;
&lt;p&gt;If you find a bug in the source code or a mistake in the documentation, you can help us by
submitting an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt;. Even better you can submit a Pull Request with a fix.&lt;/p&gt;
&lt;p&gt;If have an issue or you found a typo in the documentation, you can help us by
opnening an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt;.&lt;/p&gt;
&lt;h2 id=&#34;want-a-feature&#34;&gt;Want a Feature?&lt;/h2&gt;
&lt;p&gt;&lt;strong&gt;Steps to do before opening an Issue:&lt;/strong&gt;&lt;/p&gt;
&lt;p&gt;You can request a new feature by submitting an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt; (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;&lt;p&gt;Before you submit your issue search the archive, maybe your question was already answered couple hours ago (search in the closed Issues as well).&lt;/p&gt;&lt;/li&gt;
&lt;h2 id=&#34;update-documentation-site&#34;&gt;Update Documentation (Site)&lt;/h2&gt;
&lt;li&gt;&lt;p&gt;Decide if the Issue belongs to this project or to &lt;a href=&#34;https://github.com/docker&#34;&gt;Docker&lt;/a&gt; itself! or even the tool you are using such as Nginx or MongoDB&amp;hellip;&lt;/p&gt;&lt;/li&gt;
&lt;/ol&gt;
&lt;p&gt;If your issue appears to be a bug, and hasn&amp;rsquo;t been reported, then open a new issue.&lt;/p&gt;
&lt;p&gt;&lt;em&gt;This Help us to maximize the effort we can spend fixing issues and adding new
features, by not reporting duplicate issues.&lt;/em&gt;&lt;/p&gt;
&lt;h2 id=&#34;i-want-a-feature&#34;&gt;I want a Feature&lt;/h2&gt;
&lt;p&gt;You can request a new feature by submitting an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&gt;Issue&lt;/a&gt; (it will be labeled as &lt;code&gt;Feature Suggestion&lt;/code&gt;). If you would like to implement a new feature then consider submitting a Pull Request yourself.&lt;/p&gt;
&lt;h2 id=&#34;i-want-to-update-the-documentation-site&#34;&gt;I want to update the Documentation (Site)&lt;/h2&gt;
&lt;p&gt;Laradock uses &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; as website generator tool, with the &lt;a href=&#34;http://themes.gohugo.io/theme/material-docs/&#34;&gt;Material Docs theme&lt;/a&gt;. You might need to check their docs quickly.&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;Install &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; on your machine.&lt;/li&gt;
&lt;li&gt;Clone laradock.&lt;/li&gt;
&lt;li&gt;Go to &lt;code&gt;/docs&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;Delete everything except the &lt;code&gt;_settings&lt;/code&gt; folder &amp;amp; the &lt;code&gt;CNAME&lt;/code&gt; file.&lt;/li&gt;
&lt;li&gt;Open &lt;code&gt;docs/_settings&lt;/code&gt; from your terminal and run &lt;code&gt;hugo serve&lt;/code&gt; to host the website locally.&lt;/li&gt;
&lt;li&gt;Open the &lt;code&gt;docs/_settings/content&lt;/code&gt; and search for the folder of the section you want to edit.&lt;/li&gt;
&lt;li&gt;In each section there&amp;rsquo;s an &lt;code&gt;index.md&lt;/code&gt; file, that&amp;rsquo;s the file you need to edit.&lt;/li&gt;
&lt;li&gt;To edit the sidebar (in case you are adding new section) go to &lt;code&gt;docs/_settings/config.toml&lt;/code&gt; and add the section there.&lt;/li&gt;
&lt;li&gt;After done editing, run the this command &lt;code&gt;hugo&lt;/code&gt; to generate the updated site inside the &lt;code&gt;docs&lt;/code&gt; folder.&lt;/li&gt;
&lt;li&gt;Go back to the project root directory, commit and push..&lt;/li&gt;
&lt;li&gt;Install &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; on your machine (easy thing).&lt;/li&gt;
&lt;li&gt;Open the &lt;code&gt;DOCUMENTATION/_settings/content&lt;/code&gt; and search for the markdown file you want to edit (every folder represents a section in the menu).&lt;/li&gt;
&lt;li&gt;Delete the &lt;code&gt;/docs&lt;/code&gt; folder from the root.&lt;/li&gt;
&lt;li&gt;When you finish editing, go to &lt;code&gt;DOCUMENTATION/_settings/&lt;/code&gt; and run the &lt;code&gt;hugo&lt;/code&gt; command to generate the HTML docs (inside new &lt;code&gt;/docs&lt;/code&gt; folder).&lt;/li&gt;
&lt;/ol&gt;
&lt;h2 id=&#34;coding-guidelines&#34;&gt;Coding Guidelines&lt;/h2&gt;
&lt;h3 id=&#34;to-host-the-website-locally&#34;&gt;To Host the website locally&lt;/h3&gt;
&lt;h2 id=&#34;support-new-software&#34;&gt;Support new Software&lt;/h2&gt;
&lt;p&gt;Go to &lt;code&gt;DOCUMENTATION/_settings&lt;/code&gt; in your terminal and run &lt;code&gt;hugo serve&lt;/code&gt; to host the website locally.&lt;/p&gt;
&lt;h3 id=&#34;edit-the-sidebar&#34;&gt;Edit the sidebar&lt;/h3&gt;
&lt;p&gt;To add a new section to the sidebar or edit existing one, you need to edit this file &lt;code&gt;DOCUMENTATION/_settings/config.toml&lt;/code&gt;.&lt;/p&gt;
&lt;h2 id=&#34;how-to-support-new-software-add-new-container&#34;&gt;How to support new Software (Add new Container)&lt;/h2&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Create folder with the software name.&lt;/p&gt;&lt;/li&gt;
@ -1660,10 +1766,10 @@ submitting an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&g
&lt;li&gt;&lt;p&gt;Make sure you follow our commenting style.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Add the software in the &lt;code&gt;Readme&lt;/code&gt;.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Add the software in the &lt;code&gt;Documentation&lt;/code&gt;.&lt;/p&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&#34;edit-existing-software&#34;&gt;Edit existing Software&lt;/h2&gt;
&lt;h2 id=&#34;edit-existing-software-edit-a-container&#34;&gt;Edit existing Software (Edit a Container)&lt;/h2&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Open the software (container) folder.&lt;/p&gt;&lt;/li&gt;
@ -1671,22 +1777,14 @@ submitting an &lt;a href=&#34;https://github.com/laradock/laradock/issues&#34;&g
&lt;li&gt;&lt;p&gt;Edit the files you want to update.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt; If you want to edit the base image of the &lt;code&gt;Workspace&lt;/code&gt; or the &lt;code&gt;php-fpm&lt;/code&gt; Containers,
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the LaraDock repository.&lt;/p&gt;&lt;/li&gt;
you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Make sure to update the &lt;code&gt;Readme&lt;/code&gt; in case you made any changes.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Make sure to update the &lt;code&gt;Documentation&lt;/code&gt; in case you made any changes.&lt;/p&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&#34;issue-pr-submission-guidelines&#34;&gt;Issue/PR Submission Guidelines&lt;/h2&gt;
&lt;h2 id=&#34;pull-request&#34;&gt;Pull Request&lt;/h2&gt;
&lt;h2 id=&#34;submitting-an-issue&#34;&gt;Submitting an Issue&lt;/h2&gt;
&lt;p&gt;Before you submit your issue search the archive, maybe your question was already answered.&lt;/p&gt;
&lt;p&gt;If your issue appears to be a bug, and hasn&amp;rsquo;t been reported, open a new issue.
Help us to maximize the effort we can spend fixing issues and adding new
features, by not reporting duplicate issues.&lt;/p&gt;
&lt;h2 id=&#34;before-submitting-a-pull-request-pr&#34;&gt;Before Submitting a Pull Request (PR)&lt;/h2&gt;
&lt;h3 id=&#34;1-before-submitting-a-pull-request-pr&#34;&gt;1. Before Submitting a Pull Request (PR)&lt;/h3&gt;
&lt;p&gt;Always Test everything and make sure its working:&lt;/p&gt;
@ -1702,16 +1800,16 @@ features, by not reporting duplicate issues.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Testing building the container (docker-compose build container-name) with no errors.&lt;/li&gt;
&lt;li&gt;Test it in real App.&lt;/li&gt;
&lt;li&gt;Test it in a real App if possible.&lt;/li&gt;
&lt;/ul&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&#34;submitting-a-pr&#34;&gt;Submitting a PR&lt;/h2&gt;
&lt;h3 id=&#34;2-submitting-a-pr&#34;&gt;2. Submitting a PR&lt;/h3&gt;
&lt;p&gt;Consider the following guidelines:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Search &lt;a href=&#34;https://github.com/laradock/laradock/pulls&#34;&gt;GitHub&lt;/a&gt; for an open or closed Pull Request that relates to your submission. You don&amp;rsquo;t want to duplicate effort.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Search &lt;a href=&#34;https://github.com/laradock/laradock/pulls&#34;&gt;GitHub&lt;/a&gt; for an open or closed Pull Request that relates to your submission. You don&amp;rsquo;t want to duplicate efforts.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Make your changes in a new git branch:&lt;/p&gt;
@ -1746,10 +1844,9 @@ git push origin my-fix-branch -f
&lt;p&gt;&lt;em&gt;WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments on code that were previously made by you and others in your commits.&lt;/em&gt;&lt;/p&gt;
&lt;h2 id=&#34;after-your-pr-is-merged&#34;&gt;After your PR is merged&lt;/h2&gt;
&lt;h3 id=&#34;3-after-your-pr-is-merged&#34;&gt;3. After your PR is merged&lt;/h3&gt;
&lt;p&gt;After your pull request is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository:&lt;/p&gt;
&lt;p&gt;After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:&lt;/p&gt;
@ -1775,7 +1872,7 @@ from the main (upstream) repository:&lt;/p&gt;
&lt;p&gt;&lt;br&gt;&lt;/p&gt;
&lt;h2 id=&#34;happy-coding&#34;&gt;Happy Coding :)&lt;/h2&gt;
&lt;h4 id=&#34;happy-coding&#34;&gt;Happy Coding :)&lt;/h4&gt;
</description>
</item>

View File

@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
<meta http-equiv="X-UA-Compatible" content="IE=10" />
<title>Introduction - Laradock</title>
<meta name="generator" content="Hugo 0.18.1" />
<meta name="generator" content="Hugo 0.19" />
<meta name="description" content="Laradock documentations.">
@ -313,27 +313,32 @@
<p>LaraDock strives to make the PHP development experience easier and faster.</p>
<p>Laradock strives to make the PHP development experience easier and faster.</p>
<p>It contains pre-packaged Docker Images that provides you a wonderful <em>development</em> environment without requiring you to install PHP, NGINX, MySQL, Redis, and any other software on your machines.</p>
<p>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&hellip;).</p>
<p>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&hellip;).</p>
<h2 id="quick-overview">Quick Overview</h2>
<p>Let&rsquo;s see how easy it is to install <code>NGINX</code>, <code>PHP</code>, <code>Composer</code>, <code>MySQL</code>, <code>Redis</code> and <code>beanstalkd</code>:</p>
<p>1 - Clone LaraDock inside your PHP project:</p>
<p>1 - Clone Laradock inside your PHP project:</p>
<pre><code class="language-shell">git clone https://github.com/Laradock/laradock.git
</code></pre>
<p>2 - Enter the laradock folder and run this command:</p>
<p>2 - Enter the laradock folder and rename <code>env-example</code> to <code>.env</code>.</p>
<pre><code class="language-shell">cp env-example .env
</code></pre>
<p>3 - Run your containers:</p>
<pre><code class="language-shell">docker-compose up -d nginx mysql redis beanstalkd
</code></pre>
<p>3 - Open your <code>.env</code> file and set the following:</p>
<p>3 - Open your project&rsquo;s <code>.env</code> file and set the following:</p>
<pre><code class="language-shell">DB_HOST=mysql
REDIS_HOST=redis
@ -365,21 +370,21 @@ QUEUE_HOST=beanstalkd
<p><a name="laradock-vs-homestead"></a></p>
<h2 id="laradock-vs-homestead-for-laravel-developers">LaraDock VS Homestead (For Laravel Developers)</h2>
<h2 id="laradock-vs-homestead-for-laravel-developers">Laradock VS Homestead (For Laravel Developers)</h2>
<blockquote>
<p>LaraDock It&rsquo;s like Laravel Homestead but for Docker instead of Vagrant.</p>
<p>Laradock It&rsquo;s like Laravel Homestead but for Docker instead of Vagrant.</p>
</blockquote>
<p>LaraDock and <a href="https://laravel.com/docs/master/homestead">Homestead</a> both give you complete virtual development environments. (Without the need to install and configure every single software on your own Operating System).</p>
<p>Laradock and <a href="https://laravel.com/docs/master/homestead">Homestead</a> both give you complete virtual development environments. (Without the need to install and configure every single software on your own Operating System).</p>
<ul>
<li><p>Homestead is a tool that controls Vagrant for you (using Homestead special commands). And Vagrant manages your Virtual Machine.</p></li>
<li><p>LaraDock is a tool that controls Docker for you (using Docker &amp; Docker Compose official commands). And Docker manages your Virtual Containers.</p></li>
<li><p>Laradock is a tool that controls Docker for you (using Docker &amp; Docker Compose official commands). And Docker manages your Virtual Containers.</p></li>
</ul>
<p>Running a virtual container is much faster than running a full virtual Machine. Thus <strong>LaraDock is much faster than Homestead</strong>.</p>
<p>Running a virtual container is much faster than running a full virtual Machine. Thus <strong>Laradock is much faster than Homestead</strong>.</p>
<p><a name="Demo"></a></p>
@ -388,10 +393,10 @@ QUEUE_HOST=beanstalkd
<p>What&rsquo;s better than a <strong>Demo Video</strong>:</p>
<ul>
<li>LaraDock <a href="https://www.youtube.com/watch?v=TQii1jDa96Y">v4.*</a></li>
<li>LaraDock <a href="https://www.youtube.com/watch?v=-DamFMczwDA">v2.*</a></li>
<li>LaraDock <a href="https://www.youtube.com/watch?v=jGkyO6Is_aI">v0.3</a></li>
<li>LaraDock <a href="https://www.youtube.com/watch?v=3YQsHe6oF80">v0.1</a></li>
<li>Laradock <a href="https://www.youtube.com/watch?v=TQii1jDa96Y">v4.*</a></li>
<li>Laradock <a href="https://www.youtube.com/watch?v=-DamFMczwDA">v2.*</a></li>
<li>Laradock <a href="https://www.youtube.com/watch?v=jGkyO6Is_aI">v0.3</a></li>
<li>Laradock <a href="https://www.youtube.com/watch?v=3YQsHe6oF80">v0.1</a></li>
</ul>
<p><a name="features"></a></p>
@ -423,11 +428,12 @@ QUEUE_HOST=beanstalkd
<ul>
<li>MySQL</li>
<li>PostgreSQL</li>
<li>MariaDB</li>
<li>MongoDB</li>
<li>Neo4j</li>
<li>RethinkDB</li>
<li>PostgreSQL</li>
<li>Postgres Postgis</li>
</ul></li>
<li><strong>Cache Engines:</strong>
@ -461,9 +467,12 @@ QUEUE_HOST=beanstalkd
<ul>
<li>PhpMyAdmin</li>
<li>Adminer</li>
<li>PgAdmin</li>
<li>ElasticSearch</li>
<li>Selenium</li>
<li>Certbot</li>
<li>Mailhog</li>
<li>Minio</li>
<li>Workspace
@ -495,7 +504,7 @@ QUEUE_HOST=beanstalkd
<p>You are welcome to join our chat room on Gitter.</p>
<p><a href="https://gitter.im/LaraDock/laradock?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge"><img src="https://badges.gitter.im/LaraDock/laradock.svg" alt="Gitter" /></a></p>
<p><a href="https://gitter.im/Laradock/laradock?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge"><img src="https://badges.gitter.im/Laradock/laradock.svg" alt="Gitter" /></a></p>
<aside class="copyright" role="note">

View File

@ -16,27 +16,32 @@
<guid>http://laradock.io/introduction/</guid>
<description>
&lt;p&gt;LaraDock strives to make the PHP development experience easier and faster.&lt;/p&gt;
&lt;p&gt;Laradock strives to make the PHP development experience easier and faster.&lt;/p&gt;
&lt;p&gt;It contains pre-packaged Docker Images that provides you a wonderful &lt;em&gt;development&lt;/em&gt; environment without requiring you to install PHP, NGINX, MySQL, Redis, and any other software on your machines.&lt;/p&gt;
&lt;p&gt;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&amp;hellip;).&lt;/p&gt;
&lt;p&gt;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&amp;hellip;).&lt;/p&gt;
&lt;h2 id=&#34;quick-overview&#34;&gt;Quick Overview&lt;/h2&gt;
&lt;p&gt;Let&amp;rsquo;s see how easy it is to install &lt;code&gt;NGINX&lt;/code&gt;, &lt;code&gt;PHP&lt;/code&gt;, &lt;code&gt;Composer&lt;/code&gt;, &lt;code&gt;MySQL&lt;/code&gt;, &lt;code&gt;Redis&lt;/code&gt; and &lt;code&gt;beanstalkd&lt;/code&gt;:&lt;/p&gt;
&lt;p&gt;1 - Clone LaraDock inside your PHP project:&lt;/p&gt;
&lt;p&gt;1 - Clone Laradock inside your PHP project:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;git clone https://github.com/Laradock/laradock.git
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;2 - Enter the laradock folder and run this command:&lt;/p&gt;
&lt;p&gt;2 - Enter the laradock folder and rename &lt;code&gt;env-example&lt;/code&gt; to &lt;code&gt;.env&lt;/code&gt;.&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;cp env-example .env
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;3 - Run your containers:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;docker-compose up -d nginx mysql redis beanstalkd
&lt;/code&gt;&lt;/pre&gt;
&lt;p&gt;3 - Open your &lt;code&gt;.env&lt;/code&gt; file and set the following:&lt;/p&gt;
&lt;p&gt;3 - Open your project&amp;rsquo;s &lt;code&gt;.env&lt;/code&gt; file and set the following:&lt;/p&gt;
&lt;pre&gt;&lt;code class=&#34;language-shell&#34;&gt;DB_HOST=mysql
REDIS_HOST=redis
@ -68,21 +73,21 @@ QUEUE_HOST=beanstalkd
&lt;p&gt;&lt;a name=&#34;laradock-vs-homestead&#34;&gt;&lt;/a&gt;&lt;/p&gt;
&lt;h2 id=&#34;laradock-vs-homestead-for-laravel-developers&#34;&gt;LaraDock VS Homestead (For Laravel Developers)&lt;/h2&gt;
&lt;h2 id=&#34;laradock-vs-homestead-for-laravel-developers&#34;&gt;Laradock VS Homestead (For Laravel Developers)&lt;/h2&gt;
&lt;blockquote&gt;
&lt;p&gt;LaraDock It&amp;rsquo;s like Laravel Homestead but for Docker instead of Vagrant.&lt;/p&gt;
&lt;p&gt;Laradock It&amp;rsquo;s like Laravel Homestead but for Docker instead of Vagrant.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;LaraDock and &lt;a href=&#34;https://laravel.com/docs/master/homestead&#34;&gt;Homestead&lt;/a&gt; both give you complete virtual development environments. (Without the need to install and configure every single software on your own Operating System).&lt;/p&gt;
&lt;p&gt;Laradock and &lt;a href=&#34;https://laravel.com/docs/master/homestead&#34;&gt;Homestead&lt;/a&gt; both give you complete virtual development environments. (Without the need to install and configure every single software on your own Operating System).&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;p&gt;Homestead is a tool that controls Vagrant for you (using Homestead special commands). And Vagrant manages your Virtual Machine.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;LaraDock is a tool that controls Docker for you (using Docker &amp;amp; Docker Compose official commands). And Docker manages your Virtual Containers.&lt;/p&gt;&lt;/li&gt;
&lt;li&gt;&lt;p&gt;Laradock is a tool that controls Docker for you (using Docker &amp;amp; Docker Compose official commands). And Docker manages your Virtual Containers.&lt;/p&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;Running a virtual container is much faster than running a full virtual Machine. Thus &lt;strong&gt;LaraDock is much faster than Homestead&lt;/strong&gt;.&lt;/p&gt;
&lt;p&gt;Running a virtual container is much faster than running a full virtual Machine. Thus &lt;strong&gt;Laradock is much faster than Homestead&lt;/strong&gt;.&lt;/p&gt;
&lt;p&gt;&lt;a name=&#34;Demo&#34;&gt;&lt;/a&gt;&lt;/p&gt;
@ -91,10 +96,10 @@ QUEUE_HOST=beanstalkd
&lt;p&gt;What&amp;rsquo;s better than a &lt;strong&gt;Demo Video&lt;/strong&gt;:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;LaraDock &lt;a href=&#34;https://www.youtube.com/watch?v=TQii1jDa96Y&#34;&gt;v4.*&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;LaraDock &lt;a href=&#34;https://www.youtube.com/watch?v=-DamFMczwDA&#34;&gt;v2.*&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;LaraDock &lt;a href=&#34;https://www.youtube.com/watch?v=jGkyO6Is_aI&#34;&gt;v0.3&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;LaraDock &lt;a href=&#34;https://www.youtube.com/watch?v=3YQsHe6oF80&#34;&gt;v0.1&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;Laradock &lt;a href=&#34;https://www.youtube.com/watch?v=TQii1jDa96Y&#34;&gt;v4.*&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;Laradock &lt;a href=&#34;https://www.youtube.com/watch?v=-DamFMczwDA&#34;&gt;v2.*&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;Laradock &lt;a href=&#34;https://www.youtube.com/watch?v=jGkyO6Is_aI&#34;&gt;v0.3&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;Laradock &lt;a href=&#34;https://www.youtube.com/watch?v=3YQsHe6oF80&#34;&gt;v0.1&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;&lt;a name=&#34;features&#34;&gt;&lt;/a&gt;&lt;/p&gt;
@ -126,11 +131,12 @@ QUEUE_HOST=beanstalkd
&lt;ul&gt;
&lt;li&gt;MySQL&lt;/li&gt;
&lt;li&gt;PostgreSQL&lt;/li&gt;
&lt;li&gt;MariaDB&lt;/li&gt;
&lt;li&gt;MongoDB&lt;/li&gt;
&lt;li&gt;Neo4j&lt;/li&gt;
&lt;li&gt;RethinkDB&lt;/li&gt;
&lt;li&gt;PostgreSQL&lt;/li&gt;
&lt;li&gt;Postgres Postgis&lt;/li&gt;
&lt;/ul&gt;&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;Cache Engines:&lt;/strong&gt;
@ -164,9 +170,12 @@ QUEUE_HOST=beanstalkd
&lt;ul&gt;
&lt;li&gt;PhpMyAdmin&lt;/li&gt;
&lt;li&gt;Adminer&lt;/li&gt;
&lt;li&gt;PgAdmin&lt;/li&gt;
&lt;li&gt;ElasticSearch&lt;/li&gt;
&lt;li&gt;Selenium&lt;/li&gt;
&lt;li&gt;Certbot&lt;/li&gt;
&lt;li&gt;Mailhog&lt;/li&gt;
&lt;li&gt;Minio&lt;/li&gt;
&lt;li&gt;Workspace
@ -198,7 +207,7 @@ QUEUE_HOST=beanstalkd
&lt;p&gt;You are welcome to join our chat room on Gitter.&lt;/p&gt;
&lt;p&gt;&lt;a href=&#34;https://gitter.im/LaraDock/laradock?utm_source=badge&amp;amp;utm_medium=badge&amp;amp;utm_campaign=pr-badge&#34;&gt;&lt;img src=&#34;https://badges.gitter.im/LaraDock/laradock.svg&#34; alt=&#34;Gitter&#34; /&gt;&lt;/a&gt;&lt;/p&gt;
&lt;p&gt;&lt;a href=&#34;https://gitter.im/Laradock/laradock?utm_source=badge&amp;amp;utm_medium=badge&amp;amp;utm_campaign=pr-badge&#34;&gt;&lt;img src=&#34;https://badges.gitter.im/Laradock/laradock.svg&#34; alt=&#34;Gitter&#34; /&gt;&lt;/a&gt;&lt;/p&gt;
</description>
</item>

View File

@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
<meta http-equiv="X-UA-Compatible" content="IE=10" />
<title>License - Laradock</title>
<meta name="generator" content="Hugo 0.18.1" />
<meta name="generator" content="Hugo 0.19" />
<meta name="description" content="Laradock documentations.">

View File

@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
<meta http-equiv="X-UA-Compatible" content="IE=10" />
<title>Related Projects - Laradock</title>
<meta name="generator" content="Hugo 0.18.1" />
<meta name="generator" content="Hugo 0.19" />
<meta name="description" content="Laradock documentations.">
@ -311,11 +311,11 @@
<div class="wrapper">
<h1>Related Projects </h1>
<p>LaraDock related projects:</p>
<p>Laradock related projects:</p>
<ul>
<li><a href="https://github.com/lorinlee/laradock-cli">LaraDock CLI</a> by <a href="https://github.com/lorinlee">LorinLee</a></li>
<li><a href="https://github.com/bagart/laradock_env">LaraDock Env</a> by <a href="https://github.com/bagart">BAGArt</a></li>
<li><a href="https://github.com/lorinlee/laradock-cli">Laradock CLI</a> by <a href="https://github.com/lorinlee">LorinLee</a></li>
<li><a href="https://github.com/bagart/laradock_env">Laradock Env</a> by <a href="https://github.com/bagart">BAGArt</a></li>
<li><a href="https://github.com/poyhsiao/Klaradock">Klaradock</a> by <a href="https://github.com/poyhsiao">Kim Hsiao</a></li>
<li><a href="https://github.com/sifat-rahim/ansible-laradock-kubernetes">Ansible Laradock Kubernetes</a> by <a href="https://github.com/sifat-rahim">Sifat Rahim</a>
These Docker Compose projects have piqued our interest:</li>

View File

@ -14,11 +14,11 @@
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>http://laradock.io/related-projects/</guid>
<description>&lt;p&gt;LaraDock related projects:&lt;/p&gt;
<description>&lt;p&gt;Laradock related projects:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;a href=&#34;https://github.com/lorinlee/laradock-cli&#34;&gt;LaraDock CLI&lt;/a&gt; by &lt;a href=&#34;https://github.com/lorinlee&#34;&gt;LorinLee&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href=&#34;https://github.com/bagart/laradock_env&#34;&gt;LaraDock Env&lt;/a&gt; by &lt;a href=&#34;https://github.com/bagart&#34;&gt;BAGArt&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href=&#34;https://github.com/lorinlee/laradock-cli&#34;&gt;Laradock CLI&lt;/a&gt; by &lt;a href=&#34;https://github.com/lorinlee&#34;&gt;LorinLee&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href=&#34;https://github.com/bagart/laradock_env&#34;&gt;Laradock Env&lt;/a&gt; by &lt;a href=&#34;https://github.com/bagart&#34;&gt;BAGArt&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href=&#34;https://github.com/poyhsiao/Klaradock&#34;&gt;Klaradock&lt;/a&gt; by &lt;a href=&#34;https://github.com/poyhsiao&#34;&gt;Kim Hsiao&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href=&#34;https://github.com/sifat-rahim/ansible-laradock-kubernetes&#34;&gt;Ansible Laradock Kubernetes&lt;/a&gt; by &lt;a href=&#34;https://github.com/sifat-rahim&#34;&gt;Sifat Rahim&lt;/a&gt;
These Docker Compose projects have piqued our interest:&lt;/li&gt;

162
env-example Normal file
View File

@ -0,0 +1,162 @@
### Application
# Point to your application code, wish should be available at `/var/www`
APPLICATION=../
### PHP version (Does not apply for HHVM)
# PHP_VERSION=56
PHP_VERSION=70
# PHP_VERSION=71
### PHP interpreter
# PHP_INTERPRETER=hhvm
PHP_INTERPRETER=php-fpm
### WORKSPACE Container
WORKSPACE_INSTALL_XDEBUG=false
WORKSPACE_INSTALL_SOAP=false
WORKSPACE_INSTALL_MONGO=false
WORKSPACE_INSTALL_NODE=false
WORKSPACE_INSTALL_YARN=false
WORKSPACE_INSTALL_DRUSH=false
WORKSPACE_INSTALL_AEROSPIKE_EXTENSION=false
WORKSPACE_INSTALL_INSTALL_V8JS_EXTENSION=false
WORKSPACE_COMPOSER_GLOBAL_INSTALL=false
WORKSPACE_INSTALL_WORKSPACE_SSH=false
WORKSPACE_INSTALL_LARAVEL_ENVOY=false
WORKSPACE_INSTALL_DEPLOYER=false
WORKSPACE_INSTALL_LINUXBREW=false
WORKSPACE_INSTALL_MC=false
WORKSPACE_INSTALL_SYMFONY=false
WORKSPACE_PUID=1000
WORKSPACE_PGID=1000
WORKSPACE_NODE_VERSION=stable
WORKSPACE_YARN_VERSION=latest
WORKSPACE_TIMEZONE=UTC
WORKSPACE_SSH_PORT=2222
### PHP_FPM Container
PHP_FPM_INSTALL_XDEBUG=false
PHP_FPM_INSTALL_MONGO=false
PHP_FPM_INSTALL_SOAP=false
PHP_FPM_INSTALL_ZIP_ARCHIVE=false
PHP_FPM_INSTALL_BCMATH=false
PHP_FPM_INSTALL_PHPREDIS=false
PHP_FPM_INSTALL_MEMCACHED=false
PHP_FPM_INSTALL_OPCACHE=false
PHP_FPM_INSTALL_EXIF=false
PHP_FPM_INSTALL_AEROSPIKE_EXTENSION=false
PHP_FPM_INSTALL_MYSQLI=false
PHP_FPM_INSTALL_TOKENIZER=false
PHP_FPM_INSTALL_INTL=false
PHP_FPM_INSTALL_GHOSTSCRIPT=false
### NGINX Container
NGINX_HOST_HTTP_PORT=80
NGINX_HOST_HTTPS_PORT=443
NGINX_HOST_LOG_PATH=./logs/nginx/
NGINX_SITES_PATH=./nginx/sites/
### APACHE Container
APACHE_HOST_HTTP_PORT=80
APACHE_HOST_HTTPS_PORT=443
APACHE2_PHP_SOCKET=php-fpm:9000
APACHE_HOST_LOG_PATH=./logs/apache2
PHP_SOCKET=php-fpm:9000
### MYSQL Container
MYSQL_DATABASE=default
MYSQL_USER=default
MYSQL_PASSWORD=secret
MYSQL_PORT=3306
MYSQL_ROOT_PASSWORD=root
### MSSQL Container
MSSQL_DATABASE=homestead
MSSQL_PASSWORD=yourStrong(!)Password
MSSQL_PORT=1433
### MARIADB Container
MARIADB_DATABASE=default
MARIADB_USER=default
MARIADB_PASSWORD=secret
MARIADB_PORT=3306
MARIADB_ROOT_PASSWORD=root
### POSTGRES Container
POSTGRES_DB=default
POSTGRES_USER=default
POSTGRES_PASSWORD=secret
POSTGRES_PORT=5432
### RABBITMQ Container
RABBITMQ_NODE_HOST_PORT=5672
RABBITMQ_MANAGEMENT_HTTP_HOST_PORT=15672
RABBITMQ_MANAGEMENT_HTTPS_HOST_PORT=15671
RABBITMQ_DEFAULT_USER=guest
RABBITMQ_DEFAULT_PASS=guest
### ELASTICSEARCH Container
ELASTICSEARCH_HOST_HTTP_PORT=9200
ELASTICSEARCH_HOST_TRANSPORT_PORT=9300
### MEMCACHED Container
MEMCACHED_HOST_PORT=11211
### BEANSTALKD CONSOLE
BEANSTALKD_CONSOLE_BUILD_PATH=./beanstalkd-console
BEANSTALKD_CONSOLE_CONTAINER_NAME=beanstalkd-console
BEANSTALKD_CONSOLE_HOST_PORT=2080
### BEANSTALKD Container
BEANSTALKD_HOST_PORT=11300
### SELENIUM Container
SELENIUM_PORT=4444
### MINIO Container
MINIO_PORT=9000
### PHP MY ADMIN Container
# PMA_DB_ENGINE=mariadb
PMA_DB_ENGINE=mysql
PMA_USER=default
PMA_PASSWORD=secret
PMA_ROOT_PASSWORD=secret
PMA_PORT=88
### ADMINER Container
ADM_PORT=88
### VARNISH Container
VARNISH_CONFIG=/etc/varnish/default.vcl
VARNISH_PORT=8080
VARNISH_BACKEND_PORT=8888
VARNISHD_PARAMS=-p default_ttl=3600 -p default_grace=3600
### Varnish Proxy 1 Container
VARNISH_PROXY1_CACHE_SIZE=128m
VARNISH_PROXY1_BACKEND_HOST=workspace
VARNISH_PROXY1_SERVER=SERVER1
### Varnish Proxy 2 Container
VARNISH_PROXY2_CACHE_SIZE=128m
VARNISH_PROXY2_BACKEND_HOST=workspace
VARNISH_PROXY2_SERVER=SERVER2
### HAPROXY Container
HAPROXY_HOST_HTTP_PORT=8085
### JENKINS Container
JENKINS_HOST_HTTP_PORT=8090
JENKINS_HOST_SLAVE_AGENT_PORT=50000
JENKINS_HOME=./jenkins/jenkins_home
### MISC
# Replace with your Docker Host IP (will be appended to /etc/hosts)
DOCKER_HOST_IP=10.0.75.1
# The Remote Interpreter entry matching name `laradock`
PHP_IDE_CONFIG=serverName=laradock
# Fix for windows users to make sure the application path works.
COMPOSE_CONVERT_WINDOWS_PATHS=1
### to be continue neo4j mongo rethinkdb redis aerospike pgadmin ...

5
haproxy/Dockerfile Normal file
View File

@ -0,0 +1,5 @@
FROM dockercloud/haproxy:latest
MAINTAINER ZeroC0D3 Team<zeroc0d3.team@gmail.com>
EXPOSE 80

View File

@ -1,5 +1,7 @@
FROM ubuntu:14.04
MAINTAINER Mahmoud Zalt <mahmoud@zalt.me>
RUN apt-key adv --recv-keys --keyserver hkp://keyserver.ubuntu.com:80 0x5a16e7281be7a449
RUN apt-get update -y \

23
jenkins/.github/ISSUE_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,23 @@
# Issues and Contributing
Please note that only issues related to this Docker image will be addressed here.
* If you have Docker related issues, please ask in the [Docker user mailing list](https://groups.google.com/forum/#!forum/docker-user).
* If you have Jenkins related issues, please ask in the [Jenkins mailing lists](https://jenkins-ci.org/content/mailing-lists).
* If you are not sure, then this is probably not the place to create an issue and you should use any of the previously mentioned mailing lists.
If after going through the previous checklist you still think you should create an issue here please provide:
### Docker commands that you execute
### Actual result
### Expected outcome
### Have you tried a non-dockerized Jenkins and get the expected outcome?
### Output of `docker version`
### Other relevant information

6
jenkins/.gitmodules vendored Normal file
View File

@ -0,0 +1,6 @@
[submodule "tests/test_helper/bats-support"]
path = tests/test_helper/bats-support
url = https://github.com/ztombol/bats-support
[submodule "tests/test_helper/bats-assert"]
path = tests/test_helper/bats-assert
url = https://github.com/ztombol/bats-assert

16
jenkins/CONTRIBUTING.md Normal file
View File

@ -0,0 +1,16 @@
# Issues and Contributing
Please note that only issues related to this Docker image will be addressed here.
* If you have Docker related issues, please ask in the [Docker user mailing list](https://groups.google.com/forum/#!forum/docker-user).
* If you have Jenkins related issues, please ask in the [Jenkins mailing lists](https://jenkins-ci.org/content/mailing-lists).
* If you are not sure, then this is probably not the place to create an issue and you should use any of the previously mentioned mailing lists.
If after going through the previous checklist you still think you should create an issue here please provide:
* Docker commands that you execute
* Actual result
* Expected outcome
* Have you tried a non-dockerized Jenkins and get the expected outcome?
* Output of `docker version`
* Other relevant information

108
jenkins/Dockerfile Normal file
View File

@ -0,0 +1,108 @@
FROM openjdk:8-jdk
RUN apt-get update && apt-get install -y git curl && rm -rf /var/lib/apt/lists/*
ENV JENKINS_HOME /var/jenkins_home
ENV JENKINS_SLAVE_AGENT_PORT 50000
ARG user=jenkins
ARG group=jenkins
ARG uid=1000
ARG gid=1000
# Jenkins is run with user `jenkins`, uid = 1000
# If you bind mount a volume from the host or a data container,
# ensure you use the same uid
RUN groupadd -g ${gid} ${group} \
&& useradd -d "$JENKINS_HOME" -u ${uid} -g ${gid} -m -s /bin/bash ${user}
# Jenkins home directory is a volume, so configuration and build history
# can be persisted and survive image upgrades
VOLUME /var/jenkins_home
# `/usr/share/jenkins/ref/` contains all reference configuration we want
# to set on a fresh new installation. Use it to bundle additional plugins
# or config file with your custom jenkins Docker image.
RUN mkdir -p /usr/share/jenkins/ref/init.groovy.d
ENV TINI_VERSION 0.13.2
ENV TINI_SHA afbf8de8a63ce8e4f18cb3f34dfdbbd354af68a1
# Use tini as subreaper in Docker container to adopt zombie processes
RUN curl -fsSL https://github.com/krallin/tini/releases/download/v${TINI_VERSION}/tini-static-amd64 -o /bin/tini && chmod +x /bin/tini \
&& echo "$TINI_SHA /bin/tini" | sha1sum -c -
COPY init.groovy /usr/share/jenkins/ref/init.groovy.d/tcp-slave-agent-port.groovy
# jenkins version being bundled in this docker image
ARG JENKINS_VERSION
ENV JENKINS_VERSION ${JENKINS_VERSION:-2.32.3}
# jenkins.war checksum, download will be validated using it
ARG JENKINS_SHA=a25b9a314ca9e76f9673da7309e1882e32674223
# Can be used to customize where jenkins.war get downloaded from
ARG JENKINS_URL=https://repo.jenkins-ci.org/public/org/jenkins-ci/main/jenkins-war/${JENKINS_VERSION}/jenkins-war-${JENKINS_VERSION}.war
# could use ADD but this one does not check Last-Modified header neither does it allow to control checksum
# see https://github.com/docker/docker/issues/8331
RUN curl -fsSL ${JENKINS_URL} -o /usr/share/jenkins/jenkins.war \
&& echo "${JENKINS_SHA} /usr/share/jenkins/jenkins.war" | sha1sum -c -
ENV JENKINS_UC https://updates.jenkins.io
RUN chown -R ${user} "$JENKINS_HOME" /usr/share/jenkins/ref
# Add jenkins to the correct group
# see http://stackoverflow.com/questions/42164653/docker-in-docker-permissions-error
# use "getent group docker | awk -F: '{printf "%d\n", $3}'" command on host to find correct value for gid or simply use 'id'
ARG DOCKER_GID=998
RUN groupadd -g ${DOCKER_GID} docker \
&& curl -sSL https://get.docker.com/ | sh \
&& apt-get -q autoremove \
&& apt-get -q clean -y \
&& rm -rf /var/lib/apt/lists/* /var/cache/apt/*.bin
# Install Docker-in-Docker from git@github.com:jpetazzo/dind.git
# RUN apt-get update -qq && apt-get install -qqy apt-transport-https ca-certificates curl lxc iptables
# Install Docker from Docker Inc. repositories.
RUN apt-get install -y curl && curl -sSL https://get.docker.com/ | sh
RUN usermod -aG docker jenkins
# Install Docker-Compose
RUN curl -L "https://github.com/docker/compose/releases/download/1.10.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
RUN chmod +x /usr/local/bin/docker-compose
# for main web interface:
EXPOSE 8080
# will be used by attached slave agents:
EXPOSE 50000
ENV COPY_REFERENCE_FILE_LOG $JENKINS_HOME/copy_reference_file.log
USER ${user}
COPY jenkins-support /usr/local/bin/jenkins-support
COPY jenkins.sh /usr/local/bin/jenkins.sh
ENTRYPOINT ["/bin/tini", "--", "/usr/local/bin/jenkins.sh"]
# from a derived Dockerfile, can use `RUN plugins.sh active.txt` to setup /usr/share/jenkins/ref/plugins from a support bundle
COPY plugins.sh /usr/local/bin/plugins.sh
COPY install-plugins.sh /usr/local/bin/install-plugins.sh
# Only need below if we are starting from empty jenkins_home
## Copy the RSA keys
#RUN mkdir -p /var/jenkins_home/.ssh
#RUN chown jenkins:jenkins /var/jenkins_home/.ssh
#COPY keys/id_rsa /var/jenkins_home/.ssh/id_rsa.pub
#COPY keys/id_rsa /var/jenkins_home/.ssh/id_rsa
#COPY keys/known_hosts /var/jenkins_home/.ssh/known_hosts
#
#USER root
#RUN chmod 600 /var/jenkins_home/.ssh/id_rsa
#RUN chmod 644 /var/jenkins_home/.ssh/id_rsa.pub
## ssh-keyscan -H github.com >> ~/.ssh/known_hosts
## ssh-keyscan -H bitbucket.org >> ~/.ssh/known_hosts

38
jenkins/Jenkinsfile vendored Normal file
View File

@ -0,0 +1,38 @@
#!/usr/bin/env groovy
properties([
buildDiscarder(logRotator(numToKeepStr: '5', artifactNumToKeepStr: '5')),
pipelineTriggers([cron('@daily')]),
])
node('docker') {
deleteDir()
stage('Checkout') {
checkout scm
}
if (!infra.isTrusted()) {
/* Outside of the trusted.ci environment, we're building and testing
* the Dockerful in this repository, but not publishing to docker hub
*/
stage('Build') {
docker.build('jenkins')
}
stage('Test') {
sh """
git submodule update --init --recursive
git clone https://github.com/sstephenson/bats.git
bats/bin/bats tests
"""
}
} else {
/* In our trusted.ci environment we only want to be publishing our
* containers from artifacts
*/
stage('Publish') {
sh './publish.sh'
}
}
}

226
jenkins/README.md Normal file
View File

@ -0,0 +1,226 @@
# Official Jenkins Docker image
The Jenkins Continuous Integration and Delivery server.
This is a fully functional Jenkins server, based on the Long Term Support release.
[http://jenkins.io/](http://jenkins.io/).
For weekly releases check out [`jenkinsci/jenkins`](https://hub.docker.com/r/jenkinsci/jenkins/)
<img src="http://jenkins-ci.org/sites/default/files/jenkins_logo.png"/>
# Usage
```
docker run -p 8080:8080 -p 50000:50000 jenkins
```
NOTE: read below the _build executors_ part for the role of the `50000` port mapping.
This will store the workspace in /var/jenkins_home. All Jenkins data lives in there - including plugins and configuration.
You will probably want to make that an explicit volume so you can manage it and attach to another container for upgrades :
```
docker run -p 8080:8080 -p 50000:50000 -v jenkins_home:/var/jenkins_home jenkins
```
this will automatically create a 'jenkins_home' volume on docker host, that will survive container stop/restart/deletion.
Avoid using a bind mount from a folder on host into `/var/jenkins_home`, as this might result in file permission issue. If you _really_ need to bind mount jenkins_home, ensure that directory on host is accessible by the jenkins user in container (jenkins user - uid 1000) or use `-u some_other_user` parameter with `docker run`.
## Backing up data
If you bind mount in a volume - you can simply back up that directory
(which is jenkins_home) at any time.
This is highly recommended. Treat the jenkins_home directory as you would a database - in Docker you would generally put a database on a volume.
If your volume is inside a container - you can use ```docker cp $ID:/var/jenkins_home``` command to extract the data, or other options to find where the volume data is.
Note that some symlinks on some OSes may be converted to copies (this can confuse jenkins with lastStableBuild links etc)
For more info check Docker docs section on [Managing data in containers](https://docs.docker.com/engine/tutorials/dockervolumes/)
# Setting the number of executors
You can specify and set the number of executors of your Jenkins master instance using a groovy script. By default its set to 2 executors, but you can extend the image and change it to your desired number of executors :
`executors.groovy`
```
import jenkins.model.*
Jenkins.instance.setNumExecutors(5)
```
and `Dockerfile`
```
FROM jenkins
COPY executors.groovy /usr/share/jenkins/ref/init.groovy.d/executors.groovy
```
# Attaching build executors
You can run builds on the master out of the box.
But if you want to attach build slave servers **through JNLP (Java Web Start)**: make sure you map the port: ```-p 50000:50000``` - which will be used when you connect a slave agent.
If you are only using [SSH slaves](https://wiki.jenkins-ci.org/display/JENKINS/SSH+Slaves+plugin), then you do **NOT** need to put that port mapping.
# Passing JVM parameters
You might need to customize the JVM running Jenkins, typically to pass system properties or tweak heap memory settings. Use JAVA_OPTS environment
variable for this purpose :
```
docker run --name myjenkins -p 8080:8080 -p 50000:50000 --env JAVA_OPTS=-Dhudson.footerURL=http://mycompany.com jenkins
```
# Configuring logging
Jenkins logging can be configured through a properties file and `java.util.logging.config.file` Java property.
For example:
```
mkdir data
cat > data/log.properties <<EOF
handlers=java.util.logging.ConsoleHandler
jenkins.level=FINEST
java.util.logging.ConsoleHandler.level=FINEST
EOF
docker run --name myjenkins -p 8080:8080 -p 50000:50000 --env JAVA_OPTS="-Djava.util.logging.config.file=/var/jenkins_home/log.properties" -v `pwd`/data:/var/jenkins_home jenkins
```
# Configuring reverse proxy
If you want to install Jenkins behind a reverse proxy with prefix, example: mysite.com/jenkins, you need to add environnement variable `JENKINS_OPTS="--prefix=/jenkins"` and then follow the below procedures to configure your reverse proxy, which will depend if you have Apache ou Nginx:
- [Apache](https://wiki.jenkins-ci.org/display/JENKINS/Running+Jenkins+behind+Apache)
- [Nginx](https://wiki.jenkins-ci.org/display/JENKINS/Jenkins+behind+an+NGinX+reverse+proxy)
# Passing Jenkins launcher parameters
Argument you pass to docker running the jenkins image are passed to jenkins launcher, so you can run for sample :
```
docker run jenkins --version
```
This will dump Jenkins version, just like when you run jenkins as an executable war.
You also can define jenkins arguments as `JENKINS_OPTS`. This is usefull to define a set of arguments to pass to jenkins launcher as you
define a derived jenkins image based on the official one with some customized settings. The following sample Dockerfile uses this option
to force use of HTTPS with a certificate included in the image
```
FROM jenkins:1.565.3
COPY https.pem /var/lib/jenkins/cert
COPY https.key /var/lib/jenkins/pk
ENV JENKINS_OPTS --httpPort=-1 --httpsPort=8083 --httpsCertificate=/var/lib/jenkins/cert --httpsPrivateKey=/var/lib/jenkins/pk
EXPOSE 8083
```
You can also change the default slave agent port for jenkins by defining `JENKINS_SLAVE_AGENT_PORT` in a sample Dockerfile.
```
FROM jenkins:1.565.3
ENV JENKINS_SLAVE_AGENT_PORT 50001
```
or as a parameter to docker,
```
docker run --name myjenkins -p 8080:8080 -p 50001:50001 --env JENKINS_SLAVE_AGENT_PORT=50001 jenkins
```
# Installing more tools
You can run your container as root - and install via apt-get, install as part of build steps via jenkins tool installers, or you can create your own Dockerfile to customise, for example:
```
FROM jenkins
# if we want to install via apt
USER root
RUN apt-get update && apt-get install -y ruby make more-thing-here
# drop back to the regular jenkins user - good practice
USER jenkins
```
In such a derived image, you can customize your jenkins instance with hook scripts or additional plugins.
For this purpose, use `/usr/share/jenkins/ref` as a place to define the default JENKINS_HOME content you
wish the target installation to look like :
```
FROM jenkins
COPY custom.groovy /usr/share/jenkins/ref/init.groovy.d/custom.groovy
```
## Preinstalling plugins
You can rely on the `install-plugins.sh` script to pass a set of plugins to download with their dependencies.
Use plugin artifact ID, whithout `-plugin` extension, and append the version if needed separated by `:`.
Dependencies that are already included in the Jenkins war will only be downloaded if their required version is newer than the one included.
```
FROM jenkins
RUN /usr/local/bin/install-plugins.sh docker-slaves github-branch-source:1.8
```
When jenkins container starts, it will check `JENKINS_HOME` has this reference content, and copy them
there if required. It will not override such files, so if you upgraded some plugins from UI they won't
be reverted on next start.
In case you *do* want to override, append '.override' to the name of the reference file. E.g. a file named
`/usr/share/jenkins/ref/config.xml.override` will overwrite an existing `config.xml` file in JENKINS_HOME.
Also see [JENKINS-24986](https://issues.jenkins-ci.org/browse/JENKINS-24986)
Here is an example to get the list of plugins from an existing server:
```
JENKINS_HOST=username:password@myhost.com:port
curl -sSL "http://$JENKINS_HOST/pluginManager/api/xml?depth=1&xpath=/*/*/shortName|/*/*/version&wrapper=plugins" | perl -pe 's/.*?<shortName>([\w-]+).*?<version>([^<]+)()(<\/\w+>)+/\1 \2\n/g'|sed 's/ /:/'
```
Example Output:
```
cucumber-testresult-plugin:0.8.2
pam-auth:1.1
matrix-project:1.4.1
script-security:1.13
...
```
For 2.x-derived images, you may also want to
RUN echo 2.0 > /usr/share/jenkins/ref/jenkins.install.UpgradeWizard.state
to indicate that this Jenkins installation is fully configured.
Otherwise a banner will appear prompting the user to install additional plugins,
which may be inappropriate.
# Upgrading
All the data needed is in the /var/jenkins_home directory - so depending on how you manage that - depends on how you upgrade. Generally - you can copy it out - and then "docker pull" the image again - and you will have the latest LTS - you can then start up with -v pointing to that data (/var/jenkins_home) and everything will be as you left it.
As always - please ensure that you know how to drive docker - especially volume handling!
## Upgrading plugins
By default, plugins will be upgraded if they haven't been upgraded manually and if the version from the docker image is newer than the version in the container. Versions installed by the docker image are tracked through a marker file.
The default behaviour when upgrading from a docker image that didn't write marker files is to leave existing plugins in place. If you want to upgrade existing plugins without marker you may run the docker image with `-e TRY_UPGRADE_IF_NO_MARKER=true`. Then plugins will be upgraded if the version provided by the docker image is newer.
# Building
Build with the usual
docker build -t jenkins .
Tests are written using [bats](https://github.com/sstephenson/bats) under the `tests` dir
bats tests
Bats can be easily installed with `brew install bats` on OS X
# Questions?
Jump on irc.freenode.net and the #jenkins room. Ask!

View File

@ -0,0 +1,14 @@
master:
build: .
environment:
JAVA_OPTS: "-Djava.awt.headless=true"
ports:
- "50000:50000"
# Expose Jenkins to parent on port 8090
- "8090:8080"
# Allow Docker In Docker
privileged: true
volumes:
- ./jenkins_home:/var/jenkins_home
# Allow Docker In Docker to use parent docker container
- /var/run/docker.sock:/var/run/docker.sock

12
jenkins/init.groovy Normal file
View File

@ -0,0 +1,12 @@
import hudson.model.*;
import jenkins.model.*;
Thread.start {
sleep 10000
println "--> setting agent port for jnlp"
def env = System.getenv()
int port = env['JENKINS_SLAVE_AGENT_PORT'].toInteger()
Jenkins.instance.setSlaveAgentPort(port)
println "--> setting agent port for jnlp... done"
}

205
jenkins/install-plugins.sh Normal file
View File

@ -0,0 +1,205 @@
#!/bin/bash -eu
# Resolve dependencies and download plugins given on the command line
#
# FROM jenkins
# RUN install-plugins.sh docker-slaves github-branch-source
set -o pipefail
REF_DIR=${REF:-/usr/share/jenkins/ref/plugins}
FAILED="$REF_DIR/failed-plugins.txt"
. /usr/local/bin/jenkins-support
getLockFile() {
printf '%s' "$REF_DIR/${1}.lock"
}
getArchiveFilename() {
printf '%s' "$REF_DIR/${1}.jpi"
}
download() {
local plugin originalPlugin version lock ignoreLockFile
plugin="$1"
version="${2:-latest}"
ignoreLockFile="${3:-}"
lock="$(getLockFile "$plugin")"
if [[ $ignoreLockFile ]] || mkdir "$lock" &>/dev/null; then
if ! doDownload "$plugin" "$version"; then
# some plugin don't follow the rules about artifact ID
# typically: docker-plugin
originalPlugin="$plugin"
plugin="${plugin}-plugin"
if ! doDownload "$plugin" "$version"; then
echo "Failed to download plugin: $originalPlugin or $plugin" >&2
echo "Not downloaded: ${originalPlugin}" >> "$FAILED"
return 1
fi
fi
if ! checkIntegrity "$plugin"; then
echo "Downloaded file is not a valid ZIP: $(getArchiveFilename "$plugin")" >&2
echo "Download integrity: ${plugin}" >> "$FAILED"
return 1
fi
resolveDependencies "$plugin"
fi
}
doDownload() {
local plugin version url jpi
plugin="$1"
version="$2"
jpi="$(getArchiveFilename "$plugin")"
# If plugin already exists and is the same version do not download
if test -f "$jpi" && unzip -p "$jpi" META-INF/MANIFEST.MF | tr -d '\r' | grep "^Plugin-Version: ${version}$" > /dev/null; then
echo "Using provided plugin: $plugin"
return 0
fi
JENKINS_UC_DOWNLOAD=${JENKINS_UC_DOWNLOAD:-"$JENKINS_UC/download"}
url="$JENKINS_UC_DOWNLOAD/plugins/$plugin/$version/${plugin}.hpi"
echo "Downloading plugin: $plugin from $url"
curl --connect-timeout ${CURL_CONNECTION_TIMEOUT:-20} --retry ${CURL_RETRY:-5} --retry-delay ${CURL_RETRY_DELAY:-0} --retry-max-time ${CURL_RETRY_MAX_TIME:-60} -s -f -L "$url" -o "$jpi"
return $?
}
checkIntegrity() {
local plugin jpi
plugin="$1"
jpi="$(getArchiveFilename "$plugin")"
unzip -t -qq "$jpi" >/dev/null
return $?
}
resolveDependencies() {
local plugin jpi dependencies
plugin="$1"
jpi="$(getArchiveFilename "$plugin")"
dependencies="$(unzip -p "$jpi" META-INF/MANIFEST.MF | tr -d '\r' | tr '\n' '|' | sed -e 's#| ##g' | tr '|' '\n' | grep "^Plugin-Dependencies: " | sed -e 's#^Plugin-Dependencies: ##')"
if [[ ! $dependencies ]]; then
echo " > $plugin has no dependencies"
return
fi
echo " > $plugin depends on $dependencies"
IFS=',' read -r -a array <<< "$dependencies"
for d in "${array[@]}"
do
plugin="$(cut -d':' -f1 - <<< "$d")"
if [[ $d == *"resolution:=optional"* ]]; then
echo "Skipping optional dependency $plugin"
else
local pluginInstalled
if pluginInstalled="$(echo "${bundledPlugins}" | grep "^${plugin}:")"; then
pluginInstalled="${pluginInstalled//[$'\r']}"
local versionInstalled; versionInstalled=$(versionFromPlugin "${pluginInstalled}")
local minVersion; minVersion=$(versionFromPlugin "${d}")
if versionLT "${versionInstalled}" "${minVersion}"; then
echo "Upgrading bundled dependency $d ($minVersion > $versionInstalled)"
download "$plugin" &
else
echo "Skipping already bundled dependency $d ($minVersion <= $versionInstalled)"
fi
else
download "$plugin" &
fi
fi
done
wait
}
bundledPlugins() {
local JENKINS_WAR=/usr/share/jenkins/jenkins.war
if [ -f $JENKINS_WAR ]
then
TEMP_PLUGIN_DIR=/tmp/plugintemp.$$
for i in $(jar tf $JENKINS_WAR | egrep '[^detached-]plugins.*\..pi' | sort)
do
rm -fr $TEMP_PLUGIN_DIR
mkdir -p $TEMP_PLUGIN_DIR
PLUGIN=$(basename "$i"|cut -f1 -d'.')
(cd $TEMP_PLUGIN_DIR;jar xf "$JENKINS_WAR" "$i";jar xvf "$TEMP_PLUGIN_DIR/$i" META-INF/MANIFEST.MF >/dev/null 2>&1)
VER=$(egrep -i Plugin-Version "$TEMP_PLUGIN_DIR/META-INF/MANIFEST.MF"|cut -d: -f2|sed 's/ //')
echo "$PLUGIN:$VER"
done
rm -fr $TEMP_PLUGIN_DIR
else
rm -f "$TEMP_ALREADY_INSTALLED"
echo "ERROR file not found: $JENKINS_WAR"
exit 1
fi
}
versionFromPlugin() {
local plugin=$1
if [[ $plugin =~ .*:.* ]]; then
echo "${plugin##*:}"
else
echo "latest"
fi
}
installedPlugins() {
for f in "$REF_DIR"/*.jpi; do
echo "$(basename "$f" | sed -e 's/\.jpi//'):$(get_plugin_version "$f")"
done
}
main() {
local plugin version
mkdir -p "$REF_DIR" || exit 1
# Create lockfile manually before first run to make sure any explicit version set is used.
echo "Creating initial locks..."
for plugin in "$@"; do
mkdir "$(getLockFile "${plugin%%:*}")"
done
echo "Analyzing war..."
bundledPlugins="$(bundledPlugins)"
echo "Downloading plugins..."
for plugin in "$@"; do
version=""
if [[ $plugin =~ .*:.* ]]; then
version=$(versionFromPlugin "${plugin}")
plugin="${plugin%%:*}"
fi
download "$plugin" "$version" "true" &
done
wait
echo
echo "WAR bundled plugins:"
echo "${bundledPlugins}"
echo
echo "Installed plugins:"
installedPlugins
if [[ -f $FAILED ]]; then
echo "Some plugins failed to download!" "$(<"$FAILED")" >&2
exit 1
fi
echo "Cleaning up locks"
rm -r "$REF_DIR"/*.lock
}
main "$@"

127
jenkins/jenkins-support Normal file
View File

@ -0,0 +1,127 @@
#!/bin/bash -eu
# compare if version1 < version2
versionLT() {
local v1; v1=$(echo "$1" | cut -d '-' -f 1 )
local q1; q1=$(echo "$1" | cut -s -d '-' -f 2- )
local v2; v2=$(echo "$2" | cut -d '-' -f 1 )
local q2; q2=$(echo "$2" | cut -s -d '-' -f 2- )
if [ "$v1" = "$v2" ]; then
if [ "$q1" = "$q2" ]; then
return 1
else
if [ -z "$q1" ]; then
return 1
else
if [ -z "$q2" ]; then
return 0
else
[ "$q1" = "$(echo -e "$q1\n$q2" | sort -V | head -n1)" ]
fi
fi
fi
else
[ "$v1" = "$(echo -e "$v1\n$v2" | sort -V | head -n1)" ]
fi
}
# returns a plugin version from a plugin archive
get_plugin_version() {
local archive; archive=$1
local version; version=$(unzip -p "$archive" META-INF/MANIFEST.MF | grep "^Plugin-Version: " | sed -e 's#^Plugin-Version: ##')
version=${version%%[[:space:]]}
echo "$version"
}
# Copy files from /usr/share/jenkins/ref into $JENKINS_HOME
# So the initial JENKINS-HOME is set with expected content.
# Don't override, as this is just a reference setup, and use from UI
# can then change this, upgrade plugins, etc.
copy_reference_file() {
f="${1%/}"
b="${f%.override}"
rel="${b:23}"
version_marker="${rel}.version_from_image"
dir=$(dirname "${b}")
local action;
local reason;
local container_version;
local image_version;
local marker_version;
local log; log=false
if [[ ${rel} == plugins/*.jpi ]]; then
container_version=$(get_plugin_version "$JENKINS_HOME/${rel}")
image_version=$(get_plugin_version "${f}")
if [[ -e $JENKINS_HOME/${version_marker} ]]; then
marker_version=$(cat "$JENKINS_HOME/${version_marker}")
if versionLT "$marker_version" "$container_version"; then
action="SKIPPED"
reason="Installed version ($container_version) has been manually upgraded from initial version ($marker_version)"
log=true
else
if [[ "$image_version" == "$container_version" ]]; then
action="SKIPPED"
reason="Version from image is the same as the installed version $image_version"
else
if versionLT "$image_version" "$container_version"; then
action="SKIPPED"
log=true
reason="Image version ($image_version) is older than installed version ($container_version)"
else
action="UPGRADED"
log=true
reason="Image version ($image_version) is newer than installed version ($container_version)"
fi
fi
fi
else
if [[ -n "$TRY_UPGRADE_IF_NO_MARKER" ]]; then
if [[ "$image_version" == "$container_version" ]]; then
action="SKIPPED"
reason="Version from image is the same as the installed version $image_version (no marker found)"
# Add marker for next time
echo "$image_version" > "$JENKINS_HOME/${version_marker}"
else
if versionLT "$image_version" "$container_version"; then
action="SKIPPED"
log=true
reason="Image version ($image_version) is older than installed version ($container_version) (no marker found)"
else
action="UPGRADED"
log=true
reason="Image version ($image_version) is newer than installed version ($container_version) (no marker found)"
fi
fi
fi
fi
if [[ ! -e $JENKINS_HOME/${rel} || "$action" == "UPGRADED" || $f = *.override ]]; then
action=${action:-"INSTALLED"}
log=true
mkdir -p "$JENKINS_HOME/${dir:23}"
cp -r "${f}" "$JENKINS_HOME/${rel}";
# pin plugins on initial copy
touch "$JENKINS_HOME/${rel}.pinned"
echo "$image_version" > "$JENKINS_HOME/${version_marker}"
reason=${reason:-$image_version}
else
action=${action:-"SKIPPED"}
fi
else
if [[ ! -e $JENKINS_HOME/${rel} || $f = *.override ]]
then
action="INSTALLED"
log=true
mkdir -p "$JENKINS_HOME/${dir:23}"
cp -r "${f}" "$JENKINS_HOME/${rel}";
else
action="SKIPPED"
fi
fi
if [[ -n "$VERBOSE" || "$log" == "true" ]]; then
if [ -z "$reason" ]; then
echo "$action $rel" >> "$COPY_REFERENCE_FILE_LOG"
else
echo "$action $rel : $reason" >> "$COPY_REFERENCE_FILE_LOG"
fi
fi
}

26
jenkins/jenkins.sh Normal file
View File

@ -0,0 +1,26 @@
#! /bin/bash -e
: "${JENKINS_HOME:="/var/jenkins_home"}"
touch "${COPY_REFERENCE_FILE_LOG}" || { echo "Can not write to ${COPY_REFERENCE_FILE_LOG}. Wrong volume permissions?"; exit 1; }
echo "--- Copying files at $(date)" >> "$COPY_REFERENCE_FILE_LOG"
find /usr/share/jenkins/ref/ -type f -exec bash -c '. /usr/local/bin/jenkins-support; for arg; do copy_reference_file "$arg"; done' _ {} +
# if `docker run` first argument start with `--` the user is passing jenkins launcher arguments
if [[ $# -lt 1 ]] || [[ "$1" == "--"* ]]; then
# read JAVA_OPTS and JENKINS_OPTS into arrays to avoid need for eval (and associated vulnerabilities)
java_opts_array=()
while IFS= read -r -d '' item; do
java_opts_array+=( "$item" )
done < <([[ $JAVA_OPTS ]] && xargs printf '%s\0' <<<"$JAVA_OPTS")
jenkins_opts_array=( )
while IFS= read -r -d '' item; do
jenkins_opts_array+=( "$item" )
done < <([[ $JENKINS_OPTS ]] && xargs printf '%s\0' <<<"$JENKINS_OPTS")
exec java "${java_opts_array[@]}" -jar /usr/share/jenkins/jenkins.war "${jenkins_opts_array[@]}" "$@"
fi
# As argument is not jenkins, assume user want to run his own process, for example a `bash` shell to explore this image
exec "$@"

28
jenkins/jenkins_home/.gitignore vendored Normal file
View File

@ -0,0 +1,28 @@
# File Patterns to Ignore
logs
*.log
*.log.*
*.swp
# Ignore SSH Config
.ssh/*
!.ssh/known_hosts
# Include job configs and ignore other data
!config.xml
builds
lastStable
lastSuccessful
nextBuildNumber
# Ignore expanded plugins folders because we only want jpi files
plugins/*
!plugins/*.jpi
# Include user info
!userContent/*
!users/*
# Ignore Directories
workspace/
war/

124
jenkins/plugins.sh Normal file
View File

@ -0,0 +1,124 @@
#! /bin/bash
# Parse a support-core plugin -style txt file as specification for jenkins plugins to be installed
# in the reference directory, so user can define a derived Docker image with just :
#
# FROM jenkins
# COPY plugins.txt /plugins.txt
# RUN /usr/local/bin/plugins.sh /plugins.txt
#
# Note: Plugins already installed are skipped
#
set -e
echo "WARN: plugins.sh is deprecated, please switch to install-plugins.sh"
if [ -z "$1" ]
then
echo "
USAGE:
Parse a support-core plugin -style txt file as specification for jenkins plugins to be installed
in the reference directory, so user can define a derived Docker image with just :
FROM jenkins
COPY plugins.txt /plugins.txt
RUN /usr/local/bin/plugins.sh /plugins.txt
Note: Plugins already installed are skipped
"
exit 1
else
JENKINS_INPUT_JOB_LIST=$1
if [ ! -f "$JENKINS_INPUT_JOB_LIST" ]
then
echo "ERROR File not found: $JENKINS_INPUT_JOB_LIST"
exit 1
fi
fi
# the war includes a # of plugins, to make the build efficient filter out
# the plugins so we dont install 2x - there about 17!
if [ -d "$JENKINS_HOME" ]
then
TEMP_ALREADY_INSTALLED=$JENKINS_HOME/preinstalled.plugins.$$.txt
else
echo "ERROR $JENKINS_HOME not found"
exit 1
fi
JENKINS_PLUGINS_DIR=/var/jenkins_home/plugins
if [ -d "$JENKINS_PLUGINS_DIR" ]
then
echo "Analyzing: $JENKINS_PLUGINS_DIR"
for i in "$JENKINS_PLUGINS_DIR"/*/; do
JENKINS_PLUGIN=$(basename "$i")
JENKINS_PLUGIN_VER=$(egrep -i Plugin-Version "$i/META-INF/MANIFEST.MF"|cut -d: -f2|sed 's/ //')
echo "$JENKINS_PLUGIN:$JENKINS_PLUGIN_VER"
done >"$TEMP_ALREADY_INSTALLED"
else
JENKINS_WAR=/usr/share/jenkins/jenkins.war
if [ -f "$JENKINS_WAR" ]
then
echo "Analyzing war: $JENKINS_WAR"
TEMP_PLUGIN_DIR=/tmp/plugintemp.$$
while read -r i <&3; do
rm -fr "$TEMP_PLUGIN_DIR"
mkdir -p "$TEMP_PLUGIN_DIR"
PLUGIN=$(basename "$i"|cut -f1 -d'.')
(cd "$TEMP_PLUGIN_DIR" || exit; jar xf "$JENKINS_WAR" "$i"; jar xvf "$TEMP_PLUGIN_DIR/$i" META-INF/MANIFEST.MF >/dev/null 2>&1)
VER=$(egrep -i Plugin-Version "$TEMP_PLUGIN_DIR/META-INF/MANIFEST.MF"|cut -d: -f2|sed 's/ //')
echo "$PLUGIN:$VER"
done 3< <(jar tf "$JENKINS_WAR" | egrep '[^detached-]plugins.*\..pi' | sort) > "$TEMP_ALREADY_INSTALLED"
rm -fr "$TEMP_PLUGIN_DIR"
else
rm -f "$TEMP_ALREADY_INSTALLED"
echo "ERROR file not found: $JENKINS_WAR"
exit 1
fi
fi
REF=/usr/share/jenkins/ref/plugins
mkdir -p $REF
COUNT_PLUGINS_INSTALLED=0
while read -r spec || [ -n "$spec" ]; do
plugin=(${spec//:/ });
[[ ${plugin[0]} =~ ^# ]] && continue
[[ ${plugin[0]} =~ ^[[:space:]]*$ ]] && continue
[[ -z ${plugin[1]} ]] && plugin[1]="latest"
if [ -z "$JENKINS_UC_DOWNLOAD" ]; then
JENKINS_UC_DOWNLOAD=$JENKINS_UC/download
fi
if ! grep -q "${plugin[0]}:${plugin[1]}" "$TEMP_ALREADY_INSTALLED"
then
echo "Downloading ${plugin[0]}:${plugin[1]}"
curl --retry 3 --retry-delay 5 -sSL -f "${JENKINS_UC_DOWNLOAD}/plugins/${plugin[0]}/${plugin[1]}/${plugin[0]}.hpi" -o "$REF/${plugin[0]}.jpi"
unzip -qqt "$REF/${plugin[0]}.jpi"
(( COUNT_PLUGINS_INSTALLED += 1 ))
else
echo " ... skipping already installed: ${plugin[0]}:${plugin[1]}"
fi
done < "$JENKINS_INPUT_JOB_LIST"
echo "---------------------------------------------------"
if (( "$COUNT_PLUGINS_INSTALLED" > 0 ))
then
echo "INFO: Successfully installed $COUNT_PLUGINS_INSTALLED plugins."
if [ -d $JENKINS_PLUGINS_DIR ]
then
echo "INFO: Please restart the container for changes to take effect!"
fi
else
echo "INFO: No changes, all plugins previously installed."
fi
echo "---------------------------------------------------"
#cleanup
rm "$TEMP_ALREADY_INSTALLED"
exit 0

148
jenkins/publish.sh Normal file
View File

@ -0,0 +1,148 @@
#!/bin/bash -eu
# Publish any versions of the docker image not yet pushed to jenkinsci/jenkins
# Arguments:
# -n dry run, do not build or publish images
set -o pipefail
sort-versions() {
if [ "$(uname)" == 'Darwin' ]; then
gsort --version-sort
else
sort --version-sort
fi
}
# Try tagging with and without -f to support all versions of docker
docker-tag() {
local from="jenkinsci/jenkins:$1"
local to="jenkinsci/jenkins:$2"
local out
if out=$(docker tag -f "$from" "$to" 2>&1); then
echo "$out"
else
docker tag "$from" "$to"
fi
}
get-variant() {
local branch
branch=$(git show-ref | grep $(git rev-list -n 1 HEAD) | tail -1 | rev | cut -d/ -f 1 | rev)
if [ -z "$branch" ]; then
>&2 echo "Could not get the current branch name for commit, not in a branch?: $(git rev-list -n 1 HEAD)"
return 1
fi
case "$branch" in
master) echo "" ;;
*) echo "-${branch}" ;;
esac
}
login-token() {
# could use jq .token
curl -q -sSL https://auth.docker.io/token\?service\=registry.docker.io\&scope\=repository:jenkinsci/jenkins:pull | grep -o '"token":"[^"]*"' | cut -d':' -f 2 | xargs echo
}
is-published() {
get-manifest "$1" &> /dev/null
}
get-manifest() {
local tag=$1
curl -q -fsSL -H "Accept: application/vnd.docker.distribution.manifest.v2+json" -H "Authorization: Bearer $TOKEN" "https://index.docker.io/v2/jenkinsci/jenkins/manifests/$tag"
}
get-digest() {
#get-manifest "$1" | jq .config.digest
get-manifest "$1" | grep -A 10 -o '"config".*' | grep digest | head -1 | cut -d':' -f 2,3 | xargs echo
}
get-latest-versions() {
curl -q -fsSL https://api.github.com/repos/jenkinsci/jenkins/tags?per_page=20 | grep '"name": "jenkins-' | egrep -o '[0-9]+(\.[0-9]+)+' | sort-versions | uniq
}
publish() {
local version=$1
local variant=$2
local tag="${version}${variant}"
local sha
local build_opts="--no-cache --pull"
sha=$(curl -q -fsSL "http://repo.jenkins-ci.org/simple/releases/org/jenkins-ci/main/jenkins-war/${version}/jenkins-war-${version}.war.sha1")
docker build --build-arg "JENKINS_VERSION=$version" \
--build-arg "JENKINS_SHA=$sha" \
--tag "jenkinsci/jenkins:${tag}" ${build_opts} .
docker push "jenkinsci/jenkins:${tag}"
}
tag-and-push() {
local source=$1
local target=$2
local digest_source; digest_source=$(get-digest ${tag1})
local digest_target; digest_target=$(get-digest ${tag2})
if [ "$digest_source" == "$digest_target" ]; then
echo "Images ${source} [$digest_source] and ${target} [$digest_target] are already the same, not updating tags"
else
echo "Creating tag ${target} pointing to ${source}"
if [ ! "$dry_run" = true ]; then
docker-tag "jenkinsci/jenkins:${source}" "jenkinsci/jenkins:${target}"
docker push "jenkinsci/jenkins:${source}"
fi
fi
}
publish-latest() {
local version=$1
local variant=$2
# push latest (for master) or the name of the branch (for other branches)
if [ -z "${variant}" ]; then
tag-and-push "${version}${variant}" "latest"
else
tag-and-push "${version}${variant}" "${variant#-}"
fi
}
publish-lts() {
local version=$1
local variant=$2
tag-and-push "${version}" "lts${variant}"
}
dry_run=false
if [ "-n" == "${1:-}" ]; then
dry_run=true
fi
if [ "$dry_run" = true ]; then
echo "Dry run, will not build or publish images"
fi
TOKEN=$(login-token)
variant=$(get-variant)
lts_version=""
version=""
for version in $(get-latest-versions); do
if is-published "$version$variant"; then
echo "Tag is already published: $version$variant"
else
echo "Publishing version: $version$variant"
if [ ! "$dry_run" = true ]; then
publish "$version" "$variant"
fi
fi
# Update lts tag
if [[ "$version" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
lts_version="${version}"
fi
done
publish-latest "${version}" "${variant}"
if [ -n "${lts_version}" ]; then
publish-lts "${lts_version}" "${variant}"
fi

View File

@ -0,0 +1,31 @@
#!/usr/bin/env bats
SUT_IMAGE=bats-jenkins
load 'test_helper/bats-support/load'
load 'test_helper/bats-assert/load'
load test_helpers
. $BATS_TEST_DIRNAME/../jenkins-support
@test "build image" {
cd $BATS_TEST_DIRNAME/..
docker_build -t $SUT_IMAGE .
}
@test "versionLT" {
run docker run --rm $SUT_IMAGE bash -c "source /usr/local/bin/jenkins-support && versionLT 1.0 1.0"
assert_failure
run docker run --rm $SUT_IMAGE bash -c "source /usr/local/bin/jenkins-support && versionLT 1.0 1.1"
assert_success
run docker run --rm $SUT_IMAGE bash -c "source /usr/local/bin/jenkins-support && versionLT 1.1 1.0"
assert_failure
run docker run --rm $SUT_IMAGE bash -c "source /usr/local/bin/jenkins-support && versionLT 1.0-beta-1 1.0"
assert_success
run docker run --rm $SUT_IMAGE bash -c "source /usr/local/bin/jenkins-support && versionLT 1.0 1.0-beta-1"
assert_failure
run docker run --rm $SUT_IMAGE bash -c "source /usr/local/bin/jenkins-support && versionLT 1.0-alpha-1 1.0-beta-1"
assert_success
run docker run --rm $SUT_IMAGE bash -c "source /usr/local/bin/jenkins-support && versionLT 1.0-beta-1 1.0-alpha-1"
assert_failure
}

View File

@ -0,0 +1,118 @@
#!/usr/bin/env bats
SUT_IMAGE=bats-jenkins
load 'test_helper/bats-support/load'
load 'test_helper/bats-assert/load'
load test_helpers
@test "build image" {
cd $BATS_TEST_DIRNAME/..
docker_build -t $SUT_IMAGE .
}
@test "plugins are installed with plugins.sh" {
run docker build -t $SUT_IMAGE-plugins $BATS_TEST_DIRNAME/plugins
assert_success
# replace DOS line endings \r\n
run bash -c "docker run --rm $SUT_IMAGE-plugins ls --color=never -1 /var/jenkins_home/plugins | tr -d '\r'"
assert_success
assert_line 'maven-plugin.jpi'
assert_line 'maven-plugin.jpi.pinned'
assert_line 'ant.jpi'
assert_line 'ant.jpi.pinned'
}
@test "plugins are installed with install-plugins.sh" {
run docker build -t $SUT_IMAGE-install-plugins $BATS_TEST_DIRNAME/install-plugins
assert_success
refute_line --partial 'Skipping already bundled dependency'
# replace DOS line endings \r\n
run bash -c "docker run --rm $SUT_IMAGE-install-plugins ls --color=never -1 /var/jenkins_home/plugins | tr -d '\r'"
assert_success
assert_line 'maven-plugin.jpi'
assert_line 'maven-plugin.jpi.pinned'
assert_line 'ant.jpi'
assert_line 'ant.jpi.pinned'
assert_line 'credentials.jpi'
assert_line 'credentials.jpi.pinned'
assert_line 'mesos.jpi'
assert_line 'mesos.jpi.pinned'
# optional dependencies
refute_line 'metrics.jpi'
refute_line 'metrics.jpi.pinned'
# plugins bundled but under detached-plugins, so need to be installed
assert_line 'javadoc.jpi'
assert_line 'javadoc.jpi.pinned'
assert_line 'mailer.jpi'
assert_line 'mailer.jpi.pinned'
}
@test "plugins are installed with install-plugins.sh even when already exist" {
run docker build -t $SUT_IMAGE-install-plugins-update --no-cache $BATS_TEST_DIRNAME/install-plugins/update
assert_success
assert_line "Using provided plugin: ant"
refute_line --partial 'Skipping already bundled dependency'
# replace DOS line endings \r\n
run bash -c "docker run --rm $SUT_IMAGE-install-plugins-update unzip -p /var/jenkins_home/plugins/maven-plugin.jpi META-INF/MANIFEST.MF | tr -d '\r'"
assert_success
assert_line 'Plugin-Version: 2.13'
}
@test "plugins are getting upgraded but not downgraded" {
# Initial execution
run docker build -t $SUT_IMAGE-install-plugins $BATS_TEST_DIRNAME/install-plugins
assert_success
local work; work="$BATS_TEST_DIRNAME/upgrade-plugins/work"
mkdir -p $work
# Image contains maven-plugin 2.7.1 and ant-plugin 1.3
run bash -c "docker run -u $UID -v $work:/var/jenkins_home --rm $SUT_IMAGE-install-plugins true"
assert_success
run unzip_manifest maven-plugin.jpi $work
assert_line 'Plugin-Version: 2.7.1'
run unzip_manifest ant.jpi $work
assert_line 'Plugin-Version: 1.3'
# Upgrade to new image with different plugins
run docker build -t $SUT_IMAGE-upgrade-plugins $BATS_TEST_DIRNAME/upgrade-plugins
assert_success
# Images contains maven-plugin 2.13 and ant-plugin 1.2
run bash -c "docker run -u $UID -v $work:/var/jenkins_home --rm $SUT_IMAGE-upgrade-plugins true"
assert_success
run unzip_manifest maven-plugin.jpi $work
assert_success
# Should be updated
assert_line 'Plugin-Version: 2.13'
run unzip_manifest ant.jpi $work
# 1.2 is older than the existing 1.3, so keep 1.3
assert_line 'Plugin-Version: 1.3'
}
@test "clean work directory" {
run bash -c "rm -rf $BATS_TEST_DIRNAME/upgrade-plugins/work"
}
@test "do not upgrade if plugin has been manually updated" {
run docker build -t $SUT_IMAGE-install-plugins $BATS_TEST_DIRNAME/install-plugins
assert_success
local work; work="$BATS_TEST_DIRNAME/upgrade-plugins/work"
mkdir -p $work
# Image contains maven-plugin 2.7.1 and ant-plugin 1.3
run bash -c "docker run -u $UID -v $work:/var/jenkins_home --rm $SUT_IMAGE-install-plugins curl --connect-timeout 20 --retry 5 --retry-delay 0 --retry-max-time 60 -s -f -L https://updates.jenkins.io/download/plugins/maven-plugin/2.12.1/maven-plugin.hpi -o /var/jenkins_home/plugins/maven-plugin.jpi"
assert_success
run unzip_manifest maven-plugin.jpi $work
assert_line 'Plugin-Version: 2.12.1'
run docker build -t $SUT_IMAGE-upgrade-plugins $BATS_TEST_DIRNAME/upgrade-plugins
assert_success
# Images contains maven-plugin 2.13 and ant-plugin 1.2
run bash -c "docker run -u $UID -v $work:/var/jenkins_home --rm $SUT_IMAGE-upgrade-plugins true"
assert_success
run unzip_manifest maven-plugin.jpi $work
assert_success
# Shouldn't be updated
refute_line 'Plugin-Version: 2.13'
}
@test "clean work directory" {
run bash -c "rm -rf $BATS_TEST_DIRNAME/upgrade-plugins/work"
}

View File

@ -0,0 +1,3 @@
FROM bats-jenkins
RUN /usr/local/bin/install-plugins.sh maven-plugin:2.7.1 ant:1.3 mesos:0.13.0

View File

@ -0,0 +1,3 @@
FROM bats-jenkins-install-plugins
RUN /usr/local/bin/install-plugins.sh maven-plugin:2.13 ant:1.3

View File

@ -0,0 +1,4 @@
FROM bats-jenkins
COPY plugins.txt /usr/share/jenkins/ref/
RUN /usr/local/bin/plugins.sh /usr/share/jenkins/ref/plugins.txt

View File

@ -0,0 +1,2 @@
maven-plugin:2.7.1
ant:1.3

View File

@ -0,0 +1,56 @@
#!/usr/bin/env bats
SUT_IMAGE=bats-jenkins
SUT_CONTAINER=bats-jenkins
load 'test_helper/bats-support/load'
load 'test_helper/bats-assert/load'
load test_helpers
@test "build image" {
cd $BATS_TEST_DIRNAME/..
docker_build -t $SUT_IMAGE .
}
@test "clean test containers" {
cleanup $SUT_CONTAINER
}
@test "test multiple JENKINS_OPTS" {
# running --help --version should return the version, not the help
local version=$(grep 'ENV JENKINS_VERSION' Dockerfile | sed -e 's/.*:-\(.*\)}/\1/')
# need the last line of output
assert "${version}" docker run --rm -e JENKINS_OPTS="--help --version" --name $SUT_CONTAINER -P $SUT_IMAGE | tail -n 1
}
@test "test jenkins arguments" {
# running --help --version should return the version, not the help
local version=$(grep 'ENV JENKINS_VERSION' Dockerfile | sed -e 's/.*:-\(.*\)}/\1/')
# need the last line of output
assert "${version}" docker run --rm --name $SUT_CONTAINER -P $SUT_IMAGE --help --version | tail -n 1
}
@test "create test container" {
docker run -d -e JAVA_OPTS="-Duser.timezone=Europe/Madrid -Dhudson.model.DirectoryBrowserSupport.CSP=\"default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline';\"" --name $SUT_CONTAINER -P $SUT_IMAGE
}
@test "test container is running" {
sleep 1 # give time to eventually fail to initialize
retry 3 1 assert "true" docker inspect -f {{.State.Running}} $SUT_CONTAINER
}
@test "Jenkins is initialized" {
retry 30 5 test_url /api/json
}
@test "JAVA_OPTS are set" {
local sed_expr='s/<wbr>//g;s/<td class="pane">.*<\/td><td class.*normal">//g;s/<t.>//g;s/<\/t.>//g'
assert 'default-src &#039;self&#039;; script-src &#039;self&#039; &#039;unsafe-inline&#039; &#039;unsafe-eval&#039;; style-src &#039;self&#039; &#039;unsafe-inline&#039;;' \
bash -c "curl -fsSL --user \"admin:$(get_jenkins_password)\" $(get_jenkins_url)/systemInfo | sed 's/<\/tr>/<\/tr>\'$'\n/g' | grep '<td class=\"pane\">hudson.model.DirectoryBrowserSupport.CSP</td>' | sed -e '${sed_expr}'"
assert 'Europe/Madrid' \
bash -c "curl -fsSL --user \"admin:$(get_jenkins_password)\" $(get_jenkins_url)/systemInfo | sed 's/<\/tr>/<\/tr>\'$'\n/g' | grep '<td class=\"pane\">user.timezone</td>' | sed -e '${sed_expr}'"
}
@test "clean test containers" {
cleanup $SUT_CONTAINER
}

View File

@ -0,0 +1,84 @@
#!/bin/bash
# check dependencies
(
type docker &>/dev/null || ( echo "docker is not available"; exit 1 )
type curl &>/dev/null || ( echo "curl is not available"; exit 1 )
)>&2
# Assert that $1 is the outputof a command $2
function assert {
local expected_output=$1
shift
local actual_output
actual_output=$("$@")
actual_output="${actual_output//[$'\t\r\n']}" # remove newlines
if ! [ "$actual_output" = "$expected_output" ]; then
echo "expected: \"$expected_output\""
echo "actual: \"$actual_output\""
false
fi
}
# Retry a command $1 times until it succeeds. Wait $2 seconds between retries.
function retry {
local attempts=$1
shift
local delay=$1
shift
local i
for ((i=0; i < attempts; i++)); do
run "$@"
if [ "$status" -eq 0 ]; then
return 0
fi
sleep $delay
done
echo "Command \"$*\" failed $attempts times. Status: $status. Output: $output" >&2
false
}
function docker_build {
if [ -n "$JENKINS_VERSION" ]; then
docker build --build-arg JENKINS_VERSION=$JENKINS_VERSION --build-arg JENKINS_SHA=$JENKINS_SHA "$@"
else
docker build "$@"
fi
}
function get_jenkins_url {
if [ -z "${DOCKER_HOST}" ]; then
DOCKER_IP=localhost
else
DOCKER_IP=$(echo "$DOCKER_HOST" | sed -e 's|tcp://\(.*\):[0-9]*|\1|')
fi
echo "http://$DOCKER_IP:$(docker port "$SUT_CONTAINER" 8080 | cut -d: -f2)"
}
function get_jenkins_password {
docker logs "$SUT_CONTAINER" 2>&1 | grep -A 2 "Please use the following password to proceed to installation" | tail -n 1
}
function test_url {
run curl --user "admin:$(get_jenkins_password)" --output /dev/null --silent --head --fail --connect-timeout 30 --max-time 60 "$(get_jenkins_url)$1"
if [ "$status" -eq 0 ]; then
true
else
echo "URL $(get_jenkins_url)$1 failed" >&2
echo "output: $output" >&2
false
fi
}
function cleanup {
docker kill "$1" &>/dev/null ||:
docker rm -fv "$1" &>/dev/null ||:
}
function unzip_manifest {
local plugin=$1
local work=$2
bash -c "docker run --rm -v $work:/var/jenkins_home --entrypoint unzip $SUT_IMAGE -p /var/jenkins_home/plugins/$plugin META-INF/MANIFEST.MF | tr -d '\r'"
}

View File

@ -0,0 +1,3 @@
FROM bats-jenkins
RUN /usr/local/bin/install-plugins.sh maven-plugin:2.13 ant:1.2

Some files were not shown because too many files have changed in this diff Show More