Skip to content

Commit 6f4520e

Browse files
authored
Merge pull request #56 from homeylab/update_readme_new
update description on application mode
2 parents 7f33b1f + bd5ffff commit 6f4520e

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ What it does:
3636
- Can be run via [Python](#run-via-pip) or [Docker](#run-via-docker)
3737
- Can push archives to remote object storage like [Minio](https://min.io/)
3838
- Basic housekeeping option (`keep_last`) to keep a tidy archive destination
39+
- Can run in application mode (always running) using `run_interval` property. Used for basic scheduling of backups.
3940

4041
Supported backup targets are:
4142

@@ -262,7 +263,7 @@ More descriptions can be found for each section below:
262263
| `assets.export_meta` | `bool` | `false` | Optional (default: `false`), export of metadata about the page in a json file |
263264
| `assets.verify_ssl` | `bool` | `false` | Optional (default: `true`), whether or not to check ssl certificates when requesting content from Bookstack host |
264265
| `keep_last` | `int` | `false` | Optional (default: `None`), if exporter can delete older archives. valid values are:<br>- set to `-1` if you want to delete all archives after each run (useful if you only want to upload to object storage)<br>- set to `1+` if you want to retain a certain number of archives<br>- `0` will result in no action done |
265-
| `run_interval` | `int` | `false` | Optional (default: `0`). If specified, exporter will run in a loop and pause for `{run_interval}` seconds before subsequent runs. Example: `86400` seconds = `24` hours or run once a day. Setting this property to `0` will disable looping |
266+
| `run_interval` | `int` | `false` | Optional (default: `0`). If specified, exporter will run as an application and pause for `{run_interval}` seconds before subsequent runs. Example: `86400` seconds = `24` hours or run once a day. Setting this property to `0` will invoke a single run and exit. Used for basic scheduling of backups. |
266267
| `minio` | `object` | `false` | Optional [Minio](#minio-backups) configuration options. |
267268

268269
#### Valid Environment Variables

0 commit comments

Comments
 (0)