mirror of
https://github.com/element-hq/synapse.git
synced 2024-11-23 10:05:55 +03:00
78 lines
2.3 KiB
Markdown
78 lines
2.3 KiB
Markdown
Using the synapse manhole
|
|
=========================
|
|
|
|
The "manhole" allows server administrators to access a Python shell on a running
|
|
Synapse installation. This is a very powerful mechanism for administration and
|
|
debugging.
|
|
|
|
**_Security Warning_**
|
|
|
|
Note that this will give administrative access to synapse to **all users** with
|
|
shell access to the server. It should therefore **not** be enabled in
|
|
environments where untrusted users have shell access.
|
|
|
|
***
|
|
|
|
To enable it, first uncomment the `manhole` listener configuration in
|
|
`homeserver.yaml`. The configuration is slightly different if you're using docker.
|
|
|
|
#### Docker config
|
|
|
|
If you are using Docker, set `bind_addresses` to `['0.0.0.0']` as shown:
|
|
|
|
```yaml
|
|
listeners:
|
|
- port: 9000
|
|
bind_addresses: ['0.0.0.0']
|
|
type: manhole
|
|
```
|
|
|
|
When using `docker run` to start the server, you will then need to change the command to the following to include the
|
|
`manhole` port forwarding. The `-p 127.0.0.1:9000:9000` below is important: it
|
|
ensures that access to the `manhole` is only possible for local users.
|
|
|
|
```bash
|
|
docker run -d --name synapse \
|
|
--mount type=volume,src=synapse-data,dst=/data \
|
|
-p 8008:8008 \
|
|
-p 127.0.0.1:9000:9000 \
|
|
matrixdotorg/synapse:latest
|
|
```
|
|
|
|
#### Native config
|
|
|
|
If you are not using docker, set `bind_addresses` to `['::1', '127.0.0.1']` as shown.
|
|
The `bind_addresses` in the example below is important: it ensures that access to the
|
|
`manhole` is only possible for local users).
|
|
|
|
```yaml
|
|
listeners:
|
|
- port: 9000
|
|
bind_addresses: ['::1', '127.0.0.1']
|
|
type: manhole
|
|
```
|
|
|
|
#### Accessing synapse manhole
|
|
|
|
Then restart synapse, and point an ssh client at port 9000 on localhost, using
|
|
the username `matrix`:
|
|
|
|
```bash
|
|
ssh -p9000 matrix@localhost
|
|
```
|
|
|
|
The password is `rabbithole`.
|
|
|
|
This gives a Python REPL in which `hs` gives access to the
|
|
`synapse.server.HomeServer` object - which in turn gives access to many other
|
|
parts of the process.
|
|
|
|
Note that any call which returns a coroutine will need to be wrapped in `ensureDeferred`.
|
|
|
|
As a simple example, retrieving an event from the database:
|
|
|
|
```pycon
|
|
>>> from twisted.internet import defer
|
|
>>> defer.ensureDeferred(hs.get_datastore().get_event('$1416420717069yeQaw:matrix.org'))
|
|
<Deferred at 0x7ff253fc6998 current result: <FrozenEvent event_id='$1416420717069yeQaw:matrix.org', type='m.room.create', state_key=''>>
|
|
```
|