From bb0a30aba3d60214a7ceacb9d06fa5b014b6446e Mon Sep 17 00:00:00 2001 From: JanHoefelmeyer <107021473+JanHoefelmeyer@users.noreply.github.com> Date: Fri, 17 Jun 2022 09:26:27 +0200 Subject: [PATCH] Improve provider docs * Add issuing_authority and contact_details to publisher info example in docs/csaf_provider.md. * Add a link to toml's website. --- docs/csaf_provider.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/csaf_provider.md b/docs/csaf_provider.md index e17a383..bddd018 100644 --- a/docs/csaf_provider.md +++ b/docs/csaf_provider.md @@ -1,5 +1,5 @@ `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) 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.list_on_CSAF_aggregators: List 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."}`.