diff --git a/.devcontainer/devcontainer.example.json b/.devcontainer/devcontainer.example.json new file mode 100644 index 0000000..f6399ce --- /dev/null +++ b/.devcontainer/devcontainer.example.json @@ -0,0 +1,14 @@ +{ + "name": "Laradock", + "dockerComposeFile": "../docker-compose.yml", + "remoteUser": "laradock", + "runServices": [ + "nginx", + "postgres", + "pgadmin" + ], + "service": "workspace", + "workspaceFolder": "/var/www", + "shutdownAction": "stopCompose", + "postCreateCommand": "uname -a" +} diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md deleted file mode 100644 index 8359c58..0000000 --- a/.github/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,46 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at mahmoud@zalt.me. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] - -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md deleted file mode 100644 index 7d5865b..0000000 --- a/.github/CONTRIBUTING.md +++ /dev/null @@ -1,3 +0,0 @@ -### First off, thanks for taking the time to contribute! - -For the contribution guide [click here](http://laradock.io/contributing/). diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 61a5c98..4000502 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,6 +1,5 @@ # DO NOT CHANGE THIS FILE PLEASE. +github: Mahmoudz open_collective: laradock -ko_fi: laradock -issuehunt: laradock -custom: ['beerpay.io/laradock/laradock', 'paypal.me/mzmmzz'] +custom: ['paypal.me/mzmmzz'] diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index eff16ef..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,23 +0,0 @@ -### Info: -- Docker version (`$ docker --version`): -- Laradock commit (`$ git rev-parse HEAD`): -- System info (Mac, PC, Linux): -- System info disto/version: - -### Issue: - -_____ - -### Expected behavior: - -_____ - -### Reproduce: - -_____ - -### Relevant Code: - -``` -// place a code sample here -``` diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..14edcca --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,50 @@ +--- +name: "Bug report" +about: "Report a general issue, encountered while using Laradock." +labels: "Type: Bug" +--- + +### Description: + + +### Expected Behavior: + + +### Context information: + +**Output of `git rev-parse HEAD`** + +``` +{paste here} +``` + +**Output of `docker version`** + +``` +{paste here} +``` + +**Output of `docker-compose version`** + +``` +{paste here} +``` + +**System info: Mac, Windows or Linux. Include which disto/version** + +``` +{paste here} +``` + +### Steps to reproduce the issue: + + +1. +2. +3. + +### Stacktrace & Additional info: + +``` +{paste here} +``` diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..18ff9f8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Support question + url: https://gitter.im/LaraDock/laradock + about: 'This repository is only for reporting bugs. If you need help, get in touch with us via Gitter.' diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..15ad6ff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: "Feature request" +about: "Suggest an idea for this project." +labels: "Type: Feature Request" +--- + +**Is your feature request related to a problem? Please describe.** + + +**Describe the solution you'd like** + + +**Describe alternatives you've considered** + + +**Additional context** + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 163c99c..85ca95d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,18 @@ - +## Description + + -##### I completed the 3 steps below: +## Motivation and Context + -- [ ] I've read the [Contribution Guide](http://laradock.io/contributing). -- [ ] I've updated the **documentation**. (refer to [this](http://laradock.io/contributing/#update-the-documentation-site) for how to do so). -- [ ] I enjoyed my time contributing and making developer's life easier :) +## Types of Changes + +- [] Bug fix (non-breaking change which fixes an issue). +- [] New feature (non-breaking change which adds functionality). +- [] Breaking change (fix or feature that would cause existing functionality to not work as expected). + +## Definition of Done Checklist: + +- [] I've read the [Contribution Guide](http://laradock.io/contributing). +- [] I've updated the **documentation**. (refer to [this](http://laradock.io/contributing/#update-the-documentation-site) for how to do so). +- [] I enjoyed my time contributing and making developer's life easier :) diff --git a/.github/README.md b/.github/README.md deleted file mode 100644 index c3b5c84..0000000 --- a/.github/README.md +++ /dev/null @@ -1,91 +0,0 @@ -

- Laradock Logo -

- -

PHP development environment that runs on Docker

- -

- Build status - GitHub stars - GitHub forks - GitHub issues - GitHub license - contributions welcome -

- -

Use Docker First - Then Learn About It Later

- -

- forthebadge -

- - ---- - -

- - Laradock Docs - -

