From ed9e0265792428c2ef1f3636ef66c60174bc00af Mon Sep 17 00:00:00 2001 From: Bernhard Reiter Date: Mon, 16 May 2022 16:21:16 +0200 Subject: [PATCH] Improve documentation * Fix doc long optionsname for the uploader. * Add more infos to the provider doc. --- docs/csaf_provider.md | 8 +++++++- docs/csaf_uploader.md | 2 +- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/csaf_provider.md b/docs/csaf_provider.md index 311b006..94c2086 100644 --- a/docs/csaf_provider.md +++ b/docs/csaf_provider.md @@ -1,5 +1,11 @@ +`csaf_provider` implements the CGI interface for webservers +and reads its configuration from a TOML file. +See the [../README.md#setup-trusted-provider] section on how to +set this up with a webserver and the place for the config file. + ## Provider options -Following options are supported: + +Following options are supported in the config file: - password: Authentication password for accessing the CSAF provider. - key: The private OpenPGP key. diff --git a/docs/csaf_uploader.md b/docs/csaf_uploader.md index 51889ab..b95d64a 100644 --- a/docs/csaf_uploader.md +++ b/docs/csaf_uploader.md @@ -19,7 +19,7 @@ Application Options: --client-cert=CERT-FILE.crt TLS client certificate file (PEM encoded data) --client-key=KEY-FILE.pem TLS client private key file (PEM encoded data) -i, --password-interactive Enter password interactively - -I, --passphrase-interacive Enter passphrase interactively + -I, --passphrase-interactive Enter passphrase interactively --insecure Do not check TLS certificates from provider -c, --config=INI-FILE Path to config ini file --version Display version of the binary