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

Improve provider docs

Browse source 
* Add issuing_authority and contact_details to publisher info example
   in docs/csaf_provider.md.
* Add a link to toml's website.
This commit is contained in:
JanHoefelmeyer 2022-06-17 09:26:27 +02:00 • committed by GitHub
parent fa434fa039
commit bb0a30aba3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/csaf_provider.md
View file

@ -1,5 +1,5 @@
`csaf_provider` implements the CGI interface for webservers `csaf_provider` implements the CGI interface for webservers
and reads its configuration from a TOML file. and reads its configuration from a [TOML](https://toml.io/en/) file.
The [setup docs](../README.md#setup-trusted-provider) The [setup docs](../README.md#setup-trusted-provider)
explain how to wire this up with nginx and where the config file lives. explain how to wire this up with nginx and where the config file lives.
@ -27,4 +27,4 @@ Following options are supported in the config file:
- provider_metadata: Configure the provider metadata. - provider_metadata: Configure the provider metadata.
- provider_metadata.list_on_CSAF_aggregators: List on aggregators - provider_metadata.list_on_CSAF_aggregators: List on aggregators
- provider_metadata.mirror_on_CSAF_aggregators: Mirror on aggregators - provider_metadata.mirror_on_CSAF_aggregators: Mirror on aggregators
- provider_metadata.publisher: Set the publisher. Default: `{"category"= "vendor", "name"= "Example Company", "namespace"= "https://example.com"}`. - provider_metadata.publisher: Set the publisher. Default: `{"category"= "vendor", "name"= "Example Company", "namespace"= "https://example.com", "issuing_authority"= "We at Example Company are responsible for publishing and maintaining Product Y.", "contact_details"= "Example Company can be reached at contact_us@example.com, or via our website at https://www.example.com/contact."}`.