andreasbrett/vaultwarden-backup

Backup vaultwarden (formerly known as bitwarden_rs) sqlite3 database by rclone. (Docker)

vaultwarden backup

README | 中文文档

Docker containers for vaultwarden (formerly known as bitwarden_rs) backup to remote.

• Docker Hub
• GitHub

Rename

Unofficial Bitwarden compatible server written in Rust, formerly known as bitwarden_rs, renamed to vaultwarden.

For this reason, the backup tool was migrated to ttionya/vaultwarden-backup.

The old image can still be used, just deprecated. It is recommended to migrate to new image ttionya/vaultwarden-backup.

See how to migrate here.

Feature

This tool supports backing up the following files or directories.

• db.sqlite3
• config.json
• rsa_key* (multiple files)
• attachments (directory)
• sends (directory)

And the following ways of notifying backup results are supported.

• Ping (only send on success)
• Mail (SMTP based, send on success and on failure)

Usage

Important: We assume you already read the vaultwarden documentation.

Backup

We upload the backup files to the storage system by Rclone.

You need to configure Rclone first, otherwise the backup tool will not work.

Visit GitHub for more storage system tutorials. Different systems get tokens differently.

You can get the token by the following command.

docker run --rm -it \
  --mount type=volume,source=vaultwarden-rclone-data,target=/config/ \
  ttionya/vaultwarden-backup:latest \
  rclone config

After setting, check the configuration content by the following command.

docker run --rm -it \
  --mount type=volume,source=vaultwarden-rclone-data,target=/config/ \
  ttionya/vaultwarden-backup:latest \
  rclone config show

# Microsoft Onedrive Example
# [YouRemoteName]
# type = onedrive
# token = {"access_token":"access token","token_type":"token type","refresh_token":"refresh token","expiry":"expiry time"}
# drive_id = driveid
# drive_type = personal

Note that you need to set the environment variable RCLONE_REMOTE_NAME to a remote name like YouRemoteName.

Automatic Backups

Make sure that your vaultwarden container is named vaultwarden otherwise you have to replace the container name in the --volumes-from section of the docker run call.

By default the data folder for vaultwarden is /data, you need to explicitly specify the data folder using the environment variable DATA_DIR.

Start the backup container with default settings. (automatic backup at 5 minute every hour)

docker run -d \
  --restart=always \
  --name vaultwarden_backup \
  --volumes-from=vaultwarden \
  --mount type=volume,source=vaultwarden-rclone-data,target=/config/ \
  -e RCLONE_REMOTE_NAME="YouRemoteName" \
  -e DATA_DIR="/data" \
  ttionya/vaultwarden-backup:latest

Use Docker Compose

Download docker-compose.yml to you machine, edit environment variables and start it. You need to go to the directory where the docker-compose.yml file is saved.

# Start
docker-compose up -d

# Stop
docker-compose stop

# Restart
docker-compose restart

# Remove
docker-compose down

Restore

Important: Restore will overwrite the existing files.

You need to stop the Docker container before the restore.

Because the host's files are not accessible in the Docker container, you need to map the directory where the backup files that need to be restored are located to the docker container.

And go to the directory where your backup files are located.

If you are using automatic backups, please confirm the vaultwarden volume and replace the --mount source section. Also don't forget to use the environment variable DATA_DIR to specify the data directory (-e DATA_DIR="/data").

docker run --rm -it \
  --mount type=volume,source=vaultwarden-data,target=/bitwarden/data/ \
  --mount type=bind,source=$(pwd),target=/bitwarden/restore/ \
  ttionya/vaultwarden-backup:latest restore \
  [OPTIONS]

See Options for options information.

Options

※ You have the compressed file named backup

--zip-file

You need to use this option to specify the backup compressed package.

Make sure the file name in the compressed package has not been changed.

-p / --password

THIS IS INSECURE!

If the backup compressed package has a password, you can use this option to set the password to extract it.

If not, the password will be asked for interactively.

※ You have multiple independent backup files

--db-file

You need to use this option to specify the db.sqlite3 file.

--config-file

You need to use this option to specify the config.json file.

--rsakey-file

You need to use this option to specify the rsakey.tar file.

--attachments-file

You need to use this option to specify the attachments.tar file.

--sends-file

You need to use this option to specify the sends.tar file.

Environment Variables

Note: All environment variables have default values, and you can use the docker image without setting environment variables.

RCLONE_REMOTE_NAME

Rclone remote name, you can name it yourself.

Default: BitwardenBackup

RCLONE_REMOTE_DIR

Folder for storing backup files in the storage system.

Default: /BitwardenBackup/

CRON

Schedule run backup script, based on Linux crond. You can test the rules here.

