SystemSh0cker/gocsaf
1
0
Fork 0
mirror of https://github.com/gocsaf/csaf.git synced 2025-12-22 05:40:11 +01:00
Code Issues Releases Activity Actions

Add documention for update_interval (#281)

Browse source 
Add documentation for new option "update_interval" and behavior from #278.
This commit is contained in:
mfd2007 2022-08-17 13:15:03 +02:00 • committed by GitHub
parent 4f3f7efd5a
commit 06bd16db47
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/csaf_aggregator.md
View file

@ -103,6 +103,7 @@ rate
insecure insecure
write_indices write_indices
category category
update_interval
``` ```
If you want an entry to be listed instead of mirrored 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. set `category` to `lister` in the entry.
Otherwise it is recommended to not set `category` for entries. 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 #### Example config file
<!-- MARKDOWN-AUTO-DOCS:START (CODE:src=../docs/examples/aggregator.toml) --> <!-- MARKDOWN-AUTO-DOCS:START (CODE:src=../docs/examples/aggregator.toml) -->
<!-- The below code snippet is automatically added from ../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 # rate = 1.5
# insecure = true # insecure = true
[[providers]] [[providers]]
name = "local-dev-provider2" name = "local-dev-provider2"
domain = "https://localhost:8443/.well-known/csaf/provider-metadata.json" domain = "https://localhost:8443/.well-known/csaf/provider-metadata.json"
# rate = 1.2 # rate = 1.2
# insecure = true # insecure = true
write_indices = true write_indices = true
# Default value: "on best effort"
update_interval = "monthly"
[[providers]] [[providers]]
name = "local-dev-provider3" name = "local-dev-provider3"