Provisioning

Currently there is no automated form to provision a Meowlnir bot for your community.

In order to get your own Meowlnir, or other bot, please join #general:nexy7574.co.uk and ask @nex:nexy7574.co.uk for a bot.

There are no requirements or restrictions - you can get a bot provisioned for a community of any size, from nobody to everybody.

Large communities

In order to ensure that the service remains fast and available for all users, we ask that you make it known before your provision is processed that you would like to provision for a large community, ideally specifying a rough size where possible. This allows us to make sure that we have adequate resources available at all times.

Note that community size does not influence your priority, for better or worse. Available resources are distributed evenly between all consumers.

Provisioning a bot

Onsite

An "onsite" bot is one that runs on our server, corellia.timedout.uk. This is a high-uptime Synapse server running on a dedicated host that is specifically tuned to be running bots at unquestionably high performance. Due to this nature, only bot accounts are allowed to reside on the server, so user accounts cannot be provided. This is the best option if you do not run your own server, or cannot run a Meowlnir on your server, or even if your server is just not as reliable.

An onsite bot is the easiest and fastest to provision. Upon request, you will receive an invite from a bot with a user ID like @modbot.8111aa6a-f956-4451-a777-e676a2d441ce:corellia.timedout.uk to your management room. This is where you can control the Meowlnir bot, including changing protected rooms, watched lists, setting power levels, redacting events, kicking and banning users, and changing the bot's profile.

Onsite bots are automatically subscribed to the crowdsourced policy lists "Community Moderation Effort" and "Project Huginn and Muninn Active Threats". It is recommended you keep these two lists enabled.

You will also want to create your own policy list room so that you can issue bans with Meowlnir. You can also use the management room itself as a policy list.

Offsite

An "offsite" bot is one that runs on your own server. You need to be a server manager to use an offsite bot as you usually need filesystem-level access to your homeserver.

In order to manage an offsite bot, you have to register an appservice. The configuration (YAML) will be given to you, which includes a unique ID, credentials, communication URL, and some metadata around what the offsite bot is allowed to control. You can pick the bot's user ID, the rest will be given to you.

If you are on Synapse, you need to place this file somewhere that Synapse can read, and then append that to your configuration file: see the Synapse documentation.

If you are on conduwuit, Continuwuity, or Tuwunel, you will need to go to your admin room (typically called "[server name] Admin Room") and run !admin appservices register and then paste the YAML content into a code block, like below:

!admin appservices register
```yaml
id: <random>
url: https://corellia.timedout.uk/<random>
as_token: <random>
hs_token: <random>
sender_localpart: <random>
namespaces:
  users:
    - exclusive: true
      regex: <...>
```

If you are on Conduit, you should do the same thing, but use @conduit:yourserver.name.example register-appservice instead of !admin appservices register.

Any other homeservers are untested and likely unsupported.

Once your appservice has been registered, a Meowlnir instance will be spawned for you, configured, and then handed off to you. If you wish for this Meowlnir instance to be able to perform tasks such as user suspension and deactivation, you will need to give it server administrator (on conduit and derrivatives, this is achieved by inviting it to the admin room)

In order to do things like room deletes and takedowns, and faster bulk event redactions, you will need to provide (read-only) database access. This can be discussed in private, however is not required for operation.