From 3c662de4f21f00024817b36968ba228a4371716e Mon Sep 17 00:00:00 2001 From: laxmanpradhan Date: Mon, 9 Jul 2018 14:41:12 -0700 Subject: [PATCH 1/4] updated to include backup infromation --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) 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` From 203fb2e3e74982f646e035c759997f2009a2736d Mon Sep 17 00:00:00 2001 From: laxmanpradhan Date: Mon, 9 Jul 2018 14:44:00 -0700 Subject: [PATCH 2/4] formatting for headings --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b82a17fc..e4863e5f 100644 --- a/README.md +++ b/README.md @@ -196,9 +196,10 @@ docker build -t bitwarden_rs . 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 +### 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. @@ -208,14 +209,14 @@ 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 +## 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 +## 3. the attachements folder By default, this is located in `$DATA_FOLDER/attachments` -4. Icon Cache +## 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` From f920441b2882d646ec2fdf57d776ba0f03d58ddd Mon Sep 17 00:00:00 2001 From: laxmanpradhan Date: Mon, 9 Jul 2018 14:48:51 -0700 Subject: [PATCH 3/4] updated key files infor --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e4863e5f..65494338 100644 --- a/README.md +++ b/README.md @@ -197,9 +197,9 @@ docker build -t bitwarden_rs . For building binary outside the Docker environment and running it locally without docker, please see [build instructions](BUILD.md). -### Backing up your vault +## Backing up your vault -## 1. the sqlite3 database +### 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. @@ -209,14 +209,14 @@ 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 +### 2. the attachements folder -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. +By default, this is located in `$DATA_FOLDER/attachments` -## 3. the attachements folder +### 3. the key files -By default, this is located in `$DATA_FOLDER/attachments` +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 +### 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` From 57701d5213a963252b16e460df3c72d9f4b60383 Mon Sep 17 00:00:00 2001 From: laxmanpradhan Date: Mon, 9 Jul 2018 14:51:13 -0700 Subject: [PATCH 4/4] typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 65494338..fc5c948e 100644 --- a/README.md +++ b/README.md @@ -207,7 +207,7 @@ The sqlite3 database should be backed up using the proper sqlite3 backup command 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. +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