diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..61a5c983 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,6 @@ +# DO NOT CHANGE THIS FILE PLEASE. + +open_collective: laradock +ko_fi: laradock +issuehunt: laradock +custom: ['beerpay.io/laradock/laradock', 'paypal.me/mzmmzz'] diff --git a/.github/README.md b/.github/README.md deleted file mode 100644 index 834b8789..00000000 --- a/.github/README.md +++ /dev/null @@ -1,92 +0,0 @@ -

- Laradock Logo -

- -

A Docker PHP development environment that facilitates running PHP Apps on Docker

- -

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

- -

Use Docker First And Learn About It Later

- -

- forthebadge -

- - ---- - -

- - Laradock Docs - -

- - -## Sponsors - -Support this project by becoming a sponsor. - -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. [[Become a sponsor](https://opencollective.com/laradock#sponsor)] - - - - - - - - - - - - - -## Contributors - -#### Core 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 -- [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 -- Join us, by submitting 20 useful PR's. - -#### 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://www.paypal.me/mzalt) - -[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/mzalt) - -or become a backer on [Open Collective](https://opencollective.com/laradock#backer) - - - -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) - - -## License - -[MIT License](https://github.com/laradock/laradock/blob/master/LICENSE) diff --git a/.github/home-page-images/documentation-button.png b/.github/home-page-images/documentation-button.png new file mode 100644 index 00000000..4ab17161 Binary files /dev/null and b/.github/home-page-images/documentation-button.png differ diff --git a/.github/home-page-images/join-us.png b/.github/home-page-images/join-us.png new file mode 100644 index 00000000..c97f75f9 Binary files /dev/null and b/.github/home-page-images/join-us.png differ diff --git a/.travis.yml b/.travis.yml index d4731771..8773aa32 100644 --- a/.travis.yml +++ b/.travis.yml @@ -29,7 +29,7 @@ env: - 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" + - 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="kibana grafana laravel-echo-server" diff --git a/DOCUMENTATION/config.toml b/DOCUMENTATION/config.toml index 91fd0724..1d11afbd 100644 --- a/DOCUMENTATION/config.toml +++ b/DOCUMENTATION/config.toml @@ -26,7 +26,7 @@ googleAnalytics = "UA-37514928-9" permalink = "#" # Custom assets - custom_css = [] + custom_css = ["custom-style.css"] custom_js = [] # Syntax highlighting theme @@ -48,42 +48,42 @@ googleAnalytics = "UA-37514928-9" # ------- MENU START ----------------------------------------- [[menu.main]] - name = "Introduction" + name = "1. Introduction" url = "introduction/" weight = 1 [[menu.main]] - name = "Getting Started" + name = "2. Getting Started" url = "getting-started/" weight = 2 [[menu.main]] - name = "Documentation" + name = "3. Documentation" url = "documentation/" weight = 3 [[menu.main]] - name = "Guides" + name = "4. Guides" url = "guides/" weight = 4 [[menu.main]] - name = "Help & Questions" + name = "5. Help & Questions" url = "help/" weight = 5 [[menu.main]] - name = "Related Projects" + name = "6. Related Projects" url = "related-projects/" weight = 6 [[menu.main]] - name = "Contributing" + name = "7. Contributing" url = "contributing/" weight = 7 [[menu.main]] - name = "License" + name = "8. License" url = "license/" weight = 8 diff --git a/DOCUMENTATION/content/contributing/index.md b/DOCUMENTATION/content/contributing/index.md index 24ab6335..1d58dcfc 100644 --- a/DOCUMENTATION/content/contributing/index.md +++ b/DOCUMENTATION/content/contributing/index.md @@ -1,5 +1,5 @@ --- -title: Contributing +title: 7. Contributing type: index weight: 7 --- diff --git a/DOCUMENTATION/content/documentation/index.md b/DOCUMENTATION/content/documentation/index.md index 91693705..d83b4422 100644 --- a/DOCUMENTATION/content/documentation/index.md +++ b/DOCUMENTATION/content/documentation/index.md @@ -1,5 +1,5 @@ --- -title: Documentation +title: 3. Documentation type: index weight: 3 --- @@ -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. @@ -297,6 +296,24 @@ e) set it to `true` For information on how to configure xDebug with your IDE and work it out, check this [Repository](https://github.com/LarryEitel/laravel-laradock-phpstorm) or follow up on the next section if you use linux and PhpStorm. + + +
+ +## Start/Stop xDebug: + +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): + +- Stop xDebug from running by default: `.php-fpm/xdebug stop`. +- Start xDebug by default: `.php-fpm/xdebug start`. +- See the status: `.php-fpm/xdebug status`. + +Note: If `.php-fpm/xdebug` doesn't execute and gives `Permission Denied` error the problem can be that file `xdebug` doesn't have execution access. This can be fixed by running `chmod` command with desired access permissions. + + +
## Install phpdbg @@ -320,37 +337,6 @@ PHP_FPM_INSTALL_PHPDBG=true ``` - -## 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 ! - - -
- -## Start/Stop xDebug: - -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): - -- Stop xDebug from running by default: `.php-fpm/xdebug stop`. -- Start xDebug by default: `.php-fpm/xdebug start`. -- See the status: `.php-fpm/xdebug status`. - -Note: If `.php-fpm/xdebug` doesn't execute and gives `Permission Denied` error the problem can be that file `xdebug` doesn't have execution access. This can be fixed by running `chmod` command with desired access permissions. - -
@@ -1581,22 +1567,6 @@ Available versions are: 5.5, 5.6, 5.7, 8.0, or latest. See https://store.docker -
- -## MySQL access from host - -You can forward the MySQL/MariaDB port to your host by making sure these lines are added to the `mysql` or `mariadb` section of the `docker-compose.yml` or in your [environment specific Compose](https://docs.docker.com/compose/extends/) file. - -``` -ports: - - "3306:3306" -``` - - - - - -
## MySQL root access @@ -1697,7 +1667,7 @@ Enabling Global Composer Install during the build for the container allows you t
-## Magento 2 authentication credential (composer install) +## Add authentication credential for Magento 2 1 - Open the `.env` file @@ -2029,22 +1999,6 @@ Remote debug Laravel web and phpunit tests. -
- -## Upgrading Laradock - -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`. - -**Note:** If you face any problem with the last step above: rebuild all your containers -`docker-compose build --no-cache` -"Warning Containers Data might be lost!" - - @@ -2212,126 +2166,17 @@ docker-compose up ... - - -
- -## Common Problems + +## Upgrade Laradock -*Here's a list of the common problems you might face, and the possible solutions.* +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`. - - - - -
-## I see a blank (white) page instead of the Laravel 'Welcome' page! - -Run the following command from the Laravel root directory: - -```bash -sudo chmod -R 777 storage bootstrap/cache -``` - - - - - - -
-## I see "Welcome to nginx" instead of the Laravel App! - -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` - -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. - - - - - - -
-## I get NGINX error 404 Not Found on Windows. - -1. Go to docker Settings on your Windows machine. -2. Click on the `Shared Drives` tab and check the drive that contains your project files. -3. Enter your windows username and password. -4. Go to the `reset` tab and click restart docker. - - - - - - -
-## The time in my services does not match the current time - -1. Make sure you've [changed the timezone](#Change-the-timezone). -2. Stop and rebuild the containers (`docker-compose up -d --build `) - - - - - - -
-## I get MySQL connection refused - -This error sometimes happens because your Laravel application isn't running on the container localhost IP (Which is 127.0.0.1). Steps to fix it: - -* Option A - 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` - -## I get stuck when building nginx on `fetch http://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. - -## Custom composer repo packagist url and npm registry url - -In China, the origin source of composer and npm is very slow. You can add `WORKSPACE_NPM_REGISTRY` and `WORKSPACE_COMPOSER_REPO_PACKAGIST` config in `.env` to use your custom source. - -Example: -```bash -WORKSPACE_NPM_REGISTRY=https://registry.npm.taobao.org -WORKSPACE_COMPOSER_REPO_PACKAGIST=https://packagist.phpcomposer.com -``` - -
- -## I get `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. - -This is caused of an outdated library for processing **.jpg files** in ubuntu 16.04. - -To fix the problem you can follow those steps - -1 - Open the `.env`. - -2 - Search for `WORKSPACE_INSTALL_LIBPNG` or add the key if missing. - -3 - Set the value to true: - -```dotenv -WORKSPACE_INSTALL_LIBPNG=true -``` - -4 - Finally rebuild the workspace image - -```bash -docker-compose build workspace -``` - +**Note:** If you face any problem with the last step above: rebuild all your containers +`docker-compose build --no-cache` +"Warning Containers Data might be lost!" diff --git a/DOCUMENTATION/content/getting-started/index.md b/DOCUMENTATION/content/getting-started/index.md index 8262ead1..f71661da 100644 --- a/DOCUMENTATION/content/getting-started/index.md +++ b/DOCUMENTATION/content/getting-started/index.md @@ -1,10 +1,10 @@ --- -title: Getting Started +title: 2. Getting Started type: index weight: 2 --- -## Requirements +## 2.1 Requirements - [Git](https://git-scm.com/downloads) - [Docker](https://www.docker.com/products/docker/) `>= 17.12` @@ -12,10 +12,7 @@ weight: 2 - - - -## Installation +## 2.2 Installation Choose the setup the best suits your needs. @@ -44,7 +41,7 @@ Note: If you are not using Git yet for your project, you can use `git clone` ins *To keep track of your Laradock changes, between your projects and also keep Laradock updated [check these docs](/documentation/#keep-track-of-your-laradock-changes)* -Your folder structure should look like this: +2 - Make sure your folder structure should look like this: ``` + project-a @@ -55,7 +52,7 @@ Your folder structure should look like this: *(It's important to rename the laradock folders to unique name in each project, if you want to run laradock per project).* -> **Now jump to the [Usage](#Usage) section.** +3 - Go to the [Usage](#Usage) section. ### A.2) Don't have a PHP project yet: @@ -89,7 +86,7 @@ APP_CODE_PATH_HOST=../project-z/ Make sure to replace `project-z` with your project folder name. -> **Now jump to the [Usage](#Usage) section.** +3 - Go to the [Usage](#Usage) section. @@ -110,9 +107,11 @@ Your folder structure should look like this: + project-2 ``` -2 - Go to `nginx/sites` and create config files to point to different project directory when visiting different domains. +2 - Go to your web server and create config files to point to different project directory when visiting different domains: -Laradock by default includes `app.conf.example`, `laravel.conf.example` and `symfony.conf.example` as working samples. +For **Nginx** go to `nginx/sites`, for **Apache2** `apache2/sites`. + +Laradock by default includes some sample files for you to copy `app.conf.example`, `laravel.conf.example` and `symfony.conf.example`. 3 - change the default names `*.conf`: @@ -125,9 +124,10 @@ You can rename the config files, project folders and domains as you like, just m 127.0.0.1 project-2.test ... ``` + If you use Chrome 63 or above for development, don't use `.dev`. [Why?](https://laravel-news.com/chrome-63-now-forces-dev-domains-https). Instead use `.localhost`, `.invalid`, `.test`, or `.example`. -> **Now jump to the [Usage](#Usage) section.** +4 - Go to the [Usage](#Usage) section. @@ -136,7 +136,7 @@ If you use Chrome 63 or above for development, don't use `.dev`. [Why?](https:// -## Usage +## 2.3 Usage **Read Before starting:** @@ -213,7 +213,16 @@ Open your PHP project's `.env` file or whichever configuration file you are read DB_HOST=mysql ``` +You need to use the Laradock's default DB credentials which can be found in the `.env` file (ex: `MYSQL_USER=`). +Or you can change them and rebuild the container. + *If you want to install Laravel as PHP project, see [How to Install Laravel in a Docker Container](#Install-Laravel).*
-5 - Open your browser and visit your localhost address `http://localhost/`. If you followed the multiple projects setup, you can visit `http://project-1.test/` and `http://project-2.test/`. +5 - Open your browser and visit your localhost address. + +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 index 388edf42..9ffd0140 100644 --- a/DOCUMENTATION/content/guides/index.md +++ b/DOCUMENTATION/content/guides/index.md @@ -1,21 +1,14 @@ --- -title: Guides +title: 4. Guides type: index weight: 4 --- - -* [Production Setup on Digital Ocean](#Digital-Ocean) -* [PHPStorm XDebug Setup](#PHPStorm-Debugging) -* [Running Laravel Dusk Test](#Laravel-Dusk) - - - -# Production Setup on Digital Ocean +## Production Setup on Digital Ocean -## Install Docker +### Install Docker - Visit [DigitalOcean](https://cloud.digitalocean.com/login) and login. - Click the `Create Droplet` button. @@ -24,7 +17,7 @@ weight: 4 - Continue creating the droplet as you normally would. - If needed, check your e-mail for the droplet root password. -## SSH to your Server +### SSH to your Server Find the IP address of the droplet in the DigitalOcean interface. Use it to connect to the server. @@ -40,7 +33,7 @@ You can now check if Docker is available: $root@server:~# docker ``` -## Set Up Your Laravel Project +### Set Up Your Laravel Project ``` $root@server:~# apt-get install git @@ -50,12 +43,12 @@ $root@server:~/laravel/ git submodule add https://github.com/Laradock/laradock.g $root@server:~/laravel/ cd laradock ``` -## Enter the laradock folder and rename env-example to .env. +### Enter the laradock folder and rename env-example to .env. ``` $root@server:~/laravel/laradock# cp env-example .env ``` -## Create Your Laradock Containers +### Create Your Laradock Containers ``` $root@server:~/laravel/laradock# docker-compose up -d nginx mysql @@ -63,13 +56,13 @@ $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 +### Go to Your Workspace ``` docker-compose exec workspace bash ``` -## Execute commands +### Execute commands If you want to only execute some command and don't want to enter bash, you can execute `docker-compose run workspace `. @@ -77,7 +70,7 @@ If you want to only execute some command and don't want to enter bash, you can e docker-compose run workspace php artisan migrate ``` -## Install and configure Laravel +### 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. @@ -100,7 +93,7 @@ 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 +### Using Your Own Domain Name Login to your DNS provider, such as Godaddy, Namecheap. @@ -118,7 +111,7 @@ 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) +### Serving Site With NGINX (HTTP ONLY) Go back to command line. @@ -142,14 +135,14 @@ And add `server_name` (your custom domain) server_name yourdomain.com; ``` -## Rebuild Your Nginx +### 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 +### Re Run Your Containers MYSQL and NGINX ``` $root@server:~/laravel/laradock/nginx# docker-compose up -d nginx mysql @@ -157,7 +150,7 @@ $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 +### Run Site on SSL with Let's Encrypt Certificate **Note: You need to Use Caddy here Instead of Nginx** @@ -196,7 +189,7 @@ tls serverbreaker@gmai.com This is needed Prior to Creating Let's Encypt -## Run Your Caddy Container without the -d flag and Generate SSL with Let's Encrypt +### Run Your Caddy Container without the -d flag and Generate SSL with Let's Encrypt ``` $root@server:~/laravel/laradock# docker-compose up caddy @@ -217,7 +210,7 @@ caddy_1 | http://yourdomain.com After it finishes, press `Ctrl` + `C` to exit. -## Stop All Containers and ReRun Caddy and Other Containers on Background +### Stop All Containers and ReRun Caddy and Other Containers on Background ``` $root@server:~/laravel/laradock# docker-compose down @@ -238,326 +231,6 @@ View your Site in the Browser Securely Using HTTPS (https://yourdomain.com) - [https://caddyserver.com/docs/tls](https://caddyserver.com/docs/tls) - [https://caddyserver.com/docs/caddyfile](https://caddyserver.com/docs/caddyfile) - - - - -
-
-
-
-
- - -# 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) -


@@ -565,13 +238,9 @@ Assuming that you are in laradock folder, type:
-# Running Laravel Dusk Tests +## Running Laravel Dusk Tests -- [Option 1: Without Selenium](#option1-dusk) -- [Option 2: With Selenium](#option2-dusk) - - -## Option 1: Without Selenium +### Option 1: Without Selenium - [Intro](#option1-dusk-intro) - [Workspace Setup](#option1-workspace-setup) @@ -579,14 +248,12 @@ Assuming that you are in laradock folder, type: - [Choose Chrome Driver Version (Optional)](#option1-choose-chrome-driver-version) - [Run Dusk Tests](#option1-run-dusk-tests) - -### Intro +#### 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 +#### Workspace Setup Update your .env with following entries: @@ -606,8 +273,7 @@ Then run below to build your workspace. docker-compose build workspace ``` - -### Application Setup +#### Application Setup Run a `workspace` container and you will be inside the container at `/var/www` directory. @@ -672,15 +338,14 @@ abstract class DuskTestCase extends BaseTestCase } ``` - -### Choose Chrome Driver Version (Optional) +#### 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. +For Laravel Dusk 2.x, you need to update `DuskTestCase#prepare` method if you wish to go with option #2. ``` @@ -700,7 +365,7 @@ abstract class DuskTestCase extends BaseTestCase } ``` -For Laravel 1.x, you need to add `DuskTestCase#buildChromeProcess` method if you wish to go with option #2. +For Laravel Dusk 1.x, you need to add `DuskTestCase#buildChromeProcess` method if you wish to go with option #2. ``` -### Run Dusk Tests +#### Run Dusk Tests Run local server in `workspace` container and run Dusk tests. @@ -745,8 +409,7 @@ PHPUnit 6.4.0 by Sebastian Bergmann and contributors. Time: 837 ms, Memory: 6.00MB ``` - -## Option 2: With Selenium +### Option 2: With Selenium - [Intro](#dusk-intro) - [DNS Setup](#dns-setup) @@ -754,8 +417,7 @@ Time: 837 ms, Memory: 6.00MB - [Laravel Dusk Setup](#laravel-dusk-setup) - [Running Laravel Dusk Tests](#running-tests) - -### Intro +#### 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, @@ -765,8 +427,7 @@ 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 +#### DNS Setup According to RFC-2606, only four TLDs are reserved for local testing[^1]: - `.test` @@ -799,8 +460,7 @@ For example, in your `/etc/hosts` file: 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 +#### 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: @@ -822,8 +482,7 @@ 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 +#### 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 @@ -833,13 +492,13 @@ 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 +##### .env.dusk.local ``` ... USE_SELENIUM=true ``` -#### DuskTestCase.php +##### DuskTestCase.php ```php abstract class DuskTestCase extends BaseTestCase { @@ -859,8 +518,7 @@ abstract class DuskTestCase extends BaseTestCase } ``` - -### Running Laravel Dusk Tests +#### 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: @@ -885,3 +543,326 @@ This invokes the Dusk command from inside the workspace container but when the s 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 3f2342de..1d971c51 100644 --- a/DOCUMENTATION/content/help/index.md +++ b/DOCUMENTATION/content/help/index.md @@ -1,5 +1,5 @@ --- -title: Help & Questions +title: 5. Help & Questions type: index weight: 5 --- @@ -7,3 +7,121 @@ weight: 5 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). + + +
+ +# Common Problems + +*Here's a list of the common problems you might face, and the possible solutions.* + + +
+## I see a blank (white) page instead of the Laravel 'Welcome' page! + +Run the following command from the Laravel root directory: + +```bash +sudo chmod -R 777 storage bootstrap/cache +``` + + + + + + +
+## I see "Welcome to nginx" instead of the Laravel App! + +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` + +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. + + + + + + +
+## I get NGINX error 404 Not Found on Windows. + +1. Go to docker Settings on your Windows machine. +2. Click on the `Shared Drives` tab and check the drive that contains your project files. +3. Enter your windows username and password. +4. Go to the `reset` tab and click restart docker. + + + + + + +
+## The time in my services does not match the current time + +1. Make sure you've [changed the timezone](#Change-the-timezone). +2. Stop and rebuild the containers (`docker-compose up -d --build `) + + + + + + +
+## I get MySQL connection refused + +This error sometimes happens because your Laravel application isn't running on the container localhost IP (Which is 127.0.0.1). Steps to fix it: + +* Option A + 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` + +## I get stuck when building nginx on `fetch http://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. + +## Custom composer repo packagist url and npm registry url + +In China, the origin source of composer and npm is very slow. You can add `WORKSPACE_NPM_REGISTRY` and `WORKSPACE_COMPOSER_REPO_PACKAGIST` config in `.env` to use your custom source. + +Example: +```bash +WORKSPACE_NPM_REGISTRY=https://registry.npm.taobao.org +WORKSPACE_COMPOSER_REPO_PACKAGIST=https://packagist.phpcomposer.com +``` + +
+ +## I get `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. + +This is caused of an outdated library for processing **.jpg files** in ubuntu 16.04. + +To fix the problem you can follow those steps + +1 - Open the `.env`. + +2 - Search for `WORKSPACE_INSTALL_LIBPNG` or add the key if missing. + +3 - Set the value to true: + +```dotenv +WORKSPACE_INSTALL_LIBPNG=true +``` + +4 - Finally rebuild the workspace image + +```bash +docker-compose build workspace +``` + diff --git a/DOCUMENTATION/content/introduction/index.md b/DOCUMENTATION/content/introduction/index.md index 82c5b319..8493fed8 100644 --- a/DOCUMENTATION/content/introduction/index.md +++ b/DOCUMENTATION/content/introduction/index.md @@ -1,24 +1,105 @@ --- -title: Introduction +title: 1. Introduction type: index weight: 1 --- +Laradock is a full PHP development environment based on Docker. + +Supporting a variety of common services, all pre-configured to provide a full PHP development environment. + +## Features -A full PHP development environment for Docker. +- 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. -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... +--- +### Use Docker First - Then Learn About It Later +--- -![](https://s19.postimg.org/jblfytw9f/laradock-logo.jpg) + +## Sponsors + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +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. + +
+ ## Quick Overview -Let's see how easy it is to install `NGINX`, `PHP`, `Composer`, `MySQL`, `Redis` and `Beanstalkd`: +Let's see how easy it is to setup our demo stack `PHP`, `NGINX`, `MySQL`, `Redis` and `Composer`: 1 - Clone Laradock inside your PHP project: @@ -55,55 +136,128 @@ 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 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.. - - - - -## Supported Software (Images) +## Supported Software (Docker 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. +> Laradock, adheres to the 'separation of concerns' principle, thus it runs each software on its own Docker Container. +> You can turn On/Off as many instances as you want without worrying about the configurations. + +> To run a chosen container from the list below, run `docker-compose up -d {container-name}`. +> The container name `{container-name}` is the same as its folder name. Example to run the "PHP FPM" container use the name "php-fpm". + +- **Web Servers:** + - NGINX + - Apache2 + - Caddy + +- **Load Balancers:** + - HAProxy + - Traefik -- **Database Engines:** -MySQL - MariaDB - Percona - MongoDB - Neo4j - RethinkDB - MSSQL - PostgreSQL - Postgres-PostGIS. -- **Database Management:** -PhpMyAdmin - Adminer - PgAdmin -- **Cache Engines:** -Redis - Memcached - Aerospike -- **PHP Servers:** -NGINX - Apache2 - Caddy - **PHP Compilers:** -PHP FPM - HHVM -- **Message Queueing:** -Beanstalkd - RabbitMQ - PHP Worker -- **Queueing Management:** -Beanstalkd Console - RabbitMQ Console -- **Random Tools:** -Mailu - HAProxy - Certbot - Blackfire - Selenium - Jenkins - ElasticSearch - Kibana - Grafana - Gitlab - Mailhog - MailDev - Minio - Varnish - Swoole - NetData - Portainer - Laravel Echo - Phalcon... + - PHP FPM + - HHVM -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. +- **Database Management Systems:** + - MySQL + - PostgreSQL + - PostGIS + - MariaDB + - Percona + - MSSQL + - MongoDB + - MongoDB Web UI + - Neo4j + - CouchDB + - RethinkDB + - Cassandra -**Workspace Image Tools** -PHP CLI - Composer - Git - Linuxbrew - Node - V8JS - Gulp - SQLite - xDebug - Envoy - Deployer - Vim - Yarn - SOAP - Drush - WP-CLI... + +- **Database Management Apps:** + - PhpMyAdmin + - Adminer + - PgAdmin + +- **Cache Engines:** + - Redis + - Redis Web UI + - Redis Cluster + - Memcached + - Aerospike + - Varnish + +- **Message Brokers:** + - RabbitMQ + - RabbitMQ Admin Console + - Beanstalkd + - Beanstalkd Admin Console + - Eclipse Mosquitto + - PHP Worker + - Laravel Horizon + +- **Mail Servers:** + - Mailu + - Mailhog + - MailDev + +- **Log Management:** + - GrayLog + +- **Testing:** + - Selenium + +- **Monitoring:** + - Grafana + - NetData + +- **Search Engines:** + - ElasticSearch + - Apache Solr + - Manticore Search + +- **IDE's** + - ICE Coder + - Theia + - Web IDE + +- **Miscellaneous:** + - Workspace *(Laradock container that includes a rich set of pre-configured useful tools)* + - `PHP CLI` + - `Composer` + - `Git` + - `Vim` + - `xDebug` + - `Linuxbrew` + - `Node` + - `V8JS` + - `Gulp` + - `SQLite` + - `Laravel Envoy` + - `Deployer` + - `Yarn` + - `SOAP` + - `Drush` + - `Wordpress CLI` + - Apache ZooKeeper *(Centralized service for distributed systems to a hierarchical key-value store)* + - Kibana *(Visualize your Elasticsearch data and navigate the Elastic Stack)* + - LogStash *(Server-side data processing pipeline that ingests data from a multitude of sources simultaneously)* + - Jenkins *(automation server, that provides plugins to support building, deploying and automating any project)* + - Certbot *(Automatically enable HTTPS on your website)* + - Swoole *(Production-Grade Async programming Framework for PHP)* + - SonarQube *(continuous inspection of code quality to perform automatic reviews with static analysis of code to detect bugs and more)* + - Gitlab *(A single application for the entire software development lifecycle)* + - PostGIS *(Database extender for PostgreSQL. It adds support for geographic objects allowing location queries to be run in SQL)* + - Blackfire *(Empowers all PHP developers and IT/Ops to continuously verify and improve their app's performance)* + - Laravel Echo *(Bring the power of WebSockets to your Laravel applications)* + - Phalcon *(A PHP web framework based on the model–view–controller pattern)* + - Minio *(Cloud storage server released under Apache License v2, compatible with Amazon S3)* + - AWS EB CLI *(CLI that helps you deploy and manage your AWS Elastic Beanstalk applications and environments)* + - Thumbor *(Photo thumbnail service)* + - IPython *(Provides a rich architecture for interactive computing)* + - Jupyter Hub *(Jupyter notebook for multiple users)* + - Portainer *(Build and manage your Docker environments with ease)* + - Docker Registry *(The Docker Registry implementation for storing and distributing Docker images)* + - Docker Web UI *(A browser-based solution for browsing and modifying a private Docker registry)* You can choose, which tools to install in your workspace container and other containers, from the `.env` file. @@ -112,75 +266,9 @@ 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 :) - - - -## Sponsors - - - - - -Support this project by becoming a sponsor. - -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. [[Become a sponsor](https://opencollective.com/laradock#sponsor)] - - - - - - - - - - - - - - - -## 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 v5.* (should be next!) -- 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) - - - +*If you can't find your Software in the list, build it yourself and submit it. Contributions are welcomed :)* +--- @@ -191,24 +279,147 @@ 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) +--- +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://www.paypal.me/mzalt) +Option 1: Donate directly to [Paypal](https://paypal.me/mzmmzz). -[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/mzalt) +[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/mzmmzz) -or become a backer on [Open Collective](https://opencollective.com/laradock#backer) - - - -or show your support via [Beerpay](https://beerpay.io/laradock/laradock) +Option 2: Support us via [BeerPay](https://beerpay.io/laradock/laradock). [![Beerpay](https://beerpay.io/laradock/laradock/badge.svg?style=flat)](https://beerpay.io/laradock/laradock) + +Option 3: Become a backer on [Open Collective](https://opencollective.com/laradock/contribute). + + diff --git a/DOCUMENTATION/content/license/index.md b/DOCUMENTATION/content/license/index.md index 795d4c89..312b13d1 100644 --- a/DOCUMENTATION/content/license/index.md +++ b/DOCUMENTATION/content/license/index.md @@ -1,5 +1,5 @@ --- -title: License +title: 8. License type: index weight: 8 --- diff --git a/DOCUMENTATION/content/related-projects/index.md b/DOCUMENTATION/content/related-projects/index.md index bc37d9b5..a55343fb 100644 --- a/DOCUMENTATION/content/related-projects/index.md +++ b/DOCUMENTATION/content/related-projects/index.md @@ -1,5 +1,5 @@ --- -title: Related Projects +title: 6. Related Projects type: index weight: 6 --- diff --git a/DOCUMENTATION/static/ads.txt b/DOCUMENTATION/static/ads.txt new file mode 100644 index 00000000..22301965 --- /dev/null +++ b/DOCUMENTATION/static/ads.txt @@ -0,0 +1 @@ +google.com, pub-9826129398689742, DIRECT, f08c47fec0942fa0 diff --git a/DOCUMENTATION/static/custom-style.css b/DOCUMENTATION/static/custom-style.css new file mode 100644 index 00000000..d25a5ac1 --- /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/index.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/index.html index 5ee52d1c..502cd68c 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,32 @@
- -
- - - - - - - -
+ +
+ + + + + + + +
+ +


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

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

+





+
+
+

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

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