mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-12-14 11:57:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Add worker_manhole to configuration manual (#14824)

Browse source 
Closes: #13643
This commit is contained in:
Dirk Klimpel 2023-01-13 15:14:39 +01:00 committed by GitHub
parent d344bc8b6e
commit 1caf16a450
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/14824.doc Normal file
View file

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

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