Skip to content

Commit

Permalink
Merge pull request #12602 from keymanapp/docs/websites-readme-debug
Browse files Browse the repository at this point in the history
docs: Update websites readme with debug info
  • Loading branch information
mcdurdin authored Nov 5, 2024
2 parents a233e4b + 08afdf7 commit ea629be
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/websites/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,17 @@ This downloads and builds the Docker images needed for the site.
This step typically downloads _common/ website files from [shared-sites](https://github.com/keymanapp/shared-sites/tree/main/_common).

#### Start the Docker container
1. Run `./build.sh start`
1. Run `./build.sh start --debug`

This maps the local directory to the the Docker image.

The `--debug` flag will, among other things:
* Skip generation of CDN assets (so changes appear without a rebuild) (Some sites have assets in `/cdn/dev/` used to generate CDN in `/dev/deploy/`.)
* Cause any PHP errors to be displayed to the user (rather than logging them back-end)

For sites that use Composer dependencies, this step also creates a link in the Docker image from /var/www/vendor/ to /var/www/html/vendor.
The link file also appears locally.

Some sites have assets in `/cdn/dev/` used to generate CDN in `/dev/deploy/`. To avoid confusion during development, you can skip generating CDN with `./build.sh start --debug`.

##### Port lookup table
After this, you can access the website at the following ports:

Expand Down

0 comments on commit ea629be

Please sign in to comment.