diff options
| author | Erik Johnston <erik@matrix.org> | 2020-08-07 14:21:24 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-07 14:21:24 +0100 |
| commit | 7620912d84f6a8b24143f1340dd653f44b13bf30 (patch) | |
| tree | 0429a0cfbe00c0d491643255b577520bf657c921 /docs/reverse_proxy.md | |
| parent | Reduce unnecessary whitespace in JSON. (#7372) (diff) | |
| download | synapse-7620912d84f6a8b24143f1340dd653f44b13bf30.tar.xz | |
Add health check endpoint (#8048)
Diffstat (limited to 'docs/reverse_proxy.md')
| -rw-r--r-- | docs/reverse_proxy.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/reverse_proxy.md b/docs/reverse_proxy.md index 7bfb96eff6..fd48ba0874 100644 --- a/docs/reverse_proxy.md +++ b/docs/reverse_proxy.md @@ -139,3 +139,10 @@ client IP addresses are recorded correctly. Having done so, you can then use `https://matrix.example.com` (instead of `https://matrix.example.com:8448`) as the "Custom server" when connecting to Synapse from a client. + + +## Health check endpoint + +Synapse exposes a health check endpoint for use by reverse proxies. +Each configured HTTP listener has a `/health` endpoint which always returns +200 OK (and doesn't get logged). |