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 user-agent documentation to aggregator

Browse source
This commit is contained in:
koplas 2024-08-01 15:43:35 +02:00
parent 1a2ce684ff
commit 13a635c7e3
No known key found for this signature in database
1 changed files with 12 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/csaf_aggregator.md
View file

@ -16,6 +16,7 @@ Help Options:
``` ```
If no config file is explictly given the follwing places are searched for a config file: If no config file is explictly given the follwing places are searched for a config file:
``` ```
~/.config/csaf/aggregator.toml ~/.config/csaf/aggregator.toml
~/.csaf_aggregator.toml ~/.csaf_aggregator.toml
@ -25,6 +26,7 @@ csaf_aggregator.toml
with `~` expanding to `$HOME` on unixoid systems and `%HOMEPATH` on Windows systems. with `~` expanding to `$HOME` on unixoid systems and `%HOMEPATH` on Windows systems.
Usage example for a single run, to test if the config is good: Usage example for a single run, to test if the config is good:
```bash ```bash
./csaf_aggregator -c docs/examples/aggregator.toml ./csaf_aggregator -c docs/examples/aggregator.toml
``` ```
@ -62,7 +64,6 @@ SHELL=/bin/bash
30 0-23 * * * $HOME/bin/csaf_aggregator --config /etc/csaf_aggregator.toml --interim >> /var/log/csaf_aggregator/interim.log 2>&1 30 0-23 * * * $HOME/bin/csaf_aggregator --config /etc/csaf_aggregator.toml --interim >> /var/log/csaf_aggregator/interim.log 2>&1
``` ```
#### serve via web server #### serve via web server
Serve the paths where the aggregator writes its `html/` output Serve the paths where the aggregator writes its `html/` output
@ -78,7 +79,6 @@ a template. For the aggregator the difference is that you can leave out
the cgi-bin part, potentially commend out the TLS client parts and the cgi-bin part, potentially commend out the TLS client parts and
adjust the `root` path accordingly. adjust the `root` path accordingly.
### config options ### config options
The config file is written in [TOML](https://toml.io/en/v1.0.0). The config file is written in [TOML](https://toml.io/en/v1.0.0).
@ -118,10 +118,12 @@ Next we have two TOML _tables_:
aggregator // basic infos for the aggregator object aggregator // basic infos for the aggregator object
remote_validator // config for optional remote validation checker remote_validator // config for optional remote validation checker
``` ```
[See the provider config](csaf_provider.md#provider-options) about [See the provider config](csaf_provider.md#provider-options) about
how to configure `remote_validator`. how to configure `remote_validator`.
At last there is the TOML _array of tables_: At last there is the TOML _array of tables_:
``` ```
providers // each entry to be mirrored or listed providers // each entry to be mirrored or listed
``` ```
@ -148,6 +150,9 @@ header
Where valid `name` and `domain` settings are required. Where valid `name` and `domain` settings are required.
If no user agent is specified with `header = "user-agent:custom-agent/1.0"`
then the default agent in the form of `csaf_distribution/VERSION` is sent.
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.
@ -165,15 +170,16 @@ To offer an easy way of assorting CSAF documents by criteria like
document category, languages or values of the branch category within document category, languages or values of the branch category within
the product tree, ROLIE category values can be configured in `categories`. the product tree, ROLIE category values can be configured in `categories`.
This can either This can either
be done using an array of strings taken literally or, by prepending `"expr:"`. be done using an array of strings taken literally or, by prepending `"expr:"`.
The latter is evaluated as JSONPath and the result will be added into the The latter is evaluated as JSONPath and the result will be added into the
categories document. For a more detailed explanation and examples, categories document. For a more detailed explanation and examples,
[refer to the provider config](csaf_provider.md#provider-options). [refer to the provider config](csaf_provider.md#provider-options).
#### 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 -->
```toml ```toml
workers = 2 workers = 2
folder = "/var/csaf_aggregator" folder = "/var/csaf_aggregator"
@ -233,8 +239,8 @@ insecure = true
category = "lister" category = "lister"
# ignore_pattern = [".*white.*", ".*red.*"] # ignore_pattern = [".*white.*", ".*red.*"]
``` ```
<!-- MARKDOWN-AUTO-DOCS:END -->
<!-- MARKDOWN-AUTO-DOCS:END -->
#### Publish others' advisories #### Publish others' advisories