Skip to content

配置文件 ​

宿主机直部署使用 TOML 格式配置;容器部署不需要配置文件,连接信息由环境变量提供。

用法 ​

bash
cp config/config.toml.sample config/config.toml
vim config/config.toml       # 按需修改
./GoPanel                    # 程序启动时自动识别 config/config.toml

自定义路径:

bash
./GoPanel -c=/etc/gopanel/config.toml
# 或
GOPANEL_CONFIG=/etc/gopanel/config.toml ./GoPanel

示例 ​

toml
# ---------- 服务 ----------
[server]
port = 12395                # 等价 GOPANEL_PORT / GOPANEL_SERVER_PORT

# ---------- 数据库连接 ----------
[db]
type = "mysql"              # mysql / mariadb / postgres / sqlite
user = "root"
password = ""
host = "127.0.0.1"          # 可写 host:port
port = 3306
database = "gopanel"
prefix = ""
debug = false               # true 时打印每条 SQL

[db.options]
charset = "utf8mb4"

# ---------- 系统 ----------
[sys]
env = "prod"                # prod / dev

SQLite 配置 ​

toml
[db]
type = "sqlite"
file = "data/gopanel.db"    # 也可用 database 字段

取值优先级 ​

text
环境变量 > 命令行参数 > config.toml > 内置默认值

例如同时存在 GOPANEL_PORT=8080 与 server.port = 9000 时,最终为 8080。

启动自检日志会打印 listen_port 与 listen_port_source,指出最终端口及其来源。

环境变量与配置键的对应 ​

环境变量名 = GOPANEL_ + 配置键大写(. 换成 _):

配置键环境变量
server.portGOPANEL_SERVER_PORT(别名 GOPANEL_PORT)
sys.envGOPANEL_SYS_ENV(别名 GOPANEL_ENV)
db.typeGOPANEL_DB_TYPE
db.hostGOPANEL_DB_HOST
db.databaseGOPANEL_DB_DATABASE(别名 GOPANEL_DB_NAME)
db.debugGOPANEL_DB_DEBUG

完整清单见 环境变量。

关于「站点端口」类配置 ​

本程序是单一监听端口的管理后台,除管理后台端口外不提供任何监听能力。 因此「站点 HTTP/HTTPS 端口、站点根目录、HTTP/2、QUIC、可配置优雅退出时长」 这一类参数不存在(启动参数与配置键均已移除,镜像与编排也不再声明)。

需要站点 / HTTPS / HTTP-3 时,由外部 Nginx / Caddy 反代管理后台端口承载。

相关 ​

基于 AGPL-3.0 协议发布