跳到主要内容

配置文件说明

1 功能简介​

MaxKB 的运行参数主要保存在运行目录的 .env。调整服务端口、数据库、Redis、工作流循环上限等,一般改这个文件后重新加载即可。

2 配置文件位置​

默认运行目录为 /opt/maxkb(离线安装,由 MAXKB_BASE=/opt 决定;在线 docker run 常见挂载为 ~/.maxkb)。主要文件如下:

表 1 主要配置文件
文件默认路径说明
.env/opt/maxkb/.env主运行配置
redis.conf/opt/maxkb/conf/redis.conf内置 Redis
postgresql.conf/opt/maxkb/data/postgresql/pgdata/postgresql.conf内置 PostgreSQL
mkctl 适用范围

mkctl 用于离线安装包环境;在线安装、1Panel 安装方式默认不内置该工具。

3 修改与生效​

修改前先备份:

cp /opt/maxkb/.env /opt/maxkb/.env.bak.$(date +%F)
vi /opt/maxkb/.env

保存后重新加载:

mkctl reload
修改后需重新加载

配置不会热更新,须执行 mkctl reload(或等价的容器重建 / 重启)。见 命令行工具。

4 参数说明​

.env 及内置库配置中常见参数如下:

表 2 参数说明
参数名称默认值可选项说明
MAXKB_BASE/opt—安装目录前缀,运行目录为 ${MAXKB_BASE}/maxkb
MAXKB_PORT8080—服务端口
max_connections
(postgresql.conf)
——内置 PostgreSQL 最大连接数;出现 too many clients already 时可调大,见 安装部署 FAQ
其他可调项
  • 暴露内置 PostgreSQL 端口:在 /opt/maxkb/.env 中调整端口映射后执行 mkctl reload,见 安装部署 FAQ。
  • 工作流无限循环上限:默认最大循环 1000 次,可在 .env 中修改后执行 mkctl reload,见 工作流应用。

5 后续操作​