From 02774a53781cfa6f4923f2c6ee1c93618ef1c544 Mon Sep 17 00:00:00 2001 From: Willy Kloucek Date: Fri, 8 Jul 2022 15:32:26 +0200 Subject: [PATCH] add missing config descriptions --- services/frontend/pkg/config/config.go | 2 +- services/idp/pkg/config/http.go | 6 +++--- services/ocdav/pkg/config/config.go | 2 +- services/proxy/pkg/config/http.go | 6 +++--- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/services/frontend/pkg/config/config.go b/services/frontend/pkg/config/config.go index 066c23b78..3d8cef6b1 100644 --- a/services/frontend/pkg/config/config.go +++ b/services/frontend/pkg/config/config.go @@ -101,7 +101,7 @@ type Archiver struct { } type DataGateway struct { - Prefix string `yaml:"prefix" env:"FRONTEND_DATA_GATEWAY_PREFIX"` + Prefix string `yaml:"prefix" env:"FRONTEND_DATA_GATEWAY_PREFIX" desc:"Path prefix for the data gateway."` } type OCS struct { diff --git a/services/idp/pkg/config/http.go b/services/idp/pkg/config/http.go index 8051caa73..02a31415b 100644 --- a/services/idp/pkg/config/http.go +++ b/services/idp/pkg/config/http.go @@ -5,7 +5,7 @@ type HTTP struct { Addr string `yaml:"addr" env:"IDP_HTTP_ADDR" desc:"The bind address of the HTTP service."` Root string `yaml:"root" env:"IDP_HTTP_ROOT" desc:"Subdirectory that serves as the root for this HTTP service."` Namespace string `yaml:"-"` - TLSCert string `yaml:"tls_cert" env:"IDP_TRANSPORT_TLS_CERT"` - TLSKey string `yaml:"tls_key" env:"IDP_TRANSPORT_TLS_KEY"` - TLS bool `yaml:"tls" env:"IDP_TLS"` + TLSCert string `yaml:"tls_cert" env:"IDP_TRANSPORT_TLS_CERT" desc:"File name of the TLS server certificate for the HTTPS server."` + TLSKey string `yaml:"tls_key" env:"IDP_TRANSPORT_TLS_KEY" desc:"File name of the TLS server certificate key for the HTTPS server."` + TLS bool `yaml:"tls" env:"IDP_TLS" desc:"Use HTTPS server instead of HTTP server."` } diff --git a/services/ocdav/pkg/config/config.go b/services/ocdav/pkg/config/config.go index 1735ebff4..3ed98bf3e 100644 --- a/services/ocdav/pkg/config/config.go +++ b/services/ocdav/pkg/config/config.go @@ -27,7 +27,7 @@ type Config struct { PublicURL string `yaml:"public_url" env:"OCIS_URL;OCDAV_PUBLIC_URL" desc:"URL where oCIS is reachable for users."` // Insecure certificates allowed when making requests to the gateway - Insecure bool `yaml:"insecure" env:"OCIS_INSECURE;OCDAV_INSECURE"` + Insecure bool `yaml:"insecure" env:"OCIS_INSECURE;OCDAV_INSECURE" desc:"Allow insecure connections to the GATEWAY service."` // Timeout in seconds when making requests to the gateway Timeout int64 `yaml:"gateway_request_timeout" env:"OCDAV_GATEWAY_REQUEST_TIMEOUT" desc:"Request timeout in seconds for requests from the oCDAV service to the GATEWAY service."` Middleware Middleware `yaml:"middleware"` diff --git a/services/proxy/pkg/config/http.go b/services/proxy/pkg/config/http.go index 10d979eb4..7a29b8dde 100644 --- a/services/proxy/pkg/config/http.go +++ b/services/proxy/pkg/config/http.go @@ -5,7 +5,7 @@ type HTTP struct { Addr string `yaml:"addr" env:"PROXY_HTTP_ADDR" desc:"The bind address of the HTTP service."` Root string `yaml:"root" env:"PROXY_HTTP_ROOT" desc:"Subdirectory that serves as the root for this HTTP service."` Namespace string `yaml:"-"` - TLSCert string `yaml:"tls_cert" env:"PROXY_TRANSPORT_TLS_CERT"` - TLSKey string `yaml:"tls_key" env:"PROXY_TRANSPORT_TLS_KEY"` - TLS bool `yaml:"tls" env:"PROXY_TLS"` + TLSCert string `yaml:"tls_cert" env:"PROXY_TRANSPORT_TLS_CERT" desc:"File name of the TLS server certificate for the HTTPS server."` + TLSKey string `yaml:"tls_key" env:"PROXY_TRANSPORT_TLS_KEY" desc:"File name of the TLS server certificate key for the HTTPS server."` + TLS bool `yaml:"tls" env:"PROXY_TLS" desc:"Use HTTPS server instead of HTTP server."` }