docs: update README
This commit is contained in:
@@ -218,11 +218,23 @@ You need to use this option to specify the `sends.tar` file.
|
|||||||
|
|
||||||
## Environment Variables
|
## Environment Variables
|
||||||
|
|
||||||
> **Note:** All environment variables have default values, and you can use the docker image without setting environment variables.
|
> **Note:** All environment variables have default values, you can use the docker image without setting any environment variables.
|
||||||
|
|
||||||
#### RCLONE_REMOTE_NAME
|
#### RCLONE_REMOTE_NAME
|
||||||
|
|
||||||
Rclone remote name, you can name it yourself.
|
Rclone remote name, which needs to be consistent with the remote name in the rclone config.
|
||||||
|
|
||||||
|
You can view the current remote name with the following command.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
docker run --rm -it \
|
||||||
|
--mount type=volume,source=vaultwarden-rclone-data,target=/config/ \
|
||||||
|
ttionya/vaultwarden-backup:latest \
|
||||||
|
rclone config show
|
||||||
|
|
||||||
|
# [BitwardenBackup] <- this
|
||||||
|
# ...
|
||||||
|
```
|
||||||
|
|
||||||
Default: `BitwardenBackup`
|
Default: `BitwardenBackup`
|
||||||
|
|
||||||
@@ -236,25 +248,25 @@ Default: `/BitwardenBackup/`
|
|||||||
|
|
||||||
Rclone global flags, see [flags](https://rclone.org/flags/).
|
Rclone global flags, see [flags](https://rclone.org/flags/).
|
||||||
|
|
||||||
**Do not add flags that change the output, such as `-P`, which will affect the deletion of outdated backup files.**
|
**Do not add flags that will change the output, such as `-P`, which will affect the deletion of outdated backup files.**
|
||||||
|
|
||||||
Default: `''`
|
Default: `''`
|
||||||
|
|
||||||
#### CRON
|
#### CRON
|
||||||
|
|
||||||
Schedule run backup script, based on Linux `crond`. You can test the rules [here](https://crontab.guru/#5_*_*_*_*).
|
Schedule run backup script, based on [`supercronic`](https://github.com/aptible/supercronic). You can test the rules [here](https://crontab.guru/#5_*_*_*_*).
|
||||||
|
|
||||||
Default: `5 * * * *` (run the script at 5 minute every hour)
|
Default: `5 * * * *` (run the script at 5 minute every hour)
|
||||||
|
|
||||||
#### ZIP_ENABLE
|
#### ZIP_ENABLE
|
||||||
|
|
||||||
Compress the backup file as Zip archive. When set to `'FALSE'`, only upload `.sqlite3` files without compression.
|
Pack all backup files into a compressed file. When set to `'FALSE'`, each backup file will be uploaded independently.
|
||||||
|
|
||||||
Default: `TRUE`
|
Default: `TRUE`
|
||||||
|
|
||||||
#### ZIP_PASSWORD
|
#### ZIP_PASSWORD
|
||||||
|
|
||||||
Set your password to encrypt Zip archive. Note that the password will always be used when compressing the backup file.
|
Password for compressed file. Note that the password will always be used when packing the backup files.
|
||||||
|
|
||||||
Default: `WHEREISMYPASSWORD?`
|
Default: `WHEREISMYPASSWORD?`
|
||||||
|
|
||||||
|
|||||||
+17
-5
@@ -218,11 +218,23 @@ docker run --rm -it \
|
|||||||
|
|
||||||
## 环境变量
|
## 环境变量
|
||||||
|
|
||||||
> **注意:** 所有的环境变量都有默认值,你可以在不设置环境变量的情况下使用 Docker 镜像。
|
> **注意:** 所有的环境变量都有默认值,你可以在不设置任何环境变量的情况下使用 Docker 镜像。
|
||||||
|
|
||||||
#### RCLONE_REMOTE_NAME
|
#### RCLONE_REMOTE_NAME
|
||||||
|
|
||||||
Rclone 远程名称,你可以自己修改命名。
|
Rclone 远程名称,它需要和 rclone config 中的远程名称保持一致。
|
||||||
|
|
||||||
|
你可以通过以下命令查看当前远程名称。
|
||||||
|
|
||||||
|
```shell
|
||||||
|
docker run --rm -it \
|
||||||
|
--mount type=volume,source=vaultwarden-rclone-data,target=/config/ \
|
||||||
|
ttionya/vaultwarden-backup:latest \
|
||||||
|
rclone config show
|
||||||
|
|
||||||
|
# [BitwardenBackup] <- 就是它
|
||||||
|
# ...
|
||||||
|
```
|
||||||
|
|
||||||
默认值:`BitwardenBackup`
|
默认值:`BitwardenBackup`
|
||||||
|
|
||||||
@@ -242,19 +254,19 @@ Rclone 全局参数,详见 [flags](https://rclone.org/flags/)。
|
|||||||
|
|
||||||
#### CRON
|
#### CRON
|
||||||
|
|
||||||
`crond` 的规则,它基于 Linux `crond`。你可以在 [这里](https://crontab.guru/#5_*_*_*_*) 进行测试。
|
`crond` 的规则,它基于 [`supercronic`](https://github.com/aptible/supercronic)。你可以在 [这里](https://crontab.guru/#5_*_*_*_*) 进行测试。
|
||||||
|
|
||||||
默认值:`5 * * * *` (每小时的 05 分自动备份)
|
默认值:`5 * * * *` (每小时的 05 分自动备份)
|
||||||
|
|
||||||
#### ZIP_ENABLE
|
#### ZIP_ENABLE
|
||||||
|
|
||||||
将备份文件打包为 Zip 文件。当设置为 `'FALSE'` 时,会单独上传备份文件。
|
将所有备份文件打包为压缩文件。当设置为 `'FALSE'` 时,会单独上传每个备份文件。
|
||||||
|
|
||||||
默认值:`TRUE`
|
默认值:`TRUE`
|
||||||
|
|
||||||
#### ZIP_PASSWORD
|
#### ZIP_PASSWORD
|
||||||
|
|
||||||
使用密码加密打包的备份文件。请注意,打包备份文件时将始终使用密码。
|
压缩文件的密码。请注意,打包备份文件时始终会使用密码。
|
||||||
|
|
||||||
默认值:`WHEREISMYPASSWORD?`
|
默认值:`WHEREISMYPASSWORD?`
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user