Skip to content

配置指南 ​

仓库的 .env.example 提供配置示例。使用项目的 docker-compose.yml 时,复制为 .env 并按部署环境修改;不要将包含密码和密钥的文件提交到 Git。

基础配置 ​

配置项说明
DB_PASSWORDPostgreSQL 密码;应用与数据库容器使用同一个值。
ADMIN_INITIAL_PASSWORD空数据库首次初始化时的管理员密码,至少 12 个非空白字符,最多 72 个 UTF-8 字节。
APP_KEY至少 32 个字符的独立随机应用密钥,部署后应妥善保存和备份。
PLATFORM_ORIGIN浏览器访问后台的完整 origin,例如 https://bot.example.com。
TGBOTPRESS_IMAGE可选,指定应用镜像;示例默认使用 ghcr.io/cnmbdb/tgbotpress:latest。

示例 Compose 将数据库地址设为 postgres:5432,数据库名和用户名均为 tgbotpress。使用外部数据库或自定义 Compose 时,应一并检查 DB_HOST、DB_PORT、DB_DATABASE、DB_USERNAME 和 DB_PASSWORD 是否与实际环境一致。示例 Compose 的 environment 会覆盖 env_file 中对应的连接值。

访问与反向代理 ​

示例将应用端口 8083 和可选 webhook 端口 8084 绑定到服务器的 127.0.0.1。通过域名访问时,配置 HTTPS 反向代理,并将 PLATFORM_ORIGIN 设置为浏览器实际使用的地址。WEBHOOK_PROXY_PORT 是可选的额外监听端口,仅在部署需要时配置和映射。

进程与 Telegram ​

配置项说明
PLATFORM_PROCESS_MODE选择 all、web 或 worker;示例使用 all。拆分进程时需分别规划数据库和健康检查。
PLATFORM_TELEGRAM_ACTIONS控制 Telegram 相关操作;示例默认关闭。
PLATFORM_TELEGRAM_UPDATE_DISPATCH_READY控制更新分发就绪状态;示例默认关闭。
PLATFORM_TELEGRAM_POLLING_ENABLED控制轮询;示例默认关闭。
TELEGRAM_WEBHOOK_ORIGINWebhook 使用的地址;应结合实际公网 HTTPS 路由配置。

启动容器不会自动完成 Telegram 接入。Webhook 需要 Telegram 可访问的 HTTPS 地址、正确路由及稳定密钥;请先在受控环境验证。

数据持久化 ​

示例 Compose 使用 postgres_data 卷保存数据库,使用 media 卷保存媒体文件。更新前备份数据库和媒体,并安全保存 APP_KEY。初始管理员密码仅在空数据库首次初始化时使用,不是已有账号的密码重置方式。

部分邮件、媒体、链上和支付功能还需要额外服务与配置。完整选项请以项目当前的 .env.example、Compose 文件和 README 为准。

Released under the MIT License.