From 006f088082f615dfd975e024a7da9869f4fac2b4 Mon Sep 17 00:00:00 2001
From: Bernhard Reiter <bernhard@intevation.de>
Date: Fri, 10 Jun 2022 17:27:33 +0200
Subject: [PATCH] Improve checker documentation for config file

 * Move the config variables which could be specified as tables in TOML
   to the bottom of the documentation, to avoid that a regular toplevel
   variable is used below them (which would be wrong in TOML).
 * Be more specific about the value of the `upload_limit`.
---
 docs/csaf_provider.md | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/docs/csaf_provider.md b/docs/csaf_provider.md
index 81dd7fd..a54662e 100644
--- a/docs/csaf_provider.md
+++ b/docs/csaf_provider.md
@@ -12,19 +12,19 @@ Following options are supported in the config file:
  - openpgp_private_key: The private OpenPGP key. Default: `/ust/lib/csaf/openpgp_private.asc`
  - folder: Specify the root folder. Default: `/var/www/`.
  - web: Specify the web folder. Default: `/var/www/html`.
- - tlps: Set the allowed TLP comming with the upload request (one or more of "csaf", "white", "amber", "green", "red").
-   The "csaf" selection lets the provider takes the value from the CSAF document.
-   These affects the list items in the web interface.
-   Default: `["csaf", "white", "amber", "green", "red"]`.
  - upload_signature: Send signature with the request, an additional input-field in the web interface will be shown to let user enter an ascii armored signature. Default: `false`.
  - canonical_url_prefix: start of the URL where contents shall be accessible from the internet. Default: `https://$SERVER_NAME`.
  - no_passphrase: Let user send password with the request, if set to true the input-field in the web interface will be disappeared. Default: `false`.
  - no_validation: Validate the uploaded CSAF document against the JSON schema. Default: `false`.
  - no_web_ui: Disable the web interface. Default: `false`.
  - dynamic_provider_metadata: Take the publisher from the CSAF document. Default: `false`.
+ - upload_limit: Set the upload limit size of a file in bytes. Default: `52428800` (aka 50 MiB).
+ - issuer: The issuer of the CA, which if set, restricts the writing permission and the accessing to the web-interface to only the client certificates signed with this CA.
+ - tlps: Set the allowed TLP comming with the upload request (one or more of "csaf", "white", "amber", "green", "red").
+   The "csaf" selection lets the provider takes the value from the CSAF document.
+   These affects the list items in the web interface.
+   Default: `["csaf", "white", "amber", "green", "red"]`.
  - 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", "namespace"= "https://example.com"}`.
- - upload_limit: Set the upload limit  size of the file. Default: `50 MiB`.
- - issuer: The issuer of the CA, which if set, restricts the writing permission and the accessing to the web-interface to only the client certificates signed with this CA.