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

Improve provider docs

Browse source 
* Rephrase link from setup-provider to csaf_provider options.
* Remove a few superfluous whitespace chars.
This commit is contained in:
JanHoefelmeyer 2022-06-21 15:43:03 +02:00 • committed by GitHub
parent 78d8b89aca
commit 1a6829c9ea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/csaf_provider.md
View file

@ -30,8 +30,8 @@ Following options are supported in the config file:
- provider_metadata.mirror_on_CSAF_aggregators: Mirror on aggregators - provider_metadata.mirror_on_CSAF_aggregators: Mirror on aggregators
- remote_validator: Use a remote validator service. Not used by default. - remote_validator: Use a remote validator service. Not used by default.
`{ "url" = "http://localhost:3000", "presets" = ["mandatory"], "cache" = "/var/lib/csaf/validations.db" }` `{ "url" = "http://localhost:3000", "presets" = ["mandatory"], "cache" = "/var/lib/csaf/validations.db" }`
- provider_metadata.publisher: Set the publisher. Default: - provider_metadata.publisher: Set the publisher. Default:
```toml ```toml
[provider_metadata.publisher] [provider_metadata.publisher]
category = "vendor" category = "vendor"
name = "Example Company" name = "Example Company"

10
docs/provider-setup.md
View file

@ -109,9 +109,13 @@ sudo chmod g+r,o-rwx /usr/lib/csaf/config.toml
``` ```
<!-- MARKDOWN-AUTO-DOCS:END --> <!-- MARKDOWN-AUTO-DOCS:END -->
**This and the other settings are just examples, please adjust permissions and paths** **This and the other settings are just examples,**
**according to your webserver and security needs** **please adjust permissions and paths**
with suitable [replacements](https://github.com/csaf-poc/csaf_distribution/blob/main/docs/csaf_provider.md) **according to your webserver and security needs.**
Here is a minimal example configuration,
which you need to customize for a production setup,
see the [options of `csaf_provider`](https://github.com/csaf-poc/csaf_distribution/blob/main/docs/csaf_provider.md).
<!-- MARKDOWN-AUTO-DOCS:START (CODE:src=../docs/scripts/setupProviderForITest.sh&lines=94-99) --> <!-- MARKDOWN-AUTO-DOCS:START (CODE:src=../docs/scripts/setupProviderForITest.sh&lines=94-99) -->
<!-- The below code snippet is automatically added from ../docs/scripts/setupProviderForITest.sh --> <!-- The below code snippet is automatically added from ../docs/scripts/setupProviderForITest.sh -->