Skip to content

Configuration

Tobias Vorwachs edited this page Oct 27, 2026 · 1 revision

Configuration

The webhook bot reads one TOML file, bot.toml, given with mumbot webhook --config <file> or the MUMBOT_CONFIG environment variable. The test bot needs no file; it takes command-line options.

Full key-by-key reference: docs/configuration.md.

Sections

Section Holds
[server] Mumble host, port, bot name, certificate name, channel to join, connect password, data folder.
[http] Listen address (default 127.0.0.1:8080), rate limit per minute (default 20), delivery timeout.
[[keys]] One block per outside system: key, label, allowed channels (name or id).
[[token]] Channel passwords (access tokens), if channels need them.

Minimal example

[server]
host = "mumble.example.org"
channel = "Lobby"

[http]
listen = "127.0.0.1:8080"

[[keys]]
key = "REPLACE-WITH-A-LONG-RANDOM-KEY"
label = "ci"
channels = ["Lobby"]

Environment variables

Variable Meaning
MUMBOT_CONFIG Path of bot.toml.
SERVER_PASSWORD Connect password (preferred over the file).
MUMBOT_DATA Folder for the client certificate (/data in Docker).
RUST_LOG Log level, for example info.

Rules

  • An unknown key or section is an error, so typos show up at startup.
  • The file is read once. Restart the bot after a change.
  • Keep bot.toml private and never commit it. See Security.

Starting points: examples/bot.example.toml for a binary, Examples for Docker.

Clone this wiki locally