第18章 NodeBB 配置文件 config. 详解
NodeBB 配置文件(config.json)
NodeBB 的大部分配置通过管理员控制面板(ACP)进行管理,而少数与服务器相关的选项则定义在位于 NodeBB 根目录下的 config.json 文件中。对 config.json 的任何修改都需要重启 NodeBB。其中部分值由安装脚本保存:
url 是指向 NodeBB 的完整 Web 访问地址。如果没有域名,IP 地址也可以正常工作(例如 http://127.0.0.1:4567)。子目录安装也在此定义其路径(例如 http://127.0.0.1:4567/forum)。如果将 url 更改为子文件夹,需要执行 ./nodebb build 重新构建 NodeBB。
secret 是用于对 Cookie 会话进行哈希处理的字符串。如果更改了 secret,所有现有会话将失效,用户需要重新登录。
database 定义 NodeBB 使用的主数据库(例如 redis、mongo 或 postgres),更多信息请参阅
redis、mongo 和 postgres 是包含数据库连接信息的对象,其中包含以下部分或全部字段: host port uri(仅 MongoDB 连接字符串) username(仅 MongoDB) password database
以下值为可选,用于覆盖 NodeBB 的默认设置:
bcrypt_rounds(默认:12)指定密码哈希的轮数。性能较低的机器可能会选择减少轮数以加快登录速度,但更建议随着计算能力的提升而增加轮数,以提高抵御密码破解的强度。
bind_address(默认:0.0.0.0,即所有接口)指定 NodeBB 应绑定的本地地址。默认情况下,NodeBB 监听所有接口的请求,但设置后仅接受来自指定接口的连接。
trust_proxy(默认:false)启用 Express 对 req.ip 及相关值的代理信任处理。仅在 NodeBB 位于会剥离或覆盖不可信 X-Forwarded-For 头的反向代理之后时才将其设为 true。如果未设置,NodeBB 不会信任转发的客户端 IP 头。详见 expressjs 文档 https://expressjs.com/en/5x/guide/behind-proxies/
isCluster 如果在多台机器上各运行单个 NodeBB 进程,请将其设为 true。如果在单台或多台机器上运行多个 NodeBB 进程,则无需此设置。
jobsDisabled 可添加此选项以禁用定时任务。例如,"jobsDisabled":true 将禁用每日摘要邮件和通知清理。这对于运行多个 NodeBB 后端以进行扩展的安装很有用。在此类配置中,应只有一个后端处理任务,其他后端将 jobsDisabled 设为 true。
acpPluginInstallDisabled 设为 true 可禁止通过 ACP 安装插件。启用后,只能通过 ./nodebb install 或直接通过 npm 安装插件。
logFile(默认:logs/output.log)指定日志文件的存储路径(相对于 NodeBB 根安装目录)。如果路径不存在,将被创建。当前日志文件超过 1 MB 时,日志会轮转到同一目录,最多保留 3 个归档文件。
port(默认:4567)指定 NodeBB 绑定的端口号。可以指定端口数组,NodeBB 将启动 port.length 个进程。如果使用多个端口,需配置负载均衡器将请求代理到不同端口。
max-memory 指定 NodeBB 进程可使用的最大内存(单位:兆字节)。
package_manager 指定 NodeBB 调用的包管理器。如果未设置,将回退到锁定文件检测(若无锁定文件,则使用 npm)。
sessionKey(默认:express.sid)指定会话键。
session_store 类似 redis、mongo 或 postgres 块的对象,用于定义会话数据库。例如,将其设置为不同的 redis 实例,可以将数据和会话分离到两个不同的 redis 实例中。
name(使用的数据库名称,redis、mongo 或 postgres) 其他设置与数据存储的数据库块相同。
socket.io 包含 socket.io 设置的哈希对象: transports(默认:["polling", "websocket"])用于配置 socket.io 传输方式。 address(默认:"")socket.io 服务器地址,可以为空。 origins(默认:config.json 中 url 的所有端口)为 socket.io 连接定义不同的 URL,格式为 domain.tld:port(例如 example.org:*)。如果需要多个 origins,请用逗号分隔(例如 https://example.org:*,https://example.net:*)。
upload_path(默认:/public/uploads)指定上传文件的存储路径(相对于 NodeBB 根安装目录)。
fontawesome 定义 NodeBB 使用的图标库 FontAwesome 的附加设置对象。 pro 如果需要使用付费的 FontAwesome Pro 图标,请设为 true。注意,NodeBB 使用前需自行安装 FontAwesome Pro 包。可遵循 https://fontawesome.com/docs/web/setup/packages 的说明进行安装。 styles(默认:"*")指定 NodeBB 允许使用的图标样式。"*" 表示使用所有支持的样式,当前若 fontawesome:pro 为 false,则为 ["solid", "brands", "regular"],否则为 ["solid", "brands", "regular", "light", "thin", "duotone", "sharp"]。
plugins:active 活动插件数组 ["nodebb-plugin-mentions", "nodebb-plugin-markdown"],如果设置了此数组,将使用它而不是从数据库读取活动插件。
ssl 包含安全套接层选项的对象。如果存在此属性,NodeBB 将使用安全的 https 服务器: key 私有密钥文件的路径。 cert 公共证书文件的路径。