Skip to main content

Creating an account for Draupnir

tip

If you want Draupnir to be a homeserver admin, you might want to create the account using Synapse's register_new_matrix_user or Dendrite's create-account command. See the Synapse documentation here and Dendrite documentation here.

If you are not using encrypted rooms anywhere, you can get an access token by opening Element in a separate browser profile or incognito tab and logging in as the bot or registering an account. Once you are logged in, go to "All Settings", "Help & About", and click the little triangle next to "Access token". Copy and paste that into your config file under the accessToken key.

note

Do not log out, just close the window, otherwise the access token will be invalidated.

If you have presence enabled on your homeserver, do not keep the window open or use the same session to login to the Draupnir account as this will cause you to accidentally trigger a bug in Synapse or Element web that will flood presence updates.

warning

If you are using mas you cannot use the Synapse API currently.

Instead you should use the mas-cli as such:

  1. mas-cli manage issue-compatibility-token --yes-i-want-to-grant-synapse-admin-privileges <username>1
  2. mas-cli manage provision-all-users 2

Note that this requires an existing account. Create this one as you usually would with MAS.

Disabling rate limiting​

info

While Draupnir can be run on a rate limited account without issue. We recommend disabling rate limiting if the option is available to you.

By default, Draupnir will be rate limited by homeservers, which can inhibit Draupnir's ability to respond in some scenarios, particularly while redacting lots of messages.

It's therefore recommended to turn off ratelimiting for a draupnir bot, see the synapse admin API documentation for more information. For Dendrite this is configured in dendrite.yaml by adding exempt_user_ids: under rate_limiting:.

Making Draupnir a Synapse Admin​

note

To deactivate users, move aliases, and shutdown rooms, Draupnir will need to be a server admin. These features are only supported on Synapse.

If you registered a new account, please see the Synapse documentation for how to make an existing account a Synapse admin here.

Footnotes​

  1. You can find more about it in the official documentation at https://element-hq.github.io/matrix-authentication-service/reference/cli/manage.html#manage-issue-compatibility-token ↩

  2. This ensures that synapse is aware of the user's new device. Otherwise synapse will reject requests. Check upstream for more information ↩