add run_interval feature documentation and examples

pchang388 · pchang388 · commit 20cfee191c59 · 2025-02-14T04:50:22.000-05:00
diff --git a/README.md b/README.md
@@ -150,6 +150,11 @@ docker run \
     homeylab/bookstack-file-exporter:latest
 ```
 
+#### Docker Compose
+When using the configuration option: `run_interval`, a docker compose set up could be used to run the exporter as an always running application. The exporter will sleep and wait until `{run_interval}` seconds has elapsed before subsequent runs.
+
+An example is shown in `examples/docker-compose.yaml`
+
 #### Environment Variables
 See [Valid Environment Variables](#valid-environment-variables) for more options.
 
@@ -256,6 +261,7 @@ More descriptions can be found for each section below:
 | `assets.export_meta` | `bool` | `false` | Optional (default: `false`), export of metadata about the page in a json file |
 | `assets.verify_ssl` | `bool` | `false` | Optional (default: `true`), whether or not to check ssl certificates when requesting content from Bookstack host |
 | `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 |
+| `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 |
 | `minio` | `object` | `false` | Optional [Minio](#minio-backups) configuration options. |
 
 #### Valid Environment Variables
diff --git a/bookstack_file_exporter/config_helper/models.py b/bookstack_file_exporter/config_helper/models.py
@@ -39,4 +39,4 @@ class UserInput(BaseModel):
     assets: Optional[Assets] = Assets()
     minio: Optional[ObjectStorageConfig] = None
     keep_last: Optional[int] = None
-    run_interval: Optional[int] = None
+    run_interval: Optional[int] = 0
diff --git a/examples/config.yml b/examples/config.yml
@@ -52,3 +52,8 @@ output_path: "bkps/"
 # set to 1+ if you want to retain a certain number of archives
 # set to 0 or comment out section if you want no action done
 keep_last: 5
+## optional - if specified exporter will run in a loop
+# it will run and then pause for {run_interval} seconds before running again
+# specify in seconds, example: 86400 seconds = 24 hours or run once a day
+# omit/commit out or set to 0 if you just want a single run and exit
+run_interval: 0
diff --git a/examples/minio_config.yml b/examples/minio_config.yml
@@ -82,4 +82,9 @@ clean_up: true
 # - this is useful if you only want to upload to object storage
 # set to 1+ if you want to retain a certain number of archives
 # set to 0 or comment out section if you want no action done
-keep_last: -1
+keep_last: -1
+## optional - if specified exporter will run in a loop
+# it will run and then pause for {run_interval} seconds before running again
+# specify in seconds, example: 86400 seconds = 24 hours or run once a day
+# omit/commit out or set to 0 if you just want a single run and exit
+run_interval: 0
