环境配置文件
环境配置文件用于在 Bitwarden 部署完成以后增减某些功能,如配置 SMTP、启用 Yubico、启用系统管理员门户、禁用用户注册等。
环境配置文件位置:./bwdata/env/global.override.env
。
其默认内容如下:
由于环境配置文件只有在 Bitwarden 容器启动时才会被读取,因此,更改环境配置文件后,需要运行 restart
(重启)命令以使更改生效:
注意环境配置文件中值为 https://vault.yourdomain.com
的所有变量,需要全部修改其值为实际的外部访问地址(包括端口),否则当有链接跳转时,会导致错误,例如验证电子邮件的跳转链接、管理员门户的跳转链接。假设外部访问地址为 https://vault.yourdomain.com:28443
,则环境配置文件中值为 https://vault.yourdomain.com
的所有变量的值都要替换为 https://vault.yourdomain.com:28443
。
已有变量
以下变量在 global.override.env
中已经存在:
变量 | 描述 |
---|---|
globalSettings__sqlServer__connectionString= | 使用此字段连接到外部 MSSQL 数据库。 |
globalSettings__oidcIdentityClientKey= | 随机生成的 OpenID Connect 客户端密钥。有关更多信息,请参阅 OpenID 文档。 |
globalSettings__duo__aKey= | 随机生成的 Duo 密钥。有关更多信息,请参阅 Duo 文档。 |
globalSettings__yubico__clientId= | YubiCloud 验证服务或自托管的 Yubico 验证服务器的客户端 ID。如果是 YubiCloud,请在此处获取您的客户端 ID 和安全密钥。如果是自托管,请参阅可选变量 |
globalSettings__yubico__key= | YubiCloud 验证服务或自托管的 Yubico 验证服务器的安全密钥。如果是 YubiCloud,请在此处获取您的客户端 ID 和安全密钥。如果是自托管,请参阅可选变量 |
globalSettings__mail__replyToEmail= | 用于邀请的电子邮件地址,通常为 |
globalSettings__mail__smtp__host= | SMTP 服务器的主机名(建议)或 IP 地址。 |
globalSettings__mail__smtp__port= | SMTP 服务器使用的 SMTP 端口。 |
globalSettings__mail__smtp__ssl= | (布尔值)SMTP 服务器是否使用加密协议:
|
globalSettings__mail__smtp__username= |
|
globalSettings__mail__smtp__password= |
|
globalSettings__disableUserRegistration= | 指定为 |
globalSettings__hibpApiKey= | 您的 HaveIBeenPwned (HIBP) API 密钥,参阅此处。 |
adminSettings__admins= | 用于访问系统管理员门户的电子邮件地址。 |
可选变量
以下变量在 global.override.env
中尚不存在,但可以手动添加:
变量 | 描述 |
---|---|
globalSettings__logDirectory= | 指定日志文件的保存目录。默认为 |
globalSettings__logRollBySizeLimit= | 开启滚动日志并指定滚动日志文件的大小限制,以字节为单位(例如开启并设置为 1GB |
globalSettings__syslog__destination= | 指定要将日志文件发送到的 Syslog 服务器或端点(例如 |
globalSettings__mail__smtp__trustServer= | 指定为 |
globalSettings__mail__smtp__sslOverride= | 指定为 |
globalSettings__mail__smtp__startTls= | 指定为 |
globalSettings__organizationInviteExpirationHours= | 指定组织邀请到期的小时数。默认为 |
globalSettings__yubico__validationUrls__0= | 自托管 Yubico 验证服务器的主要地址。例如: 通过创建递增的环境变量来添加其他验证服务器 URL,例如: |
adminSettings__deleteTrashDaysAgo= | 指定多少天后从回收站永久删除项目。默认为 |
最后更新于