Browse Source

Add `worker_manhole` to configuration manual (#14824)

Closes: #13643
tags/v1.76.0rc1
Dirk Klimpel 1 year ago
committed by GitHub
parent
commit
1caf16a450
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 0 deletions
  1. +1
    -0
      changelog.d/14824.doc
  2. +21
    -0
      docs/usage/configuration/config_documentation.md

+ 1
- 0
changelog.d/14824.doc View File

@@ -0,0 +1 @@
Add `worker_manhole` to configuration manual.

+ 21
- 0
docs/usage/configuration/config_documentation.md View File

@@ -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`



Loading…
Cancel
Save