bitwarden_rs

Table of Contents

Overview
Backing up data

SQLite database files
The attachments dir
The sends dir
The config.json file
The rsa_key* files
The icon_cache dir

Restoring backup data
Examples

Overview

vaultwarden data should be backed up regularly, preferably via an automated process (e.g., cron job). Ideally, at least one copy should be stored remotely (e.g., cloud storage or a different computer). Avoid relying on filesystem or VM snapshots as a backup method, as these are more complex operations where more things can go wrong, and recovery in such cases can be difficult or impossible for the typical user. Adding an extra layer of encryption on your backups would generally be a good idea (especially if your backup also includes config data like your admin token), but you might choose to skip this step if you're confident that your master password (and those of your other users, if any) is strong.

Backing up data

By default, vaultwarden stores all of its data under a directory called data (in the same directory as the vaultwarden executable). This location can be changed by setting the DATA_FOLDER environment variable. If you run vaultwarden with SQLite (this is the most common setup), then the SQL database is just a file in the data folder. If you run with MySQL or PostgreSQL, you will have to dump that data separately -- this is beyond the scope of this article, but a web search will turn up many other tutorials that cover this topic.

When running with the default SQLite backend, the vaultwarden data directory has this structure:

data
├── attachments          # Each attachment is stored as a separate file under this dir.
│   └── <uuid>           # (The attachments dir won't be present if no attachments have been created.)
│       └── <random_id>
├── config.json          # Stores admin page config; only exists if the admin page has been enabled before.
├── db.sqlite3           # Main SQLite database file.
├── db.sqlite3-shm       # SQLite shared memory file (not always present).
├── db.sqlite3-wal       # SQLite write-ahead log file (not always present).
├── icon_cache           # Site icons (favicons) are cached under this dir.
│   ├── <domain>.png
│   ├── example.com.png
│   ├── example.net.png
│   └── example.org.png
├── rsa_key.der          # `rsa_key.*` files are used to sign authentication tokens.
├── rsa_key.pem
├── rsa_key.pub.der
└── sends                # Each Send attachment is stored as a separate file under this dir.
    └── <uuid>           # (The sends dir won't be present if no Send attachments have been created.)
        └── <random_id>

When running with MySQL or PostgreSQL backends, the directory structure is the same, except there are no SQLite files. You'll still want to back up files in the data directory, as well as a dump of your MySQL or PostgreSQL tables.

Each set of files is discussed in more detail next.

SQLite database files

Backup required.

The SQLite database file (db.sqlite3) stores almost all important vaultwarden data/state (database entries, user/org/device metadata, etc.), with the main exception being attachments, which are stored as separate files on the filesystem.

You should generally use the .backup command in the SQLite CLI (sqlite3) to back up the database file. This command uses the Online Backup API, which SQLite documents as the best way to back up a database file that may be in active use. If you can ensure the database will not be in use when a backup runs, you can also use other methods such as the .dump command, or simply copying all the SQLite database files (including the -wal file, if present).

A basic backup command looks like this, assuming your data folder is data (the default):

sqlite3 data/db.sqlite3 ".backup '/path/to/backups/db-$(date '+%Y%m%d-%H%M').sqlite3'"

You can also use VACUUM INTO, which will compact empty space, but takes somewhat more processing time:

sqlite3 data/db.sqlite3 "VACUUM INTO '/path/to/backups/db-$(date '+%Y%m%d-%H%M').sqlite3'"

Assuming this command is run on January 1, 2021 at 12:34pm (local time), this backs up your SQLite database file to /path/to/backups/db-20210101-1234.sqlite3.

You can run this command via a cron job periodically (preferably at least once a day). If you are running via Docker, note that the Docker images do not include an sqlite3 binary or cron daemon, so you would generally install these on the Docker host itself and run the cron job outside of the container. If you really want to run backups from within the container for some reason, you can install any necessary packages during container startup, or create your own custom Docker image with your preferred vaultwarden/server:<tag> image as the parent.

