Skip to content

配置 ​

配置文件位于默认目录,完整示例见仓库中的 backend/config.example.toml。

配置项 ​

配置项说明
database_urlsqlite://nodeflare.db 或 PostgreSQL 连接串,如 postgres://user:password@127.0.0.1:5432/nodeflare?sslmode=disable
bind_addr监听地址,默认 127.0.0.1:2206
admin_username管理员用户名
admin_password管理员密码(8–128 字符),仅首次初始化数据库需要,成功后自动清空
trusted_proxies可信反向代理 IP / CIDR;仅这些网段的 X-Forwarded-For 才会被信任,详见反向代理
turnstile_site_key / turnstile_secret_keyCloudflare Turnstile 密钥,留空则禁用;可分别保护管理员登录与公开看板
session_ttl_hours会话有效期(1–2160 小时),默认 168
frontend_dir / admin_frontend_dir前端静态资源目录,相对路径按配置文件所在目录解析
theme_dir主题解压目录,默认配置目录下的 themes,详见主题开发

TIP

Docker 部署使用宿主机 /etc/nodeflare/config.toml,挂载到容器内同一路径。文件需允许容器用户 10001:10001 读写,bind_addr 保持 0.0.0.0:2206,具体填法见 Docker 部署。

命令行参数 ​

启动时可用命令行临时覆盖配置:

bash
nodeflare --config <路径> --bind <地址> --database <URL>

WARNING

使用 --database 启动时,后台的在线迁移功能会被禁用。

完整示例 ​

以下为 config.example.toml 的完整内容(正式安装时配置位于 /etc/nodeflare/config.toml,各平台路径见默认目录;Docker 部署使用 docker/config.example.toml):

toml
# 数据库连接 URL
# SQLite: sqlite:///path/to/database.db 或 sqlite://nodeflare.db
# PostgreSQL: postgres://user:password@127.0.0.1:5432/nodeflare?sslmode=disable
database_url = "sqlite://nodeflare.db"

# 服务器监听地址
bind_addr = "127.0.0.1:2206"

# 只有来自这些反向代理网段的 X-Forwarded-For 才会被信任
trusted_proxies = ["127.0.0.1/32", "::1/128"]

# 管理员用户名
admin_username = "admin"

# 管理员密码(8-128 个字符;仅首次初始化数据库需要,成功后自动清空)
admin_password = "CHANGE_ME_WITH_A_STRONG_PASSWORD"

# Cloudflare Turnstile 站点密钥(公开),留空则禁用
turnstile_site_key = ""

# Cloudflare Turnstile 密钥(私密)
turnstile_secret_key = ""

# 路径相对于本配置文件所在目录
frontend_dir = "../frontend/dist"
admin_frontend_dir = "../frontend/admin-dist"

# 下载或上传的主题 ZIP 解压目录
theme_dir = "themes"

# 管理员会话有效期(小时,范围 1-2160)
session_ttl_hours = 168

基于 MIT 许可发布