2018-06-12 21:09:42 +02:00
## Bitwarden_RS Configuration File
## Uncomment any of the following lines to change the defaults
2020-09-12 21:47:24 +02:00
##
## Be aware that most of these settings will be overridden if they were changed
2020-08-13 17:49:25 +02:00
## in the admin interface. Those overrides are stored within DATA_FOLDER/config.json .
2018-06-12 21:09:42 +02:00
## Main data folder
# DATA_FOLDER=data
2019-06-02 13:44:59 +02:00
## Database URL
## When using SQLite, this is the path to the DB file, default to %DATA_FOLDER%/db.sqlite3
2018-02-10 01:00:55 +01:00
# DATABASE_URL=data/db.sqlite3
2020-08-13 11:33:22 +02:00
## When using MySQL, specify an appropriate connection URI.
## Details: https://docs.diesel.rs/diesel/mysql/struct.MysqlConnection.html
# DATABASE_URL=mysql://user:password@host[:port]/database_name
## When using PostgreSQL, specify an appropriate connection URI (recommended)
## or keyword/value connection string.
## Details:
## - https://docs.diesel.rs/diesel/pg/struct.PgConnection.html
## - https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING
# DATABASE_URL=postgresql://user:password@host[:port]/database_name
2019-06-02 13:44:59 +02:00
## Individual folders, these override %DATA_FOLDER%
2018-06-12 21:09:42 +02:00
# RSA_KEY_FILENAME=data/rsa_key
2018-02-10 01:00:55 +01:00
# ICON_CACHE_FOLDER=data/icon_cache
# ATTACHMENTS_FOLDER=data/attachments
2019-01-13 01:39:29 +01:00
## Templates data folder, by default uses embedded templates
## Check source code to see the format
# TEMPLATES_FOLDER=/path/to/templates
2019-01-20 17:43:56 +01:00
## Automatically reload the templates for every request, slow, use only for development
# RELOAD_TEMPLATES=false
2019-01-13 01:39:29 +01:00
2019-12-27 18:42:39 +01:00
## Client IP Header, used to identify the IP of the client, defaults to "X-Client-IP"
## Set to the string "none" (without quotes), to disable any headers and just use the remote IP
# IP_HEADER=X-Client-IP
2018-12-18 22:33:31 +01:00
## Cache time-to-live for successfully obtained icons, in seconds (0 is "forever")
# ICON_CACHE_TTL=2592000
## Cache time-to-live for icons which weren't available, in seconds (0 is "forever")
# ICON_CACHE_NEGTTL=259200
2018-06-12 21:09:42 +02:00
## Web vault settings
# WEB_VAULT_FOLDER=web-vault/
# WEB_VAULT_ENABLED=true
2019-01-15 15:28:25 +01:00
## Enables websocket notifications
# WEBSOCKET_ENABLED=false
2018-09-28 13:46:13 +02:00
## Controls the WebSocket server address and port
# WEBSOCKET_ADDRESS=0.0.0.0
2018-09-13 20:59:51 +02:00
# WEBSOCKET_PORT=3012
2019-12-06 22:19:07 +01:00
## Enable extended logging, which shows timestamps and targets in the logs
2018-12-06 20:35:25 +01:00
# EXTENDED_LOGGING=true
2020-07-23 06:50:49 +02:00
## Timestamp format used in extended logging.
## Format specifiers: https://docs.rs/chrono/latest/chrono/format/strftime
2020-07-23 23:19:51 +02:00
# LOG_TIMESTAMP_FORMAT="%Y-%m-%d %H:%M:%S.%3f"
2020-07-23 06:50:49 +02:00
2018-12-06 20:35:25 +01:00
## Logging to file
## It's recommended to also set 'ROCKET_CLI_COLORS=off'
# LOG_FILE=/path/to/log
2019-04-27 20:14:37 +02:00
## Logging to Syslog
## This requires extended logging
## It's recommended to also set 'ROCKET_CLI_COLORS=off'
# USE_SYSLOG=false
2019-03-25 14:12:41 +01:00
## Log level
## Change the verbosity of the log output
## Valid values are "trace", "debug", "info", "warn", "error" and "off"
2020-09-12 21:47:24 +02:00
## Setting it to "trace" or "debug" would also show logs for mounted
2019-12-06 22:19:07 +01:00
## routes and static file, websocket and alive requests
2019-03-25 14:12:41 +01:00
# LOG_LEVEL=Info
2019-02-18 15:57:21 +01:00
## Enable WAL for the DB
## Set to false to avoid enabling WAL during startup.
## Note that if the DB already has WAL enabled, you will also need to disable WAL in the DB,
## this setting only prevents bitwarden_rs from automatically enabling it on start.
## Please read project wiki page about this setting first before changing the value as it can
## cause performance degradation or might render the service unable to start.
# ENABLE_DB_WAL=true
2019-01-28 23:58:32 +01:00
## Disable icon downloading
## Set to true to disable icon downloading, this would still serve icons from $ICON_CACHE_FOLDER,
## but it won't produce any external network request. Needs to set $ICON_CACHE_TTL to 0,
## otherwise it will delete them and they won't be downloaded again.
# DISABLE_ICON_DOWNLOAD=false
2019-02-12 21:56:28 +01:00
## Icon download timeout
## Configure the timeout value when downloading the favicons.
## The default is 10 seconds, but this could be to low on slower network connections
# ICON_DOWNLOAD_TIMEOUT=10
2019-03-18 22:12:39 +01:00
## Icon blacklist Regex
## Any domains or IPs that match this regex won't be fetched by the icon service.
## Useful to hide other servers in the local network. Check the WIKI for more details
# ICON_BLACKLIST_REGEX=192\.168\.1\.[0-9].*^
2019-10-08 13:30:17 +02:00
## Any IP which is not defined as a global IP will be blacklisted.
## Usefull to secure your internal environment: See https://en.wikipedia.org/wiki/Reserved_IP_addresses for a list of IPs which it will block
# ICON_BLACKLIST_NON_GLOBAL_IPS=true
2019-03-18 22:12:39 +01:00
## Disable 2FA remember
## Enabling this would force the users to use a second factor to login every time.
## Note that the checkbox would still be present, but ignored.
# DISABLE_2FA_REMEMBER=false
2018-12-18 18:52:58 +01:00
## Controls if new users can register
# SIGNUPS_ALLOWED=true
2019-11-25 06:28:49 +01:00
## Controls if new users need to verify their email address upon registration
## Note that setting this option to true prevents logins until the email address has been verified!
## The welcome email will include a verification link, and login attempts will periodically
## trigger another verification email to be sent.
# SIGNUPS_VERIFY=false
## If SIGNUPS_VERIFY is set to true, this limits how many seconds after the last time
## an email verification link has been sent another verification email will be sent
# SIGNUPS_VERIFY_RESEND_TIME=3600
## If SIGNUPS_VERIFY is set to true, this limits how many times an email verification
## email will be re-sent upon an attempted login.
# SIGNUPS_VERIFY_RESEND_LIMIT=6
2019-11-16 23:01:45 +01:00
## Controls if new users from a list of comma-separated domains can register
## even if SIGNUPS_ALLOWED is set to false
# SIGNUPS_DOMAINS_WHITELIST=example.com,example.net,example.org
2020-08-06 07:35:29 +02:00
## Controls which users can create new orgs.
## Blank or 'all' means all users can create orgs (this is the default):
# ORG_CREATION_USERS=
## 'none' means no users can create orgs:
# ORG_CREATION_USERS=none
## A comma-separated list means only those users can create orgs:
# ORG_CREATION_USERS=admin1@example.com,admin2@example.com
2018-12-18 18:52:58 +01:00
## Token for the admin interface, preferably use a long random string
## One option is to use 'openssl rand -base64 48'
## If not set, the admin panel is disabled
# ADMIN_TOKEN=Vy2VyYTTsKPv8W5aEOWUbB/Bt3DEKePbHmI4m9VcemUMS2rEviDowNAFqYi1xjmp
2019-10-08 19:33:27 +02:00
## Enable this to bypass the admin panel security. This option is only
## meant to be used with the use of a separate auth layer in front
2019-02-20 21:44:35 +01:00
# DISABLE_ADMIN_TOKEN=false
2018-12-18 18:52:58 +01:00
## Invitations org admins to invite users, even when signups are disabled
# INVITATIONS_ALLOWED=true
2018-06-12 21:09:42 +02:00
## Controls the PBBKDF password iterations to apply on the server
## The change only applies when the password is changed
# PASSWORD_ITERATIONS=100000
2018-02-10 01:00:55 +01:00
2018-08-10 15:21:42 +02:00
## Whether password hint should be sent into the error response when the client request it
# SHOW_PASSWORD_HINT=true
2018-07-12 23:28:01 +02:00
## Domain settings
## The domain must match the address from where you access the server
2019-02-08 19:21:48 +01:00
## It's recommended to configure this value, otherwise certain functionality might not work,
## like attachment downloads, email links and U2F.
2018-07-12 23:28:01 +02:00
## For U2F to work, the server must use HTTPS, you can use Let's Encrypt for free certs
# DOMAIN=https://bw.domain.tld:8443
2018-11-16 02:40:27 +01:00
## Yubico (Yubikey) Settings
## Set your Client ID and Secret Key for Yubikey OTP
## You can generate it here: https://upgrade.yubico.com/getapikey/
2018-11-16 02:54:53 +01:00
## You can optionally specify a custom OTP server
2018-11-16 02:40:27 +01:00
# YUBICO_CLIENT_ID=11111
# YUBICO_SECRET_KEY=AAAAAAAAAAAAAAAAAAAAAAAA
2018-11-16 02:54:53 +01:00
# YUBICO_SERVER=http://yourdomain.com/wsapi/2.0/verify
2018-11-16 02:40:27 +01:00
2019-04-07 18:58:15 +02:00
## Duo Settings
2019-04-27 20:14:37 +02:00
## You need to configure all options to enable global Duo support, otherwise users would need to configure it themselves
2019-04-07 18:58:15 +02:00
## Create an account and protect an application as mentioned in this link (only the first step, not the rest):
## https://help.bitwarden.com/article/setup-two-step-login-duo/#create-a-duo-security-account
## Then set the following options, based on the values obtained from the last step:
# DUO_IKEY=<Integration Key>
# DUO_SKEY=<Secret Key>
# DUO_HOST=<API Hostname>
## After that, you should be able to follow the rest of the guide linked above,
## ignoring the fields that ask for the values that you already configured beforehand.
2019-11-07 17:11:29 +01:00
## Authenticator Settings
## Disable authenticator time drifted codes to be valid.
## TOTP codes of the previous and next 30 seconds will be invalid
2020-09-12 21:47:24 +02:00
##
2019-11-07 17:11:29 +01:00
## According to the RFC6238 (https://tools.ietf.org/html/rfc6238),
## we allow by default the TOTP code which was valid one step back and one in the future.
## This can however allow attackers to be a bit more lucky with there attempts because there are 3 valid codes.
## You can disable this, so that only the current TOTP Code is allowed.
## Keep in mind that when a sever drifts out of time, valid codes could be marked as invalid.
## In any case, if a code has been used it can not be used again, also codes which predates it will be invalid.
# AUTHENTICATOR_DISABLE_TIME_DRIFT = false
2018-06-12 21:09:42 +02:00
## Rocket specific settings, check Rocket documentation to learn more
# ROCKET_ENV=staging
2018-02-10 01:00:55 +01:00
# ROCKET_ADDRESS=0.0.0.0 # Enable this to test mobile app
# ROCKET_PORT=8000
# ROCKET_TLS={certs="/path/to/certs.pem",key="/path/to/key.pem"}
2018-08-15 08:32:19 +02:00
2018-09-13 20:59:51 +02:00
## Mail specific settings, set SMTP_HOST and SMTP_FROM to enable the mail service.
2019-02-08 19:21:48 +01:00
## To make sure the email links are pointing to the correct host, set the DOMAIN variable.
2018-09-13 20:59:51 +02:00
## Note: if SMTP_USERNAME is specified, SMTP_PASSWORD is mandatory
2018-08-15 08:32:19 +02:00
# SMTP_HOST=smtp.domain.tld
2018-09-13 20:59:51 +02:00
# SMTP_FROM=bitwarden-rs@domain.tld
2019-01-13 15:24:46 +01:00
# SMTP_FROM_NAME=Bitwarden_RS
2018-08-15 08:32:19 +02:00
# SMTP_PORT=587
2020-09-19 17:09:58 +02:00
# SMTP_SSL=true # (Explicit) - This variable by default configures Explicit STARTTLS, it will upgrade an insecure connection to a secure one. Unless SMTP_EXPLICIT_TLS is set to true.
# SMTP_EXPLICIT_TLS=true # (Implicit) - N.B. This variable configures Implicit TLS. It's currently mislabelled (see bug #851) - SMTP_SSL Needs to be set to true for this option to work.
2018-08-15 08:32:19 +02:00
# SMTP_USERNAME=username
2019-02-20 21:44:35 +01:00
# SMTP_PASSWORD=password
2020-09-12 21:47:24 +02:00
## Defaults for SSL is "Plain" and "Login" and nothing for Non-SSL connections.
## Possible values: ["Plain", "Login", "Xoauth2"].
## Multiple options need to be separated by a comma ','.
2019-08-24 01:22:14 +02:00
# SMTP_AUTH_MECHANISM="Plain"
2019-11-06 21:39:33 +01:00
# SMTP_TIMEOUT=15
2019-11-11 11:19:58 +01:00
# vim: syntax=ini