Document the reverse proxy requirement for X-Real-IP

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
finnandClaude Opus 5.5 committed 2026-10-22 18:02:36 +00:00
1 parent 74a7eaf677
commit fda35307c6
1 file changed
+9 -2
+9 -2
View File
@@ -2,8 +2,6 @@
A small little program to manage emails. A small little program to manage emails.
The proxy should add X-Real-IP to get a better logging.
## Setup ## Setup
Requirements: Docker, Make Requirements: Docker, Make
@@ -17,6 +15,15 @@ Start with `make run-dev`
- `MAX_PRODUCTION=1` is set in the Docker image and makes MAX refuse to start - `MAX_PRODUCTION=1` is set in the Docker image and makes MAX refuse to start
in debug mode (`FLASK_DEBUG`). Do not override it. in debug mode (`FLASK_DEBUG`). Do not override it.
## Reverse proxy
In production, the reverse proxy must set `X-Real-IP` to the client's address and **overwrite** any
value the client sends. Max uses this address for audit logging. For nginx:
```nginx
proxy_set_header X-Real-IP $remote_addr;
```
## Dependencies ## Dependencies
Direct dependencies are listed in `requirements.in` (production) and Direct dependencies are listed in `requirements.in` (production) and