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

Adds explanations about which options are mandatory and which are optional

Browse source
This commit is contained in:
JanHoefelmeyer 2023-02-27 17:59:41 +01:00 • committed by Sascha L. Teichmann
parent f38cff13d6
commit bebeec30e0
1 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/csaf_aggregator.md
View file

@ -92,6 +92,8 @@ aggregator // table with basic infos for the aggregator object
providers // array of tables, each entry to be mirrored or listed providers // array of tables, each entry to be mirrored or listed
``` ```
At least 2 providers have to be configured. The other options are optional.
Rates are specified as floats in HTTPS operations per second. Rates are specified as floats in HTTPS operations per second.
0 means no limit. The rates can be specified per provider. Any provider 0 means no limit. The rates can be specified per provider. Any provider
which has no specified rate will use the configured default. If which has no specified rate will use the configured default. If
@ -108,6 +110,9 @@ category
update_interval update_interval
``` ```
Any provider needs a valid name and domain. The other
options are optional.
If you want an entry to be listed instead of mirrored If you want an entry to be listed instead of mirrored
in a `aggregator.category == "aggregator"` instance, in a `aggregator.category == "aggregator"` instance,
set `category` to `lister` in the entry. set `category` to `lister` in the entry.