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-13 15:14:39 +0100
committerGitHub <noreply@github.com>2023-01-13 14:14:39 +0000
commit1caf16a4509fef337b49a8c9d08cdc4494447d7d (patch)
treef0d2b2637936d00b83520723efe3b56cd89cb47e /docs/usage
parentInclude `x_forwarded` in workers example configs (#14667) (diff)
downloadsynapse-1caf16a4509fef337b49a8c9d08cdc4494447d7d.tar.xz
Add `worker_manhole` to configuration manual (#14824)
Closes: #13643
Diffstat (limited to 'docs/usage')
-rw-r--r--docs/usage/configuration/config_documentation.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md
index 294dd6eddd..35de9c95e3 100644
--- a/docs/usage/configuration/config_documentation.md
+++ b/docs/usage/configuration/config_documentation.md
@@ -4030,6 +4030,27 @@ worker_listeners:
       - names: [client, federation]
 ```
 ---
+### `worker_manhole`
+
+A worker may have a listener for [`manhole`](../../manhole.md).
+It allows server administrators to access a Python shell on the worker.
+
+Example configuration:
+```yaml
+worker_manhole: 9000
+```
+
+This is a short form for:
+```yaml
+worker_listeners:
+  - port: 9000
+    bind_addresses: ['127.0.0.1']
+    type: manhole
+```
+
+It needs also an additional [`manhole_settings`](#manhole_settings) configuration.
+
+---
 ### `worker_daemonize`
 
 Specifies whether the worker should be started as a daemon process.