configuring-playbook-synapse-admin.md

Setting up Synapse Admin (optional)

The playbook can install and configure etkecc/synapse-admin (a feature-rich fork of Awesome-Technologies/synapse-admin) for you.

synapse-admin is a web UI tool you can use to administrate users, rooms, media, etc. on your Matrix server. It's designed to work with the Synapse homeserver implementation, but to some extent may work with Dendrite as well.

See the project's documentation to learn what it does and why it might be useful to you.

Adjusting the playbook configuration

Add the following configuration to your inventory/host_vars/matrix.DOMAIN/vars.yml file:

matrix_synapse_admin_enabled: true

Note: Synapse Admin requires Synapse's Admin APIs to function. Access to them is restricted with a valid access token, so exposing them publicly should not be a real security concern. Still, for additional security, we normally leave them unexposed, following official Synapse reverse-proxying recommendations. Because Synapse Admin needs these APIs to function, when installing Synapse Admin, the playbook automatically exposes the Synapse Admin API publicly for you. Depending on the homeserver implementation you're using (Synapse, Dendrite), this is equivalent to:

• for Synapse (our default homeserver implementation): matrix_synapse_container_labels_public_client_synapse_admin_api_enabled: true
• for Dendrite: matrix_dendrite_container_labels_public_client_synapse_admin_api_enabled: true

By default, synapse-admin installation will be restricted to only work with one homeserver - the one managed by the playbook. To adjust these restrictions, tweak the matrix_synapse_admin_config_restrictBaseUrl variable.

Installing

After configuring the playbook, run the installation command again (just install-all).

Usage

After installation, Synapse Admin will be accessible at: https://matrix.DOMAIN/synapse-admin/

To use Synapse Admin, you need to have registered at least one administrator account on your server.