35 lines
1.1 KiB
Markdown
35 lines
1.1 KiB
Markdown
|
# Setting up Synapse Admin (optional)
|
||
|
|
|
||
|
|
The playbook can install and configure [synapse-admin](https://github.com/Awesome-Technologies/synapse-admin) for you.
|
||
|
|
|
||
|
|
It's a web UI tool you can use to **administrate users and rooms on your Matrix server**.
|
||
|
|
|
||
|
|
See the project's [documentation](https://github.com/Awesome-Technologies/synapse-admin) 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:
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
matrix_synapse_admin_enabled: true
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Installing
|
||
|
|
|
||
|
|
After configuring the playbook, run the [installation](installing.md) command again:
|
||
|
|
|
||
|
|
```
|
||
|
|
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## 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](registering-users.md) on your server.
|
||
|
|
|
||
|
|
The Homeserver URL to use on Synapse Admin's login page is: `https://matrix.DOMAIN`
|