docs: make configuration rclone more visible
This commit is contained in:
@@ -9,6 +9,8 @@ Docker containers for [vaultwarden](https://github.com/dani-garcia/vaultwarden)
|
|||||||
- [Docker Hub](https://hub.docker.com/r/ttionya/vaultwarden-backup)
|
- [Docker Hub](https://hub.docker.com/r/ttionya/vaultwarden-backup)
|
||||||
- [GitHub](https://github.com/ttionya/vaultwarden-backup)
|
- [GitHub](https://github.com/ttionya/vaultwarden-backup)
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Rename
|
## Rename
|
||||||
@@ -21,6 +23,8 @@ The old image can still be used, just **deprecated**. It is recommended to migra
|
|||||||
|
|
||||||
**See how to migrate [here](#migration).**
|
**See how to migrate [here](#migration).**
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Feature
|
## Feature
|
||||||
@@ -33,6 +37,8 @@ This tool supports backing up the following files or directories.
|
|||||||
- `attachments` (directory)
|
- `attachments` (directory)
|
||||||
- `sends` (directory)
|
- `sends` (directory)
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
@@ -43,6 +49,8 @@ This tool supports backing up the following files or directories.
|
|||||||
|
|
||||||
We upload the backup files to the storage system by [Rclone](https://rclone.org/).
|
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.
|
Visit [GitHub](https://github.com/rclone/rclone) for more storage system tutorials. Different systems get tokens differently.
|
||||||
|
|
||||||
You can get the token by the following command.
|
You can get the token by the following command.
|
||||||
@@ -177,6 +185,8 @@ You need to use this option to specify the `sends.tar` file.
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Environment Variables
|
## Environment Variables
|
||||||
@@ -329,6 +339,8 @@ Default: `${DATA_DIR}/sends`
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Use `.env` file
|
## Use `.env` file
|
||||||
@@ -341,6 +353,8 @@ docker run -d \
|
|||||||
ttionya/vaultwarden-backup:latest
|
ttionya/vaultwarden-backup:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Docker Secrets
|
## Docker Secrets
|
||||||
@@ -353,12 +367,16 @@ docker run -d \
|
|||||||
ttionya/vaultwarden-backup:latest
|
ttionya/vaultwarden-backup:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## About Priority
|
## About Priority
|
||||||
|
|
||||||
We will use the environment variables first, then the contents of the file ending in `_FILE` as defined by the environment variables, followed by the contents of the file ending in `_FILE` as defined in the `.env` file, and finally the `.env` file values.
|
We will use the environment variables first, then the contents of the file ending in `_FILE` as defined by the environment variables, followed by the contents of the file ending in `_FILE` as defined in the `.env` file, and finally the `.env` file values.
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Mail Test
|
## Mail Test
|
||||||
@@ -373,6 +391,8 @@ docker run --rm -it -e MAIL_SMTP_VARIABLES='<your smtp variables>' ttionya/vault
|
|||||||
docker run --rm -it -e MAIL_SMTP_VARIABLES='<your smtp variables>' -e MAIL_TO='<mail send to>' ttionya/vaultwarden-backup:latest mail
|
docker run --rm -it -e MAIL_SMTP_VARIABLES='<your smtp variables>' -e MAIL_TO='<mail send to>' ttionya/vaultwarden-backup:latest mail
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Migration
|
## Migration
|
||||||
@@ -383,6 +403,8 @@ If you are using `docker-compose`, you need to update `bitwardenrs/server` to `v
|
|||||||
|
|
||||||
We recommend re-downloading the `docker-compose.yml` file, replacing your environment variables, and noting the `volumes` section, which you may need to change.
|
We recommend re-downloading the `docker-compose.yml` file, replacing your environment variables, and noting the `volumes` section, which you may need to change.
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|||||||
@@ -9,6 +9,8 @@
|
|||||||
- [Docker Hub](https://hub.docker.com/r/ttionya/vaultwarden-backup)
|
- [Docker Hub](https://hub.docker.com/r/ttionya/vaultwarden-backup)
|
||||||
- [GitHub](https://github.com/ttionya/vaultwarden-backup)
|
- [GitHub](https://github.com/ttionya/vaultwarden-backup)
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 重命名
|
## 重命名
|
||||||
@@ -21,6 +23,8 @@
|
|||||||
|
|
||||||
**请在[这里](#迁移)查看如何迁移**。
|
**请在[这里](#迁移)查看如何迁移**。
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 功能
|
## 功能
|
||||||
@@ -33,6 +37,8 @@
|
|||||||
- `attachments` (目录)
|
- `attachments` (目录)
|
||||||
- `sends` (目录)
|
- `sends` (目录)
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 使用方法
|
## 使用方法
|
||||||
@@ -43,6 +49,8 @@
|
|||||||
|
|
||||||
我们通过 [Rclone](https://rclone.org/) 同步备份文件到远程存储系统。
|
我们通过 [Rclone](https://rclone.org/) 同步备份文件到远程存储系统。
|
||||||
|
|
||||||
|
> **你需要先配置 Rclone,否则备份工具不会工作。**
|
||||||
|
|
||||||
访问 [GitHub](https://github.com/rclone/rclone) 了解更多存储系统使用教程,不同的系统获得 Token 的方式不同。
|
访问 [GitHub](https://github.com/rclone/rclone) 了解更多存储系统使用教程,不同的系统获得 Token 的方式不同。
|
||||||
|
|
||||||
你可以通过下面的命令获得 Token。
|
你可以通过下面的命令获得 Token。
|
||||||
@@ -179,6 +187,8 @@ docker run --rm -it \
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 环境变量
|
## 环境变量
|
||||||
@@ -330,6 +340,8 @@ Rclone 远程名称,你可以自己修改命名。
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Use `.env` file
|
## Use `.env` file
|
||||||
@@ -342,6 +354,8 @@ docker run -d \
|
|||||||
ttionya/vaultwarden-backup:latest
|
ttionya/vaultwarden-backup:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Docker Secrets
|
## Docker Secrets
|
||||||
@@ -354,12 +368,16 @@ docker run -d \
|
|||||||
ttionya/vaultwarden-backup:latest
|
ttionya/vaultwarden-backup:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 关于优先级
|
## 关于优先级
|
||||||
|
|
||||||
我们会优先使用环境变量,然后是环境变量定义的 `_FILE` 结尾的文件内容,之后是 `.env` 文件中定义的 `_FILE` 结尾的文件内容,最后才是 `.env` 文件的值。
|
我们会优先使用环境变量,然后是环境变量定义的 `_FILE` 结尾的文件内容,之后是 `.env` 文件中定义的 `_FILE` 结尾的文件内容,最后才是 `.env` 文件的值。
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 邮件发送测试
|
## 邮件发送测试
|
||||||
@@ -374,6 +392,8 @@ docker run --rm -it -e MAIL_SMTP_VARIABLES='<your smtp variables>' ttionya/vault
|
|||||||
docker run --rm -it -e MAIL_SMTP_VARIABLES='<your smtp variables>' -e MAIL_TO='<mail send to>' ttionya/vaultwarden-backup:latest mail
|
docker run --rm -it -e MAIL_SMTP_VARIABLES='<your smtp variables>' -e MAIL_TO='<mail send to>' ttionya/vaultwarden-backup:latest mail
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 迁移
|
## 迁移
|
||||||
@@ -384,6 +404,8 @@ docker run --rm -it -e MAIL_SMTP_VARIABLES='<your smtp variables>' -e MAIL_TO='<
|
|||||||
|
|
||||||
我们建议重新下载 `docker-compose.yml` 文件,替换你的环境变量,并注意 `volumes` 一节,你可能需要改变它。
|
我们建议重新下载 `docker-compose.yml` 文件,替换你的环境变量,并注意 `volumes` 一节,你可能需要改变它。
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 许可证
|
## 许可证
|
||||||
|
|||||||
Reference in New Issue
Block a user