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

Add note to manhole.md about bind_address when using with docker #8526

Merged
merged 6 commits into from
Oct 14, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/8526.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added note about docker in manhole.md regarding which ip address to bind to. Contributed by @Maquis196.
10 changes: 10 additions & 0 deletions docs/manhole.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,16 @@ listeners:
(`bind_addresses` in the above is important: it ensures that access to the
manhole is only possible for local users).

**Docker Note**
If you are using docker, please ensure you use the following example;
maquis196 marked this conversation as resolved.
Show resolved Hide resolved

```yaml
listeners:
- port: 9000
bind_addresses: ['0.0.0.0']
type: manhole
```

maquis196 marked this conversation as resolved.
Show resolved Hide resolved
Note that this will give administrative access to synapse to **all users** with
maquis196 marked this conversation as resolved.
Show resolved Hide resolved
shell access to the server. It should therefore **not** be enabled in
environments where untrusted users have shell access.
Expand Down