add more config option documentation

This commit is contained in:
Willy Kloucek
2022-06-13 15:45:24 +02:00
parent d1f01fdf67
commit 751b90f332
65 changed files with 116 additions and 116 deletions
+3 -3
View File
@@ -19,19 +19,19 @@ type Log struct {
// Tracing defines the available tracing configuration.
type Tracing struct {
Enabled bool `yaml:"enabled" env:"OCIS_TRACING_ENABLED"`
Type string `yaml:"type" env:"OCIS_TRACING_TYPE"`
Type string `yaml:"type" env:"OCIS_TRACING_TYPE" desc:"The type of tracing. Defaults to \"\", which is the same as \"jaeger\". Allowed tracing types are \"jaeger\" and \"\" as of now."`
Endpoint string `yaml:"endpoint" env:"OCIS_TRACING_ENDPOINT"`
Collector string `yaml:"collector" env:"OCIS_TRACING_COLLECTOR"`
}
// TokenManager is the config for using the reva token manager
type TokenManager struct {
JWTSecret string `yaml:"jwt_secret" env:"OCIS_JWT_SECRET" desc:"The secret to mint jwt tokens."`
JWTSecret string `yaml:"jwt_secret" env:"OCIS_JWT_SECRET" desc:"The secret to mint and validate jwt tokens."`
}
// Reva defines all available REVA configuration.
type Reva struct {
Address string `yaml:"address" env:"REVA_GATEWAY"`
Address string `yaml:"address" env:"REVA_GATEWAY" desc:"The CS3 gateway endpoint"`
}
// Commons holds configuration that are common to all extensions. Each extension can then decide whether