docs: update README

2023-03-18 21:35:23 +08:00
parent 434bfed0c0
commit c992b27db3
3 changed files with 38 additions and 0 deletions
@@ -493,6 +493,7 @@ We recommend re-downloading the `docker-compose.yml` file, replacing your enviro

 - [Run as non-root user](docs/run-as-non-root-user.md)
 - [Multiple remote destinations](docs/multiple-remote-destinations.md)
+- [Manually trigger a backup](docs/manually-trigger-a-backup.md)
 - [Using the PostgreSQL backend](docs/using-the-postgresql-backend.md)
 - [Using the MySQL(MariaDB) backend](docs/using-the-mysql-or-mariadb-backend.md)

@@ -490,6 +490,7 @@ 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)
+- [手动触发备份](docs/manually-trigger-a-backup.md)
 - [使用 PostgreSQL 数据库](docs/using-the-postgresql-backend.md)
 - [使用 MySQL(MariaDB) 数据库](docs/using-the-mysql-or-mariadb-backend.md)

@@ -0,0 +1,36 @@
+# Manually trigger a backup
+
+Sometimes, it's necessary to manually trigger backup actions.
+
+This can be useful when other programs are used to consistently schedule tasks or to verify that environment variables are properly configured.
+
+<br>
+
+
+
+## Usage
+
+Previously, performing an immediate backup required overwriting the entrypoint of the image. However, with the new setup, you can perform a backup directly with a parameterless command.
+
+```shell
+docker run \
+  --rm \
+  --name vaultwarden_backup \
+  --volumes-from=vaultwarden \
+  --mount type=volume,source=vaultwarden-rclone-data,target=/config/ \
+  -e ... \
+  ttionya/vaultwarden-backup:latest backup
+```
+
+You also need to mount the rclone config file and set the environment variables.
+
+The only difference is that the environment variable `CRON` does not work because it does not start the CRON program, but exits the container after the backup is done.
+
+<br>
+
+
+
+## IMPORTANT
+
+**Manually triggering a backup only verifies that the environment variables are configured correctly, not that CRON is working properly. This is the [issue](https://github.com/ttionya/vaultwarden-backup/issues/53) that CRON may not work properly on ARM devices.**
+