https://github.com/le0developer/vaultwarden-backup
https://github.com/le0developer/vaultwarden-backup
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/le0developer/vaultwarden-backup
- Owner: Le0Developer
- Created: 2025-06-26T07:37:38.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2025-06-26T11:51:53.000Z (8 months ago)
- Last Synced: 2025-06-26T12:47:35.977Z (8 months ago)
- Language: Shell
- Size: 3.91 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vaultwarden-backup
Backs up your Vaultwarden database every hour.
## Setup
You must mount the `/data` directory of your Vaultwarden container to the `/data` directory of this container.
For example using Docker Compose:
```yaml
services:
vaultwarden:
image: vaultwarden/server:latest
volumes:
- ./data:/data
vaultwarden-backup:
image: ghcr.io/le0developer/vaultwarden-backup:master
volumes:
- ./data:/data
```
## Backup Location
The backups will be stored in the `/backup` directory of this container.
You can mount this directory to your host machine to access the backups or use [`rclone`](#rclone) to sync them to a remote storage.
## Environment Variables
You can set the following environment variables to customize the backup process:
### `HEALTHCHECK_URL`
A URL you can specify which will be called after every successful backup.
Think of this as a keep alive ping. Status monitors can be used to notify you if no ping arrives.
### `RCLONE_REMOTE`
See [rclone](#rclone) for more information.
### `CLEAN`
If set to `true`, after a successful backup, older backups will be deleted.
## rclone
Rclone lets you sync your backups to remote storages.
Set `RCLONE_REMOTE` to the name of your remote storage. See [rclone documentation](https://rclone.org/docs/#environment-variables) for more information and how to set up your environment variables.