Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README to add instruction to enable XDEBUG #7

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added PHPStorm_server_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,22 @@ The GovCMS projects have been designed to be able to import a nightly copy of th
* The files folder is not (currently) committed to GitLab.
* Do not make changes to `docker-compose.yml`, `lagoon.yml`, `.gitlab-ci.yml` or the Dockerfiles under `/.docker` - these will result in your project being unable to deploy to GovCMS SaaS

## Local Development - enable XDEBUG
Please find below the steps to enable XDEBUG on your local environment.
The instructions are specific to PHPStorm and Chrome.

### Edit docker-compose.yml
* Search for this line `X_FRAME_OPTIONS: ${X_FRAME_OPTIONS:-SameOrigin}`
* Add this line after the above - `XDEBUG_ENABLE: "true"`
DO NOT COMMIT THIS FILE

### Copy docker folder to the host
* `docker cp govcms7-scaffold_test_1:/app .`

### Add server settings to PHPStorm
The settings can be seen in the screenshot below:
![alt text](/PHPStorm_server_settings.png?raw=true "PHPStorm")

## Image inheritance

This project is designed to provision a Drupal 7 project onto GovCMS SaaS, using the GovCMS distribution, and has been prepared thus
Expand Down