Default: 5 * * * * (run the script at 5 minute every hour)

ZIP_ENABLE

Compress the backup file as Zip archive. When set to 'FALSE', only upload .sqlite3 files without compression.

Default: TRUE

ZIP_PASSWORD

Set your password to encrypt Zip archive. Note that the password will always be used when compressing the backup file.

Default: WHEREISMYPASSWORD?

ZIP_TYPE

Because the zip format is less secure, we offer archives in 7z format for those who seek security.

It should be noted that the password for vaultwarden is encrypted before it is sent to the server. The server does not have plaintext passwords, so the zip format is good enough for basic encryption needs.

Default: zip (only support zip and 7z format)

BACKUP_KEEP_DAYS

Only keep last a few days backup files in the storage system. Set to 0 to keep all backup files.

Default: 0

BACKUP_FILE_DATE_SUFFIX

Each backup file is suffixed by default with %Y%m%d. If you back up your vault multiple times a day that suffix is not unique anymore. This environment variable allows you to append that date (%Y%m%d${BACKUP_FILE_DATE_SUFFIX}) suffix in order to create a unique backup name.

Note that only numbers, upper and lower case letters, -, _, % are supported.

Please use the date man page for the format notation.

Default: ''

TIMEZONE

You should set the available timezone name.

Here is timezone list at wikipedia.

Default: UTC

PING_URL

Use healthcheck.io url or similar cron monitoring to perform GET requests after a successful backup.

MAIL_SMTP_ENABLE

The tool uses heirloom-mailx to send mail.

Default: FALSE

MAIL_SMTP_VARIABLES

Because the configuration for sending emails is too complicated, we allow you to configure it yourself.

We will set the subject according to the usage scenario, so you should not use the -s option.

When testing, we will add the -v option to display detailed information.

# My example:

# For Zoho
-S smtp-use-starttls \
-S smtp=smtp://smtp.zoho.com:587 \
-S smtp-auth=login \
-S smtp-auth-user=<my-email-address> \
-S smtp-auth-password=<my-email-password> \
-S from=<my-email-address>

See here for more information.

MAIL_TO

Who will receive the notification email.

MAIL_WHEN_SUCCESS

Send email when backup is successful.

Default: TRUE

MAIL_WHEN_FAILURE

Send email when backup fails.

Default: TRUE

DATA_DIR

The folder where vaultwarden stores its data.

When using Docker Compose, you don't need to change it, but when using automatic backup, you need to change it to /data.

Default: /bitwarden/data

※ Other environment variables

You don't need to change these environment variables unless you know what you're doing.

DATA_DB

Set the sqlite database file path.

Default: ${DATA_DIR}/db.sqlite3

DATA_RSAKEY

Set the rsa_key file path.

Default: ${DATA_DIR}/rsa_key

DATA_ATTACHMENTS

Set the attachment folder path.

Default: ${DATA_DIR}/attachments

DATA_SENDS

Set the sends folder path.

Default: ${DATA_DIR}/sends

Use .env file

If you prefer to use env file instead of environment variables, you can map the env file containing the environment variables to the /.env file in the container.

docker run -d \
  --mount type=bind,source=/path/to/env,target=/.env \
  ttionya/vaultwarden-backup:latest

Docker Secrets

As an alternative to passing sensitive information via environment variables, _FILE may be appended to the previously listed environment variables, causing the initialization script to load the values for those variables from files present in the container. In particular, this can be used to load passwords from Docker secrets stored in /run/secrets/<secret_name> files.

docker run -d \
  -e ZIP_PASSWORD_FILE=/run/secrets/zip-password \
  ttionya/vaultwarden-backup:latest

About Priority

We will use the environment variables first, then the contents of the file ending in _FILE as defined by the environment variables, followed by the contents of the file ending in _FILE as defined in the .env file, and finally the .env file values.

Mail Test

You can use the following command to test the mail sending. Remember to replace your smtp variables.

docker run --rm -it -e MAIL_SMTP_VARIABLES='<your smtp variables>' ttionya/vaultwarden-backup:latest mail <mail send to>

# Or

docker run --rm -it -e MAIL_SMTP_VARIABLES='<your smtp variables>' -e MAIL_TO='<mail send to>' ttionya/vaultwarden-backup:latest mail

Migration

If you use automatic backups, you just need to replace the image with ttionya/vaultwarden-backup. Note the name of your volume.

If you are using docker-compose, you need to update bitwardenrs/server to vaultwarden/server and ttionya/bitwardenrs-backup to ttionya/vaultwarden-backup.

We recommend re-downloading the docker-compose.yml file, replacing your environment variables, and noting the volumes section, which you may need to change.

Changelog

Check out CHANGELOG file.

License

MIT