docs: make configuration rclone more visible

This commit is contained in:
ttionya
2021-05-12 21:01:37 +08:00
parent ebeb055650
commit 0c09a739bb
2 changed files with 44 additions and 0 deletions
+22
View File
@@ -9,6 +9,8 @@ Docker containers for [vaultwarden](https://github.com/dani-garcia/vaultwarden)
- [Docker Hub](https://hub.docker.com/r/ttionya/vaultwarden-backup)
- [GitHub](https://github.com/ttionya/vaultwarden-backup)
<br>
## 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).**
<br>
## Feature
@@ -33,6 +37,8 @@ This tool supports backing up the following files or directories.
- `attachments` (directory)
- `sends` (directory)
<br>
## 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/).
> **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.
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>
<br>
## Environment Variables
@@ -329,6 +339,8 @@ Default: `${DATA_DIR}/sends`
</details>
<br>
## Use `.env` file
@@ -341,6 +353,8 @@ docker run -d \
ttionya/vaultwarden-backup:latest
```
<br>
## Docker Secrets
@@ -353,12 +367,16 @@ docker run -d \
ttionya/vaultwarden-backup:latest
```
<br>
## 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.
<br>
## 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
```
<br>
## 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.
<br>
## License