-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Configuration overview
In bitwarden_rs, you can perform configuration either via environment variables or an admin page (which writes settings to a config.json
file under your data directory). It's important to note that each setting in config.json
overrides the corresponding environment variable setting (if it exists). For example, if you set the environment variable DOMAIN=https://bitwarden.example.com
, but your config.json
includes "domain": "https://bw.example.com"
, then bitwarden_rs will generate various links based on what's in the config file (https://bw.example.com
).
A common source of confusion is enabling the admin page (which creates the config.json
file), changing some settings via the admin page (which sets the corresponding values in config.json
), then later trying to change those settings via environment variable (which doesn't work because config.json
overrides env vars). To avoid this confusion, it's highly recommended to stick to one configuration method or the other; that is, configure entirely via environment variables, or entirely via config.json
(whether using the admin page or editing config.json
directly).
Make sure to set the DOMAIN
environment variable (or domain
in the config file) properly. If you don't, it's likely that various functionality will break mysteriously. Some examples:
https://bitwarden.example.com
-
https://bitwarden.example.com:8443
(non-default port) -
https://host.example.com/bitwarden
(subdir hosting -- avoid URL-rewriting tricks whenever possible)
- Which container image to use
- Starting a container
- Updating the vaultwarden image
- Using Docker Compose
- Using Podman
- Building your own docker image
- Building binary
- Pre-built binaries
- Third-party packages
- Deployment examples
- Proxy examples
- Logrotate example
- Overview
- Disable registration of new users
- Disable invitations
- Enabling admin page
- Disable the admin token
- Enabling WebSocket notifications
- Enabling Mobile Client push notification
- Enabling U2F and FIDO2 WebAuthn authentication
- Enabling YubiKey OTP authentication
- Changing persistent data location
- Changing the API request size limit
- Changing the number of workers
- SMTP configuration
- Translating the email templates
- Customize Vaultwarden CSS
- Password hint display
- Disabling or overriding the Vault interface hosting
- Logging
- Creating a systemd service
- Syncing users from LDAP
- Using an alternate base dir (subdir/subpath)
- Other configuration