mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2026-07-23 02:43:49 +10:00
matrix-tuwunel: add labels to expose the Synapse-compatible admin API
Tuwunel serves the Synapse administration API under /_synapse/admin, but the role only routed /_matrix, so admin dashboards and moderation bots could not reach it. Add public and internal Traefik label groups mirroring the matrix-synapse role, and enable them automatically when Ketesa, Element Admin, or Draupnir is installed.
This commit is contained in:
committed by
Slavi Pantaleev
parent
01949d8ad2
commit
1febc275f2
@@ -41,6 +41,7 @@ matrix_ketesa_enabled: true
|
||||
|
||||
- for [Synapse](./configuring-playbook-synapse.md) (our default homeserver implementation): `matrix_synapse_container_labels_public_client_synapse_admin_api_enabled: true`
|
||||
- for [Dendrite](./configuring-playbook-dendrite.md): `matrix_dendrite_container_labels_public_client_synapse_admin_api_enabled: true`
|
||||
- for [Tuwunel](./configuring-playbook-tuwunel.md): `matrix_tuwunel_container_labels_public_client_synapse_admin_api_enabled: true`
|
||||
|
||||
By default, Ketesa installation will be [restricted to only work with one homeserver](https://github.com/etkecc/ketesa/blob/main/README.md#restricting-available-homeserver) — the one managed by the playbook. To adjust these restrictions, tweak the `matrix_ketesa_config_restrictBaseUrl` variable.
|
||||
|
||||
|
||||
@@ -180,6 +180,22 @@ When enabled, rooms with a valid `m.room.policy` state event have outgoing event
|
||||
|
||||
The role sets `default_room_version: '12'`, so newly created rooms default to Matrix [room version 12](https://github.com/matrix-org/matrix-spec-proposals/pull/4289) ("Hydra"). Override `matrix_tuwunel_config_default_room_version` if you need an earlier version for client compatibility.
|
||||
|
||||
### Exposing the Administration API
|
||||
|
||||
Tuwunel serves a Synapse-compatible Administration API under the `/_synapse/admin` path, so administration dashboards (such as synapse-admin and ketesa) and moderation bots (such as Draupnir and Meowlnir) work against it. The served endpoints are listed on the [Tuwunel Synapse Admin API page](https://matrix-construct.github.io/tuwunel/development/compliance/synapse-admin.html).
|
||||
|
||||
The API is not routed through the reverse proxy by default. Every endpoint requires an administrator access token, but you may still prefer to keep it off the public entrypoint. To reach it only from trusted networks, expose it on the internal Traefik entrypoint:
|
||||
|
||||
```yaml
|
||||
matrix_tuwunel_container_labels_internal_client_synapse_admin_api_enabled: true
|
||||
```
|
||||
|
||||
To expose it publicly instead (for example, when a dashboard runs in the browser), set:
|
||||
|
||||
```yaml
|
||||
matrix_tuwunel_container_labels_public_client_synapse_admin_api_enabled: true
|
||||
```
|
||||
|
||||
## Creating the first user account
|
||||
|
||||
Unlike Synapse and Dendrite, Tuwunel does not register users from the command line or via the playbook. On first startup it logs a one-time-use registration token to its journal:
|
||||
|
||||
Reference in New Issue
Block a user