Additional Config
We strongly advise against including any config not configurable via the UI as it will most likely interfere with settings automatically computed by the updater. Additional configuration options are not supported so we encourage you to first raise your requirements to Support where we can best advise on them.
The Additional Config
section, which allows including config not currently configurable via the UI from the Configuration Manual, is available under the 'Advanced' section of the Synapse
page.
Configuration should follow the same format as supplied by the Configuration Manual, if you include options that have otherwise been configured via the UI they will be overridden with the exception of MAU, Federation and Data Retention. Though as noted above, this will most likely interfere with settings automatically computed by the updater.
Known Issues
auto_join_rooms
Due to how the installer sets up Synapse, this option will only work when on configured as required on the first deployment. Should you configure this on an existing deployment, or change the rooms on a subsequent deployment, it will not function and you'll recieve various errors within the Synapse pod logs. To resolve you will need to manually create the rooms and specify auto_join_mxid_localpart
in your config. If you're making use of AdminBot / AuditBot, they'd be perfect for this as they are automatically invited to all new rooms.
Therefore in order to get this setup, you'll need to follow these steps:
-
For a brand new "fresh" install, simply specify with config per the manual, on the first user registration, they will create and join the specified rooms and all subsequent users will also auto-join.
auto_join_rooms: - "#exampleroom:example.com" - "#anotherexampleroom:example.com"
-
For existing installs, or when you wish to adjust the auto-join room list, you will need to:
- Manually create the rooms and assign the desired alias. (Room Settings -> Local Addresses)
- Add the following config, making sure to set the localpart to a user present within the rooms specified. This could be the room creator, someone invited who has joined, or something like Admin/Audit Bot.
auto_join_mxid_localpart: adminbot
- Redeploy, wait for the synapse pod to restart
- Newly registered users will now auto-join the specified rooms
As usual, with auto_join_rooms
, the caveat is that changing the rooms will not autojoin previously registered users.