martinan/vaultwarden-backup
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README

Browse Source
This commit is contained in:
ttionya
2022-07-01 00:44:38 +08:00
parent c24263dd25
commit 848e7fae9b
2 changed files with 35 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+18 -6
View File
@@ -218,11 +218,23 @@ You need to use this option to specify the `sends.tar` file.
## 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, 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`
@@ -236,25 +248,25 @@ Default: `/BitwardenBackup/`
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: `''`
#### 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)
#### 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`
#### 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?`