aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorlaxmanpradhan <[email protected]>2018-07-09 14:41:12 -0700
committerGitHub <[email protected]>2018-07-09 14:41:12 -0700
commit3c662de4f21f00024817b36968ba228a4371716e (patch)
treed1c26b8fef55504ceacebd1c2ef6a425b9618273 /README.md
parentb1d19262494a1273d2b366834161aabc9be7feaa (diff)
downloadvaultwarden-3c662de4f21f00024817b36968ba228a4371716e.tar.gz
vaultwarden-3c662de4f21f00024817b36968ba228a4371716e.zip
updated to include backup infromation
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/README.md b/README.md
index 95408ca8..b82a17fc 100644
--- a/README.md
+++ b/README.md
@@ -194,4 +194,28 @@ docker build -t bitwarden_rs .
## Building binary
-For building binary outside the Docker environment and running it locally without docker, please see [build instructions](BUILD.md). \ No newline at end of file
+For building binary outside the Docker environment and running it locally without docker, please see [build instructions](BUILD.md).
+
+## Backup up your vault
+
+1. the sqlite3 database
+
+The sqlite3 database should be backed up using the proper sqlite3 backup command. This will ensure the database does not become corrupted if the backup happens during a database write.
+
+```
+sqlite3 /$DATA_FOLDER/db.sqlite3 ".backup '/$DATA_FOLDER/db-backup/backup.sq3'"
+```
+
+This command can be run via a CRON job everyday, however note that it will overwrite the same backup.sq3 file each time. This backup file should therefore be saved via incremental back either using a CRON job command that appends a timestamp or from another backup app such as Duplicati.
+
+2. the key files
+
+By default, these are located in the `$DATA_FOLDER` (by default /data in the docker). There are 3 files: rsa_key.der, rsa_key.pem, rsa_key.pub.der.
+
+3. the attachements folder
+
+By default, this is located in `$DATA_FOLDER/attachments`
+
+4. Icon Cache
+
+This is optional, the icon cache can redownload itself however if you have a large cache, it may take a long time. By default it is located in `$DATA_FOLDER/icon_cache`