If you want to copy your backup data to cloud storage, rclone is a useful tool for interfacing with various cloud storage systems. restic is another good option, especially if you have larger attachments and want to avoid recopying them as part of each backup.

The `attachments` dir

Backup required.

File attachments are the only important class of data not stored in database tables, mainly because they can be arbitrarily large, and SQL databases generally aren't designed to handle large blobs efficiently. This directory won't be present if no file attachments have ever been created.

The `sends` dir

Backup optional.

Like regular file attachments, Send file attachments are not stored in database tables. (Send text notes are stored in the database, however.)

Unlike regular attachments, Send attachments are intended to be ephemeral. Therefore, you might choose not to back up this directory if you want to minimize the size of your backups. On the other hand, if it's more important to maintain proper functionality of existing Sends across a restore, then you should back up this directory.

This directory won't be present if no Send attachments have ever been created.

The `config.json` file

Backup recommended.

If you use the admin page to configure your vaultwarden instance and don't have your configuration backed up some other way, then you probably want to back up this file so you don't have to figure out your preferred configuration all over again.

Keep in mind that this file does contain some data in plaintext that could be considered sensitive (admin token, SMTP credentials, etc.), so make sure to encrypt this data if you're concerned that someone else might be able to access it (e.g., when uploaded to cloud storage).

The `rsa_key*` files

Backup recommended.

These files are used to sign the JWTs (authentication tokens) of users currently logged in. Deleting them would simply log out each user, forcing them to log in again and it would also invalidate any open invitation tokens that have been sent via mail.

The rsa_key.pem (private key) file could be considered somewhat sensitive. In principle, it could be used to forge vault login sessions to your server, though in practice, doing so would require additional knowledge of various UUIDs (e.g., taken from a copy of your database). Also, any data obtained with a forged session would still be encrypted with personal and/or organization keys, so brute-forcing the relevant master password in order to obtain those keys would still be required. Admin panel login sessions, however, could be forged easily (this would only work if the admin panel is enabled). This wouldn't provide access to vault data, but it would allow some administrative actions like deleting users or removing 2FA.

Overall, encrypting the private key is recommended if you're concerned that someone else might be able to access it (e.g., when uploaded to cloud storage).

The `icon_cache` dir

Backup optional.

The icon cache stores website icons so that they don't need to be fetched from the login site repeatedly. It's probably not worth backing up unless you really want to avoid refetching a large cache of icons.

Restoring backup data

Make sure vaultwarden is stopped, and then simply replace each file or directory in the data dir with its backed up version.

When restoring a backup created using .backup or VACUUM INTO, make sure to first delete any existing db.sqlite3-wal file, as this could potentially result in database corruption when SQLite tries to recover db.sqlite3 using a stale/mismatched WAL file. However, if you backed up the database using a straight copy of db.sqlite3 and its matching db.sqlite3-wal file, then you must restore both files as a pair. You don't need to back up or restore the db.sqlite3-shm file.

It's a good idea to run through the process of restoring from backup periodically, just to verify that your backups are working properly. When doing this, make sure to move or keep a copy of your original data in case your backups do not in fact work properly.

Examples

This section contains an index of third-party backup examples. You should review an example thoroughly and understand what it's doing before using it.

Overview

Backing up data

SQLite database files

The `attachments` dir

The `sends` dir

The `config.json` file

The `rsa_key*` files

The `icon_cache` dir

Restoring backup data

Examples

FAQs

Container Image Usage

Deployment

HTTPS

Configuration

Database

Security

Backup

Other Information

Overview

Backing up data

SQLite database files

The attachments dir

The sends dir

The config.json file

The rsa_key* files

The icon_cache dir

Restoring backup data

Examples

FAQs

Container Image Usage

Deployment

HTTPS

Configuration

Database

Security

Backup

Other Information

The `attachments` dir

The `sends` dir

The `config.json` file

The `rsa_key*` files

The `icon_cache` dir