commit 3f56730b8a87aaf0e7a1c9e4ca1bdf48652cf10c
parent b1d19262494a1273d2b366834161aabc9be7feaa
Author: Daniel García <dani-garcia@users.noreply.github.com>
Date: Tue, 10 Jul 2018 13:41:06 +0200
Merge pull request #65 from laxmanpradhan/master
updated README to include backup information
Diffstat:
1 file changed, 26 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -194,4 +194,29 @@ 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).
+
+
+## Backing 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 backup either using a CRON job command that appends a timestamp or from another backup app such as Duplicati.
+
+### 2. the attachements folder
+
+By default, this is located in `$DATA_FOLDER/attachments`
+
+### 3. the key files
+
+This is optional, these are only used to store tokens of users currently logged in, deleting them would simply log each user out forcing them to log in again. 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.
+
+### 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`
