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

Further improve documentation for aggregator

Browse source
This commit is contained in:
Bernhard Reiter 2023-01-26 16:30:27 +01:00
parent de64b88491
commit c143a4620b
No known key found for this signature in database
GPG key ID: 2B7BA3BF9BC3A554
1 changed files with 7 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/csaf_aggregator.md
View file

@ -111,12 +111,13 @@ 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. If a provider's domain starts with `https://` it is considered a publisher.
These publishers are added to the `csaf_publishers` list. These publishers are added to the `csaf_publishers` list, written
Each publisher must announce an `update_interval`. to the resulting `aggregator.json`.
This can be configured for each entry. Each publisher must announce an `update_interval` there.
If not given it is taken from the global `update_interval` This can be configured for each entry, by the config option with the same name.
and otherwise the default is "on best effort". If not given it is taken from the configured default
and otherwise the internal 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) -->