配置文件
免责声明
本文档可能已过时、不完整或不准确。请参阅你安装中附带的默认 config.yaml 以获取最新、最完整的设置列表。
警告:请勿直接编辑默认配置。这样做不会产生任何正面效果。请改为编辑仓库根目录中它的副本。
config.yaml 是 SillyTavern 服务器的主配置文件,在完成安装并首次运行服务器后,你可以在仓库根目录找到它。它是一个 YAML 文件,包含网络、安全以及后端相关的各种设置。对该文件所做的更改将在重启服务器后生效。
在更新仓库后重启服务器时,上游新增的设置会自动填充默认值,随后你可以按需修改这些设置。若想在启动前补全缺失的设置,请运行 npm run init 脚本。
对于嵌套设置,使用点号表示法来表示层级关系。例如,protocol.ipv6: false 指的是 protocol 节下的 ipv6 设置,其值为 false。
protocol:
ipv6: false
命令行参数
启动 SillyTavern 服务器时可以传入命令行参数,以覆盖 config.yaml 中的部分设置。
示例
node server.js --port 8000 --listen false
# or
npm run start -- --port 8000 --listen false
# or (Windows only)
Start.bat --port 8000 --listen false
支持的参数
所有参数都不是必填的。如果你不提供它们,SillyTavern 将使用 config.yaml 中的设置。
环境变量
配置也可以通过环境变量来设置,环境变量会覆盖 config.yaml 文件中的值。
环境变量应以 SILLYTAVERN_ 为前缀,并且设置名使用大写字母。例如,dataRoot 设置可以通过 SILLYTAVERN_DATAROOT 环境变量来覆盖。
嵌套设置之间应使用下划线分隔。例如,protocol.ipv6 可以通过 SILLYTAVERN_PROTOCOL_IPV6 环境变量来覆盖。
期望接收数组或对象的配置应进行 JSON 序列化。例如,要通过 SILLYTAVERN_WHITELIST 环境变量覆盖 whitelist 设置,你应将其设为 JSON 字符串:SILLYTAVERN_WHITELIST='["127.0.0.1", "::1"]'。
如果你使用 Node.js v20 或更高版本,你也可以将环境变量存储在 .env 文件中,并通过 --env-file 标志将其传递给服务器。例如,要使用位于仓库根目录的 .env 文件,你可以使用以下命令启动服务器:
node --env-file=.env server.js
或者,直接通过命令行传递环境变量:
SILLYTAVERN_LISTEN=true SILLYTAVERN_PORT=8000 node server.js
有关使用环境变量的更多信息,请参阅 Node.js 文档。
数据配置
日志配置
网络配置
SSL 配置
安全配置
IP 白名单
转发头配置
调整用于确定真实 IP 的头信息,以支持 IP 白名单、速率限制和访问日志等功能。
仅在你确定使用的是正确配置的反向代理时才进行更改,否则可能导致 IP 欺骗。
私有地址白名单
这是一层额外的安全防护,用于防范服务器端请求伪造(SSRF)攻击,会对解析为私有 IP 地址的服务器端 HTTP 请求执行白名单检查。启用后,私有网络范围将被阻止,除非在 privateAddressWhitelist.allowedRanges 设置中显式允许。
该功能默认禁用,但在启用监听模式时,或当你的服务器可被不受信任的用户访问时,推荐启用。
主机白名单
安全覆盖
强烈不建议禁用安全措施。在做出更改之前,请确保你清楚自己在做什么。
用户认证
默认对基础认证和用户账户登录尝试都启用了速率限制。你可以在
如果在隧道连接(例如 Cloudflare 隧道)后使用基础认证,请务必相应地调整
SSO 自动登录
SSO 流程的安全配置不当可能导致未授权访问。请务必正确配置可信代理,并在启用 SSO 之前测试你的设置。如果你不确定其安全影响,建议保持 SSO 自动登录处于禁用状态,改用其他身份验证方式。
速率限制配置
要禁用某个路由的速率限制,请将限制值设为 0。
例如,要禁用登录的速率限制,请将 rateLimiting.accountsLoginMaxAttempts 设为 0。
请求代理配置
请求代理与私有地址白名单功能冲突。如果同时启用两者,只有绕过代理的请求会接受私有地址白名单检查,而经代理的请求则完全不会被检查。如不确定,建议禁用请求代理。
CORS 代理配置
某些扩展可能需要启用 CORS 代理。任何内置功能都不需要它。
在没有适当安全措施(例如 IP、主机和私有地址白名单)的情况下启用 CORS 代理可能导致 SSRF 漏洞。如果启用此功能,请务必相应地配置白名单,并且仅在你信任需要它的扩展时才启用。
CORS 配置
浏览器启动配置
此前称为 "Autorun" 设置。
性能配置
缓存清理配置
需要 localhost 或启用了 HTTPS 的域名,否则不会生效!
缩略图配置
备份配置
扩展配置
服务器插件
Git 配置
Git 后端说明
auto- 优先使用系统二进制程序,失败时回退到内置引擎system- 使用 simple-git 的系统 git 二进制程序builtin- 使用 isomorphic-git 的内置引擎
API 集成设置
OpenAI 配置
MistralAI 配置
Ollama 配置
Claude 配置
重要提示!
请谨慎使用,并且仅在提示词前缀是静态的、不会在请求之间变化时使用。{{random}} 宏、世界书、向量、摘要等很可能会使缓存失效,结果只是把钱浪费在缓存未命中上。服务商可能对缓存有最小提示词大小的要求。其行为可能不可预测,无法提供任何保证,请查阅 API 文档。
参见:提示词缓存