环境变量

bitwarden.sh 安装程序无法配置 Bitwarden 的某些功能,需要通过编辑环境文件(./bwdata/env/global.override.env)来配置这些设置。global.override.env 中预置了一些可配置的变量(参阅已有变量),还有一些额外的变量可以手动添加(参阅可选变量)。

每当您对 global.override.env 做了修改后,请执行 ./bitwarden.sh rebuild 以应用您的更改。

本文不会定义每一个环境变量,而是重点介绍大多数安装所使用或配置的环境变量。

已有变量

以下变量是 global.override.env 中已经存在的变量:

变量
描述

globalSettings__baseServiceUri__vault=

输入 Bitwarden 实例的域名。如果未配置,域名将默认为 localhost。不得包含尾部斜线。

globalSettings__sqlServer__connectionString=

globalSettings__oidcIdentityClientKey=

随机生成的 OpenID Connect 客户端密钥。更多信息,请参阅 OpenID 文档

globalSettings__duo__aKey=

随机生成的 Duo 密钥。更多信息,请参阅 Duo 文档

globalSettings__yubico__clientId=

YubiCloud 验证服务或自托管的 Yubico 验证服务器的客户端 ID。

如果是 YubiCloud,请在此处获取您的客户端 ID 和安全密钥。

如果是自托管 Yubico 验证服务器,请参阅可选变量 globalSettings__yubico__validationUrls

globalSettings__yubico__key=

YubiCloud 验证服务或自托管的 Yubico 验证服务器的安全密钥。

如果是 YubiCloud,请在此处获取您的客户端 ID 和安全密钥。

如果是自托管 Yubico 验证服务器,请参阅可选变量 globalSettings__yubico__validationUrls

globalSettings__mail__replyToEmail=

用于邀请的电子邮件地址,通常为 no_reply@smpt__host

globalSettings__mail__smtp__host=

您的 SMTP 服务器的主机名(建议)或 IP 地址。

globalSettings__mail__smtp__port=

SMTP 服务器使用的 SMTP 端口。

globalSettings__mail__smtp__ssl=

(布尔值)您的 SMTP 服务器是否使用加密协议: true = SSL false = TLS

globalSettings__mail__smtp__username=

smtp__host 的有效用户名。

globalSettings__mail__smtp__password=

smtp__host 的有效密码。

globalSettings__disableUserRegistration=

指定为 true 将禁用新用户通过注册页面在此实例上注册账户。

globalSettings__hibpApiKey=

您的 HaveIBeenPwned (HIBP) API 密钥,可在此处获取。该密钥允许用户运行数据泄露报告,并在创建账户时检查其主密码是否存在泄露。

adminSettings__admins=

可以访问系统管理员门户的电子邮件地址。

可选变量

以下变量在 global.override.env 中尚不存在,但可以手动添加:

变量
描述

globalSettings__logDirectory=

指定日志文件的保存目录。默认为 globalSettings__logDirectory=bwdata/logs

globalSettings__logRollBySizeLimit=

指定用于滚动日志文件的大小限制,以字节为单位(例如 globalSettings__logRollBySizeLimit=1073741824)。

globalSettings__syslog__destination=

指定要将日志文件发送到的 Syslog 服务器或端点(例如 globalSettings__syslog__destination=udp://example.com:514)。

globalSettings__mail__smtp__trustServer=

指定为 true 将以显式信任 SMTP 服务器提供的证书(不建议用于生产中)。

globalSettings__mail__smtp__sslOverride=

指定为 true 将在端口 25 上使用 SSL(而不是 TLS)。

globalSettings__mail__smtp__startTls=

指定为 true 将强制 STARTTLS(随机 TLS)。

globalSettings__organizationInviteExpirationHours=

指定组织邀请到期的小时数。默认为 120 小时。

globalSettings__yubico__validationUrls__0=

自托管 Yubico 验证服务器的主要地址。例如:globalSettings__yubico__validationUrls__0=https://your.url.com/wsapi/2.0/verify

通过创建递增的环境变量来添加其他验证服务器 URL,例如: globalSettings__yubico__validationUrls__1=globalSettings__yubico__validationUrls__2=

globalSettings__enableCloudCommunication=

设置为 true 以允许您的服务器和我们的云系统之间进行通信。目前仅适用于企业版家庭赞助

adminSettings__deleteTrashDaysAgo=

指定多少天后从回收站永久删除项目。默认为 30 天。

globalSettings__sso__enforceSsoPolicyForAllUsers=

指定为 true 以对所有者和管理员角色强制执行需要 SSO 身份验证策略。

globalSettings__baseServiceUri__cloudRegion=

指定为 USEU,以指定自托管服务器应超链接到哪个云端服务器。

如果使用 EU 服务器,还需要设置其他一些变量,如此处所述。

globalSettings__sqlServer__DisableDatabaseMaintenanceJobs=

指定为 true 可跳过数据库中统计和索引重建任务的应用程序端维护。

这些任务需要提升的 MSSQL 权限,如果该值设为 true,则应重新配置为以数据库用户身份运行。了解更多

globalSettings__sqlServer__SkipDatabasePreparation=

指定为 true 可跳过应用程序端数据库准备。如果不指定,数据库准备将在安装时检查 globalSettings__sqlServer__connectionString= 中指定名称的数据库是否存在,如果不存在,则创建一个。

这项任务需要提升的 MSSQL 权限,如果该值设置为 true,则在开始安装之前,指定的数据库必须存在。了解更多

最后更新于