summary refs log tree commit diff
path: root/develop/usage
diff options
context:
space:
mode:
authorerikjohnston <erikjohnston@users.noreply.github.com>2023-01-11 12:01:31 +0000
committererikjohnston <erikjohnston@users.noreply.github.com>2023-01-11 12:01:31 +0000
commita14f0ff19172c444555a64a1e02c52a7f1e8d175 (patch)
treedc505fd53460d200c5ceb7ef09f6c50d95b502f6 /develop/usage
parentdeploy: bc7ca704ddc34a76fe9e3e1f895f459ac9ac7186 (diff)
downloadsynapse-a14f0ff19172c444555a64a1e02c52a7f1e8d175.tar.xz
deploy: 73f097888eedaad05eda6b2453b6558158c0b032
Diffstat (limited to 'develop/usage')
-rw-r--r--develop/usage/configuration/config_documentation.html7
1 files changed, 7 insertions, 0 deletions
diff --git a/develop/usage/configuration/config_documentation.html b/develop/usage/configuration/config_documentation.html
index 8c493aacac..d0f616f54c 100644
--- a/develop/usage/configuration/config_documentation.html
+++ b/develop/usage/configuration/config_documentation.html
@@ -551,6 +551,13 @@ additional endpoints which should be loaded via dynamic modules.</p>
 <li>
 <p><code>static</code>: static resources under synapse/static (/_matrix/static). (Mostly useful for 'fallback authentication'.)</p>
 </li>
+<li>
+<p><code>health</code>: the <a href="../../reverse_proxy.html#health-check-endpoint">health check endpoint</a>. 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 <a href="../../workers.html">workers</a> and containers without listener e.g.
+<a href="../../workers.html#notifying-application-services">application services</a>.</p>
+</li>
 </ul>
 <p>Example configuration #1:</p>
 <pre><code class="language-yaml">listeners: