Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 1caf16a

Browse files
authored
Add worker_manhole to configuration manual (#14824)
Closes: #13643
1 parent d344bc8 commit 1caf16a

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

changelog.d/14824.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add `worker_manhole` to configuration manual.

docs/usage/configuration/config_documentation.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4029,6 +4029,27 @@ worker_listeners:
40294029
resources:
40304030
- names: [client, federation]
40314031
```
4032+
---
4033+
### `worker_manhole`
4034+
4035+
A worker may have a listener for [`manhole`](../../manhole.md).
4036+
It allows server administrators to access a Python shell on the worker.
4037+
4038+
Example configuration:
4039+
```yaml
4040+
worker_manhole: 9000
4041+
```
4042+
4043+
This is a short form for:
4044+
```yaml
4045+
worker_listeners:
4046+
- port: 9000
4047+
bind_addresses: ['127.0.0.1']
4048+
type: manhole
4049+
```
4050+
4051+
It needs also an additional [`manhole_settings`](#manhole_settings) configuration.
4052+
40324053
---
40334054
### `worker_daemonize`
40344055

0 commit comments

Comments
 (0)