- - -## Sponsors - - - - - - - - - - -For basic sponsorships go to [Open Collective](https://opencollective.com/laradock#sponsor), for golden sponsorships contact support@laradock.io. - -*Your logo will show up on the [github repository](https://github.com/laradock/laradock/) index page and the [documentation](http://laradock.io/) main page, with a link to your website.* - -## People - -#### Maintainers: -- [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 -- [TJ Miller](https://github.com/sixlive) @sixlive -- [Yu-Lung Shao (Allen)](https://github.com/bestlong) @bestlong -- [Milan Urukalo](https://github.com/urukalo) @urukalo -- [Vince Chu](https://github.com/vwchu) @vwchu -- [Huadong Zuo](https://github.com/zuohuadong) @zuohuadong -- [Lan Phan](https://github.com/lanphan) @lanphan -- [Ahkui](https://github.com/ahkui) @ahkui -- Join us. - -#### Awesome Contributors: - - - - -## Donations - -> Help keeping the project development going, by [contributing](http://laradock.io/contributing) or donating a little. -> Thanks in advance. - -Donate directly via [Paypal](https://paypal.me/mzmmzz) - -[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/mzmmzz) - -or show your support via [Beerpay](https://beerpay.io/laradock/laradock) - -[![Beerpay](https://beerpay.io/laradock/laradock/badge.svg?style=flat)](https://beerpay.io/laradock/laradock) - -or become a backer on [Open Collective](https://opencollective.com/laradock#backer) - - - - -## License - -[MIT License](https://github.com/laradock/laradock/blob/master/LICENSE) diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 0000000..323f966 --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,3 @@ +# Support Questions + +For help, please visit our official chatting room on [Gitter](https://gitter.im/Laradock/laradock). diff --git a/.github/home-page-images/join-us.png b/.github/home-page-images/join-us.png new file mode 100644 index 0000000..c97f75f Binary files /dev/null and b/.github/home-page-images/join-us.png differ diff --git a/.github/stale.yml b/.github/stale.yml new file mode 100644 index 0000000..dfadd79 --- /dev/null +++ b/.github/stale.yml @@ -0,0 +1,21 @@ +# Configuration for Github probot-stale - https://github.com/probot/stale + +# Number of days of inactivity before an issue becomes stale +daysUntilStale: 90 +# Number of days of inactivity before a stale issue is closed +daysUntilClose: 21 +# Issues with these labels will never be considered stale +exemptLabels: + - 'Type: Feature Request' +# Label to use when marking an issue as stale +staleLabel: Stale +# Comment to post when marking an issue as stale. Set to `false` to disable +markComment: > + Hi 👋 this issue has been automatically marked as `stale` 📌 because it has not had recent activity 😴. + It will be closed if no further activity occurs. Thank you for your contributions ❤️. +# Comment to post when closing a stale issue. Set to `false` to disable +closeComment: > + Hi again 👋 we would like to inform you that this issue has been automatically `closed` 🔒 because it had not recent activity during the `stale` period. + We really really appreciate your contributions, and looking forward for more in the future 🎈. +# Limit to only `issues` or `pulls` +only: issues diff --git a/.gitignore b/.gitignore index 0673206..e215d35 100644 --- a/.gitignore +++ b/.gitignore @@ -13,4 +13,8 @@ /nginx/ssl/*.key /nginx/ssl/*.csr -.DS_Store \ No newline at end of file +/.devcontainer/* +!/.devcontainer/devcontainer.example.json +!/.devcontainer/docker-compose.extend-example.yml + +.DS_Store diff --git a/.travis.yml b/.travis.yml index 8773aa3..4b68105 100644 --- a/.travis.yml +++ b/.travis.yml @@ -12,12 +12,14 @@ env: - PHP_VERSION=7.1 BUILD_SERVICE=workspace - PHP_VERSION=7.2 BUILD_SERVICE=workspace - PHP_VERSION=7.3 BUILD_SERVICE=workspace + - PHP_VERSION=7.4 BUILD_SERVICE=workspace - PHP_VERSION=5.6 BUILD_SERVICE=php-fpm - PHP_VERSION=7.0 BUILD_SERVICE=php-fpm - PHP_VERSION=7.1 BUILD_SERVICE=php-fpm - PHP_VERSION=7.2 BUILD_SERVICE=php-fpm - PHP_VERSION=7.3 BUILD_SERVICE=php-fpm + - PHP_VERSION=7.4 BUILD_SERVICE=php-fpm - PHP_VERSION=hhvm BUILD_SERVICE=hhvm @@ -26,12 +28,19 @@ env: - PHP_VERSION=7.1 BUILD_SERVICE=php-worker - PHP_VERSION=7.2 BUILD_SERVICE=php-worker - PHP_VERSION=7.3 BUILD_SERVICE=php-worker + - PHP_VERSION=7.4 BUILD_SERVICE=php-worker + + - PHP_VERSION=7.0 BUILD_SERVICE=laravel-horizon + - PHP_VERSION=7.1 BUILD_SERVICE=laravel-horizon + - PHP_VERSION=7.2 BUILD_SERVICE=laravel-horizon + - PHP_VERSION=7.3 BUILD_SERVICE=laravel-horizon + - PHP_VERSION=7.4 BUILD_SERVICE=laravel-horizon - PHP_VERSION=NA BUILD_SERVICE=solr - PHP_VERSION=NA BUILD_SERVICE="mssql rethinkdb aerospike" - PHP_VERSION=NA BUILD_SERVICE="blackfire minio percona nginx caddy apache2 mysql mariadb postgres postgres-postgis neo4j mongo redis cassandra" - PHP_VERSION=NA BUILD_SERVICE="adminer phpmyadmin pgadmin" - - PHP_VERSION=NA BUILD_SERVICE="memcached beanstalkd beanstalkd-console rabbitmq elasticsearch certbot mailhog maildev selenium jenkins proxy proxy2 haproxy" + - PHP_VERSION=NA BUILD_SERVICE="memcached beanstalkd beanstalkd-console rabbitmq elasticsearch certbot mailhog maildev selenium jenkins proxy proxy2 haproxy gearman" - PHP_VERSION=NA BUILD_SERVICE="kibana grafana laravel-echo-server" - PHP_VERSION=NA BUILD_SERVICE="ipython-controller manticore" # - PHP_VERSION=NA BUILD_SERVICE="aws" diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..6d8e9ee --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,5 @@ +{ + "files.associations": { + "Dockerfile-*": "dockerfile" + }, +} diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..4d6e306 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Laradock Code of Conduct + +We follow the [Contributor Covenant](https://www.contributor-covenant.org/version/1/4/code-of-conduct) Code of Conduct. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..74868e1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# Thank you for your consideration + +Checkout out our [contribution guide](http://laradock.io/contributing). diff --git a/DOCUMENTATION/config.toml b/DOCUMENTATION/config.toml index 8fd6062..56e4fe0 100644 --- a/DOCUMENTATION/config.toml +++ b/DOCUMENTATION/config.toml @@ -17,7 +17,7 @@ googleAnalytics = "UA-37514928-9" # Repository provider = "" - repo_url = "" + repo_url = "https://github.com/laradock/laradock" version = "" logo = "images/logo.png" @@ -26,7 +26,7 @@ googleAnalytics = "UA-37514928-9" permalink = "#" # Custom assets - custom_css = [] + custom_css = ["custom-style.css"] custom_js = [] # Syntax highlighting theme @@ -43,7 +43,7 @@ googleAnalytics = "UA-37514928-9" [social] twitter = "" github = "laradock/laradock" - email = "" + email = "support@laradock.io" # ------- MENU START ----------------------------------------- @@ -63,29 +63,24 @@ googleAnalytics = "UA-37514928-9" weight = 3 [[menu.main]] - name = "4. Guides" - url = "guides/" + name = "4. Help & Questions" + url = "help/" weight = 4 [[menu.main]] - name = "5. Help & Questions" - url = "help/" + name = "5. Related Projects" + url = "related-projects/" weight = 5 [[menu.main]] - name = "6. Related Projects" - url = "related-projects/" + name = "6. Contributing" + url = "contributing/" weight = 6 [[menu.main]] - name = "7. Contributing" - url = "contributing/" - weight = 7 - -[[menu.main]] - name = "8. License" + name = "7. License" url = "license/" - weight = 8 + weight = 7 # ------- MENU END ----------------------------------------- diff --git a/DOCUMENTATION/content/contributing/index.md b/DOCUMENTATION/content/contributing/index.md index 1d58dcf..dbe3efb 100644 --- a/DOCUMENTATION/content/contributing/index.md +++ b/DOCUMENTATION/content/contributing/index.md @@ -204,4 +204,4 @@ After your pull request is merged, you can safely delete your branch and pull th
-#### Happy Coding :) +## Happy Coding :) diff --git a/DOCUMENTATION/content/documentation/index.md b/DOCUMENTATION/content/documentation/index.md index a9aeb8a..8bf6247 100644 --- a/DOCUMENTATION/content/documentation/index.md +++ b/DOCUMENTATION/content/documentation/index.md @@ -76,7 +76,7 @@ docker-compose exec mysql bash *Example: enter to MySQL prompt within MySQL container* ```bash -docker-compose exec mysql mysql -u homestead -psecret +docker-compose exec mysql mysql -udefault -psecret ``` 3 - To exit a container, type `exit`. @@ -250,7 +250,6 @@ docker-compose build php-fpm
## Change the PHP-CLI Version -By default **PHP-CLI 7.0** is running. >Note: it's not very essential to edit the PHP-CLI version. The PHP-CLI is only used for the Artisan Commands & Composer. It doesn't serve your Application code, this is the PHP-FPM job. @@ -273,10 +272,6 @@ docker-compose build workspace ``` - - - -
## Install xDebug @@ -315,6 +310,29 @@ Note: If `.php-fpm/xdebug` doesn't execute and gives `Permission Denied` error t +
+ +## Install pcov + +1 - First install `pcov` in the Workspace and the PHP-FPM Containers: +
+a) open the `.env` file +
+b) search for the `WORKSPACE_INSTALL_PCOV` argument under the Workspace Container +
+c) set it to `true` +
+d) search for the `PHP_FPM_INSTALL_PCOV` argument under the PHP-FPM Container +
+e) set it to `true` + +2 - Re-build the containers `docker-compose build workspace php-fpm` + +Note that pcov is only supported on PHP 7.1 or newer. For more information on setting up pcov optimally, check the recommended section +of the [README](https://github.com/krakjoe/pcov) + + +
## Install phpdbg @@ -537,13 +555,19 @@ Note: Should add `--user=laradock` (example `docker-compose exec --user=laradock php artisan ``` ```bash -Composer update +composer update ``` ```bash phpunit ``` - - +``` +vue serve +``` +(browse the results at `http://localhost:[WORKSPACE_VUE_CLI_SERVE_HOST_PORT]`) +``` +vue ui +``` +(browse the results at `http://localhost:[WORKSPACE_VUE_CLI_UI_HOST_PORT]`) @@ -651,7 +675,7 @@ docker-compose up -d metabase 1) Boot the container `docker-compose up -d jenkins`. To enter the container type `docker-compose exec jenkins bash`. -2) Go to `http://localhost:8090/` (if you didn't chanhed your default port mapping) +2) Go to `http://localhost:8090/` (if you didn't change your default port mapping) 3) Authenticate from the web app. @@ -675,6 +699,7 @@ You may wanna change the default security configuration, so go to `http://localh
+ ## Use Redis 1 - First make sure you run the Redis Container (`redis`) with the `docker-compose up` command. @@ -762,12 +787,81 @@ Read the [Laravel official documentation](https://laravel.com/docs/5.7/redis#con ``` +
+ +## Use Varnish +The goal was to proxy request to varnish server using nginx. So only nginx has been configured for Varnish proxy. +Nginx is on port 80 or 443. Nginx sends request through varnish server and varnish server sends request back to nginx on port 81 (external port is defined in `VARNISH_BACKEND_PORT`). +The idea was taken from this [post](https://www.linode.com/docs/websites/varnish/use-varnish-and-nginx-to-serve-wordpress-over-ssl-and-http-on-debian-8/) + +The Varnish configuration was developed and tested for Wordpress only. Probably it works with other systems. + +#### Steps to configure varnish proxy server: +1. You have to set domain name for VARNISH_PROXY1_BACKEND_HOST variable. +2. If you want to use varnish for different domains, you have to add new configuration section in your env file. + ``` + VARNISH_PROXY1_CACHE_SIZE=128m + VARNISH_PROXY1_BACKEND_HOST=replace_with_your_domain.name + VARNISH_PROXY1_SERVER=SERVER1 + ``` +3. Then you have to add new config section into docker-compose.yml with related variables: + ``` + custom_proxy_name: + container_name: custom_proxy_name + 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} + ports: + - "${VARNISH_PORT}:${VARNISH_PORT}" + links: + - workspace + networks: + - frontend + ``` +4. change your varnish config and add nginx configuration. Example Nginx configuration is here: `nginx/sites/laravel_varnish.conf.example`. +5. `varnish/default.vcl` is old varnish configuration, which was used in the previous version. Use `default_wordpress.vcl` instead. + +#### How to run: +1. Rename `default_wordpress.vcl` to `default.vcl` +2. `docker-compose up -d nginx` +3. `docker-compose up -d proxy` + +Keep in mind that varnish server must be built after Nginx cause varnish checks domain affordability. + +#### FAQ: + +1. How to purge cache?
+run from any cli:
`curl -X PURGE https://yourwebsite.com/`. +2. How to reload varnish?
+`docker container exec proxy varnishreload` +3. Which varnish commands are allowed? + - varnishadm + - varnishd + - varnishhist + - varnishlog + - varnishncsa + - varnishreload + - varnishstat + - varnishtest + - varnishtop +4. How to reload Nginx?
+`docker exec Nginx nginx -t`
+`docker exec Nginx nginx -s reload`
+ ## Use Mongo 1 - First install `mongo` in the Workspace and the PHP-FPM Containers: @@ -1045,6 +1139,7 @@ _Note: You can customize the port on which beanstalkd console is listening by ch
+ ## Use Confluence 1 - Run the Confluence Container (`confluence`) with the `docker-compose up` command. Example: @@ -1055,10 +1150,19 @@ docker-compose up -d confluence 2 - Open your browser and visit the localhost on port **8090**: `http://localhost:8090` -**Note:** You can you trial version and then you have to buy a licence to use it. +**Note:** Confluence is a licensed application - an evaluation licence can be obtained from Atlassian. You can set custom confluence version in `CONFLUENCE_VERSION`. [Find more info in section 'Versioning'](https://hub.docker.com/r/atlassian/confluence-server/) + +##### Confluence usage with Nginx and SSL. + +1. Find an instance configuration file in `nginx/sites/confluence.conf.example` and replace sample domain with yours. + +2. Configure ssl keys to your domain. + +Keep in mind that Confluence is still accessible on 8090 anyway. +
## Use ElasticSearch @@ -1491,6 +1595,13 @@ To add locales to the container: 4 - Check enabled locales with `docker-compose exec php-fpm locale -a` +Update the locale setting, default is `POSIX` + +1 - Open the `.env` file and set `PHP_FPM_DEFAULT_LOCALE` to `en_US.UTF8` or other locale you want. + +2 - Re-build your PHP-FPM Container `docker-compose build php-fpm`. + +3 - Check the default locale with `docker-compose exec php-fpm locale`
@@ -1576,7 +1687,7 @@ The default username and password for the root MySQL user are `root` and `root ` 1 - Enter the MySQL container: `docker-compose exec mysql bash`. -2 - Enter mysql: `mysql -uroot -proot` for non root access use `mysql -uhomestead -psecret`. +2 - Enter mysql: `mysql -uroot -proot` for non root access use `mysql -udefault -psecret`. 3 - See all users: `SELECT User FROM mysql.user;` @@ -1785,7 +1896,11 @@ To install NPM VUE CLI in the Workspace container 2 - Search for the `WORKSPACE_INSTALL_NPM_VUE_CLI` argument under the Workspace Container and set it to `true` -3 - Re-build the container `docker-compose build workspace` +3 - Change `vue serve` port using `WORKSPACE_VUE_CLI_SERVE_HOST_PORT` if you wish to (default value is 8080) + +4 - Change `vue ui` port using `WORKSPACE_VUE_CLI_UI_HOST_PORT` if you wish to (default value is 8001) + +5 - Re-build the container `docker-compose build workspace` @@ -1841,7 +1956,21 @@ To install FFMPEG in the Workspace container **PS** Don't forget to install the binary in the `php-fpm` container too by applying the same steps above to its container, otherwise the you'll get an error when running the `php-ffmpeg` binary. +
+ +## Install wkhtmltopdf +[wkhtmltopdf](https://wkhtmltopdf.org/) is a utility for outputting a PDF from HTML + +To install wkhtmltopdf in the Workspace container + +1 - Open the `.env` file + +2 - Search for the `WORKSPACE_INSTALL_WKHTMLTOPDF` argument under the Workspace Container and set it to `true` + +3 - Re-build the container `docker-compose build workspace` + +**PS** Don't forget to install the binary in the `php-fpm` container too by applying the same steps above to its container, otherwise the you'll get an error when running the `wkhtmltopdf` binary. @@ -1866,6 +1995,29 @@ To install GNU Parallel in the Workspace container +
+ +## Install Supervisor + +Supervisor is a client/server system that allows its users to monitor and control a number of processes on UNIX-like operating systems. + +(see http://supervisord.org/index.html) + +To install Supervisor in the Workspace container + +1 - Open the `.env` file + +2 - Set `WORKSPACE_INSTALL_SUPERVISOR` and `WORKSPACE_INSTALL_PYTHON` to `true`. + +3 - Create supervisor configuration file (for ex., named `laravel-worker.conf`) for Laravel Queue Worker in `php-worker/supervisord.d/` by simply copy from `laravel-worker.conf.example` + +4 - Re-build the container `docker-compose build workspace` Or `docker-composer up --build -d workspace` + + + + + +

@@ -1974,6 +2126,45 @@ YAML PHP extension allows you to easily parse and create YAML structured data. I 4 - Re-build the container `docker-compose build php-fpm`
+ + +
+ +## Install AST PHP extension +AST exposes the abstract syntax tree generated by PHP 7+. This extension is required by tools such as `Phan`, a static analyzer for PHP. + +1 - Open the `.env` file + +2 - Search for the `WORKSPACE_INSTALL_AST` argument under the Workspace Container + +3 - Set it to `true` + +4 - Re-build the container `docker-compose build workspace` + +**Note** If you need a specific version of AST then search for the `WORKSPACE_AST_VERSION` argument under the Workspace Container and set it to the desired version and continue step 4. + + + + +
+ +## Install Git Bash Prompt +A bash prompt that displays information about the current git repository. In particular the branch name, difference with remote branch, number of files staged, changed, etc. + +1 - Open the `.env` file + +2 - Search for the `WORKSPACE_INSTALL_GIT_PROMPT` argument under the Workspace Container + +3 - Set it to `true` + +4 - Re-build the container `docker-compose build workspace` + +**Note** You can configure bash-git-prompt by editing the `workspace/gitprompt.sh` file and re-building the workspace container. +For configuration information, visit the [bash-git-prompt repository](https://github.com/magicmonty/bash-git-prompt). + + + +
## PHPStorm Debugging Guide @@ -1983,6 +2174,19 @@ Remote debug Laravel web and phpunit tests. +
+ +## Setup Google Cloud for docker registry + +``` +gcloud auth configure-docker +``` + +Login to gcloud for use the registry and auth the permission. + +``` +gcloud auth login +``` diff --git a/DOCUMENTATION/content/getting-started/index.md b/DOCUMENTATION/content/getting-started/index.md index f71661d..df19354 100644 --- a/DOCUMENTATION/content/getting-started/index.md +++ b/DOCUMENTATION/content/getting-started/index.md @@ -221,8 +221,12 @@ Or you can change them and rebuild the container.
5 - Open your browser and visit your localhost address. +Make sure you add use the right port number as provided by your running server. + +[http://localhost](http://localhost) + If you followed the multiple projects setup, you can visit `http://project-1.test/` and `http://project-2.test/`. -[http://localhost:8080](http://localhost:8080) -Make sure you add use the right port number as provided by your running server. Ex: NGINX uses port 8080 by default while Apache2 uses 80. + + diff --git a/DOCUMENTATION/content/guides/index.md b/DOCUMENTATION/content/guides/index.md deleted file mode 100644 index 451c002..0000000 --- a/DOCUMENTATION/content/guides/index.md +++ /dev/null @@ -1,868 +0,0 @@ ---- -title: 4. Guides -type: index -weight: 4 ---- - - - -## 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 -``` - -### Enter the laradock folder and rename env-example to .env. -``` -$root@server:~/laravel/laradock# cp env-example .env -``` - -### 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 -``` - -### Execute commands - -If you want to only execute some command and don't want to enter bash, you can execute `docker-compose run workspace `. - -``` -docker-compose run workspace php artisan migrate -``` - -### 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# docker-compose down -$root@server:~/laravel/laradock# 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# 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# docker-compose down -$root@server:~/laravel/laradock# 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) - -
-
-
-
-
- - -## Running Laravel Dusk Tests - -### Option 1: Without Selenium - -- [Intro](#option1-dusk-intro) -- [Workspace Setup](#option1-workspace-setup) -- [Application Setup](#option1-application-setup) -- [Choose Chrome Driver Version (Optional)](#option1-choose-chrome-driver-version) -- [Run Dusk Tests](#option1-run-dusk-tests) - -#### Intro - -This is a guide to run Dusk tests in your `workspace` container with headless -google-chrome and chromedriver. It has been tested with Laravel 5.4 and 5.5. - -#### Workspace Setup - -Update your .env with following entries: - -``` -... -# Install Laravel installer bin to setup demo app -WORKSPACE_INSTALL_LARAVEL_INSTALLER=true -... -# Install all the necessary dependencies for running Dusk tests -WORKSPACE_INSTALL_DUSK_DEPS=true -... -``` - -Then run below to build your workspace. - -``` -docker-compose build workspace -``` - -#### Application Setup - -Run a `workspace` container and you will be inside the container at `/var/www` directory. - -``` -docker-compose run workspace bash - -/var/www#> _ -``` - -Create new Laravel application named `dusk-test` and install Laravel Dusk package. - -``` -/var/www> laravel new dusk-test -/var/www> cd dusk-test -/var/www/dusk-test> composer require --dev laravel/dusk -/var/www/dusk-test> php artisan dusk:install -``` - -Create `.env.dusk.local` by copying from `.env` file. - -``` -/var/www/dusk-test> cp .env .env.dusk.local -``` - -Update the `APP_URL` entry in `.env.dusk.local` to local Laravel server. - -``` -APP_URL=http://localhost:8000 -``` - -You will need to run chromedriver with `headless` and `no-sandbox` flag. In Laravel Dusk 2.x it is -already set `headless` so you just need to add `no-sandbox` flag. If you on previous version 1.x, -you will need to update your `DustTestCase#driver` as shown below. - - -``` -addArguments([ - '--disable-gpu', - '--headless', - '--no-sandbox' - ]); - - return RemoteWebDriver::create( - 'http://localhost:9515', DesiredCapabilities::chrome()->setCapability( - ChromeOptions::CAPABILITY, $options - ) - ); - } -} -``` - -#### Choose Chrome Driver Version (Optional) - -You could choose to use either: - -1. Chrome Driver shipped with Laravel Dusk. (Default) -2. Chrome Driver installed in `workspace` container. (Required tweak on DuskTestCase class) - -For Laravel 2.x, you need to update `DuskTestCase#prepare` method if you wish to go with option #2. - -``` - -setPrefix('chromedriver') - ->getProcess() - ->setEnv(static::chromeEnvironment()); - } - - ... -} -``` - -#### Run Dusk Tests - -Run local server in `workspace` container and run Dusk tests. - -``` -# alias to run Laravel server in the background (php artisan serve --quiet &) -/var/www/dusk-test> serve -# alias to run Dusk tests (php artisan dusk) -/var/www/dusk-test> dusk - -PHPUnit 6.4.0 by Sebastian Bergmann and contributors. - -. 1 / 1 (100%) - -Time: 837 ms, Memory: 6.00MB -``` - -### Option 2: With Selenium - -- [Intro](#dusk-intro) -- [DNS Setup](#dns-setup) -- [Docker Compose Setup](#docker-compose) -- [Laravel Dusk Setup](#laravel-dusk-setup) -- [Running Laravel Dusk Tests](#running-tests) - -#### Intro -Setting up Laravel Dusk tests to run with Laradock appears be something that -eludes most Laradock users. This guide is designed to show you how to wire them -up to work together. This guide is written with macOS and Linux in mind. As such, -it's only been tested on macOS. Feel free to create pull requests to update the guide -for Windows-specific instructions. - -This guide assumes you know how to use a DNS forwarder such as `dnsmasq` or are comfortable -with editing the `/etc/hosts` file for one-off DNS changes. - -#### DNS Setup -According to RFC-2606, only four TLDs are reserved for local testing[^1]: - -- `.test` -- `.example` -- `.invalid` -- `.localhost` - -A common TLD used for local development is `.dev`, but newer versions of Google -Chrome (such as the one bundled with the Selenium Docker image), will fail to -resolve that DNS as there will appear to be a name collision. - -The recommended extension is `.test` for your Laravel web apps because you're -running tests. Using a DNS forwarder such as `dnsmasq` or by editing the `/etc/hosts` -file, configure the host to point to `localhost`. - -For example, in your `/etc/hosts` file: -``` -## -# Host Database -# -# localhost is used to configure the loopback interface -# when the system is booting. Do not change this entry. -## -127.0.0.1 localhost -255.255.255.255 broadcasthost -::1 localhost -127.0.0.1 myapp.test -``` - -This will ensure that when navigating to `myapp.test`, it will route the -request to `127.0.0.1` which will be handled by Nginx in Laradock. - -#### Docker Compose setup -In order to make the Selenium container talk to the Nginx container appropriately, -the `docker-compose.yml` needs to be edited to accommodate this. Make the following -changes: - -```yaml -... -selenium: - ... - depends_on: - - nginx - links: - - nginx: -``` - -This allows network communication between the Nginx and Selenium containers -and it also ensures that when starting the Selenium container, the Nginx -container starts up first unless it's already running. This allows -the Selenium container to make requests to the Nginx container, which is -necessary for running Dusk tests. These changes also link the `nginx` environment -variable to the domain you wired up in your hosts file. - -#### Laravel Dusk Setup - -In order to make Laravel Dusk make the proper request to the Selenium container, -you have to edit the `DuskTestCase.php` file that's provided on the initial -installation of Laravel Dusk. The change you have to make deals with the URL the -Remote Web Driver attempts to use to set up the Selenium session. - -One recommendation for this is to add a separate config option in your `.env.dusk.local` -so it's still possible to run your Dusk tests locally should you want to. - -##### .env.dusk.local -``` -... -USE_SELENIUM=true -``` - -##### DuskTestCase.php -```php -abstract class DuskTestCase extends BaseTestCase -{ -... - protected function driver() - { - if (env('USE_SELENIUM', 'false') == 'true') { - return RemoteWebDriver::create( - 'http://selenium:4444/wd/hub', DesiredCapabilities::chrome() - ); - } else { - return RemoteWebDriver::create( - 'http://localhost:9515', DesiredCapabilities::chrome() - ); - } - } -} -``` - -#### Running Laravel Dusk Tests - -Now that you have everything set up, to run your Dusk tests, you have to SSH -into the workspace container as you normally would: -```docker-compose exec --user=laradock workspace bash``` - -Once inside, you can change directory to your application and run: - -```php artisan dusk``` - -One way to make this easier from your project is to create a helper script. Here's one such example: -```bash -#!/usr/bin/env sh - -LARADOCK_HOME="path/to/laradock" - -pushd ${LARADOCK_HOME} - -docker-compose exec --user=laradock workspace bash -c "cd my-project && php artisan dusk && exit" -``` - -This invokes the Dusk command from inside the workspace container but when the script completes -execution, it returns your session to your project directory. - -[^1]: [Don't Use .dev for Development](https://iyware.com/dont-use-dev-for-development/) - - -
-
-
-
-
- - -## PHPStorm XDebug Setup - -- [Intro](#Intro) -- [Installation](#Installation) - - [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) - -### 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`, -you should be able to adjust accordingly. This guide was written based on Docker for Windows Native. - -### 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`. - -### 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](images/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](images/photos/SimpleHostsEditor/AddHost_laravel.png). - - -### 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. - -- 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. - -#### Edit laradock/docker-compose.yml -Set the following variables: -``` -### Workspace Utilities Container ############### - - workspace: - build: - context: ./workspace - args: - - INSTALL_XDEBUG=true - - INSTALL_WORKSPACE_SSH=true - ... - - -### PHP-FPM Container ##################### - - php-fpm: - build: - context: ./php-fpm - args: - - INSTALL_XDEBUG=true - ... - -``` - -#### Edit xdebug.ini files -- `laradock/workspace/xdebug.ini` -- `laradock/php-fpm/xdebug.ini` - -Set the following variables: - -``` -xdebug.remote_autostart=1 -xdebug.remote_enable=1 -xdebug.remote_connect_back=1 -xdebug.cli_color=1 -``` - - -#### Need to clean house first? - -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). - -`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: -`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. - -``` -dclean() { - processes=`docker ps -q -f status=exited` - if [ -n "$processes" ]; then - docker rm $processes - fi - - images=`docker images -q -f dangling=true` - if [ -n "$images" ]; then - docker rmi $images - fi -} -``` - -- If you frequently switch configurations for Laradock, you may find that adding the following and added to your `.bashrc` or equivalent useful: - -``` -# remove laravel* containers -# remove laravel_* images -dcleanlaradockfunction() -{ - echo 'Removing ALL containers associated with laradock' - docker ps -a | awk '{ print $1,$2 }' | grep laradock | awk '{print $1}' | xargs -I {} docker rm {} - - # remove ALL images associated with laradock_ - # does NOT delete laradock/* which are hub images - echo 'Removing ALL images associated with laradock_' - docker images | awk '{print $1,$2,$3}' | grep laradock_ | awk '{print $3}' | xargs -I {} docker rmi {} - - echo 'Listing all laradock docker hub images...' - docker images | grep laradock - - echo 'dcleanlaradock completed' -} -# associate the above function with an alias -# so can recall/lookup by typing 'alias' -alias dcleanlaradock=dcleanlaradockfunction -``` - - -### Let's get a dial-tone with Laravel - -``` -# barebones at this point -docker-compose up -d nginx mysql - -# run -docker-compose ps - -# Should see: - Name Command State Ports ------------------------------------------------------------------------------------------------------------ -laradock_mysql_1 docker-entrypoint.sh mysqld Up 0.0.0.0:3306->3306/tcp -laradock_nginx_1 nginx Up 0.0.0.0:443->443/tcp, 0.0.0.0:80->80/tcp -laradock_php-fpm_1 php-fpm Up 9000/tcp -laradock_volumes_data_1 true Exit 0 -laradock_volumes_source_1 true Exit 0 -laradock_workspace_1 /sbin/my_init Up 0.0.0.0:2222->22/tcp -``` - -### Enable xDebug on php-fpm - -In a host terminal sitting in the laradock folder, run: `./php-fpm/xdebug status` -You should see something like the following: - -``` -xDebug status -laradock_php-fpm_1 -PHP 7.0.9 (cli) (built: Aug 10 2016 19:45:48) ( NTS ) -Copyright (c) 1997-2016 The PHP Group -Zend Engine v3.0.0, Copyright (c) 1998-2016 Zend Technologies - with Xdebug v2.4.1, Copyright (c) 2002-2016, by Derick Rethans -``` - -Other commands include `./php-fpm/xdebug start | stop`. - -If you have enabled `xdebug=true` in `docker-compose.yml/php-fpm`, `xdebug` will already be running when -`php-fpm` is started and listening for debug info on port 9000. - - -### PHPStorm Settings - -- Here are some settings that are known to work: - - `Settings/BuildDeploymentConnection` - - ![Settings/BuildDeploymentConnection](/images/photos/PHPStorm/Settings/BuildDeploymentConnection.png) - - - `Settings/BuildDeploymentConnectionMappings` - - ![Settings/BuildDeploymentConnectionMappings](/images/photos/PHPStorm/Settings/BuildDeploymentConnectionMappings.png) - - - `Settings/BuildDeploymentDebugger` - - ![Settings/BuildDeploymentDebugger](/images/photos/PHPStorm/Settings/BuildDeploymentDebugger.png) - - - `Settings/EditRunConfigurationRemoteWebDebug` - - ![Settings/EditRunConfigurationRemoteWebDebug](/images/photos/PHPStorm/Settings/EditRunConfigurationRemoteWebDebug.png) - - - `Settings/EditRunConfigurationRemoteExampleTestDebug` - - ![Settings/EditRunConfigurationRemoteExampleTestDebug](/images/photos/PHPStorm/Settings/EditRunConfigurationRemoteExampleTestDebug.png) - - - `Settings/LangsPHPDebug` - - ![Settings/LangsPHPDebug](/images/photos/PHPStorm/Settings/LangsPHPDebug.png) - - - `Settings/LangsPHPInterpreters` - - ![Settings/LangsPHPInterpreters](/images/photos/PHPStorm/Settings/LangsPHPInterpreters.png) - - - `Settings/LangsPHPPHPUnit` - - ![Settings/LangsPHPPHPUnit](/images/photos/PHPStorm/Settings/LangsPHPPHPUnit.png) - - - `Settings/LangsPHPServers` - - ![Settings/LangsPHPServers](/images/photos/PHPStorm/Settings/LangsPHPServers.png) - - - `RemoteHost` - To switch on this view, go to: `Menu/Tools/Deployment/Browse Remote Host`. - - ![RemoteHost](/images/photos/PHPStorm/RemoteHost.png) - - - `RemoteWebDebug` - - ![DebugRemoteOn](/images/photos/PHPStorm/DebugRemoteOn.png) - - - `EditRunConfigurationRemoteWebDebug` - Go to: `Menu/Run/Edit Configurations`. - - ![EditRunConfigurationRemoteWebDebug](/images/photos/PHPStorm/Settings/EditRunConfigurationRemoteWebDebug.png) - - - `EditRunConfigurationRemoteExampleTestDebug` - Go to: `Menu/Run/Edit Configurations`. - - ![EditRunConfigurationRemoteExampleTestDebug](/images/photos/PHPStorm/Settings/EditRunConfigurationRemoteExampleTestDebug.png) - - - `WindowsFirewallAllowedApps` - Go to: `Control Panel\All Control Panel Items\Windows Firewall\Allowed apps`. - - ![WindowsFirewallAllowedApps.png](/images/photos/PHPStorm/Settings/WindowsFirewallAllowedApps.png) - - - `hosts` - Edit: `C:\Windows\System32\drivers\etc\hosts`. - - ![WindowsFirewallAllowedApps.png](/images/photos/PHPStorm/Settings/hosts.png) - - - [Enable xDebug on php-fpm](#enablePhpXdebug) - - - -### Usage - -#### Run ExampleTest -- right-click on `tests/ExampleTest.php` - - Select: `Run 'ExampleTest.php'` or `Ctrl+Shift+F10`. - - Should pass!! You just ran a remote test via SSH! - -#### Debug ExampleTest -- Open to edit: `tests/ExampleTest.php` -- Add a BreakPoint on line 16: `$this->visit('/')` -- right-click on `tests/ExampleTest.php` - - Select: `Debug 'ExampleTest.php'`. - - Should have stopped at the BreakPoint!! You are now debugging locally against a remote Laravel project via SSH! - - ![Remote Test Debugging Success](/images/photos/PHPStorm/RemoteTestDebuggingSuccess.png) - -#### Debug WebSite -- In case xDebug is disabled, from the `laradock` folder run: -`./php-fpm/xdebug start`. - - To switch xdebug off, run: -`./php-fpm/xdebug stop` - -- Start Remote Debugging - - ![DebugRemoteOn](/images/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/) - - Should have stopped at the BreakPoint!! You are now debugging locally against a remote Laravel project via SSH! - - ![Remote Debugging Success](/images/photos/PHPStorm/RemoteDebuggingSuccess.png) - - -### Let's shell into workspace -Assuming that you are in laradock folder, type: -`ssh -i workspace/insecure_id_rsa -p2222 root@laravel` -**Cha Ching!!!!** -- `workspace/insecure_id_rsa.ppk` may become corrupted. In which case: - - fire up `puttygen` - - import `workspace/insecure_id_rsa` - - save private key to `workspace/insecure_id_rsa.ppk` - -#### 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: - - ![Session](/images/photos/KiTTY/Session.png) - - ![Terminal](/images/photos/KiTTY/Terminal.png) - - ![Window](/images/photos/KiTTY/Window.png) - - ![WindowAppearance](/images/photos/KiTTY/WindowAppearance.png) - - ![Connection](/images/photos/KiTTY/Connection.png) - - ![ConnectionData](/images/photos/KiTTY/ConnectionData.png) - - ![ConnectionSSH](/images/photos/KiTTY/ConnectionSSH.png) - - ![ConnectionSSHAuth](/images/photos/KiTTY/ConnectionSSHAuth.png) - - ![TerminalShell](/images/photos/KiTTY/TerminalShell.png) - -
-
-
-
-
- - -## Setup remote debugging for PhpStorm on Linux - - - Make sure you have followed the steps above in the [Install Xdebug section](#install-xdebug). - - - Make sure Xdebug accepts connections and listens on port 9000. (Should be default configuration). - -![Debug Configuration](/images/photos/PHPStorm/linux/configuration/debugConfiguration.png "Debug Configuration"). - - - Create a server with name `laradock` (matches **PHP_IDE_CONFIG** key in environment file) and make sure to map project root path with server correctly. - -![Server Configuration](/images/photos/PHPStorm/linux/configuration/serverConfiguration.png "Server Configuration"). - - - Start listening for debug connections, place a breakpoint and you are good to go ! diff --git a/DOCUMENTATION/content/help/index.md b/DOCUMENTATION/content/help/index.md index 1d971c5..8267bc5 100644 --- a/DOCUMENTATION/content/help/index.md +++ b/DOCUMENTATION/content/help/index.md @@ -6,6 +6,8 @@ weight: 5 Join the chat room on [Gitter](https://gitter.im/Laradock/laradock) and get help and support from the community. +[![Gitter](https://badges.gitter.im/Laradock/laradock.svg)](https://gitter.im/Laradock/laradock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) + 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). @@ -41,7 +43,7 @@ Use `http://127.0.0.1` instead of `http://localhost` in your browser.
-## I see an error message containing `address already in use` or `port is already allocated` +## I see an error message containing (address already in use) or (port is already allocated) Make sure the ports for the services that you are trying to run (22, 80, 443, 3306, etc.) are not being used already by other programs on the host, such as a built in `apache`/`httpd` service or other development tools you have installed. @@ -85,7 +87,7 @@ This error sometimes happens because your Laravel application isn't running on t * 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` -## I get stuck when building nginx on `fetch http://mirrors.aliyun.com/alpine/v3.5/main/x86_64/APKINDEX.tar.gz` +## I get stuck when building nginx on (fetch mirrors.aliyun.com/alpine/v3.5/main/x86_64/APKINDEX.tar.gz) As stated on [#749](https://github.com/laradock/laradock/issues/749#issuecomment-419652646), Already fixed，just set `CHANGE_SOURCE` to false. @@ -101,7 +103,7 @@ WORKSPACE_COMPOSER_REPO_PACKAGIST=https://packagist.phpcomposer.com
-## I get `Module build failed: Error: write EPIPE` while compiling react application +## I got (Module build failed: Error: write EPIPE) while compiling react application When you run `npm build` or `yarn dev` building a react application using webpack with elixir you may receive a `Error: write EPIPE` while processing .jpg images. diff --git a/DOCUMENTATION/content/introduction/index.md b/DOCUMENTATION/content/introduction/index.md index 143faa2..5dcc92d 100644 --- a/DOCUMENTATION/content/introduction/index.md +++ b/DOCUMENTATION/content/introduction/index.md @@ -4,34 +4,34 @@ type: index weight: 1 --- +Laradock is a full PHP development environment based on Docker. -## Use Docker First - Then Learn About It Later - -Laradock is a PHP development environment that runs on Docker. - -Supports a variety of useful Docker Images, pre-configured to provide a wonderful PHP development environment. +Supporting a variety of common services, all pre-configured to provide a full PHP development environment. -![](https://raw.githubusercontent.com/laradock/laradock/master/.github/home-page-images/laradock-logo.jpg) + +## Features +- Easy switch between PHP versions: 7.4, 7.3, 7.2, 7.1, 5.6... +- Choose your favorite database engine: MySQL, Postgres, MariaDB... +- Run your own stack: Memcached, HHVM, RabbitMQ... +- Each software runs on its own 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. - - - -## Sponsors - - - - - - - - - - -For basic sponsorships go to [Open Collective](https://opencollective.com/laradock#sponsor), for golden sponsorships contact support@laradock.io.
-*Your logo will show up on the [github repository](https://github.com/laradock/laradock/) index page and the [documentation](http://laradock.io/) main page, with a link to your website.* + +--- +### Use Docker First - Then Learn About It Later +--- + ## Quick Overview @@ -72,25 +72,6 @@ That's it! enjoy :) - -## Features - -- Easy switch between PHP versions: 7.3, 7.2, 7.1, 5.6... -- Choose your favorite database engine: MySQL, Postgres, MariaDB... -- Run your own stack: Memcached, HHVM, RabbitMQ... -- Each software runs on its own 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. - - - ## Supported Software (Docker Images) @@ -149,6 +130,7 @@ That's it! enjoy :) - Eclipse Mosquitto - PHP Worker - Laravel Horizon + - Gearman - **Mail Servers:** - Mailu @@ -223,77 +205,271 @@ You can choose, which tools to install in your workspace container and other con *If you can't find your Software in the list, build it yourself and submit it. Contributions are welcomed :)* - - - -## What is Docker? - -[Docker](https://www.docker.com) is an open platform for developing, shipping, and running applications. -Docker enables you to separate your applications from your infrastructure so you can deliver software quickly. -With Docker, you can manage your infrastructure in the same ways you manage your applications. -By taking advantage of Docker’s methodologies for shipping, testing, and deploying code quickly, you can significantly reduce the delay between writing code and running it in production. - - - - - - -## 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). - - - - - - - -## 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) - - - - +--- ## Chat with us -You are welcome to join our chat room on Gitter. +Feel free to join us 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) +--- +Laradock exists thanks to all the people who contribute. +## Project Maintainers + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ Mahmoud Zalt +
+ @mahmoudz + 		+ +
+ Bo-Yi Wu +
+ @appleboy + 		+ +
+ Philippe Trépanier +
+ @philtrep + 		+ +
+ Mike Erickson +
+ @mikeerickson + 		+ +
+ Dwi Fahni Denni +
+ @zeroc0d3 +
+ +
+ Thor Erik +
+ @thorerik + 		+ +
+ Winfried van Loon +
+ @winfried-van-loon + 		+ +
+ TJ Miller +
+ @sixlive + 		+ +
+ Yu-Lung Shao (Allen) +
+ @bestlong + 		+ +
+ Milan Urukalo +
+ @urukalo +
+ +
+ Vince Chu +
+ @vwchu + 		+ +
+ Huadong Zuo +
+ @zuohuadong + 		+ +
+ Lan Phan +
+ @lanphan + 		+ +
+ Ahkui +
+ @ahkui + 		+ +
+ < Join Us > +
+ @laradock +
+ +## Code Contributors + + + +--- -## Donations +## Financial Contributors -> Help keeping the project development going, by [contributing](http://laradock.io/contributing) or donating a little. -> Thanks in advance. +Contribute and help us sustain the project. -Donate directly via [Paypal](https://paypal.me/mzmmzz) +Option 1: Donate via [Paypal](https://paypal.me/mzmmzz). +
+Option 2: Become a Sponsor via [Github Sponsors](https://github.com/sponsors/Mahmoudz). +
+Option 3: Become a Sponsor/Backer via [Open Collective](https://opencollective.com/laradock/contribute). -[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/mzmmzz) + +## Sponsors -or show your support via [Beerpay](https://beerpay.io/laradock/laradock) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -[![Beerpay](https://beerpay.io/laradock/laradock/badge.svg?style=flat)](https://beerpay.io/laradock/laradock) +Support Laradock with your [organization](https://opencollective.com/laradock/contribute/). +
+Your logo will show up on the [github repository](https://github.com/laradock/laradock/) index page and the [documentation](http://laradock.io/) main page. +
+For more info contact support@laradock.io. -or become a backer on [Open Collective](https://opencollective.com/laradock#backer) + +## Backers + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- diff --git a/DOCUMENTATION/static/custom-style.css b/DOCUMENTATION/static/custom-style.css new file mode 100644 index 0000000..d25a5ac --- /dev/null +++ b/DOCUMENTATION/static/custom-style.css @@ -0,0 +1,30 @@ +/* Custom CSS */ + +.article a { + border-bottom: none; +} +.project .logo { + width: 200px; + padding-right: 0; +} +.project .banner { + height: 70px; + padding: 25px; +} +.palette-primary-deep-purple .article h1{ + color: #7e57c2; + font-size: 35px; +} +.palette-primary-deep-purple .article h2{ + + color: #ce2046; + font-size: 25px; +} +.palette-primary-deep-purple .article h3{ + color: #851d54; + font-size: 18px; +} +.palette-primary-deep-purple .article code{ + color: #851d54; + background: #eeeeeea8; +} diff --git a/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/single.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/single.html index af662ad..050f28d 100644 --- a/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/single.html +++ b/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/single.html @@ -24,20 +24,6 @@
- - - - - - - - -

{{ .Title }} {{ if .IsDraft }} (Draft){{ end }}

{{ .Content }} diff --git a/DOCUMENTATION/themes/hugo-material-docs/layouts/index.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/index.html index 5ee52d1..7f14e8b 100644 --- a/DOCUMENTATION/themes/hugo-material-docs/layouts/index.html +++ b/DOCUMENTATION/themes/hugo-material-docs/layouts/index.html @@ -1,8 +1,8 @@ {{ partial "head" . }} {{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }} - {{ $repo_id := replace .Site.Params.repo_url "https://github.com/" ""}} - {{ .Scratch.Set "repo_id" $repo_id }} + {{ $repo_id := replace .Site.Params.repo_url "https://github.com/" ""}} + {{ .Scratch.Set "repo_id" $repo_id }} {{ end }}
@@ -25,26 +25,29 @@
- -
- - - - - - - -
+ + + + + + + + +


+ laradock logo {{ range where .Site.Pages "Type" "index" }} -

{{ .Title }} {{ if .IsDraft }} (Draft){{ end }}

+





+
+
+

{{ .Title }} {{ if .IsDraft }} (Draft){{ end }}

- {{ .Content }} + {{ .Content }} {{ end }}