-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Using the PostgreSQL Backend
To use the PostgreSQL backend, you can either use the official Docker image or build your own binary with PostgreSQL enabled.
To run the binary or container ensure the DATABASE_URL
environment variable is set (i.e. DATABASE_URL='postgresql://<user>:<password>@postgresql/bitwarden'
)
Connection String Syntax:
DATABASE_URL=postgresql://[[user]:[password]@]host[:port][/database]
An example docker run environment variable would be: -e 'DATABASE_URL=postgresql://postgresadmin:strongpassword@postgres:5432/vaultwarden'
.
If your password contains special characters, you will need to use percentage encoding.
! | # | $ | % | & | ' | ( | ) | * | + | , | / | : | ; | = | ? | @ | [ | ] |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
%21 | %23 | %24 | %25 | %26 | %27 | %28 | %29 | %2A | %2B | %2C | %2F | %3A | %3B | %3D | %3F | %40 | %5B | %5D |
A complete list of codes can be found on Wikipedia page for percent encoding
Migrating from SQLite to PostgreSQL
An easy way of migrating from SQLite to PostgreSQL or to MySQL exists, but please, note that you are using this at your own risk and you are strongly advised to backup your installation and data!. This is unsupported and has not been robustly tested.
- Create an new (empty) database for vaultwarden:
CREATE DATABASE vaultwarden;
- Create a new database user and grant rights to database:
CREATE USER vaultwarden WITH ENCRYPTED PASSWORD 'yourpassword';
GRANT all privileges ON database vaultwarden TO vaultwarden;
- Configure vaultwarden and start it, so diesel can run migrations and set up the schema properly. Do not do anything else.
- Stop vaultwarden.
- install pgloader
- disable WAL of the SQLite database.
- create the file bitwarden.load with the following content:
load database
from sqlite:///where/you/keep/your/vaultwarden/db.sqlite3
into postgresql://yourpgsqluser:yourpgsqlpassword@yourpgsqlserver:yourpgsqlport/yourpgsqldatabase
WITH data only, include no drop, reset sequences
EXCLUDING TABLE NAMES LIKE '__diesel_schema_migrations'
ALTER SCHEMA 'bitwarden' RENAME TO 'public'
;
- run the command
pgloader bitwarden.load
and you might see some warnings, but the migration should complete successfully - Start vaultwarden again.
- 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
- 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