From 1caf16a4509fef337b49a8c9d08cdc4494447d7d Mon Sep 17 00:00:00 2001
From: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com>
Date: Fri, 13 Jan 2023 15:14:39 +0100
Subject: [PATCH] Add `worker_manhole` to configuration manual (#14824)
Closes: #13643
---
changelog.d/14824.doc | 1 +
.../configuration/config_documentation.md | 21 +++++++++++++++++++
2 files changed, 22 insertions(+)
create mode 100644 changelog.d/14824.doc
diff --git a/changelog.d/14824.doc b/changelog.d/14824.doc
new file mode 100644
index 0000000000..172d37baf2
--- /dev/null
+++ b/changelog.d/14824.doc
@@ -0,0 +1 @@
+Add `worker_manhole` to configuration manual.
\ No newline at end of file
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
@@ -4029,6 +4029,27 @@ worker_listeners:
resources:
- 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`
--
GitLab