Using the Admin Console
Opening the Admin Console
N.B. This document relates to versions 2023-07.01 and later.
First, let’s get started by logging into the admin console. To do this, make sure that the installer is still running or bring it up by running the installer binary like this (Please specify the correct version and don’t just copy this line!):
You will then see output similar to:
To start configuration open:
The Configure Tab
You’ll notice that the first page is the “Configure” tab on the top and the sections in the left hand menu mirror those in the installer:
- Host is for setting details specific to the deployment host itself.
- Domains is for setting the specific domain names and subdomains that are used by the installation.
- Certificates is for making specific certificate choices and uploading certificates if using custom certificates.
- Cluster is for setting any kubernetes specific parameters required for your installation.
- Synapse is for setting any homeserver settings or variables. You may also set any custom configuration that can be done through homeserver.yaml.
- Element Web is for making any specific changes to the Element Web deployment and also for setting any custom configuration that would be specified in a config.json.
- Homeserver Admin is for making changes related to this admin console.
- Integrator is for making any changes related to the integration manager.
- Integrations is for installing, configuring, or removing any of the add-ons that we ship as part of Element Server Suite.
Note that all settings under the “Configure” tab presently require you to re-deploy your installation by using the conveniently located “Deploy” button. Please make all changes across any of these pages that you wish to deploy prior to hitting the “Deploy” button.
If you click on the “Admin” tab, you will see the following screen:
See the section by section guide on
TheUsing the Admin Tab for a more detailed look at using it, otherwise see the below overview:
In the left hand menu, we have the following options:
- Users tab. On this tab, we can display a list of users, see who has admin rights, and click on a username to get more information on a local user.
- User Info. tab. On this tab, we can specify a username and get more information about a user.
- Add user tab. We can use this tab to add a local user to the database. This will not work if you are using delegated authentication.
- Rooms tab. On this tab, we can view a list of rooms on the homeserver. This will have information on the room id, the room name, the number of users in a room, and the version of the room. From here, we can also delete rooms from the server.
- Server Info tab. On this tab, we can see some basic server information such as the version of synapse installed and the version of python available to the homeserver.
- Admin bot tab. This tab includes a button to log in as the admin bot user along with the key backup credentials to decrypt the messages once you are logged in as the admin bot.
- Audit bot tab. This tab includes a button to log in as the audit bot user along with the key backup credentials to decrypt the messages once you are logged in as the audit bot.