docs: update README

This commit is contained in:
ttionya
2022-07-30 19:58:11 +08:00
parent ae021c9013
commit 9ff6479c19
3 changed files with 107 additions and 0 deletions
+9
View File
@@ -479,6 +479,15 @@ We recommend re-downloading the `docker-compose.yml` file, replacing your enviro
## Advance
- [Run as non-root user](docs/run-as-non-root-user.md)
- [Multiple remote destinations](docs/multiple-remote-destinations.md)
<br>
## Changelog ## Changelog
Check out [CHANGELOG](CHANGELOG.md) file. Check out [CHANGELOG](CHANGELOG.md) file.
+9
View File
@@ -476,6 +476,15 @@ docker run --rm -it -e MAIL_SMTP_VARIABLES='<your smtp variables>' -e MAIL_TO='<
## 高级
- [以非 root 用户运行](docs/run-as-non-root-user.md)
- [备份到多个远程目标](docs/multiple-remote-destinations.md)
<br>
## 更新日志 ## 更新日志
请查看 [CHANGELOG](CHANGELOG.md) 文件。 请查看 [CHANGELOG](CHANGELOG.md) 文件。
+89
View File
@@ -0,0 +1,89 @@
# Multiple remote destinations
Some users want to upload to multiple remote destinations when backing up.
You can do this by setting the following environment variables.
<br>
## Usage
Set additional remote destinations via environment variables `RCLONE_REMOTE_NAME_N` and `RCLONE_REMOTE_DIR_N`.
Note:
- `N` is the serial number, which is a number
- `N` starts from 1 and is consecutive, e.g. 1 2 3 4 5 ...
- `RCLONE_REMOTE_NAME_N` and `RCLONE_REMOTE_DIR_N` cannot be empty
The script will break parsing of environment variables for remote destinations where the serial number is not consecutive or the value is empty.
<br>
#### Example
```yml
...
environment:
# they have default values
# RCLONE_REMOTE_NAME: BitwardenBackup
# RCLONE_REMOTE_DIR: /BitwardenBackup/
RCLONE_REMOTE_NAME_1: extraRemoteName1
RCLONE_REMOTE_DIR_1: extraRemoteDir1
...
```
Both remote destinations are available, they are `BitwardenBackup:/BitwardenBackup/` and `extraRemoteName1:extraRemoteDir1`.
<br>
```yml
...
environment:
RCLONE_REMOTE_NAME: remoteName
RCLONE_REMOTE_DIR: remoteDir
RCLONE_REMOTE_NAME_1: extraRemoteName1
RCLONE_REMOTE_DIR_1: extraRemoteDir1
RCLONE_REMOTE_NAME_2: extraRemoteName2
RCLONE_REMOTE_DIR_2: extraRemoteDir2
RCLONE_REMOTE_NAME_3: extraRemoteName3
RCLONE_REMOTE_DIR_3: extraRemoteDir3
RCLONE_REMOTE_NAME_4: extraRemoteName4
RCLONE_REMOTE_DIR_4: extraRemoteDir4
...
```
All 5 remote destinations are available.
<br>
```yml
...
environment:
RCLONE_REMOTE_NAME: remoteName
RCLONE_REMOTE_DIR: remoteDir
RCLONE_REMOTE_NAME_1: extraRemoteName1
RCLONE_REMOTE_DIR_1: extraRemoteDir1
RCLONE_REMOTE_NAME_2: extraRemoteName2
# RCLONE_REMOTE_DIR_2: extraRemoteDir2
RCLONE_REMOTE_NAME_3: extraRemoteName3
RCLONE_REMOTE_DIR_3: extraRemoteDir3
RCLONE_REMOTE_NAME_4: extraRemoteName4
RCLONE_REMOTE_DIR_4: extraRemoteDir4
...
```
`RCLONE_REMOTE_DIR_2` is not defined, so only the remote destination before it is available. They are `remoteName:remoteDir` and `extraRemoteName1:extraRemoteDir1`.
<br>
## Notification
- success: **all** remote destinations were uploaded successfully
- failure: **any** of the remote destinations failed to upload