配置文件
免责声明
本文档可能已过时、不完整或存在错误。请参阅您安装目录中的 默认 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
# 或
npm run start -- --port 8000 --listen false
# 或(仅限 Windows)
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 Tunnel)使用基本身份验证,请务必相应地调整
SSO 自动登录
不当保护 SSO 流程可能导致未授权访问。在启用 SSO 之前,请确保正确配置可信代理并测试您的设置。如果不确定安全影响,建议保持 SSO 自动登录禁用,并使用其他身份验证方法。
速率限制配置
要禁用特定路由的速率限制,请将限制设置为 0。
例如,要禁用登录速率限制,请将 rateLimiting.accountsLoginMaxAttempts 设置为 0。
请求代理配置
请求代理与私有地址白名单功能存在冲突。如果同时启用两者,只有绕过代理的请求会被私有地址白名单检查,而经过代理的请求将不会被检查。如有疑虑,建议禁用请求代理。
CORS 代理配置
某些扩展可能需要启用 CORS 代理。内置功能不需要此功能。
在没有适当安全措施(例如 IP、主机和私有地址白名单)的情况下启用 CORS 代理可能导致 SSRF 漏洞。如果启用此功能,请确保相应地配置白名单,并且只在信任需要此功能的扩展时才启用它。
CORS 配置
浏览器启动配置
以前称为"自动运行"设置。
性能配置
缓存清除配置
需要 localhost 或带有 HTTPS 的域名,否则将无法工作!
缩略图配置
备份配置
扩展配置
服务器插件
Git 配置
Git 后端说明
auto- 优先使用系统二进制文件,回退到内置引擎system- 使用 simple-git 的系统 git 二进制文件builtin- 使用 isomorphic-git 的内置引擎
API 集成设置
OpenAI 配置
MistralAI 配置
Ollama 配置
Claude 配置
重要!
请谨慎使用,仅在提示词前缀在请求之间保持不变时使用。\{\{random\}\} 宏、知识书、向量、摘要等可能会使缓存失效,导致您浪费缓存未命中的费用。提供商可能对缓存有最低提示词大小要求。行为可能不可预测,不提供任何保证,请查阅 API 文档。
参见:提示词缓存