From 06bd16db477ea3aa84f93ea6651dac73a64a63d2 Mon Sep 17 00:00:00 2001
From: mfd2007 <58845044+mfd2007@users.noreply.github.com>
Date: Wed, 17 Aug 2022 13:15:03 +0200
Subject: [PATCH] Add documention for update_interval (#281)

Add documentation for new option "update_interval" and behavior from #278.
---
 docs/csaf_aggregator.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/docs/csaf_aggregator.md b/docs/csaf_aggregator.md
index da0a44c..9bd9e79 100644
--- a/docs/csaf_aggregator.md
+++ b/docs/csaf_aggregator.md
@@ -103,6 +103,7 @@ rate
 insecure
 write_indices
 category
+update_interval
 ```
 
 If you want an entry to be listed instead of mirrored
@@ -110,6 +111,12 @@ in a `aggregator.category == "aggregator"` instance,
 set `category` to `lister` in the entry.
 Otherwise it is recommended to not set `category` for entries.
 
+If a provider's domain starts with https:// its considered a publisher.
+These publishers are added to the csaf_publishers list instead of the csaf_providers list which was used before.
+
+The mandatory value of update_interval can be configured for each publisher (provider) individually. If not given it falls back
+to the global update_interval. If this is not given either the default is "on best effort".
+
 #### Example config file
 <!-- MARKDOWN-AUTO-DOCS:START (CODE:src=../docs/examples/aggregator.toml) -->
 <!-- The below code snippet is automatically added from ../docs/examples/aggregator.toml -->
@@ -148,12 +155,15 @@ insecure = true
 #  rate = 1.5
 #  insecure = true
 
+
 [[providers]]
   name = "local-dev-provider2"
   domain = "https://localhost:8443/.well-known/csaf/provider-metadata.json"
 #  rate = 1.2
 #  insecure = true
   write_indices = true
+#  Default value: "on best effort"
+  update_interval = "monthly"
 
 [[providers]]
   name = "local-dev-provider3"