Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 2.59 KB

setup.md

File metadata and controls

49 lines (32 loc) · 2.59 KB
Raw

Setting up Mjolnir

It is recommended that your management room be encrypted. To ensure that your bot can communicate with encrypted rooms, ensure that you have encryption enabled in the config.

If you aren't using encrypted rooms anywhere, get an access token by opening Element in a seperate browser profile or incognito tab, and log in as the bot. Then, go to "All Settings", "Help & About", and click the little triangle next to "Access token". Copy and paste that into your config under accessToken.

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

It's recommended to setup mjolnir as "close" to your server as possible (latency-wise), so that it may react swiftly to commands, and quickly apply protections.

It's also recommended to turn off ratelimiting for a mjolnir bot, see matrix-org/synapse#6286 and the synapse admin API documentation for more information.

Note: To deactivate users, move aliases, shutdown rooms, Mjolnir will need to be a server admin, and the server needs to be Synapse.

See the sample configuration for documentation about individual config keys.

Installation

On a high level, installing Mjolnir works like the following;

  1. Creating an account for mjolnir. (Optional) Disable rate limits for that account.
  2. Install mjolnir, see below.
  3. Configure mjolnir see further below.
  4. Start mjolnir.

Mjolnir can be installed in two ways, via Docker, or building it yourself.

See the below links for corresponding installation documentation;

Post-install

After installation, create a room, and ensure the mjolnir has joined. This will be your "management room".

It is highly recommended that this room be encrypted. Ensure that you have properly configured your mjolnir to use encryption in the configuration.

Acquire the room ID of this room, in Element Web you can find this via (Room Name) -> Settings -> Advanced -> "Internal Room ID".

In your configuration, set managementRoom to this Room ID, now Mjolnir will only respond to commands originating from that room. If you want to upgrade your room in the future, you will have to update the configuration with it, or set it to an alias that corresponds to that room ID.

You can now start mjolnir. If everything went well, it should now send a bunch of messages in that room, signalling how it is booting up, and its current status.