Setup

Requirements

• A Matrix homeserver that supports application services (e.g. Synapse). You need access to register an appservice, which usually involves editing the homeserver config file.

If you want to compile Meowlnir manually (which is not required), you'll also need:

• Go 1.23+ (download & installation instructions at https://go.dev/doc/install).
• libolm3 with dev headers and a C/C++ compiler (if you want encryption support).

Installation

You may either compile Meowlnir manually or download a prebuilt executable from the mau.dev CI or GitHub releases. Prebuilt executables are the simplest option, as they don't require having Go nor libolm installed.

Option 1: Downloading a prebuilt executable from CI

1. Download the relevant artifacts:
   • linux/amd64: https://mau.dev/maunium/meowlnir/-/jobs/artifacts/main/download?job=build%20amd64
   • linux/arm64: https://mau.dev/maunium/meowlnir/-/jobs/artifacts/main/download?job=build%20arm64
   • linux/arm: https://mau.dev/maunium/meowlnir/-/jobs/artifacts/main/download?job=build%20arm
   • or find it yourself on https://mau.dev/maunium/meowlnir/-/pipelines
2. Extract the downloaded zip file into a new directory.

Option 2: Downloading a release

1. Go to https://github.com/maunium/meowlnir/releases
2. Download the binary for the architecture you want and save it in a new directory.

Option 3: Compiling manually

1. Clone the repo with git clone https://github.com/maunium/meowlnir.git
2. Enter the directory (cd meowlnir)
3. Run ./build.sh to fetch Go dependencies and compile ([build.sh] will simply call go build with some additional flags).

• If you want encryption support, make sure you have a C/C++ compiler and the Olm dev headers (libolm-dev on debian-based distros) installed.
• If not, use ./build.sh -tags nocrypto to disable encryption.
• As an experimental feature, you can also use -tags goolm to use a pure Go reimplementation of libolm. Encryption can be supported without a C compiler or Olm dev headers with this method.

Configuring and running

1. Follow the configuration instructions to create a config file and registration.
2. Register the registration file with your homeserver (see Registering appservices in the bridge docs for details).
3. Run Meowlnir with ./meowlnir.
4. Follow the instructions on the Creating bots page to actually initialize your bot, then the Configuring bots page to tell the bot what to do.

Updating

If you compiled manually, pull changes with git pull and recompile with ./build.sh.

If you downloaded a prebuilt executable, simply download a new one and replace the old one.

Finally, start Meowlnir again.