diff --git a/DOCUMENTATION/content/getting-started/index.md b/DOCUMENTATION/content/getting-started/index.md index b878307..cbcbbe2 100644 --- a/DOCUMENTATION/content/getting-started/index.md +++ b/DOCUMENTATION/content/getting-started/index.md @@ -4,34 +4,32 @@ type: index weight: 2 --- -## Requirements +# Requirements - [Git](https://git-scm.com/downloads) - [Docker](https://www.docker.com/products/docker/) `>= 1.12` - - - - - - -## Installation +# Installation Choose the setup the best suits your needs. - [A) Setup for Single Project](#A) - - [A.1) Already have a PHP project](#A1) - - [A.2) Don't have a PHP project yet](#A2) + + - [A.1) Already have a PHP project](#A1) + + - [A.2) Don't have a PHP project yet](#A2) + - [B) Setup for Multiple Projects](#B) +[]() + +## A) Setup for Single Project - -### A) Setup for Single Project > (Follow these steps if you want a separate Docker environment for each project) +[]() - -### A.1) Already have a PHP project: +## A.1) Already have a PHP project: 1 - Clone laradock on your project root directory: @@ -39,10 +37,9 @@ Choose the setup the best suits your needs. git submodule add https://github.com/Laradock/laradock.git ``` -Note: If you are not using Git yet for your project, you can use `git clone` instead of `git submodule `. - -*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)* +Note: If you are not using Git yet for your project, you can use `git clone` instead of `git submodule`. +_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: @@ -53,12 +50,13 @@ Your folder structure should look like this: + laradock-b ``` -*(It's important to rename the laradock folders to unique name in each project, if you want to run laradock per project).* +_(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.** - -### A.2) Don't have a PHP project yet: +[]() + +## A.2) Don't have a PHP project yet: 1 - Clone this repository anywhere on your machine: @@ -84,19 +82,20 @@ cp env-example .env At the top, change the `APPLICATION` variable to your project path. ``` -APPLICATION=../project-z/public/ +APPLICATION=../project-z/ ``` Make sure to replace `project-z` with your project folder name. > **Now jump to the [Usage](#Usage) section.** +[]() + +## B) Setup for Multiple Projects: - -### B) Setup for Multiple Projects: > (Follow these steps if you want a single Docker environment for all your project) -1 - Clone this repository anywhere on your machine (similar to [Steps A.2. from above](#A2)): +1 - Clone this repository anywhere on your machine (similar to [Steps A.2\. from above](#A2)): ```bash git clone https://github.com/laradock/laradock.git @@ -127,25 +126,20 @@ You can rename the config files, project folders and domains as you like, just m > **Now jump to the [Usage](#Usage) section.** +[]() - - - - - - -## Usage +# Usage **Read Before starting:** If you are using **Docker Toolbox** (VM), do one of the following: - Upgrade to Docker [Native](https://www.docker.com/products/docker) for Mac/Windows (Recommended). Check out [Upgrading Laradock](/documentation/#upgrading-laradock) -- Use Laradock v3.\*. Visit the [Laradock-ToolBox](https://github.com/laradock/laradock/tree/Laradock-ToolBox) branch. *(outdated)* +- Use Laradock v3.*. Visit the [Laradock-ToolBox](https://github.com/laradock/laradock/tree/Laradock-ToolBox) branch. _(outdated)_
->**Warning:** If you used an older version of Laradock it's highly recommended to rebuild the containers you need to use [see how you rebuild a container](#Build-Re-build-Containers) in order to prevent as much errors as possible. +> **Warning:** If you used an older version of Laradock it's highly recommended to rebuild the containers you need to use [see how you rebuild a container](#Build-Re-build-Containers) in order to prevent as much errors as possible.
@@ -157,7 +151,6 @@ cp env-example .env You can edit the `.env` file to chose which software's you want to be installed in your environment. You can always refer to the `docker-compose.yml` file to see how those variables are been used. - 2 - Build the enviroment and run it using `docker-compose` In this example we'll see how to run NGINX (web server) and MySQL (database engine) to host a PHP Web Scripts: @@ -168,11 +161,9 @@ docker-compose up -d nginx mysql **Note**: The `workspace` and `php-fpm` will run automatically in most of the cases, so no need to specify them in the `up` command. If you couldn't find them running then you need specify them as follow: `docker-compose up -d nginx php-fpm mysql workspace`. - You can select your own combination of containers form [this list](http://laradock.io/introduction/#supported-software-images). -*(Please note that sometimes we forget to update the docs, so check the `docker-compose.yml` file to see an updated list of all available containers).* - +_(Please note that sometimes we forget to update the docs, so check the `docker-compose.yml` file to see an updated list of all available containers)._
3 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, ...) @@ -181,19 +172,19 @@ You can select your own combination of containers form [this list](http://larado docker-compose exec workspace bash ``` -*Alternatively, for Windows PowerShell users: execute the following command to enter any running container:* +_Alternatively, for Windows PowerShell users: execute the following command to enter any running container:_ ```bash docker exec -it {workspace-container-id} bash ``` -**Note:** You can add `--user=laradock` to have files created as your host's user. Example: +**Note:** You can add `--user=laradock` to have files created as your host's user. Example: ```shell docker-compose exec --user=laradock workspace bash ``` -*You can change the PUID (User id) and PGID (group id) variables from the `.env` file)* +_You can change the PUID (User id) and PGID (group id) variables from the `.env` file)_
4 - Update your project configurations to use the database host @@ -204,9 +195,7 @@ Open your PHP project's `.env` file or whichever configuration file you are read DB_HOST=mysql ``` -*If you want to install Laravel as PHP project, see [How to Install Laravel in a Docker Container](#Install-Laravel).* +_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.dev/` and `http://project-2.dev/`. But first don't - - +5 - Open your browser and visit your localhost address `http://localhost/`. If you followed the multiple projects setup, you can visit `http://project-1.dev/` and `http://project-2.dev/`. But first don't diff --git a/DOCUMENTATION/content/guides/index.md b/DOCUMENTATION/content/guides/index.md index 927e327..e924976 100644 --- a/DOCUMENTATION/content/guides/index.md +++ b/DOCUMENTATION/content/guides/index.md @@ -4,14 +4,11 @@ type: index weight: 4 --- +- [Production Setup on Digital Ocean](#Digital-Ocean) +- [PHPStorm XDebug Setup](#PHPStorm-Debugging) +[]() -* [Production Setup on Digital Ocean](#Digital-Ocean) -* [PHPStorm XDebug Setup](#PHPStorm-Debugging) - - - - # Production Setup on Digital Ocean ## Install Docker @@ -107,7 +104,7 @@ ns3.digitalocean.com Within DigitalOcean, you'll need to change some settings, too. -Visit: https://cloud.digitalocean.com/networking/domains +Visit: Add your domain name and choose the server IP you'd provision earlier. @@ -148,7 +145,7 @@ $root@server:~/laravel/laradock/nginx# docker-compose build nginx $root@server:~/laravel/laradock/nginx# docker-compose up -d nginx mysql ``` -**View Your Site with HTTP ONLY (http://yourdomain.com)** +**View Your Site with HTTP ONLY ()** ## Run Site on SSL with Let's Encrypt Certificate @@ -165,14 +162,14 @@ Remove 0.0.0.0:80 ``` 0.0.0.0:80 -root /var/www +root /var/www/public ``` -and replace with your https://yourdomain.com +and replace with your ``` https://yourdomain.com -root /var/www +root /var/www/public ``` uncomment tls @@ -217,83 +214,93 @@ $root@server:~/laravel/laradock/caddy# docker-compose down $root@server:~/laravel/laradock/caddy# docker-compose up -d mysql caddy ``` -View your Site in the Browser Securely Using HTTPS (https://yourdomain.com) +View your Site in the Browser Securely Using HTTPS () **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) +> References: +> - +> - +> - +> - +> - +> - +> - +




+[]() - -
-
-
-
-
- - # 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) - + - [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. +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`. - + - 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) + +- 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). + - 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. + +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 ############### @@ -314,14 +321,15 @@ Set the following variables: 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 @@ -329,23 +337,19 @@ 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 {}` +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 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` +- 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" ]; thend @@ -357,33 +361,35 @@ Here are a few things I use to clean things up. 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 {} + ``` + # 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 {} - echo 'Listing all laradock docker hub images...' - docker images | grep laradock + # 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 'dcleanlaradock completed' -} -# associate the above function with an alias -# so can recall/lookup by typing 'alias' -alias dcleanlaradock=dcleanlaradockfunction -``` + 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 ``` @@ -402,14 +408,14 @@ 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: + +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 @@ -418,129 +424,150 @@ 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. +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/BuildDeploymentConnection` - - `Settings/BuildDeploymentDebugger` - - ![Settings/BuildDeploymentDebugger](/images/photos/PHPStorm/Settings/BuildDeploymentDebugger.png) + - ![Settings/BuildDeploymentConnection](/images/photos/PHPStorm/Settings/BuildDeploymentConnection.png) - - `Settings/EditRunConfigurationRemoteWebDebug` - - ![Settings/EditRunConfigurationRemoteWebDebug](/images/photos/PHPStorm/Settings/EditRunConfigurationRemoteWebDebug.png) + - `Settings/BuildDeploymentConnectionMappings` - - `Settings/EditRunConfigurationRemoteExampleTestDebug` - - ![Settings/EditRunConfigurationRemoteExampleTestDebug](/images/photos/PHPStorm/Settings/EditRunConfigurationRemoteExampleTestDebug.png) + - ![Settings/BuildDeploymentConnectionMappings](/images/photos/PHPStorm/Settings/BuildDeploymentConnectionMappings.png) - - `Settings/LangsPHPDebug` - - ![Settings/LangsPHPDebug](/images/photos/PHPStorm/Settings/LangsPHPDebug.png) + - `Settings/BuildDeploymentDebugger` - - `Settings/LangsPHPInterpreters` - - ![Settings/LangsPHPInterpreters](/images/photos/PHPStorm/Settings/LangsPHPInterpreters.png) + - ![Settings/BuildDeploymentDebugger](/images/photos/PHPStorm/Settings/BuildDeploymentDebugger.png) - - `Settings/LangsPHPPHPUnit` - - ![Settings/LangsPHPPHPUnit](/images/photos/PHPStorm/Settings/LangsPHPPHPUnit.png) + - `Settings/EditRunConfigurationRemoteWebDebug` - - `Settings/LangsPHPServers` - - ![Settings/LangsPHPServers](/images/photos/PHPStorm/Settings/LangsPHPServers.png) + - ![Settings/EditRunConfigurationRemoteWebDebug](/images/photos/PHPStorm/Settings/EditRunConfigurationRemoteWebDebug.png) - - `RemoteHost` - To switch on this view, go to: `Menu/Tools/Deployment/Browse Remote Host`. - - ![RemoteHost](/images/photos/PHPStorm/RemoteHost.png) + - `Settings/EditRunConfigurationRemoteExampleTestDebug` - - `RemoteWebDebug` - - ![DebugRemoteOn](/images/photos/PHPStorm/DebugRemoteOn.png) + - ![Settings/EditRunConfigurationRemoteExampleTestDebug](/images/photos/PHPStorm/Settings/EditRunConfigurationRemoteExampleTestDebug.png) - - `EditRunConfigurationRemoteWebDebug` - Go to: `Menu/Run/Edit Configurations`. - - ![EditRunConfigurationRemoteWebDebug](/images/photos/PHPStorm/Settings/EditRunConfigurationRemoteWebDebug.png) + - `Settings/LangsPHPDebug` - - `EditRunConfigurationRemoteExampleTestDebug` - Go to: `Menu/Run/Edit Configurations`. - - ![EditRunConfigurationRemoteExampleTestDebug](/images/photos/PHPStorm/Settings/EditRunConfigurationRemoteExampleTestDebug.png) + - ![Settings/LangsPHPDebug](/images/photos/PHPStorm/Settings/LangsPHPDebug.png) - - `WindowsFirewallAllowedApps` - Go to: `Control Panel\All Control Panel Items\Windows Firewall\Allowed apps`. - - ![WindowsFirewallAllowedApps.png](/images/photos/PHPStorm/Settings/WindowsFirewallAllowedApps.png) + - `Settings/LangsPHPInterpreters` - - `hosts` - Edit: `C:\Windows\System32\drivers\etc\hosts`. - - ![WindowsFirewallAllowedApps.png](/images/photos/PHPStorm/Settings/hosts.png) + - ![Settings/LangsPHPInterpreters](/images/photos/PHPStorm/Settings/LangsPHPInterpreters.png) - - [Enable xDebug on php-fpm](#enablePhpXdebug) + - `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! +[]() + +### 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) + - 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` + +- 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) + + - ![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) + - 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` - +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) - + - ![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) diff --git a/apache2/Dockerfile b/apache2/Dockerfile index e2b4ce4..9d4d9a9 100644 --- a/apache2/Dockerfile +++ b/apache2/Dockerfile @@ -6,13 +6,13 @@ ARG PHP_SOCKET=php-fpm:9000 ENV WEB_PHP_SOCKET=$PHP_SOCKET -ENV WEB_DOCUMENT_ROOT=/var/www/ +ENV WEB_DOCUMENT_ROOT=/var/www/public/ EXPOSE 80 443 -WORKDIR /var/www/ +WORKDIR /var/www/public/ -ADD vhost.conf /etc/apache2/sites-enabled/vhost.conf +COPY vhost.conf /etc/apache2/sites-enabled/vhost.conf ENTRYPOINT ["/opt/docker/bin/entrypoint.sh"] diff --git a/apache2/sites/default.apache.conf b/apache2/sites/default.apache.conf index 2d15daf..5cedafb 100644 --- a/apache2/sites/default.apache.conf +++ b/apache2/sites/default.apache.conf @@ -1,9 +1,9 @@ ServerName laradock.dev - DocumentRoot /var/www/html/ + DocumentRoot /var/www/public/ Options Indexes FollowSymLinks - + AllowOverride All Allow from all diff --git a/apache2/sites/sample.conf.example b/apache2/sites/sample.conf.example index 20af469..48a132e 100644 --- a/apache2/sites/sample.conf.example +++ b/apache2/sites/sample.conf.example @@ -1,9 +1,9 @@ ServerName sample.dev - DocumentRoot /var/www/sample/ + DocumentRoot /var/www/sample/public/ Options Indexes FollowSymLinks - + AllowOverride All Allow from all diff --git a/beanstalkd-console/Dockerfile b/beanstalkd-console/Dockerfile index 2867847..b07f1e3 100644 --- a/beanstalkd-console/Dockerfile +++ b/beanstalkd-console/Dockerfile @@ -14,4 +14,4 @@ RUN apt-get remove --purge -y curl && \ EXPOSE 2080 -CMD bash -c 'BEANSTALK_SERVERS=$BEANSTALKD_PORT_11300_TCP_ADDR:11300 php -S 0.0.0.0:2080 -t /source' +CMD bash -c 'BEANSTALK_SERVERS=$BEANSTALKD_PORT_11300_TCP_ADDR:11300 php -S 0.0.0.0:2080 -t /source/public' diff --git a/caddy/Caddyfile b/caddy/Caddyfile index 488b0c0..269b62a 100644 --- a/caddy/Caddyfile +++ b/caddy/Caddyfile @@ -1,6 +1,6 @@ # Docs: https://caddyserver.com/docs/caddyfile 0.0.0.0:80 -root /var/www +root /var/www/public fastcgi / php-fpm:9000 php { index index.php } diff --git a/caddy/Dockerfile b/caddy/Dockerfile index f1a8c19..b10a9f5 100644 --- a/caddy/Dockerfile +++ b/caddy/Dockerfile @@ -19,6 +19,6 @@ RUN curl --silent --show-error --fail --location \ EXPOSE 80 443 2015 -WORKDIR /var/www +WORKDIR /var/www/public CMD ["/usr/bin/caddy", "-conf", "/etc/Caddyfile"] diff --git a/env-example b/env-example index fc6b8c4..40e9080 100644 --- a/env-example +++ b/env-example @@ -5,7 +5,7 @@ ### Application Path # Point to your application code, will be available at `/var/www`. -APPLICATION=../public/ +APPLICATION=../ ### Data Path: # For all storage systems. @@ -239,4 +239,3 @@ PHP_IDE_CONFIG=serverName=laradock # Fix for windows users to make sure the application path works. COMPOSE_CONVERT_WINDOWS_PATHS=1 - diff --git a/hhvm/server.ini b/hhvm/server.ini index 992bf63..8cd5569 100644 --- a/hhvm/server.ini +++ b/hhvm/server.ini @@ -12,7 +12,7 @@ hhvm.log.level = Error hhvm.log.header = true hhvm.log.access[default][file] = /var/log/hhvm/access.log hhvm.log.access[default][format] = "%h %l %u %t \"%r\" %>s %b" -hhvm.server.source_root=/var/www +hhvm.server.source_root=/var/www/public hhvm.repo.central.path = /var/run/hhvm/hhvm.hhbc ; Uncomment to log to files instead of STDOUT diff --git a/nginx/sites/default.conf b/nginx/sites/default.conf index a0b05c8..75435a6 100644 --- a/nginx/sites/default.conf +++ b/nginx/sites/default.conf @@ -4,7 +4,7 @@ server { listen [::]:80 default_server ipv6only=on; server_name localhost; - root /var/www; + root /var/www/public; index index.php index.html index.htm; location / { @@ -30,6 +30,3 @@ server { log_not_found off; } } - - - diff --git a/nginx/sites/project-1.conf.example b/nginx/sites/project-1.conf.example index 1eb8545..cf8872b 100644 --- a/nginx/sites/project-1.conf.example +++ b/nginx/sites/project-1.conf.example @@ -4,7 +4,7 @@ server { listen [::]:80; server_name project-1.dev; - root /var/www/project-1; + root /var/www/project-1/public; index index.php index.html index.htm; location / { @@ -30,6 +30,3 @@ server { log_not_found off; } } - - - diff --git a/nginx/sites/project-2.conf.example b/nginx/sites/project-2.conf.example index 0c37cee..cf495fe 100644 --- a/nginx/sites/project-2.conf.example +++ b/nginx/sites/project-2.conf.example @@ -4,7 +4,7 @@ server { listen [::]:80; server_name project-2.dev; - root /var/www/project-2; + root /var/www/project-2/public; index index.php index.html index.htm; location / { @@ -30,6 +30,3 @@ server { log_not_found off; } } - - -