From b3fd8e548f83fe46398ced4760d7e2bb7588c24d Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Mon, 15 Dec 2025 09:22:54 +0200 Subject: [PATCH] Minor documentation updates --- docs/access.md | 3 ++- docs/configuration/README.md | 7 +++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/access.md b/docs/access.md index 54d8538..a5250e8 100644 --- a/docs/access.md +++ b/docs/access.md @@ -43,7 +43,8 @@ Administrators cannot be changed without adjusting the bot's configuration on th Room-local agent managers are users privileged to **create their own [agents](./agents.md)** (see `!bai agent`) in rooms. -**⚠️ WARNING**: Letting regular users create agents which contact arbitrary network services **may be a security issue**. +> [!WARNING] +> Letting regular users create agents which contact arbitrary network services **may be a security issue**. The following commands are available: - **Show** the currently allowed users: `!bai access room-local-agent-managers` diff --git a/docs/configuration/README.md b/docs/configuration/README.md index e941b1f..761ca5c 100644 --- a/docs/configuration/README.md +++ b/docs/configuration/README.md @@ -12,12 +12,15 @@ 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](../../src/entity/cfg/defaults.rs) would be used. -Each configuration key found in the YAML configuration can be overridden by setting an environment variable (dots should be replaced with `_`). Example: +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 variable `BAIBOT_COMMAND_PREFIX` - to override `homeserver.server_name`, set an environment variable `BAIBOT_HOMESERVER_SERVER_NAME` -The static configuration contains an `initial_global_config` key, which is used to populate the bot's global configuration (stored as [dynamic configuration](#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. +You can see the list of supported environment variables in the [🦀 src/entity/cfg/env.rs](../../src/entity/cfg/env.rs) file. + +> [!WARNING] +> The static configuration contains an `initial_global_config` key, which is used to populate the bot's global configuration (stored as [dynamic configuration](#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. ### Dynamic configuration