Homeserver Admin Section
Configuration options relating to the deployed Homeserver Admin instance provided by ESS
Homeserver Admin is the web-based client for the Synapse Admin API. Homeserver Admin serves as a user interface for administering Synapse homeservers, allowing management of users, rooms, federation and more.
All settings configured via the UI in this section will be saved to your deployment.yml
, with the contents of secrets being saved to secrets.yml
. You will find specific configuration examples in each section.
Config Example
spec:
components:
synapseAdmin:
By default, if you do not change any settings on this page, default Homeserver Admin pod CPU and Memory requirements will be added to your configuration file/s (see example below).
Config Example
spec:
components:
synapseAdmin:
k8s:
workloads:
resources:
limits:
memory: 500Mi
requests:
cpu: 50m
memory: 50Mi
Advanced
Verify TLS
Config Example
spec:
components:
synapseAdmin:
# Not present if 'Use Global Setting' selected
config:
# verifyTls: useGlobalSetting
# verifyTls: force
verifyTls: disable
Configures TLS verification, options include:
-
Use Global Setting
-
Force
-
Disable
It is not recommended to change this setting.
Delegated Authentication
If you are using delegated authentication and have kept Allow Local Users Login
as Auto
or set have directly set to Disabled
then the built-in defualt Synapse Admin user onprem-admin-donotdelete
will not be able to login.
Once deployed, to promote a user from your identity provider to Synapse Admin i.e. Bob:
- Ensure they have logged in once. so that their Matrix ID has been created, i.e. @bob:example.com
- Use the following to promote them to Synapse Admin:
kubectl exec -n element-onprem -it pods/synapse-postgres-0 -- /usr/bin/psql -d synapse -U synapse_user -c "update users set admin = 1 where name = '@bob:example.com';"