Document provider config options #40
Conversation
|
Again I think, we may improve the point by generating the documentation, if this is easily possible. |
|
As for implementing the documentation as part of the config code, e.g. in cmd/csaf_provider/config.go`: The toml library does not yet support handling of comments, see BurntSushi/toml#328 |
docs/provider-setup.md
Outdated
| 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`. | ||
| - openpgp_url: URL to OpenPGP key-server. Default: `https://openpgp.circl.lu`. | ||
| - domain: The domain name. Default: `http://$SERVER_NAME`. |
There was a problem hiding this comment.
@s-l-teichmann the domain config options is a bit unbalanced. It is called domain, but in the code, the value will be taken as base_url. And then there is http: which is okay for development, but not as default I guess. What about renaming it to serve_url and then default it to https://$SERVER_NAME or so. Where does the name SERVER_NAME come from? My search engine does not tell me it is a standard environment variable. For development either localhost or $hostname would be alternatives. What do you think?
There was a problem hiding this comment.
@s-l-teichmann ping
There was a problem hiding this comment.
@bernhardreiter SERVER_NAME is an env var from CGI [1].
[1] https://datatracker.ietf.org/doc/html/rfc3875#section-4.1.14
There was a problem hiding this comment.
@s-l-teichmann Thanks for answering the second part. What about remaining domain to serve_url for the reasons outlined?
There was a problem hiding this comment.
@bernhardreiter We could use https:// as a default, sure.
Concerning domain ... my bike shed opinion would more tend to something like canonical_url_prefix.
There was a problem hiding this comment.
Okay, changed to canonical_url_prefix.
Co-authored-by: tschmidtb51 <65305130+tschmidtb51@users.noreply.github.com>
* Moving from `domain` to `canonical_prefix_url`. Using `https` as default.
No description provided.