启动层配置
OmniGate 把配置分成两层:
- 启动层:
config.yaml,进程启动时读取,改完需要重启 - 运行层:管理台里改、数据库存、热替换,保存即生效
这一页讲启动层;运行层见 运行设置。
完整示例
server:
host: 127.0.0.1 # 局域网访问改成 0.0.0.0
port: 17777
admin:
username: "" # 设置后 Web 管理台需登录
password: "" # 留空 = 本地免登录
database:
driver: sqlite # sqlite | mysql | postgres
path: "" # sqlite 数据库文件,默认 ~/.omnigate/omnigate.db
dsn: "" # mysql/postgres 连接串
init_sql: [] # 初始化 SQL 文件列表
init_sql_inline: "" # 内联初始化 SQL
max_open_conns: 0 # 0 = 按驱动取默认值
max_idle_conns: 0
conn_max_lifetime_s: 0
log:
path: "" # 默认 ~/.omnigate/omnigate.log,支持 stdout / stderr / off
优先级
四级优先级:CLI flag > 环境变量 > config.yaml > 代码默认值。
server
| 字段 | 默认 | 说明 |
|---|---|---|
host | 127.0.0.1 | 监听地址。仅本机访问保持默认;局域网/容器访问改成 0.0.0.0 |
port | 17777 | 管理台与代理共用同一端口 |
admin
| 字段 | 说明 |
|---|---|
username | 管理台登录用户名,不能包含冒号 |
password | 管理台登录密码;用户名和密码都留空 = 本地免登录 |
这套账号只保护 Web 管理台,不用于 /v1 调用。/v1 一律使用虚拟密钥,见 虚拟密钥。
database
| 字段 | 说明 |
|---|---|
driver | sqlite(默认)、mysql、postgres |
path | driver=sqlite 时的数据库文件路径 |
dsn | driver=mysql/postgres 时的连接串 |
init_sql | 初始化 SQL 文件列表,连接后、建表迁移前按序执行 |
init_sql_inline | 内联初始化 SQL,在文件之后执行 |
max_open_conns / max_idle_conns | 连接池上限,0 按驱动取默认值 |
conn_max_lifetime_s | 连接最长存活秒数,0 不限制 |
Validate 会拒绝两种静默错配:driver=sqlite 却配了 dsn,以及远程驱动没有 dsn。多实例共享状态、初始化 SQL 写法与连接池默认值见 数据库后端。
log
| 值 | 说明 |
|---|---|
| 文件路径 | 默认 ~/.omnigate/omnigate.log |
stdout | 只输出到标准输出 |
stderr | 只输出到标准错误 |
off | 关闭日志 |
日志是 log/slog 结构化格式。调试流式细节可临时打开运行层的调试开关,见 调试模式。