summary refs log tree commit diff
path: root/develop/print.html
diff options
context:
space:
mode:
authorerikjohnston <erikjohnston@users.noreply.github.com>2023-01-13 14:15:25 +0000
committererikjohnston <erikjohnston@users.noreply.github.com>2023-01-13 14:15:25 +0000
commitba9d92cce080732acdd55d92307cb3d2fe29ddd9 (patch)
tree77b7bb1d5630f33995b16ef242364de21e9596ab /develop/print.html
parentdeploy: d344bc8b6ea14210614845f4e0af776013f86459 (diff)
downloadsynapse-ba9d92cce080732acdd55d92307cb3d2fe29ddd9.tar.xz
deploy: 1caf16a4509fef337b49a8c9d08cdc4494447d7d
Diffstat (limited to 'develop/print.html')
-rw-r--r--develop/print.html14
1 files changed, 14 insertions, 0 deletions
diff --git a/develop/print.html b/develop/print.html
index c683d17245..969aebe764 100644
--- a/develop/print.html
+++ b/develop/print.html
@@ -6919,6 +6919,20 @@ other workers.</p>
       - names: [client, federation]
 </code></pre>
 <hr />
+<h3 id="worker_manhole"><a class="header" href="#worker_manhole"><code>worker_manhole</code></a></h3>
+<p>A worker may have a listener for <a href="usage/configuration/../../manhole.html"><code>manhole</code></a>.
+It allows server administrators to access a Python shell on the worker.</p>
+<p>Example configuration:</p>
+<pre><code class="language-yaml">worker_manhole: 9000
+</code></pre>
+<p>This is a short form for:</p>
+<pre><code class="language-yaml">worker_listeners:
+  - port: 9000
+    bind_addresses: ['127.0.0.1']
+    type: manhole
+</code></pre>
+<p>It needs also an additional <a href="usage/configuration/config_documentation.html#manhole_settings"><code>manhole_settings</code></a> configuration.</p>
+<hr />
 <h3 id="worker_daemonize"><a class="header" href="#worker_daemonize"><code>worker_daemonize</code></a></h3>
 <p>Specifies whether the worker should be started as a daemon process.
 If Synapse is being managed by <a href="usage/configuration/../../systemd-with-workers/">systemd</a>, this option