Add a CLI feature to backup the SQLite DB #4906
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dani-garcia
reviewed
Aug 30, 2024
Many users request to add the sqlite3 binary to the container image. This isn't really ideal as that might bring in other dependencies and will only bloat the image. There main reason is to create a backup of the database. While there already was a feature within the admin interface to do so (or by using the admin API call), this might not be easy. This PR adds several ways to generate a backup. 1. By calling the Vaultwarden binary with the `backup` command like: - `/vaultwarden backup` - `docker exec -it vaultwarden /vaultwarden backup` 2. By sending the USR1 signal to the running process like: - `kill -s USR1 $(pidof vaultwarden) - `killall -s USR1 vaultwarden) This should help users to more easily create backups of there SQLite database. Also added the Web-Vault version number when using `-v/--version` to the output. Signed-off-by: BlackDex <black.dex@gmail.com>
Signed-off-by: BlackDex <black.dex@gmail.com>
BlackDex
force-pushed
the
add-cli-backup-for-sqlite
branch
from
b6bbdf1
to
9c07103
Compare
dani-garcia
approved these changes
Sep 1, 2024
|
Quick question about the new update: it only covers SQLite right? I'm wondering if this would be enough to recover from a complete loss of a Vaultwarden deployment? Currently, I'm running ttionya/vaultwarden-backup to maintain backups in case I need to spin up the server again. It covers
|
|
It only covers the database currently. So i would suggest to keep using that tool. |
Makes complete sense, thank you |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Many users request to add the sqlite3 binary to the container image. This isn't really ideal as that might bring in other dependencies and will only bloat the image. There main reason is to create a backup of the database.
While there already was a feature within the admin interface to do so (or by using the admin API call), this might not be easy.
This PR adds several ways to generate a backup.
backupcommand like:/vaultwarden backupdocker exec -it vaultwarden /vaultwarden backupkill -s USR1 $(pidof vaultwarden)killall -s USR1 vaultwardenThis should help users to more easily create backups of there SQLite database.
Also added the Web-Vault version number when using
-v/--versionto the output.