Skip to content

Commit 006b583

Browse files
committed
Add mention of PROXY_MODE
1 parent 212b85b commit 006b583

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,9 @@ only advised in development.
6868

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

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

7475
### Docker images
7576

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

198199
## Development
199200

201+
The easiest way to develop this project is by running the environment provided
202+
by the `docker-compose.yml` file. This can be done by running `docker-compose up`.
203+
204+
This will start the application and a pubsub server in separate docker containers.
205+
200206
### Project structure
201207

202208
This project is structured as follows:

docker-compose.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,13 @@ services:
44
build:
55
context: .
66
environment:
7+
# During development it can be useful to set the ENVIRONMENT to "development"
8+
# in order to see more details about the errors.
9+
# ENVIRONMENT: development
710
USERNAME: alice
811
PASSWORD: alice123
12+
# to run in HTTP mode, set PROXY_MODE
13+
# PROXY_MODE: true
914
PUBSUB_URL: http://pubsub:8080
1015
ports:
1116
- 80:80

0 commit comments

Comments
 (0)