summary refs log tree commit diff
path: root/docs/usage
diff options
context:
space:
mode:
authorDirk Klimpel <5740567+dklimpel@users.noreply.github.com>2023-01-11 13:00:38 +0100
committerGitHub <noreply@github.com>2023-01-11 12:00:38 +0000
commit73f097888eedaad05eda6b2453b6558158c0b032 (patch)
treebdfc50b056c6200be5a1a5d79b175c3efc399a37 /docs/usage
parentAdd poetry.toml to .gitignore (#14807) (diff)
downloadsynapse-73f097888eedaad05eda6b2453b6558158c0b032.tar.xz
Add listener `health` (#14747)
Fixes: #8780
Diffstat (limited to 'docs/usage')
-rw-r--r--docs/usage/configuration/config_documentation.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index a355eef529..294dd6eddd 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -480,6 +480,12 @@ Valid resource names are:
 
 * `static`: static resources under synapse/static (/_matrix/static). (Mostly useful for 'fallback authentication'.)
 
+* `health`: the [health check endpoint](../../reverse_proxy.md#health-check-endpoint). This endpoint
+  is by default active for all other resources and does not have to be activated separately.
+  This is only useful if you want to use the health endpoint explicitly on a dedicated port or
+  for [workers](../../workers.md) and containers without listener e.g.
+  [application services](../../workers.md#notifying-application-services).
+
 Example configuration #1:
 ```yaml
 listeners: