diff --git a/README.md b/README.md
index 87ce5f2..e585b72 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@ Docker containers for [vaultwarden](https://github.com/dani-garcia/vaultwarden)
For this reason, the backup tool was migrated to [ttionya/vaultwarden-backup](https://github.com/ttionya/vaultwarden-backup).
-The old image can still be used, just **deprecated**. It is recommended to migrate to new image [ttionya/vaultwarden-backup](https://hub.docker.com/r/ttionya/vaultwarden-backup).
+The old image can still be used, just **DEPRECATED**. It is recommended to migrate to new image [ttionya/vaultwarden-backup](https://hub.docker.com/r/ttionya/vaultwarden-backup).
**See how to migrate [here](#migration).**
@@ -50,14 +50,18 @@ And the following ways of notifying backup results are supported.
> **Important:** We assume you already read the `vaultwarden` [documentation](https://github.com/dani-garcia/vaultwarden/wiki).
-### Backup
+### Configure Rclone (⚠️ MUST READ ⚠️)
+
+> **For backup, you need to configure Rclone first, otherwise the backup tool will not work.**
+>
+> **For restore, it is not necessary.**
We upload the backup files to the storage system by [Rclone](https://rclone.org/).
-**You need to configure Rclone first, otherwise the backup tool will not work.**
-
Visit [GitHub](https://github.com/rclone/rclone) for more storage system tutorials. Different systems get tokens differently.
+#### Configure and Check
+
You can get the token by the following command.
```shell
@@ -67,6 +71,8 @@ docker run --rm -it \
rclone config
```
+**We recommend setting the remote name to `BitwardenBackup`, otherwise you need to specify the environment variable `RCLONE_REMOTE_NAME` as the remote name you set.**
+
After setting, check the configuration content by the following command.
```shell
@@ -76,14 +82,18 @@ docker run --rm -it \
rclone config show
# Microsoft Onedrive Example
-# [YouRemoteName]
+# [BitwardenBackup]
# type = onedrive
# token = {"access_token":"access token","token_type":"token type","refresh_token":"refresh token","expiry":"expiry time"}
# drive_id = driveid
# drive_type = personal
```
-Note that you need to set the environment variable `RCLONE_REMOTE_NAME` to a remote name like `YouRemoteName`.
+
+
+
+
+### Backup
#### Use Docker Compose (Recommend)
@@ -123,20 +133,25 @@ docker run -d \
--name vaultwarden_backup \
--volumes-from=vaultwarden \
--mount type=volume,source=vaultwarden-rclone-data,target=/config/ \
- -e RCLONE_REMOTE_NAME="YouRemoteName" \
-e DATA_DIR="/data" \
ttionya/vaultwarden-backup:latest
```
+
+
+
+
### Restore
> **Important:** Restore will overwrite the existing files.
You need to stop the Docker container before the restore.
+You also need to download the backup files to your local machine.
+
Because the host's files are not accessible in the Docker container, you need to map the directory where the backup files that need to be restored are located to the docker container.
-And go to the directory where your backup files are located.
+**And go to the directory where your backup files to be restored are located.**
If you use the `docker-compose.yml` provided with this project, you can use the following command.
diff --git a/README_zh.md b/README_zh.md
index 026b94d..7b85c56 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -19,7 +19,7 @@
所以这个备份工具迁移到了 [ttionya/vaultwarden-backup](https://github.com/ttionya/vaultwarden-backup) 。
-旧的镜像仍然可以使用,只是 **deprecated** 了。建议迁移到新的镜像 [ttionya/vaultwarden-backup](https://hub.docker.com/r/ttionya/vaultwarden-backup) 。
+旧的镜像仍然可以使用,只是 **DEPRECATED** 了。建议迁移到新的镜像 [ttionya/vaultwarden-backup](https://hub.docker.com/r/ttionya/vaultwarden-backup) 。
**请在[这里](#迁移)查看如何迁移**。
@@ -50,14 +50,18 @@
> **重要:** 我们假设你已经完整阅读了 `vaultwarden` [文档](https://github.com/dani-garcia/vaultwarden/wiki) 。
-### 备份
+### 配置 Rclone (⚠️ 必读 ⚠️)
+
+> **对于备份,你需要先配置 Rclone,否则备份工具不会工作。**
+>
+> **对于还原,它不是必要的。**
我们通过 [Rclone](https://rclone.org/) 同步备份文件到远程存储系统。
-**你需要先配置 Rclone,否则备份工具不会工作。**
-
访问 [GitHub](https://github.com/rclone/rclone) 了解更多存储系统使用教程,不同的系统获得 Token 的方式不同。
+#### 配置和检查
+
你可以通过下面的命令获得 Token。
```shell
@@ -67,6 +71,8 @@ docker run --rm -it \
rclone config
```
+**我们建议将远程名称设置为 `BitwardenBackup`,否则你需要指定环境变量 `RCLONE_REMOTE_NAME` 为你设置的远程名称。**
+
完成设置后,可以通过以下命令检查配置情况。
```shell
@@ -76,14 +82,18 @@ docker run --rm -it \
rclone config show
# Microsoft Onedrive Example
-# [YouRemoteName]
+# [BitwardenBackup]
# type = onedrive
# token = {"access_token":"access token","token_type":"token type","refresh_token":"refresh token","expiry":"expiry time"}
# drive_id = driveid
# drive_type = personal
```
-需要注意的是,你要将环境变量 `RCLONE_REMOTE_NAME` 设置为远程名称,比如上面的 `YouRemoteName`。
+
+
+
+
+### 备份
#### 使用 Docker Compose (推荐)
@@ -123,20 +133,25 @@ docker run -d \
--name vaultwarden_backup \
--volumes-from=vaultwarden \
--mount type=volume,source=vaultwarden-rclone-data,target=/config/ \
- -e RCLONE_REMOTE_NAME="YouRemoteName" \
-e DATA_DIR="/data" \
ttionya/vaultwarden-backup:latest
```
+
+
+
+
### 还原备份
> **重要:** 还原备份会覆盖已存在的文件。
你需要在还原备份前停止 Docker 容器。
+你也需要下载备份文件到本地计算机。
+
因为主机的文件无法在 Docker 容器中直接访问,所以要将需要还原的备份文件所在目录映射到 Docker 容器中。
-首先进入备份文件所在目录。
+**首先进入待还原的备份文件所在目录。**
如果你使用的是本项目提供的 `docker-compose.yml`,你可以执行下面的命令。