527759dd02
Add a dedicated configuration/authentication doc covering password and access-token setup, including environment-variable mappings and token-generation example. Link to it from configuration docs and align the sample config wording with Matrix Authentication Service/OIDC terminology.
2.9 KiB
🛠️ Configuration
The bot's behavior is controlled by a combination of static and dynamic configuration.
Static configuration
The bot can be configured using a YAML configuration file as well as environment variables.
When running the bot locally (during 🧑💻 development), the bot's configuration is read from the var/app/config.yml file.
This file is created from the template found in etc/app/config.yml.dist.
Certain keys can be left unset, in which case 📝 hardcoded defaults would be used.
Some configuration keys found in the YAML configuration can be overridden by setting an environment variable (dots should be replaced with _). Example:
- to override
command_prefix, set an environment variableBAIBOT_COMMAND_PREFIX - to override
homeserver.server_name, set an environment variableBAIBOT_HOMESERVER_SERVER_NAME
You can see the list of supported environment variables in the 🦀 src/entity/cfg/env.rs file.
Warning
The static configuration contains an
initial_global_configkey, which is used to populate the bot's global configuration (stored as dynamic configuration) the first time the bot starts. Modifying this subsequently will not have any effect. After initial global configuration creation, it's expected to be managed dynamically via chat commands.
For Matrix-account authentication setup, see 🔐 Authentication.
Dynamic configuration
Besides the bot's static configuration, the bot can also be configured dynamically at runtime (via chat messages).
This includes changes to 🔒 Access, 🤖 Agents and 🛠️ Room Settings.
Room Settings
Room Settings come from 3 different levels with priority in the following order (higher to lower):
- 📍 per-room (
!bai config room ..commands) - 🌐 globally (
!bai config global ..commands) - 📝 as hardcoded defaults
You can adjust the following settings per room and/or globally:
Refer to the bot's help messages (as a response to a !bai config help command) for the most up-to-date information on what Room Settings can be configured.
You can get an overview of the configuration affecting the current room (a mix of hardcoded defaults, agent defaults, global and room-level settings) by sending a !bai config status command to the room.