Skip to content

Commit

Permalink
Add mention of PROXY_MODE
Browse files Browse the repository at this point in the history
  • Loading branch information
Potherca committed Jan 12, 2022
1 parent 212b85b commit 006b583
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,9 @@ only advised in development.

For security reasons, the server expects to run on HTTPS (also known as HTTP+TLS).

To run insecure, set the environment variable `ENVIRONMENT` to `develop`. This
will prohibit the application from running in production mode.
To run insecure, for instance when the application is run behind a proxy or in a
PHP-FPM (or similar) setup, set the environment variable `PROXY_MODE`.
This will allow the application to accept HTTP requests.

### Docker images

Expand Down Expand Up @@ -197,6 +198,11 @@ The underlying functionality for these features is provided by:

## Development

The easiest way to develop this project is by running the environment provided
by the `docker-compose.yml` file. This can be done by running `docker-compose up`.

This will start the application and a pubsub server in separate docker containers.

### Project structure

This project is structured as follows:
Expand Down
5 changes: 5 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@ services:
build:
context: .
environment:
# During development it can be useful to set the ENVIRONMENT to "development"
# in order to see more details about the errors.
# ENVIRONMENT: development
USERNAME: alice
PASSWORD: alice123
# to run in HTTP mode, set PROXY_MODE
# PROXY_MODE: true
PUBSUB_URL: http://pubsub:8080
ports:
- 80:80
Expand Down

0 comments on commit 006b583

Please sign in to comment.