mirror of
https://github.com/matrix-org/mjolnir.git
synced 2024-10-01 01:36:06 -04:00
96 lines
3.8 KiB
YAML
96 lines
3.8 KiB
YAML
# Where the homeserver is located (client-server URL). This should point at
|
|
# pantalaimon if you're using that.
|
|
homeserverUrl: "https://matrix.org"
|
|
|
|
# The access token for the bot to use. Do not populate if using Pantalaimon.
|
|
accessToken: "YOUR_TOKEN_HERE"
|
|
|
|
# Pantalaimon options (https://github.com/matrix-org/pantalaimon)
|
|
pantalaimon:
|
|
# If true, accessToken above is ignored and the username/password below will be
|
|
# used instead. The access token of the bot will be stored in the dataPath.
|
|
use: false
|
|
|
|
# The username to login with.
|
|
username: mjolnir
|
|
|
|
# The password to login with. Can be removed after the bot has logged in once and
|
|
# stored the access token.
|
|
password: your_password
|
|
|
|
# The directory the bot should store various bits of information in
|
|
dataPath: "/data/storage"
|
|
|
|
# Whether the bot should autojoin rooms it is invited to or not
|
|
autojoin: true
|
|
|
|
# If `autojoin` is true, this defines whether anyone can invite the bot (the
|
|
# default), or only those in the `managementRoom` below. Generally this option
|
|
# should be set to true (only allow people in the management room to do invites)
|
|
# when using autojoin.
|
|
autojoinOnlyIfManager: false
|
|
|
|
# The room ID where people can use the bot. The bot has no access controls, so
|
|
# anyone in this room can use the bot - secure your room!
|
|
# This should be a room alias or room ID - not a matrix.to URL.
|
|
# Note: Mjolnir is fairly verbose - expect a lot of messages from it.
|
|
managementRoom: "#moderators:example.org"
|
|
|
|
# Set to false to make the management room a bit quieter.
|
|
verboseLogging: true
|
|
|
|
# The log level for the logs themselves. One of DEBUG, INFO, WARN, and ERROR.
|
|
# This should be at INFO or DEBUG in order to get support for Mjolnir problems.
|
|
logLevel: "INFO"
|
|
|
|
# Set to false to disable synchronizing the ban lists on startup. If true, this
|
|
# is the same as running !mjolnir sync immediately after startup.
|
|
syncOnStartup: true
|
|
|
|
# Set to false to prevent Mjolnir from checking its permissions on startup. This
|
|
# is recommended to be left as "true" to catch room permission problems (state
|
|
# resets, etc) before Mjolnir is needed.
|
|
verifyPermissionsOnStartup: true
|
|
|
|
# If true, Mjolnir won't actually ban users or apply server ACLs, but will
|
|
# think it has. This is useful to see what it does in a scenario where the
|
|
# bot might not be trusted fully, yet. Default false (do bans/ACLs).
|
|
noop: false
|
|
|
|
# Set to true to use /joined_members instead of /state to figure out who is
|
|
# in the room. Using /state is preferred because it means that users are
|
|
# banned when they are invited instead of just when they join, though if your
|
|
# server struggles with /state requests then set this to true.
|
|
fasterMembershipChecks: false
|
|
|
|
# A case-insensitive list of ban reasons to automatically redact a user's
|
|
# messages for. Typically this is useful to avoid having to type two commands
|
|
# to the bot. Use asterisks to represent globs (ie: "spam*testing" would match
|
|
# "spam for testing" as well as "spamtesting").
|
|
automaticallyRedactForReasons:
|
|
- "spam"
|
|
- "advertising"
|
|
|
|
# A list of rooms to protect (matrix.to URLs)
|
|
protectedRooms:
|
|
- "https://matrix.to/#/#yourroom:example.org"
|
|
|
|
# Set this option to true to protect every room the bot is joined to. Note that
|
|
# this effectively makes the protectedRooms and associated commands useless because
|
|
# the bot by nature must be joined to the room to protect it.
|
|
#
|
|
# Note: the management room is *excluded* from this condition. Add it to the
|
|
# protected rooms to protect it.
|
|
protectAllJoinedRooms: false
|
|
|
|
# An optional server for the Synapse Mjolnir plugin to connect to. This is
|
|
# recommended if you're running the Synapse module in a worker environment,
|
|
# particularly if you're running a federation reader.
|
|
#
|
|
# It is not recommended to expose this to the wider internet. Connections
|
|
# are over TCP only.
|
|
banListServer:
|
|
enabled: false
|
|
bind: "0.0.0.0"
|
|
port: 24465
|