Compare commits

...

295 Commits

Author SHA1 Message Date
c5105c29b6 Merge pull request #834 from xbojch/libicu-dev-not-found
Run apt-get update before installing intl extension
2017-04-20 13:46:02 -04:00
4dda815980 upgrade base images for php-fpm and workspace.
These duplicated Dockerfiles will be merged onto single Dockerfile
later. The same Dockerfile will check for the PHP version variable
and install the necessary softwar's accordingly.
2017-04-20 13:45:04 -04:00
a6ff3d0666 Merge pull request #831 from bestlong/fix-pgadmin-host-name-not-resolve
Fixing Unable to connect to postgresql server
2017-04-20 13:14:52 -04:00
0549936547 Fixing Unable to connect to postgresql server 2017-04-20 20:25:14 +08:00
407353e6eb Run apt-get update before installing intl extension 2017-04-20 13:46:38 +02:00
f30e36bc93 Merge pull request #825 from bestlong/install-all-ext-for-ci-build
Install all ext to run CI build.
2017-04-18 11:32:51 -04:00
b9716e7fef Merge pull request #821 from computerfr33k/master
Revert to Hugo v0.19
2017-04-18 11:30:53 -04:00
cc520c18b5 Install all ext to run CI build. 2017-04-18 15:07:27 +08:00
c67fa5b258 Fixing could not resolve host: elasticsearch (#823) 2017-04-18 12:23:44 +08:00
3d6b6ba271 Included Percona in the docs (#820) 2017-04-18 12:17:39 +08:00
677b9170ca Fixing type and markdown syntax. (#822) 2017-04-18 12:16:22 +08:00
92511ab8a8 Revert to Hugo v0.19
v0.20 is not working properly with the current site.
2017-04-17 20:03:57 -05:00
5b9dd242f3 Merge pull request #819 from dtunes/master
Added percona container
2017-04-17 19:52:04 -04:00
a91bd19739 Merge branch 'master' of https://github.com/laradock/laradock 2017-04-18 10:27:37 +12:00
ba32dedbef Added Percona container as an alternative to mysql mariadb 2017-04-18 10:19:09 +12:00
df87c3e36b Merge pull request #817 from laradock/winfried-van-loon-patch-1
Fixing typo in docs menu
2017-04-17 17:16:26 -04:00
425d344e97 Fixing typo in docs menu 2017-04-17 18:37:01 +02:00
73ebc1effa Merge pull request #815 from bestlong/fix-adminer-login-fail
Fixing Adminer can’t login
2017-04-17 11:22:50 -04:00
bb8bf6ae10 Merge pull request #812 from bestlong/add-travis-ci-build-status-image
Add Travis CI status image.
2017-04-17 11:22:33 -04:00
5f3e0a9109 Fixing Adminer can’t login 2017-04-17 13:40:30 +08:00
f7090a47a4 Add Travis CI status image. 2017-04-17 10:48:07 +08:00
8ffb0ff3e3 Merge pull request #810 from wxb/master
set data save path(mysql/redis/memcached..)
2017-04-16 11:51:32 -04:00
wxb
f14b3b32cf add php.ini file 2017-04-16 19:33:27 +08:00
wxb
3a8bd8a015 add data save path(mysql/redis/memcached..) 2017-04-16 19:08:03 +08:00
efc23a693d add missing workspace tools to the docs 2017-04-14 21:02:04 -04:00
1235304a0d add missing containers to the docs 2017-04-14 20:02:27 -04:00
13952f3468 fix docs images url on the site 2017-04-14 17:58:10 -04:00
4a88cbc17a add logo and update some texts 2017-04-14 17:46:35 -04:00
dc71a125c3 testing travis doc generate 2017-04-14 14:55:45 -04:00
5d1660567c rename the travis build scrit and update the new doc path 2017-04-14 14:54:47 -04:00
57ee5d96a4 travis for docker build and hugo site 2017-04-14 14:52:54 -04:00
919e0a75cd Delet the _settings folder from the Documentation 2017-04-14 14:43:28 -04:00
43ace2bebe update contrubition docs 2017-04-14 14:37:31 -04:00
07ad461e75 fix travis CI integration to generate Hugo Site 2017-04-14 14:30:39 -04:00
9f4aaa9bc7 fix deploy local_dir. 2017-04-14 12:56:18 -05:00
ae01a9fd49 Fix the if statements for checking if env is set. 2017-04-14 12:31:09 -05:00
94a383bea9 Forgot to make script executable. Oops 2017-04-14 12:19:56 -05:00
375f733def Use Travis CI for building docker images and docs 2017-04-14 12:15:10 -05:00
74efa008da regenerate site 2017-04-14 04:44:50 -04:00
5a496bafeb move _guides to the documentation 2017-04-14 04:43:26 -04:00
3a7e6e4b1a add travis file to auto generated documentation 2017-04-14 03:55:08 -04:00
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
1c7e2e7d85 Merge pull request #684 from laradock/revert-639-master
Revert "Add apache conf file for specific virtualhost ServerName"
2017-03-16 14:41:12 -04:00
1d6583e97e Revert "Add apache conf file for specific virtualhost ServerName" 2017-03-16 14:40:45 -04:00
1cf5bcde62 Merge pull request #682 from MauricioTRS/master
Elasticsearch - Fix plugins directory
2017-03-16 13:35:24 -04:00
db40c67f75 Merge pull request #639 from tiknil/master
Add apache conf file for specific virtualhost ServerName
2017-03-16 13:30:14 -04:00
e10ba9fa9f Merge pull request #617 from alchimik/patch-1
don't load opcache extension twice
2017-03-16 13:28:28 -04:00
a42a295951 Merge pull request #485 from AliveCorpse/feature/workspace_with_php_7.1
Add dokerfile with php 7.1
2017-03-16 13:26:36 -04:00
0678415663 Merge pull request #484 from AliveCorpse/feature/php_fpm_v7.1
Add dockerfile with php-fpm 7.1
2017-03-16 13:26:14 -04:00
73a3745cc3 Merge pull request #370 from philtrep/certbot
Certbot container
2017-03-16 13:25:15 -04:00
bed0fd9bdb Elasticsearch - Fix plugins directory 2017-03-16 14:24:56 -03:00
3f1d4b70a6 Merge pull request #650 from wayanjimmy/feature/mailhog
Add mailhog for mail debugging
2017-03-16 13:23:28 -04:00
218ffe641e Merge pull request #659 from thorerik/fix-issue-619
Fix issue 619
2017-03-16 13:21:17 -04:00
be39e93ea2 Merge pull request #672 from cabrerabywaters/GOHSTSCRIPT_SUPPORT
Gohstscript support
2017-03-16 13:11:08 -04:00
783c9321c9 Merge pull request #679 from davidvleung/master
Refine container name retrieval
2017-03-16 13:10:00 -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
735647bdf7 Refine container definition
Changed to `docker ps` because this one word wraps.  `docker-compose ps` will create a newline if text is too long in a small terminal window.  Also `awk` represents tokens better than ones created with a " " delimiter.
2017-03-15 13:51:54 -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
9c14954ff4 Adding GHOSTSCRIPT support 2017-03-14 10:59:38 -03:00
fd0cbff16c Adding ARG to docker-compose 2017-03-14 10:58:35 -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
1a80385a48 change some desgins in the docs site 2017-03-10 13:48:13 -05: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
048b55186e Fix issue 619 2017-03-08 09:26:08 +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
48710f19c3 Sync with master 2017-03-04 02:10:34 +08:00
0983cc98fe Setup mailhog 2017-03-04 02:07:29 +08:00
6be81f05c2 - Aggiunto servizio php-worker per avviamento queue 2017-03-02 12:14:38 +01:00
8317fbde5c - Eliminato .env dal repo git per poterlo linkare nel progetto locale
- Impostata configurazione dinamica porte per apache
2017-03-01 15:55:33 +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
4947dfaad1 - Add apache conf file for specific virtualhost ServerName 2017-02-25 21:25:33 +01:00
7b542618f0 Update opcache.ini 2017-02-19 13:26:18 +08:00
aabe504c24 Add dokerfile with php 7.1 2016-12-15 15:13:00 +02:00
b401c517b2 Add dockerfile with php-fpm 7.1 2016-12-15 15:05:48 +02:00
d89a944e22 Added nginx config for certbot 2016-11-14 11:29:44 -05:00
48f8f3c02d Added certbot serving in laravel conf 2016-11-14 11:27:39 -05:00
4030cc2f26 Added certbot container 2016-11-14 11:27:37 -05:00
184 changed files with 12151 additions and 3352 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

25
.travis.yml Normal file
View File

@ -0,0 +1,25 @@
language: bash
sudo: required
services:
- docker
env:
matrix:
- PHP_VERSION=56
- PHP_VERSION=70
- PHP_VERSION=71
- HUGO_VERSION=0.19
script: ./_scripts/travis-build.sh
deploy:
provider: pages
skip_cleanup: true
local_dir: docs
github_token: $GITHUB_TOKEN
on:
branch: master
condition: -n "${HUGO_VERSION}"
notifications:
email: false

View File

@ -1,7 +1,7 @@
baseurl = "http://laradock.io/"
languageCode = "en-us"
publishDir = "../"
title = "Laradock Docs"
publishDir = "../docs"
title = "Laradock"
theme = "hugo-material-docs"
metadataformat = "yaml"
canonifyurls = true
@ -11,15 +11,15 @@ googleAnalytics = "UA-37514928-9"
[params]
# General information
author = "Mahmoud Zalt"
description = "Laradock documentations."
description = "Full PHP development environment for Docker."
copyright = ""
# Repository
provider = "GitHub"
repo_url = "https://github.com/laradock/laradock"
provider = ""
repo_url = ""
version = ""
logo = ""
logo = "images/logo.png"
favicon = ""
permalink = "#"
@ -32,8 +32,8 @@ googleAnalytics = "UA-37514928-9"
highlight_css = ""
[params.palette]
primary = "purple"
accent = "deep-purple"
primary = "deep-purple"
accent = "purple"
[params.font]
text = "Doctarine"
@ -41,7 +41,7 @@ googleAnalytics = "UA-37514928-9"
[social]
twitter = ""
github = "laradock"
github = "laradock/laradock"
email = ""
# ------- MENU START -----------------------------------------
@ -62,8 +62,8 @@ googleAnalytics = "UA-37514928-9"
weight = 3
[[menu.main]]
name = "Related Projects"
url = "related-projects/"
name = "Guides"
url = "guides/"
weight = 4
[[menu.main]]
@ -71,15 +71,20 @@ googleAnalytics = "UA-37514928-9"
url = "help/"
weight = 5
[[menu.main]]
name = "Related Projects"
url = "related-projects/"
weight = 6
[[menu.main]]
name = "Contributing"
url = "contributing/"
weight = 6
weight = 7
[[menu.main]]
name = "License"
url = "license/"
weight = 7
weight = 8
# ------- MENU END -----------------------------------------

View File

@ -1,47 +1,65 @@
---
title: Contributing
type: index
weight: 6
weight: 7
---
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.*
## Edit the documentation
## 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.
Go the `DOCUMENTATION/content` and search for the markdown file you want to edit
Note: Every folder represents a section in the sidebar "Menu". And every page and sidebar has a `weight` number to show it's position in the site.
To update the sidebar or add a new section to it, you can edit this `DOCUMENTATION/config.toml` toml file.
> The site will be auto-generated in the `docs/` folder by [Travis CI](https://travis-ci.org/laradock/laradock/).
<br>
### To Host the website locally
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 secion 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..
2. Edit the `DOCUMENTATION/content`.
3. Delete the `/docs` folder from the root.
4. After you finish the editing, go to `DOCUMENTATION/` and run the `hugo` command to generate the HTML docs (inside a new `/docs` folder).
## Coding Guidelines
## Support new Software
## How to support new Software (Add new Container)
* Create folder with the software name.
@ -53,30 +71,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 +97,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 +134,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 +167,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,209 @@
---
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 [this list](http://laradock.io/introduction/#supported-software-images).
*(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

@ -1,49 +1,293 @@
# PHPStorm Debugging Guide
---
title: Guides
type: index
weight: 4
---
* [Production Setup on Digital Ocean](#Digital-Ocean)
* [PHPStorm XDebug Setup](#PHPStorm-Debugging)
<a name="Digital-Ocean"></a>
# Production Setup on Digital Ocean
## Install Docker
- 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 may be prompted for a password. Type the one you found within your e-mailbox. It'll then ask you to change the password.
You can now check if Docker is available:
```
$root@server:~# docker
```
## Set Up Your Laravel Project
```
$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@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@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 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@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 by visiting the IP address of your server in your browser. For example:
```
http://192.168.1.1
```
It should show you the Laravel default welcome page.
However, we want it to show up using your custom domain name, as well.
## Using Your Own Domain Name
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
```
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@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)
```
listen 80;
listen [::]:80 ipv6only=on;
server_name yourdomain.com;
```
## Rebuild Your 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@server:~/laravel/laradock/nginx# docker-compose up -d nginx mysql
```
**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**
To go Caddy Folders and Edit CaddyFile
```
$root@server:~/laravel/laradock# cd caddy
$root@server:~/laravel/laradock/caddy# vim Caddyfile
```
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 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
```
$root@server:~/laravel/laradock/caddy# docker-compose up caddy
```
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...
caddy_1 | Your sites will be served over HTTPS automatically using Let's Encrypt.
caddy_1 | By continuing, you agree to the Let's Encrypt Subscriber Agreement at:
caddy_1 | https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf
caddy_1 | Activating privacy features... done.
caddy_1 | https://yourdomain.com
caddy_1 | http://yourdomain.com
```
After it finishes, press `Ctrl` + `C` to exit.
## Stop All Containers and ReRun Caddy and Other Containers on Background
```
$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**
>References:
>
- [https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-16-04](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-16-04)
- [https://www.digitalocean.com/products/one-click-apps/docker/](https://www.digitalocean.com/products/one-click-apps/docker/)
- [https://docs.docker.com/engine/installation/linux/ubuntulinux/](https://docs.docker.com/engine/installation/linux/ubuntulinux/)
- [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/)
- [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)
<br>
<br>
<br>
<br>
<br>
<a name="PHPStorm-Debugging"></a>
# PHPStorm XDebug Setup
- [Intro](#Intro)
- [Installation](#Installation)
- [Customize laradock/docker-compose.yml](#CustomizeDockerCompose)
- [Clean House](#InstallCleanHouse)
- [LaraDock Dial Tone](#InstallLaraDockDialTone)
- [hosts](#AddToHosts)
- [Firewall](#FireWall)
- [Customize laradock/docker-compose.yml](#CustomizeDockerCompose)
- [Clean House](#InstallCleanHouse)
- [LaraDock Dial Tone](#InstallLaraDockDialTone)
- [hosts](#AddToHosts)
- [Firewall](#FireWall)
- [Enable xDebug on php-fpm](#enablePhpXdebug)
- [PHPStorm Settings](#InstallPHPStorm)
- [Configs](#InstallPHPStormConfigs)
- [Usage](#Usage)
- [Laravel](#UsageLaravel)
- [Run ExampleTest](#UsagePHPStormRunExampleTest)
- [Debug ExampleTest](#UsagePHPStormDebugExampleTest)
- [Debug Web Site](#UsagePHPStormDebugSite)
- [SSH into workspace](#SSHintoWorkspace)
- [KiTTY](#InstallKiTTY)
- [Laravel](#UsageLaravel)
- [Run ExampleTest](#UsagePHPStormRunExampleTest)
- [Debug ExampleTest](#UsagePHPStormDebugExampleTest)
- [Debug Web Site](#UsagePHPStormDebugSite)
- [SSH into workspace](#SSHintoWorkspace)
- [KiTTY](#InstallKiTTY)
<a name="Intro"></a>
## Intro
Wiring up [Laravel](https://laravel.com/), [LaraDock](https://github.com/LaraDock/laradock) [Laravel+Docker] and [PHPStorm](https://www.jetbrains.com/phpstorm/) to play nice together complete with remote xdebug'ing as icing on top! Although this guide is based on `PHPStorm Windows`,
Wiring up [Laravel](https://laravel.com/), [LaraDock](https://github.com/LaraDock/laradock) [Laravel+Docker] and [PHPStorm](https://www.jetbrains.com/phpstorm/) to play nice together complete with remote xdebug'ing as icing on top! Although this guide is based on `PHPStorm Windows`,
you should be able to adjust accordingly. This guide was written based on Docker for Windows Native.
<a name="Installation"></a>
## Installation
- This guide assumes the following:
- you have already installed and are familiar with Laravel, LaraDock and PHPStorm.
- you have installed Laravel as a parent of `laradock`. This guide assumes `/c/_dk/laravel`.
- you have already installed and are familiar with Laravel, LaraDock and PHPStorm.
- you have installed Laravel as a parent of `laradock`. This guide assumes `/c/_dk/laravel`.
<a name="AddToHosts"></a>
## hosts
- Add `laravel` to your hosts file located on Windows 10 at `C:\Windows\System32\drivers\etc\hosts`. It should be set to the IP of your running container. Mine is: `10.0.75.2`
On Windows you can find it by opening Windows `Hyper-V Manager`.
- ![Windows Hyper-V Manager](photos/PHPStorm/Settings/WindowsHyperVManager.png)
- [Hosts File Editor](https://github.com/scottlerch/HostsFileEditor) makes it easy to change your hosts file.
- Set `laravel` to your docker host IP. See [Example](photos/SimpleHostsEditor/AddHost_laravel.png).
<a name="FireWall"></a>
## Firewall
Your PHPStorm will need to be able to receive a connection from PHP xdebug either your running workspace or php-fpm containers on port 9000. This means that your Windows Firewall should either enable connections from the Application PHPStorm OR the port.
Your PHPStorm will need to be able to receive a connection from PHP xdebug either your running workspace or php-fpm containers on port 9000. This means that your Windows Firewall should either enable connections from the Application PHPStorm OR the port.
- It is important to note that if the Application PHPStorm is NOT enabled in the firewall, you will not be able to recreate a rule to override that.
- Also be aware that if you are installing/upgrade different versions of PHPStorm, you MAY have orphaned references to PHPStorm in your Firewall! You may decide to remove orphaned references however in either case, make sure that they are set to receive public TCP traffic.
@ -51,7 +295,7 @@ Your PHPStorm will need to be able to receive a connection from PHP xdebug eithe
### Edit laradock/docker-compose.yml
Set the following variables:
```
### Workspace Utilities Container ###########################
### Workspace Utilities Container ###############
workspace:
build:
@ -60,9 +304,9 @@ Set the following variables:
- INSTALL_XDEBUG=true
- INSTALL_WORKSPACE_SSH=true
...
### PHP-FPM Container #######################################
### PHP-FPM Container #####################
php-fpm:
build:
@ -70,7 +314,7 @@ Set the following variables:
args:
- INSTALL_XDEBUG=true
...
```
### Edit xdebug.ini files
@ -91,13 +335,13 @@ xdebug.cli_color=1
Make sure you are starting with a clean state. For example, do you have other LaraDock containers and images?
Here are a few things I use to clean things up.
- Delete all containers using `grep laradock_` on the names, see: [Remove all containers based on docker image name](https://linuxconfig.org/remove-all-containners-based-on-docker-image-name).
- Delete all containers using `grep laradock_` on the names, see: [Remove all containers based on docker image name](https://linuxconfig.org/remove-all-containners-based-on-docker-image-name).
`docker ps -a | awk '{ print $1,$2 }' | grep laradock_ | awk '{print $1}' | xargs -I {} docker rm {}`
- Delete all images containing `laradock`.
`docker images | awk '{print $1,$2,$3}' | grep laradock_ | awk '{print $3}' | xargs -I {} docker rmi {}`
**Note:** This will only delete images that were built with `LaraDock`, **NOT** `laradock/*` which are pulled down by `LaraDock` such as `laradock/workspace`, etc.
**Note:** Some may fail with:
**Note:** Some may fail with:
`Error response from daemon: conflict: unable to delete 3f38eaed93df (cannot be forced) - image has dependent child images`
- I added this to my `.bashrc` to remove orphaned images.
@ -107,7 +351,7 @@ Here are a few things I use to clean things up.
if [ -n "$processes" ]; thend
docker rm $processes
fi
images=`docker images -q -f dangling=true`
if [ -n "$images" ]; then
docker rmi $images
@ -140,13 +384,13 @@ alias dcleanlaradock=dcleanlaradockfunction
```
<a name="InstallLaraDockDialTone"></a>
#### Let's get a dial-tone with Laravel
## Let's get a dial-tone with Laravel
```
# barebones at this point
docker-compose up -d nginx mysql
# run
# run
docker-compose ps
# Should see:
@ -163,7 +407,7 @@ laradock_workspace_1 /sbin/my_init Up 0.0.0.0:2222-
```
<a name="enablePhpXdebug"></a>
#### Enable xDebug on php-fpm
## Enable xDebug on php-fpm
In a host terminal sitting in the laradock folder, run: `./xdebugPhpFpm status`
You should see something like the following:
```
@ -181,39 +425,39 @@ If you have enabled `xdebug=true` in `docker-compose.yml/php-fpm`, `xdebug` will
<a name="InstallPHPStormConfigs"></a>
#### PHPStorm Settings
## PHPStorm Settings
- Here are some settings that are known to work:
- `Settings/BuildDeploymentConnection`
- ![Settings/BuildDeploymentConnection](photos/PHPStorm/Settings/BuildDeploymentConnection.png)
- `Settings/BuildDeploymentConnectionMappings`
- ![Settings/BuildDeploymentConnectionMappings](photos/PHPStorm/Settings/BuildDeploymentConnectionMappings.png)
- `Settings/BuildDeploymentDebugger`
- ![Settings/BuildDeploymentDebugger](photos/PHPStorm/Settings/BuildDeploymentDebugger.png)
- `Settings/EditRunConfigurationRemoteWebDebug`
- ![Settings/EditRunConfigurationRemoteWebDebug](photos/PHPStorm/Settings/EditRunConfigurationRemoteWebDebug.png)
- `Settings/EditRunConfigurationRemoteExampleTestDebug`
- ![Settings/EditRunConfigurationRemoteExampleTestDebug](photos/PHPStorm/Settings/EditRunConfigurationRemoteExampleTestDebug.png)
- `Settings/LangsPHPDebug`
- ![Settings/LangsPHPDebug](photos/PHPStorm/Settings/LangsPHPDebug.png)
- `Settings/LangsPHPInterpreters`
- ![Settings/LangsPHPInterpreters](photos/PHPStorm/Settings/LangsPHPInterpreters.png)
- `Settings/LangsPHPPHPUnit`
- ![Settings/LangsPHPPHPUnit](photos/PHPStorm/Settings/LangsPHPPHPUnit.png)
- `Settings/LangsPHPServers`
- ![Settings/LangsPHPServers](photos/PHPStorm/Settings/LangsPHPServers.png)
- `RemoteHost`
To switch on this view, go to: `Menu/Tools/Deployment/Browse Remote Host`.
- ![RemoteHost](photos/PHPStorm/RemoteHost.png)
- `RemoteWebDebug`
- ![DebugRemoteOn](photos/PHPStorm/DebugRemoteOn.png)
@ -258,14 +502,14 @@ If you have enabled `xdebug=true` in `docker-compose.yml/php-fpm`, `xdebug` will
<a name="UsagePHPStormDebugSite"></a>
### Debug WebSite
- In case xDebug is disabled, from the `laradock` folder run:
- In case xDebug is disabled, from the `laradock` folder run:
`./xdebugPhpFpm start`.
- To switch xdebug off, run:
- To switch xdebug off, run:
`./xdebugPhpFpm stop`
- Start Remote Debugging
- ![DebugRemoteOn](photos/PHPStorm/DebugRemoteOn.png)
- Open to edit: `bootstrap/app.php`
- Add a BreakPoint on line 14: `$app = new Illuminate\Foundation\Application(`
- Reload [Laravel Site](http://laravel/)
@ -274,7 +518,7 @@ If you have enabled `xdebug=true` in `docker-compose.yml/php-fpm`, `xdebug` will
<a name="SSHintoWorkspace"></a>
#### Let's shell into workspace
## Let's shell into workspace
Assuming that you are in laradock folder, type:
`ssh -i workspace/insecure_id_rsa -p2222 root@laravel`
**Cha Ching!!!!**
@ -285,7 +529,7 @@ Assuming that you are in laradock folder, type:
<a name="InstallKiTTY"></a>
##### KiTTY
### KiTTY
[Kitty](http://www.9bis.net/kitty/) KiTTY is a fork from version 0.67 of PuTTY.
- Here are some settings that are working for me:

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

@ -0,0 +1,166 @@
---
title: Introduction
type: index
weight: 1
---
A full PHP development environment for Docker.
Includes pre-packaged Docker Images, all pre-configured to provide a wonderful PHP development environment.
Laradock is well known in the Laravel community, as the project started with single focus on running Laravel projects on Docker. Later and due to the large adoption from the PHP community, it started supporting other PHP projects like Symfony, CodeIgniter, WordPress, Drupal...
![](https://s19.postimg.org/jblfytw9f/laradock-logo.jpg)
## Quick Overview
Let's see how easy it is to install `NGINX`, `PHP`, `Composer`, `MySQL`, `Redis` and `Beanstalkd`:
1 - Clone Laradock inside your PHP project:
```shell
git clone https://github.com/Laradock/laradock.git
```
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
```
4 - Open your project's `.env` file and set the following:
```shell
DB_HOST=mysql
REDIS_HOST=redis
QUEUE_HOST=beanstalkd
```
5 - Open your browser and visit localhost: `http://localhost`.
```shell
That's it! enjoy :)
```
<a name="features"></a>
## Features
- Easy switch between PHP versions: 7.1, 7.0, 5.6...
- Choose your favorite database engine: MySQL, Postgres, MariaDB...
- Run your own combination of software: Memcached, HHVM, Beanstalkd...
- Every software runs on a separate container: PHP-FPM, NGINX, PHP-CLI...
- Easy to customize any container, with simple edit to the `Dockerfile`.
- All Images extends from an official base Image. (Trusted base Images).
- Pre-configured NGINX to host any code at your root directory.
- Can use Laradock per project, or single Laradock for all projects.
- Easy to install/remove software's in Containers using environment variables.
- Clean and well structured Dockerfiles (`Dockerfile`).
- Latest version of the Docker Compose file (`docker-compose`).
- Everything is visible and editable.
- Fast Images Builds.
- More to come every week..
<a name="Supported-Containers"></a>
## Supported Software (Images)
In adhering to the separation of concerns principle as promoted by Docker, Laradock runs each software on its own Container.
You can turn On/Off as many instances of as any container without worrying about the configurations, everything works like a charm.
- **Database Engines:**
MySQL - MariaDB - Percona - MongoDB - Neo4j - RethinkDB - MSSQL - PostgreSQL - Postgres Postgis.
- **Cache Engines:**
Redis - Memcached - Aerospike
- **PHP Servers:**
NGINX - Apache2 - Caddy
- **PHP Compilers:**
PHP FPM - HHVM
- **Message Queuing:**
Beanstalkd - Beanstalkd Console - RabbitMQ - RabbitMQ Console - PHP Worker
- **Tools:**
HAProxy - Jenkins - ElasticSearch - Selenium - Certbot - Mailhog - Minio - Varnish - PhpMyAdmin - Adminer - PgAdmin - MailHog...
Laradock introduces the **Workspace** Image, as a development environment.
It contains a rich set of helpful tools, all pre-configured to work and integrate with almost any combination of Containers and tools you may choose.
**Workspace Image Tools**
PHP CLI - Composer - Git - Linuxbrew - Node - V8JS - Gulp - SQLite - xDebug - Envoy - Deployer - Vim - Yarn - SOAP - Drush...
You can choose, which tools to install in your workspace container and other containers, from the `.env` file.
> If you modify `docker-compose.yml`, `.env` or any `dockerfile` file, you must re-build your containers, to see those effects in the running instance.
If you can't find your Software in the list, build it yourself and sumit it. Contributions are welcomed :)
<a name="what-is-docker"></a>
## What is Docker?
[Docker](https://www.docker.com) is an open-source project that automates the deployment of applications inside software containers, by providing an additional layer of abstraction and automation of [operating-system-level virtualization](https://en.wikipedia.org/wiki/Operating-system-level_virtualization) on Linux, Mac OS and Windows.
<a name="why-docker-not-vagrant"></a>
## Why Docker not Vagrant!?
[Vagrant](https://www.vagrantup.com) creates Virtual Machines in minutes while Docker creates Virtual Containers in seconds.
Instead of providing a full Virtual Machines, like you get with Vagrant, Docker provides you **lightweight** Virtual Containers, that share the same kernel and allow to safely execute independent processes.
In addition to the speed, Docker gives tons of features that cannot be achieved with Vagrant.
Most importantly Docker can run on Development and on Production (same environment everywhere). While Vagrant is designed for Development only, (so you have to re-provision your server on Production every time).
<a name="Demo"></a>
## Demo Video
What's better than a **Demo Video**:
- Laradock v5.* (soon or never)
- 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)
<a name="Chat"></a>
## Chat with us
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)

View File

@ -1,7 +1,7 @@
---
title: License
type: index
weight: 7
weight: 8
---
[MIT License](https://github.com/laradock/laradock/blob/master/LICENSE) (MIT)

View File

@ -1,13 +1,13 @@
---
title: Related Projects
type: index
weight: 4
weight: 6
---
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

@ -37,7 +37,9 @@
Documentation built with
<a href="https://www.gohugo.io" target="_blank">Hugo</a>
using the
<a href="http://github.com/digitalcraftsman/hugo-material-docs" target="_blank">Material</a> theme.
<a href="http://github.com/digitalcraftsman/hugo-material-docs" target="_blank">Material</a> theme,
by
<a href="https://zalt.me">Mahmoud Zalt</a>.
</aside>
<footer class="footer">

View File

@ -6,13 +6,13 @@
<img src="{{ $.Site.BaseURL }}{{ . }}">
</div>
{{ end }}
<div class="name">
<strong>{{ .Site.Title }} {{ with .Site.Params.version }}<span class="version">{{ . }}</span>{{ end }}</strong>
{{ with .Scratch.Get "repo_id" }}
<br>
{{ . }}
{{ end }}
</div>
<!--<div class="name">-->
<!--<strong>{{ .Site.Title }} {{ with .Site.Params.version }}<span class="version">{{ . }}</span>{{ end }}</strong>-->
<!--{{ with .Scratch.Get "repo_id" }}-->
<!--<br>-->
<!--{{ . }}-->
<!--{{ end }}-->
<!--</div>-->
</div>
</a>
@ -43,8 +43,8 @@
{{ end }}
{{ if isset .Site.Params "author" }}
<hr>
<span class="section">The author</span>
<!--<hr>-->
<!--<span class="section">The author</span>-->
<ul>
{{ with .Site.Social.twitter }}
@ -55,13 +55,13 @@
</li>
{{ end }}
{{ with .Site.Social.github }}
<li>
<a href="https://github.com/{{ . }}" target="_blank" title="@{{ . }} on GitHub">
@{{ . }} on GitHub
</a>
</li>
{{ end }}
<!--{{ with .Site.Social.github }}-->
<!--<li>-->
<!--<a href="https://github.com/{{ . }}" target="_blank" title="@{{ . }} on GitHub">-->
<!--@{{ . }} on GitHub-->
<!--</a>-->
<!--</li>-->
<!--{{ end }}-->
{{ with .Site.Social.email }}
<li>

View File

@ -7,7 +7,7 @@
</div>
<div class="stretch">
<div class="title">
{{ .Title }}
<b>{{ .Site.Title }}</b> <span style="color: rgba(249, 245, 255, 0.63);"> / {{ .Title }}</span>
</div>
</div>
@ -19,8 +19,9 @@
{{ with .Site.Social.github }}
<div class="button button-github" role="button" aria-label="GitHub">
<a href="https://github.com/{{ . }}" title="@{{ . }} on GitHub" target="_blank" class="toggle-button icon icon-github"></a>
<a style="padding: 0px; font-size:40px" href="https://github.com/{{ . }}" title="@{{ . }} on GitHub" target="_blank" class="toggle-button icon icon-github"></a>
</div>
<p style="font-size: 18px; padding: 8px">Github</p>
{{ end }}
<!-- TODO: disabled until Hugo supports the generation of a content index natively
@ -42,4 +43,4 @@
<button class="toggle-button icon icon-close" id="reset-search"></button>
</div>
</div>
</nav>
</nav>

View File

Before

Width:  |  Height:  |  Size: 4.3 KiB

After

Width:  |  Height:  |  Size: 4.3 KiB

View File

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 142 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

View File

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

View File

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

View File

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

View File

Before

Width:  |  Height:  |  Size: 3.3 KiB

After

Width:  |  Height:  |  Size: 3.3 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

View File

Before

Width:  |  Height:  |  Size: 3.8 KiB

After

Width:  |  Height:  |  Size: 3.8 KiB

View File

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

View File

Before

Width:  |  Height:  |  Size: 9.5 KiB

After

Width:  |  Height:  |  Size: 9.5 KiB

View File

@ -3,7 +3,7 @@
* theme that is used as fallback in codeblocks
*/
.article pre code {
color: rgba(0, 0, 0, 0.8) !important;
color: rgba(0, 0, 0, 0.78) !important;
}
@ -103,3 +103,14 @@ font-style:italic;
.hljs-strong {
font-weight:700;
}
/*
OVERRIDING THE DEFAULT STYLES - By Mahmoud Zalt (mahmoud@zalt.me) for Laradock.io
*/
.project .logo img{
width: 140px;
height: 140px;
background: transparent;
border-radius: 0%;
}

View File

@ -4,14 +4,13 @@
[![Gitter](https://badges.gitter.im/LaraDock/laradock.svg)](https://gitter.im/LaraDock/laradock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
LaraDock能够帮你在**Docker**上快速搭建**Laravel**应用。
<br>
就像Laravel Homestead一样但是Docker替换了Vagrant。
LaraDock 能够帮你在 **Docker** 上快速搭建 **Laravel** 应用。
就像 Laravel Homestead 一样,但是 Docker 替换了 Vagrant。
> 先在使用 LaraDock然后再学习它们。
<br>
## 目录
- [Intro](#Intro)
- [Features](#features)
- [Supported Software's](#Supported-Containers)
@ -54,40 +53,44 @@ LaraDock能够帮你在**Docker**上快速搭建**Laravel**应用。
- [Help & Questions](#Help)
<a name="Intro"></a>
## 介绍
LaraDock努力简化创建开发环境过程。
它包含预包装Docker镜像提供你一个美妙的开发环境而不需要安装PHP,NGINX,MySQL和其他任何软件在你本地机器上
LaraDock 努力简化创建开发环境过程
它包含预包装 Docker 镜像,提供你一个美妙的开发环境而不需要安装 PHP, NGINX, MySQL 和其他任何软件在你本地机器上。
**使用概览:**
让我们了解使用它安装 `NGINX`, `PHP`, `Composer`, `MySQL``Redis`,然后运行 `Laravel`
让我们了解使用它安装`NGINX`, `PHP`, `Composer`, `MySQL``Redis`,然后运行`Laravel`
1. 将 LaraDock 放到你的 Laravel 项目中:
1. 将LaraDock放到你的Laravel项目中
<br>
`git clone https://github.com/laradock/laradock.git`.
2. 进入LaraDock目录然后运行这些容器。
<br>
`docker-compose up -d nginx mysql redis`
3. 打开你的`.env`文件,然后设置`mysql``DB_HOST``redis``REDIS_HOST`
4. 打开浏览器访问localhost
```bash
git clone https://github.com/laradock/laradock.git
```
2. 进入 LaraDock 目录,然后运行这些容器。
```bash
docker-compose up -d nginx mysql redis
```
3. 打开你的 `.env` 文件,然后设置 `mysql``DB_HOST``redis``REDIS_HOST`
4. 打开浏览器,访问 localhost
<a name="features"></a>
### 特点
- 在PHP版本7.05.6.5.5...之中可以简单切换。
- PHP 版本7.05.6.5.5...之中可以简单切换。
- 可选择你最喜欢的数据库引擎比如MySQL, Postgres, MariaDB...
- 可运行自己的软件组合比如Memcached, HHVM, Beanstalkd...
- 所有软件运行在不同的容器之中比如PHP-FPM, NGINX, PHP-CLI...
- 通过简单的编写`dockerfile`容易定制任何容器。
- 通过简单的编写 `Dockerfile` 容易定制任何容器。
- 所有镜像继承自一个官方基础镜像Trusted base Images
- 可预配置Laravel的Nginx环境
- 容易应用容器中的配置
- 干净的结构化的Docker配置文件`dockerfile`
- 最新的Docker Compose 版本(`docker-compose`
- 容易应用容器中的配置 配置文件(`Dockerfile`
- 最新的 Docker Compose 版本`docker-compose`
- 所有的都是可视化和可编辑的
- 快速的镜像构建
- 每周都会有更新...
@ -115,39 +118,37 @@ LaraDock努力简化创建开发环境过程。
- Beanstalkd (+ Beanstalkd Console)
- **工具:**
- Workspace (PHP7-CLI, Composer, Git, Node, Gulp, SQLite, Vim, Nano, cURL...)
>如果你找不到你需要的软件,构建它然后把它添加到这个列表。你的贡献是受欢迎的。
<a name="what-is-docker"></a>
### Docker是什么?
### Docker 是什么?
[Docker](https://www.docker.com) 是一个开源项目,自动化部署应用程序软件的容器,在Linux, Mac OS and Windows提供一个额外的抽象层和自动化的[操作系统级的虚拟化](https://en.wikipedia.org/wiki/Operating-system-level_virtualization)
[Docker](https://www.docker.com) 是一个开源项目,自动化部署应用程序软件的容器,在 Linux, Mac OS and Windows 提供一个额外的抽象层和自动化的[操作系统级的虚拟化](https://en.wikipedia.org/wiki/Operating-system-level_virtualization)
<a name="what-is-laravel"></a>
### Laravel是什么?
### Laravel 是什么?
额,这很认真的!!!
<a name="why-docker-not-vagrant"></a>
### 为什么使用Docker而不是Vagrant!?
### 为什么使用 Docker 而不是 Vagrant!?
[Vagrant](https://www.vagrantup.com)构建虚拟机需要几分钟然而Docker构建虚拟容器只需要几秒钟。
而不是提供一个完整的虚拟机,就像你用Vagrant,Docker为您提供**轻量级**虚拟容器,共享相同的内核和允许安全执行独立的进程。
[Vagrant](https://www.vagrantup.com) 构建虚拟机需要几分钟然而 Docker 构建虚拟容器只需要几秒钟。
而不是提供一个完整的虚拟机,就像你用 Vagrant, Docker 为您提供**轻量级**虚拟容器,共享相同的内核和允许安全执行独立的进程。
除了速度,Docker提供大量的Vagrant无法实现的功能。
除了速度, Docker 提供大量的 Vagrant 无法实现的功能。
最重要的是Docker可以运行在开发和生产(相同环境无处不在)。Vagrant是专为开发,(所以在生产环境你必须每一次重建您的服务器)。
最重要的是 Docker 可以运行在开发和生产(相同环境无处不在)。Vagrant 是专为开发,(所以在生产环境你必须每一次重建您的服务器)。
<a name="laradock-vs-homestead"></a>
### LaraDock Homestead 对比
LaraDock and [Homestead](https://laravel.com/docs/master/homestead) 给你一个完整的虚拟开发环境。(不需要安装和配置软件在你自己的每一个操作系统)。
Homestead 是一个工具,为你控制虚拟机(使用Homestead特殊命令)。Vagrant可以管理你的管理虚容器。
运行一个虚拟容器比运行一整个虚拟机快多了**LaraDock 比 Homestead快多了**
Homestead 是一个工具,为你控制虚拟机(使用 Homestead 特殊命令)。Vagrant 可以管理你的管理虚容器。
运行一个虚拟容器比运行一整个虚拟机快多了 **LaraDock 比 Homestead 快多了**
<a name="Demo"></a>
## 演示视频
@ -158,53 +159,41 @@ Homestead 是一个工具,为你控制虚拟机(使用Homestead特殊命令)。V
- LaraDock [v0.3](https://www.youtube.com/watch?v=jGkyO6Is_aI)
- LaraDock [v0.1](https://www.youtube.com/watch?v=3YQsHe6oF80)
<a name="Requirements"></a>
## 依赖
- [Git](https://git-scm.com/downloads)
- [Git](https://git-scm.com/downloads)
- [Docker](https://www.docker.com/products/docker/)
<a name="Installation"></a>
## 安装
1 - 克隆 `LaraDock` 仓库:
**A)** 如果你已经有一个Laravel项目,克隆这个仓库在到`Laravel`根目录
**A)** 如果你已经有一个 Laravel 项目,克隆这个仓库在到 `Laravel` 根目录
```bash
git submodule add https://github.com/laradock/laradock.git
```
>如果你不是使用Git管理Laravel项目,您可以使用 `git clone` 而不是`git submodule`
>如果你不是使用 Git 管理 Laravel 项目,您可以使用 `git clone` 而不是 `git submodule`
**B)** 如果你没有一个Laravel项目,你想Docker安装Laravel,克隆这个源在您的机器任何地方上:
**B)** 如果你没有一个 Laravel 项目,你想 Docker 安装 Laravel,克隆这个源在您的机器任何地方上:
```bash
git clone https://github.com/laradock/laradock.git
```
<a name="Usage"></a>
## 使用
**请在开始之前阅读:**
如果你正在使用**Docker Toolbox** (VM),选择以下任何一个方法:
- 更新到Docker [Native](https://www.docker.com/products/docker) Mac/Windows版本 (建议). 查看 [Upgrading LaraDock](#upgrading-laradock)
如果你正在使用 **Docker Toolbox** (VM),选择以下任何一个方法:
- 更新到 Docker [Native](https://www.docker.com/products/docker) Mac/Windows 版本 (建议). 查看 [Upgrading LaraDock](#upgrading-laradock)
- 使用 LaraDock v3.* (访问 `LaraDock-ToolBox` [分支](https://github.com/laradock/laradock/tree/LaraDock-ToolBox)).
如果您使用的是**Docker Native**(Mac / Windows版本)甚至是Linux版本,通常可以继续阅读这个文档LaraDock v4以上版本将仅支持**Docker Native**。
<br>
<br>
1 - 运行容器: *(在运行`docker-compose`命令之前,确认你在 `laradock` 目录中*
如果您使用的是 **Docker Native**(Mac / Windows 版本)甚至是 Linux 版本,通常可以继续阅读这个文档LaraDock v4 以上版本将仅支持 **Docker Native**
1 - 运行容器: *(在运行 `docker-compose` 命令之前,确认你在 `laradock` 目录中*
**例子:** 运行 NGINX 和 MySQL:
@ -213,77 +202,50 @@ docker-compose up -d nginx mysql
```
你可以从以下列表选择你自己的容器组合:
`nginx`, `hhvm`, `php-fpm`, `mysql`, `redis`, `postgres`, `mariadb`, `neo4j`, `mongo`, `apache2`, `caddy`, `memcached`, `beanstalkd`, `beanstalkd-console`, `workspace`.
**说明**: `workspace``php-fpm` 将运行在大部分实例中, 所以不需要在 `up` 命令中加上它们.
<br>
2 - 进入 Workspace 容器, 执行像 (Artisan, Composer, PHPUnit, Gulp, ...)等命令
```bash
docker-compose exec workspace bash
```
<br />
增加 `--user=laradock` (例如 `docker-compose exec --user=laradock workspace bash`) 作为您的主机的用户创建的文件. (你可以从 `docker-compose.yml`修改 PUID (User id) 和 PGID (group id) 值 ).
<br>
3 - 编辑 Laravel 的配置.
如果你还没有安装Laravel项目请查看 [How to Install Laravel in a Docker Container](#Install-Laravel).
如果你还没有安装 Laravel 项目,请查看 [How to Install Laravel in a Docker Container](#Install-Laravel).
打开 Laravel的 `.env` 文件 然后 配置 你的`mysql``DB_HOST`:
打开 Laravel `.env` 文件 然后 配置 你的 `mysql``DB_HOST`:
```env
DB_HOST=mysql
```
4 - 打开浏览器访问 localhost (`http://localhost/`).
<br>
4 - 打开浏览器访问localhost (`http://localhost/`).
<br>
**调试**: 如果你碰到任何问题,请查看 [调试](#debugging) 章节
如果你需要特别支持,请联系我,更多细节在[帮助 & 问题](#Help)章节
<br>
<a name="Documentation"></a>
## 文档
<a name="Docker"></a>
### [Docker]
<a name="List-current-running-Containers"></a>
### 列出正在运行的容器
```bash
docker ps
```
你也可以使用以下命令查看某项目的容器
```bash
docker-compose ps
```
<br>
<a name="Close-all-running-Containers"></a>
### 关闭所有容器
```bash
@ -296,25 +258,18 @@ docker-compose stop
docker-compose stop {容器名称}
```
<br>
<a name="Delete-all-existing-Containers"></a>
### 删除所有容器
```bash
docker-compose down
```
小心这个命令,因为它也会删除你的数据容器。(如果你想保留你的数据你应该在上述命令后列出容器名称删除每个容器本身):*
<br>
<a name="Enter-Container"></a>
### 进入容器 (通过SSH 进入一个运行中的容器)
### 进入容器 (通过 SSH 进入一个运行中的容器)
1 - 首先使用 `docker ps`命令查看正在运行的容器
1 - 首先使用 `docker ps` 命令查看正在运行的容器
2 - 进入某个容器使用:
@ -331,12 +286,6 @@ docker-compose exec mysql bash
3 - 退出容器, 键入 `exit`.
<br>
<a name="Edit-Container"></a>
### 编辑默认容器配置
打开 `docker-compose.yml` 然后 按照你想的修改.
@ -357,18 +306,10 @@ docker-compose exec mysql bash
- "1111:6379"
```
<br>
<a name="Edit-a-Docker-Image"></a>
### 编辑Docker镜像
### 编辑 Docker 镜像
1 - 找到你想修改的镜像的 `dockerfile` ,
1 - 找到你想修改的镜像的 `Dockerfile` ,
<br>
例如: `mysql``mysql/Dockerfile`.
@ -379,28 +320,19 @@ docker-compose exec mysql bash
```bash
docker-compose build mysql
```
更多信息在容器重建中 [点击这里](#Build-Re-build-Containers).
更多信息在容器重建中[点击这里](#Build-Re-build-Containers).
<br>
<a name="Build-Re-build-Containers"></a>
### 建立/重建容器
如果你做任何改变`dockerfile`确保你运行这个命令,可以让所有修改更改生效:
如果你做任何改变 `Dockerfile` 确保你运行这个命令,可以让所有修改更改生效:
```bash
docker-compose build
```
选择你可以指定哪个容器重建(而不是重建所有的容器):
选择你可以指定哪个容器重建(而不是重建所有的容器):
```bash
docker-compose build {container-name}
@ -408,25 +340,11 @@ docker-compose build {container-name}
如果你想重建整个容器,你可能需要使用 `--no-cache` 选项 (`docker-compose build --no-cache {container-name}`).
<br>
<a name="Add-Docker-Images"></a>
### 增加更多软件 (Docker 镜像)
为了增加镜像(软件), 编辑 `docker-compose.yml` 添加容器细节, 你需要熟悉 [docker compose 文件语法](https://docs.docker.com/compose/compose-file/).
<br>
<a name="View-the-Log-files"></a>
### 查看日志文件
Nginx的日志在 `logs/nginx` 目录
@ -437,19 +355,12 @@ Nginx的日志在 `logs/nginx` 目录
docker logs {container-name}
```
<br>
<a name="Laravel"></a>
### [Laravel]
<a name="Install-Laravel"></a>
### 从Docker镜像安装Laravel
### 从 Docker 镜像安装 Laravel
1 - 首先你需要进入 Workspace 容器.
2 - 安装 Laravel.
@ -460,16 +371,15 @@ docker logs {container-name}
composer create-project laravel/laravel my-cool-app "5.2.*"
```
> 我们建议使用 `composer create-project` 替换Laravel 安装器去安装Laravel.
> 我们建议使用 `composer create-project` 替换 Laravel 安装器去安装 Laravel.
关于更多Laravel安装内容请 [点击这儿](https://laravel.com/docs/master#installing-laravel).
关于更多 Laravel 安装内容请 [点击这儿](https://laravel.com/docs/master#installing-laravel).
3 - 编辑 `docker-compose.yml` 映射新的应用目录:
系统默认LaraDock假定Laravel应用在LaraDock的父级目录中
By default LaraDock assumes the Laravel application is living in the parent directory of the laradock folder.
系统默认 LaraDock 假定 Laravel 应用在 laradock 的父级目录中
更新Laravel应用在 `my-cool-app` 目录中, 我们需要用 `../my-cool-app/:/var/www`替换 `../:/var/www` , 如下:
更新 Laravel 应用在 `my-cool-app` 目录中, 我们需要用 `../my-cool-app/:/var/www`替换 `../:/var/www` , 如下:
```yaml
application:
@ -477,32 +387,33 @@ By default LaraDock assumes the Laravel application is living in the parent dire
volumes:
- ../my-cool-app/:/var/www
```
4 - 进入目录下继续工作..
```bash
cd my-cool-app
```
5 - 回到LaraDock安装步骤,看看如何编辑`env`的文件。
5 - 回到 LaraDock 安装步骤,看看如何编辑 `.env` 的文件。
<br>
<a name="Run-Artisan-Commands"></a>
### 运行 Artisan 命令
你可以从Workspace容器运行artisan命令和其他终端命令
1 - 确认Workspace容器已经运行.
你可以从 Workspace 容器运行 artisan 命令和其他终端命令
1 - 确认 Workspace 容器已经运行.
```bash
docker-compose up -d workspace // ..and all your other containers
```
2 - 找到Workspace容器名称:
2 - 找到 Workspace 容器名称:
```bash
docker-compose ps
```
3 - 进入Workspace容器:
3 - 进入 Workspace 容器:
```bash
docker-compose exec workspace bash
@ -510,35 +421,33 @@ docker-compose exec workspace bash
增加 `--user=laradock` (例如 `docker-compose exec --user=laradock workspace bash`) 作为您的主机的用户创建的文件.
4 - 运行任何你想的 :)
```bash
php artisan
```
```bash
Composer update
composer update
```
```bash
phpunit
```
<br>
<a name="Use-Redis"></a>
### 使用 Redis
1 - 首先务必用 `docker-compose up` 命令运行 (`redis`)容器.
1 - 首先务必用 `docker-compose up` 命令运行 (`redis`) 容器.
```bash
docker-compose up -d redis
```
2 - 打开你的Laravel的 `.env` 文件 然后 配置`redis``REDIS_HOST`
2 - 打开你的Laravel的 `.env` 文件 然后 配置 `redis``REDIS_HOST`
```env
REDIS_HOST=redis
```
如果在你的`.env` 文件没有找到`REDIS_HOST`变量。打开数据库配置文件`config/database.php`然后用`redis`替换默认IP`127.0.0.1`,例如:
如果在你的 `.env` 文件没有找到 `REDIS_HOST` 变量。打开数据库配置文件 `config/database.php` 然后用 `redis` 替换默认 IP `127.0.0.1`,例如:
```php
@ -552,44 +461,35 @@ REDIS_HOST=redis
],
```
3 - 启用Redis缓存或者开启Session管理也在`.env`文件中用`redis`替换默认`file`设置`CACHE_DRIVER``SESSION_DRIVER`
3 - 启用 Redis 缓存或者开启 Session 管理也在 `.env` 文件中用 `redis` 替换默认 `file` 设置 `CACHE_DRIVER``SESSION_DRIVER`
```env
CACHE_DRIVER=redis
SESSION_DRIVER=redis
```
4 - 最好务必通过Compose安装 `predis/predis``(~1.0)`:
4 - 最好务必通过 Composer 安装 `predis/predis``(~1.0)`:
```bash
composer require predis/predis:^1.0
```
5 - 你可以用以下代码在Laravel中手动测试
5 - 你可以用以下代码在 Laravel 中手动测试:
```php
\Cache::store('redis')->put('LaraDock', 'Awesome', 10);
```
<br>
<a name="Use-Mongo"></a>
### 使用 Mongo
1 - 首先在WorkspacePHP-FPM容器中安装`mongo`:
<br>
a) 打开 `docker-compose.yml` 文件
<br>
b) 在Workspace容器中找到`INSTALL_MONGO`选项:
1 - 首先在 WorkspacePHP-FPM 容器中安装 `mongo`:
<br>
c) 设置为 `true`
<br>
d) 在PHP-FPM容器中找到`INSTALL_MONGO` <br>
e) 设置为 `true`
a) 打开 `docker-compose.yml` 文件
b) 在 Workspace 容器中找到 `INSTALL_MONGO` 选项:
c) 设置为 `true`
d) 在 PHP-FPM 容器中找到 `INSTALL_MONGO`
e) 设置为 `true`
相关配置项如下:
@ -608,18 +508,19 @@ e) 设置为 `true`
...
```
2 - 重建`Workspace、PHP-FPM`容器 `docker-compose build workspace php-fpm`
2 - 重建 `Workspace、PHP-FPM` 容器
```bash
docker-compose build workspace php-fpm
```
3 - 使用`docker-compose up` 命令运行MongoDB容器 (`mongo`)
3 - 使用 `docker-compose up` 命令运行 MongoDB 容器 (`mongo`)
```bash
docker-compose up -d mongo
```
4 - 在`config/database.php` 文件添加MongoDB的配置项:
4 - 在 `config/database.php` 文件添加 MongoDB 的配置项:
```php
'connections' => [
@ -641,65 +542,53 @@ docker-compose up -d mongo
],
```
5 - 打开Laravel的 `.env` 文件 然后 更新以下字段:
5 - 打开 Laravel `.env` 文件然后更新以下字段:
- 设置 `DB_HOST``mongo`的主机IP.
- 设置 `DB_HOST``mongo` 的主机 IP.
- 设置 `DB_PORT``27017`.
- 设置 `DB_DATABASE``database`.
6 - 最后务必通过Composer安装`jenssegers/mongodb`添加服务提供者Laravel Service Provider
6 - 最后务必通过 Composer 安装 `jenssegers/mongodb` 添加服务提供者Laravel Service Provider
```bash
composer require jenssegers/mongodb
```
更多细节内容 [点击这儿](https://github.com/jenssegers/laravel-mongodb#installation).
7 - 测试:
- 首先让你的模型继承MongoEloquent Model. 查看 [文档](https://github.com/jenssegers/laravel-mongodb#eloquent).
- 进入Workspace容器.
- 首先让你的模型继承 MongoEloquent Model. 查看 [文档](https://github.com/jenssegers/laravel-mongodb#eloquent).
- 进入 Workspace 容器.
- 迁移数据库 `php artisan migrate`.
<br>
<a name="PHP"></a>
### [PHP]
<a name="Install-PHP-Extensions"></a>
### 安装PHP拓展
安装PHP扩展之前,你必须决定你是否需要`FPM``CLI`,因为他们安装在不同的容器上,如果你需要两者,则必须编辑两个容器。
### 安装 PHP 拓展
PHP-FPM拓展务必安装在 `php-fpm/Dockerfile-XX`. *(用你PHP版本号替换 XX)*.
<br>
PHP-CLI拓展应该安装到`workspace/Dockerfile`.
安装 PHP 扩展之前,你必须决定你是否需要 `FPM``CLI`,因为他们安装在不同的容器上,如果你需要两者,则必须编辑两个容器。
PHP-FPM 拓展务必安装在 `php-fpm/Dockerfile-XX`. *(用你 PHP 版本号替换 XX)*.
PHP-CLI 拓展应该安装到 `workspace/Dockerfile`.
<br>
<a name="Change-the-PHP-FPM-Version"></a>
### 修改PHP-FPM版本
默认运行**PHP-FPM 7.0**版本.
>PHP-FPM负责服务你的应用代码,如果你是计划运行您的应用程序在不同PHP-FPM版本上则不需要更改PHP-CLI版本。
### 修改 PHP-FPM 版本
默认运行 **PHP-FPM 7.0** 版本.
>PHP-FPM 负责服务你的应用代码,如果你是计划运行您的应用程序在不同 PHP-FPM 版本上,则不需要更改 PHP-CLI 版本。
#### A) 切换版本 PHP `7.0` 到 PHP `5.6`
1 - 打开 `docker-compose.yml`
2 - 在PHP容器的 `Dockerfile-70`文件。
2 - 在PHP容器的 `Dockerfile-70` 文件。
3 - 修改版本号, 用`Dockerfile-56`替换 `Dockerfile-70` , 例如:
3 - 修改版本号, 用 `Dockerfile-56` 替换 `Dockerfile-70` , 例如:
```txt
php-fpm:
@ -718,57 +607,39 @@ docker-compose build php
#### B) 切换版本 PHP `7.0` 或 `5.6` 到 PHP `5.5`
我们已不在本地支持PHP5.5,但是你按照以下步骤获取:
我们已不在本地支持 PHP5.5,但是你按照以下步骤获取:
1 - 克隆 `https://github.com/laradock/php-fpm`.
3 - 重命名 `Dockerfile-56``Dockerfile-55`.
2 - 重命名 `Dockerfile-56``Dockerfile-55`.
3 - 编辑文件 `FROM php:5.6-fpm``FROM php:5.5-fpm`.
4 - 从 `Dockerfile-55`构建镜像.
4 - 从 `Dockerfile-55` 构建镜像.
5 - 打开 `docker-compose.yml` 文件.
6 - 将 `php-fpm` 指向你的 `Dockerfile-55` 文件.
<br>
<a name="Change-the-PHP-CLI-Version"></a>
### 修改 PHP-CLI 版本
默认运行**PHP-CLI 7.0**版本
默认运行 **PHP-CLI 7.0** 版本
>说明: PHP-CLI只用于执行ArtisanComposer命令不服务于你的应用代码这是PHP-FPM的工作所以编辑PHP-CLI的版本不是很重要。
PHP-CLI安装在Workspace容器改变PHP-CLI版本你需要编辑`workspace/Dockerfile`.
现在你必须手动修改PHP-FPM`Dockerfile`或者创建一个新的。 (可以考虑贡献功能).
>说明: PHP-CLI 只用于执行 ArtisanComposer 命令,不服务于你的应用代码,这是 PHP-FPM 的工作,所以编辑 PHP-CLI 的版本不是很重要。
PHP-CLI 安装在 Workspace 容器,改变 PHP-CLI 版本你需要编辑 `workspace/Dockerfile`.
现在你必须手动修改 PHP-FPM`Dockerfile` 或者创建一个新的。 (可以考虑贡献功能).
<br>
<a name="Install-xDebug"></a>
### 安装 xDebug
1 - 首先在WorkspacePHP-FPM容器安装 `xDebug`:
<br>
a) 打开 `docker-compose.yml` 文件
<br>
b) 在Workspace容器中找到 `INSTALL_XDEBUG` 选项
<br>
c) 改为 `true`
<br>
d) 在PHP-FPM容器中找到 `INSTALL_XDEBUG ` 选项<br>
e) 改为 `true`
1 - 首先在 WorkspacePHP-FPM 容器安装 `xDebug`:
a) 打开 `docker-compose.yml` 文件
b) 在 Workspace 容器中找到 `INSTALL_XDEBUG` 选项
c) 改为 `true`
d) 在 PHP-FPM 容器中找到 `INSTALL_XDEBUG ` 选项
e) 改为 `true`
例如:
@ -789,44 +660,35 @@ e) 改为 `true`
2 - 重建容器 `docker-compose build workspace php-fpm`
<br>
<a name="Misc"></a>
### [Misc]
<br>
<a name="Use-custom-Domain"></a>
### 使用自定义域名 (替换DockerIP)
### 使用自定义域名 (替换 DockerIP)
假定你的自定义域名是 `laravel.dev`
1 - 打开 `/etc/hosts` 文件 添加以下内容映射你的localhost 地址 `127.0.0.1``laravel.dev` 域名
1 - 打开 `/etc/hosts` 文件添加以下内容,映射你的 localhost 地址 `127.0.0.1``laravel.dev` 域名
```bash
127.0.0.1 laravel.dev
```
2 - 打开你的浏览器访问 `{http://laravel.dev}`
你可以在nginx配置文件自定义服务器名称,如下:
你可以在 nginx 配置文件自定义服务器名称,如下:
```conf
server_name laravel.dev;
```
<br>
<a name="Enable-Global-Composer-Build-Install"></a>
### 安装全局Composer命令
### 安装全局 Composer 命令
为启用全局Composer Install在容器构建中允许你安装composer的依赖然后构建完成后就是可用的。
为启用全局 Composer Install 在容器构建中允许你安装 composer 的依赖,然后构建完成后就是可用的。
1 - 打开 `docker-compose.yml` 文件
2 - 在Workspace容器找到 `COMPOSER_GLOBAL_INSTALL` 选项并设置为 `true`
2 - 在 Workspace 容器找到 `COMPOSER_GLOBAL_INSTALL` 选项并设置为 `true`
例如:
@ -840,19 +702,16 @@ server_name laravel.dev;
```
3 - 现在特价你的依赖关系到 `workspace/composer.json`
4 - 重建Workspace容器 `docker-compose build workspace`
4 - 重建 Workspace 容器 `docker-compose build workspace`
<br>
<a name="Install-Prestissimo"></a>
### 安装 Prestissimo
[Prestissimo](https://github.com/hirak/prestissimo) 是一个平行安装功能的composer插件。
1 - 在安装期间使全局Composer Install 正在运行:
[Prestissimo](https://github.com/hirak/prestissimo) 是一个平行安装功能的 composer 插件。
点击这个 [启用全局Composer构建安装](#Enable-Global-Composer-Build-Install) 然后继续步骤1、2.
1 - 在安装期间,使全局 Composer Install 正在运行:
点击这个 [启用全局 Composer 构建安装](#Enable-Global-Composer-Build-Install) 然后继续步骤1、2.
2 - 添加 prestissimo 依赖到 Composer:
@ -860,19 +719,17 @@ a - 现在打开 `workspace/composer.json` 文件
b - 添加 `"hirak/prestissimo": "^0.3"` 依赖
c - 重建Workspace容器 `docker-compose build workspace`
c - 重建 Workspace 容器 `docker-compose build workspace`
<br>
<a name="Install-Node"></a>
### 安装 Node + NVM
在Workspace 容器安装 NVM 和 NodeJS
Workspace 容器安装 NVM 和 NodeJS
1 - 打开 `docker-compose.yml` 文件
2 - 在Workspace容器找到 `INSTALL_NODE` 选项设为 `true`
2 - 在 Workspace 容器找到 `INSTALL_NODE` 选项设为 `true`
例如:
@ -887,17 +744,14 @@ c - 重建Workspace容器 `docker-compose build workspace`
3 - 重建容器 `docker-compose build workspace`
<br>
<a name="debugging"></a>
### Debugging
*这里是你可能面临的常见问题列表,以及可能的解决方案.*
#### 看到空白页而不是Laravel的欢迎页面!
#### 看到空白页而不是 Laravel 的欢迎页面!
在Laravel根目录运行下列命令:
Laravel 根目录,运行下列命令:
```bash
sudo chmod -R 777 storage bootstrap/cache
@ -909,34 +763,28 @@ sudo chmod -R 777 storage bootstrap/cache
#### 看到包含 `address already in use` 的错误
确保你想运行的服务端口(80, 3306, etc.)不是已经被其他程序使用,例如`apache`/`httpd`服务或其他安装的开发工具
确保你想运行的服务端口(80, 3306, etc.)不是已经被其他程序使用,例如 `apache`/`httpd` 服务或其他安装的开发工具
<br>
<a name="upgrading-laradock"></a>
### LaraDock 升级
从Docker Toolbox (VirtualBox)移动到Docker Native (for Mac/Windows),需要从 LaraDock v3.* 升级到 v4.*:
Docker Toolbox (VirtualBox) 移动到 Docker Native (for Mac/Windows),需要从 LaraDock v3.* 升级到 v4.*:
1. 停止Docker虚拟机 `docker-machine stop {default}`
1. 停止 Docker 虚拟机 `docker-machine stop {default}`
2. 安装 Docker [Mac](https://docs.docker.com/docker-for-mac/) 或 [Windows](https://docs.docker.com/docker-for-windows/).
3. 升级 LaraDock 到 `v4.*.*` (`git pull origin master`)
4. 像之前一样使用LaraDock: `docker-compose up -d nginx mysql`.
4. 像之前一样使用 LaraDock: `docker-compose up -d nginx mysql`.
**说明:** 如果你面临任何上面的问题的最后一步:重建你所有的容器
`docker-compose build --no-cache`
```bash
docker-compose build --no-cache
```
"警告:容器数据可能会丢失!"
<br>
## 贡献
这个小项目是由一个有一个全职工作和很多的职责的人建立的,所以如果你喜欢这个项目,并且发现它需要一个bug修复或支持或新软件或升级任何容器,或其他任何. . 你是非常欢迎,欢迎毫不不犹豫地贡献吧:)
这个小项目是由一个有一个全职工作和很多的职责的人建立的,所以如果你喜欢这个项目,并且发现它需要一个 bug 修复或支持或新软件或升级任何容器,或其他任何. . 你是非常欢迎,欢迎毫不不犹豫地贡献吧:)
#### 阅读我们的 [贡献说明](https://github.com/laradock/laradock/blob/master/CONTRIBUTING.md)
@ -945,9 +793,9 @@ sudo chmod -R 777 storage bootstrap/cache
从聊天室 [Gitter](https://gitter.im/LaraDock/laradock) 社区获取帮助和支持.
你也可以打开Github上的 [issue](https://github.com/laradock/laradock/issues) (将被贴上问题和答案) 或与大家讨论 [Gitter](https://gitter.im/LaraDock/laradock).
你也可以打开 Github 上的 [issue](https://github.com/laradock/laradock/issues) (将被贴上问题和答案) 或与大家讨论 [Gitter](https://gitter.im/LaraDock/laradock).
DockerLaravel的特别帮助你可以在[Codementor.io](https://www.codementor.io/mahmoudz)上直接和项目创始人在线沟通
DockerLaravel 的特别帮助,你可以在 [Codementor.io](https://www.codementor.io/mahmoudz) 上直接和项目创始人在线沟通
## 关于作者

View File

@ -1,10 +1,12 @@
# Laradock
[![Build Status](https://travis-ci.org/laradock/laradock.svg?branch=master)](https://travis-ci.org/laradock/laradock)
![](https://s19.postimg.org/jblfytw9f/laradock-logo.jpg)
> Use Docker first and learn about it later.
[![forthebadge](http://forthebadge.com/images/badges/built-by-developers.svg)](http://zalt.me)
A Docker PHP development environment that facilitates running **PHP** Apps on **Docker**.
Laradock is a Docker PHP development environment that facilitate running **PHP** Apps on **Docker**.
[![forthebadge](http://forthebadge.com/images/badges/built-by-developers.svg)](http://zalt.me)
## Documentation
@ -12,17 +14,15 @@ Laradock is a Docker PHP development environment that facilitate running **PHP**
## Credits
**Super 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!
**Amazing Contributors:**
- [Contributors](https://github.com/laradock/laradock/graphs/contributors)
- [Mahmoud Zalt](https://github.com/Mahmoudz) @mahmoudz | [Twitter](https://twitter.com/Mahmoud_Zalt) | [Site](http://zalt.me)
- [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
- [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
## License

View File

@ -1,213 +0,0 @@
#### Install Docker
```
Login Digital Ocean
Add Droplet
1 Click Install docker
Choose Droplet
reset ROOT password
check email
```
#### SSH to your 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
After SSH
you can check that docker command is working by typing
```
$root@midascode:~# 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
```
#### 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
```
#### Create Your LaraDock Containers
```
$root@midascode:~/laravel/laradock# docker-compose up -d nginx mysql
```
#### Go to Your Workspace
```
docker-compose exec workspace bash
```
#### Install laravel Dependencies, Add .env , generate Key and give proper permission certain 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
```
you can then view your laravel site at your ipaddress
for example
```
192.168.1.1
```
You will see there Laravel Default Welcome Page
but if you need to view on your custom domain name
which you would.
#### Using Your Own Domain Name
login to your DNS provider
Godaddy, Namecheap what ever...
And 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
```
$root@midascode:~/laravel/laradock# cd nginx
$root@midascode:~/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)
```
listen 80;
listen [::]:80 ipv6only=on;
server_name yourdomain.com;
```
#### Rebuild Your Nginx
```
$root@midascode:~/laravel/laradock/nginx# docker-compose down
$root@midascode:~/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
```
###### 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
###### To go Caddy Folders and Edit CaddyFile
```
$root@midascode:~/laravel/laradock# cd caddy
$root@midascode:~/laravel/laradock/caddy# vim Caddyfile
```
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
```
This is needed Prior to Creating Let's Encypt
#### Run Your Caddy Container without the -d flag and Generate SSL with Let's Encrypt
```
$root@midascode:~/laravel/laradock/caddy# docker-compose up caddy
```
you will 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...
caddy_1 | Your sites will be served over HTTPS automatically using Let's Encrypt.
caddy_1 | By continuing, you agree to the Let's Encrypt Subscriber Agreement at:
caddy_1 | https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf
caddy_1 | Activating privacy features... done.
caddy_1 | https://yourdomain.com
caddy_1 | http://yourdomain.com
```
After it finish 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
```
View your Site in the Browser Securely Using HTTPS (https://yourdomain.com)
##### Note that Certificate will be Automatically Renew By Caddy
>References:
>
- [https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-16-04](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-16-04)
- [https://www.digitalocean.com/products/one-click-apps/docker/](https://www.digitalocean.com/products/one-click-apps/docker/)
- [https://docs.docker.com/engine/installation/linux/ubuntulinux/](https://docs.docker.com/engine/installation/linux/ubuntulinux/)
- [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/)
- [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)

28
_scripts/travis-build.sh Executable file
View File

@ -0,0 +1,28 @@
#!/usr/bin/env bash
#### Build the Docker Images
if [ -n "${PHP_VERSION}" ]; then
cp env-example .env
sed -i -- 's/=false/=true/g' .env
cat .env
docker-compose build
docker images
fi
#### Generate the Laradock Documentation site using Hugo
if [ -n "${HUGO_VERSION}" ]; then
HUGO_PACKAGE=hugo_${HUGO_VERSION}_Linux-64bit
HUGO_BIN=hugo_${HUGO_VERSION}_linux_amd64
# Download hugo binary
curl -L https://github.com/spf13/hugo/releases/download/v$HUGO_VERSION/$HUGO_PACKAGE.tar.gz | tar xz
mkdir $HOME/bin
mv ./${HUGO_BIN}/${HUGO_BIN} $HOME/bin/hugo
# Remove existing docs
rm -r ./docs
# Build docs
cd DOCUMENTATION
hugo
fi

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

10
certbot/Dockerfile Normal file
View File

@ -0,0 +1,10 @@
FROM phusion/baseimage:latest
MAINTAINER Mahmoud Zalt <mahmoud@zalt.me>
COPY run-certbot.sh /root/certbot/run-certbot.sh
RUN apt-get update
RUN apt-get install -y letsencrypt
ENTRYPOINT bash -c "bash /root/certbot/run-certbot.sh && sleep infinity"

6
certbot/run-certbot.sh Normal file
View File

@ -0,0 +1,6 @@
#!/bin/bash
letsencrypt certonly --webroot -w /var/www/letsencrypt -d "$CN" --agree-tos --email "$EMAIL" --non-interactive --text
cp /etc/letsencrypt/archive/"$CN"/cert1.pem /var/certs/cert1.pem
cp /etc/letsencrypt/archive/"$CN"/privkey1.pem /var/certs/privkey1.pem

View File

@ -5,384 +5,594 @@ 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
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}
- 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
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
volumes:
- ./php-fpm/php${PHP_VERSION}.ini:/usr/local/etc/php/php.ini
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:
- ${DATA_SAVE_PATH}/mysql:/var/lib/mysql
ports:
- "${MYSQL_PORT}:3306"
networks:
- backend
### Percona Container #########################################
percona:
build:
context: ./percona
environment:
- MYSQL_DATABASE=${PERCONA_DATABASE}
- MYSQL_USER=${PERCONA_USER}
- MYSQL_PASSWORD=${PERCONA_PASSWORD}
- MYSQL_ROOT_PASSWORD=${PERCONA_ROOT_PASSWORD}
volumes:
- percona:/var/lib/mysql
ports:
- "${PERCONA_PORT}:3306"
networks:
- backend
### MSSQL Container #########################################
mssql:
build:
context: ./mssql
environment:
- MSSQL_DATABASE=${MSSQL_DATABASE}
- SA_PASSWORD=${MSSQL_PASSWORD}
- ACCEPT_EULA=Y
volumes:
- ${DATA_SAVE_PATH}/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:
- ${DATA_SAVE_PATH}/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:
- ${DATA_SAVE_PATH}/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:
- ${DATA_SAVE_PATH}/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:
- ${DATA_SAVE_PATH}/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:
- ${DATA_SAVE_PATH}/mongo:/data/db
networks:
- backend
### RethinkDB Container #######################################
rethinkdb:
build: ./rethinkdb
ports:
- "8090:8080"
volumes:
- rethinkdb:/data/rethinkdb_data
build: ./rethinkdb
ports:
- "8090:8080"
volumes:
- ${DATA_SAVE_PATH}/rethinkdb:/data/rethinkdb_data
networks:
- backend
### Redis Container #########################################
redis:
build: ./redis
volumes:
- redis:/data
ports:
- "6379:6379"
build: ./redis
volumes:
- ${DATA_SAVE_PATH}/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:
- ${DATA_SAVE_PATH}/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:
- ${DATA_SAVE_PATH}/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
- backend
### pgAdmin Container #######################################
pgadmin:
build: ./pgadmin
ports:
- "5050:5050"
links:
- postgres
build: ./pgadmin
ports:
- "5050:5050"
depends_on:
- postgres
networks:
- frontend
- backend
### ElasticSearch Container #################################
elasticsearch:
build: ./elasticsearch
volumes:
- elasticsearch-data:/usr/share/elasticsearch/data
- elasticsearch-plugins:/usr/share/elasticsearch/data
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
- backend
### Selenium Container #########################################
### 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"
networks:
- frontend
### Mailhog Container #########################################
mailhog:
build: ./mailhog
ports:
- "1025:1025"
- "8025:8025"
networks:
- frontend
### 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"
percona:
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

@ -1,197 +0,0 @@
---
title: Introduction
type: index
weight: 1
---
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...).
## Quick Overview
Let's see how easy it is to install `NGINX`, `PHP`, `Composer`, `MySQL`, `Redis` and `beanstalkd`:
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:
```shell
docker-compose up -d nginx mysql redis beanstalkd
```
3 - Open your `.env` file and set the following:
```shell
DB_HOST=mysql
REDIS_HOST=redis
QUEUE_HOST=beanstalkd
```
4 - Open your browser and visit localhost: `http://localhost`.
```shell
That's it! enjoy :)
```
<a name="what-is-docker"></a>
## What is Docker?
[Docker](https://www.docker.com) is an open-source project that automates the deployment of applications inside software containers, by providing an additional layer of abstraction and automation of [operating-system-level virtualization](https://en.wikipedia.org/wiki/Operating-system-level_virtualization) on Linux, Mac OS and Windows.
<a name="why-docker-not-vagrant"></a>
## Why Docker not Vagrant!?
[Vagrant](https://www.vagrantup.com) creates Virtual Machines in minutes while Docker creates Virtual Containers in seconds.
Instead of providing a full Virtual Machines, like you get with Vagrant, Docker provides you **lightweight** Virtual Containers, that share the same kernel and allow to safely execute independent processes.
In addition to the speed, Docker gives tons of features that cannot be achieved with Vagrant.
Most importantly Docker can run on Development and on Production (same environment everywhere). While Vagrant is designed for Development only, (so you have to re-provision your server on Production every time).
<a name="laradock-vs-homestead"></a>
## LaraDock VS Homestead (For Laravel Developers)
> 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).
- 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.
Running a virtual container is much faster than running a full virtual Machine. Thus **LaraDock is much faster than Homestead**.
<a name="Demo"></a>
## Demo Video
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)
<a name="features"></a>
## Features
- Easy switch between PHP versions: 7.0, 5.6, 5.5...
- Choose your favorite database engine: MySQL, Postgres, MariaDB...
- Run your own combination of software: Memcached, HHVM, Beanstalkd...
- Every software runs on a separate container: PHP-FPM, NGINX, PHP-CLI...
- Easy to customize any container, with simple edit to the `Dockerfile`.
- All Images extends from an official base Image. (Trusted base Images).
- Pre-configured NGINX for Laravel.
- Easy to apply configurations inside containers.
- Clean and well structured Dockerfiles (`Dockerfile`).
- Latest version of the Docker Compose file (`docker-compose`).
- Everything is visible and editable.
- Fast Images Builds.
- More to come every week..
<a name="Supported-Containers"></a>
## Supported Software (Containers)
- **Database Engines:**
- MySQL
- PostgreSQL
- MariaDB
- MongoDB
- Neo4j
- RethinkDB
- **Cache Engines:**
- Redis
- Memcached
- Aerospike
- **PHP Servers:**
- NGINX
- Apache2
- Caddy
- **PHP Compilers:**
- PHP-FPM
- HHVM
- **Message Queuing Systems:**
- Beanstalkd
- Beanstalkd Console
- RabbitMQ
- RabbitMQ Console
- **Tools:**
- PhpMyAdmin
- PgAdmin
- ElasticSearch
- Selenium
- Minio
- Workspace
- PHP7-CLI
- Composer
- Git
- Linuxbrew
- Node
- Gulp
- SQLite
- xDebug
- Envoy
- Deployer
- Vim
- Yarn
- ... Many other supported tools are not documented. (Will be updated soon)
>If you can't find your Software, build it yourself and add it to this list. Contributions are welcomed :)
<a name="Chat"></a>
## Chat with us
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)

View File

@ -1,78 +0,0 @@
baseurl = "https://example.org/"
languageCode = "en-us"
title = "Material Docs"
theme = "hugo-material-docs"
metadataformat = "yaml"
canonifyurls = true
# Enable Google Analytics by entering your tracking id
googleAnalytics = ""
[params]
# General information
author = "Digitalcraftsman"
description = "A material design theme for documentations."
copyright = "Released under the MIT license"
# Repository
provider = "GitHub"
repo_url = "https://github.com/digitalcraftsman/hugo-material-docs"
version = "1.0.0"
logo = "images/logo.png"
favicon = ""
permalink = "#"
# Custom assets
custom_css = []
custom_js = []
# Syntax highlighting theme
highlight_css = ""
[params.palette]
primary = "red"
accent = "teal"
[params.font]
text = "Ubuntu"
code = "Ubuntu Mono"
[social]
twitter = ""
github = "digitalcraftsman"
email = "hello@email.com"
[[menu.main]]
name = "Material"
url = "/"
weight = 0
[[menu.main]]
name = "Getting started"
url = "getting-started/"
weight = 10
[[menu.main]]
name = "Adding content"
url = "adding-content/"
weight = 20
[[menu.main]]
name = "Roadmap"
url = "roadmap/"
weight = 30
[[menu.main]]
name = "License"
url = "license/"
weight = 40
[blackfriday]
smartypants = true
fractions = true
smartDashes = true
plainIDAnchors = true

View File

@ -1,61 +0,0 @@
---
date: 2016-03-09T19:56:50+01:00
title: Adding content
weight: 20
---
## Hello world
Let's create our first content file for your documentation. Open a terminal and add the following command for each new file you want to add. Replace `<section-name>` with a general term that describes your document in detail.
```sh
hugo new <section-name>/filename.md
```
Visitors of your website will find the final document under `www.example.com/<section-name>/filename/`.
Since it's possible to have multiple content files in the same section I recommend to create at least one `index.md` file per section. This ensures that users will find an index page under `www.example.com/<section-name>`.
## Homepage
To add content to the homepage you need to add a small indicator to the frontmatter of the content file:
```toml
type: index
```
Otherwise the theme will not be able to find the corresponding content file.
## Table of contents
You maybe noticed that the menu on the left contains a small table of contents of the current page. All `<h2>` tags (`## Headline` in Markdown) will be added automatically.
## Admonitions
Admonition is a handy feature that adds block-styled side content to your documentation, for example hints, notes or warnings. It can be enabled by using the corresponding [shortcodes](http://gohugo.io/extras/shortcodes/) inside your content:
```go
{{</* note title="Note" */>}}
Nothing to see here, move along.
{{</* /note */>}}
```
This will print the following block:
{{< note title="Note" >}}
Nothing to see here, move along.
{{< /note >}}
The shortcode adds a neutral color for the note class and a red color for the warning class. You can also add a custom title:
```go
{{</* warning title="Don't try this at home" */>}}
Nothing to see here, move along.
{{</* /warning */>}}
```
This will print the following block:
{{< warning title="Don't try this at home" >}}
Nothing to see here, move along.
{{< /warning >}}

View File

@ -1,240 +0,0 @@
---
date: 2016-03-09T00:11:02+01:00
title: Getting started
weight: 10
---
## Installation
### Installing Hugo
Hugo itself is just a single binary without dependencies on expensive runtimes like Ruby, Python or PHP and without dependencies on any databases. You just need to download the [latest version](https://github.com/spf13/hugo/releases). For more information read the official [installation guides](http://gohugo.io/overview/installing/).
Let's make sure Hugo is set up as expected. You should see a similar version number in your terminal:
```sh
hugo version
# Hugo Static Site Generator v0.15 BuildDate: 2016-01-03T12:47:47+01:00
```
### Installing Material
Next, assuming you have Hugo up and running the `hugo-material-docs` theme can be installed with `git`:
```sh
# create a new Hugo website
hugo new site my-awesome-docs
# move into the themes folder of your website
cd my-awesome-docs/themes/
# download the theme
git clone git@github.com:digitalcraftsman/hugo-material-docs.git
```
## Setup
Next, take a look in the `exampleSite` folder at `themes/hugo-material-docs/`. This directory contains an example config file and the content that you are currently reading. It serves as an example setup for your documentation.
Copy at least the `config.toml` in the root directory of your website. Overwrite the existing config file if necessary.
Hugo includes a development server, so you can view your changes as you go -
very handy. Spin it up with the following command:
``` sh
hugo server
```
Now you can go to [localhost:1313](http://localhost:1313) and the Material
theme should be visible. You can now start writing your documentation, or read
on and customize the theme through some options.
## Configuration
Before you are able to deploy your documentation you should take a few minute to adjust some information in the `config.toml`. Open the file in an editor:
```toml
baseurl = "https://example.com/"
languageCode = "en-us"
title = "Material Docs"
[params]
# General information
author = "Digitalcraftsman"
description = "A material design theme for documentations."
copyright = "Released under the MIT license"
```
## Options
### Github integration
If your project is hosted on GitHub, add the repository link to the
configuration. If the `provider` equals **GitHub**, the Material theme will
add a download and star button, and display the number of stars:
```toml
[params]
# Repository
provider = "GitHub"
repo_url = "https://github.com/digitalcraftsman/hugo-material-docs"
```
### Adding a version
In order to add the current version next to the project banner inside the
drawer, you can set the variable `version`:
```toml
[params]
version = "1.0.0"
```
This will also change the link behind the download button to point to the
archive with the respective version on GitHub, assuming a release tagged with
this exact version identifier.
### Adding a logo
If your project has a logo, you can add it to the drawer/navigation by defining
the variable `logo`. Ideally, the image of your logo should have
rectangular shape with a minimum resolution of 128x128 and leave some room
towards the edges. The logo will also be used as a web application icon on iOS.
Either save your logo somewhere in the `static/` folder and reference the file relative to this location or use an external URL:
```toml
[params]
logo = "images/logo.png"
```
### Adding a custom favicon
Favicons are small small icons that are displayed in the tabs right next to the title of the current page. As with the logo above you need to save your favicon in `static/` and link it relative to this folder or use an external URL:
```toml
[params]
favicon = "favicon.ico"
```
### Google Analytics
You can enable Google Analytics by replacing `UA-XXXXXXXX-X` with your own tracking code.
```toml
googleAnalytics = "UA-XXXXXXXX-X"
```
### Small tweaks
This theme provides a simple way for making small adjustments, that is changing
some margins, centering text, etc. The `custom_css` and `custom_js` option allow you to add further CSS and JS files. They can either reside locally in the `/static` folder or on an external server, e.g. a CDN. In both cases use either the relative path to `/static` or the absolute URL to the external ressource.
```toml
[params]
# Custom assets
custom_css = [
"foo.css",
"bar.css"
]
custom_js = ["buzz.js"]
```
### Changing the color palette
Material defines a default hue for every primary and accent color on Google's
material design [color palette][]. This makes it very easy to change the overall look of the theme. Just set the variables `palette.primary` and `palette.accent` to one of the colors defined in the palette:
```toml
[params.palette]
primary = "red"
accent = "light-green"
```
Color names can be written upper- or lowercase but must match the names of the
material design [color palette](http://www.materialui.co/colors). Valid values are: _red_, _pink_, _purple_, _deep purple_, _indigo_, _blue_, _light-blue_, _cyan_, _teal_, _green_, _light-green_,
_lime_, _yellow_, _amber_, _orange_, _deep-orange_, _brown_, _grey_ and
_blue-grey_. The last three colors can only be used as a primary color.
![Color palette](/images/colors.png)
If the color is set via this configuration, an additional CSS file called
`palettes.css` is included that defines the color palettes.
### Changing the font family
Material uses the [Ubuntu font family](http://font.ubuntu.com) by default, specifically the regular sans-serif type for text and the monospaced type for code. Both fonts are loaded from [Google Fonts](https://www.google.com/fonts) and can be easily changed to other fonts, like for example Google's own [Roboto font](https://www.google.com/fonts/specimen/Roboto):
```toml
[params.font]
text = "Roboto"
code = "Roboto Mono"
```
The text font will be loaded in font-weights 400 and **700**, the monospaced
font in regular weight.
### Syntax highlighting
This theme uses the popular [Highlight.js](https://highlightjs.org/) library to colorize code examples. The default theme is called `Github` with a few small tweaks. You can link our own theme if you like. Again, store your stylesheet in the `static/` folder and set the relative path in the config file:
```toml
[params]
# Syntax highlighting theme
highlight_css = "path/to/theme.css"
```
### Adding a GitHub and Twitter account
If you have a GitHub and/or Twitter account, you can add links to your
accounts to the drawer by setting the variables `github` and
`twitter` respectively:
``` toml
[social]
twitter = ""
github = "digitalcraftsman"
```
### Adding menu entries
Once you created your first content files you can link them manually in the sidebar on the left. A menu entry has the following schema:
```toml
[[menu.main]]
name = "Material"
url = "/"
weight = 0
pre = ""
```
`name` is the title displayed in the menu and `url` the relative URL to the content. The `weight` attribute allows you to modify the order of the menu entries. A menu entry appears further down the more weight you add. The `pre` attribute is optional and allows you to *pre*pend elements to a menu link, e.g. an icon.
Instead of just linking a single file you can enhance the sidebar by creating a nested menu. This way you can list all pages of a section instead of linking them one by one (without nesting).
You need extend the frontmatter of each file content file in a section slightly. The snippet below registers this content file as 'child' of a menu entry that already exists.
```yaml
menu:
main:
parent: Material
identifier: <link name>
weight: 0
```
`main` specifies to which menu the content file should be added. `main` is the only menu in this theme by default. `parent` let's you register this content file to an existing menu entry, in this case the `Material` link. Note that the parent in the frontmatter needs to match the name in `config.toml`.
`identifier` is the link that is shown in the menu. Ideally you choose the same name for the `identifier` and the `title` of the page. Again, `weight` allows you to change the order of the nested links in a section.
### Markdown extensions
Hugo uses [Blackfriday](https://github.com/russross/blackfriday) to process your content. For a detailed description of all options take a look at the [Blackfriday configuration](http://gohugo.io/overview/configuration/#configure-blackfriday-rendering) section in the Hugo documentation.
```toml
[blackfriday]
smartypants = true
fractions = true
smartDashes = true
plainIDAnchors = true
```

View File

@ -1,55 +0,0 @@
---
date: 2016-03-08T21:07:13+01:00
title: Material for Hugo
type: index
weight: 0
---
## Beautiful documentation
Material is a theme for [Hugo](https://gohugo.io), a fast and flexible static site generator. It is built using Google's [material design](https://www.google.com/design/spec/material-design/introduction.html)
guidelines, fully responsive, optimized for touch and pointer devices as well
as all sorts of screen sizes.
![Material Screenshot](/images/screen.png)
Material is very lightweight it is built from scratch using Javascript and
CSS that weighs less than 30kb (minified, gzipped and excluding Google Fonts
and Analytics). Yet, it is highly customizable and degrades gracefully in older
browsers.
## Quick start
Install with `git`:
```sh
git clone git@github.com:digitalcraftsman/hugo-material-docs.git themes/hugo-material-docs
```
## Features
- Beautiful, readable and very user-friendly design based on Google's material
design guidelines, packed in a full responsive template with a well-defined
and [easily customizable color palette]({{< relref "getting-started/index.md#changing-the-color-palette" >}}), great typography, as well as a
beautiful search interface and footer.
- Well-tested and optimized Javascript and CSS including a cross-browser
fixed/sticky header, a drawer that even works without Javascript using
the [checkbox hack](http://tutorialzine.com/2015/08/quick-tip-css-only-dropdowns-with-the-checkbox-hack/) with fallbacks, responsive tables that scroll when
the screen is too small and well-defined print styles.
- Extra configuration options like a [project logo]({{< relref "getting-started/index.md#adding-a-logo" >}}), links to the authors
[GitHub and Twitter accounts]({{< relref "getting-started/index.md#adding-a-github-and-twitter-account" >}}) and display of the amount of stars the
project has on GitHub.
- Web application capability on iOS when the page is saved to the homescreen,
it behaves and looks like a native application.
See the [getting started guide]({{< relref "getting-started/index.md" >}}) for instructions how to get
it up and running.
## Acknowledgements
Last but not least a big thank you to [Martin Donath](https://github.com/squidfunk). He created the original [Material theme](https://github.com/squidfunk/mkdocs-material) for Hugo's companion [MkDocs](http://www.mkdocs.org/). This port wouldn't be possible without him.
Furthermore, thanks to [Steve Francia](https://gihub.com/spf13) for creating Hugo and the [awesome community](https://github.com/spf13/hugo/graphs/contributors) around the project.

View File

@ -1,27 +0,0 @@
---
date: 2016-03-09T20:10:46+01:00
title: License
weight: 40
---
Copyright (c) 2016 Digitalcraftsman <digitalcraftsman@protonmail.com><br>
Copyright (c) 2016 Martin Donath <martin.donath@squidfunk.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.

View File

@ -1,27 +0,0 @@
---
date: 2016-03-09T20:08:11+01:00
title: Roadmap
weight: 30
---
Quo vadis? The port of the original [Material theme](https://github.com/squidfunk/mkdocs-material) has replicated nearly all of its features. A few are still missing but I've good news: the Hugo community is actively working on this issues. Maybe with the next release of Hugo we can abandon this list. Stay tuned.
## Localization
Currently, it is possible to collect all strings in a single place for easy customization. However, this only enables you to define all strings in a single language. This approach is quite limiting in terms of localization support. Therefore, I decided to wait for a native integration. This way we can avoid a second setup of all strings in your website.
Keep an eye on [#1734](https://github.com/spf13/hugo/issues/1734).
## Search
Beside third-party services, some hacky workarounds and Grunt-/Gulp-based scripts that only require unnecessary dependencies, future versions of Hugo will support the generation of a content index as a core feature.
This approach plays well with this theme since MkDocs does the same.
Keep an eye on [#1853](https://github.com/spf13/hugo/pull/1853).
## Contributing
Did you found an bug or you would like to suggest a new feature? I'm open for feedback. Please open a new [issue](https://github.com/digitalcraftsman/hugo-material-docs/issues) and let me know.
You're also welcome to contribute with [pull requests](https://github.com/digitalcraftsman/hugo-material-docs/pulls).

Binary file not shown.

Before

Width:  |  Height:  |  Size: 246 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 254 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

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