Environment Variables

Some features of Bitwarden are not configured by the bitwarden.sh installer. Configure these settings by editing the environment file, located at ./bwdata/env/global.override.env. This .env file comes pre-baked with configurable variables (see Included variables), however there are additional variables which can be manually added (see Optional variables).

Whenever you make changes toglobal.override.env, perform a./bitwarden.sh restartto apply your changes.



note

The information in this article may not apply to Bitwarden Lite self-hosted deployments.

Included variables

The following variables are among those that already exist in global.override.env:

Variable	Description
`globalSettings__baseServiceUri__vault=`	Enter the domain of your Bitwarden instance. If not configured, domain will default to localhost. Must not include a trailing slash.
`globalSettings__sqlServer__connectionString=`	Use this field to connect to an external MSSQL database.
`globalSettings__oidcIdentityClientKey=`	A randomly generated OpenID Connect client key. For more information, see OpenID Documentation.
`globalSettings__duo__aKey=`	A randomly generated Duo akey. For more information, see Duo's Documentation.
`globalSettings__yubico__clientId=`	Client ID for YubiCloud Validation Service or self-hosted Yubico Validation Server. If YubiCloud, get your client ID and secret key here. If self-hosted, see optional variable `globalSettings__yubico__validationUrls`.
`globalSettings__yubico__key=`	Secret Key for YubiCloud Validation Service or self-hosted Yubico Validation Server. If YubiCloud, get your client ID and secret key here. If self-hosted, see optional variable `globalSettings__yubico__validationUrls`.
`globalSettings__mail__replyToEmail=`	Email address used for invitations, typically `no_reply@smpt__host`.
`globalSettings__mail__smtp__host=`	Your SMTP server hostname (recommended) or IP address.
`globalSettings__mail__smtp__port=`	The SMTP port used by the SMTP server.
`globalSettings__mail__smtp__ssl=`	(Boolean) Whether your SMTP server uses an encryption protocol: `true` = SSL `false` = TLS
`globalSettings__mail__smtp__username=`	A valid username for the `smtp__host`.
`globalSettings__mail__smtp__password=`	A valid password for the `smtp__host`. Dollar sign `$` characters are not supported in SMTP passwords.
`globalSettings__disableUserRegistration=`	Specify `true` to disable new users signing up for an account on this instance via the registration page.
`globalSettings__hibpApiKey=`	Your HaveIBeenPwned (HIBP) API Key, available here. This key allows users to run the Data Breach report and to check their master password for presence in breaches when they create an account.
`adminSettings__admins=`	Email addresses which may access the System Administrator Portal.

Optional variables

The following variables do not already exist in global.override.env, and can be manually added:

Variable