From 73652ffd96acdc28004dd496e04a8275b8ab496a Mon Sep 17 00:00:00 2001 From: Christian Richter Date: Tue, 13 Feb 2024 13:25:52 +0100 Subject: [PATCH 01/10] add cli options to main.go Signed-off-by: Christian Richter --- docs/helpers/envvardeltas.go | 7 +++++++ docs/helpers/main.go | 40 ++++++++++++++++++++++++++++++++---- 2 files changed, 43 insertions(+), 4 deletions(-) create mode 100644 docs/helpers/envvardeltas.go diff --git a/docs/helpers/envvardeltas.go b/docs/helpers/envvardeltas.go new file mode 100644 index 0000000000..4dec070fc2 --- /dev/null +++ b/docs/helpers/envvardeltas.go @@ -0,0 +1,7 @@ +package main + +import "fmt" + +func RenderEnvVarDeltas() { + fmt.Println("RenderEnvVarDeltas") +} diff --git a/docs/helpers/main.go b/docs/helpers/main.go index 2f150567fb..08041d764b 100644 --- a/docs/helpers/main.go +++ b/docs/helpers/main.go @@ -1,8 +1,40 @@ package main +import ( + "fmt" + "os" +) + func main() { - RenderTemplates() - GetRogueEnvs() - RenderGlobalVarsTemplate() - GenerateServiceIndexMarkdowns() + if len(os.Args) > 1 { + switch os.Args[1] { + case "templates": + RenderTemplates() + case "rogue": + GetRogueEnvs() + case "globals": + RenderGlobalVarsTemplate() + case "service-index": + GenerateServiceIndexMarkdowns() + case "envvar-deltas": + RenderEnvVarDeltas() + case "all": + RenderTemplates() + GetRogueEnvs() + RenderGlobalVarsTemplate() + GenerateServiceIndexMarkdowns() + RenderEnvVarDeltas() + case "help": + fallthrough + default: + fmt.Println("Usage: [templates|rogue|globals|service-index|envvar-deltas|all]") + } + } else { + // Left here, even though present in the switch case, for backwards compatibility + RenderTemplates() + GetRogueEnvs() + RenderGlobalVarsTemplate() + GenerateServiceIndexMarkdowns() + RenderEnvVarDeltas() + } } From cd5847da1266e9f528c6fd2cbcbf4619a74abf36 Mon Sep 17 00:00:00 2001 From: Christian Richter Date: Tue, 13 Feb 2024 16:16:37 +0100 Subject: [PATCH 02/10] add env var yaml generator Signed-off-by: Christian Richter --- docs/helpers/configenvextractor.go | 12 +- docs/helpers/envvardeltas.go | 7 - docs/helpers/main.go | 6 +- .../{ => templates}/adoc-generator.go.tmpl | 0 .../templates/envar-delta-table.go.tmpl | 120 ++++++++++++++++++ ...nvironment-variable-docs-generator.go.tmpl | 0 .../example-config-generator.go.tmpl | 0 docs/helpers/{ => templates}/index.tmpl | 0 8 files changed, 129 insertions(+), 16 deletions(-) delete mode 100644 docs/helpers/envvardeltas.go rename docs/helpers/{ => templates}/adoc-generator.go.tmpl (100%) create mode 100644 docs/helpers/templates/envar-delta-table.go.tmpl rename docs/helpers/{ => templates}/environment-variable-docs-generator.go.tmpl (100%) rename docs/helpers/{ => templates}/example-config-generator.go.tmpl (100%) rename docs/helpers/{ => templates}/index.tmpl (100%) diff --git a/docs/helpers/configenvextractor.go b/docs/helpers/configenvextractor.go index 474a1fee3c..a553aa72b4 100644 --- a/docs/helpers/configenvextractor.go +++ b/docs/helpers/configenvextractor.go @@ -12,9 +12,10 @@ import ( ) var targets = map[string]string{ - "adoc-generator.go.tmpl": "output/adoc/adoc-generator.go", - "example-config-generator.go.tmpl": "output/exampleconfig/example-config-generator.go", - "environment-variable-docs-generator.go.tmpl": "output/env/environment-variable-docs-generator.go", + "templates/adoc-generator.go.tmpl": "output/adoc/adoc-generator.go", + "templates/example-config-generator.go.tmpl": "output/exampleconfig/example-config-generator.go", + "templates/environment-variable-docs-generator.go.tmpl": "output/env/environment-variable-docs-generator.go", + "templates/envar-delta-table.go.tmpl": "output/env/envvar-delta-table.go", } // RenderTemplates does something with templates @@ -37,7 +38,10 @@ func RenderTemplates() { runIntermediateCode(output) } fmt.Println("Cleaning up") - os.RemoveAll("output") + err = os.RemoveAll("output") + if err != nil { + fmt.Println(err) + } } func generateIntermediateCode(templatePath string, intermediateCodePath string, paths []string) { diff --git a/docs/helpers/envvardeltas.go b/docs/helpers/envvardeltas.go deleted file mode 100644 index 4dec070fc2..0000000000 --- a/docs/helpers/envvardeltas.go +++ /dev/null @@ -1,7 +0,0 @@ -package main - -import "fmt" - -func RenderEnvVarDeltas() { - fmt.Println("RenderEnvVarDeltas") -} diff --git a/docs/helpers/main.go b/docs/helpers/main.go index 08041d764b..7629a2e015 100644 --- a/docs/helpers/main.go +++ b/docs/helpers/main.go @@ -16,18 +16,15 @@ func main() { RenderGlobalVarsTemplate() case "service-index": GenerateServiceIndexMarkdowns() - case "envvar-deltas": - RenderEnvVarDeltas() case "all": RenderTemplates() GetRogueEnvs() RenderGlobalVarsTemplate() GenerateServiceIndexMarkdowns() - RenderEnvVarDeltas() case "help": fallthrough default: - fmt.Println("Usage: [templates|rogue|globals|service-index|envvar-deltas|all]") + fmt.Println("Usage: [templates|rogue|globals|service-index|all]") } } else { // Left here, even though present in the switch case, for backwards compatibility @@ -35,6 +32,5 @@ func main() { GetRogueEnvs() RenderGlobalVarsTemplate() GenerateServiceIndexMarkdowns() - RenderEnvVarDeltas() } } diff --git a/docs/helpers/adoc-generator.go.tmpl b/docs/helpers/templates/adoc-generator.go.tmpl similarity index 100% rename from docs/helpers/adoc-generator.go.tmpl rename to docs/helpers/templates/adoc-generator.go.tmpl diff --git a/docs/helpers/templates/envar-delta-table.go.tmpl b/docs/helpers/templates/envar-delta-table.go.tmpl new file mode 100644 index 0000000000..c1e3bd1682 --- /dev/null +++ b/docs/helpers/templates/envar-delta-table.go.tmpl @@ -0,0 +1,120 @@ +package main + +import ( + "fmt" + "gopkg.in/yaml.v2" + "html" + "reflect" + "strings" + "log" + "os" + "path/filepath" + + {{- range $key, $value :=.}} + pkg{{$key}} "{{$value}}" + {{- end}} +) + +const yamlSource = "env_vars.yaml" + +type ConfigField struct { + Name string `yaml:"name"` + DefaultValue string `yaml:"defaultValue"` + Type string `yaml:"type"` + Description string `yaml:"description"` + IntroductionVersion string `yaml:"introductionVersion"` + DeprecationVersion string `yaml:"deprecationVersion"` + RemovalVersion string `yaml:"removalVersion"` + DeprecationInfo string `yaml:"deprecationInfo"` +} + +func main() { + fmt.Println("Generating tables for env-var deltas") + var fields []ConfigField + configFields := make(map[string]ConfigField) + m := map[string]interface{}{ + {{- range $key, $value := .}} + "{{$value}}": *pkg{{$key}}.FullDefaultConfig(), + {{- end }} + } + for _, conf := range m { + fields = GetAnnotatedVariables(conf) + for _, field := range fields { + variants := strings.Split(field.Name, ";") + for _, variant := range variants { + if configFields[variant].Name == "" { + configFields[variant] = field + } else { + fmt.Println("Duplicate key: ", variant) + } + } + } + } + curdir, err := os.Getwd() + if err != nil { + log.Fatal(err) + } + fullYamlPath := filepath.Join(curdir, yamlSource) + output, err := yaml.Marshal(configFields) + if err != nil { + log.Fatalf("Could not marshall variables: %v", err) + } + err = os.WriteFile(fullYamlPath, output, 0666) + if err != nil { + log.Fatalf("could not write %s", fullYamlPath) + } + if err := os.Chdir(curdir); err != nil { + log.Fatal(err) + } +} + +func GetAnnotatedVariables(s interface{}) []ConfigField { + t := reflect.TypeOf(s) + v := reflect.ValueOf(s) + + var fields []ConfigField + for i := 0; i < t.NumField(); i++ { + field := t.Field(i) + value := v.Field(i) + + switch value.Kind() { + default: + desc := field.Tag.Get("desc") + env, ok := field.Tag.Lookup("env") + if !ok { + continue + } + introductionVersion := field.Tag.Get("introductionVersion") + deprecationVersion := field.Tag.Get("deprecationVersion") + removalVersion := field.Tag.Get("removalVersion") + deprecationInfo := field.Tag.Get("deprecationInfo") + v := fmt.Sprintf("%v", value.Interface()) + typeName := value.Type().Name() + if typeName == "" { + typeName = value.Type().String() + } + //fields = append(fields, ConfigField{Name: strings.ReplaceAll(env, ";", "
"), DefaultValue: html.EscapeString(strings.Replace(v, "|", "\\|", -1)), Description: desc, Type: typeName}) + fields = append(fields, ConfigField{ + Name: env, + DefaultValue: html.EscapeString(strings.Replace(v, "|", "\\|", -1)), + Description: desc, + Type: typeName, + IntroductionVersion: introductionVersion, + DeprecationVersion: deprecationVersion, + RemovalVersion: removalVersion, + DeprecationInfo: deprecationInfo, + }) + case reflect.Ptr: + // PolicySelectors in the Proxy are being skipped atm + // they are not configurable via env vars, if that changes + // they are probably added to the Sanitize() function + // and this should not be an issue then + if !value.IsZero() && value.Elem().CanInterface() { + fields = append(fields, GetAnnotatedVariables(value.Elem().Interface())...) + } + case reflect.Struct: + fields = append(fields, GetAnnotatedVariables(value.Interface())...) + } + } + return fields +} diff --git a/docs/helpers/environment-variable-docs-generator.go.tmpl b/docs/helpers/templates/environment-variable-docs-generator.go.tmpl similarity index 100% rename from docs/helpers/environment-variable-docs-generator.go.tmpl rename to docs/helpers/templates/environment-variable-docs-generator.go.tmpl diff --git a/docs/helpers/example-config-generator.go.tmpl b/docs/helpers/templates/example-config-generator.go.tmpl similarity index 100% rename from docs/helpers/example-config-generator.go.tmpl rename to docs/helpers/templates/example-config-generator.go.tmpl diff --git a/docs/helpers/index.tmpl b/docs/helpers/templates/index.tmpl similarity index 100% rename from docs/helpers/index.tmpl rename to docs/helpers/templates/index.tmpl From eec9abcbaa4c4fa7c2bdcceb1cfa5dba36455578 Mon Sep 17 00:00:00 2001 From: Christian Richter Date: Wed, 14 Feb 2024 11:25:05 +0100 Subject: [PATCH 03/10] merge existing data with new data Signed-off-by: Christian Richter --- .../templates/envar-delta-table.go.tmpl | 52 +++++++++++++++---- 1 file changed, 43 insertions(+), 9 deletions(-) diff --git a/docs/helpers/templates/envar-delta-table.go.tmpl b/docs/helpers/templates/envar-delta-table.go.tmpl index c1e3bd1682..c33fb7ee78 100644 --- a/docs/helpers/templates/envar-delta-table.go.tmpl +++ b/docs/helpers/templates/envar-delta-table.go.tmpl @@ -29,9 +29,22 @@ type ConfigField struct { } func main() { - fmt.Println("Generating tables for env-var deltas") + fmt.Println("Generating tables for env-var deltas...") + curdir, err := os.Getwd() + if err != nil { + log.Fatal(err) + } + fullYamlPath := filepath.Join(curdir, yamlSource) var fields []ConfigField - configFields := make(map[string]ConfigField) + configFields := make(map[string]*ConfigField) + fmt.Printf("Reading existing variable definitions from %s\n", fullYamlPath) + yfile, err := os.ReadFile(fullYamlPath) + if err == nil { + err := yaml.Unmarshal(yfile, configFields) + if err != nil { + log.Fatal(err) + } + } m := map[string]interface{}{ {{- range $key, $value := .}} "{{$value}}": *pkg{{$key}}.FullDefaultConfig(), @@ -43,18 +56,39 @@ func main() { variants := strings.Split(field.Name, ";") for _, variant := range variants { if configFields[variant].Name == "" { - configFields[variant] = field + configFields[variant] = &field } else { - fmt.Println("Duplicate key: ", variant) + fmt.Printf("%v, duplicate key, merging\n", variant) + if strings.TrimSpace(configFields[variant].DefaultValue) != "" && configFields[variant].DefaultValue != field.DefaultValue { + configFields[variant].DefaultValue = field.DefaultValue + } + if strings.TrimSpace(configFields[variant].Description) != "" && configFields[variant].Description != field.Description { + configFields[variant].Description = field.Description + } + if strings.TrimSpace(configFields[variant].Type) != "" && configFields[variant].Type != field.Type { + configFields[variant].Type = field.Type + } + if strings.TrimSpace(configFields[variant].IntroductionVersion) != "" && configFields[variant].IntroductionVersion != field.IntroductionVersion { + configFields[variant].IntroductionVersion = field.IntroductionVersion + } + if strings.TrimSpace(configFields[variant].DeprecationVersion) != "" && configFields[variant].DeprecationVersion != field.DeprecationVersion { + configFields[variant].DeprecationVersion = field.DeprecationVersion + } + if strings.TrimSpace(configFields[variant].RemovalVersion) != "" && configFields[variant].RemovalVersion != field.RemovalVersion { + configFields[variant].RemovalVersion = field.RemovalVersion + } + if strings.TrimSpace(configFields[variant].Name) != "" && configFields[variant].Name != field.Name { + configFields[variant].Name = field.Name + } + if strings.TrimSpace(configFields[variant].DeprecationInfo) != "" && configFields[variant].DeprecationInfo != field.DeprecationInfo { + // there might be multiple superseeding DeprecationInformations, we might want to keep track of those, that's why we are not overwriting the field + configFields[variant].DeprecationInfo = configFields[variant].DeprecationInfo + " | " + field.DeprecationInfo + } } } } } - curdir, err := os.Getwd() - if err != nil { - log.Fatal(err) - } - fullYamlPath := filepath.Join(curdir, yamlSource) + output, err := yaml.Marshal(configFields) if err != nil { log.Fatalf("Could not marshall variables: %v", err) From 2ca57fdc20f5bb6f0c5b72326817081565a2aa7b Mon Sep 17 00:00:00 2001 From: Christian Richter Date: Wed, 14 Feb 2024 17:13:02 +0100 Subject: [PATCH 04/10] add delta markdown generator Signed-off-by: Christian Richter --- docs/helpers/env-var-delta.go | 107 + docs/helpers/env_vars.yaml | 14921 ++++++++++++++++ docs/helpers/main.go | 11 +- docs/helpers/templates/env-vars-added.md.tmpl | 7 + .../templates/env-vars-deprecated.md.tmpl | 7 + .../templates/env-vars-removed.md.tmpl | 7 + 6 files changed, 15059 insertions(+), 1 deletion(-) create mode 100644 docs/helpers/env-var-delta.go create mode 100644 docs/helpers/env_vars.yaml create mode 100644 docs/helpers/templates/env-vars-added.md.tmpl create mode 100644 docs/helpers/templates/env-vars-deprecated.md.tmpl create mode 100644 docs/helpers/templates/env-vars-removed.md.tmpl diff --git a/docs/helpers/env-var-delta.go b/docs/helpers/env-var-delta.go new file mode 100644 index 0000000000..ee1f29d6e1 --- /dev/null +++ b/docs/helpers/env-var-delta.go @@ -0,0 +1,107 @@ +package main + +import ( + "fmt" + "github.com/rogpeppe/go-internal/semver" + "gopkg.in/yaml.v2" + "log" + "os" + "path/filepath" + "text/template" +) + +const envVarYamlSource = "env_vars.yaml" + +var envVarOutPutTemplates = map[string]string{ + "added": "templates/env-vars-added.md.tmpl", + "removed": "templates/env-vars-removed.md.tmpl", + "deprecated": "templates/env-vars-deprecated.md.tmpl", +} + +// ConfigField represents the env-var annotation in the code +type ConfigField struct { + Name string `yaml:"name"` + DefaultValue string `yaml:"defaultValue"` + Type string `yaml:"type"` + Description string `yaml:"description"` + IntroductionVersion string `yaml:"introductionVersion"` + DeprecationVersion string `yaml:"deprecationVersion"` + RemovalVersion string `yaml:"removalVersion"` + DeprecationInfo string `yaml:"deprecationInfo"` +} + +type TemplateData struct { + StartVersion string + EndVersion string + DeltaFields []*ConfigField +} + +// RenderEnvVarDeltaTable generates tables for env-var deltas +func RenderEnvVarDeltaTable(osArgs []string) { + if !semver.IsValid(osArgs[2]) { + log.Fatalf("Start version invalid semver: %s", osArgs[2]) + } + if !semver.IsValid(osArgs[3]) { + log.Fatalf("Target version invalid semver: %s", osArgs[3]) + } + startVersion := osArgs[2] + endVersion := osArgs[3] + fmt.Printf("Generating tables for env-var deltas between version %s and %s...\n", startVersion, endVersion) + curdir, err := os.Getwd() + if err != nil { + log.Fatal(err) + } + fullYamlPath := filepath.Join(curdir, envVarYamlSource) + configFields := make(map[string]*ConfigField) + variableList := map[string][]*ConfigField{ + "added": {}, + "removed": {}, + "deprecated": {}, + } + fmt.Printf("Reading existing variable definitions from %s\n", fullYamlPath) + yfile, err := os.ReadFile(fullYamlPath) + if err == nil { + err := yaml.Unmarshal(yfile, configFields) + if err != nil { + log.Fatal(err) + } + } + fmt.Printf("Success, found %d entries\n", len(configFields)) + for _, field := range configFields { + if field.DeprecationVersion != "" { + fmt.Printf("Processing field %s\n", field.Name) + } + if field.RemovalVersion != "" && semver.Compare(startVersion, field.RemovalVersion) < 0 && semver.Compare(endVersion, field.RemovalVersion) >= 0 { + variableList["removed"] = append(variableList["removed"], field) + } + if field.DeprecationVersion != "" && semver.Compare(startVersion, field.DeprecationVersion) <= 0 && semver.Compare(endVersion, field.DeprecationVersion) > 0 { + variableList["deprecated"] = append(variableList["deprecated"], field) + } + if field.IntroductionVersion != "" && semver.Compare(startVersion, field.IntroductionVersion) <= 0 && semver.Compare(endVersion, field.IntroductionVersion) > 0 { + variableList["added"] = append(variableList["added"], field) + } + } + for templateName, templatePath := range envVarOutPutTemplates { + content, err := os.ReadFile(templatePath) + if err != nil { + log.Fatal(err) + } + tpl := template.Must(template.New(templateName).Parse(string(content))) + err = os.MkdirAll("output/env-deltas", 0700) + if err != nil { + log.Fatal(err) + } + targetFile, err := os.Create(filepath.Join("output/env-deltas", fmt.Sprintf("%s-%s-%s.md", startVersion, endVersion, templateName))) + if err != nil { + log.Fatal(err) + } + err = tpl.Execute(targetFile, TemplateData{ + StartVersion: startVersion, + EndVersion: endVersion, + DeltaFields: variableList[templateName], + }) + if err != nil { + log.Fatal(err) + } + } +} diff --git a/docs/helpers/env_vars.yaml b/docs/helpers/env_vars.yaml new file mode 100644 index 0000000000..965330b496 --- /dev/null +++ b/docs/helpers/env_vars.yaml @@ -0,0 +1,14921 @@ +ANTIVIRUS_CLAMAV_SOCKET: + name: ANTIVIRUS_CLAMAV_SOCKET + defaultValue: /run/clamav/clamd.ctl + type: string + description: The socket clamav is running on. Note the default value is an example + which needs adaption according your OS. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_DEBUG_ADDR: + name: ANTIVIRUS_DEBUG_ADDR + defaultValue: 127.0.0.1:9277 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_DEBUG_PPROF: + name: ANTIVIRUS_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_DEBUG_SCAN_OUTCOME: + name: ANTIVIRUS_DEBUG_SCAN_OUTCOME + defaultValue: "" + type: string + description: 'A predefined outcome for virus scanning, FOR DEBUG PURPOSES ONLY! + (example values: ''found,infected'')' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_DEBUG_TOKEN: + name: ANTIVIRUS_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_DEBUG_ZPAGES: + name: ANTIVIRUS_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_EVENTS_AUTH_PASSWORD: + name: OCIS_EVENTS_AUTH_PASSWORD;ANTIVIRUS_EVENTS_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_EVENTS_AUTH_USERNAME: + name: OCIS_EVENTS_AUTH_USERNAME;ANTIVIRUS_EVENTS_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_EVENTS_CLUSTER: + name: OCIS_EVENTS_CLUSTER;ANTIVIRUS_EVENTS_CLUSTER + defaultValue: ocis-cluster + type: string + description: The clusterID of the event system. The event system is the message + queuing service. It is used as message broker for the microservice architecture. + Mandatory when using NATS as event system. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_EVENTS_ENABLE_TLS: + name: OCIS_EVENTS_ENABLE_TLS;ANTIVIRUS_EVENTS_ENABLE_TLS + defaultValue: "false" + type: bool + description: Enable TLS for the connection to the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_EVENTS_ENDPOINT: + name: OCIS_EVENTS_ENDPOINT;ANTIVIRUS_EVENTS_ENDPOINT + defaultValue: 127.0.0.1:9233 + type: string + description: The address of the event system. The event system is the message queuing + service. It is used as message broker for the microservice architecture. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_EVENTS_TLS_INSECURE: + name: OCIS_INSECURE;ANTIVIRUS_EVENTS_TLS_INSECURE + defaultValue: "false" + type: bool + description: Whether to verify the server TLS certificates. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_EVENTS_TLS_ROOT_CA_CERTIFICATE: + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;ANTIVIRUS_EVENTS_TLS_ROOT_CA_CERTIFICATE + defaultValue: "" + type: string + description: The root CA certificate used to validate the server's TLS certificate. + If provided ANTIVIRUS_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_ICAP_SCAN_TIMEOUT: + name: ANTIVIRUS_ICAP_SCAN_TIMEOUT + defaultValue: 5m0s + type: Duration + description: Scan timeout for the ICAP client. Defaults to '5m' (5 minutes). See + the Environment Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_ICAP_SERVICE: + name: ANTIVIRUS_ICAP_SERVICE + defaultValue: avscan + type: string + description: The name of the ICAP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_ICAP_TIMEOUT: + name: ANTIVIRUS_ICAP_TIMEOUT + defaultValue: "0" + type: int64 + description: Timeout for the ICAP client. + introductionVersion: "" + deprecationVersion: "v5.0" + removalVersion: "v6.0" + deprecationInfo: Changing the envvar type for consistency reasons. +ANTIVIRUS_ICAP_URL: + name: ANTIVIRUS_ICAP_URL + defaultValue: icap://127.0.0.1:1344 + type: string + description: URL of the ICAP server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_INFECTED_FILE_HANDLING: + name: ANTIVIRUS_INFECTED_FILE_HANDLING + defaultValue: delete + type: string + description: 'Defines the behaviour when a virus has been found. Supported options + are: ''delete'', ''continue'' and ''abort ''. Delete will delete the file. Continue + will mark the file as infected but continues further processing. Abort will keep + the file in the uploads folder for further admin inspection and will not move + it to its final destination.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_LOG_COLOR: + name: OCIS_LOG_COLOR;ANTIVIRUS_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_LOG_FILE: + name: OCIS_LOG_FILE;ANTIVIRUS_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_LOG_LEVEL: + name: OCIS_LOG_LEVEL;ANTIVIRUS_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_LOG_PRETTY: + name: OCIS_LOG_PRETTY;ANTIVIRUS_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_MAX_SCAN_SIZE: + name: ANTIVIRUS_MAX_SCAN_SIZE + defaultValue: "" + type: string + description: 'The maximum scan size the virusscanner can handle. Only this many + bytes of a file will be scanned. 0 means unlimited and is the default. Usable + common abbreviations: [KB, KiB, GB, GiB, TB, TiB, PB, PiB, EB, EiB], example: + 2GB.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_SCANNER_TYPE: + name: ANTIVIRUS_SCANNER_TYPE + defaultValue: clamav + type: string + description: The antivirus scanner to use. Supported values are 'clamav' and 'icap'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;ANTIVIRUS_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;ANTIVIRUS_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;ANTIVIRUS_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +ANTIVIRUS_TRACING_TYPE: + name: OCIS_TRACING_TYPE;ANTIVIRUS_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_DEBUG_ADDR: + name: APP_PROVIDER_DEBUG_ADDR + defaultValue: 127.0.0.1:9165 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_DEBUG_PPROF: + name: APP_PROVIDER_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_DEBUG_TOKEN: + name: APP_PROVIDER_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_DEBUG_ZPAGES: + name: APP_PROVIDER_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing traces + in-memory. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_DRIVER: + name: APP_PROVIDER_DRIVER + defaultValue: "" + type: string + description: Driver, the APP PROVIDER services uses. Only 'wopi' is supported as + of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_EXTERNAL_ADDR: + name: APP_PROVIDER_EXTERNAL_ADDR + defaultValue: "" + type: string + description: Address of the app provider, where the GATEWAY service can reach it. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_GRPC_ADDR: + name: APP_PROVIDER_GRPC_ADDR + defaultValue: 127.0.0.1:9164 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_GRPC_PROTOCOL: + name: APP_PROVIDER_GRPC_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the GPRC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_JWT_SECRET: + name: OCIS_JWT_SECRET;APP_PROVIDER_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_LOG_COLOR: + name: OCIS_LOG_COLOR;APP_PROVIDER_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_LOG_FILE: + name: OCIS_LOG_FILE;APP_PROVIDER_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_LOG_LEVEL: + name: OCIS_LOG_LEVEL;APP_PROVIDER_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_LOG_PRETTY: + name: OCIS_LOG_PRETTY;APP_PROVIDER_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_SERVICE_NAME: + name: APP_PROVIDER_SERVICE_NAME + defaultValue: app-provider + type: string + description: 'The name of the service. This needs to be changed when using more + than one app provider. Each app provider configured needs to be identified by + a unique service name. Possible examples are: ''app-provider-collabora'', ''app-provider-onlyoffice'', + ''app-provider-office365''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;APP_PROVIDER_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;APP_PROVIDER_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;APP_PROVIDER_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_TRACING_TYPE: + name: OCIS_TRACING_TYPE;APP_PROVIDER_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_WOPI_APP_API_KEY: + name: APP_PROVIDER_WOPI_APP_API_KEY + defaultValue: "" + type: string + description: API key for the wopi app. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_WOPI_APP_DESKTOP_ONLY: + name: APP_PROVIDER_WOPI_APP_DESKTOP_ONLY + defaultValue: "false" + type: bool + description: Offer this app only on desktop. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_WOPI_APP_ICON_URI: + name: APP_PROVIDER_WOPI_APP_ICON_URI + defaultValue: "" + type: string + description: URI to an app icon to be used by clients. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_WOPI_APP_INTERNAL_URL: + name: APP_PROVIDER_WOPI_APP_INTERNAL_URL + defaultValue: "" + type: string + description: Internal URL to the app, like in your DMZ. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_WOPI_APP_NAME: + name: APP_PROVIDER_WOPI_APP_NAME + defaultValue: "" + type: string + description: Human readable app name. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_WOPI_APP_URL: + name: APP_PROVIDER_WOPI_APP_URL + defaultValue: "" + type: string + description: URL for end users to access the app. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_WOPI_DISABLE_CHAT: + name: APP_PROVIDER_WOPI_DISABLE_CHAT + defaultValue: "false" + type: bool + description: Disable the chat functionality of the office app. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_WOPI_FOLDER_URL_BASE_URL: + name: OCIS_URL;APP_PROVIDER_WOPI_FOLDER_URL_BASE_URL + defaultValue: https://localhost:9200/ + type: string + description: Base url to navigate back from the app to the containing folder in + the file list. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_WOPI_FOLDER_URL_PATH_TEMPLATE: + name: APP_PROVIDER_WOPI_FOLDER_URL_PATH_TEMPLATE + defaultValue: /f/{{.ResourceID}} + type: string + description: Path template to navigate back from the app to the containing folder + in the file list. Supported template variables are {{.ResourceInfo.ResourceID}}, + {{.ResourceInfo.Mtime.Seconds}}, {{.ResourceInfo.Name}}, {{.ResourceInfo.Path}}, + {{.ResourceInfo.Type}}, {{.ResourceInfo.Id.SpaceId}}, {{.ResourceInfo.Id.StorageId}}, + {{.ResourceInfo.Id.OpaqueId}}, {{.ResourceInfo.MimeType}} + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_WOPI_INSECURE: + name: APP_PROVIDER_WOPI_INSECURE + defaultValue: "false" + type: bool + description: Disable TLS certificate validation for requests to the WOPI server + and the web office application. Do not set this in production environments. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_WOPI_WOPI_SERVER_EXTERNAL_URL: + name: APP_PROVIDER_WOPI_WOPI_SERVER_EXTERNAL_URL + defaultValue: "" + type: string + description: External url of the CS3org WOPI server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_PROVIDER_WOPI_WOPI_SERVER_IOP_SECRET: + name: APP_PROVIDER_WOPI_WOPI_SERVER_IOP_SECRET + defaultValue: "" + type: string + description: Shared secret of the CS3org WOPI server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_REGISTRY_DEBUG_ADDR: + name: APP_REGISTRY_DEBUG_ADDR + defaultValue: 127.0.0.1:9243 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_REGISTRY_DEBUG_PPROF: + name: APP_REGISTRY_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_REGISTRY_DEBUG_TOKEN: + name: APP_REGISTRY_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_REGISTRY_DEBUG_ZPAGES: + name: APP_REGISTRY_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_REGISTRY_GRPC_ADDR: + name: APP_REGISTRY_GRPC_ADDR + defaultValue: 127.0.0.1:9242 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_REGISTRY_GRPC_PROTOCOL: + name: APP_REGISTRY_GRPC_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_REGISTRY_JWT_SECRET: + name: OCIS_JWT_SECRET;APP_REGISTRY_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_REGISTRY_LOG_COLOR: + name: OCIS_LOG_COLOR;APP_REGISTRY_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_REGISTRY_LOG_FILE: + name: OCIS_LOG_FILE;APP_REGISTRY_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_REGISTRY_LOG_LEVEL: + name: OCIS_LOG_LEVEL;APP_REGISTRY_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_REGISTRY_LOG_PRETTY: + name: OCIS_LOG_PRETTY;APP_REGISTRY_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_REGISTRY_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;APP_REGISTRY_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_REGISTRY_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;APP_REGISTRY_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_REGISTRY_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;APP_REGISTRY_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +APP_REGISTRY_TRACING_TYPE: + name: OCIS_TRACING_TYPE;APP_REGISTRY_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_DEBUG_ADDR: + name: AUDIT_DEBUG_ADDR + defaultValue: 127.0.0.1:9229 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_DEBUG_PPROF: + name: AUDIT_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_DEBUG_TOKEN: + name: AUDIT_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_DEBUG_ZPAGES: + name: AUDIT_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_EVENTS_AUTH_PASSWORD: + name: OCIS_EVENTS_AUTH_PASSWORD;AUDIT_EVENTS_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_EVENTS_AUTH_USERNAME: + name: OCIS_EVENTS_AUTH_USERNAME;AUDIT_EVENTS_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_EVENTS_CLUSTER: + name: OCIS_EVENTS_CLUSTER;AUDIT_EVENTS_CLUSTER + defaultValue: ocis-cluster + type: string + description: The clusterID of the event system. The event system is the message + queuing service. It is used as message broker for the microservice architecture. + Mandatory when using NATS as event system. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_EVENTS_ENABLE_TLS: + name: OCIS_EVENTS_ENABLE_TLS;AUDIT_EVENTS_ENABLE_TLS + defaultValue: "false" + type: bool + description: Enable TLS for the connection to the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_EVENTS_ENDPOINT: + name: OCIS_EVENTS_ENDPOINT;AUDIT_EVENTS_ENDPOINT + defaultValue: 127.0.0.1:9233 + type: string + description: The address of the event system. The event system is the message queuing + service. It is used as message broker for the microservice architecture. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_EVENTS_TLS_INSECURE: + name: OCIS_INSECURE;AUDIT_EVENTS_TLS_INSECURE + defaultValue: "false" + type: bool + description: Whether to verify the server TLS certificates. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_EVENTS_TLS_ROOT_CA_CERTIFICATE: + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;AUDIT_EVENTS_TLS_ROOT_CA_CERTIFICATE + defaultValue: "" + type: string + description: The root CA certificate used to validate the server's TLS certificate. + If provided AUDIT_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_FILEPATH: + name: AUDIT_FILEPATH + defaultValue: "" + type: string + description: Filepath of the logfile. Mandatory if LOG_TO_FILE is set to 'true'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_FORMAT: + name: AUDIT_FORMAT + defaultValue: json + type: string + description: Log format. Supported values are '' (empty) and 'json'. Using 'json' + is advised, '' (empty) renders the 'minimal' format. See the text description + for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_LOG_COLOR: + name: OCIS_LOG_COLOR;AUDIT_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_LOG_FILE: + name: OCIS_LOG_FILE;AUDIT_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_LOG_LEVEL: + name: OCIS_LOG_LEVEL;AUDIT_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_LOG_PRETTY: + name: OCIS_LOG_PRETTY;AUDIT_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_LOG_TO_CONSOLE: + name: AUDIT_LOG_TO_CONSOLE + defaultValue: "true" + type: bool + description: Logs to stdout if set to 'true'. Independent of the LOG_TO_FILE option. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_LOG_TO_FILE: + name: AUDIT_LOG_TO_FILE + defaultValue: "false" + type: bool + description: Logs to file if set to 'true'. Independent of the LOG_TO_CONSOLE option. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;AUDIT_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;AUDIT_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;AUDIT_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUDIT_TRACING_TYPE: + name: OCIS_TRACING_TYPE;AUDIT_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_AUTH_MANAGER: + name: AUTH_BASIC_AUTH_MANAGER + defaultValue: ldap + type: string + description: The authentication manager to check if credentials are valid. Supported + value is 'ldap'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_DEBUG_ADDR: + name: AUTH_BASIC_DEBUG_ADDR + defaultValue: 127.0.0.1:9147 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_DEBUG_PPROF: + name: AUTH_BASIC_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_DEBUG_TOKEN: + name: AUTH_BASIC_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_DEBUG_ZPAGES: + name: AUTH_BASIC_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing traces + in-memory. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_DISABLE_USER_MECHANISM: + name: OCIS_LDAP_DISABLE_USER_MECHANISM;AUTH_BASIC_DISABLE_USER_MECHANISM + defaultValue: attribute + type: string + description: An option to control the behavior for disabling users. Valid options + are 'none', 'attribute' and 'group'. If set to 'group', disabling a user via API + will add the user to the configured group for disabled users, if set to 'attribute' + this will be done in the ldap user entry, if set to 'none' the disable request + is not processed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_DISABLED_USERS_GROUP_DN: + name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;AUTH_BASIC_DISABLED_USERS_GROUP_DN + defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm + type: string + description: The distinguished name of the group to which added users will be classified + as disabled when 'disable_user_mechanism' is set to 'group'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_GRPC_ADDR: + name: AUTH_BASIC_GRPC_ADDR + defaultValue: 127.0.0.1:9146 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_GRPC_PROTOCOL: + name: AUTH_BASIC_GRPC_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_IDP_URL: + name: OCIS_URL;OCIS_OIDC_ISSUER;AUTH_BASIC_IDP_URL + defaultValue: https://localhost:9200 + type: string + description: The identity provider value to set in the userids of the CS3 user objects + for users returned by this user provider. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_JWT_SECRET: + name: OCIS_JWT_SECRET;AUTH_BASIC_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_BIND_DN: + name: OCIS_LDAP_BIND_DN;AUTH_BASIC_LDAP_BIND_DN + defaultValue: uid=reva,ou=sysusers,o=libregraph-idm + type: string + description: LDAP DN to use for simple bind authentication with the target LDAP + server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_BIND_PASSWORD: + name: OCIS_LDAP_BIND_PASSWORD;AUTH_BASIC_LDAP_BIND_PASSWORD + defaultValue: "" + type: string + description: Password to use for authenticating the 'bind_dn'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_CACERT: + name: OCIS_LDAP_CACERT;AUTH_BASIC_LDAP_CACERT + defaultValue: /var/lib/ocis/idm/ldap.crt + type: string + description: Path/File name for the root CA certificate (in PEM format) used to + validate TLS server certificates of the LDAP service. If not defined, the root + directory derives from $OCIS_BASE_DATA_PATH:/idm. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_GROUP_BASE_DN: + name: OCIS_LDAP_GROUP_BASE_DN;AUTH_BASIC_LDAP_GROUP_BASE_DN + defaultValue: ou=groups,o=libregraph-idm + type: string + description: Search base DN for looking up LDAP groups. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_GROUP_FILTER: + name: OCIS_LDAP_GROUP_FILTER;AUTH_BASIC_LDAP_GROUP_FILTER + defaultValue: "" + type: string + description: LDAP filter to add to the default filters for group searches. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_GROUP_OBJECTCLASS: + name: OCIS_LDAP_GROUP_OBJECTCLASS;AUTH_BASIC_LDAP_GROUP_OBJECTCLASS + defaultValue: groupOfNames + type: string + description: The object class to use for groups in the default group search filter + ('groupOfNames'). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_GROUP_SCHEMA_DISPLAYNAME: + name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;AUTH_BASIC_LDAP_GROUP_SCHEMA_DISPLAYNAME + defaultValue: cn + type: string + description: LDAP Attribute to use for the displayname of groups (often the same + as groupname attribute). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_GROUP_SCHEMA_GROUPNAME: + name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;AUTH_BASIC_LDAP_GROUP_SCHEMA_GROUPNAME + defaultValue: cn + type: string + description: LDAP Attribute to use for the name of groups. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_GROUP_SCHEMA_ID: + name: OCIS_LDAP_GROUP_SCHEMA_ID;AUTH_BASIC_LDAP_GROUP_SCHEMA_ID + defaultValue: ownclouduuid + type: string + description: LDAP Attribute to use as the unique id for groups. This should be a + stable globally unique id (e.g. a UUID). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING: + name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;AUTH_BASIC_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING + defaultValue: "false" + type: bool + description: Set this to true if the defined 'id' attribute for groups is of the + 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute + of Active Directory for the group IDs. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_GROUP_SCHEMA_MAIL: + name: OCIS_LDAP_GROUP_SCHEMA_MAIL;AUTH_BASIC_LDAP_GROUP_SCHEMA_MAIL + defaultValue: mail + type: string + description: LDAP Attribute to use for the email address of groups (can be empty). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_GROUP_SCHEMA_MEMBER: + name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;AUTH_BASIC_LDAP_GROUP_SCHEMA_MEMBER + defaultValue: member + type: string + description: LDAP Attribute that is used for group members. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_GROUP_SCOPE: + name: OCIS_LDAP_GROUP_SCOPE;AUTH_BASIC_LDAP_GROUP_SCOPE + defaultValue: sub + type: string + description: LDAP search scope to use when looking up groups. Supported values are + 'base', 'one' and 'sub'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_INSECURE: + name: OCIS_LDAP_INSECURE;AUTH_BASIC_LDAP_INSECURE + defaultValue: "false" + type: bool + description: Disable TLS certificate validation for the LDAP connections. Do not + set this in production environments. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_LOGIN_ATTRIBUTES: + name: LDAP_LOGIN_ATTRIBUTES;AUTH_BASIC_LDAP_LOGIN_ATTRIBUTES + defaultValue: '[uid]' + type: '[]string' + description: A list of user object attributes that can be used for login. See the + Environment Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_URI: + name: OCIS_LDAP_URI;AUTH_BASIC_LDAP_URI + defaultValue: ldaps://localhost:9235 + type: string + description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' + and 'ldap://' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_USER_BASE_DN: + name: OCIS_LDAP_USER_BASE_DN;AUTH_BASIC_LDAP_USER_BASE_DN + defaultValue: ou=users,o=libregraph-idm + type: string + description: Search base DN for looking up LDAP users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_USER_ENABLED_ATTRIBUTE: + name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;AUTH_BASIC_LDAP_USER_ENABLED_ATTRIBUTE + defaultValue: ownCloudUserEnabled + type: string + description: LDAP attribute to use as a flag telling if the user is enabled or disabled. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_USER_FILTER: + name: OCIS_LDAP_USER_FILTER;AUTH_BASIC_LDAP_USER_FILTER + defaultValue: "" + type: string + description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_USER_OBJECTCLASS: + name: OCIS_LDAP_USER_OBJECTCLASS;AUTH_BASIC_LDAP_USER_OBJECTCLASS + defaultValue: inetOrgPerson + type: string + description: The object class to use for users in the default user search filter + ('inetOrgPerson'). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_USER_SCHEMA_DISPLAYNAME: + name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;AUTH_BASIC_LDAP_USER_SCHEMA_DISPLAYNAME + defaultValue: displayname + type: string + description: LDAP Attribute to use for the displayname of users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_USER_SCHEMA_ID: + name: OCIS_LDAP_USER_SCHEMA_ID;AUTH_BASIC_LDAP_USER_SCHEMA_ID + defaultValue: ownclouduuid + type: string + description: LDAP Attribute to use as the unique ID for users. This should be a + stable globally unique ID like a UUID. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING: + name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;AUTH_BASIC_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING + defaultValue: "false" + type: bool + description: Set this to true if the defined 'ID' attribute for users is of the + 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute + of Active Directory for the user IDs. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_USER_SCHEMA_MAIL: + name: OCIS_LDAP_USER_SCHEMA_MAIL;AUTH_BASIC_LDAP_USER_SCHEMA_MAIL + defaultValue: mail + type: string + description: LDAP Attribute to use for the email address of users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_USER_SCHEMA_USERNAME: + name: OCIS_LDAP_USER_SCHEMA_USERNAME;AUTH_BASIC_LDAP_USER_SCHEMA_USERNAME + defaultValue: uid + type: string + description: LDAP Attribute to use for username of users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LDAP_USER_SCOPE: + name: OCIS_LDAP_USER_SCOPE;AUTH_BASIC_LDAP_USER_SCOPE + defaultValue: sub + type: string + description: LDAP search scope to use when looking up users. Supported values are + 'base', 'one' and 'sub'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LOG_COLOR: + name: OCIS_LOG_COLOR;AUTH_BASIC_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LOG_FILE: + name: OCIS_LOG_FILE;AUTH_BASIC_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LOG_LEVEL: + name: OCIS_LOG_LEVEL;AUTH_BASIC_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_LOG_PRETTY: + name: OCIS_LOG_PRETTY;AUTH_BASIC_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_OWNCLOUDSQL_DB_HOST: + name: AUTH_BASIC_OWNCLOUDSQL_DB_HOST + defaultValue: mysql + type: string + description: Hostname of the database server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_OWNCLOUDSQL_DB_NAME: + name: AUTH_BASIC_OWNCLOUDSQL_DB_NAME + defaultValue: owncloud + type: string + description: Name of the owncloud database. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD: + name: AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD + defaultValue: "" + type: string + description: Password for the database user. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_OWNCLOUDSQL_DB_PORT: + name: AUTH_BASIC_OWNCLOUDSQL_DB_PORT + defaultValue: "3306" + type: int + description: Network port to use for the database connection. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME: + name: AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME + defaultValue: owncloud + type: string + description: Database user to use for authenticating with the owncloud database. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_OWNCLOUDSQL_IDP: + name: AUTH_BASIC_OWNCLOUDSQL_IDP + defaultValue: https://localhost:9200 + type: string + description: The identity provider value to set in the userids of the CS3 user objects + for users returned by this user provider. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID: + name: AUTH_BASIC_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID + defaultValue: "false" + type: bool + description: Join the user properties table to read user ID's. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME: + name: AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME + defaultValue: "false" + type: bool + description: Join the user properties table to read usernames + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_OWNCLOUDSQL_NOBODY: + name: AUTH_BASIC_OWNCLOUDSQL_NOBODY + defaultValue: "90" + type: int64 + description: Fallback number if no numeric UID and GID properties are provided. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_SKIP_USER_GROUPS_IN_TOKEN: + name: AUTH_BASIC_SKIP_USER_GROUPS_IN_TOKEN + defaultValue: "false" + type: bool + description: Disables the encoding of the user's group memberships in the reva access + token. This reduces the token size, especially when users are members of a large + number of groups. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;AUTH_BASIC_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;AUTH_BASIC_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;AUTH_BASIC_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BASIC_TRACING_TYPE: + name: OCIS_TRACING_TYPE;AUTH_BASIC_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_DEBUG_ADDR: + name: AUTH_BEARER_DEBUG_ADDR + defaultValue: 127.0.0.1:9149 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_DEBUG_PPROF: + name: AUTH_BEARER_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_DEBUG_TOKEN: + name: AUTH_BEARER_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_DEBUG_ZPAGES: + name: AUTH_BEARER_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_GRPC_ADDR: + name: AUTH_BEARER_GRPC_ADDR + defaultValue: 127.0.0.1:9148 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_GRPC_PROTOCOL: + name: AUTH_BEARER_GRPC_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_JWT_SECRET: + name: OCIS_JWT_SECRET;AUTH_BEARER_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_LOG_COLOR: + name: OCIS_LOG_COLOR;AUTH_BEARER_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_LOG_FILE: + name: OCIS_LOG_FILE;AUTH_BEARER_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_LOG_LEVEL: + name: OCIS_LOG_LEVEL;AUTH_BEARER_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_LOG_PRETTY: + name: OCIS_LOG_PRETTY;AUTH_BEARER_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_OIDC_GID_CLAIM: + name: AUTH_BEARER_OIDC_GID_CLAIM + defaultValue: "" + type: string + description: Name of the claim, which holds the GID. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_OIDC_ID_CLAIM: + name: AUTH_BEARER_OIDC_ID_CLAIM + defaultValue: preferred_username + type: string + description: Name of the claim, which holds the user identifier. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_OIDC_INSECURE: + name: OCIS_INSECURE;AUTH_BEARER_OIDC_INSECURE + defaultValue: "false" + type: bool + description: Allow insecure connections to the OIDC issuer. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_OIDC_ISSUER: + name: OCIS_URL;OCIS_OIDC_ISSUER;AUTH_BEARER_OIDC_ISSUER + defaultValue: https://localhost:9200 + type: string + description: URL of the OIDC issuer. It defaults to URL of the builtin IDP. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_OIDC_UID_CLAIM: + name: AUTH_BEARER_OIDC_UID_CLAIM + defaultValue: "" + type: string + description: Name of the claim, which holds the UID. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_SKIP_USER_GROUPS_IN_TOKEN: + name: AUTH_BEARER_SKIP_USER_GROUPS_IN_TOKEN + defaultValue: "false" + type: bool + description: Disables the encoding of the user's group memberships in the reva access + token. This reduces the token size, especially when users are members of a large + number of groups. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;AUTH_BEARER_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;AUTH_BEARER_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;AUTH_BEARER_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_BEARER_TRACING_TYPE: + name: OCIS_TRACING_TYPE;AUTH_BEARER_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_MACHINE_API_KEY: + name: OCIS_MACHINE_AUTH_API_KEY;AUTH_MACHINE_API_KEY + defaultValue: "" + type: string + description: Machine auth API key used to validate internal requests necessary for + the access to resources from other services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_MACHINE_DEBUG_ADDR: + name: AUTH_MACHINE_DEBUG_ADDR + defaultValue: 127.0.0.1:9167 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_MACHINE_DEBUG_PPROF: + name: AUTH_MACHINE_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_MACHINE_DEBUG_TOKEN: + name: AUTH_MACHINE_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_MACHINE_DEBUG_ZPAGES: + name: AUTH_MACHINE_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_MACHINE_GRPC_ADDR: + name: AUTH_MACHINE_GRPC_ADDR + defaultValue: 127.0.0.1:9166 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_MACHINE_GRPC_PROTOCOL: + name: AUTH_MACHINE_GRPC_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_MACHINE_JWT_SECRET: + name: OCIS_JWT_SECRET;AUTH_MACHINE_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_MACHINE_LOG_COLOR: + name: OCIS_LOG_COLOR;AUTH_MACHINE_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_MACHINE_LOG_FILE: + name: OCIS_LOG_FILE;AUTH_MACHINE_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_MACHINE_LOG_LEVEL: + name: OCIS_LOG_LEVEL;AUTH_MACHINE_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_MACHINE_LOG_PRETTY: + name: OCIS_LOG_PRETTY;AUTH_MACHINE_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_MACHINE_SKIP_USER_GROUPS_IN_TOKEN: + name: AUTH_MACHINE_SKIP_USER_GROUPS_IN_TOKEN + defaultValue: "false" + type: bool + description: Disables the encoding of the user's group memberships in the reva access + token. This reduces the token size, especially when users are members of a large + number of groups. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_MACHINE_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;AUTH_MACHINE_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_MACHINE_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;AUTH_MACHINE_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_MACHINE_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;AUTH_MACHINE_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_MACHINE_TRACING_TYPE: + name: OCIS_TRACING_TYPE;AUTH_MACHINE_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_SERVICE_DEBUG_ADDR: + name: AUTH_SERVICE_DEBUG_ADDR + defaultValue: 127.0.0.1:9198 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_SERVICE_DEBUG_PPROF: + name: AUTH_SERVICE_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_SERVICE_DEBUG_TOKEN: + name: AUTH_SERVICE_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_SERVICE_DEBUG_ZPAGES: + name: AUTH_SERVICE_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_SERVICE_GRPC_ADDR: + name: AUTH_SERVICE_GRPC_ADDR + defaultValue: 127.0.0.1:9199 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_SERVICE_GRPC_PROTOCOL: + name: AUTH_SERVICE_GRPC_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_SERVICE_JWT_SECRET: + name: OCIS_JWT_SECRET;AUTH_SERVICE_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_SERVICE_LOG_COLOR: + name: OCIS_LOG_COLOR;AUTH_SERVICE_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_SERVICE_LOG_FILE: + name: OCIS_LOG_FILE;AUTH_SERVICE_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_SERVICE_LOG_LEVEL: + name: OCIS_LOG_LEVEL;AUTH_SERVICE_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_SERVICE_LOG_PRETTY: + name: OCIS_LOG_PRETTY;AUTH_SERVICE_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_SERVICE_SERVICE_ACCOUNT_ID: + name: OCIS_SERVICE_ACCOUNT_ID;AUTH_SERVICE_SERVICE_ACCOUNT_ID + defaultValue: "" + type: string + description: The ID of the service account the service should use. See the 'auth-service' + service description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_SERVICE_SERVICE_ACCOUNT_SECRET: + name: OCIS_SERVICE_ACCOUNT_SECRET;AUTH_SERVICE_SERVICE_ACCOUNT_SECRET + defaultValue: "" + type: string + description: The service account secret. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_SERVICE_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;AUTH_SERVICE_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_SERVICE_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;AUTH_SERVICE_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_SERVICE_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;AUTH_SERVICE_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +AUTH_SERVICE_TRACING_TYPE: + name: OCIS_TRACING_TYPE;AUTH_SERVICE_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_DEBUG_ADDR: + name: CLIENTLOG_DEBUG_ADDR + defaultValue: 127.0.0.1:9260 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_DEBUG_PPROF: + name: CLIENTLOG_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_DEBUG_TOKEN: + name: CLIENTLOG_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_DEBUG_ZPAGES: + name: CLIENTLOG_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_EVENTS_AUTH_PASSWORD: + name: OCIS_EVENTS_AUTH_PASSWORD;CLIENTLOG_EVENTS_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_EVENTS_AUTH_USERNAME: + name: OCIS_EVENTS_AUTH_USERNAME;CLIENTLOG_EVENTS_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_EVENTS_CLUSTER: + name: OCIS_EVENTS_CLUSTER;CLIENTLOG_EVENTS_CLUSTER + defaultValue: ocis-cluster + type: string + description: The clusterID of the event system. The event system is the message + queuing service. It is used as message broker for the microservice architecture. + Mandatory when using NATS as event system. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_EVENTS_ENABLE_TLS: + name: OCIS_EVENTS_ENABLE_TLS;CLIENTLOG_EVENTS_ENABLE_TLS + defaultValue: "false" + type: bool + description: Enable TLS for the connection to the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_EVENTS_ENDPOINT: + name: OCIS_EVENTS_ENDPOINT;CLIENTLOG_EVENTS_ENDPOINT + defaultValue: 127.0.0.1:9233 + type: string + description: The address of the event system. The event system is the message queuing + service. It is used as message broker for the microservice architecture. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_EVENTS_TLS_INSECURE: + name: OCIS_INSECURE;CLIENTLOG_EVENTS_TLS_INSECURE + defaultValue: "false" + type: bool + description: Whether to verify the server TLS certificates. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE: + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;CLIENTLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE + defaultValue: "" + type: string + description: The root CA certificate used to validate the server's TLS certificate. + If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_JWT_SECRET: + name: OCIS_JWT_SECRET;CLIENTLOG_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_SERVICE_ACCOUNT_ID: + name: OCIS_SERVICE_ACCOUNT_ID;CLIENTLOG_SERVICE_ACCOUNT_ID + defaultValue: "" + type: string + description: The ID of the service account the service should use. See the 'auth-service' + service description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_SERVICE_ACCOUNT_SECRET: + name: OCIS_SERVICE_ACCOUNT_SECRET;CLIENTLOG_SERVICE_ACCOUNT_SECRET + defaultValue: "" + type: string + description: The service account secret. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;CLIENTLOG_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;CLIENTLOG_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;CLIENTLOG_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_TRACING_TYPE: + name: OCIS_TRACING_TYPE;CLIENTLOG_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_USERLOG_LOG_COLOR: + name: OCIS_LOG_COLOR;CLIENTLOG_USERLOG_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_USERLOG_LOG_FILE: + name: OCIS_LOG_FILE;CLIENTLOG_USERLOG_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_USERLOG_LOG_LEVEL: + name: OCIS_LOG_LEVEL;CLIENTLOG_USERLOG_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +CLIENTLOG_USERLOG_LOG_PRETTY: + name: OCIS_LOG_PRETTY;CLIENTLOG_USERLOG_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_DEBUG_ADDR: + name: EVENTHISTORY_DEBUG_ADDR + defaultValue: 127.0.0.1:9270 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_DEBUG_PPROF: + name: EVENTHISTORY_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_DEBUG_TOKEN: + name: EVENTHISTORY_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_DEBUG_ZPAGES: + name: EVENTHISTORY_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_EVENTS_AUTH_PASSWORD: + name: OCIS_EVENTS_AUTH_PASSWORD;EVENTHISTORY_EVENTS_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_EVENTS_AUTH_USERNAME: + name: OCIS_EVENTS_AUTH_USERNAME;EVENTHISTORY_EVENTS_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_EVENTS_CLUSTER: + name: OCIS_EVENTS_CLUSTER;EVENTHISTORY_EVENTS_CLUSTER + defaultValue: ocis-cluster + type: string + description: The clusterID of the event system. The event system is the message + queuing service. It is used as message broker for the microservice architecture. + Mandatory when using NATS as event system. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_EVENTS_ENABLE_TLS: + name: OCIS_EVENTS_ENABLE_TLS;EVENTHISTORY_EVENTS_ENABLE_TLS + defaultValue: "false" + type: bool + description: Enable TLS for the connection to the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_EVENTS_ENDPOINT: + name: OCIS_EVENTS_ENDPOINT;EVENTHISTORY_EVENTS_ENDPOINT + defaultValue: 127.0.0.1:9233 + type: string + description: The address of the event system. The event system is the message queuing + service. It is used as message broker for the microservice architecture. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_EVENTS_TLS_INSECURE: + name: OCIS_INSECURE;EVENTHISTORY_EVENTS_TLS_INSECURE + defaultValue: "false" + type: bool + description: Whether to verify the server TLS certificates. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_EVENTS_TLS_ROOT_CA_CERTIFICATE: + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;EVENTHISTORY_EVENTS_TLS_ROOT_CA_CERTIFICATE + defaultValue: "" + type: string + description: The root CA certificate used to validate the server's TLS certificate. + Will be seen as empty if NOTIFICATIONS_EVENTS_TLS_INSECURE is provided. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_GRPC_ADDR: + name: EVENTHISTORY_GRPC_ADDR + defaultValue: 127.0.0.1:0 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_LOG_COLOR: + name: OCIS_LOG_COLOR;EVENTHISTORY_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_LOG_FILE: + name: OCIS_LOG_FILE;EVENTHISTORY_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_LOG_LEVEL: + name: OCIS_LOG_LEVEL;EVENTHISTORY_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_LOG_PRETTY: + name: OCIS_LOG_PRETTY;EVENTHISTORY_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_STORE: + name: OCIS_PERSISTENT_STORE;EVENTHISTORY_STORE + defaultValue: memory + type: string + description: 'The type of the store. Supported values are: ''memory'', ''ocmem'', + ''etcd'', ''redis'', ''redis-sentinel'', ''nats-js'', ''noop''. See the text description + for details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_STORE_AUTH_PASSWORD: + name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;EVENTHISTORY_STORE_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the store. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_STORE_AUTH_USERNAME: + name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;EVENTHISTORY_STORE_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the store. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_STORE_DATABASE: + name: EVENTHISTORY_STORE_DATABASE + defaultValue: eventhistory + type: string + description: The database name the configured store should use. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_STORE_NODES: + name: OCIS_PERSISTENT_STORE_NODES;EVENTHISTORY_STORE_NODES + defaultValue: '[]' + type: '[]string' + description: A list of nodes to access the configured store. This has no effect + when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes + are used is dependent on the library of the configured store. See the Environment + Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_STORE_SIZE: + name: OCIS_PERSISTENT_STORE_SIZE;EVENTHISTORY_STORE_SIZE + defaultValue: "0" + type: int + description: The maximum quantity of items in the store. Only applies when store + type 'ocmem' is configured. Defaults to 512 which is derived and used from the + ocmem package though no explicit default was set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_STORE_TABLE: + name: EVENTHISTORY_STORE_TABLE + defaultValue: events + type: string + description: The database table the store should use. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_STORE_TTL: + name: OCIS_PERSISTENT_STORE_TTL;EVENTHISTORY_STORE_TTL + defaultValue: 336h0m0s + type: Duration + description: Time to live for events in the store. Defaults to '336h' (2 weeks). + See the Environment Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;EVENTHISTORY_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;EVENTHISTORY_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;EVENTHISTORY_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +EVENTHISTORY_TRACING_TYPE: + name: OCIS_TRACING_TYPE;EVENTHISTORY_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_APP_HANDLER_INSECURE: + name: OCIS_INSECURE;FRONTEND_APP_HANDLER_INSECURE + defaultValue: "false" + type: bool + description: Allow insecure connections to the frontend. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_ARCHIVER_INSECURE: + name: OCIS_INSECURE;FRONTEND_ARCHIVER_INSECURE + defaultValue: "false" + type: bool + description: Allow insecure connections to the archiver. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_ARCHIVER_MAX_NUM_FILES: + name: FRONTEND_ARCHIVER_MAX_NUM_FILES + defaultValue: "10000" + type: int64 + description: Max number of files that can be packed into an archive. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_ARCHIVER_MAX_SIZE: + name: FRONTEND_ARCHIVER_MAX_SIZE + defaultValue: "1073741824" + type: int64 + description: Max size in bytes of the zip archive the archiver can create. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_AUTO_ACCEPT_SHARES: + name: FRONTEND_AUTO_ACCEPT_SHARES + defaultValue: "true" + type: bool + description: Defines if shares should be auto accepted by default. Users can change + this setting individually in their profile. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_CHECKSUMS_PREFERRED_UPLOAD_TYPE: + name: FRONTEND_CHECKSUMS_PREFERRED_UPLOAD_TYPE + defaultValue: sha1 + type: string + description: The supported checksum type for uploads that indicates to clients supporting + multiple hash algorithms which one is preferred by the server. Must be one out + of the defined list of SUPPORTED_TYPES. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_CHECKSUMS_SUPPORTED_TYPES: + name: FRONTEND_CHECKSUMS_SUPPORTED_TYPES + defaultValue: '[sha1 md5 adler32]' + type: '[]string' + description: A list of checksum types that indicate to clients which hashes the + server can use to verify upload integrity. Supported types are 'sha1', 'md5' and + 'adler32'. See the Environment Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_CORS_ALLOW_CREDENTIALS: + name: OCIS_CORS_ALLOW_CREDENTIALS;FRONTEND_CORS_ALLOW_CREDENTIALS + defaultValue: "true" + type: bool + description: 'Allow credentials for CORS.See following chapter for more details: + *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_CORS_ALLOW_HEADERS: + name: OCIS_CORS_ALLOW_HEADERS;FRONTEND_CORS_ALLOW_HEADERS + defaultValue: '[Origin Accept Content-Type Depth Authorization Ocs-Apirequest If-None-Match + If-Match Destination Overwrite X-Request-Id X-Requested-With Tus-Resumable Tus-Checksum-Algorithm + Upload-Concat Upload-Length Upload-Metadata Upload-Defer-Length Upload-Expires + Upload-Checksum Upload-Offset X-HTTP-Method-Override Cache-Control]' + type: '[]string' + description: 'A list of allowed CORS headers. See following chapter for more details: + *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_CORS_ALLOW_METHODS: + name: OCIS_CORS_ALLOW_METHODS;FRONTEND_CORS_ALLOW_METHODS + defaultValue: '[OPTIONS HEAD GET PUT POST DELETE MKCOL PROPFIND PROPPATCH MOVE COPY + REPORT SEARCH]' + type: '[]string' + description: 'A list of allowed CORS methods. See following chapter for more details: + *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_CORS_ALLOW_ORIGINS: + name: OCIS_CORS_ALLOW_ORIGINS;FRONTEND_CORS_ALLOW_ORIGINS + defaultValue: '[*]' + type: '[]string' + description: 'A list of allowed CORS origins. See following chapter for more details: + *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_DATA_GATEWAY_PREFIX: + name: FRONTEND_DATA_GATEWAY_PREFIX + defaultValue: data + type: string + description: Path prefix for the data gateway. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_DEBUG_ADDR: + name: FRONTEND_DEBUG_ADDR + defaultValue: 127.0.0.1:9141 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_DEBUG_PPROF: + name: FRONTEND_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_DEBUG_TOKEN: + name: FRONTEND_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_DEBUG_ZPAGES: + name: FRONTEND_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_DEFAULT_LINK_PERMISSIONS: + name: FRONTEND_DEFAULT_LINK_PERMISSIONS + defaultValue: "1" + type: int + description: Defines the default permissions a link is being created with. Possible + values are 0 (= internal link, for instance members only) and 1 (= public link + with viewer permissions). Defaults to 1. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_DEFAULT_UPLOAD_PROTOCOL: + name: FRONTEND_DEFAULT_UPLOAD_PROTOCOL + defaultValue: tus + type: string + description: The default upload protocol to use in clients. Currently only 'tus' + is avaliable. See the developer API documentation for more details about TUS. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_DISABLE_SSE: + name: OCIS_DISABLE_SSE;FRONTEND_DISABLE_SSE + defaultValue: "false" + type: bool + description: When set to true, clients are informed that the Server-Sent Events + endpoint is not accessible. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_EDITION: + name: OCIS_EDITION;FRONTEND_EDITION + defaultValue: Community + type: string + description: "" + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_ENABLE_FAVORITES: + name: FRONTEND_ENABLE_FAVORITES + defaultValue: "false" + type: bool + description: Enables the support for favorites in the clients. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_ENABLE_FEDERATED_SHARING_INCOMING: + name: FRONTEND_ENABLE_FEDERATED_SHARING_INCOMING + defaultValue: "false" + type: bool + description: Changing this value is NOT supported. Enables support for incoming + federated sharing for clients. The backend behaviour is not changed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_ENABLE_FEDERATED_SHARING_OUTGOING: + name: FRONTEND_ENABLE_FEDERATED_SHARING_OUTGOING + defaultValue: "false" + type: bool + description: Changing this value is NOT supported. Enables support for outgoing + federated sharing for clients. The backend behaviour is not changed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_ENABLE_RESHARING: + name: OCIS_ENABLE_RESHARING;FRONTEND_ENABLE_RESHARING + defaultValue: "true" + type: bool + description: Changing this value is NOT supported. Enables the support for resharing + in the clients. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_EVENTS_AUTH_PASSWORD: + name: OCIS_EVENTS_AUTH_PASSWORD;FRONTEND_EVENTS_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_EVENTS_AUTH_USERNAME: + name: OCIS_EVENTS_AUTH_USERNAME;FRONTEND_EVENTS_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_EVENTS_CLUSTER: + name: OCIS_EVENTS_CLUSTER;FRONTEND_EVENTS_CLUSTER + defaultValue: ocis-cluster + type: string + description: The clusterID of the event system. The event system is the message + queuing service. It is used as message broker for the microservice architecture. + Mandatory when using NATS as event system. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_EVENTS_ENABLE_TLS: + name: OCIS_EVENTS_ENABLE_TLS;FRONTEND_EVENTS_ENABLE_TLS + defaultValue: "false" + type: bool + description: Enable TLS for the connection to the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_EVENTS_ENDPOINT: + name: OCIS_EVENTS_ENDPOINT;FRONTEND_EVENTS_ENDPOINT + defaultValue: 127.0.0.1:9233 + type: string + description: The address of the event system. The event system is the message queuing + service. It is used as message broker for the microservice architecture. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_EVENTS_TLS_INSECURE: + name: OCIS_INSECURE;FRONTEND_EVENTS_TLS_INSECURE + defaultValue: "false" + type: bool + description: Whether to verify the server TLS certificates. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_EVENTS_TLS_ROOT_CA_CERTIFICATE: + name: FRONTEND_EVENTS_TLS_ROOT_CA_CERTIFICATE;OCS_EVENTS_TLS_ROOT_CA_CERTIFICATE + defaultValue: "" + type: string + description: The root CA certificate used to validate the server's TLS certificate. + If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_FULL_TEXT_SEARCH_ENABLED: + name: FRONTEND_FULL_TEXT_SEARCH_ENABLED + defaultValue: "false" + type: bool + description: "" + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_HTTP_ADDR: + name: FRONTEND_HTTP_ADDR + defaultValue: 127.0.0.1:9140 + type: string + description: The bind address of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_HTTP_PREFIX: + name: FRONTEND_HTTP_PREFIX + defaultValue: "" + type: string + description: The Path prefix where the frontend can be accessed (defaults to /). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_HTTP_PROTOCOL: + name: FRONTEND_HTTP_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_JWT_SECRET: + name: OCIS_JWT_SECRET;FRONTEND_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_LDAP_SERVER_WRITE_ENABLED: + name: OCIS_LDAP_SERVER_WRITE_ENABLED;FRONTEND_LDAP_SERVER_WRITE_ENABLED + defaultValue: "true" + type: bool + description: Allow creating, modifying and deleting LDAP users via the GRAPH API. + This can only be set to 'true' when keeping default settings for the LDAP user + and group attribute types (the 'OCIS_LDAP_USER_SCHEMA_* and 'OCIS_LDAP_GROUP_SCHEMA_* + variables). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_LOG_COLOR: + name: OCIS_LOG_COLOR;FRONTEND_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_LOG_FILE: + name: OCIS_LOG_FILE;FRONTEND_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_LOG_LEVEL: + name: OCIS_LOG_LEVEL;FRONTEND_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_LOG_PRETTY: + name: OCIS_LOG_PRETTY;FRONTEND_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_MACHINE_AUTH_API_KEY: + name: OCIS_MACHINE_AUTH_API_KEY;FRONTEND_MACHINE_AUTH_API_KEY + defaultValue: "" + type: string + description: The machine auth API key used to validate internal requests necessary + to access resources from other services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_MAX_QUOTA: + name: OCIS_SPACES_MAX_QUOTA;FRONTEND_MAX_QUOTA + defaultValue: "0" + type: uint64 + description: Set the global max quota value in bytes. A value of 0 equals unlimited. + The value is provided via capabilities. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_OCS_ADDITIONAL_INFO_ATTRIBUTE: + name: FRONTEND_OCS_ADDITIONAL_INFO_ATTRIBUTE + defaultValue: '{{.Mail}}' + type: string + description: Additional information attribute for the user like {{.Mail}}. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_OCS_ENABLE_DENIALS: + name: FRONTEND_OCS_ENABLE_DENIALS + defaultValue: "false" + type: bool + description: 'EXPERIMENTAL: enable the feature to deny access on folders.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_OCS_INCLUDE_OCM_SHAREES: + name: FRONTEND_OCS_INCLUDE_OCM_SHAREES + defaultValue: "false" + type: bool + description: Include OCM sharees when listing sharees. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_OCS_LIST_OCM_SHARES: + name: FRONTEND_OCS_LIST_OCM_SHARES + defaultValue: "true" + type: bool + description: Include OCM shares when listing shares. See the OCM service documentation + for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_OCS_PERSONAL_NAMESPACE: + name: FRONTEND_OCS_PERSONAL_NAMESPACE + defaultValue: /users/{{.Id.OpaqueId}} + type: string + description: Homespace namespace identifier. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_OCS_PREFIX: + name: FRONTEND_OCS_PREFIX + defaultValue: ocs + type: string + description: URL path prefix for the OCS service. Note that the string must not + start with '/'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_OCS_PUBLIC_SHARE_MUST_HAVE_PASSWORD: + name: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD;FRONTEND_OCS_PUBLIC_SHARE_MUST_HAVE_PASSWORD + defaultValue: "true" + type: bool + description: Set this to true if you want to enforce passwords on all public shares. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD: + name: OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD;FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD + defaultValue: "false" + type: bool + description: Set this to true if you want to enforce passwords on Uploader, Editor + or Contributor shares. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_OCS_SHARE_PREFIX: + name: FRONTEND_OCS_SHARE_PREFIX + defaultValue: /Shares + type: string + description: Path prefix for shares as part of an ocis resource. Note that the path + must start with '/'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_OCS_STAT_CACHE_AUTH_PASSWORD: + name: OCIS_CACHE_AUTH_PASSWORD;FRONTEND_OCS_STAT_CACHE_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to use for authentication. Only applies when using the + 'nats-js-kv' store type. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_OCS_STAT_CACHE_AUTH_USERNAME: + name: OCIS_CACHE_AUTH_USERNAME;FRONTEND_OCS_STAT_CACHE_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to use for authentication. Only applies when using the + 'nats-js-kv' store type. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_OCS_STAT_CACHE_DISABLE_PERSISTENCE: + name: OCIS_CACHE_DISABLE_PERSISTENCE;FRONTEND_OCS_STAT_CACHE_DISABLE_PERSISTENCE + defaultValue: "false" + type: bool + description: Disable persistence of the cache. Only applies when using the 'nats-js-kv' + store type. Defaults to false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_OCS_STAT_CACHE_SIZE: + name: OCIS_CACHE_SIZE;FRONTEND_OCS_STAT_CACHE_SIZE + defaultValue: "0" + type: int + description: Max number of entries to hold in the cache. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_OCS_STAT_CACHE_STORE: + name: OCIS_CACHE_STORE;FRONTEND_OCS_STAT_CACHE_STORE + defaultValue: memory + type: string + description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', + ''nats-js-kv'', ''noop''. See the text description for details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_OCS_STAT_CACHE_STORE_NODES: + name: OCIS_CACHE_STORE_NODES;FRONTEND_OCS_STAT_CACHE_STORE_NODES + defaultValue: '[127.0.0.1:9233]' + type: '[]string' + description: A list of nodes to access the configured store. This has no effect + when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes + are used is dependent on the library of the configured store. See the Environment + Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_OCS_STAT_CACHE_TABLE: + name: FRONTEND_OCS_STAT_CACHE_TABLE + defaultValue: "" + type: string + description: The database table the store should use. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_OCS_STAT_CACHE_TTL: + name: OCIS_CACHE_TTL;FRONTEND_OCS_STAT_CACHE_TTL + defaultValue: 5m0s + type: Duration + description: Default time to live for user info in the cache. Only applied when + access tokens has no expiration. See the Environment Variable Types description + for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_PASSWORD_POLICY_BANNED_PASSWORDS_LIST: + name: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST;FRONTEND_PASSWORD_POLICY_BANNED_PASSWORDS_LIST + defaultValue: "" + type: string + description: Path to the 'banned passwords list' file. See the documentation for + more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_PASSWORD_POLICY_DISABLED: + name: OCIS_PASSWORD_POLICY_DISABLED;FRONTEND_PASSWORD_POLICY_DISABLED + defaultValue: "false" + type: bool + description: Disable the password policy. Defaults to false if not set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_PASSWORD_POLICY_MIN_CHARACTERS: + name: OCIS_PASSWORD_POLICY_MIN_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_CHARACTERS + defaultValue: "8" + type: int + description: Define the minimum password length. Defaults to 8 if not set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_PASSWORD_POLICY_MIN_DIGITS: + name: OCIS_PASSWORD_POLICY_MIN_DIGITS;FRONTEND_PASSWORD_POLICY_MIN_DIGITS + defaultValue: "1" + type: int + description: Define the minimum number of digits. Defaults to 1 if not set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS: + name: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS + defaultValue: "1" + type: int + description: Define the minimum number of uppercase letters. Defaults to 1 if not + set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS: + name: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS + defaultValue: "1" + type: int + description: Define the minimum number of characters from the special characters + list to be present. Defaults to 1 if not set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS: + name: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS + defaultValue: "1" + type: int + description: Define the minimum number of lowercase letters. Defaults to 1 if not + set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_PUBLIC_URL: + name: OCIS_URL;FRONTEND_PUBLIC_URL + defaultValue: https://localhost:9200 + type: string + description: The public facing URL of the oCIS frontend. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_READONLY_USER_ATTRIBUTES: + name: FRONTEND_READONLY_USER_ATTRIBUTES + defaultValue: '[]' + type: '[]string' + description: 'A list of user attributes to indicate as read-only. Supported values: + ''user.onPremisesSamAccountName'' (username), ''user.displayName'', ''user.mail'', + ''user.passwordProfile'' (password), ''user.appRoleAssignments'' (role), ''user.memberOf'' + (groups), ''user.accountEnabled'' (login allowed), ''drive.quota'' (quota). See + the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_SEARCH_MIN_LENGTH: + name: FRONTEND_SEARCH_MIN_LENGTH + defaultValue: "3" + type: int + description: Minimum number of characters to enter before a client should start + a search for Share receivers. This setting can be used to customize the user experience + if e.g too many results are displayed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_SERVICE_ACCOUNT_ID: + name: OCIS_SERVICE_ACCOUNT_ID;FRONTEND_SERVICE_ACCOUNT_ID + defaultValue: "" + type: string + description: The ID of the service account the service should use. See the 'auth-service' + service description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_SERVICE_ACCOUNT_SECRET: + name: OCIS_SERVICE_ACCOUNT_SECRET;FRONTEND_SERVICE_ACCOUNT_SECRET + defaultValue: "" + type: string + description: The service account secret. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_SKIP_USER_GROUPS_IN_TOKEN: + name: FRONTEND_SKIP_USER_GROUPS_IN_TOKEN + defaultValue: "false" + type: bool + description: Disables the loading of user's group memberships from the reva access + token. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;FRONTEND_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;FRONTEND_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;FRONTEND_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_TRACING_TYPE: + name: OCIS_TRACING_TYPE;FRONTEND_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE: + name: FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE + defaultValue: "" + type: string + description: Advise TUS to replace PATCH requests by POST requests. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +FRONTEND_UPLOAD_MAX_CHUNK_SIZE: + name: FRONTEND_UPLOAD_MAX_CHUNK_SIZE + defaultValue: "10000000" + type: int + description: Sets the max chunk sizes in bytes for uploads via the clients. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT: + name: GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT + defaultValue: "true" + type: bool + description: Commit shares to storage grants. This grants access to shared resources + for the share receiver directly on the storage. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_CREATE_HOME_CACHE_AUTH_PASSWORD: + name: OCIS_CACHE_AUTH_PASSWORD;GATEWAY_CREATE_HOME_CACHE_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to use for authentication. Only applies when store type + 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_CREATE_HOME_CACHE_AUTH_USERNAME: + name: OCIS_CACHE_AUTH_USERNAME;GATEWAY_CREATE_HOME_CACHE_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to use for authentication. Only applies when store type + 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_CREATE_HOME_CACHE_DISABLE_PERSISTENCE: + name: OCIS_CACHE_DISABLE_PERSISTENCE;GATEWAY_CREATE_HOME_CACHE_DISABLE_PERSISTENCE + defaultValue: "false" + type: bool + description: Disables persistence of the create home cache. Only applies when store + type 'nats-js-kv' is configured. Defaults to false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_CREATE_HOME_CACHE_SIZE: + name: OCIS_CACHE_SIZE;GATEWAY_CREATE_HOME_CACHE_SIZE + defaultValue: "0" + type: int + description: The maximum quantity of items in the cache. Only applies when store + type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package + though not exclicitely set as default. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_CREATE_HOME_CACHE_STORE: + name: OCIS_CACHE_STORE;GATEWAY_CREATE_HOME_CACHE_STORE + defaultValue: memory + type: string + description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', + ''nats-js-kv'', ''noop''. See the text description for details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_CREATE_HOME_CACHE_STORE_NODES: + name: OCIS_CACHE_STORE_NODES;GATEWAY_CREATE_HOME_CACHE_STORE_NODES + defaultValue: '[127.0.0.1:9233]' + type: '[]string' + description: A list of nodes to access the configured store. This has no effect + when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes + are used is dependent on the library of the configured store. See the Environment + Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_CREATE_HOME_CACHE_TTL: + name: OCIS_CACHE_TTL;GATEWAY_CREATE_HOME_CACHE_TTL + defaultValue: 5m0s + type: Duration + description: Default time to live for user info in the cache. Only applied when + access tokens has no expiration. See the Environment Variable Types description + for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_DEBUG_ADDR: + name: GATEWAY_DEBUG_ADDR + defaultValue: 127.0.0.1:9143 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_DEBUG_PPROF: + name: GATEWAY_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_DEBUG_TOKEN: + name: GATEWAY_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_DEBUG_ZPAGES: + name: GATEWAY_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN: + name: GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN + defaultValue: "true" + type: bool + description: Disable creation of the home space on login. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_FRONTEND_PUBLIC_URL: + name: OCIS_URL;GATEWAY_FRONTEND_PUBLIC_URL + defaultValue: https://localhost:9200 + type: string + description: The public facing URL of the oCIS frontend. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_GRPC_ADDR: + name: OCIS_GATEWAY_GRPC_ADDR;GATEWAY_GRPC_ADDR + defaultValue: 127.0.0.1:9142 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_GRPC_PROTOCOL: + name: GATEWAY_GRPC_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_JWT_SECRET: + name: OCIS_JWT_SECRET;GATEWAY_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_LOG_COLOR: + name: OCIS_LOG_COLOR;GATEWAY_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_LOG_FILE: + name: OCIS_LOG_FILE;GATEWAY_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_LOG_LEVEL: + name: OCIS_LOG_LEVEL;GATEWAY_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_LOG_PRETTY: + name: OCIS_LOG_PRETTY;GATEWAY_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_PROVIDER_CACHE_AUTH_PASSWORD: + name: OCIS_CACHE_AUTH_PASSWORD;GATEWAY_PROVIDER_CACHE_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to use for authentication. Only applies when store type + 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_PROVIDER_CACHE_AUTH_USERNAME: + name: OCIS_CACHE_AUTH_USERNAME;GATEWAY_PROVIDER_CACHE_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to use for authentication. Only applies when store type + 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_PROVIDER_CACHE_DISABLE_PERSISTENCE: + name: OCIS_CACHE_DISABLE_PERSISTENCE;GATEWAY_PROVIDER_CACHE_DISABLE_PERSISTENCE + defaultValue: "false" + type: bool + description: Disables persistence of the provider cache. Only applies when store + type 'nats-js-kv' is configured. Defaults to false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_PROVIDER_CACHE_SIZE: + name: OCIS_CACHE_SIZE;GATEWAY_PROVIDER_CACHE_SIZE + defaultValue: "0" + type: int + description: The maximum quantity of items in the cache. Only applies when store + type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package + though not exclicitely set as default. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_PROVIDER_CACHE_STORE: + name: OCIS_CACHE_STORE;GATEWAY_PROVIDER_CACHE_STORE + defaultValue: noop + type: string + description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', + ''nats-js-kv'', ''noop''. See the text description for details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_PROVIDER_CACHE_STORE_NODES: + name: OCIS_CACHE_STORE_NODES;GATEWAY_PROVIDER_CACHE_STORE_NODES + defaultValue: '[127.0.0.1:9233]' + type: '[]string' + description: A list of nodes to access the configured store. This has no effect + when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes + are used is dependent on the library of the configured store. See the Environment + Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_PROVIDER_CACHE_TTL: + name: OCIS_CACHE_TTL;GATEWAY_PROVIDER_CACHE_TTL + defaultValue: 5m0s + type: Duration + description: Default time to live for user info in the cache. Only applied when + access tokens has no expiration. See the Environment Variable Types description + for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_SHARE_FOLDER_NAME: + name: GATEWAY_SHARE_FOLDER_NAME + defaultValue: Shares + type: string + description: Name of the share folder in users' home space. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_SKIP_USER_GROUPS_IN_TOKEN: + name: GATEWAY_SKIP_USER_GROUPS_IN_TOKEN + defaultValue: "false" + type: bool + description: Disables the loading of user's group memberships from the reva access + token. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_STORAGE_REGISTRY_CONFIG_JSON: + name: GATEWAY_STORAGE_REGISTRY_CONFIG_JSON + defaultValue: "" + type: string + description: Additional configuration for the storage registry in json format. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_STORAGE_REGISTRY_DRIVER: + name: GATEWAY_STORAGE_REGISTRY_DRIVER + defaultValue: spaces + type: string + description: The driver name of the storage registry to use. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_STORAGE_REGISTRY_RULES: + name: GATEWAY_STORAGE_REGISTRY_RULES + defaultValue: '[]' + type: '[]string' + description: The rules for the storage registry. See the Environment Variable Types + description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_STORAGE_USERS_MOUNT_ID: + name: GATEWAY_STORAGE_USERS_MOUNT_ID + defaultValue: "" + type: string + description: Mount ID of this storage. Admins can set the ID for the storage in + this config option manually which is then used to reference the storage. Any reasonable + long string is possible, preferably this would be an UUIDv4 format. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;GATEWAY_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;GATEWAY_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;GATEWAY_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_TRACING_TYPE: + name: OCIS_TRACING_TYPE;GATEWAY_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GATEWAY_TRANSFER_EXPIRES: + name: GATEWAY_TRANSFER_EXPIRES + defaultValue: "86400" + type: int + description: Expiry for the gateway tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_APPLICATION_DISPLAYNAME: + name: GRAPH_APPLICATION_DISPLAYNAME + defaultValue: ownCloud Infinite Scale + type: string + description: The ocis application name. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_APPLICATION_ID: + name: GRAPH_APPLICATION_ID + defaultValue: "" + type: string + description: The ocis application ID shown in the graph. All app roles are tied + to this ID. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_ASSIGN_DEFAULT_USER_ROLE: + name: GRAPH_ASSIGN_DEFAULT_USER_ROLE + defaultValue: "true" + type: bool + description: Whether to assign newly created users the default role 'User'. Set + this to 'false' if you want to assign roles manually, or if the role assignment + should happen at first login. Set this to 'true' (the default) to assign the role + 'User' when creating a new user. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_CACHE_AUTH_PASSWORD: + name: OCIS_CACHE_AUTH_PASSWORD;GRAPH_CACHE_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the cache. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_CACHE_AUTH_USERNAME: + name: OCIS_CACHE_AUTH_USERNAME;GRAPH_CACHE_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the cache. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_CACHE_DISABLE_PERSISTENCE: + name: OCIS_CACHE_DISABLE_PERSISTENCE;GRAPH_CACHE_DISABLE_PERSISTENCE + defaultValue: "false" + type: bool + description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' + is configured. Defaults to false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_CACHE_SIZE: + name: OCIS_CACHE_SIZE;GRAPH_CACHE_SIZE + defaultValue: "0" + type: int + description: The maximum quantity of items in the store. Only applies when store + type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package + though not exclicitely set as default. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_CACHE_STORE: + name: OCIS_CACHE_STORE;GRAPH_CACHE_STORE + defaultValue: memory + type: string + description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', + ''nats-js-kv'', ''noop''. See the text description for details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_CACHE_STORE_DATABASE: + name: GRAPH_CACHE_STORE_DATABASE + defaultValue: cache-roles + type: string + description: The database name the configured store should use. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_CACHE_STORE_NODES: + name: OCIS_CACHE_STORE_NODES;GRAPH_CACHE_STORE_NODES + defaultValue: '[127.0.0.1:9233]' + type: '[]string' + description: A list of nodes to access the configured store. This has no effect + when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes + are used is dependent on the library of the configured store. See the Environment + Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_CACHE_STORE_TABLE: + name: GRAPH_CACHE_STORE_TABLE + defaultValue: "" + type: string + description: The database table the store should use. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_CACHE_TTL: + name: OCIS_CACHE_TTL;GRAPH_CACHE_TTL + defaultValue: 336h0m0s + type: Duration + description: Time to live for cache records in the graph. Defaults to '336h' (2 + weeks). See the Environment Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_CORS_ALLOW_CREDENTIALS: + name: OCIS_CORS_ALLOW_CREDENTIALS;GRAPH_CORS_ALLOW_CREDENTIALS + defaultValue: "true" + type: bool + description: 'Allow credentials for CORS.See following chapter for more details: + *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_CORS_ALLOW_HEADERS: + name: OCIS_CORS_ALLOW_HEADERS;GRAPH_CORS_ALLOW_HEADERS + defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id + Purge Restore]' + type: '[]string' + description: 'A list of allowed CORS headers. See following chapter for more details: + *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_CORS_ALLOW_METHODS: + name: OCIS_CORS_ALLOW_METHODS;GRAPH_CORS_ALLOW_METHODS + defaultValue: '[GET POST PUT PATCH DELETE OPTIONS]' + type: '[]string' + description: 'A list of allowed CORS methods. See following chapter for more details: + *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_CORS_ALLOW_ORIGINS: + name: OCIS_CORS_ALLOW_ORIGINS;GRAPH_CORS_ALLOW_ORIGINS + defaultValue: '[*]' + type: '[]string' + description: 'A list of allowed CORS origins. See following chapter for more details: + *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_DEBUG_ADDR: + name: GRAPH_DEBUG_ADDR + defaultValue: 127.0.0.1:9124 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_DEBUG_PPROF: + name: GRAPH_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_DEBUG_TOKEN: + name: GRAPH_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_DEBUG_ZPAGES: + name: GRAPH_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_DISABLE_USER_MECHANISM: + name: OCIS_LDAP_DISABLE_USER_MECHANISM;GRAPH_DISABLE_USER_MECHANISM + defaultValue: attribute + type: string + description: An option to control the behavior for disabling users. Supported options + are 'none', 'attribute' and 'group'. If set to 'group', disabling a user via API + will add the user to the configured group for disabled users, if set to 'attribute' + this will be done in the ldap user entry, if set to 'none' the disable request + is not processed. Default is 'attribute'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_DISABLED_USERS_GROUP_DN: + name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;GRAPH_DISABLED_USERS_GROUP_DN + defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm + type: string + description: The distinguished name of the group to which added users will be classified + as disabled when 'disable_user_mechanism' is set to 'group'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_ENABLE_RESHARING: + name: OCIS_ENABLE_RESHARING;GRAPH_ENABLE_RESHARING + defaultValue: "true" + type: bool + description: Changing this value is NOT supported. Enables the support for resharing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_EVENTS_AUTH_PASSWORD: + name: OCIS_EVENTS_AUTH_PASSWORD;GRAPH_EVENTS_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_EVENTS_AUTH_USERNAME: + name: OCIS_EVENTS_AUTH_USERNAME;GRAPH_EVENTS_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_EVENTS_CLUSTER: + name: OCIS_EVENTS_CLUSTER;GRAPH_EVENTS_CLUSTER + defaultValue: ocis-cluster + type: string + description: The clusterID of the event system. The event system is the message + queuing service. It is used as message broker for the microservice architecture. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_EVENTS_ENABLE_TLS: + name: OCIS_EVENTS_ENABLE_TLS;GRAPH_EVENTS_ENABLE_TLS + defaultValue: "false" + type: bool + description: Enable TLS for the connection to the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_EVENTS_ENDPOINT: + name: OCIS_EVENTS_ENDPOINT;GRAPH_EVENTS_ENDPOINT + defaultValue: 127.0.0.1:9233 + type: string + description: The address of the event system. The event system is the message queuing + service. It is used as message broker for the microservice architecture. Set to + a empty string to disable emitting events. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_EVENTS_TLS_INSECURE: + name: OCIS_INSECURE;GRAPH_EVENTS_TLS_INSECURE + defaultValue: "false" + type: bool + description: Whether to verify the server TLS certificates. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_EVENTS_TLS_ROOT_CA_CERTIFICATE: + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;GRAPH_EVENTS_TLS_ROOT_CA_CERTIFICATE + defaultValue: "" + type: string + description: The root CA certificate used to validate the server's TLS certificate. + If provided GRAPH_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_GROUP_MEMBERS_PATCH_LIMIT: + name: GRAPH_GROUP_MEMBERS_PATCH_LIMIT + defaultValue: "20" + type: int + description: The amount of group members allowed to be added with a single patch + request. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_HTTP_ADDR: + name: GRAPH_HTTP_ADDR + defaultValue: 127.0.0.1:9120 + type: string + description: The bind address of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_HTTP_API_TOKEN: + name: GRAPH_HTTP_API_TOKEN + defaultValue: "" + type: string + description: An optional API bearer token + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_HTTP_ROOT: + name: GRAPH_HTTP_ROOT + defaultValue: /graph + type: string + description: Subdirectory that serves as the root for this HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_IDENTITY_BACKEND: + name: GRAPH_IDENTITY_BACKEND + defaultValue: ldap + type: string + description: The user identity backend to use. Supported backend types are 'ldap' + and 'cs3'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_IDENTITY_SEARCH_MIN_LENGTH: + name: GRAPH_IDENTITY_SEARCH_MIN_LENGTH + defaultValue: "3" + type: int + description: The minimum length the search term needs to have for unprivileged users + when searching for users or groups. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_JWT_SECRET: + name: OCIS_JWT_SECRET;GRAPH_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_KEYCLOAK_BASE_PATH: + name: OCIS_KEYCLOAK_BASE_PATH;GRAPH_KEYCLOAK_BASE_PATH + defaultValue: "" + type: string + description: The URL to access keycloak. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_KEYCLOAK_CLIENT_ID: + name: OCIS_KEYCLOAK_CLIENT_ID;GRAPH_KEYCLOAK_CLIENT_ID + defaultValue: "" + type: string + description: The client id to authenticate with keycloak. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_KEYCLOAK_CLIENT_REALM: + name: OCIS_KEYCLOAK_CLIENT_REALM;GRAPH_KEYCLOAK_CLIENT_REALM + defaultValue: "" + type: string + description: The realm the client is defined in. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_KEYCLOAK_CLIENT_SECRET: + name: OCIS_KEYCLOAK_CLIENT_SECRET;GRAPH_KEYCLOAK_CLIENT_SECRET + defaultValue: "" + type: string + description: The client secret to use in authentication. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_KEYCLOAK_INSECURE_SKIP_VERIFY: + name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;GRAPH_KEYCLOAK_INSECURE_SKIP_VERIFY + defaultValue: "false" + type: bool + description: Disable TLS certificate validation for Keycloak connections. Do not + set this in production environments. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_KEYCLOAK_USER_REALM: + name: OCIS_KEYCLOAK_USER_REALM;GRAPH_KEYCLOAK_USER_REALM + defaultValue: "" + type: string + description: The realm users are defined. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_BIND_DN: + name: OCIS_LDAP_BIND_DN;GRAPH_LDAP_BIND_DN + defaultValue: uid=libregraph,ou=sysusers,o=libregraph-idm + type: string + description: LDAP DN to use for simple bind authentication with the target LDAP + server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_BIND_PASSWORD: + name: OCIS_LDAP_BIND_PASSWORD;GRAPH_LDAP_BIND_PASSWORD + defaultValue: "" + type: string + description: Password to use for authenticating the 'bind_dn'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_CACERT: + name: OCIS_LDAP_CACERT;GRAPH_LDAP_CACERT + defaultValue: /var/lib/ocis/idm/ldap.crt + type: string + description: Path/File name for the root CA certificate (in PEM format) used to + validate TLS server certificates of the LDAP service. If not defined, the root + directory derives from $OCIS_BASE_DATA_PATH:/idm. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_EDUCATION_RESOURCES_ENABLED: + name: GRAPH_LDAP_EDUCATION_RESOURCES_ENABLED + defaultValue: "false" + type: bool + description: Enable LDAP support for managing education related resources. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_GROUP_BASE_DN: + name: OCIS_LDAP_GROUP_BASE_DN;GRAPH_LDAP_GROUP_BASE_DN + defaultValue: ou=groups,o=libregraph-idm + type: string + description: Search base DN for looking up LDAP groups. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_GROUP_CREATE_BASE_DN: + name: GRAPH_LDAP_GROUP_CREATE_BASE_DN + defaultValue: ou=groups,o=libregraph-idm + type: string + description: Parent DN under which new groups are created. This DN needs to be subordinate + to the 'GRAPH_LDAP_GROUP_BASE_DN'. This setting is only relevant when 'GRAPH_LDAP_SERVER_WRITE_ENABLED' + is 'true'. It defaults to the value of 'GRAPH_LDAP_GROUP_BASE_DN'. All groups + outside of this subtree are treated as readonly groups and cannot be updated. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_GROUP_FILTER: + name: OCIS_LDAP_GROUP_FILTER;GRAPH_LDAP_GROUP_FILTER + defaultValue: "" + type: string + description: LDAP filter to add to the default filters for group searches. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_GROUP_ID_ATTRIBUTE: + name: OCIS_LDAP_GROUP_SCHEMA_ID;GRAPH_LDAP_GROUP_ID_ATTRIBUTE + defaultValue: owncloudUUID + type: string + description: LDAP Attribute to use as the unique id for groups. This should be a + stable globally unique ID like a UUID. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_GROUP_MEMBER_ATTRIBUTE: + name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;GRAPH_LDAP_GROUP_MEMBER_ATTRIBUTE + defaultValue: member + type: string + description: LDAP Attribute that is used for group members. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_GROUP_NAME_ATTRIBUTE: + name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;GRAPH_LDAP_GROUP_NAME_ATTRIBUTE + defaultValue: cn + type: string + description: LDAP Attribute to use for the name of groups. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_GROUP_OBJECTCLASS: + name: OCIS_LDAP_GROUP_OBJECTCLASS;GRAPH_LDAP_GROUP_OBJECTCLASS + defaultValue: groupOfNames + type: string + description: The object class to use for groups in the default group search filter + ('groupOfNames'). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING: + name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;GRAPH_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING + defaultValue: "false" + type: bool + description: Set this to true if the defined 'ID' attribute for groups is of the + 'OCTETSTRING' syntax. This is required when using the 'objectGUID' attribute of + Active Directory for the group ID's. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_GROUP_SEARCH_SCOPE: + name: OCIS_LDAP_GROUP_SCOPE;GRAPH_LDAP_GROUP_SEARCH_SCOPE + defaultValue: sub + type: string + description: LDAP search scope to use when looking up groups. Supported scopes are + 'base', 'one' and 'sub'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_INSECURE: + name: OCIS_LDAP_INSECURE;GRAPH_LDAP_INSECURE + defaultValue: "false" + type: bool + description: Disable TLS certificate validation for the LDAP connections. Do not + set this in production environments. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_REFINT_ENABLED: + name: GRAPH_LDAP_REFINT_ENABLED + defaultValue: "false" + type: bool + description: Signals that the server has the refint plugin enabled, which makes + some actions not needed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_SCHOOL_BASE_DN: + name: GRAPH_LDAP_SCHOOL_BASE_DN + defaultValue: "" + type: string + description: Search base DN for looking up LDAP schools. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_SCHOOL_FILTER: + name: GRAPH_LDAP_SCHOOL_FILTER + defaultValue: "" + type: string + description: LDAP filter to add to the default filters for school searches. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_SCHOOL_ID_ATTRIBUTE: + name: GRAPH_LDAP_SCHOOL_ID_ATTRIBUTE + defaultValue: "" + type: string + description: LDAP Attribute to use as the unique id for schools. This should be + a stable globally unique ID like a UUID. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_SCHOOL_NAME_ATTRIBUTE: + name: GRAPH_LDAP_SCHOOL_NAME_ATTRIBUTE + defaultValue: "" + type: string + description: LDAP Attribute to use for the name of a school. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_SCHOOL_NUMBER_ATTRIBUTE: + name: GRAPH_LDAP_SCHOOL_NUMBER_ATTRIBUTE + defaultValue: "" + type: string + description: LDAP Attribute to use for the number of a school. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_SCHOOL_OBJECTCLASS: + name: GRAPH_LDAP_SCHOOL_OBJECTCLASS + defaultValue: "" + type: string + description: The object class to use for schools in the default school search filter. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_SCHOOL_SEARCH_SCOPE: + name: GRAPH_LDAP_SCHOOL_SEARCH_SCOPE + defaultValue: "" + type: string + description: LDAP search scope to use when looking up schools. Supported scopes + are 'base', 'one' and 'sub'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_SCHOOL_TERMINATION_MIN_GRACE_DAYS: + name: GRAPH_LDAP_SCHOOL_TERMINATION_MIN_GRACE_DAYS + defaultValue: "0" + type: int + description: When setting a 'terminationDate' for a school, require the date to + be at least this number of days in the future. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_SERVER_USE_PASSWORD_MODIFY_EXOP: + name: GRAPH_LDAP_SERVER_USE_PASSWORD_MODIFY_EXOP + defaultValue: "true" + type: bool + description: Use the 'Password Modify Extended Operation' for updating user passwords. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_SERVER_UUID: + name: GRAPH_LDAP_SERVER_UUID + defaultValue: "false" + type: bool + description: If set to true, rely on the LDAP Server to generate a unique ID for + users and groups, like when using 'entryUUID' as the user ID attribute. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_SERVER_WRITE_ENABLED: + name: OCIS_LDAP_SERVER_WRITE_ENABLED;GRAPH_LDAP_SERVER_WRITE_ENABLED + defaultValue: "true" + type: bool + description: Allow creating, modifying and deleting LDAP users via the GRAPH API. + This can only be set to 'true' when keeping default settings for the LDAP user + and group attribute types (the 'OCIS_LDAP_USER_SCHEMA_* and 'OCIS_LDAP_GROUP_SCHEMA_* + variables). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_URI: + name: OCIS_LDAP_URI;GRAPH_LDAP_URI + defaultValue: ldaps://localhost:9235 + type: string + description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' + and 'ldap://' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_USER_BASE_DN: + name: OCIS_LDAP_USER_BASE_DN;GRAPH_LDAP_USER_BASE_DN + defaultValue: ou=users,o=libregraph-idm + type: string + description: Search base DN for looking up LDAP users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_USER_DISPLAYNAME_ATTRIBUTE: + name: LDAP_USER_SCHEMA_DISPLAY_NAME;GRAPH_LDAP_USER_DISPLAYNAME_ATTRIBUTE + defaultValue: displayName + type: string + description: LDAP Attribute to use for the displayname of users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_USER_EMAIL_ATTRIBUTE: + name: OCIS_LDAP_USER_SCHEMA_MAIL;GRAPH_LDAP_USER_EMAIL_ATTRIBUTE + defaultValue: mail + type: string + description: LDAP Attribute to use for the email address of users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_USER_FILTER: + name: OCIS_LDAP_USER_FILTER;GRAPH_LDAP_USER_FILTER + defaultValue: "" + type: string + description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_USER_NAME_ATTRIBUTE: + name: OCIS_LDAP_USER_SCHEMA_USERNAME;GRAPH_LDAP_USER_NAME_ATTRIBUTE + defaultValue: uid + type: string + description: LDAP Attribute to use for username of users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_USER_OBJECTCLASS: + name: OCIS_LDAP_USER_OBJECTCLASS;GRAPH_LDAP_USER_OBJECTCLASS + defaultValue: inetOrgPerson + type: string + description: The object class to use for users in the default user search filter + ('inetOrgPerson'). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING: + name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;GRAPH_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING + defaultValue: "false" + type: bool + description: Set this to true if the defined 'ID' attribute for users is of the + 'OCTETSTRING' syntax. This is required when using the 'objectGUID' attribute of + Active Directory for the user ID's. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_USER_SCOPE: + name: OCIS_LDAP_USER_SCOPE;GRAPH_LDAP_USER_SCOPE + defaultValue: sub + type: string + description: LDAP search scope to use when looking up users. Supported scopes are + 'base', 'one' and 'sub'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_USER_TYPE_ATTRIBUTE: + name: OCIS_LDAP_USER_SCHEMA_USER_TYPE;GRAPH_LDAP_USER_TYPE_ATTRIBUTE + defaultValue: ownCloudUserType + type: string + description: LDAP Attribute to distinguish between 'Member' and 'Guest' users. Default + is 'ownCloudUserType'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LDAP_USER_UID_ATTRIBUTE: + name: OCIS_LDAP_USER_SCHEMA_ID;GRAPH_LDAP_USER_UID_ATTRIBUTE + defaultValue: owncloudUUID + type: string + description: LDAP Attribute to use as the unique ID for users. This should be a + stable globally unique ID like a UUID. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LOG_COLOR: + name: OCIS_LOG_COLOR;GRAPH_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LOG_FILE: + name: OCIS_LOG_FILE;GRAPH_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LOG_LEVEL: + name: OCIS_LOG_LEVEL;GRAPH_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_LOG_PRETTY: + name: OCIS_LOG_PRETTY;GRAPH_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_SERVICE_ACCOUNT_ID: + name: OCIS_SERVICE_ACCOUNT_ID;GRAPH_SERVICE_ACCOUNT_ID + defaultValue: "" + type: string + description: The ID of the service account the service should use. See the 'auth-service' + service description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_SERVICE_ACCOUNT_SECRET: + name: OCIS_SERVICE_ACCOUNT_SECRET;GRAPH_SERVICE_ACCOUNT_SECRET + defaultValue: "" + type: string + description: The service account secret. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_SPACES_DEFAULT_QUOTA: + name: GRAPH_SPACES_DEFAULT_QUOTA + defaultValue: "1000000000" + type: string + description: The default quota in bytes. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_SPACES_EXTENDED_SPACE_PROPERTIES_CACHE_TTL: + name: GRAPH_SPACES_EXTENDED_SPACE_PROPERTIES_CACHE_TTL + defaultValue: "60000000000" + type: int + description: Max TTL in seconds for the spaces property cache. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_SPACES_GROUPS_CACHE_TTL: + name: GRAPH_SPACES_GROUPS_CACHE_TTL + defaultValue: "60000000000" + type: int + description: Max TTL in seconds for the spaces groups cache. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_SPACES_USERS_CACHE_TTL: + name: GRAPH_SPACES_USERS_CACHE_TTL + defaultValue: "60000000000" + type: int + description: Max TTL in seconds for the spaces users cache. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_SPACES_WEBDAV_BASE: + name: OCIS_URL;GRAPH_SPACES_WEBDAV_BASE + defaultValue: https://localhost:9200 + type: string + description: The public facing URL of WebDAV. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_SPACES_WEBDAV_PATH: + name: GRAPH_SPACES_WEBDAV_PATH + defaultValue: /dav/spaces/ + type: string + description: The WebDAV subpath for spaces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;GRAPH_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;GRAPH_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;GRAPH_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_TRACING_TYPE: + name: OCIS_TRACING_TYPE;GRAPH_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_USER_ENABLED_ATTRIBUTE: + name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;GRAPH_USER_ENABLED_ATTRIBUTE + defaultValue: ownCloudUserEnabled + type: string + description: LDAP Attribute to use as a flag telling if the user is enabled or disabled. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GRAPH_USERNAME_MATCH: + name: GRAPH_USERNAME_MATCH + defaultValue: default + type: string + description: Apply restrictions to usernames. Supported values are 'default' and + 'none'. When set to 'default', user names must not start with a number and are + restricted to ASCII characters. When set to 'none', no restrictions are applied. + The default value is 'default'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_DEBUG_ADDR: + name: GROUPS_DEBUG_ADDR + defaultValue: 127.0.0.1:9161 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_DEBUG_PPROF: + name: GROUPS_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_DEBUG_TOKEN: + name: GROUPS_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_DEBUG_ZPAGES: + name: GROUPS_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_DRIVER: + name: GROUPS_DRIVER + defaultValue: ldap + type: string + description: The driver which should be used by the groups service. Supported values + are 'ldap' and 'owncloudsql'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_GRPC_ADDR: + name: GROUPS_GRPC_ADDR + defaultValue: 127.0.0.1:9160 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_GRPC_PROTOCOL: + name: GROUPS_GRPC_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_IDP_URL: + name: OCIS_URL;OCIS_OIDC_ISSUER;GROUPS_IDP_URL + defaultValue: https://localhost:9200 + type: string + description: The identity provider value to set in the group IDs of the CS3 group + objects for groups returned by this group provider. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_JWT_SECRET: + name: OCIS_JWT_SECRET;GROUPS_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_BIND_DN: + name: OCIS_LDAP_BIND_DN;GROUPS_LDAP_BIND_DN + defaultValue: uid=reva,ou=sysusers,o=libregraph-idm + type: string + description: LDAP DN to use for simple bind authentication with the target LDAP + server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_BIND_PASSWORD: + name: OCIS_LDAP_BIND_PASSWORD;GROUPS_LDAP_BIND_PASSWORD + defaultValue: "" + type: string + description: Password to use for authenticating the 'bind_dn'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_CACERT: + name: OCIS_LDAP_CACERT;GROUPS_LDAP_CACERT + defaultValue: /var/lib/ocis/idm/ldap.crt + type: string + description: Path/File name for the root CA certificate (in PEM format) used to + validate TLS server certificates of the LDAP service. If not defined, the root + directory derives from $OCIS_BASE_DATA_PATH:/idm. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_GROUP_BASE_DN: + name: OCIS_LDAP_GROUP_BASE_DN;GROUPS_LDAP_GROUP_BASE_DN + defaultValue: ou=groups,o=libregraph-idm + type: string + description: Search base DN for looking up LDAP groups. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_GROUP_FILTER: + name: OCIS_LDAP_GROUP_FILTER;GROUPS_LDAP_GROUP_FILTER + defaultValue: "" + type: string + description: LDAP filter to add to the default filters for group searches. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_GROUP_OBJECTCLASS: + name: OCIS_LDAP_GROUP_OBJECTCLASS;GROUPS_LDAP_GROUP_OBJECTCLASS + defaultValue: groupOfNames + type: string + description: The object class to use for groups in the default group search filter + ('groupOfNames'). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_GROUP_SCHEMA_DISPLAYNAME: + name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;GROUPS_LDAP_GROUP_SCHEMA_DISPLAYNAME + defaultValue: cn + type: string + description: LDAP Attribute to use for the displayname of groups (often the same + as groupname attribute). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_GROUP_SCHEMA_GROUPNAME: + name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;GROUPS_LDAP_GROUP_SCHEMA_GROUPNAME + defaultValue: cn + type: string + description: LDAP Attribute to use for the name of groups. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_GROUP_SCHEMA_ID: + name: OCIS_LDAP_GROUP_SCHEMA_ID;GROUPS_LDAP_GROUP_SCHEMA_ID + defaultValue: ownclouduuid + type: string + description: LDAP Attribute to use as the unique id for groups. This should be a + stable globally unique ID like a UUID. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING: + name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;GROUPS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING + defaultValue: "false" + type: bool + description: Set this to true if the defined 'id' attribute for groups is of the + 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute + of Active Directory for the group ID's. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_GROUP_SCHEMA_MAIL: + name: OCIS_LDAP_GROUP_SCHEMA_MAIL;GROUPS_LDAP_GROUP_SCHEMA_MAIL + defaultValue: mail + type: string + description: LDAP Attribute to use for the email address of groups (can be empty). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_GROUP_SCHEMA_MEMBER: + name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;GROUPS_LDAP_GROUP_SCHEMA_MEMBER + defaultValue: member + type: string + description: LDAP Attribute that is used for group members. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_GROUP_SCOPE: + name: OCIS_LDAP_GROUP_SCOPE;GROUPS_LDAP_GROUP_SCOPE + defaultValue: sub + type: string + description: LDAP search scope to use when looking up groups. Supported scopes are + 'base', 'one' and 'sub'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_GROUP_SUBSTRING_FILTER_TYPE: + name: LDAP_GROUP_SUBSTRING_FILTER_TYPE;GROUPS_LDAP_GROUP_SUBSTRING_FILTER_TYPE + defaultValue: any + type: string + description: Type of substring search filter to use for substring searches for groups. + Supported values are 'initial', 'final' and 'any'. The value 'initial' is used + for doing prefix only searches, 'final' for doing suffix only searches or 'any' + for doing full substring searches + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_INSECURE: + name: OCIS_LDAP_INSECURE;GROUPS_LDAP_INSECURE + defaultValue: "false" + type: bool + description: Disable TLS certificate validation for the LDAP connections. Do not + set this in production environments. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_URI: + name: OCIS_LDAP_URI;GROUPS_LDAP_URI + defaultValue: ldaps://localhost:9235 + type: string + description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' + and 'ldap://' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_USER_BASE_DN: + name: OCIS_LDAP_USER_BASE_DN;GROUPS_LDAP_USER_BASE_DN + defaultValue: ou=users,o=libregraph-idm + type: string + description: Search base DN for looking up LDAP users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_USER_FILTER: + name: OCIS_LDAP_USER_FILTER;GROUPS_LDAP_USER_FILTER + defaultValue: "" + type: string + description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_USER_OBJECTCLASS: + name: OCIS_LDAP_USER_OBJECTCLASS;GROUPS_LDAP_USER_OBJECTCLASS + defaultValue: inetOrgPerson + type: string + description: The object class to use for users in the default user search filter + ('inetOrgPerson'). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_USER_SCHEMA_DISPLAYNAME: + name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;GROUPS_LDAP_USER_SCHEMA_DISPLAYNAME + defaultValue: displayname + type: string + description: LDAP Attribute to use for the displayname of users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_USER_SCHEMA_ID: + name: OCIS_LDAP_USER_SCHEMA_ID;GROUPS_LDAP_USER_SCHEMA_ID + defaultValue: ownclouduuid + type: string + description: LDAP Attribute to use as the unique id for users. This should be a + stable globally unique id like a UUID. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING: + name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;GROUPS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING + defaultValue: "false" + type: bool + description: Set this to true if the defined 'ID' attribute for users is of the + 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute + of Active Directory for the user ID's. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_USER_SCHEMA_MAIL: + name: OCIS_LDAP_USER_SCHEMA_MAIL;GROUPS_LDAP_USER_SCHEMA_MAIL + defaultValue: mail + type: string + description: LDAP Attribute to use for the email address of users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_USER_SCHEMA_USERNAME: + name: OCIS_LDAP_USER_SCHEMA_USERNAME;GROUPS_LDAP_USER_SCHEMA_USERNAME + defaultValue: uid + type: string + description: LDAP Attribute to use for username of users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LDAP_USER_SCOPE: + name: OCIS_LDAP_USER_SCOPE;GROUPS_LDAP_USER_SCOPE + defaultValue: sub + type: string + description: LDAP search scope to use when looking up users. Supported scopes are + 'base', 'one' and 'sub'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LOG_COLOR: + name: OCIS_LOG_COLOR;GROUPS_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LOG_FILE: + name: OCIS_LOG_FILE;GROUPS_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LOG_LEVEL: + name: OCIS_LOG_LEVEL;GROUPS_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_LOG_PRETTY: + name: OCIS_LOG_PRETTY;GROUPS_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_OWNCLOUDSQL_DB_HOST: + name: GROUPS_OWNCLOUDSQL_DB_HOST + defaultValue: mysql + type: string + description: Hostname of the database server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_OWNCLOUDSQL_DB_NAME: + name: GROUPS_OWNCLOUDSQL_DB_NAME + defaultValue: owncloud + type: string + description: Name of the owncloud database. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_OWNCLOUDSQL_DB_PASSWORD: + name: GROUPS_OWNCLOUDSQL_DB_PASSWORD + defaultValue: "" + type: string + description: Password for the database user. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_OWNCLOUDSQL_DB_PORT: + name: GROUPS_OWNCLOUDSQL_DB_PORT + defaultValue: "3306" + type: int + description: Network port to use for the database connection. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_OWNCLOUDSQL_DB_USERNAME: + name: GROUPS_OWNCLOUDSQL_DB_USERNAME + defaultValue: owncloud + type: string + description: Database user to use for authenticating with the owncloud database. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH: + name: GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH + defaultValue: "false" + type: bool + description: Allow 'medial search' when searching for users instead of just doing + a prefix search. This allows finding 'Alice' when searching for 'lic'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_OWNCLOUDSQL_IDP: + name: GROUPS_OWNCLOUDSQL_IDP + defaultValue: https://localhost:9200 + type: string + description: The identity provider value to set in the userids of the CS3 user objects + for users returned by this user provider. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID: + name: GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID + defaultValue: "false" + type: bool + description: Join the user properties table to read user IDs. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_OWNCLOUDSQL_JOIN_USERNAME: + name: GROUPS_OWNCLOUDSQL_JOIN_USERNAME + defaultValue: "false" + type: bool + description: Join the user properties table to read usernames. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_OWNCLOUDSQL_NOBODY: + name: GROUPS_OWNCLOUDSQL_NOBODY + defaultValue: "90" + type: int64 + description: Fallback number if no numeric UID and GID properties are provided. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_SKIP_USER_GROUPS_IN_TOKEN: + name: GROUPS_SKIP_USER_GROUPS_IN_TOKEN + defaultValue: "false" + type: bool + description: Disables the loading of user's group memberships from the reva access + token. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;GROUPS_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;GROUPS_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;GROUPS_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +GROUPS_TRACING_TYPE: + name: OCIS_TRACING_TYPE;GROUPS_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_ADMIN_PASSWORD: + name: IDM_ADMIN_PASSWORD + defaultValue: "" + type: string + description: Password to set for the oCIS 'admin' user. Either cleartext or an argon2id + hash. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_ADMIN_USER_ID: + name: OCIS_ADMIN_USER_ID;IDM_ADMIN_USER_ID + defaultValue: "" + type: string + description: ID of the user that should receive admin privileges. Consider that + the UUID can be encoded in some LDAP deployment configurations like in .ldif files. + These need to be decoded beforehand. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_CREATE_DEMO_USERS: + name: SETTINGS_SETUP_DEFAULT_ASSIGNMENTS;IDM_CREATE_DEMO_USERS + defaultValue: "false" + type: bool + description: The default role assignments the demo users should be setup. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_DATABASE_PATH: + name: IDM_DATABASE_PATH + defaultValue: /var/lib/ocis/idm/ocis.boltdb + type: string + description: Full path to the IDM backend database. If not defined, the root directory + derives from $OCIS_BASE_DATA_PATH:/idm. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_DEBUG_ADDR: + name: IDM_DEBUG_ADDR + defaultValue: 127.0.0.1:9239 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_DEBUG_PPROF: + name: IDM_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_DEBUG_TOKEN: + name: IDM_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_DEBUG_ZPAGES: + name: IDM_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_IDPSVC_PASSWORD: + name: IDM_IDPSVC_PASSWORD + defaultValue: "" + type: string + description: Password to set for the 'idp' service user. Either cleartext or an + argon2id hash. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_LDAPS_ADDR: + name: IDM_LDAPS_ADDR + defaultValue: 127.0.0.1:9235 + type: string + description: Listen address for the LDAPS listener (ip-addr:port). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_LDAPS_CERT: + name: IDM_LDAPS_CERT + defaultValue: /var/lib/ocis/idm/ldap.crt + type: string + description: File name of the TLS server certificate for the LDAPS listener. If + not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_LDAPS_KEY: + name: IDM_LDAPS_KEY + defaultValue: /var/lib/ocis/idm/ldap.key + type: string + description: File name for the TLS certificate key for the server certificate. If + not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_LOG_COLOR: + name: OCIS_LOG_COLOR;IDM_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_LOG_FILE: + name: OCIS_LOG_FILE;IDM_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_LOG_LEVEL: + name: OCIS_LOG_LEVEL;IDM_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_LOG_PRETTY: + name: OCIS_LOG_PRETTY;IDM_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_REVASVC_PASSWORD: + name: IDM_REVASVC_PASSWORD + defaultValue: "" + type: string + description: Password to set for the 'reva' service user. Either cleartext or an + argon2id hash. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_SVC_PASSWORD: + name: IDM_SVC_PASSWORD + defaultValue: "" + type: string + description: Password to set for the 'idm' service user. Either cleartext or an + argon2id hash. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;IDM_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;IDM_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;IDM_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDM_TRACING_TYPE: + name: OCIS_TRACING_TYPE;IDM_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_ACCESS_TOKEN_EXPIRATION: + name: IDP_ACCESS_TOKEN_EXPIRATION + defaultValue: "300" + type: uint64 + description: '''Access token lifespan in seconds (time before an access token is + expired).''' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_ALLOW_CLIENT_GUESTS: + name: IDP_ALLOW_CLIENT_GUESTS + defaultValue: "false" + type: bool + description: Allow guest clients to access oCIS. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_ALLOW_DYNAMIC_CLIENT_REGISTRATION: + name: IDP_ALLOW_DYNAMIC_CLIENT_REGISTRATION + defaultValue: "false" + type: bool + description: Allow dynamic client registration. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_ASSET_PATH: + name: IDP_ASSET_PATH + defaultValue: "" + type: string + description: Serve IDP assets from a path on the filesystem instead of the builtin + assets. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_DEBUG_ADDR: + name: IDP_DEBUG_ADDR + defaultValue: 127.0.0.1:9134 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_DEBUG_PPROF: + name: IDP_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_DEBUG_TOKEN: + name: IDP_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_DEBUG_ZPAGES: + name: IDP_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_DYNAMIC_CLIENT_SECRET_DURATION: + name: IDP_DYNAMIC_CLIENT_SECRET_DURATION + defaultValue: "0" + type: uint64 + description: Lifespan in seconds of a dynamically registered OIDC client. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_ENCRYPTION_SECRET_FILE: + name: IDP_ENCRYPTION_SECRET_FILE + defaultValue: /var/lib/ocis/idp/encryption.key + type: string + description: Path to the encryption secret file, if unset, a new certificate will + be autogenerated upon each restart, thus invalidating all existing sessions. If + not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idp. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_ENDPOINT_URI: + name: IDP_ENDPOINT_URI + defaultValue: "" + type: string + description: URL of the IDP endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_HTTP_ADDR: + name: IDP_HTTP_ADDR + defaultValue: 127.0.0.1:9130 + type: string + description: The bind address of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_HTTP_ROOT: + name: IDP_HTTP_ROOT + defaultValue: / + type: string + description: Subdirectory that serves as the root for this HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_ID_TOKEN_EXPIRATION: + name: IDP_ID_TOKEN_EXPIRATION + defaultValue: "300" + type: uint64 + description: ID token lifespan in seconds (time before an ID token is expired). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_IDENTITY_MANAGER: + name: IDP_IDENTITY_MANAGER + defaultValue: ldap + type: string + description: The identity manager implementation to use. Supported identity managers + are 'ldap', 'cs3', 'libregraph' and 'guest'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_INSECURE: + name: OCIS_LDAP_INSECURE;IDP_INSECURE + defaultValue: "false" + type: bool + description: Disable TLS certificate validation for the LDAP connections. Do not + set this in production environments. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_ISS: + name: OCIS_URL;OCIS_OIDC_ISSUER;IDP_ISS + defaultValue: https://localhost:9200 + type: string + description: The OIDC issuer URL to use. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LDAP_BASE_DN: + name: OCIS_LDAP_USER_BASE_DN;IDP_LDAP_BASE_DN + defaultValue: ou=users,o=libregraph-idm + type: string + description: Search base DN for looking up LDAP users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LDAP_BIND_DN: + name: OCIS_LDAP_BIND_DN;IDP_LDAP_BIND_DN + defaultValue: uid=idp,ou=sysusers,o=libregraph-idm + type: string + description: LDAP DN to use for simple bind authentication with the target LDAP + server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LDAP_BIND_PASSWORD: + name: OCIS_LDAP_BIND_PASSWORD;IDP_LDAP_BIND_PASSWORD + defaultValue: "" + type: string + description: Password to use for authenticating the 'bind_dn'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LDAP_EMAIL_ATTRIBUTE: + name: OCIS_LDAP_USER_SCHEMA_MAIL;IDP_LDAP_EMAIL_ATTRIBUTE + defaultValue: mail + type: string + description: LDAP User email attribute like 'mail'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LDAP_FILTER: + name: OCIS_LDAP_USER_FILTER;IDP_LDAP_FILTER + defaultValue: "" + type: string + description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LDAP_LOGIN_ATTRIBUTE: + name: IDP_LDAP_LOGIN_ATTRIBUTE + defaultValue: uid + type: string + description: LDAP User attribute to use for login like 'uid'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LDAP_NAME_ATTRIBUTE: + name: OCIS_LDAP_USER_SCHEMA_USERNAME;IDP_LDAP_NAME_ATTRIBUTE + defaultValue: displayName + type: string + description: LDAP User name attribute like 'displayName'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LDAP_OBJECTCLASS: + name: OCIS_LDAP_USER_OBJECTCLASS;IDP_LDAP_OBJECTCLASS + defaultValue: inetOrgPerson + type: string + description: LDAP User ObjectClass like 'inetOrgPerson'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LDAP_SCOPE: + name: OCIS_LDAP_USER_SCOPE;IDP_LDAP_SCOPE + defaultValue: sub + type: string + description: LDAP search scope to use when looking up users. Supported scopes are + 'base', 'one' and 'sub'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LDAP_TLS_CACERT: + name: OCIS_LDAP_CACERT;IDP_LDAP_TLS_CACERT + defaultValue: /var/lib/ocis/idm/ldap.crt + type: string + description: Path/File name for the root CA certificate (in PEM format) used to + validate TLS server certificates of the LDAP service. If not defined, the root + directory derives from $OCIS_BASE_DATA_PATH:/idp. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LDAP_URI: + name: OCIS_LDAP_URI;IDP_LDAP_URI + defaultValue: ldaps://localhost:9235 + type: string + description: Url of the LDAP service to use as IDP. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LDAP_UUID_ATTRIBUTE: + name: OCIS_LDAP_USER_SCHEMA_ID;IDP_LDAP_UUID_ATTRIBUTE + defaultValue: ownCloudUUID + type: string + description: LDAP User UUID attribute like 'uid'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LDAP_UUID_ATTRIBUTE_TYPE: + name: IDP_LDAP_UUID_ATTRIBUTE_TYPE + defaultValue: text + type: string + description: LDAP User uuid attribute type like 'text'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LOG_COLOR: + name: OCIS_LOG_COLOR;IDP_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LOG_FILE: + name: OCIS_LOG_FILE;IDP_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LOG_LEVEL: + name: OCIS_LOG_LEVEL;IDP_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LOG_PRETTY: + name: OCIS_LOG_PRETTY;IDP_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_LOGIN_BACKGROUND_URL: + name: IDP_LOGIN_BACKGROUND_URL + defaultValue: "" + type: string + description: Configure an alternative URL to the background image for the login + page. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_MACHINE_AUTH_API_KEY: + name: OCIS_MACHINE_AUTH_API_KEY;IDP_MACHINE_AUTH_API_KEY + defaultValue: "" + type: string + description: Machine auth API key used to validate internal requests necessary for + the access to resources from other services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_PASSWORD_RESET_URI: + name: IDP_PASSWORD_RESET_URI + defaultValue: "" + type: string + description: The URI where a user can reset their password. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_REFRESH_TOKEN_EXPIRATION: + name: IDP_REFRESH_TOKEN_EXPIRATION + defaultValue: "2592000" + type: uint64 + description: Refresh token lifespan in seconds (time before an refresh token is + expired). This also limits the duration of an idle offline session. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_SIGN_IN_URI: + name: IDP_SIGN_IN_URI + defaultValue: "" + type: string + description: IDP sign-in url. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_SIGN_OUT_URI: + name: IDP_SIGN_OUT_URI + defaultValue: "" + type: string + description: IDP sign-out url. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_SIGNING_KID: + name: IDP_SIGNING_KID + defaultValue: private-key + type: string + description: Value of the KID (Key ID) field which is used in created tokens to + uniquely identify the signing-private-key. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_SIGNING_METHOD: + name: IDP_SIGNING_METHOD + defaultValue: PS256 + type: string + description: Signing method of IDP requests like 'PS256' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_SIGNING_PRIVATE_KEY_FILES: + name: IDP_SIGNING_PRIVATE_KEY_FILES + defaultValue: '[/var/lib/ocis/idp/private-key.pem]' + type: '[]string' + description: A list of private key files for signing IDP requests. If not defined, + the root directory derives from $OCIS_BASE_DATA_PATH:/idp. See the Environment + Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_TLS: + name: IDP_TLS + defaultValue: "false" + type: bool + description: Disable or Enable HTTPS for the communication between the Proxy service + and the IDP service. If set to 'true', the key and cert files need to be configured + and present. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;IDP_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;IDP_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;IDP_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_TRACING_TYPE: + name: OCIS_TRACING_TYPE;IDP_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_TRANSPORT_TLS_CERT: + name: IDP_TRANSPORT_TLS_CERT + defaultValue: /var/lib/ocis/idp/server.crt + type: string + description: Path/File name of the TLS server certificate (in PEM format) for the + IDP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idp. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_TRANSPORT_TLS_KEY: + name: IDP_TRANSPORT_TLS_KEY + defaultValue: /var/lib/ocis/idp/server.key + type: string + description: Path/File name for the TLS certificate key (in PEM format) for the + server certificate to use for the IDP service. If not defined, the root directory + derives from $OCIS_BASE_DATA_PATH:/idp. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_URI_BASE_PATH: + name: IDP_URI_BASE_PATH + defaultValue: "" + type: string + description: IDP uri base path (defaults to ''). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_USER_ENABLED_ATTRIBUTE: + name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;IDP_USER_ENABLED_ATTRIBUTE + defaultValue: ownCloudUserEnabled + type: string + description: LDAP Attribute to use as a flag telling if the user is enabled or disabled. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +IDP_VALIDATION_KEYS_PATH: + name: IDP_VALIDATION_KEYS_PATH + defaultValue: "" + type: string + description: Path to validation keys for IDP requests. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_CORS_ALLOW_CREDENTIALS: + name: OCIS_CORS_ALLOW_CREDENTIALS;INVITATIONS_CORS_ALLOW_CREDENTIALS + defaultValue: "false" + type: bool + description: 'Allow credentials for CORS.See following chapter for more details: + *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_CORS_ALLOW_HEADERS: + name: OCIS_CORS_ALLOW_HEADERS;INVITATIONS_CORS_ALLOW_HEADERS + defaultValue: '[]' + type: '[]string' + description: 'A list of allowed CORS headers. See following chapter for more details: + *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_CORS_ALLOW_METHODS: + name: OCIS_CORS_ALLOW_METHODS;INVITATIONS_CORS_ALLOW_METHODS + defaultValue: '[]' + type: '[]string' + description: 'A list of allowed CORS methods. See following chapter for more details: + *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_CORS_ALLOW_ORIGINS: + name: OCIS_CORS_ALLOW_ORIGINS;INVITATIONS_CORS_ALLOW_ORIGINS + defaultValue: '[*]' + type: '[]string' + description: 'A list of allowed CORS origins. See following chapter for more details: + *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_DEBUG_ADDR: + name: INVITATIONS_DEBUG_ADDR + defaultValue: 127.0.0.1:0 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_DEBUG_PPROF: + name: INVITATIONS_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_DEBUG_TOKEN: + name: INVITATIONS_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_DEBUG_ZPAGES: + name: INVITATIONS_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_HTTP_ADDR: + name: INVITATIONS_HTTP_ADDR + defaultValue: 127.0.0.1:0 + type: string + description: The bind address of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_HTTP_ROOT: + name: INVITATIONS_HTTP_ROOT + defaultValue: /graph/v1.0 + type: string + description: Subdirectory that serves as the root for this HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_JWT_SECRET: + name: OCIS_JWT_SECRET;INVITATIONS_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_KEYCLOAK_BASE_PATH: + name: OCIS_KEYCLOAK_BASE_PATH;INVITATIONS_KEYCLOAK_BASE_PATH + defaultValue: "" + type: string + description: The URL to access keycloak. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_KEYCLOAK_CLIENT_ID: + name: OCIS_KEYCLOAK_CLIENT_ID;INVITATIONS_KEYCLOAK_CLIENT_ID + defaultValue: "" + type: string + description: The client ID to authenticate with keycloak. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_KEYCLOAK_CLIENT_REALM: + name: OCIS_KEYCLOAK_CLIENT_REALM;INVITATIONS_KEYCLOAK_CLIENT_REALM + defaultValue: "" + type: string + description: The realm the client is defined in. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_KEYCLOAK_CLIENT_SECRET: + name: OCIS_KEYCLOAK_CLIENT_SECRET;INVITATIONS_KEYCLOAK_CLIENT_SECRET + defaultValue: "" + type: string + description: The client secret to use in authentication. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_KEYCLOAK_INSECURE_SKIP_VERIFY: + name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;INVITATIONS_KEYCLOAK_INSECURE_SKIP_VERIFY + defaultValue: "false" + type: bool + description: Disable TLS certificate validation for Keycloak connections. Do not + set this in production environments. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_KEYCLOAK_USER_REALM: + name: OCIS_KEYCLOAK_USER_REALM;INVITATIONS_KEYCLOAK_USER_REALM + defaultValue: "" + type: string + description: The realm users are defined. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_LOG_COLOR: + name: OCIS_LOG_COLOR;INVITATIONS_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_LOG_FILE: + name: OCIS_LOG_FILE;INVITATIONS_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_LOG_LEVEL: + name: OCIS_LOG_LEVEL;INVITATIONS_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_LOG_PRETTY: + name: OCIS_LOG_PRETTY;INVITATIONS_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;INVITATIONS_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;INVITATIONS_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;INVITATIONS_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +INVITATIONS_TRACING_TYPE: + name: OCIS_TRACING_TYPE;INVITATIONS_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +LDAP_GROUP_SUBSTRING_FILTER_TYPE: + name: LDAP_GROUP_SUBSTRING_FILTER_TYPE;GROUPS_LDAP_GROUP_SUBSTRING_FILTER_TYPE + defaultValue: any + type: string + description: Type of substring search filter to use for substring searches for groups. + Supported values are 'initial', 'final' and 'any'. The value 'initial' is used + for doing prefix only searches, 'final' for doing suffix only searches or 'any' + for doing full substring searches + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +LDAP_LOGIN_ATTRIBUTES: + name: LDAP_LOGIN_ATTRIBUTES;AUTH_BASIC_LDAP_LOGIN_ATTRIBUTES + defaultValue: '[uid]' + type: '[]string' + description: A list of user object attributes that can be used for login. See the + Environment Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +LDAP_USER_SCHEMA_DISPLAY_NAME: + name: LDAP_USER_SCHEMA_DISPLAY_NAME;GRAPH_LDAP_USER_DISPLAYNAME_ATTRIBUTE + defaultValue: displayName + type: string + description: LDAP Attribute to use for the displayname of users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +LDAP_USER_SUBSTRING_FILTER_TYPE: + name: LDAP_USER_SUBSTRING_FILTER_TYPE;USERS_LDAP_USER_SUBSTRING_FILTER_TYPE + defaultValue: any + type: string + description: 'Type of substring search filter to use for substring searches for + users. Possible values: ''initial'' for doing prefix only searches, ''final'' + for doing suffix only searches or ''any'' for doing full substring searches' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_DEBUG_ADDR: + name: NATS_DEBUG_ADDR + defaultValue: 127.0.0.1:9234 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_DEBUG_PPROF: + name: NATS_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_DEBUG_TOKEN: + name: NATS_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_DEBUG_ZPAGES: + name: NATS_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_EVENTS_ENABLE_TLS: + name: OCIS_EVENTS_ENABLE_TLS;NATS_EVENTS_ENABLE_TLS + defaultValue: "false" + type: bool + description: Enable TLS for the connection to the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_LOG_COLOR: + name: OCIS_LOG_COLOR;NATS_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_LOG_FILE: + name: OCIS_LOG_FILE;NATS_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_LOG_LEVEL: + name: OCIS_LOG_LEVEL;NATS_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_LOG_PRETTY: + name: OCIS_LOG_PRETTY;NATS_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_NATS_CLUSTER_ID: + name: NATS_NATS_CLUSTER_ID + defaultValue: ocis-cluster + type: string + description: ID of the NATS cluster. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_NATS_HOST: + name: NATS_NATS_HOST + defaultValue: 127.0.0.1 + type: string + description: Bind address. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_NATS_PORT: + name: NATS_NATS_PORT + defaultValue: "9233" + type: int + description: Bind port. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_NATS_STORE_DIR: + name: NATS_NATS_STORE_DIR + defaultValue: /var/lib/ocis/nats + type: string + description: The directory where the filesystem storage will store NATS JetStream + data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/nats. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_TLS_CERT: + name: NATS_TLS_CERT + defaultValue: /var/lib/ocis/nats/tls.crt + type: string + description: Path/File name of the TLS server certificate (in PEM format) for the + NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/nats. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_TLS_KEY: + name: NATS_TLS_KEY + defaultValue: /var/lib/ocis/nats/tls.key + type: string + description: Path/File name for the TLS certificate key (in PEM format) for the + NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/nats. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_TLS_SKIP_VERIFY_CLIENT_CERT: + name: OCIS_INSECURE;NATS_TLS_SKIP_VERIFY_CLIENT_CERT + defaultValue: "false" + type: bool + description: Whether the NATS server should skip the client certificate verification + during the TLS handshake. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;NATS_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;NATS_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;NATS_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NATS_TRACING_TYPE: + name: OCIS_TRACING_TYPE;NATS_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_DEBUG_ADDR: + name: NOTIFICATIONS_DEBUG_ADDR + defaultValue: 127.0.0.1:9174 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_DEBUG_PPROF: + name: NOTIFICATIONS_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_DEBUG_TOKEN: + name: NOTIFICATIONS_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_DEBUG_ZPAGES: + name: NOTIFICATIONS_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_EMAIL_TEMPLATE_PATH: + name: OCIS_EMAIL_TEMPLATE_PATH;NOTIFICATIONS_EMAIL_TEMPLATE_PATH + defaultValue: "" + type: string + description: Path to Email notification templates overriding embedded ones. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_EVENTS_AUTH_PASSWORD: + name: OCIS_EVENTS_AUTH_PASSWORD;NOTIFICATIONS_EVENTS_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_EVENTS_AUTH_USERNAME: + name: OCIS_EVENTS_AUTH_USERNAME;NOTIFICATIONS_EVENTS_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_EVENTS_CLUSTER: + name: OCIS_EVENTS_CLUSTER;NOTIFICATIONS_EVENTS_CLUSTER + defaultValue: ocis-cluster + type: string + description: The clusterID of the event system. The event system is the message + queuing service. It is used as message broker for the microservice architecture. + Mandatory when using NATS as event system. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_EVENTS_ENABLE_TLS: + name: OCIS_EVENTS_ENABLE_TLS;NOTIFICATIONS_EVENTS_ENABLE_TLS + defaultValue: "false" + type: bool + description: Enable TLS for the connection to the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_EVENTS_ENDPOINT: + name: OCIS_EVENTS_ENDPOINT;NOTIFICATIONS_EVENTS_ENDPOINT + defaultValue: 127.0.0.1:9233 + type: string + description: The address of the event system. The event system is the message queuing + service. It is used as message broker for the microservice architecture. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_EVENTS_TLS_INSECURE: + name: OCIS_INSECURE;NOTIFICATIONS_EVENTS_TLS_INSECURE + defaultValue: "false" + type: bool + description: Whether to verify the server TLS certificates. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_EVENTS_TLS_ROOT_CA_CERTIFICATE: + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;NOTIFICATIONS_EVENTS_TLS_ROOT_CA_CERTIFICATE + defaultValue: "" + type: string + description: The root CA certificate used to validate the server's TLS certificate. + If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_LOG_COLOR: + name: OCIS_LOG_COLOR;NOTIFICATIONS_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_LOG_FILE: + name: OCIS_LOG_FILE;NOTIFICATIONS_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_LOG_LEVEL: + name: OCIS_LOG_LEVEL;NOTIFICATIONS_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_LOG_PRETTY: + name: OCIS_LOG_PRETTY;NOTIFICATIONS_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_SERVICE_ACCOUNT_ID: + name: OCIS_SERVICE_ACCOUNT_ID;NOTIFICATIONS_SERVICE_ACCOUNT_ID + defaultValue: "" + type: string + description: The ID of the service account the service should use. See the 'auth-service' + service description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_SERVICE_ACCOUNT_SECRET: + name: OCIS_SERVICE_ACCOUNT_SECRET;NOTIFICATIONS_SERVICE_ACCOUNT_SECRET + defaultValue: "" + type: string + description: The service account secret. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_SMTP_AUTHENTICATION: + name: NOTIFICATIONS_SMTP_AUTHENTICATION + defaultValue: "" + type: string + description: Authentication method for the SMTP communication. Possible values are + 'login', 'plain', 'crammd5', 'none' or 'auto'. If set to 'auto' or unset, the + authentication method is automatically negotiated with the server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_SMTP_ENCRYPTION: + name: NOTIFICATIONS_SMTP_ENCRYPTION + defaultValue: none + type: string + description: Encryption method for the SMTP communication. Possible values are + 'starttls', 'ssl', 'ssltls', 'tls' and 'none'. + introductionVersion: "" + deprecationVersion: "v5.0.0" + removalVersion: "v6.0.0" + deprecationInfo: The NOTIFICATIONS_SMTP_ENCRYPTION values 'ssl' and 'tls' are deprecated + and will be removed in the future. +NOTIFICATIONS_SMTP_HOST: + name: NOTIFICATIONS_SMTP_HOST + defaultValue: "" + type: string + description: SMTP host to connect to. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_SMTP_INSECURE: + name: NOTIFICATIONS_SMTP_INSECURE + defaultValue: "false" + type: bool + description: Allow insecure connections to the SMTP server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_SMTP_PASSWORD: + name: NOTIFICATIONS_SMTP_PASSWORD + defaultValue: "" + type: string + description: Password for the SMTP host to connect to. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_SMTP_PORT: + name: NOTIFICATIONS_SMTP_PORT + defaultValue: "0" + type: int + description: Port of the SMTP host to connect to. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_SMTP_SENDER: + name: NOTIFICATIONS_SMTP_SENDER + defaultValue: "" + type: string + description: Sender address of emails that will be sent (e.g. 'ownCloud '. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_SMTP_USERNAME: + name: NOTIFICATIONS_SMTP_USERNAME + defaultValue: "" + type: string + description: Username for the SMTP host to connect to. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;NOTIFICATIONS_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;NOTIFICATIONS_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;NOTIFICATIONS_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_TRACING_TYPE: + name: OCIS_TRACING_TYPE;NOTIFICATIONS_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_TRANSLATION_PATH: + name: OCIS_TRANSLATION_PATH;NOTIFICATIONS_TRANSLATION_PATH + defaultValue: "" + type: string + description: (optional) Set this to a path with custom translations to overwrite + the builtin translations. Note that file and folder naming rules apply, see the + documentation for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +NOTIFICATIONS_WEB_UI_URL: + name: OCIS_URL;NOTIFICATIONS_WEB_UI_URL + defaultValue: https://localhost:9200 + type: string + description: The public facing URL of the oCIS Web UI, used e.g. when sending notification + eMails + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_ALLOW_PROPFIND_DEPTH_INFINITY: + name: OCDAV_ALLOW_PROPFIND_DEPTH_INFINITY + defaultValue: "false" + type: bool + description: Allow the use of depth infinity in PROPFINDS. When enabled, a propfind + will traverse through all subfolders. If many subfolders are expected, depth infinity + can cause heavy server load and/or delayed response times. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_CORS_ALLOW_CREDENTIALS: + name: OCIS_CORS_ALLOW_CREDENTIALS;OCDAV_CORS_ALLOW_CREDENTIALS + defaultValue: "true" + type: bool + description: 'Allow credentials for CORS.See following chapter for more details: + *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_CORS_ALLOW_HEADERS: + name: OCIS_CORS_ALLOW_HEADERS;OCDAV_CORS_ALLOW_HEADERS + defaultValue: '[Origin Accept Content-Type Depth Authorization Ocs-Apirequest If-None-Match + If-Match Destination Overwrite X-Request-Id X-Requested-With Tus-Resumable Tus-Checksum-Algorithm + Upload-Concat Upload-Length Upload-Metadata Upload-Defer-Length Upload-Expires + Upload-Checksum Upload-Offset X-HTTP-Method-Override Cache-Control]' + type: '[]string' + description: 'A list of allowed CORS headers. See following chapter for more details: + *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_CORS_ALLOW_METHODS: + name: OCIS_CORS_ALLOW_METHODS;OCDAV_CORS_ALLOW_METHODS + defaultValue: '[OPTIONS HEAD GET PUT POST DELETE MKCOL PROPFIND PROPPATCH MOVE COPY + REPORT SEARCH]' + type: '[]string' + description: 'A list of allowed CORS methods. See following chapter for more details: + *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_CORS_ALLOW_ORIGINS: + name: OCIS_CORS_ALLOW_ORIGINS;OCDAV_CORS_ALLOW_ORIGINS + defaultValue: '[*]' + type: '[]string' + description: 'A list of allowed CORS origins. See following chapter for more details: + *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_DEBUG_ADDR: + name: OCDAV_DEBUG_ADDR + defaultValue: 127.0.0.1:9163 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_DEBUG_PPROF: + name: OCDAV_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_DEBUG_TOKEN: + name: OCDAV_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_DEBUG_ZPAGES: + name: OCDAV_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_EDITION: + name: OCIS_EDITION;OCDAV_EDITION + defaultValue: Community + type: string + description: "" + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_FILES_NAMESPACE: + name: OCDAV_FILES_NAMESPACE + defaultValue: /users/{{.Id.OpaqueId}} + type: string + description: Jail requests to /dav/files/{username} into this CS3 namespace. Supports + template layouting with CS3 User properties. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_GATEWAY_REQUEST_TIMEOUT: + name: OCDAV_GATEWAY_REQUEST_TIMEOUT + defaultValue: "84300" + type: int64 + description: Request timeout in seconds for requests from the oCDAV service to the + GATEWAY service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_HTTP_ADDR: + name: OCDAV_HTTP_ADDR + defaultValue: 127.0.0.1:0 + type: string + description: The bind address of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_HTTP_PREFIX: + name: OCDAV_HTTP_PREFIX + defaultValue: "" + type: string + description: A URL path prefix for the handler. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_HTTP_PROTOCOL: + name: OCDAV_HTTP_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_INSECURE: + name: OCIS_INSECURE;OCDAV_INSECURE + defaultValue: "false" + type: bool + description: Allow insecure connections to the GATEWAY service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_JWT_SECRET: + name: OCIS_JWT_SECRET;OCDAV_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_LOG_COLOR: + name: OCIS_LOG_COLOR;OCDAV_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_LOG_FILE: + name: OCIS_LOG_FILE;OCDAV_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_LOG_LEVEL: + name: OCIS_LOG_LEVEL;OCDAV_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_LOG_PRETTY: + name: OCIS_LOG_PRETTY;OCDAV_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_MACHINE_AUTH_API_KEY: + name: OCIS_MACHINE_AUTH_API_KEY;OCDAV_MACHINE_AUTH_API_KEY + defaultValue: "" + type: string + description: Machine auth API key used to validate internal requests necessary for + the access to resources from other services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_OCM_NAMESPACE: + name: OCDAV_OCM_NAMESPACE + defaultValue: /public + type: string + description: The human readable path prefix for the ocm shares. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_PUBLIC_URL: + name: OCIS_URL;OCDAV_PUBLIC_URL + defaultValue: https://localhost:9200 + type: string + description: URL where oCIS is reachable for users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_SHARES_NAMESPACE: + name: OCDAV_SHARES_NAMESPACE + defaultValue: /Shares + type: string + description: The human readable path for the share jail. Relative to a users personal + space root. Upcased intentionally. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_SKIP_USER_GROUPS_IN_TOKEN: + name: OCDAV_SKIP_USER_GROUPS_IN_TOKEN + defaultValue: "false" + type: bool + description: Disables the loading of user's group memberships from the reva access + token. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;OCDAV_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;OCDAV_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;OCDAV_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_TRACING_TYPE: + name: OCIS_TRACING_TYPE;OCDAV_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCDAV_WEBDAV_NAMESPACE: + name: OCDAV_WEBDAV_NAMESPACE + defaultValue: /users/{{.Id.OpaqueId}} + type: string + description: Jail requests to /dav/webdav into this CS3 namespace. Supports template + layouting with CS3 User properties. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_ADMIN_USER_ID: + name: OCIS_ADMIN_USER_ID;SETTINGS_ADMIN_USER_ID + defaultValue: "" + type: string + description: ID of the user that should receive admin privileges. Consider that + the UUID can be encoded in some LDAP deployment configurations like in .ldif files. + These need to be decoded beforehand. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_ASYNC_UPLOADS: + name: OCIS_ASYNC_UPLOADS + defaultValue: "true" + type: bool + description: Enable asynchronous file uploads. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_CACHE_AUTH_PASSWORD: + name: OCIS_CACHE_AUTH_PASSWORD;FRONTEND_OCS_STAT_CACHE_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to use for authentication. Only applies when using the + 'nats-js-kv' store type. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_CACHE_AUTH_USERNAME: + name: OCIS_CACHE_AUTH_USERNAME;FRONTEND_OCS_STAT_CACHE_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to use for authentication. Only applies when using the + 'nats-js-kv' store type. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_CACHE_DATABASE: + name: OCIS_CACHE_DATABASE + defaultValue: cache-stat + type: string + description: The database name the configured store should use. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_CACHE_DISABLE_PERSISTENCE: + name: OCIS_CACHE_DISABLE_PERSISTENCE;FRONTEND_OCS_STAT_CACHE_DISABLE_PERSISTENCE + defaultValue: "false" + type: bool + description: Disable persistence of the cache. Only applies when using the 'nats-js-kv' + store type. Defaults to false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_CACHE_SIZE: + name: OCIS_CACHE_SIZE;FRONTEND_OCS_STAT_CACHE_SIZE + defaultValue: "0" + type: int + description: Max number of entries to hold in the cache. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_CACHE_STORE: + name: OCIS_CACHE_STORE;FRONTEND_OCS_STAT_CACHE_STORE + defaultValue: memory + type: string + description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', + ''nats-js-kv'', ''noop''. See the text description for details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_CACHE_STORE_NODES: + name: OCIS_CACHE_STORE_NODES;FRONTEND_OCS_STAT_CACHE_STORE_NODES + defaultValue: '[127.0.0.1:9233]' + type: '[]string' + description: A list of nodes to access the configured store. This has no effect + when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes + are used is dependent on the library of the configured store. See the Environment + Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_CACHE_TTL: + name: OCIS_CACHE_TTL;FRONTEND_OCS_STAT_CACHE_TTL + defaultValue: 5m0s + type: Duration + description: Default time to live for user info in the cache. Only applied when + access tokens has no expiration. See the Environment Variable Types description + for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_CORS_ALLOW_CREDENTIALS: + name: OCIS_CORS_ALLOW_CREDENTIALS;FRONTEND_CORS_ALLOW_CREDENTIALS + defaultValue: "true" + type: bool + description: 'Allow credentials for CORS.See following chapter for more details: + *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_CORS_ALLOW_HEADERS: + name: OCIS_CORS_ALLOW_HEADERS;FRONTEND_CORS_ALLOW_HEADERS + defaultValue: '[Origin Accept Content-Type Depth Authorization Ocs-Apirequest If-None-Match + If-Match Destination Overwrite X-Request-Id X-Requested-With Tus-Resumable Tus-Checksum-Algorithm + Upload-Concat Upload-Length Upload-Metadata Upload-Defer-Length Upload-Expires + Upload-Checksum Upload-Offset X-HTTP-Method-Override Cache-Control]' + type: '[]string' + description: 'A list of allowed CORS headers. See following chapter for more details: + *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_CORS_ALLOW_METHODS: + name: OCIS_CORS_ALLOW_METHODS;FRONTEND_CORS_ALLOW_METHODS + defaultValue: '[OPTIONS HEAD GET PUT POST DELETE MKCOL PROPFIND PROPPATCH MOVE COPY + REPORT SEARCH]' + type: '[]string' + description: 'A list of allowed CORS methods. See following chapter for more details: + *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_CORS_ALLOW_ORIGINS: + name: OCIS_CORS_ALLOW_ORIGINS;FRONTEND_CORS_ALLOW_ORIGINS + defaultValue: '[*]' + type: '[]string' + description: 'A list of allowed CORS origins. See following chapter for more details: + *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_DECOMPOSEDFS_METADATA_BACKEND: + name: OCIS_DECOMPOSEDFS_METADATA_BACKEND;STORAGE_SYSTEM_OCIS_METADATA_BACKEND + defaultValue: messagepack + type: string + description: The backend to use for storing metadata. Supported values are 'messagepack' + and 'xattrs'. The setting 'messagepack' uses a dedicated file to store file metadata + while 'xattrs' uses extended attributes to store file metadata. Defaults to 'messagepack'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_DECOMPOSEDFS_PROPAGATOR: + name: OCIS_DECOMPOSEDFS_PROPAGATOR;STORAGE_USERS_S3NG_PROPAGATOR + defaultValue: sync + type: string + description: The propagator used for decomposedfs. At the moment, only 'sync' is + fully supported, 'async' is available as an experimental option. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_DEFAULT_LANGUAGE: + name: OCIS_DEFAULT_LANGUAGE + defaultValue: "" + type: string + description: The default language used by services and the WebUI. If not defined, + English will be used as default. See the documentation for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_DISABLE_PREVIEWS: + name: OCIS_DISABLE_PREVIEWS;WEB_OPTION_DISABLE_PREVIEWS + defaultValue: "false" + type: bool + description: Set this option to 'true' to disable previews in all the different + web file listing views. This can speed up file listings in folders with many files. + The only list view that is not affected by this setting is the trash bin, as it + does not allow previewing at all. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_DISABLE_SSE: + name: OCIS_DISABLE_SSE;FRONTEND_DISABLE_SSE + defaultValue: "false" + type: bool + description: When set to true, clients are informed that the Server-Sent Events + endpoint is not accessible. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_DISABLE_SSE,USERLOG_DISABLE_SSE: + name: OCIS_DISABLE_SSE,USERLOG_DISABLE_SSE + defaultValue: "false" + type: bool + description: Disables server-sent events (sse). When disabled, clients will no longer + receive sse notifications. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_EDITION: + name: OCIS_EDITION;FRONTEND_EDITION + defaultValue: Community + type: string + description: "" + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_EMAIL_TEMPLATE_PATH: + name: OCIS_EMAIL_TEMPLATE_PATH;NOTIFICATIONS_EMAIL_TEMPLATE_PATH + defaultValue: "" + type: string + description: Path to Email notification templates overriding embedded ones. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_ENABLE_RESHARING: + name: OCIS_ENABLE_RESHARING;FRONTEND_ENABLE_RESHARING + defaultValue: "true" + type: bool + description: Changing this value is NOT supported. Enables the support for resharing + in the clients. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_EVENTS_AUTH_PASSWORD: + name: OCIS_EVENTS_AUTH_PASSWORD;FRONTEND_EVENTS_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_EVENTS_AUTH_USERNAME: + name: OCIS_EVENTS_AUTH_USERNAME;FRONTEND_EVENTS_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_EVENTS_CLUSTER: + name: OCIS_EVENTS_CLUSTER;FRONTEND_EVENTS_CLUSTER + defaultValue: ocis-cluster + type: string + description: The clusterID of the event system. The event system is the message + queuing service. It is used as message broker for the microservice architecture. + Mandatory when using NATS as event system. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_EVENTS_ENABLE_TLS: + name: OCIS_EVENTS_ENABLE_TLS;FRONTEND_EVENTS_ENABLE_TLS + defaultValue: "false" + type: bool + description: Enable TLS for the connection to the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_EVENTS_ENDPOINT: + name: OCIS_EVENTS_ENDPOINT;FRONTEND_EVENTS_ENDPOINT + defaultValue: 127.0.0.1:9233 + type: string + description: The address of the event system. The event system is the message queuing + service. It is used as message broker for the microservice architecture. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE: + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;SHARING_EVENTS_TLS_ROOT_CA_CERTIFICATE + defaultValue: "" + type: string + description: The root CA certificate used to validate the server's TLS certificate. + If provided SHARING_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_GATEWAY_GRPC_ADDR: + name: OCIS_GATEWAY_GRPC_ADDR;GATEWAY_GRPC_ADDR + defaultValue: 127.0.0.1:9142 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_GRPC_CLIENT_TLS_CACERT: + name: OCIS_GRPC_CLIENT_TLS_CACERT + defaultValue: "" + type: string + description: Path/File name for the root CA certificate (in PEM format) used to + validate TLS server certificates of the go-micro based grpc services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_GRPC_CLIENT_TLS_MODE: + name: OCIS_GRPC_CLIENT_TLS_MODE + defaultValue: "" + type: string + description: 'TLS mode for grpc connection to the go-micro based grpc services. + Possible values are ''off'', ''insecure'' and ''on''. ''off'': disables transport + security for the clients. ''insecure'' allows using transport security, but disables + certificate verification (to be used with the autogenerated self-signed certificates). + ''on'' enables transport security, including server certificate verification.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_HTTP_TLS_CERTIFICATE: + name: OCIS_HTTP_TLS_CERTIFICATE + defaultValue: "" + type: string + description: Path/File name of the TLS server certificate (in PEM format) for the + http services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_HTTP_TLS_ENABLED: + name: OCIS_HTTP_TLS_ENABLED + defaultValue: "false" + type: bool + description: Activates TLS for the http based services using the server certifcate + and key configured via OCIS_HTTP_TLS_CERTIFICATE and OCIS_HTTP_TLS_KEY. If OCIS_HTTP_TLS_CERTIFICATE + is not set a temporary server certificate is generated - to be used with PROXY_INSECURE_BACKEND=true. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_HTTP_TLS_KEY: + name: OCIS_HTTP_TLS_KEY + defaultValue: "" + type: string + description: Path/File name for the TLS certificate key (in PEM format) for the + server certificate to use for the http services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_INSECURE: + name: OCIS_INSECURE;FRONTEND_EVENTS_TLS_INSECURE + defaultValue: "false" + type: bool + description: Whether to verify the server TLS certificates. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_JWT_SECRET: + name: OCIS_JWT_SECRET;FRONTEND_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_KEYCLOAK_BASE_PATH: + name: OCIS_KEYCLOAK_BASE_PATH;INVITATIONS_KEYCLOAK_BASE_PATH + defaultValue: "" + type: string + description: The URL to access keycloak. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_KEYCLOAK_CLIENT_ID: + name: OCIS_KEYCLOAK_CLIENT_ID;INVITATIONS_KEYCLOAK_CLIENT_ID + defaultValue: "" + type: string + description: The client ID to authenticate with keycloak. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_KEYCLOAK_CLIENT_REALM: + name: OCIS_KEYCLOAK_CLIENT_REALM;INVITATIONS_KEYCLOAK_CLIENT_REALM + defaultValue: "" + type: string + description: The realm the client is defined in. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_KEYCLOAK_CLIENT_SECRET: + name: OCIS_KEYCLOAK_CLIENT_SECRET;INVITATIONS_KEYCLOAK_CLIENT_SECRET + defaultValue: "" + type: string + description: The client secret to use in authentication. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY: + name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;INVITATIONS_KEYCLOAK_INSECURE_SKIP_VERIFY + defaultValue: "false" + type: bool + description: Disable TLS certificate validation for Keycloak connections. Do not + set this in production environments. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_KEYCLOAK_USER_REALM: + name: OCIS_KEYCLOAK_USER_REALM;INVITATIONS_KEYCLOAK_USER_REALM + defaultValue: "" + type: string + description: The realm users are defined. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_BIND_DN: + name: OCIS_LDAP_BIND_DN;GROUPS_LDAP_BIND_DN + defaultValue: uid=reva,ou=sysusers,o=libregraph-idm + type: string + description: LDAP DN to use for simple bind authentication with the target LDAP + server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_BIND_PASSWORD: + name: OCIS_LDAP_BIND_PASSWORD;GROUPS_LDAP_BIND_PASSWORD + defaultValue: "" + type: string + description: Password to use for authenticating the 'bind_dn'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_CACERT: + name: OCIS_LDAP_CACERT;GROUPS_LDAP_CACERT + defaultValue: /var/lib/ocis/idm/ldap.crt + type: string + description: Path/File name for the root CA certificate (in PEM format) used to + validate TLS server certificates of the LDAP service. If not defined, the root + directory derives from $OCIS_BASE_DATA_PATH:/idm. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_DISABLE_USER_MECHANISM: + name: OCIS_LDAP_DISABLE_USER_MECHANISM;GRAPH_DISABLE_USER_MECHANISM + defaultValue: attribute + type: string + description: An option to control the behavior for disabling users. Supported options + are 'none', 'attribute' and 'group'. If set to 'group', disabling a user via API + will add the user to the configured group for disabled users, if set to 'attribute' + this will be done in the ldap user entry, if set to 'none' the disable request + is not processed. Default is 'attribute'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_DISABLED_USERS_GROUP_DN: + name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;GRAPH_DISABLED_USERS_GROUP_DN + defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm + type: string + description: The distinguished name of the group to which added users will be classified + as disabled when 'disable_user_mechanism' is set to 'group'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_GROUP_BASE_DN: + name: OCIS_LDAP_GROUP_BASE_DN;GROUPS_LDAP_GROUP_BASE_DN + defaultValue: ou=groups,o=libregraph-idm + type: string + description: Search base DN for looking up LDAP groups. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_GROUP_FILTER: + name: OCIS_LDAP_GROUP_FILTER;GROUPS_LDAP_GROUP_FILTER + defaultValue: "" + type: string + description: LDAP filter to add to the default filters for group searches. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_GROUP_OBJECTCLASS: + name: OCIS_LDAP_GROUP_OBJECTCLASS;GROUPS_LDAP_GROUP_OBJECTCLASS + defaultValue: groupOfNames + type: string + description: The object class to use for groups in the default group search filter + ('groupOfNames'). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME: + name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;GROUPS_LDAP_GROUP_SCHEMA_DISPLAYNAME + defaultValue: cn + type: string + description: LDAP Attribute to use for the displayname of groups (often the same + as groupname attribute). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_GROUP_SCHEMA_GROUPNAME: + name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;GROUPS_LDAP_GROUP_SCHEMA_GROUPNAME + defaultValue: cn + type: string + description: LDAP Attribute to use for the name of groups. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_GROUP_SCHEMA_ID: + name: OCIS_LDAP_GROUP_SCHEMA_ID;GROUPS_LDAP_GROUP_SCHEMA_ID + defaultValue: ownclouduuid + type: string + description: LDAP Attribute to use as the unique id for groups. This should be a + stable globally unique ID like a UUID. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING: + name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;GROUPS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING + defaultValue: "false" + type: bool + description: Set this to true if the defined 'id' attribute for groups is of the + 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute + of Active Directory for the group ID's. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_GROUP_SCHEMA_MAIL: + name: OCIS_LDAP_GROUP_SCHEMA_MAIL;GROUPS_LDAP_GROUP_SCHEMA_MAIL + defaultValue: mail + type: string + description: LDAP Attribute to use for the email address of groups (can be empty). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_GROUP_SCHEMA_MEMBER: + name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;GROUPS_LDAP_GROUP_SCHEMA_MEMBER + defaultValue: member + type: string + description: LDAP Attribute that is used for group members. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_GROUP_SCOPE: + name: OCIS_LDAP_GROUP_SCOPE;GROUPS_LDAP_GROUP_SCOPE + defaultValue: sub + type: string + description: LDAP search scope to use when looking up groups. Supported scopes are + 'base', 'one' and 'sub'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_INSECURE: + name: OCIS_LDAP_INSECURE;GROUPS_LDAP_INSECURE + defaultValue: "false" + type: bool + description: Disable TLS certificate validation for the LDAP connections. Do not + set this in production environments. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_SERVER_WRITE_ENABLED: + name: OCIS_LDAP_SERVER_WRITE_ENABLED;FRONTEND_LDAP_SERVER_WRITE_ENABLED + defaultValue: "true" + type: bool + description: Allow creating, modifying and deleting LDAP users via the GRAPH API. + This can only be set to 'true' when keeping default settings for the LDAP user + and group attribute types (the 'OCIS_LDAP_USER_SCHEMA_* and 'OCIS_LDAP_GROUP_SCHEMA_* + variables). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_URI: + name: OCIS_LDAP_URI;GROUPS_LDAP_URI + defaultValue: ldaps://localhost:9235 + type: string + description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' + and 'ldap://' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_USER_BASE_DN: + name: OCIS_LDAP_USER_BASE_DN;GROUPS_LDAP_USER_BASE_DN + defaultValue: ou=users,o=libregraph-idm + type: string + description: Search base DN for looking up LDAP users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_USER_ENABLED_ATTRIBUTE: + name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;IDP_USER_ENABLED_ATTRIBUTE + defaultValue: ownCloudUserEnabled + type: string + description: LDAP Attribute to use as a flag telling if the user is enabled or disabled. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_USER_FILTER: + name: OCIS_LDAP_USER_FILTER;GROUPS_LDAP_USER_FILTER + defaultValue: "" + type: string + description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_USER_OBJECTCLASS: + name: OCIS_LDAP_USER_OBJECTCLASS;GROUPS_LDAP_USER_OBJECTCLASS + defaultValue: inetOrgPerson + type: string + description: The object class to use for users in the default user search filter + ('inetOrgPerson'). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_USER_SCHEMA_DISPLAYNAME: + name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;GROUPS_LDAP_USER_SCHEMA_DISPLAYNAME + defaultValue: displayname + type: string + description: LDAP Attribute to use for the displayname of users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_USER_SCHEMA_ID: + name: OCIS_LDAP_USER_SCHEMA_ID;GROUPS_LDAP_USER_SCHEMA_ID + defaultValue: ownclouduuid + type: string + description: LDAP Attribute to use as the unique id for users. This should be a + stable globally unique id like a UUID. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING: + name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;GROUPS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING + defaultValue: "false" + type: bool + description: Set this to true if the defined 'ID' attribute for users is of the + 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute + of Active Directory for the user ID's. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_USER_SCHEMA_MAIL: + name: OCIS_LDAP_USER_SCHEMA_MAIL;GROUPS_LDAP_USER_SCHEMA_MAIL + defaultValue: mail + type: string + description: LDAP Attribute to use for the email address of users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_USER_SCHEMA_USER_TYPE: + name: OCIS_LDAP_USER_SCHEMA_USER_TYPE;GRAPH_LDAP_USER_TYPE_ATTRIBUTE + defaultValue: ownCloudUserType + type: string + description: LDAP Attribute to distinguish between 'Member' and 'Guest' users. Default + is 'ownCloudUserType'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_USER_SCHEMA_USERNAME: + name: OCIS_LDAP_USER_SCHEMA_USERNAME;GROUPS_LDAP_USER_SCHEMA_USERNAME + defaultValue: uid + type: string + description: LDAP Attribute to use for username of users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LDAP_USER_SCOPE: + name: OCIS_LDAP_USER_SCOPE;GROUPS_LDAP_USER_SCOPE + defaultValue: sub + type: string + description: LDAP search scope to use when looking up users. Supported scopes are + 'base', 'one' and 'sub'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LOG_COLOR: + name: OCIS_LOG_COLOR;FRONTEND_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LOG_FILE: + name: OCIS_LOG_FILE;FRONTEND_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LOG_LEVEL: + name: OCIS_LOG_LEVEL;FRONTEND_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_LOG_PRETTY: + name: OCIS_LOG_PRETTY;FRONTEND_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_MACHINE_AUTH_API_KEY: + name: OCIS_MACHINE_AUTH_API_KEY;FRONTEND_MACHINE_AUTH_API_KEY + defaultValue: "" + type: string + description: The machine auth API key used to validate internal requests necessary + to access resources from other services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_OIDC_CLIENT_ID: + name: OCIS_OIDC_CLIENT_ID;WEB_OIDC_CLIENT_ID + defaultValue: web + type: string + description: The OIDC client ID which ownCloud Web uses. This client needs to be + set up in your IDP. Note that this setting has no effect when using the builtin + IDP. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_OIDC_ISSUER: + name: OCIS_URL;OCIS_OIDC_ISSUER;WEB_OIDC_AUTHORITY + defaultValue: https://localhost:9200 + type: string + description: URL of the OIDC issuer. It defaults to URL of the builtin IDP. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST: + name: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST;FRONTEND_PASSWORD_POLICY_BANNED_PASSWORDS_LIST + defaultValue: "" + type: string + description: Path to the 'banned passwords list' file. See the documentation for + more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_PASSWORD_POLICY_DISABLED: + name: OCIS_PASSWORD_POLICY_DISABLED;FRONTEND_PASSWORD_POLICY_DISABLED + defaultValue: "false" + type: bool + description: Disable the password policy. Defaults to false if not set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_PASSWORD_POLICY_MIN_CHARACTERS: + name: OCIS_PASSWORD_POLICY_MIN_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_CHARACTERS + defaultValue: "8" + type: int + description: Define the minimum password length. Defaults to 8 if not set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_PASSWORD_POLICY_MIN_DIGITS: + name: OCIS_PASSWORD_POLICY_MIN_DIGITS;FRONTEND_PASSWORD_POLICY_MIN_DIGITS + defaultValue: "1" + type: int + description: Define the minimum number of digits. Defaults to 1 if not set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS: + name: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS + defaultValue: "1" + type: int + description: Define the minimum number of uppercase letters. Defaults to 1 if not + set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS: + name: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS + defaultValue: "1" + type: int + description: Define the minimum number of characters from the special characters + list to be present. Defaults to 1 if not set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS: + name: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS + defaultValue: "1" + type: int + description: Define the minimum number of lowercase letters. Defaults to 1 if not + set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_PERSISTENT_STORE: + name: OCIS_PERSISTENT_STORE;POSTPROCESSING_STORE + defaultValue: memory + type: string + description: 'The type of the store. Supported values are: ''memory'', ''ocmem'', + ''etcd'', ''redis'', ''redis-sentinel'', ''nats-js'', ''noop''. See the text description + for details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_PERSISTENT_STORE_AUTH_PASSWORD: + name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;POSTPROCESSING_STORE_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the store. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_PERSISTENT_STORE_AUTH_USERNAME: + name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;POSTPROCESSING_STORE_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the store. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_PERSISTENT_STORE_NODES: + name: OCIS_PERSISTENT_STORE_NODES;POSTPROCESSING_STORE_NODES + defaultValue: '[]' + type: '[]string' + description: A list of nodes to access the configured store. This has no effect + when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes + are used is dependent on the library of the configured store. See the Environment + Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_PERSISTENT_STORE_SIZE: + name: OCIS_PERSISTENT_STORE_SIZE;POSTPROCESSING_STORE_SIZE + defaultValue: "0" + type: int + description: The maximum quantity of items in the store. Only applies when store + type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package + though not exclicitely set as default. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_PERSISTENT_STORE_TTL: + name: OCIS_PERSISTENT_STORE_TTL;POSTPROCESSING_STORE_TTL + defaultValue: 0s + type: Duration + description: Time to live for events in the store. See the Environment Variable + Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_PUBLIC_URL: + name: OCIS_URL;OCIS_PUBLIC_URL + defaultValue: https://127.0.0.1:9200 + type: string + description: URL, where oCIS is reachable for users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_REVA_GATEWAY: + name: OCIS_REVA_GATEWAY + defaultValue: com.owncloud.api.gateway + type: string + description: The CS3 gateway endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_REVA_GATEWAY_TLS_CACERT: + name: OCIS_REVA_GATEWAY_TLS_CACERT + defaultValue: "" + type: string + description: The root CA certificate used to validate the gateway's TLS certificate. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_REVA_GATEWAY_TLS_MODE: + name: OCIS_REVA_GATEWAY_TLS_MODE + defaultValue: "" + type: string + description: 'TLS mode for grpc connection to the CS3 gateway endpoint. Possible + values are ''off'', ''insecure'' and ''on''. ''off'': disables transport security + for the clients. ''insecure'' allows using transport security, but disables certificate + verification (to be used with the autogenerated self-signed certificates). ''on'' + enables transport security, including server certificate verification.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_SERVICE_ACCOUNT_ID: + name: OCIS_SERVICE_ACCOUNT_ID;FRONTEND_SERVICE_ACCOUNT_ID + defaultValue: "" + type: string + description: The ID of the service account the service should use. See the 'auth-service' + service description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_SERVICE_ACCOUNT_SECRET: + name: OCIS_SERVICE_ACCOUNT_SECRET;FRONTEND_SERVICE_ACCOUNT_SECRET + defaultValue: "" + type: string + description: The service account secret. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD: + name: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD;FRONTEND_OCS_PUBLIC_SHARE_MUST_HAVE_PASSWORD + defaultValue: "true" + type: bool + description: Set this to true if you want to enforce passwords on all public shares. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD: + name: OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD;FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD + defaultValue: "false" + type: bool + description: Set this to true if you want to enforce passwords on Uploader, Editor + or Contributor shares. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_SPACES_MAX_QUOTA: + name: OCIS_SPACES_MAX_QUOTA;FRONTEND_MAX_QUOTA + defaultValue: "0" + type: uint64 + description: Set the global max quota value in bytes. A value of 0 equals unlimited. + The value is provided via capabilities. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_SYSTEM_USER_API_KEY: + name: OCIS_SYSTEM_USER_API_KEY;SHARING_PUBLIC_CS3_SYSTEM_USER_API_KEY + defaultValue: "" + type: string + description: API key for the STORAGE-SYSTEM system user. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_SYSTEM_USER_ID: + name: OCIS_SYSTEM_USER_ID;SHARING_PUBLIC_CS3_SYSTEM_USER_ID + defaultValue: "" + type: string + description: ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID + for the STORAGE-SYSTEM system user in this config option which is then used to + reference the user. Any reasonable long string is possible, preferably this would + be an UUIDv4 format. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_SYSTEM_USER_IDP: + name: OCIS_SYSTEM_USER_IDP;SHARING_PUBLIC_CS3_SYSTEM_USER_IDP + defaultValue: internal + type: string + description: IDP of the oCIS STORAGE-SYSTEM system user. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;FRONTEND_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;FRONTEND_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;FRONTEND_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_TRACING_TYPE: + name: OCIS_TRACING_TYPE;FRONTEND_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_TRANSFER_SECRET: + name: OCIS_TRANSFER_SECRET + defaultValue: "" + type: string + description: Transfer secret for signing file up- and download requests. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_TRANSLATION_PATH: + name: OCIS_TRANSLATION_PATH;NOTIFICATIONS_TRANSLATION_PATH + defaultValue: "" + type: string + description: (optional) Set this to a path with custom translations to overwrite + the builtin translations. Note that file and folder naming rules apply, see the + documentation for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_URL: + name: OCIS_URL;FRONTEND_PUBLIC_URL + defaultValue: https://localhost:9200 + type: string + description: The public facing URL of the oCIS frontend. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_CORS_ALLOW_CREDENTIALS: + name: OCIS_CORS_ALLOW_CREDENTIALS;OCM_CORS_ALLOW_CREDENTIALS + defaultValue: "true" + type: bool + description: 'Allow credentials for CORS.See following chapter for more details: + *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_CORS_ALLOW_HEADERS: + name: OCIS_CORS_ALLOW_HEADERS;OCM_CORS_ALLOW_HEADERS + defaultValue: '[Origin Accept Content-Type Depth Authorization Ocs-Apirequest If-None-Match + If-Match Destination Overwrite X-Request-Id X-Requested-With Tus-Resumable Tus-Checksum-Algorithm + Upload-Concat Upload-Length Upload-Metadata Upload-Defer-Length Upload-Expires + Upload-Checksum Upload-Offset X-HTTP-Method-Override Cache-Control]' + type: '[]string' + description: 'A list of allowed CORS headers. See following chapter for more details: + *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_CORS_ALLOW_METHODS: + name: OCIS_CORS_ALLOW_METHODS;OCM_CORS_ALLOW_METHODS + defaultValue: '[OPTIONS HEAD GET PUT POST DELETE MKCOL PROPFIND PROPPATCH MOVE COPY + REPORT SEARCH]' + type: '[]string' + description: 'A list of allowed CORS methods. See following chapter for more details: + *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_CORS_ALLOW_ORIGINS: + name: OCIS_CORS_ALLOW_ORIGINS;OCM_CORS_ALLOW_ORIGINS + defaultValue: '[*]' + type: '[]string' + description: 'A list of allowed CORS origins. See following chapter for more details: + *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_DEBUG_ADDR: + name: OCM_DEBUG_ADDR + defaultValue: 127.0.0.1:9281 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_DEBUG_PPROF: + name: OCM_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_DEBUG_TOKEN: + name: OCM_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_DEBUG_ZPAGES: + name: OCM_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_GRPC_ADDR: + name: OCM_GRPC_ADDR + defaultValue: 127.0.0.1:9282 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_GRPC_PROTOCOL: + name: OCM_GRPC_PROTOCOL + defaultValue: "" + type: string + description: The transport protocol of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_HTTP_ADDR: + name: OCM_HTTP_ADDR + defaultValue: 127.0.0.1:9280 + type: string + description: The bind address of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_HTTP_PREFIX: + name: OCM_HTTP_PREFIX + defaultValue: "" + type: string + description: The path prefix where OCM can be accessed (defaults to /). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_HTTP_PROTOCOL: + name: OCM_HTTP_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_LOG_COLOR: + name: OCIS_LOG_COLOR;OCM_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_LOG_FILE: + name: OCIS_LOG_FILE;OCM_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_LOG_LEVEL: + name: OCIS_LOG_LEVEL;OCM_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_LOG_PRETTY: + name: OCIS_LOG_PRETTY;OCM_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_MESH_DIRECTORY_URL: + name: OCM_MESH_DIRECTORY_URL + defaultValue: "" + type: string + description: URL of the mesh directory service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_OCM_CORE_DRIVER: + name: OCM_OCM_CORE_DRIVER + defaultValue: json + type: string + description: Driver to be used for the OCM core. Supported value is only 'json'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_OCM_CORE_JSON_FILE: + name: OCM_OCM_CORE_JSON_FILE + defaultValue: /var/lib/ocis/storage/ocm/ocmshares.json + type: string + description: Path to the JSON file where OCM share data will be stored. If not defined, + the root directory derives from $OCIS_BASE_DATA_PATH:/storage. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_OCM_INVITE_MANAGER_DRIVER: + name: OCM_OCM_INVITE_MANAGER_DRIVER + defaultValue: json + type: string + description: Driver to be used to persist OCM invites. Supported value is only 'json'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_OCM_INVITE_MANAGER_INSECURE: + name: OCM_OCM_INVITE_MANAGER_INSECURE + defaultValue: "false" + type: bool + description: Disable TLS certificate validation for the OCM connections. Do not + set this in production environments. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_OCM_INVITE_MANAGER_JSON_FILE: + name: OCM_OCM_INVITE_MANAGER_JSON_FILE + defaultValue: /var/lib/ocis/storage/ocm/ocminvites.json + type: string + description: Path to the JSON file where OCM invite data will be stored. If not + defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE: + name: OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE + defaultValue: /var/lib/ocis/storage/ocm/ocmproviders.json + type: string + description: Path to the JSON file where ocm invite data will be stored. If not + defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_OCM_PROVIDER_AUTHORIZER_VERIFY_REQUEST_HOSTNAME: + name: OCM_OCM_PROVIDER_AUTHORIZER_VERIFY_REQUEST_HOSTNAME + defaultValue: "false" + type: bool + description: Verify the hostname of the incoming request against the hostname of + the OCM provider. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_OCM_SHARE_PROVIDER_DRIVER: + name: OCM_OCM_SHARE_PROVIDER_DRIVER + defaultValue: json + type: string + description: Driver to be used for the OCM share provider. Supported value is only + 'json'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_OCM_SHARE_PROVIDER_INSECURE: + name: OCM_OCM_SHARE_PROVIDER_INSECURE + defaultValue: "false" + type: bool + description: Disable TLS certificate validation for the OCM connections. Do not + set this in production environments. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_OCM_SHAREPROVIDER_JSON_FILE: + name: OCM_OCM_SHAREPROVIDER_JSON_FILE + defaultValue: /var/lib/ocis/storage/ocm/ocmshares.json + type: string + description: Path to the JSON file where OCM share data will be stored. If not defined, + the root directory derives from $OCIS_BASE_DATA_PATH:/storage. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_OCM_STORAGE_PROVIDER_INSECURE: + name: OCM_OCM_STORAGE_PROVIDER_INSECURE + defaultValue: "false" + type: bool + description: Disable TLS certificate validation for the OCM connections. Do not + set this in production environments. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_OCM_STORAGE_PROVIDER_STORAGE_ROOT: + name: OCM_OCM_STORAGE_PROVIDER_STORAGE_ROOT + defaultValue: /var/lib/ocis/storage/ocm + type: string + description: Directory where the ocm storage provider persists its data like tus + upload info files. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_OCMD_EXPOSE_RECIPIENT_DISPLAY_NAME: + name: OCM_OCMD_EXPOSE_RECIPIENT_DISPLAY_NAME + defaultValue: "false" + type: bool + description: Expose the display name of OCM share recipients. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_OCMD_PREFIX: + name: OCM_OCMD_PREFIX + defaultValue: ocm + type: string + description: URL path prefix for the OCMD service. Note that the string must not + start with '/'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_SCIENCEMESH_PREFIX: + name: OCM_SCIENCEMESH_PREFIX + defaultValue: sciencemesh + type: string + description: URL path prefix for the ScienceMesh service. Note that the string must + not start with '/'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_SERVICE_ACCOUNT_ID: + name: OCIS_SERVICE_ACCOUNT_ID;OCM_SERVICE_ACCOUNT_ID + defaultValue: "" + type: string + description: The ID of the service account the service should use. See the 'auth-service' + service description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_SERVICE_ACCOUNT_SECRET: + name: OCIS_SERVICE_ACCOUNT_SECRET;OCM_SERVICE_ACCOUNT_SECRET + defaultValue: "" + type: string + description: The service account secret. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;OCM_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;OCM_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;OCM_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_TRACING_TYPE: + name: OCIS_TRACING_TYPE;OCM_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCM_WEBAPP_TEMPLATE: + name: OCM_WEBAPP_TEMPLATE + defaultValue: "" + type: string + description: Template for the webapp url. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_CORS_ALLOW_CREDENTIALS: + name: OCIS_CORS_ALLOW_CREDENTIALS;OCS_CORS_ALLOW_CREDENTIALS + defaultValue: "true" + type: bool + description: 'Allow credentials for CORS.See following chapter for more details: + *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_CORS_ALLOW_HEADERS: + name: OCIS_CORS_ALLOW_HEADERS;OCS_CORS_ALLOW_HEADERS + defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id + Cache-Control]' + type: '[]string' + description: 'A list of allowed CORS headers. See following chapter for more details: + *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_CORS_ALLOW_METHODS: + name: OCIS_CORS_ALLOW_METHODS;OCS_CORS_ALLOW_METHODS + defaultValue: '[GET POST PUT PATCH DELETE OPTIONS]' + type: '[]string' + description: 'A list of allowed CORS methods. See following chapter for more details: + *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_CORS_ALLOW_ORIGINS: + name: OCIS_CORS_ALLOW_ORIGINS;OCS_CORS_ALLOW_ORIGINS + defaultValue: '[*]' + type: '[]string' + description: 'A list of allowed CORS origins. See following chapter for more details: + *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_DEBUG_ADDR: + name: OCS_DEBUG_ADDR + defaultValue: 127.0.0.1:9114 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_DEBUG_PPROF: + name: OCS_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_DEBUG_TOKEN: + name: OCS_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_DEBUG_ZPAGES: + name: OCS_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_EVENTS_TLS_ROOT_CA_CERTIFICATE: + name: FRONTEND_EVENTS_TLS_ROOT_CA_CERTIFICATE;OCS_EVENTS_TLS_ROOT_CA_CERTIFICATE + defaultValue: "" + type: string + description: The root CA certificate used to validate the server's TLS certificate. + If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_HTTP_ADDR: + name: OCS_HTTP_ADDR + defaultValue: 127.0.0.1:9110 + type: string + description: The bind address of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_HTTP_ROOT: + name: OCS_HTTP_ROOT + defaultValue: /ocs + type: string + description: Subdirectory that serves as the root for this HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_JWT_SECRET: + name: OCIS_JWT_SECRET;OCS_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_LOG_COLOR: + name: OCIS_LOG_COLOR;OCS_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_LOG_FILE: + name: OCIS_LOG_FILE;OCS_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_LOG_LEVEL: + name: OCIS_LOG_LEVEL;OCS_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_LOG_PRETTY: + name: OCIS_LOG_PRETTY;OCS_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;OCS_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;OCS_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;OCS_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_TRACING_TYPE: + name: OCIS_TRACING_TYPE;OCS_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_DEBUG_ADDR: + name: POLICIES_DEBUG_ADDR + defaultValue: 127.0.0.1:9129 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_DEBUG_PPROF: + name: POLICIES_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_DEBUG_TOKEN: + name: POLICIES_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_DEBUG_ZPAGES: + name: POLICIES_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_ENGINE_MIMES: + name: POLICIES_ENGINE_MIMES + defaultValue: "" + type: string + description: Sets the mimes file path which maps mimetypes to associated file extensions. + See the text description for details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_ENGINE_TIMEOUT: + name: POLICIES_ENGINE_TIMEOUT + defaultValue: 10s + type: Duration + description: Sets the timeout the rego expression evaluation can take. Rules default + to deny if the timeout was reached. See the Environment Variable Types description + for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_EVENTS_AUTH_PASSWORD: + name: OCIS_EVENTS_AUTH_PASSWORD;POLICIES_EVENTS_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_EVENTS_AUTH_USERNAME: + name: OCIS_EVENTS_AUTH_USERNAME;POLICIES_EVENTS_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_EVENTS_CLUSTER: + name: OCIS_EVENTS_CLUSTER;POLICIES_EVENTS_CLUSTER + defaultValue: ocis-cluster + type: string + description: The clusterID of the event system. The event system is the message + queuing service. It is used as message broker for the microservice architecture. + Mandatory when using NATS as event system. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_EVENTS_ENABLE_TLS: + name: OCIS_EVENTS_ENABLE_TLS;POLICIES_EVENTS_ENABLE_TLS + defaultValue: "false" + type: bool + description: Enable TLS for the connection to the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_EVENTS_ENDPOINT: + name: OCIS_EVENTS_ENDPOINT;POLICIES_EVENTS_ENDPOINT + defaultValue: 127.0.0.1:9233 + type: string + description: The address of the event system. The event system is the message queuing + service. It is used as message broker for the microservice architecture. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_EVENTS_TLS_INSECURE: + name: OCIS_INSECURE;POLICIES_EVENTS_TLS_INSECURE + defaultValue: "false" + type: bool + description: Whether the server should skip the client certificate verification + during the TLS handshake. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_EVENTS_TLS_ROOT_CA_CERTIFICATE: + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;POLICIES_EVENTS_TLS_ROOT_CA_CERTIFICATE + defaultValue: "" + type: string + description: The root CA certificate used to validate the server's TLS certificate. + If provided POLICIES_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_GRPC_ADDR: + name: POLICIES_GRPC_ADDR + defaultValue: 127.0.0.1:9125 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_LOG_COLOR: + name: OCIS_LOG_COLOR;POLICIES_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_LOG_FILE: + name: OCIS_LOG_FILE;POLICIES_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_LOG_LEVEL: + name: OCIS_LOG_LEVEL;POLICIES_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_LOG_PRETTY: + name: OCIS_LOG_PRETTY;POLICIES_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_POSTPROCESSING_QUERY: + name: POLICIES_POSTPROCESSING_QUERY + defaultValue: "" + type: string + description: Defines the 'Complete Rules' variable defined in the rego rule set + this step uses for its evaluation. Defaults to deny if the variable was not found. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;POLICIES_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;POLICIES_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;POLICIES_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POLICIES_TRACING_TYPE: + name: OCIS_TRACING_TYPE;POLICIES_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_DEBUG_ADDR: + name: POSTPROCESSING_DEBUG_ADDR + defaultValue: 127.0.0.1:9255 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_DEBUG_PPROF: + name: POSTPROCESSING_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_DEBUG_TOKEN: + name: POSTPROCESSING_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_DEBUG_ZPAGES: + name: POSTPROCESSING_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_DELAY: + name: POSTPROCESSING_DELAY + defaultValue: 0s + type: Duration + description: After uploading a file but before making it available for download, + a delay step can be added. Intended for developing purposes only. If a duration + is set but the keyword 'delay' is not explicitely added to 'POSTPROCESSING_STEPS', + the delay step will be processed as last step. In such a case, a log entry will + be written on service startup to remind the admin about that situation. See the + Environment Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_EVENTS_AUTH_PASSWORD: + name: OCIS_EVENTS_AUTH_PASSWORD;POSTPROCESSING_EVENTS_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_EVENTS_AUTH_USERNAME: + name: OCIS_EVENTS_AUTH_USERNAME;POSTPROCESSING_EVENTS_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_EVENTS_CLUSTER: + name: OCIS_EVENTS_CLUSTER;POSTPROCESSING_EVENTS_CLUSTER + defaultValue: ocis-cluster + type: string + description: The clusterID of the event system. The event system is the message + queuing service. It is used as message broker for the microservice architecture. + Mandatory when using NATS as event system. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_EVENTS_ENABLE_TLS: + name: OCIS_EVENTS_ENABLE_TLS;POSTPROCESSING_EVENTS_ENABLE_TLS + defaultValue: "false" + type: bool + description: Enable TLS for the connection to the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_EVENTS_ENDPOINT: + name: OCIS_EVENTS_ENDPOINT;POSTPROCESSING_EVENTS_ENDPOINT + defaultValue: 127.0.0.1:9233 + type: string + description: The address of the event system. The event system is the message queuing + service. It is used as message broker for the microservice architecture. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_EVENTS_TLS_INSECURE: + name: OCIS_INSECURE;POSTPROCESSING_EVENTS_TLS_INSECURE + defaultValue: "false" + type: bool + description: Whether the ocis server should skip the client certificate verification + during the TLS handshake. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_EVENTS_TLS_ROOT_CA_CERTIFICATE: + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;POSTPROCESSING_EVENTS_TLS_ROOT_CA_CERTIFICATE + defaultValue: "" + type: string + description: The root CA certificate used to validate the server's TLS certificate. + If provided POSTPROCESSING_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_LOG_COLOR: + name: OCIS_LOG_COLOR;POSTPROCESSING_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_LOG_FILE: + name: OCIS_LOG_FILE;POSTPROCESSING_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_LOG_LEVEL: + name: OCIS_LOG_LEVEL;POSTPROCESSING_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_LOG_PRETTY: + name: OCIS_LOG_PRETTY;POSTPROCESSING_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_MAX_RETRIES: + name: POSTPROCESSING_MAX_RETRIES + defaultValue: "14" + type: int + description: The maximum number of retries for a failed postprocessing step. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_RETRY_BACKOFF_DURATION: + name: POSTPROCESSING_RETRY_BACKOFF_DURATION + defaultValue: 5s + type: Duration + description: The base for the exponential backoff duration before retrying a failed + postprocessing step. See the Environment Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_STEPS: + name: POSTPROCESSING_STEPS + defaultValue: '[]' + type: '[]string' + description: 'A list of postprocessing steps processed in order of their appearance. + Currently supported values by the system are: ''virusscan'', ''policies'' and + ''delay''. Custom steps are allowed. See the documentation for instructions. See + the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_STORE: + name: OCIS_PERSISTENT_STORE;POSTPROCESSING_STORE + defaultValue: memory + type: string + description: 'The type of the store. Supported values are: ''memory'', ''ocmem'', + ''etcd'', ''redis'', ''redis-sentinel'', ''nats-js'', ''noop''. See the text description + for details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_STORE_AUTH_PASSWORD: + name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;POSTPROCESSING_STORE_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the store. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_STORE_AUTH_USERNAME: + name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;POSTPROCESSING_STORE_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the store. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_STORE_DATABASE: + name: POSTPROCESSING_STORE_DATABASE + defaultValue: postprocessing + type: string + description: The database name the configured store should use. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_STORE_NODES: + name: OCIS_PERSISTENT_STORE_NODES;POSTPROCESSING_STORE_NODES + defaultValue: '[]' + type: '[]string' + description: A list of nodes to access the configured store. This has no effect + when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes + are used is dependent on the library of the configured store. See the Environment + Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_STORE_SIZE: + name: OCIS_PERSISTENT_STORE_SIZE;POSTPROCESSING_STORE_SIZE + defaultValue: "0" + type: int + description: The maximum quantity of items in the store. Only applies when store + type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package + though not exclicitely set as default. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_STORE_TABLE: + name: POSTPROCESSING_STORE_TABLE + defaultValue: postprocessing + type: string + description: The database table the store should use. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_STORE_TTL: + name: OCIS_PERSISTENT_STORE_TTL;POSTPROCESSING_STORE_TTL + defaultValue: 0s + type: Duration + description: Time to live for events in the store. See the Environment Variable + Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;POSTPROCESSING_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;POSTPROCESSING_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;POSTPROCESSING_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +POSTPROCESSING_TRACING_TYPE: + name: OCIS_TRACING_TYPE;POSTPROCESSING_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_ACCOUNT_BACKEND_TYPE: + name: PROXY_ACCOUNT_BACKEND_TYPE + defaultValue: cs3 + type: string + description: Account backend the PROXY service should use. Currently only 'cs3' + is possible here. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_AUTOPROVISION_ACCOUNTS: + name: PROXY_AUTOPROVISION_ACCOUNTS + defaultValue: "false" + type: bool + description: Set this to 'true' to automatically provision users that do not yet + exist in the users service on-demand upon first sign-in. To use this a write-enabled + libregraph user backend needs to be setup an running. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_DEBUG_ADDR: + name: PROXY_DEBUG_ADDR + defaultValue: 127.0.0.1:9205 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_DEBUG_PPROF: + name: PROXY_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_DEBUG_TOKEN: + name: PROXY_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_DEBUG_ZPAGES: + name: PROXY_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_ENABLE_BASIC_AUTH: + name: PROXY_ENABLE_BASIC_AUTH + defaultValue: "false" + type: bool + description: Set this to true to enable 'basic authentication' (username/password). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_ENABLE_PRESIGNEDURLS: + name: PROXY_ENABLE_PRESIGNEDURLS + defaultValue: "true" + type: bool + description: Allow OCS to get a signing key to sign requests. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_HTTP_ADDR: + name: PROXY_HTTP_ADDR + defaultValue: 0.0.0.0:9200 + type: string + description: The bind address of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_HTTP_ROOT: + name: PROXY_HTTP_ROOT + defaultValue: / + type: string + description: Subdirectory that serves as the root for this HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_HTTPS_CACERT: + name: PROXY_HTTPS_CACERT + defaultValue: "" + type: string + description: Path/File for the root CA certificate used to validate the server’s + TLS certificate for https enabled backend services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_INSECURE_BACKENDS: + name: PROXY_INSECURE_BACKENDS + defaultValue: "false" + type: bool + description: Disable TLS certificate validation for all HTTP backend connections. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_LOG_COLOR: + name: OCIS_LOG_COLOR;PROXY_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_LOG_FILE: + name: OCIS_LOG_FILE;PROXY_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_LOG_LEVEL: + name: OCIS_LOG_LEVEL;PROXY_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_LOG_PRETTY: + name: OCIS_LOG_PRETTY;PROXY_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_MACHINE_AUTH_API_KEY: + name: OCIS_MACHINE_AUTH_API_KEY;PROXY_MACHINE_AUTH_API_KEY + defaultValue: "" + type: string + description: Machine auth API key used to validate internal requests necessary to + access resources from other services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_ACCESS_TOKEN_VERIFY_METHOD: + name: PROXY_OIDC_ACCESS_TOKEN_VERIFY_METHOD + defaultValue: jwt + type: string + description: Sets how OIDC access tokens should be verified. Possible values are + 'none' and 'jwt'. When using 'none', no special validation apart from using it + for accessing the IPD's userinfo endpoint will be done. When using 'jwt', it tries + to parse the access token as a jwt token and verifies the signature using the + keys published on the IDP's 'jwks_uri'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_INSECURE: + name: OCIS_INSECURE;PROXY_OIDC_INSECURE + defaultValue: "false" + type: bool + description: Disable TLS certificate validation for connections to the IDP. Note + that this is not recommended for production environments. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_ISSUER: + name: OCIS_URL;OCIS_OIDC_ISSUER;PROXY_OIDC_ISSUER + defaultValue: https://localhost:9200 + type: string + description: URL of the OIDC issuer. It defaults to URL of the builtin IDP. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_JWKS_REFRESH_INTERVAL: + name: PROXY_OIDC_JWKS_REFRESH_INTERVAL + defaultValue: "60" + type: uint64 + description: The interval for refreshing the JWKS (JSON Web Key Set) in minutes + in the background via a new HTTP request to the IDP. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_JWKS_REFRESH_RATE_LIMIT: + name: PROXY_OIDC_JWKS_REFRESH_RATE_LIMIT + defaultValue: "60" + type: uint64 + description: Limits the rate in seconds at which refresh requests are performed + for unknown keys. This is used to prevent malicious clients from imposing high + network load on the IDP via ocis. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_JWKS_REFRESH_TIMEOUT: + name: PROXY_OIDC_JWKS_REFRESH_TIMEOUT + defaultValue: "10" + type: uint64 + description: The timeout in seconds for an outgoing JWKS request. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_JWKS_REFRESH_UNKNOWN_KID: + name: PROXY_OIDC_JWKS_REFRESH_UNKNOWN_KID + defaultValue: "true" + type: bool + description: If set to 'true', the JWKS refresh request will occur every time an + unknown KEY ID (KID) is seen. Always set a 'refresh_limit' when enabling this. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_REWRITE_WELLKNOWN: + name: PROXY_OIDC_REWRITE_WELLKNOWN + defaultValue: "false" + type: bool + description: Enables rewriting the /.well-known/openid-configuration to the configured + OIDC issuer. Needed by the Desktop Client, Android Client and iOS Client to discover + the OIDC provider. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_SKIP_USER_INFO: + name: PROXY_OIDC_SKIP_USER_INFO + defaultValue: "false" + type: bool + description: Do not look up user claims at the userinfo endpoint and directly read + them from the access token. Incompatible with 'PROXY_OIDC_ACCESS_TOKEN_VERIFY_METHOD=none'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_USERINFO_CACHE_AUTH_PASSWORD: + name: OCIS_CACHE_AUTH_PASSWORD;PROXY_OIDC_USERINFO_CACHE_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the cache. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_USERINFO_CACHE_AUTH_USERNAME: + name: OCIS_CACHE_AUTH_USERNAME;PROXY_OIDC_USERINFO_CACHE_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the cache. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_USERINFO_CACHE_DISABLE_PERSISTENCE: + name: OCIS_CACHE_DISABLE_PERSISTENCE;PROXY_OIDC_USERINFO_CACHE_DISABLE_PERSISTENCE + defaultValue: "false" + type: bool + description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' + is configured. Defaults to false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_USERINFO_CACHE_SIZE: + name: OCIS_CACHE_SIZE;PROXY_OIDC_USERINFO_CACHE_SIZE + defaultValue: "0" + type: int + description: The maximum quantity of items in the user info cache. Only applies + when store type 'ocmem' is configured. Defaults to 512 which is derived from the + ocmem package though not exclicitely set as default. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_USERINFO_CACHE_STORE: + name: OCIS_CACHE_STORE;PROXY_OIDC_USERINFO_CACHE_STORE + defaultValue: memory + type: string + description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', + ''nats-js-kv'', ''noop''. See the text description for details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_USERINFO_CACHE_STORE_NODES: + name: OCIS_CACHE_STORE_NODES;PROXY_OIDC_USERINFO_CACHE_STORE_NODES + defaultValue: '[127.0.0.1:9233]' + type: '[]string' + description: A list of nodes to access the configured store. This has no effect + when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes + are used is dependent on the library of the configured store. See the Environment + Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_USERINFO_CACHE_TABLE: + name: PROXY_OIDC_USERINFO_CACHE_TABLE + defaultValue: "" + type: string + description: The database table the store should use. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_OIDC_USERINFO_CACHE_TTL: + name: OCIS_CACHE_TTL;PROXY_OIDC_USERINFO_CACHE_TTL + defaultValue: 10s + type: Duration + description: Default time to live for user info in the user info cache. Only applied + when access tokens has no expiration. See the Environment Variable Types description + for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_POLICIES_QUERY: + name: PROXY_POLICIES_QUERY + defaultValue: "" + type: string + description: Defines the 'Complete Rules' variable defined in the rego rule set + this step uses for its evaluation. Rules default to deny if the variable was not + found. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_ROLE_ASSIGNMENT_DRIVER: + name: PROXY_ROLE_ASSIGNMENT_DRIVER + defaultValue: default + type: string + description: 'The mechanism that should be used to assign roles to user upon login. + Supported values: ''default'' or ''oidc''. ''default'' will assign the role ''user'' + to users which don''t have a role assigned at the time they login. ''oidc'' will + assign the role based on the value of a claim (configured via PROXY_ROLE_ASSIGNMENT_OIDC_CLAIM) + from the users OIDC claims.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_ROLE_ASSIGNMENT_OIDC_CLAIM: + name: PROXY_ROLE_ASSIGNMENT_OIDC_CLAIM + defaultValue: roles + type: string + description: The OIDC claim used to create the users role assignment. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_SERVICE_ACCOUNT_ID: + name: OCIS_SERVICE_ACCOUNT_ID;PROXY_SERVICE_ACCOUNT_ID + defaultValue: "" + type: string + description: The ID of the service account the service should use. See the 'auth-service' + service description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_SERVICE_ACCOUNT_SECRET: + name: OCIS_SERVICE_ACCOUNT_SECRET;PROXY_SERVICE_ACCOUNT_SECRET + defaultValue: "" + type: string + description: The service account secret. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_TLS: + name: PROXY_TLS + defaultValue: "true" + type: bool + description: Enable/Disable HTTPS for external HTTP services. Must be set to 'true' + if the built-in IDP service an no reverse proxy is used. See the text description + for details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;PROXY_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;PROXY_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;PROXY_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_TRACING_TYPE: + name: OCIS_TRACING_TYPE;PROXY_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_TRANSPORT_TLS_CERT: + name: PROXY_TRANSPORT_TLS_CERT + defaultValue: /var/lib/ocis/proxy/server.crt + type: string + description: Path/File name of the TLS server certificate (in PEM format) for the + external http services. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/proxy. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_TRANSPORT_TLS_KEY: + name: PROXY_TRANSPORT_TLS_KEY + defaultValue: /var/lib/ocis/proxy/server.key + type: string + description: Path/File name for the TLS certificate key (in PEM format) for the + server certificate to use for the external http services. If not defined, the + root directory derives from $OCIS_BASE_DATA_PATH:/proxy. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_USER_CS3_CLAIM: + name: PROXY_USER_CS3_CLAIM + defaultValue: username + type: string + description: The name of a CS3 user attribute (claim) that should be mapped to the + 'user_oidc_claim'. Supported values are 'username', 'mail' and 'userid'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_USER_OIDC_CLAIM: + name: PROXY_USER_OIDC_CLAIM + defaultValue: preferred_username + type: string + description: The name of an OpenID Connect claim that is used for resolving users + with the account backend. The value of the claim must hold a per user unique, + stable and non re-assignable identifier. The availability of claims depends on + your Identity Provider. There are common claims available for most Identity providers + like 'email' or 'preferred_username' but you can also add your own claim. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_CONTENT_EXTRACTION_SIZE_LIMIT: + name: SEARCH_CONTENT_EXTRACTION_SIZE_LIMIT + defaultValue: "20971520" + type: uint64 + description: Maximum file size in bytes that is allowed for content extraction. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_DEBUG_ADDR: + name: SEARCH_DEBUG_ADDR + defaultValue: 127.0.0.1:9224 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_DEBUG_PPROF: + name: SEARCH_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_DEBUG_TOKEN: + name: SEARCH_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_DEBUG_ZPAGES: + name: SEARCH_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_ENGINE_BLEVE_DATA_PATH: + name: SEARCH_ENGINE_BLEVE_DATA_PATH + defaultValue: /var/lib/ocis/search + type: string + description: The directory where the filesystem will store search data. If not defined, + the root directory derives from $OCIS_BASE_DATA_PATH:/search. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_ENGINE_TYPE: + name: SEARCH_ENGINE_TYPE + defaultValue: bleve + type: string + description: 'Defines which search engine to use. Defaults to ''bleve''. Supported + values are: ''bleve''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_EVENTS_ASYNC_UPLOADS: + name: OCIS_ASYNC_UPLOADS;SEARCH_EVENTS_ASYNC_UPLOADS + defaultValue: "true" + type: bool + description: Enable asynchronous file uploads. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_EVENTS_AUTH_PASSWORD: + name: OCIS_EVENTS_AUTH_PASSWORD;SEARCH_EVENTS_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_EVENTS_AUTH_USERNAME: + name: OCIS_EVENTS_AUTH_USERNAME;SEARCH_EVENTS_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_EVENTS_CLUSTER: + name: OCIS_EVENTS_CLUSTER;SEARCH_EVENTS_CLUSTER + defaultValue: ocis-cluster + type: string + description: The clusterID of the event system. The event system is the message + queuing service. It is used as message broker for the microservice architecture. + Mandatory when using NATS as event system. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_EVENTS_ENABLE_TLS: + name: OCIS_EVENTS_ENABLE_TLS;SEARCH_EVENTS_ENABLE_TLS + defaultValue: "false" + type: bool + description: Enable TLS for the connection to the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_EVENTS_ENDPOINT: + name: OCIS_EVENTS_ENDPOINT;SEARCH_EVENTS_ENDPOINT + defaultValue: 127.0.0.1:9233 + type: string + description: The address of the event system. The event system is the message queuing + service. It is used as message broker for the microservice architecture. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_EVENTS_NUM_CONSUMERS: + name: SEARCH_EVENTS_NUM_CONSUMERS + defaultValue: "0" + type: int + description: The amount of concurrent event consumers to start. Event consumers + are used for searching files. Multiple consumers increase parallelisation, but + will also increase CPU and memory demands. The default value is 0. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_EVENTS_REINDEX_DEBOUNCE_DURATION: + name: SEARCH_EVENTS_REINDEX_DEBOUNCE_DURATION + defaultValue: "1000" + type: int + description: The duration in milliseconds the reindex debouncer waits before triggering + a reindex of a space that was modified. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_EVENTS_TLS_INSECURE: + name: OCIS_INSECURE;SEARCH_EVENTS_TLS_INSECURE + defaultValue: "false" + type: bool + description: Whether to verify the server TLS certificates. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_EVENTS_TLS_ROOT_CA_CERTIFICATE: + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;SEARCH_EVENTS_TLS_ROOT_CA_CERTIFICATE + defaultValue: "" + type: string + description: The root CA certificate used to validate the server's TLS certificate. + If provided SEARCH_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_EXTRACTOR_CS3SOURCE_INSECURE: + name: OCIS_INSECURE;SEARCH_EXTRACTOR_CS3SOURCE_INSECURE + defaultValue: "false" + type: bool + description: Ignore untrusted SSL certificates when connecting to the CS3 source. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_EXTRACTOR_TIKA_CLEAN_STOP_WORDS: + name: SEARCH_EXTRACTOR_TIKA_CLEAN_STOP_WORDS + defaultValue: "true" + type: bool + description: Defines if stop words should be cleaned or not. See the documentation + for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_EXTRACTOR_TIKA_TIKA_URL: + name: SEARCH_EXTRACTOR_TIKA_TIKA_URL + defaultValue: http://127.0.0.1:9998 + type: string + description: URL of the tika server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_EXTRACTOR_TYPE: + name: SEARCH_EXTRACTOR_TYPE + defaultValue: basic + type: string + description: 'Defines the content extraction engine. Defaults to ''basic''. Supported + values are: ''basic'' and ''tika''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_GRPC_ADDR: + name: SEARCH_GRPC_ADDR + defaultValue: 127.0.0.1:9220 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_JWT_SECRET: + name: OCIS_JWT_SECRET;SEARCH_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_LOG_COLOR: + name: OCIS_LOG_COLOR;SEARCH_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_LOG_FILE: + name: OCIS_LOG_FILE;SEARCH_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_LOG_LEVEL: + name: OCIS_LOG_LEVEL;SEARCH_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_LOG_PRETTY: + name: OCIS_LOG_PRETTY;SEARCH_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_SERVICE_ACCOUNT_ID: + name: OCIS_SERVICE_ACCOUNT_ID;SEARCH_SERVICE_ACCOUNT_ID + defaultValue: "" + type: string + description: The ID of the service account the service should use. See the 'auth-service' + service description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_SERVICE_ACCOUNT_SECRET: + name: OCIS_SERVICE_ACCOUNT_SECRET;SEARCH_SERVICE_ACCOUNT_SECRET + defaultValue: "" + type: string + description: The service account secret. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;SEARCH_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;SEARCH_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;SEARCH_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SEARCH_TRACING_TYPE: + name: OCIS_TRACING_TYPE;SEARCH_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_ADMIN_USER_ID: + name: OCIS_ADMIN_USER_ID;SETTINGS_ADMIN_USER_ID + defaultValue: "" + type: string + description: ID of the user that should receive admin privileges. Consider that + the UUID can be encoded in some LDAP deployment configurations like in .ldif files. + These need to be decoded beforehand. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_BUNDLES_PATH: + name: SETTINGS_BUNDLES_PATH + defaultValue: "" + type: string + description: The path to a JSON file with a list of bundles. If not defined, the + default bundles will be loaded. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_CACHE_AUTH_PASSWORD: + name: OCIS_CACHE_AUTH_PASSWORD;SETTINGS_CACHE_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the cache. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_CACHE_AUTH_USERNAME: + name: OCIS_CACHE_AUTH_USERNAME;SETTINGS_CACHE_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the cache. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_CACHE_DISABLE_PERSISTENCE: + name: OCIS_CACHE_DISABLE_PERSISTENCE;SETTINGS_CACHE_DISABLE_PERSISTENCE + defaultValue: "false" + type: bool + description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' + is configured. Defaults to false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_CACHE_SIZE: + name: OCIS_CACHE_SIZE;SETTINGS_CACHE_SIZE + defaultValue: "0" + type: int + description: The maximum quantity of items in the cache. Only applies when store + type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package + though not exclicitely set as default. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_CACHE_STORE: + name: OCIS_CACHE_STORE;SETTINGS_CACHE_STORE + defaultValue: memory + type: string + description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', + ''nats-js-kv'', ''noop''. See the text description for details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_CACHE_STORE_NODES: + name: OCIS_CACHE_STORE_NODES;SETTINGS_CACHE_STORE_NODES + defaultValue: '[127.0.0.1:9233]' + type: '[]string' + description: A list of nodes to access the configured store. This has no effect + when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes + are used is dependent on the library of the configured store. See the Environment + Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_CACHE_TTL: + name: OCIS_CACHE_TTL;SETTINGS_CACHE_TTL + defaultValue: 10m0s + type: Duration + description: Default time to live for entries in the cache. Only applied when access + tokens has no expiration. See the Environment Variable Types description for more + details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_CORS_ALLOW_CREDENTIALS: + name: OCIS_CORS_ALLOW_CREDENTIALS;SETTINGS_CORS_ALLOW_CREDENTIALS + defaultValue: "true" + type: bool + description: 'Allow credentials for CORS.See following chapter for more details: + *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_CORS_ALLOW_HEADERS: + name: OCIS_CORS_ALLOW_HEADERS;SETTINGS_CORS_ALLOW_HEADERS + defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id]' + type: '[]string' + description: 'A list of allowed CORS headers. See following chapter for more details: + *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_CORS_ALLOW_METHODS: + name: OCIS_CORS_ALLOW_METHODS;SETTINGS_CORS_ALLOW_METHODS + defaultValue: '[GET POST PUT PATCH DELETE OPTIONS]' + type: '[]string' + description: 'A list of allowed CORS methods. See following chapter for more details: + *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_CORS_ALLOW_ORIGINS: + name: OCIS_CORS_ALLOW_ORIGINS;SETTINGS_CORS_ALLOW_ORIGINS + defaultValue: '[*]' + type: '[]string' + description: 'A list of allowed CORS origins. See following chapter for more details: + *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_DATA_PATH: + name: SETTINGS_DATA_PATH + defaultValue: /var/lib/ocis/settings + type: string + description: The directory where the filesystem storage will store ocis settings. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/settings. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_DEBUG_ADDR: + name: SETTINGS_DEBUG_ADDR + defaultValue: 127.0.0.1:9194 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_DEBUG_PPROF: + name: SETTINGS_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_DEBUG_TOKEN: + name: SETTINGS_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_DEBUG_ZPAGES: + name: SETTINGS_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_DIRECTORY_CACHE_TABLE: + name: SETTINGS_DIRECTORY_CACHE_TABLE + defaultValue: settings_dirs + type: string + description: The database table the store should use for the directory cache. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_FILE_CACHE_TABLE: + name: SETTINGS_FILE_CACHE_TABLE + defaultValue: settings_files + type: string + description: The database table the store should use for the file cache. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_GRPC_ADDR: + name: SETTINGS_GRPC_ADDR + defaultValue: 127.0.0.1:9191 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_HTTP_ADDR: + name: SETTINGS_HTTP_ADDR + defaultValue: 127.0.0.1:9190 + type: string + description: The bind address of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_HTTP_ROOT: + name: SETTINGS_HTTP_ROOT + defaultValue: / + type: string + description: Subdirectory that serves as the root for this HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_JWT_SECRET: + name: OCIS_JWT_SECRET;SETTINGS_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_LOG_COLOR: + name: OCIS_LOG_COLOR;SETTINGS_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_LOG_FILE: + name: OCIS_LOG_FILE;SETTINGS_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_LOG_LEVEL: + name: OCIS_LOG_LEVEL;SETTINGS_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_LOG_PRETTY: + name: OCIS_LOG_PRETTY;SETTINGS_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_SERVICE_ACCOUNT_IDS: + name: SETTINGS_SERVICE_ACCOUNT_IDS;OCIS_SERVICE_ACCOUNT_ID + defaultValue: '[service-user-id]' + type: '[]string' + description: 'The list of all service account IDs. These will be assigned the hidden + ''service-account'' role. Note: When using ''OCIS_SERVICE_ACCOUNT_ID'' this will + contain only one value while ''SETTINGS_SERVICE_ACCOUNT_IDS'' can have multiple. + See the ''auth-service'' service description for more details about service accounts.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_SETUP_DEFAULT_ASSIGNMENTS: + name: SETTINGS_SETUP_DEFAULT_ASSIGNMENTS;IDM_CREATE_DEMO_USERS + defaultValue: "false" + type: bool + description: The default role assignments the demo users should be setup. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_STORE_TYPE: + name: SETTINGS_STORE_TYPE + defaultValue: metadata + type: string + description: Store type configures the persistency driver. Supported values are + 'metadata' and 'filesystem'. Note that the value 'filesystem' is considered deprecated. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_SYSTEM_USER_ID: + name: OCIS_SYSTEM_USER_ID;SETTINGS_SYSTEM_USER_ID + defaultValue: "" + type: string + description: ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID + for the STORAGE-SYSTEM system user in this config option which is then used to + reference the user. Any reasonable long string is possible, preferably this would + be an UUIDv4 format. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_SYSTEM_USER_IDP: + name: OCIS_SYSTEM_USER_IDP;SETTINGS_SYSTEM_USER_IDP + defaultValue: internal + type: string + description: IDP of the oCIS STORAGE-SYSTEM system user. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;SETTINGS_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;SETTINGS_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;SETTINGS_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SETTINGS_TRACING_TYPE: + name: OCIS_TRACING_TYPE;SETTINGS_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_DEBUG_ADDR: + name: SHARING_DEBUG_ADDR + defaultValue: 127.0.0.1:9151 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_DEBUG_PPROF: + name: SHARING_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_DEBUG_TOKEN: + name: SHARING_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_DEBUG_ZPAGES: + name: SHARING_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_EVENTS_AUTH_PASSWORD: + name: OCIS_EVENTS_AUTH_PASSWORD;SHARING_EVENTS_AUTH_PASSWORD + defaultValue: "" + type: string + description: Password for the events broker. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_EVENTS_AUTH_USERNAME: + name: OCIS_EVENTS_AUTH_USERNAME;SHARING_EVENTS_AUTH_USERNAME + defaultValue: "" + type: string + description: Username for the events broker. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_EVENTS_CLUSTER: + name: OCIS_EVENTS_CLUSTER;SHARING_EVENTS_CLUSTER + defaultValue: ocis-cluster + type: string + description: The clusterID of the event system. The event system is the message + queuing service. It is used as message broker for the microservice architecture. + Mandatory when using NATS as event system. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_EVENTS_ENABLE_TLS: + name: OCIS_EVENTS_ENABLE_TLS;SHARING_EVENTS_ENABLE_TLS + defaultValue: "false" + type: bool + description: Enable TLS for the connection to the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_EVENTS_ENDPOINT: + name: OCIS_EVENTS_ENDPOINT;SHARING_EVENTS_ENDPOINT + defaultValue: 127.0.0.1:9233 + type: string + description: The address of the event system. The event system is the message queuing + service. It is used as message broker for the microservice architecture. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_EVENTS_TLS_INSECURE: + name: OCIS_INSECURE;SHARING_EVENTS_TLS_INSECURE + defaultValue: "false" + type: bool + description: Whether to verify the server TLS certificates. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_EVENTS_TLS_ROOT_CA_CERTIFICATE: + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;SHARING_EVENTS_TLS_ROOT_CA_CERTIFICATE + defaultValue: "" + type: string + description: The root CA certificate used to validate the server's TLS certificate. + If provided SHARING_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_GRPC_ADDR: + name: SHARING_GRPC_ADDR + defaultValue: 127.0.0.1:9150 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_GRPC_PROTOCOL: + name: SHARING_GRPC_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_JWT_SECRET: + name: OCIS_JWT_SECRET;SHARING_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_LOG_COLOR: + name: OCIS_LOG_COLOR;SHARING_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_LOG_FILE: + name: OCIS_LOG_FILE;SHARING_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_LOG_LEVEL: + name: OCIS_LOG_LEVEL;SHARING_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_LOG_PRETTY: + name: OCIS_LOG_PRETTY;SHARING_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_OCM_PROVIDER_AUTHORIZER_DRIVER: + name: SHARING_OCM_PROVIDER_AUTHORIZER_DRIVER + defaultValue: json + type: string + description: Driver to be used to persist ocm invites. Supported value is only 'json'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PASSWORD_POLICY_BANNED_PASSWORDS_LIST: + name: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST;SHARING_PASSWORD_POLICY_BANNED_PASSWORDS_LIST + defaultValue: "" + type: string + description: Path to the 'banned passwords list' file. See the documentation for + more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PASSWORD_POLICY_DISABLED: + name: OCIS_PASSWORD_POLICY_DISABLED;SHARING_PASSWORD_POLICY_DISABLED + defaultValue: "false" + type: bool + description: Disable the password policy. Defaults to false if not set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PASSWORD_POLICY_MIN_CHARACTERS: + name: OCIS_PASSWORD_POLICY_MIN_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_CHARACTERS + defaultValue: "8" + type: int + description: Define the minimum password length. Defaults to 8 if not set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PASSWORD_POLICY_MIN_DIGITS: + name: OCIS_PASSWORD_POLICY_MIN_DIGITS;SHARING_PASSWORD_POLICY_MIN_DIGITS + defaultValue: "1" + type: int + description: Define the minimum number of digits. Defaults to 1 if not set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS: + name: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS + defaultValue: "1" + type: int + description: Define the minimum number of uppercase letters. Defaults to 1 if not + set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS: + name: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS + defaultValue: "1" + type: int + description: Define the minimum number of characters from the special characters + list to be present. Defaults to 1 if not set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS: + name: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS + defaultValue: "1" + type: int + description: Define the minimum number of lowercase letters. Defaults to 1 if not + set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PUBLIC_CS3_PROVIDER_ADDR: + name: SHARING_PUBLIC_CS3_PROVIDER_ADDR + defaultValue: com.owncloud.api.storage-system + type: string + description: GRPC address of the STORAGE-SYSTEM service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PUBLIC_CS3_SYSTEM_USER_API_KEY: + name: OCIS_SYSTEM_USER_API_KEY;SHARING_PUBLIC_CS3_SYSTEM_USER_API_KEY + defaultValue: "" + type: string + description: API key for the STORAGE-SYSTEM system user. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PUBLIC_CS3_SYSTEM_USER_ID: + name: OCIS_SYSTEM_USER_ID;SHARING_PUBLIC_CS3_SYSTEM_USER_ID + defaultValue: "" + type: string + description: ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID + for the STORAGE-SYSTEM system user in this config option which is then used to + reference the user. Any reasonable long string is possible, preferably this would + be an UUIDv4 format. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PUBLIC_CS3_SYSTEM_USER_IDP: + name: OCIS_SYSTEM_USER_IDP;SHARING_PUBLIC_CS3_SYSTEM_USER_IDP + defaultValue: internal + type: string + description: IDP of the oCIS STORAGE-SYSTEM system user. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PUBLIC_DRIVER: + name: SHARING_PUBLIC_DRIVER + defaultValue: jsoncs3 + type: string + description: Driver to be used to persist public shares. Supported values are 'jsoncs3', + 'json' and 'cs3'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PUBLIC_JSON_FILE: + name: SHARING_PUBLIC_JSON_FILE + defaultValue: /var/lib/ocis/storage/publicshares.json + type: string + description: Path to the JSON file where public share meta-data will be stored. + This JSON file contains the information about public shares that have been created. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PUBLIC_JSONCS3_PROVIDER_ADDR: + name: SHARING_PUBLIC_JSONCS3_PROVIDER_ADDR + defaultValue: com.owncloud.api.storage-system + type: string + description: GRPC address of the STORAGE-SYSTEM service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PUBLIC_JSONCS3_SYSTEM_USER_API_KEY: + name: OCIS_SYSTEM_USER_API_KEY;SHARING_PUBLIC_JSONCS3_SYSTEM_USER_API_KEY + defaultValue: "" + type: string + description: API key for the STORAGE-SYSTEM system user. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PUBLIC_JSONCS3_SYSTEM_USER_ID: + name: OCIS_SYSTEM_USER_ID;SHARING_PUBLIC_JSONCS3_SYSTEM_USER_ID + defaultValue: "" + type: string + description: ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID + for the STORAGE-SYSTEM system user in this config option which is then used to + reference the user. Any reasonable long string is possible, preferably this would + be an UUIDv4 format. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PUBLIC_JSONCS3_SYSTEM_USER_IDP: + name: OCIS_SYSTEM_USER_IDP;SHARING_PUBLIC_JSONCS3_SYSTEM_USER_IDP + defaultValue: internal + type: string + description: IDP of the oCIS STORAGE-SYSTEM system user. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD: + name: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD;SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD + defaultValue: "true" + type: bool + description: Set this to true if you want to enforce passwords on all public shares. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD: + name: OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD;SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD + defaultValue: "false" + type: bool + description: Set this to true if you want to enforce passwords on Uploader, Editor + or Contributor shares. If not using the global OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD, + you must define the FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD in + the frontend service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_SKIP_USER_GROUPS_IN_TOKEN: + name: SHARING_SKIP_USER_GROUPS_IN_TOKEN + defaultValue: "false" + type: bool + description: Disables the loading of user's group memberships from the reva access + token. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;SHARING_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;SHARING_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;SHARING_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_TRACING_TYPE: + name: OCIS_TRACING_TYPE;SHARING_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_USER_CS3_PROVIDER_ADDR: + name: SHARING_USER_CS3_PROVIDER_ADDR + defaultValue: com.owncloud.api.storage-system + type: string + description: GRPC address of the STORAGE-SYSTEM service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_USER_CS3_SYSTEM_USER_API_KEY: + name: OCIS_SYSTEM_USER_API_KEY;SHARING_USER_CS3_SYSTEM_USER_API_KEY + defaultValue: "" + type: string + description: API key for the STORAGE-SYSTEM system user. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_USER_CS3_SYSTEM_USER_ID: + name: OCIS_SYSTEM_USER_ID;SHARING_USER_CS3_SYSTEM_USER_ID + defaultValue: "" + type: string + description: ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID + for the STORAGE-SYSTEM system user in this config option which is then used to + reference the user. Any reasonable long string is possible, preferably this would + be an UUIDv4 format. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_USER_CS3_SYSTEM_USER_IDP: + name: OCIS_SYSTEM_USER_IDP;SHARING_USER_CS3_SYSTEM_USER_IDP + defaultValue: internal + type: string + description: IDP of the oCIS STORAGE-SYSTEM system user. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_USER_DRIVER: + name: SHARING_USER_DRIVER + defaultValue: jsoncs3 + type: string + description: Driver to be used to persist shares. Supported values are 'jsoncs3', + 'json', 'cs3' and 'owncloudsql'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_USER_JSON_FILE: + name: SHARING_USER_JSON_FILE + defaultValue: /var/lib/ocis/storage/shares.json + type: string + description: Path to the JSON file where shares will be persisted. If not defined, + the root directory derives from $OCIS_BASE_DATA_PATH:/storage. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_USER_JSONCS3_CACHE_TTL: + name: SHARING_USER_JSONCS3_CACHE_TTL + defaultValue: "0" + type: int + description: TTL for the internal caches in seconds. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_USER_JSONCS3_PROVIDER_ADDR: + name: SHARING_USER_JSONCS3_PROVIDER_ADDR + defaultValue: com.owncloud.api.storage-system + type: string + description: GRPC address of the STORAGE-SYSTEM service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_USER_JSONCS3_SYSTEM_USER_API_KEY: + name: OCIS_SYSTEM_USER_API_KEY;SHARING_USER_JSONCS3_SYSTEM_USER_API_KEY + defaultValue: "" + type: string + description: API key for the STORAGE-SYSTEM system user. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_USER_JSONCS3_SYSTEM_USER_ID: + name: OCIS_SYSTEM_USER_ID;SHARING_USER_JSONCS3_SYSTEM_USER_ID + defaultValue: "" + type: string + description: ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID + for the STORAGE-SYSTEM system user in this config option which is then used to + reference the user. Any reasonable long string is possible, preferably this would + be an UUIDv4 format. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_USER_JSONCS3_SYSTEM_USER_IDP: + name: OCIS_SYSTEM_USER_IDP;SHARING_USER_JSONCS3_SYSTEM_USER_IDP + defaultValue: internal + type: string + description: IDP of the oCIS STORAGE-SYSTEM system user. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_USER_OWNCLOUDSQL_DB_HOST: + name: SHARING_USER_OWNCLOUDSQL_DB_HOST + defaultValue: mysql + type: string + description: Hostname or IP of the database server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_USER_OWNCLOUDSQL_DB_NAME: + name: SHARING_USER_OWNCLOUDSQL_DB_NAME + defaultValue: owncloud + type: string + description: Name of the database to be used. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_USER_OWNCLOUDSQL_DB_PASSWORD: + name: SHARING_USER_OWNCLOUDSQL_DB_PASSWORD + defaultValue: "" + type: string + description: Password for the database. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_USER_OWNCLOUDSQL_DB_PORT: + name: SHARING_USER_OWNCLOUDSQL_DB_PORT + defaultValue: "3306" + type: int + description: Port that the database server is listening on. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_USER_OWNCLOUDSQL_DB_USERNAME: + name: SHARING_USER_OWNCLOUDSQL_DB_USERNAME + defaultValue: owncloud + type: string + description: Username for the database. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID: + name: SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID + defaultValue: "" + type: string + description: Mount ID of the ownCloudSQL users storage for mapping ownCloud 10 shares. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_CORS_ALLOW_CREDENTIALS: + name: OCIS_CORS_ALLOW_CREDENTIALS;SSE_CORS_ALLOW_CREDENTIALS + defaultValue: "true" + type: bool + description: 'Allow credentials for CORS.See following chapter for more details: + *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_CORS_ALLOW_HEADERS: + name: OCIS_CORS_ALLOW_HEADERS;SSE_CORS_ALLOW_HEADERS + defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id + Ocs-Apirequest]' + type: '[]string' + description: 'A list of allowed CORS headers. See following chapter for more details: + *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_CORS_ALLOW_METHODS: + name: OCIS_CORS_ALLOW_METHODS;SSE_CORS_ALLOW_METHODS + defaultValue: '[GET]' + type: '[]string' + description: 'A list of allowed CORS methods. See following chapter for more details: + *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_CORS_ALLOW_ORIGINS: + name: OCIS_CORS_ALLOW_ORIGINS;SSE_CORS_ALLOW_ORIGINS + defaultValue: '[*]' + type: '[]string' + description: 'A list of allowed CORS origins. See following chapter for more details: + *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_DEBUG_ADDR: + name: SSE_DEBUG_ADDR + defaultValue: 127.0.0.1:9135 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_DEBUG_PPROF: + name: SSE_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_DEBUG_TOKEN: + name: SSE_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_DEBUG_ZPAGES: + name: SSE_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_EVENTS_AUTH_PASSWORD: + name: OCIS_EVENTS_AUTH_PASSWORD;SSE_EVENTS_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_EVENTS_AUTH_USERNAME: + name: OCIS_EVENTS_AUTH_USERNAME;SSE_EVENTS_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_EVENTS_CLUSTER: + name: OCIS_EVENTS_CLUSTER;SSE_EVENTS_CLUSTER + defaultValue: ocis-cluster + type: string + description: The clusterID of the event system. The event system is the message + queuing service. It is used as message broker for the microservice architecture. + Mandatory when using NATS as event system. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_EVENTS_ENABLE_TLS: + name: OCIS_EVENTS_ENABLE_TLS;SSE_EVENTS_ENABLE_TLS + defaultValue: "false" + type: bool + description: Enable TLS for the connection to the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_EVENTS_ENDPOINT: + name: OCIS_EVENTS_ENDPOINT;SSE_EVENTS_ENDPOINT + defaultValue: 127.0.0.1:9233 + type: string + description: The address of the event system. The event system is the message queuing + service. It is used as message broker for the microservice architecture. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_EVENTS_TLS_INSECURE: + name: OCIS_INSECURE;SSE_EVENTS_TLS_INSECURE + defaultValue: "false" + type: bool + description: Whether to verify the server TLS certificates. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_EVENTS_TLS_ROOT_CA_CERTIFICATE: + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;SSE_EVENTS_TLS_ROOT_CA_CERTIFICATE + defaultValue: "" + type: string + description: The root CA certificate used to validate the server's TLS certificate. + If provided SSE_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_HTTP_ADDR: + name: SSE_HTTP_ADDR + defaultValue: 127.0.0.1:0 + type: string + description: The bind address of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_HTTP_ROOT: + name: SSE_HTTP_ROOT + defaultValue: / + type: string + description: Subdirectory that serves as the root for this HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_JWT_SECRET: + name: OCIS_JWT_SECRET;SSE_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_LOG_COLOR: + name: OCIS_LOG_COLOR;SSE_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_LOG_FILE: + name: OCIS_LOG_FILE;SSE_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_LOG_LEVEL: + name: OCIS_LOG_LEVEL;SSE_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_LOG_PRETTY: + name: OCIS_LOG_PRETTY;SSE_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;SSE_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;SSE_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;SSE_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +SSE_TRACING_TYPE: + name: OCIS_TRACING_TYPE;SSE_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_GATEWAY_GRPC_ADDR: + name: STORAGE_GATEWAY_GRPC_ADDR + defaultValue: com.owncloud.api.storage-system + type: string + description: GRPC address of the STORAGE-SYSTEM service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_GRPC_ADDR: + name: STORAGE_GRPC_ADDR + defaultValue: com.owncloud.api.storage-system + type: string + description: GRPC address of the STORAGE-SYSTEM service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_DEBUG_ADDR: + name: STORAGE_PUBLICLINK_DEBUG_ADDR + defaultValue: 127.0.0.1:9179 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_DEBUG_PPROF: + name: STORAGE_PUBLICLINK_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_DEBUG_TOKEN: + name: STORAGE_PUBLICLINK_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_DEBUG_ZPAGES: + name: STORAGE_PUBLICLINK_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_GRPC_ADDR: + name: STORAGE_PUBLICLINK_GRPC_ADDR + defaultValue: 127.0.0.1:9178 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_GRPC_PROTOCOL: + name: STORAGE_PUBLICLINK_GRPC_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_JWT_SECRET: + name: OCIS_JWT_SECRET;STORAGE_PUBLICLINK_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_LOG_COLOR: + name: OCIS_LOG_COLOR;STORAGE_PUBLICLINK_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_LOG_FILE: + name: OCIS_LOG_FILE;STORAGE_PUBLICLINK_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_LOG_LEVEL: + name: OCIS_LOG_LEVEL;STORAGE_PUBLICLINK_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_LOG_PRETTY: + name: OCIS_LOG_PRETTY;STORAGE_PUBLICLINK_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_SKIP_USER_GROUPS_IN_TOKEN: + name: STORAGE_PUBLICLINK_SKIP_USER_GROUPS_IN_TOKEN + defaultValue: "false" + type: bool + description: Disables the loading of user's group memberships from the reva access + token. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_STORAGE_PROVIDER_MOUNT_ID: + name: STORAGE_PUBLICLINK_STORAGE_PROVIDER_MOUNT_ID + defaultValue: 7993447f-687f-490d-875c-ac95e89a62a4 + type: string + description: Mount ID of this storage. Admins can set the ID for the storage in + this config option manually which is then used to reference the storage. Any reasonable + long string is possible, preferably this would be an UUIDv4 format. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;STORAGE_PUBLICLINK_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;STORAGE_PUBLICLINK_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;STORAGE_PUBLICLINK_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_PUBLICLINK_TRACING_TYPE: + name: OCIS_TRACING_TYPE;STORAGE_PUBLICLINK_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_DEBUG_ADDR: + name: STORAGE_SHARES_DEBUG_ADDR + defaultValue: 127.0.0.1:9156 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_DEBUG_PPROF: + name: STORAGE_SHARES_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_DEBUG_TOKEN: + name: STORAGE_SHARES_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_DEBUG_ZPAGES: + name: STORAGE_SHARES_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_GRPC_ADDR: + name: STORAGE_SHARES_GRPC_ADDR + defaultValue: 127.0.0.1:9154 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_GRPC_PROTOCOL: + name: STORAGE_SHARES_GRPC_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_JWT_SECRET: + name: OCIS_JWT_SECRET;STORAGE_SHARES_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_LOG_COLOR: + name: OCIS_LOG_COLOR;STORAGE_SHARES_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_LOG_FILE: + name: OCIS_LOG_FILE;STORAGE_SHARES_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_LOG_LEVEL: + name: OCIS_LOG_LEVEL;STORAGE_SHARES_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_LOG_PRETTY: + name: OCIS_LOG_PRETTY;STORAGE_SHARES_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_MOUNT_ID: + name: STORAGE_SHARES_MOUNT_ID + defaultValue: 7639e57c-4433-4a12-8201-722fd0009154 + type: string + description: Mount ID of this storage. Admins can set the ID for the storage in + this config option manually which is then used to reference the storage. Any reasonable + long string is possible, preferably this would be an UUIDv4 format. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_READ_ONLY: + name: STORAGE_SHARES_READ_ONLY + defaultValue: "false" + type: bool + description: Set this storage to be read-only. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_SKIP_USER_GROUPS_IN_TOKEN: + name: STORAGE_SHARES_SKIP_USER_GROUPS_IN_TOKEN + defaultValue: "false" + type: bool + description: Disables the loading of user's group memberships from the reva access + token. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;STORAGE_SHARES_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;STORAGE_SHARES_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;STORAGE_SHARES_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_TRACING_TYPE: + name: OCIS_TRACING_TYPE;STORAGE_SHARES_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SHARES_USER_SHARE_PROVIDER_ENDPOINT: + name: STORAGE_SHARES_USER_SHARE_PROVIDER_ENDPOINT + defaultValue: com.owncloud.api.sharing + type: string + description: GRPC endpoint of the SHARING service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_CACHE_AUTH_PASSWORD: + name: OCIS_CACHE_AUTH_PASSWORD;STORAGE_SYSTEM_CACHE_AUTH_PASSWORD + defaultValue: "" + type: string + description: Password for the configured store. Only applies when store type 'nats-js-kv' + is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_CACHE_AUTH_USERNAME: + name: OCIS_CACHE_AUTH_USERNAME;STORAGE_SYSTEM_CACHE_AUTH_USERNAME + defaultValue: "" + type: string + description: Username for the configured store. Only applies when store type 'nats-js-kv' + is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_CACHE_DISABLE_PERSISTENCE: + name: OCIS_CACHE_DISABLE_PERSISTENCE;STORAGE_SYSTEM_CACHE_DISABLE_PERSISTENCE + defaultValue: "false" + type: bool + description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' + is configured. Defaults to false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_CACHE_SIZE: + name: OCIS_CACHE_SIZE;STORAGE_SYSTEM_CACHE_SIZE + defaultValue: "0" + type: int + description: The maximum quantity of items in the user info cache. Only applies + when store type 'ocmem' is configured. Defaults to 512 which is derived from the + ocmem package though not exclicitely set as default. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_CACHE_STORE: + name: OCIS_CACHE_STORE;STORAGE_SYSTEM_CACHE_STORE + defaultValue: memory + type: string + description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', + ''nats-js-kv'', ''noop''. See the text description for details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_CACHE_STORE_NODES: + name: OCIS_CACHE_STORE_NODES;STORAGE_SYSTEM_CACHE_STORE_NODES + defaultValue: '[127.0.0.1:9233]' + type: '[]string' + description: A list of nodes to access the configured store. This has no effect + when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes + are used is dependent on the library of the configured store. See the Environment + Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_CACHE_TTL: + name: OCIS_CACHE_TTL;STORAGE_SYSTEM_CACHE_TTL + defaultValue: 24m0s + type: Duration + description: Default time to live for user info in the user info cache. Only applied + when access tokens has no expiration. See the Environment Variable Types description + for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_DATA_SERVER_URL: + name: STORAGE_SYSTEM_DATA_SERVER_URL + defaultValue: http://localhost:9216/data + type: string + description: URL of the data server, needs to be reachable by other services using + this service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_DEBUG_ADDR: + name: STORAGE_SYSTEM_DEBUG_ADDR + defaultValue: 127.0.0.1:9217 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_DEBUG_PPROF: + name: STORAGE_SYSTEM_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_DEBUG_TOKEN: + name: STORAGE_SYSTEM_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_DEBUG_ZPAGES: + name: STORAGE_SYSTEM_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_DRIVER: + name: STORAGE_SYSTEM_DRIVER + defaultValue: ocis + type: string + description: The driver which should be used by the service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_GRPC_ADDR: + name: STORAGE_SYSTEM_GRPC_ADDR + defaultValue: 127.0.0.1:9215 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_GRPC_PROTOCOL: + name: STORAGE_SYSTEM_GRPC_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the GPRC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_HTTP_ADDR: + name: STORAGE_SYSTEM_HTTP_ADDR + defaultValue: 127.0.0.1:9216 + type: string + description: The bind address of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_HTTP_PROTOCOL: + name: STORAGE_SYSTEM_HTTP_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_JWT_SECRET: + name: OCIS_JWT_SECRET;STORAGE_SYSTEM_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_LOG_COLOR: + name: OCIS_LOG_COLOR;STORAGE_SYSTEM_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_LOG_FILE: + name: OCIS_LOG_FILE;STORAGE_SYSTEM_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_LOG_LEVEL: + name: OCIS_LOG_LEVEL;STORAGE_SYSTEM_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_LOG_PRETTY: + name: OCIS_LOG_PRETTY;STORAGE_SYSTEM_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_OCIS_LOCK_CYCLE_DURATION_FACTOR: + name: STORAGE_SYSTEM_OCIS_LOCK_CYCLE_DURATION_FACTOR + defaultValue: "30" + type: int + description: When trying to lock files, ocis will multiply the cycle with this factor + and use it as a millisecond timeout. Values of 0 or below will be ignored and + the default value of 30 will be used. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_OCIS_MAX_ACQUIRE_LOCK_CYCLES: + name: STORAGE_SYSTEM_OCIS_MAX_ACQUIRE_LOCK_CYCLES + defaultValue: "20" + type: int + description: When trying to lock files, ocis will try this amount of times to acquire + the lock before failing. After each try it will wait for an increasing amount + of time. Values of 0 or below will be ignored and the default value of 20 will + be used. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_OCIS_METADATA_BACKEND: + name: OCIS_DECOMPOSEDFS_METADATA_BACKEND;STORAGE_SYSTEM_OCIS_METADATA_BACKEND + defaultValue: messagepack + type: string + description: The backend to use for storing metadata. Supported values are 'messagepack' + and 'xattrs'. The setting 'messagepack' uses a dedicated file to store file metadata + while 'xattrs' uses extended attributes to store file metadata. Defaults to 'messagepack'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_OCIS_ROOT: + name: STORAGE_SYSTEM_OCIS_ROOT + defaultValue: /var/lib/ocis/storage/metadata + type: string + description: Path for the directory where the STORAGE-SYSTEM service stores it's + persistent data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_SKIP_USER_GROUPS_IN_TOKEN: + name: STORAGE_SYSTEM_SKIP_USER_GROUPS_IN_TOKEN + defaultValue: "false" + type: bool + description: Disables the loading of user's group memberships from the reva access + token. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;STORAGE_SYSTEM_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;STORAGE_SYSTEM_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;STORAGE_SYSTEM_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_SYSTEM_TRACING_TYPE: + name: OCIS_TRACING_TYPE;STORAGE_SYSTEM_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_ASYNC_PROPAGATOR_PROPAGATION_DELAY: + name: STORAGE_USERS_ASYNC_PROPAGATOR_PROPAGATION_DELAY + defaultValue: 0s + type: Duration + description: The delay between a change made to a tree and the propagation start + on treesize and treetime. Multiple propagations are computed to a single one. + See the Environment Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_CLI_MAX_ATTEMPTS_RENAME_FILE: + name: STORAGE_USERS_CLI_MAX_ATTEMPTS_RENAME_FILE + defaultValue: "0" + type: int + description: The maximum number of attempts to rename a file when a user restores + a file to an existing destination with the same name. The minimum value is 100. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_DATA_GATEWAY_URL: + name: STORAGE_USERS_DATA_GATEWAY_URL + defaultValue: https://localhost:9200/data + type: string + description: URL of the data gateway server + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_DATA_SERVER_URL: + name: STORAGE_USERS_DATA_SERVER_URL + defaultValue: http://localhost:9158/data + type: string + description: URL of the data server, needs to be reachable by the data gateway provided + by the frontend service or the user if directly exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_DEBUG_ADDR: + name: STORAGE_USERS_DEBUG_ADDR + defaultValue: 127.0.0.1:9159 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_DEBUG_PPROF: + name: STORAGE_USERS_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_DEBUG_TOKEN: + name: STORAGE_USERS_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_DEBUG_ZPAGES: + name: STORAGE_USERS_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_DRIVER: + name: STORAGE_USERS_DRIVER + defaultValue: ocis + type: string + description: 'The storage driver which should be used by the service. Defaults to + ''ocis'', Supported values are: ''ocis'', ''s3ng'' and ''owncloudsql''. The ''ocis'' + driver stores all data (blob and meta data) in an POSIX compliant volume. The + ''s3ng'' driver stores metadata in a POSIX compliant volume and uploads blobs + to the s3 bucket.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_EVENTS_AUTH_PASSWORD: + name: OCIS_EVENTS_AUTH_PASSWORD;STORAGE_USERS_EVENTS_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_EVENTS_AUTH_USERNAME: + name: OCIS_EVENTS_AUTH_USERNAME;STORAGE_USERS_EVENTS_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_EVENTS_CLUSTER: + name: OCIS_EVENTS_CLUSTER;STORAGE_USERS_EVENTS_CLUSTER + defaultValue: ocis-cluster + type: string + description: The clusterID of the event system. The event system is the message + queuing service. It is used as message broker for the microservice architecture. + Mandatory when using NATS as event system. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_EVENTS_ENABLE_TLS: + name: OCIS_EVENTS_ENABLE_TLS;STORAGE_USERS_EVENTS_ENABLE_TLS + defaultValue: "false" + type: bool + description: Enable TLS for the connection to the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_EVENTS_ENDPOINT: + name: OCIS_EVENTS_ENDPOINT;STORAGE_USERS_EVENTS_ENDPOINT + defaultValue: 127.0.0.1:9233 + type: string + description: The address of the event system. The event system is the message queuing + service. It is used as message broker for the microservice architecture. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_EVENTS_NUM_CONSUMERS: + name: STORAGE_USERS_EVENTS_NUM_CONSUMERS + defaultValue: "0" + type: int + description: The amount of concurrent event consumers to start. Event consumers + are used for post-processing files. Multiple consumers increase parallelisation, + but will also increase CPU and memory demands. The setting has no effect when + the OCIS_ASYNC_UPLOADS is set to false. The default and minimum value is 1. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_EVENTS_TLS_INSECURE: + name: OCIS_INSECURE;STORAGE_USERS_EVENTS_TLS_INSECURE + defaultValue: "false" + type: bool + description: Whether to verify the server TLS certificates. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_EVENTS_TLS_ROOT_CA_CERTIFICATE: + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;STORAGE_USERS_EVENTS_TLS_ROOT_CA_CERTIFICATE + defaultValue: "" + type: string + description: The root CA certificate used to validate the server's TLS certificate. + If provided STORAGE_USERS_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_EXPOSE_DATA_SERVER: + name: STORAGE_USERS_EXPOSE_DATA_SERVER + defaultValue: "false" + type: bool + description: Exposes the data server directly to users and bypasses the data gateway. + Ensure that the data server address is reachable by users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_FILEMETADATA_CACHE_AUTH_PASSWORD: + name: OCIS_CACHE_AUTH_PASSWORD;STORAGE_USERS_FILEMETADATA_CACHE_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the cache store. Only applies when + store type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_FILEMETADATA_CACHE_AUTH_USERNAME: + name: OCIS_CACHE_AUTH_USERNAME;STORAGE_USERS_FILEMETADATA_CACHE_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the cache store. Only applies when + store type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_FILEMETADATA_CACHE_DISABLE_PERSISTENCE: + name: OCIS_CACHE_DISABLE_PERSISTENCE;STORAGE_USERS_FILEMETADATA_CACHE_DISABLE_PERSISTENCE + defaultValue: "false" + type: bool + description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' + is configured. Defaults to false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_FILEMETADATA_CACHE_SIZE: + name: OCIS_CACHE_SIZE;STORAGE_USERS_FILEMETADATA_CACHE_SIZE + defaultValue: "0" + type: int + description: The maximum quantity of items in the user info cache. Only applies + when store type 'ocmem' is configured. Defaults to 512 which is derived from the + ocmem package though not exclicitely set as default. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_FILEMETADATA_CACHE_STORE: + name: OCIS_CACHE_STORE;STORAGE_USERS_FILEMETADATA_CACHE_STORE + defaultValue: memory + type: string + description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', + ''nats-js-kv'', ''noop''. See the text description for details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_FILEMETADATA_CACHE_STORE_NODES: + name: OCIS_CACHE_STORE_NODES;STORAGE_USERS_FILEMETADATA_CACHE_STORE_NODES + defaultValue: '[127.0.0.1:9233]' + type: '[]string' + description: A list of nodes to access the configured store. This has no effect + when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes + are used is dependent on the library of the configured store. See the Environment + Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_FILEMETADATA_CACHE_TTL: + name: OCIS_CACHE_TTL;STORAGE_USERS_FILEMETADATA_CACHE_TTL + defaultValue: 24m0s + type: Duration + description: Default time to live for user info in the user info cache. Only applied + when access tokens has no expiration. See the Environment Variable Types description + for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_GATEWAY_GRPC_ADDR: + name: OCIS_GATEWAY_GRPC_ADDR;STORAGE_USERS_GATEWAY_GRPC_ADDR + defaultValue: 127.0.0.1:9142 + type: string + description: The bind address of the gateway GRPC address. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_GRACEFUL_SHUTDOWN_TIMEOUT: + name: STORAGE_USERS_GRACEFUL_SHUTDOWN_TIMEOUT + defaultValue: "30" + type: int + description: 'The number of seconds to wait for the ''storage-users'' service to + shutdown cleanly before exiting with an error that gets logged. Note: This setting + is only applicable when running the ''storage-users'' service as a standalone + service. See the text description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_GRPC_ADDR: + name: STORAGE_USERS_GRPC_ADDR + defaultValue: 127.0.0.1:9157 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_GRPC_PROTOCOL: + name: STORAGE_USERS_GRPC_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the GPRC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_HTTP_ADDR: + name: STORAGE_USERS_HTTP_ADDR + defaultValue: 127.0.0.1:9158 + type: string + description: The bind address of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_HTTP_PROTOCOL: + name: STORAGE_USERS_HTTP_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_ID_CACHE_AUTH_PASSWORD: + name: OCIS_CACHE_AUTH_PASSWORD;STORAGE_USERS_ID_CACHE_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the cache store. Only applies when + store type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_ID_CACHE_AUTH_USERNAME: + name: OCIS_CACHE_AUTH_USERNAME;STORAGE_USERS_ID_CACHE_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the cache store. Only applies when + store type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_ID_CACHE_DISABLE_PERSISTENCE: + name: OCIS_CACHE_DISABLE_PERSISTENCE;STORAGE_USERS_ID_CACHE_DISABLE_PERSISTENCE + defaultValue: "false" + type: bool + description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' + is configured. Defaults to false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_ID_CACHE_SIZE: + name: OCIS_CACHE_SIZE;STORAGE_USERS_ID_CACHE_SIZE + defaultValue: "0" + type: int + description: The maximum quantity of items in the user info cache. Only applies + when store type 'ocmem' is configured. Defaults to 512 which is derived from the + ocmem package though not exclicitely set as default. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_ID_CACHE_STORE: + name: OCIS_CACHE_STORE;STORAGE_USERS_ID_CACHE_STORE + defaultValue: memory + type: string + description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', + ''nats-js-kv'', ''noop''. See the text description for details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_ID_CACHE_STORE_NODES: + name: OCIS_CACHE_STORE_NODES;STORAGE_USERS_ID_CACHE_STORE_NODES + defaultValue: '[127.0.0.1:9233]' + type: '[]string' + description: A list of nodes to access the configured store. This has no effect + when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes + are used is dependent on the library of the configured store. See the Environment + Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_ID_CACHE_TTL: + name: OCIS_CACHE_TTL;STORAGE_USERS_ID_CACHE_TTL + defaultValue: 24m0s + type: Duration + description: Default time to live for user info in the user info cache. Only applied + when access tokens have no expiration. Defaults to 300s which is derived from + the underlaying package though not explicitly set as default. See the Environment + Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_JWT_SECRET: + name: OCIS_JWT_SECRET;STORAGE_USERS_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_LOG_COLOR: + name: OCIS_LOG_COLOR;STORAGE_USERS_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_LOG_FILE: + name: OCIS_LOG_FILE;STORAGE_USERS_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_LOG_LEVEL: + name: OCIS_LOG_LEVEL;STORAGE_USERS_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_LOG_PRETTY: + name: OCIS_LOG_PRETTY;STORAGE_USERS_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_MOUNT_ID: + name: STORAGE_USERS_MOUNT_ID + defaultValue: "" + type: string + description: Mount ID of this storage. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OCIS_GENERAL_SPACE_ALIAS_TEMPLATE: + name: STORAGE_USERS_OCIS_GENERAL_SPACE_ALIAS_TEMPLATE + defaultValue: '{{.SpaceType}}/{{.SpaceName \| replace " " "-" \| + lower}}' + type: string + description: Template string to construct general space aliases. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OCIS_LOCK_CYCLE_DURATION_FACTOR: + name: STORAGE_USERS_OCIS_LOCK_CYCLE_DURATION_FACTOR + defaultValue: "30" + type: int + description: When trying to lock files, ocis will multiply the cycle with this factor + and use it as a millisecond timeout. Values of 0 or below will be ignored and + the default value of 30 will be used. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OCIS_MAX_ACQUIRE_LOCK_CYCLES: + name: STORAGE_USERS_OCIS_MAX_ACQUIRE_LOCK_CYCLES + defaultValue: "20" + type: int + description: When trying to lock files, ocis will try this amount of times to acquire + the lock before failing. After each try it will wait for an increasing amount + of time. Values of 0 or below will be ignored and the default value of 20 will + be used. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OCIS_MAX_CONCURRENCY: + name: STORAGE_USERS_OCIS_MAX_CONCURRENCY + defaultValue: "5" + type: int + description: Maximum number of concurrent go-routines. Higher values can potentially + get work done faster but will also cause more load on the system. Values of 0 + or below will be ignored and the default value of 100 will be used. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OCIS_MAX_QUOTA: + name: OCIS_SPACES_MAX_QUOTA;STORAGE_USERS_OCIS_MAX_QUOTA + defaultValue: "0" + type: uint64 + description: Set a global max quota for spaces in bytes. A value of 0 equals unlimited. + If not using the global OCIS_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA + in the frontend service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OCIS_METADATA_BACKEND: + name: OCIS_DECOMPOSEDFS_METADATA_BACKEND;STORAGE_USERS_OCIS_METADATA_BACKEND + defaultValue: messagepack + type: string + description: The backend to use for storing metadata. Supported values are 'messagepack' + and 'xattrs'. The setting 'messagepack' uses a dedicated file to store file metadata + while 'xattrs' uses extended attributes to store file metadata. Defaults to 'messagepack'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OCIS_PERMISSIONS_ENDPOINT: + name: STORAGE_USERS_PERMISSION_ENDPOINT;STORAGE_USERS_OCIS_PERMISSIONS_ENDPOINT + defaultValue: com.owncloud.api.settings + type: string + description: Endpoint of the permissions service. The endpoints can differ for 'ocis' + and 's3ng'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OCIS_PERSONAL_SPACE_ALIAS_TEMPLATE: + name: STORAGE_USERS_OCIS_PERSONAL_SPACE_ALIAS_TEMPLATE + defaultValue: '{{.SpaceType}}/{{.User.Username \| lower}}' + type: string + description: Template string to construct personal space aliases. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OCIS_PROPAGATOR: + name: OCIS_DECOMPOSEDFS_PROPAGATOR;STORAGE_USERS_OCIS_PROPAGATOR + defaultValue: sync + type: string + description: The propagator used for decomposedfs. At the moment, only 'sync' is + fully supported, 'async' is available as an experimental option. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OCIS_ROOT: + name: STORAGE_USERS_OCIS_ROOT + defaultValue: /var/lib/ocis/storage/users + type: string + description: The directory where the filesystem storage will store blobs and metadata. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OCIS_SHARE_FOLDER: + name: STORAGE_USERS_OCIS_SHARE_FOLDER + defaultValue: /Shares + type: string + description: Name of the folder jailing all shares. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OCIS_USER_LAYOUT: + name: STORAGE_USERS_OCIS_USER_LAYOUT + defaultValue: '{{.Id.OpaqueId}}' + type: string + description: Template string for the user storage layout in the user directory. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OWNCLOUDSQL_DATADIR: + name: STORAGE_USERS_OWNCLOUDSQL_DATADIR + defaultValue: /var/lib/ocis/storage/owncloud + type: string + description: The directory where the filesystem storage will store SQL migration + data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/owncloud. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OWNCLOUDSQL_DB_HOST: + name: STORAGE_USERS_OWNCLOUDSQL_DB_HOST + defaultValue: "" + type: string + description: Hostname or IP of the database server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OWNCLOUDSQL_DB_NAME: + name: STORAGE_USERS_OWNCLOUDSQL_DB_NAME + defaultValue: owncloud + type: string + description: Name of the database to be used. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD: + name: STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD + defaultValue: owncloud + type: string + description: Password for the database. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OWNCLOUDSQL_DB_PORT: + name: STORAGE_USERS_OWNCLOUDSQL_DB_PORT + defaultValue: "3306" + type: int + description: Port that the database server is listening on. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME: + name: STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME + defaultValue: owncloud + type: string + description: Username for the database. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OWNCLOUDSQL_LAYOUT: + name: STORAGE_USERS_OWNCLOUDSQL_LAYOUT + defaultValue: '{{.Username}}' + type: string + description: Path layout to use to navigate into a users folder in an owncloud data + directory + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER: + name: STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER + defaultValue: /Shares + type: string + description: Name of the folder jailing all shares. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR: + name: STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR + defaultValue: /var/lib/ocis/storage/uploadinfo + type: string + description: The directory where the filesystem will store uploads temporarily. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/uploadinfo. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT: + name: STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT + defaultValue: com.owncloud.api.users + type: string + description: Endpoint of the users provider. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_PERMISSION_ENDPOINT: + name: STORAGE_USERS_PERMISSION_ENDPOINT;STORAGE_USERS_S3NG_PERMISSIONS_ENDPOINT + defaultValue: com.owncloud.api.settings + type: string + description: Endpoint of the permissions service. The endpoints can differ for 'ocis' + and 's3ng'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_PURGE_TRASH_BIN_PERSONAL_DELETE_BEFORE: + name: STORAGE_USERS_PURGE_TRASH_BIN_PERSONAL_DELETE_BEFORE + defaultValue: 720h0m0s + type: Duration + description: Specifies the period of time in which items that have been in the personal + trash-bin for longer than this value should be deleted. A value of 0 means no + automatic deletion. See the Environment Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_PURGE_TRASH_BIN_PROJECT_DELETE_BEFORE: + name: STORAGE_USERS_PURGE_TRASH_BIN_PROJECT_DELETE_BEFORE + defaultValue: 720h0m0s + type: Duration + description: Specifies the period of time in which items that have been in the project + trash-bin for longer than this value should be deleted. A value of 0 means no + automatic deletion. See the Environment Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_PURGE_TRASH_BIN_USER_ID: + name: OCIS_ADMIN_USER_ID;STORAGE_USERS_PURGE_TRASH_BIN_USER_ID + defaultValue: "" + type: string + description: ID of the user who collects all necessary information for deletion. + Consider that the UUID can be encoded in some LDAP deployment configurations like + in .ldif files. These need to be decoded beforehand. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_READ_ONLY: + name: STORAGE_USERS_READ_ONLY + defaultValue: "false" + type: bool + description: Set this storage to be read-only. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_ACCESS_KEY: + name: STORAGE_USERS_S3NG_ACCESS_KEY + defaultValue: "" + type: string + description: Access key for the S3 bucket. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_BUCKET: + name: STORAGE_USERS_S3NG_BUCKET + defaultValue: "" + type: string + description: Name of the S3 bucket. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_ENDPOINT: + name: STORAGE_USERS_S3NG_ENDPOINT + defaultValue: "" + type: string + description: Endpoint for the S3 bucket. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_GENERAL_SPACE_ALIAS_TEMPLATE: + name: STORAGE_USERS_S3NG_GENERAL_SPACE_ALIAS_TEMPLATE + defaultValue: '{{.SpaceType}}/{{.SpaceName \| replace " " "-" \| + lower}}' + type: string + description: Template string to construct general space aliases. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_LOCK_CYCLE_DURATION_FACTOR: + name: STORAGE_USERS_S3NG_LOCK_CYCLE_DURATION_FACTOR + defaultValue: "30" + type: int + description: When trying to lock files, ocis will multiply the cycle with this factor + and use it as a millisecond timeout. Values of 0 or below will be ignored and + the default value of 30 will be used. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_MAX_ACQUIRE_LOCK_CYCLES: + name: STORAGE_USERS_S3NG_MAX_ACQUIRE_LOCK_CYCLES + defaultValue: "20" + type: int + description: When trying to lock files, ocis will try this amount of times to acquire + the lock before failing. After each try it will wait for an increasing amount + of time. Values of 0 or below will be ignored and the default value of 20 will + be used. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_MAX_CONCURRENCY: + name: STORAGE_USERS_S3NG_MAX_CONCURRENCY + defaultValue: "5" + type: int + description: Maximum number of concurrent go-routines. Higher values can potentially + get work done faster but will also cause more load on the system. Values of 0 + or below will be ignored and the default value of 100 will be used. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_METADATA_BACKEND: + name: STORAGE_USERS_S3NG_METADATA_BACKEND + defaultValue: messagepack + type: string + description: The backend to use for storing metadata. Supported values are 'xattrs' + and 'messagepack'. The setting 'xattrs' uses extended attributes to store file + metadata while 'messagepack' uses a dedicated file to store file metadata. Defaults + to 'xattrs'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_PERMISSIONS_ENDPOINT: + name: STORAGE_USERS_PERMISSION_ENDPOINT;STORAGE_USERS_S3NG_PERMISSIONS_ENDPOINT + defaultValue: com.owncloud.api.settings + type: string + description: Endpoint of the permissions service. The endpoints can differ for 'ocis' + and 's3ng'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_PERSONAL_SPACE_ALIAS_TEMPLATE: + name: STORAGE_USERS_S3NG_PERSONAL_SPACE_ALIAS_TEMPLATE + defaultValue: '{{.SpaceType}}/{{.User.Username \| lower}}' + type: string + description: Template string to construct personal space aliases. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_PROPAGATOR: + name: OCIS_DECOMPOSEDFS_PROPAGATOR;STORAGE_USERS_S3NG_PROPAGATOR + defaultValue: sync + type: string + description: The propagator used for decomposedfs. At the moment, only 'sync' is + fully supported, 'async' is available as an experimental option. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_REGION: + name: STORAGE_USERS_S3NG_REGION + defaultValue: default + type: string + description: Region of the S3 bucket. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_ROOT: + name: STORAGE_USERS_S3NG_ROOT + defaultValue: /var/lib/ocis/storage/users + type: string + description: The directory where the filesystem storage will store metadata for + blobs. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_SECRET_KEY: + name: STORAGE_USERS_S3NG_SECRET_KEY + defaultValue: "" + type: string + description: Secret key for the S3 bucket. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_SHARE_FOLDER: + name: STORAGE_USERS_S3NG_SHARE_FOLDER + defaultValue: /Shares + type: string + description: Name of the folder jailing all shares. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_USER_LAYOUT: + name: STORAGE_USERS_S3NG_USER_LAYOUT + defaultValue: '{{.Id.OpaqueId}}' + type: string + description: Template string for the user storage layout in the user directory. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_SERVICE_ACCOUNT_ID: + name: OCIS_SERVICE_ACCOUNT_ID;STORAGE_USERS_SERVICE_ACCOUNT_ID + defaultValue: "" + type: string + description: The ID of the service account the service should use. See the 'auth-service' + service description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_SERVICE_ACCOUNT_SECRET: + name: OCIS_SERVICE_ACCOUNT_SECRET;STORAGE_USERS_SERVICE_ACCOUNT_SECRET + defaultValue: "" + type: string + description: The service account secret. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_SKIP_USER_GROUPS_IN_TOKEN: + name: STORAGE_USERS_SKIP_USER_GROUPS_IN_TOKEN + defaultValue: "false" + type: bool + description: Disables the loading of user's group memberships from the reva access + token. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;STORAGE_USERS_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;STORAGE_USERS_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;STORAGE_USERS_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_TRACING_TYPE: + name: OCIS_TRACING_TYPE;STORAGE_USERS_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_TRANSFER_EXPIRES: + name: STORAGE_USERS_TRANSFER_EXPIRES + defaultValue: "86400" + type: int64 + description: the time after which the token for upload postprocessing expires + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_UPLOAD_EXPIRATION: + name: STORAGE_USERS_UPLOAD_EXPIRATION + defaultValue: "86400" + type: int64 + description: Duration in seconds after which uploads will expire. Note that when + setting this to a low number, uploads could be cancelled before they are finished + and return a 403 to the user. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORE_DATA_PATH: + name: STORE_DATA_PATH + defaultValue: /var/lib/ocis/store + type: string + description: The directory where the filesystem storage will store ocis settings. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/store. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORE_DEBUG_ADDR: + name: STORE_DEBUG_ADDR + defaultValue: 127.0.0.1:9464 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORE_DEBUG_PPROF: + name: STORE_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORE_DEBUG_TOKEN: + name: STORE_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORE_DEBUG_ZPAGES: + name: STORE_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORE_GRPC_ADDR: + name: STORE_GRPC_ADDR + defaultValue: 127.0.0.1:9460 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORE_LOG_COLOR: + name: OCIS_LOG_COLOR;STORE_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORE_LOG_FILE: + name: OCIS_LOG_FILE;STORE_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORE_LOG_LEVEL: + name: OCIS_LOG_LEVEL;STORE_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORE_LOG_PRETTY: + name: OCIS_LOG_PRETTY;STORE_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORE_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;STORE_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORE_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;STORE_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORE_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;STORE_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORE_TRACING_TYPE: + name: OCIS_TRACING_TYPE;STORE_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_CS3SOURCE_INSECURE: + name: OCIS_INSECURE;THUMBNAILS_CS3SOURCE_INSECURE + defaultValue: "false" + type: bool + description: Ignore untrusted SSL certificates when connecting to the CS3 source. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_DATA_ENDPOINT: + name: THUMBNAILS_DATA_ENDPOINT + defaultValue: http://127.0.0.1:9186/thumbnails/data + type: string + description: The HTTP endpoint where the actual thumbnail file can be downloaded. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_DEBUG_ADDR: + name: THUMBNAILS_DEBUG_ADDR + defaultValue: 127.0.0.1:9189 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_DEBUG_PPROF: + name: THUMBNAILS_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_DEBUG_TOKEN: + name: THUMBNAILS_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_DEBUG_ZPAGES: + name: THUMBNAILS_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_FILESYSTEMSTORAGE_ROOT: + name: THUMBNAILS_FILESYSTEMSTORAGE_ROOT + defaultValue: /var/lib/ocis/thumbnails + type: string + description: The directory where the filesystem storage will store the thumbnails. + If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/thumbnails. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_GRPC_ADDR: + name: THUMBNAILS_GRPC_ADDR + defaultValue: 127.0.0.1:9185 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_HTTP_ADDR: + name: THUMBNAILS_HTTP_ADDR + defaultValue: 127.0.0.1:9186 + type: string + description: The bind address of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_HTTP_ROOT: + name: THUMBNAILS_HTTP_ROOT + defaultValue: /thumbnails + type: string + description: Subdirectory that serves as the root for this HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_LOG_COLOR: + name: OCIS_LOG_COLOR;THUMBNAILS_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_LOG_FILE: + name: OCIS_LOG_FILE;THUMBNAILS_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_LOG_LEVEL: + name: OCIS_LOG_LEVEL;THUMBNAILS_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_LOG_PRETTY: + name: OCIS_LOG_PRETTY;THUMBNAILS_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_RESOLUTIONS: + name: THUMBNAILS_RESOLUTIONS + defaultValue: '[16x16 32x32 64x64 128x128 1080x1920 1920x1080 2160x3840 3840x2160 + 4320x7680 7680x4320]' + type: '[]string' + description: The supported list of target resolutions in the format WidthxHeight + like 32x32. You can define any resolution as required. See the Environment Variable + Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;THUMBNAILS_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;THUMBNAILS_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;THUMBNAILS_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_TRACING_TYPE: + name: OCIS_TRACING_TYPE;THUMBNAILS_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_TRANSFER_TOKEN: + name: THUMBNAILS_TRANSFER_TOKEN + defaultValue: "" + type: string + description: The secret to sign JWT to download the actual thumbnail file. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_TXT_FONTMAP_FILE: + name: THUMBNAILS_TXT_FONTMAP_FILE + defaultValue: "" + type: string + description: The path to a font file for txt thumbnails. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +THUMBNAILS_WEBDAVSOURCE_INSECURE: + name: OCIS_INSECURE;THUMBNAILS_WEBDAVSOURCE_INSECURE + defaultValue: "false" + type: bool + description: Ignore untrusted SSL certificates when connecting to the webdav source. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_CORS_ALLOW_CREDENTIALS: + name: OCIS_CORS_ALLOW_CREDENTIALS;USERLOG_CORS_ALLOW_CREDENTIALS + defaultValue: "true" + type: bool + description: 'Allow credentials for CORS.See following chapter for more details: + *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_CORS_ALLOW_HEADERS: + name: OCIS_CORS_ALLOW_HEADERS;USERLOG_CORS_ALLOW_HEADERS + defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id + Ocs-Apirequest]' + type: '[]string' + description: 'A list of allowed CORS headers. See following chapter for more details: + *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_CORS_ALLOW_METHODS: + name: OCIS_CORS_ALLOW_METHODS;USERLOG_CORS_ALLOW_METHODS + defaultValue: '[GET]' + type: '[]string' + description: 'A list of allowed CORS methods. See following chapter for more details: + *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_CORS_ALLOW_ORIGINS: + name: OCIS_CORS_ALLOW_ORIGINS;USERLOG_CORS_ALLOW_ORIGINS + defaultValue: '[*]' + type: '[]string' + description: 'A list of allowed CORS origins. See following chapter for more details: + *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_DEBUG_ADDR: + name: USERLOG_DEBUG_ADDR + defaultValue: 127.0.0.1:9210 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_DEBUG_PPROF: + name: USERLOG_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_DEBUG_TOKEN: + name: USERLOG_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_DEBUG_ZPAGES: + name: USERLOG_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_EVENTS_AUTH_PASSWORD: + name: OCIS_EVENTS_AUTH_PASSWORD;USERLOG_EVENTS_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_EVENTS_AUTH_USERNAME: + name: OCIS_EVENTS_AUTH_USERNAME;USERLOG_EVENTS_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_EVENTS_CLUSTER: + name: OCIS_EVENTS_CLUSTER;USERLOG_EVENTS_CLUSTER + defaultValue: ocis-cluster + type: string + description: The clusterID of the event system. The event system is the message + queuing service. It is used as message broker for the microservice architecture. + Mandatory when using NATS as event system. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_EVENTS_ENABLE_TLS: + name: OCIS_EVENTS_ENABLE_TLS;USERLOG_EVENTS_ENABLE_TLS + defaultValue: "false" + type: bool + description: Enable TLS for the connection to the events broker. The events broker + is the ocis service which receives and delivers events between the services. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_EVENTS_ENDPOINT: + name: OCIS_EVENTS_ENDPOINT;USERLOG_EVENTS_ENDPOINT + defaultValue: 127.0.0.1:9233 + type: string + description: The address of the event system. The event system is the message queuing + service. It is used as message broker for the microservice architecture. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_EVENTS_TLS_INSECURE: + name: OCIS_INSECURE;USERLOG_EVENTS_TLS_INSECURE + defaultValue: "false" + type: bool + description: Whether to verify the server TLS certificates. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE: + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;USERLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE + defaultValue: "" + type: string + description: The root CA certificate used to validate the server's TLS certificate. + If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_GLOBAL_NOTIFICATIONS_SECRET: + name: USERLOG_GLOBAL_NOTIFICATIONS_SECRET + defaultValue: "" + type: string + description: The secret to secure the global notifications endpoint. Only system + admins and users knowing that secret can call the global notifications POST/DELETE + endpoints. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_HTTP_ADDR: + name: USERLOG_HTTP_ADDR + defaultValue: 127.0.0.1:0 + type: string + description: The bind address of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_HTTP_ROOT: + name: USERLOG_HTTP_ROOT + defaultValue: / + type: string + description: Subdirectory that serves as the root for this HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_JWT_SECRET: + name: OCIS_JWT_SECRET;USERLOG_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_LOG_COLOR: + name: OCIS_LOG_COLOR;USERLOG_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_LOG_FILE: + name: OCIS_LOG_FILE;USERLOG_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_LOG_LEVEL: + name: OCIS_LOG_LEVEL;USERLOG_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_LOG_PRETTY: + name: OCIS_LOG_PRETTY;USERLOG_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_SERVICE_ACCOUNT_ID: + name: OCIS_SERVICE_ACCOUNT_ID;USERLOG_SERVICE_ACCOUNT_ID + defaultValue: "" + type: string + description: The ID of the service account the service should use. See the 'auth-service' + service description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_SERVICE_ACCOUNT_SECRET: + name: OCIS_SERVICE_ACCOUNT_SECRET;USERLOG_SERVICE_ACCOUNT_SECRET + defaultValue: "" + type: string + description: The service account secret. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_STORE: + name: OCIS_PERSISTENT_STORE;USERLOG_STORE + defaultValue: memory + type: string + description: 'The type of the store. Supported values are: ''memory'', ''ocmem'', + ''etcd'', ''redis'', ''redis-sentinel'', ''nats-js'', ''noop''. See the text description + for details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_STORE_AUTH_PASSWORD: + name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;USERLOG_STORE_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the store. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_STORE_AUTH_USERNAME: + name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;USERLOG_STORE_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the store. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_STORE_DATABASE: + name: USERLOG_STORE_DATABASE + defaultValue: userlog + type: string + description: The database name the configured store should use. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_STORE_NODES: + name: OCIS_PERSISTENT_STORE_NODES;USERLOG_STORE_NODES + defaultValue: '[]' + type: '[]string' + description: A list of nodes to access the configured store. This has no effect + when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes + are used is dependent on the library of the configured store. See the Environment + Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_STORE_SIZE: + name: OCIS_PERSISTENT_STORE_SIZE;USERLOG_STORE_SIZE + defaultValue: "0" + type: int + description: The maximum quantity of items in the store. Only applies when store + type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package + though not exclicitely set as default. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_STORE_TABLE: + name: USERLOG_STORE_TABLE + defaultValue: events + type: string + description: The database table the store should use. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_STORE_TTL: + name: OCIS_PERSISTENT_STORE_TTL;USERLOG_STORE_TTL + defaultValue: 336h0m0s + type: Duration + description: Time to live for events in the store. Defaults to '336h' (2 weeks). + See the Environment Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;USERLOG_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;USERLOG_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;USERLOG_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_TRACING_TYPE: + name: OCIS_TRACING_TYPE;USERLOG_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERLOG_TRANSLATION_PATH: + name: OCIS_TRANSLATION_PATH;USERLOG_TRANSLATION_PATH + defaultValue: "" + type: string + description: (optional) Set this to a path with custom translations to overwrite + the builtin translations. Note that file and folder naming rules apply, see the + documentation for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_DEBUG_ADDR: + name: USERS_DEBUG_ADDR + defaultValue: 127.0.0.1:9145 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_DEBUG_PPROF: + name: USERS_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_DEBUG_TOKEN: + name: USERS_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_DEBUG_ZPAGES: + name: USERS_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_DRIVER: + name: USERS_DRIVER + defaultValue: ldap + type: string + description: The driver which should be used by the users service. Supported values + are 'ldap' and 'owncloudsql'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_GRPC_ADDR: + name: USERS_GRPC_ADDR + defaultValue: 127.0.0.1:9144 + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_GRPC_PROTOCOL: + name: USERS_GRPC_PROTOCOL + defaultValue: tcp + type: string + description: The transport protocol of the GPRC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_IDP_URL: + name: OCIS_URL;OCIS_OIDC_ISSUER;USERS_IDP_URL + defaultValue: https://localhost:9200 + type: string + description: The identity provider value to set in the userids of the CS3 user objects + for users returned by this user provider. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_JWT_SECRET: + name: OCIS_JWT_SECRET;USERS_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_BIND_DN: + name: OCIS_LDAP_BIND_DN;USERS_LDAP_BIND_DN + defaultValue: uid=reva,ou=sysusers,o=libregraph-idm + type: string + description: LDAP DN to use for simple bind authentication with the target LDAP + server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_BIND_PASSWORD: + name: OCIS_LDAP_BIND_PASSWORD;USERS_LDAP_BIND_PASSWORD + defaultValue: "" + type: string + description: Password to use for authenticating the 'bind_dn'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_CACERT: + name: OCIS_LDAP_CACERT;USERS_LDAP_CACERT + defaultValue: /var/lib/ocis/idm/ldap.crt + type: string + description: Path/File name for the root CA certificate (in PEM format) used to + validate TLS server certificates of the LDAP service. If not defined, the root + directory derives from $OCIS_BASE_DATA_PATH:/idm. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_DISABLE_USER_MECHANISM: + name: OCIS_LDAP_DISABLE_USER_MECHANISM;USERS_LDAP_DISABLE_USER_MECHANISM + defaultValue: attribute + type: string + description: An option to control the behavior for disabling users. Valid options + are 'none', 'attribute' and 'group'. If set to 'group', disabling a user via API + will add the user to the configured group for disabled users, if set to 'attribute' + this will be done in the ldap user entry, if set to 'none' the disable request + is not processed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_DISABLED_USERS_GROUP_DN: + name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;USERS_LDAP_DISABLED_USERS_GROUP_DN + defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm + type: string + description: The distinguished name of the group to which added users will be classified + as disabled when 'disable_user_mechanism' is set to 'group'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_GROUP_BASE_DN: + name: OCIS_LDAP_GROUP_BASE_DN;USERS_LDAP_GROUP_BASE_DN + defaultValue: ou=groups,o=libregraph-idm + type: string + description: Search base DN for looking up LDAP groups. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_GROUP_FILTER: + name: OCIS_LDAP_GROUP_FILTER;USERS_LDAP_GROUP_FILTER + defaultValue: "" + type: string + description: LDAP filter to add to the default filters for group searches. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_GROUP_OBJECTCLASS: + name: OCIS_LDAP_GROUP_OBJECTCLASS;USERS_LDAP_GROUP_OBJECTCLASS + defaultValue: groupOfNames + type: string + description: The object class to use for groups in the default group search filter + like 'groupOfNames'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_GROUP_SCHEMA_DISPLAYNAME: + name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;USERS_LDAP_GROUP_SCHEMA_DISPLAYNAME + defaultValue: cn + type: string + description: LDAP Attribute to use for the displayname of groups (often the same + as groupname attribute). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_GROUP_SCHEMA_GROUPNAME: + name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;USERS_LDAP_GROUP_SCHEMA_GROUPNAME + defaultValue: cn + type: string + description: LDAP Attribute to use for the name of groups. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_GROUP_SCHEMA_ID: + name: OCIS_LDAP_GROUP_SCHEMA_ID;USERS_LDAP_GROUP_SCHEMA_ID + defaultValue: ownclouduuid + type: string + description: LDAP Attribute to use as the unique ID for groups. This should be a + stable globally unique ID like a UUID. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING: + name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;USERS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING + defaultValue: "false" + type: bool + description: Set this to true if the defined 'id' attribute for groups is of the + 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute + of Active Directory for the group ID's. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_GROUP_SCHEMA_MAIL: + name: OCIS_LDAP_GROUP_SCHEMA_MAIL;USERS_LDAP_GROUP_SCHEMA_MAIL + defaultValue: mail + type: string + description: LDAP Attribute to use for the email address of groups (can be empty). + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_GROUP_SCHEMA_MEMBER: + name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;USERS_LDAP_GROUP_SCHEMA_MEMBER + defaultValue: member + type: string + description: LDAP Attribute that is used for group members. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_GROUP_SCOPE: + name: OCIS_LDAP_GROUP_SCOPE;USERS_LDAP_GROUP_SCOPE + defaultValue: sub + type: string + description: LDAP search scope to use when looking up groups. Supported values are + 'base', 'one' and 'sub'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_INSECURE: + name: OCIS_LDAP_INSECURE;USERS_LDAP_INSECURE + defaultValue: "false" + type: bool + description: Disable TLS certificate validation for the LDAP connections. Do not + set this in production environments. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_URI: + name: OCIS_LDAP_URI;USERS_LDAP_URI + defaultValue: ldaps://localhost:9235 + type: string + description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' + and 'ldap://' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_USER_BASE_DN: + name: OCIS_LDAP_USER_BASE_DN;USERS_LDAP_USER_BASE_DN + defaultValue: ou=users,o=libregraph-idm + type: string + description: Search base DN for looking up LDAP users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_USER_ENABLED_ATTRIBUTE: + name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;USERS_LDAP_USER_ENABLED_ATTRIBUTE + defaultValue: ownCloudUserEnabled + type: string + description: LDAP attribute to use as a flag telling if the user is enabled or disabled. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_USER_FILTER: + name: OCIS_LDAP_USER_FILTER;USERS_LDAP_USER_FILTER + defaultValue: "" + type: string + description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_USER_OBJECTCLASS: + name: OCIS_LDAP_USER_OBJECTCLASS;USERS_LDAP_USER_OBJECTCLASS + defaultValue: inetOrgPerson + type: string + description: The object class to use for users in the default user search filter + like 'inetOrgPerson'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_USER_SCHEMA_DISPLAYNAME: + name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;USERS_LDAP_USER_SCHEMA_DISPLAYNAME + defaultValue: displayname + type: string + description: LDAP Attribute to use for the displayname of users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_USER_SCHEMA_ID: + name: OCIS_LDAP_USER_SCHEMA_ID;USERS_LDAP_USER_SCHEMA_ID + defaultValue: ownclouduuid + type: string + description: LDAP Attribute to use as the unique ID for users. This should be a + stable globally unique ID like a UUID. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING: + name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;USERS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING + defaultValue: "false" + type: bool + description: Set this to true if the defined 'ID' attribute for users is of the + 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute + of Active Directory for the user ID's. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_USER_SCHEMA_MAIL: + name: OCIS_LDAP_USER_SCHEMA_MAIL;USERS_LDAP_USER_SCHEMA_MAIL + defaultValue: mail + type: string + description: LDAP Attribute to use for the email address of users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_USER_SCHEMA_USERNAME: + name: OCIS_LDAP_USER_SCHEMA_USERNAME;USERS_LDAP_USER_SCHEMA_USERNAME + defaultValue: uid + type: string + description: LDAP Attribute to use for username of users. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_USER_SCOPE: + name: OCIS_LDAP_USER_SCOPE;USERS_LDAP_USER_SCOPE + defaultValue: sub + type: string + description: LDAP search scope to use when looking up users. Supported values are + 'base', 'one' and 'sub'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_USER_SUBSTRING_FILTER_TYPE: + name: LDAP_USER_SUBSTRING_FILTER_TYPE;USERS_LDAP_USER_SUBSTRING_FILTER_TYPE + defaultValue: any + type: string + description: 'Type of substring search filter to use for substring searches for + users. Possible values: ''initial'' for doing prefix only searches, ''final'' + for doing suffix only searches or ''any'' for doing full substring searches' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LDAP_USER_TYPE_ATTRIBUTE: + name: OCIS_LDAP_USER_SCHEMA_USER_TYPE;USERS_LDAP_USER_TYPE_ATTRIBUTE + defaultValue: ownCloudUserType + type: string + description: LDAP Attribute to distinguish between 'Member' and 'Guest' users. Default + is 'ownCloudUserType'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LOG_COLOR: + name: OCIS_LOG_COLOR;USERS_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LOG_FILE: + name: OCIS_LOG_FILE;USERS_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LOG_LEVEL: + name: OCIS_LOG_LEVEL;USERS_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_LOG_PRETTY: + name: OCIS_LOG_PRETTY;USERS_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_OWNCLOUDSQL_DB_HOST: + name: USERS_OWNCLOUDSQL_DB_HOST + defaultValue: mysql + type: string + description: Hostname of the database server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_OWNCLOUDSQL_DB_NAME: + name: USERS_OWNCLOUDSQL_DB_NAME + defaultValue: owncloud + type: string + description: Name of the owncloud database. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_OWNCLOUDSQL_DB_PASSWORD: + name: USERS_OWNCLOUDSQL_DB_PASSWORD + defaultValue: secret + type: string + description: Password for the database user. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_OWNCLOUDSQL_DB_PORT: + name: USERS_OWNCLOUDSQL_DB_PORT + defaultValue: "3306" + type: int + description: Network port to use for the database connection. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_OWNCLOUDSQL_DB_USERNAME: + name: USERS_OWNCLOUDSQL_DB_USERNAME + defaultValue: owncloud + type: string + description: Database user to use for authenticating with the owncloud database. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH: + name: USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH + defaultValue: "false" + type: bool + description: Allow 'medial search' when searching for users instead of just doing + a prefix search. This allows finding 'Alice' when searching for 'lic'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_OWNCLOUDSQL_IDP: + name: USERS_OWNCLOUDSQL_IDP + defaultValue: https://localhost:9200 + type: string + description: The identity provider value to set in the userids of the CS3 user objects + for users returned by this user provider. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID: + name: USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID + defaultValue: "false" + type: bool + description: Join the user properties table to read user IDs. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_OWNCLOUDSQL_JOIN_USERNAME: + name: USERS_OWNCLOUDSQL_JOIN_USERNAME + defaultValue: "false" + type: bool + description: Join the user properties table to read usernames + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_OWNCLOUDSQL_NOBODY: + name: USERS_OWNCLOUDSQL_NOBODY + defaultValue: "90" + type: int64 + description: Fallback number if no numeric UID and GID properties are provided. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_SKIP_USER_GROUPS_IN_TOKEN: + name: USERS_SKIP_USER_GROUPS_IN_TOKEN + defaultValue: "false" + type: bool + description: Disables the loading of user's group memberships from the reva access + token. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;USERS_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;USERS_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;USERS_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +USERS_TRACING_TYPE: + name: OCIS_TRACING_TYPE;USERS_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_ASSET_PATH: + name: WEB_ASSET_PATH + defaultValue: /var/lib/ocis/web/assets + type: string + description: Serve ownCloud Web assets from a path on the filesystem instead of + the builtin assets. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_CACHE_TTL: + name: WEB_CACHE_TTL + defaultValue: "604800" + type: int + description: Cache policy in seconds for ownCloud Web assets. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_CORS_ALLOW_CREDENTIALS: + name: OCIS_CORS_ALLOW_CREDENTIALS;WEB_CORS_ALLOW_CREDENTIALS + defaultValue: "true" + type: bool + description: 'Allow credentials for CORS. See following chapter for more details: + *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_CORS_ALLOW_HEADERS: + name: OCIS_CORS_ALLOW_HEADERS;WEB_CORS_ALLOW_HEADERS + defaultValue: '[Origin Accept Content-Type Depth Authorization Ocs-Apirequest If-None-Match + If-Match Destination Overwrite X-Request-Id X-Requested-With Tus-Resumable Tus-Checksum-Algorithm + Upload-Concat Upload-Length Upload-Metadata Upload-Defer-Length Upload-Expires + Upload-Checksum Upload-Offset X-HTTP-Method-Override]' + type: '[]string' + description: 'A list of allowed CORS headers. See following chapter for more details: + *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_CORS_ALLOW_METHODS: + name: OCIS_CORS_ALLOW_METHODS;WEB_CORS_ALLOW_METHODS + defaultValue: '[OPTIONS HEAD GET PUT PATCH POST DELETE MKCOL PROPFIND PROPPATCH + MOVE COPY REPORT SEARCH]' + type: '[]string' + description: 'A list of allowed CORS methods. See following chapter for more details: + *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_CORS_ALLOW_ORIGINS: + name: OCIS_CORS_ALLOW_ORIGINS;WEB_CORS_ALLOW_ORIGINS + defaultValue: '[*]' + type: '[]string' + description: 'A list of allowed CORS origins. See following chapter for more details: + *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_DEBUG_ADDR: + name: WEB_DEBUG_ADDR + defaultValue: 127.0.0.1:9104 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_DEBUG_PPROF: + name: WEB_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_DEBUG_TOKEN: + name: WEB_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_DEBUG_ZPAGES: + name: WEB_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_GATEWAY_GRPC_ADDR: + name: WEB_GATEWAY_GRPC_ADDR + defaultValue: com.owncloud.api.gateway + type: string + description: The bind address of the GRPC service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_HTTP_ADDR: + name: WEB_HTTP_ADDR + defaultValue: 127.0.0.1:9100 + type: string + description: The bind address of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_HTTP_ROOT: + name: WEB_HTTP_ROOT + defaultValue: / + type: string + description: Subdirectory that serves as the root for this HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_JWT_SECRET: + name: OCIS_JWT_SECRET;WEB_JWT_SECRET + defaultValue: "" + type: string + description: The secret to mint and validate jwt tokens. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_LOG_COLOR: + name: OCIS_LOG_COLOR;WEB_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_LOG_FILE: + name: OCIS_LOG_FILE;WEB_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_LOG_LEVEL: + name: OCIS_LOG_LEVEL;WEB_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_LOG_PRETTY: + name: OCIS_LOG_PRETTY;WEB_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OIDC_AUTHORITY: + name: OCIS_URL;OCIS_OIDC_ISSUER;WEB_OIDC_AUTHORITY + defaultValue: https://localhost:9200 + type: string + description: URL of the OIDC issuer. It defaults to URL of the builtin IDP. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OIDC_CLIENT_ID: + name: OCIS_OIDC_CLIENT_ID;WEB_OIDC_CLIENT_ID + defaultValue: web + type: string + description: The OIDC client ID which ownCloud Web uses. This client needs to be + set up in your IDP. Note that this setting has no effect when using the builtin + IDP. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OIDC_METADATA_URL: + name: WEB_OIDC_METADATA_URL + defaultValue: https://localhost:9200/.well-known/openid-configuration + type: string + description: URL for the OIDC well-known configuration endpoint. Defaults to the + oCIS API URL + '/.well-known/openid-configuration'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OIDC_POST_LOGOUT_REDIRECT_URI: + name: WEB_OIDC_POST_LOGOUT_REDIRECT_URI + defaultValue: "" + type: string + description: This value needs to point to a valid and reachable web page. The web + client will trigger a redirect to that page directly after the logout action. + The default value is empty and redirects to the login page. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OIDC_RESPONSE_TYPE: + name: WEB_OIDC_RESPONSE_TYPE + defaultValue: code + type: string + description: The OIDC response type to use for authentication. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OIDC_SCOPE: + name: WEB_OIDC_SCOPE + defaultValue: openid profile email + type: string + description: OIDC scopes to request during authentication to authorize access to + user details. Defaults to 'openid profile email'. Values are separated by blank. + More example values but not limited to are 'address' or 'phone' etc. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_CONCURRENT_REQUESTS_RESOURCE_BATCH_ACTIONS: + name: WEB_OPTION_CONCURRENT_REQUESTS_RESOURCE_BATCH_ACTIONS + defaultValue: "0" + type: int + description: Defines the maximum number of concurrent requests per file/folder/space + batch action. Defaults to 4. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_CONCURRENT_REQUESTS_SHARES_CREATE: + name: WEB_OPTION_CONCURRENT_REQUESTS_SHARES_CREATE + defaultValue: "0" + type: int + description: Defines the maximum number of concurrent requests per sharing invite + batch. Defaults to 4. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_CONCURRENT_REQUESTS_SHARES_LIST: + name: WEB_OPTION_CONCURRENT_REQUESTS_SHARES_LIST + defaultValue: "0" + type: int + description: Defines the maximum number of concurrent requests when loading individual + share information inside listings. Defaults to 2. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_CONCURRENT_REQUESTS_SSE: + name: WEB_OPTION_CONCURRENT_REQUESTS_SSE + defaultValue: "0" + type: int + description: Defines the maximum number of concurrent requests in SSE event handlers. + Defaults to 4. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_CONTEXTHELPERS_READ_MORE: + name: WEB_OPTION_CONTEXTHELPERS_READ_MORE + defaultValue: "true" + type: bool + description: Specifies whether the 'Read more' link should be displayed or not. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_DISABLE_FEEDBACK_LINK: + name: WEB_OPTION_DISABLE_FEEDBACK_LINK + defaultValue: "false" + type: bool + description: Set this option to 'true' to disable the feedback link in the topbar. + Keeping it enabled by setting the value to 'false' or with the absence of the + option, allows ownCloud to get feedback from your user base through a dedicated + survey website. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_DISABLE_PREVIEWS: + name: OCIS_DISABLE_PREVIEWS;WEB_OPTION_DISABLE_PREVIEWS + defaultValue: "false" + type: bool + description: Set this option to 'true' to disable previews in all the different + web file listing views. This can speed up file listings in folders with many files. + The only list view that is not affected by this setting is the trash bin, as it + does not allow previewing at all. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_DISABLED_EXTENSIONS: + name: WEB_OPTION_DISABLED_EXTENSIONS + defaultValue: '[]' + type: '[]string' + description: 'A list to disable specific Web extensions identified by their ID. + The ID can e.g. be taken from the ''index.ts'' file of the web extension. Example: + ''com.github.owncloud.web.files.search,com.github.owncloud.web.files.print''. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_HOME_FOLDER: + name: WEB_OPTION_HOME_FOLDER + defaultValue: "" + type: string + description: Specifies a folder that is used when the user navigates 'home'. Navigating + home gets triggered by clicking on the 'All files' menu item. The user will not + be jailed in that directory, it simply serves as a default location. A static + location can be provided, or variables of the user object to come up with a user + specific home path can be used. This uses the twig template variable style and + allows picking a value or a substring of a value of the authenticated user. Examples + are '/Shares', '/{{.Id}}' and '/{{substr 0 3 .Id}}/{{.Id}'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_HOVERABLE_QUICK_ACTIONS: + name: WEB_OPTION_HOVERABLE_QUICK_ACTIONS + defaultValue: "false" + type: bool + description: Set this option to 'true' to hide quick actions (buttons appearing + on file rows) and only show them when the user hovers over the row with his mouse. + Defaults to 'false'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_LOGIN_URL: + name: WEB_OPTION_LOGIN_URL + defaultValue: "" + type: string + description: 'Specifies the target URL to the login page. This is helpful when an + external IdP is used. This option is disabled by default. Example URL like: https://www.myidp.com/login.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_LOGOUT_URL: + name: WEB_OPTION_LOGOUT_URL + defaultValue: "" + type: string + description: Adds a link to the user's profile page to point him to an external + page, where he can manage his session and devices. This is helpful when an external + IdP is used. This option is disabled by default. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_OPEN_APPS_IN_TAB: + name: WEB_OPTION_OPEN_APPS_IN_TAB + defaultValue: "false" + type: bool + description: Configures whether apps and extensions should generally open in a new + tab. Defaults to false. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_OPEN_LINKS_WITH_DEFAULT_APP: + name: WEB_OPTION_OPEN_LINKS_WITH_DEFAULT_APP + defaultValue: "true" + type: bool + description: Specifies whether single file link shares should be opened with the + default app or not. If not opened by the default app, the Web UI just displays + the file details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_PREVIEW_FILE_MIMETYPES: + name: WEB_OPTION_PREVIEW_FILE_MIMETYPES + defaultValue: '[image/gif image/png image/jpeg text/plain image/tiff image/bmp image/x-ms-bmp + application/vnd.geogebra.slides]' + type: '[]string' + description: A list of mimeTypes to specify which ones will be previewed in the + UI. For example, to only preview jpg and text files, set this option to 'image/jpeg,text/plain'. + See the Environment Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_ROUTING_ID_BASED: + name: WEB_OPTION_ROUTING_ID_BASED + defaultValue: "true" + type: bool + description: 'Enable or disable fileIds being added to the URL. Defaults to ''true'', + because otherwise spaces with name clashes cannot be resolved correctly. Note: + Only disable this if you can guarantee on the server side, that spaces of the + same namespace cannot have name clashes.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_RUNNING_ON_EOS: + name: WEB_OPTION_RUNNING_ON_EOS + defaultValue: "false" + type: bool + description: Set this option to 'true' if running on an EOS storage backend (https://eos-web.web.cern.ch/eos-web/) + to enable its specific features. Defaults to 'false'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_SHARING_RECIPIENTS_PER_PAGE: + name: WEB_OPTION_SHARING_RECIPIENTS_PER_PAGE + defaultValue: "200" + type: int + description: Sets the number of users shown as recipients in the dropdown menu when + sharing resources. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_SIDEBAR_SHARES_SHOW_ALL_ON_LOAD: + name: WEB_OPTION_SIDEBAR_SHARES_SHOW_ALL_ON_LOAD + defaultValue: "false" + type: bool + description: Sets the list of the (link) shares list in the sidebar to be initially + expanded. Default is a collapsed state, only showing the first three shares. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_TOKEN_STORAGE_LOCAL: + name: WEB_OPTION_TOKEN_STORAGE_LOCAL + defaultValue: "true" + type: bool + description: Specifies whether the access token will be stored in the local storage + when set to 'true' or in the session storage when set to 'false'. If stored in + the local storage, login state will be persisted across multiple browser tabs, + means no additional logins are required. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_OPTION_USER_LIST_REQUIRES_FILTER: + name: WEB_OPTION_USER_LIST_REQUIRES_FILTER + defaultValue: "false" + type: bool + description: Defines whether one or more filters must be set in order to list users + in the Web admin settings. Set this option to 'true' if running in an environment + with a lot of users and listing all users could slow down performance. Defaults + to 'false'. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;WEB_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;WEB_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;WEB_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_TRACING_TYPE: + name: OCIS_TRACING_TYPE;WEB_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_UI_CONFIG_FILE: + name: WEB_UI_CONFIG_FILE + defaultValue: "" + type: string + description: Read the ownCloud Web json based configuration from this path/file. + The config file takes precedence over WEB_OPTION_xxx environment variables. See + the text description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_UI_CONFIG_SERVER: + name: OCIS_URL;WEB_UI_CONFIG_SERVER + defaultValue: https://localhost:9200 + type: string + description: URL, where the oCIS APIs are reachable for ownCloud Web. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_UI_THEME_PATH: + name: WEB_UI_THEME_PATH + defaultValue: /themes/owncloud/theme.json + type: string + description: Subpath/file to load the theme. Will be appended to the URL of the + theme server. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_UI_THEME_SERVER: + name: OCIS_URL;WEB_UI_THEME_SERVER + defaultValue: https://localhost:9200 + type: string + description: Base URL to load themes from. Will be prepended to the theme path. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_CORS_ALLOW_CREDENTIALS: + name: OCIS_CORS_ALLOW_CREDENTIALS;WEBDAV_CORS_ALLOW_CREDENTIALS + defaultValue: "true" + type: bool + description: 'Allow credentials for CORS.See following chapter for more details: + *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_CORS_ALLOW_HEADERS: + name: OCIS_CORS_ALLOW_HEADERS;WEBDAV_CORS_ALLOW_HEADERS + defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id + Cache-Control]' + type: '[]string' + description: 'A list of allowed CORS headers. See following chapter for more details: + *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_CORS_ALLOW_METHODS: + name: OCIS_CORS_ALLOW_METHODS;WEBDAV_CORS_ALLOW_METHODS + defaultValue: '[GET POST PUT PATCH DELETE OPTIONS]' + type: '[]string' + description: 'A list of allowed CORS methods. See following chapter for more details: + *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_CORS_ALLOW_ORIGINS: + name: OCIS_CORS_ALLOW_ORIGINS;WEBDAV_CORS_ALLOW_ORIGINS + defaultValue: '[*]' + type: '[]string' + description: 'A list of allowed CORS origins. See following chapter for more details: + *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_DEBUG_ADDR: + name: WEBDAV_DEBUG_ADDR + defaultValue: 127.0.0.1:9119 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_DEBUG_PPROF: + name: WEBDAV_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_DEBUG_TOKEN: + name: WEBDAV_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_DEBUG_ZPAGES: + name: WEBDAV_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_DISABLE_PREVIEWS: + name: OCIS_DISABLE_PREVIEWS;WEBDAV_DISABLE_PREVIEWS + defaultValue: "false" + type: bool + description: Set this option to 'true' to disable rendering of thumbnails triggered + via webdav access. Note that when disabled, all access to preview related webdav + paths will return a 404. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_HTTP_ADDR: + name: WEBDAV_HTTP_ADDR + defaultValue: 127.0.0.1:9115 + type: string + description: The bind address of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_HTTP_ROOT: + name: WEBDAV_HTTP_ROOT + defaultValue: / + type: string + description: Subdirectory that serves as the root for this HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_LOG_COLOR: + name: OCIS_LOG_COLOR;WEBDAV_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_LOG_FILE: + name: OCIS_LOG_FILE;WEBDAV_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_LOG_LEVEL: + name: OCIS_LOG_LEVEL;WEBDAV_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_LOG_PRETTY: + name: OCIS_LOG_PRETTY;WEBDAV_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;WEBDAV_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;WEBDAV_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;WEBDAV_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_TRACING_TYPE: + name: OCIS_TRACING_TYPE;WEBDAV_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBDAV_WEBDAV_NAMESPACE: + name: WEBDAV_WEBDAV_NAMESPACE + defaultValue: /users/{{.Id.OpaqueId}} + type: string + description: CS3 path layout to use when forwarding /webdav requests + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_CORS_ALLOW_CREDENTIALS: + name: OCIS_CORS_ALLOW_CREDENTIALS;WEBFINGER_CORS_ALLOW_CREDENTIALS + defaultValue: "false" + type: bool + description: 'Allow credentials for CORS.See following chapter for more details: + *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_CORS_ALLOW_HEADERS: + name: OCIS_CORS_ALLOW_HEADERS;WEBFINGER_CORS_ALLOW_HEADERS + defaultValue: '[]' + type: '[]string' + description: 'A list of allowed CORS headers. See following chapter for more details: + *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_CORS_ALLOW_METHODS: + name: OCIS_CORS_ALLOW_METHODS;WEBFINGER_CORS_ALLOW_METHODS + defaultValue: '[]' + type: '[]string' + description: 'A list of allowed CORS methods. See following chapter for more details: + *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_CORS_ALLOW_ORIGINS: + name: OCIS_CORS_ALLOW_ORIGINS;WEBFINGER_CORS_ALLOW_ORIGINS + defaultValue: '[*]' + type: '[]string' + description: 'A list of allowed CORS origins. See following chapter for more details: + *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. + See the Environment Variable Types description for more details.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_DEBUG_ADDR: + name: WEBFINGER_DEBUG_ADDR + defaultValue: 127.0.0.1:0 + type: string + description: Bind address of the debug server, where metrics, health, config and + debug endpoints will be exposed. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_DEBUG_PPROF: + name: WEBFINGER_DEBUG_PPROF + defaultValue: "false" + type: bool + description: Enables pprof, which can be used for profiling. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_DEBUG_TOKEN: + name: WEBFINGER_DEBUG_TOKEN + defaultValue: "" + type: string + description: Token to secure the metrics endpoint. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_DEBUG_ZPAGES: + name: WEBFINGER_DEBUG_ZPAGES + defaultValue: "false" + type: bool + description: Enables zpages, which can be used for collecting and viewing in-memory + traces. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_HTTP_ADDR: + name: WEBFINGER_HTTP_ADDR + defaultValue: 127.0.0.1:0 + type: string + description: The bind address of the HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_HTTP_ROOT: + name: WEBFINGER_HTTP_ROOT + defaultValue: / + type: string + description: Subdirectory that serves as the root for this HTTP service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_INSECURE: + name: OCIS_INSECURE;WEBFINGER_INSECURE + defaultValue: "false" + type: bool + description: Allow insecure connections to the WEBFINGER service. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_LOG_COLOR: + name: OCIS_LOG_COLOR;WEBFINGER_LOG_COLOR + defaultValue: "false" + type: bool + description: Activates colorized log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_LOG_FILE: + name: OCIS_LOG_FILE;WEBFINGER_LOG_FILE + defaultValue: "" + type: string + description: The path to the log file. Activates logging to this file if set. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_LOG_LEVEL: + name: OCIS_LOG_LEVEL;WEBFINGER_LOG_LEVEL + defaultValue: "" + type: string + description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', + ''warn'', ''info'', ''debug'', ''trace''.' + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_LOG_PRETTY: + name: OCIS_LOG_PRETTY;WEBFINGER_LOG_PRETTY + defaultValue: "false" + type: bool + description: Activates pretty log output. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_OIDC_ISSUER: + name: OCIS_URL;OCIS_OIDC_ISSUER;WEBFINGER_OIDC_ISSUER + defaultValue: https://localhost:9200 + type: string + description: The identity provider href for the openid-discovery relation. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_OWNCLOUD_SERVER_INSTANCE_URL: + name: OCIS_URL;WEBFINGER_OWNCLOUD_SERVER_INSTANCE_URL + defaultValue: https://localhost:9200 + type: string + description: The URL for the legacy ownCloud server instance relation (not to be + confused with the product ownCloud Server). It defaults to the OCIS_URL but can + be overridden to support some reverse proxy corner cases. To shard the deployment, + multiple instances can be configured in the configuration file. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_RELATIONS: + name: WEBFINGER_RELATIONS + defaultValue: '[http://openid.net/specs/connect/1.0/issuer http://webfinger.owncloud/rel/server-instance]' + type: '[]string' + description: A list of relation URIs or registered relation types to add to webfinger + responses. See the Environment Variable Types description for more details. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_TRACING_COLLECTOR: + name: OCIS_TRACING_COLLECTOR;WEBFINGER_TRACING_COLLECTOR + defaultValue: "" + type: string + description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. + Only used if the tracing endpoint is unset. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_TRACING_ENABLED: + name: OCIS_TRACING_ENABLED;WEBFINGER_TRACING_ENABLED + defaultValue: "false" + type: bool + description: Activates tracing. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_TRACING_ENDPOINT: + name: OCIS_TRACING_ENDPOINT;WEBFINGER_TRACING_ENDPOINT + defaultValue: "" + type: string + description: The endpoint of the tracing agent. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEBFINGER_TRACING_TYPE: + name: OCIS_TRACING_TYPE;WEBFINGER_TRACING_TYPE + defaultValue: "" + type: string + description: The type of tracing. Defaults to '', which is the same as 'jaeger'. + Allowed tracing types are 'jaeger' and '' as of now. + introductionVersion: "" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" diff --git a/docs/helpers/main.go b/docs/helpers/main.go index 7629a2e015..a10faadabe 100644 --- a/docs/helpers/main.go +++ b/docs/helpers/main.go @@ -16,6 +16,15 @@ func main() { RenderGlobalVarsTemplate() case "service-index": GenerateServiceIndexMarkdowns() + case "env-var-delta-table": + // This step is not covered by the all or default case, because it needs explicit arguments + if len(os.Args) != 4 { + fmt.Println("Needs two arguments: env-var-delta-table ") + fmt.Println("Example: env-var-delta-table v5.0.0 v6.0.0") + fmt.Println("Will not generate usable results vor versions Prior to v5.0.0") + } else { + RenderEnvVarDeltaTable(os.Args) + } case "all": RenderTemplates() GetRogueEnvs() @@ -24,7 +33,7 @@ func main() { case "help": fallthrough default: - fmt.Println("Usage: [templates|rogue|globals|service-index|all]") + fmt.Println("Usage: env-var-delta-table [templates|rogue|globals|service-index|env-var-delta-table|all|help]") } } else { // Left here, even though present in the switch case, for backwards compatibility diff --git a/docs/helpers/templates/env-vars-added.md.tmpl b/docs/helpers/templates/env-vars-added.md.tmpl new file mode 100644 index 0000000000..5e3725933a --- /dev/null +++ b/docs/helpers/templates/env-vars-added.md.tmpl @@ -0,0 +1,7 @@ +Added between Version {{ .StartVersion }} and {{ .EndVersion }}. + +| Variable | Description | +| --- | --- | +{{- range $key, $value := .DeltaFields}} +| {{$value.Name}} | {{$value.Description}} | +{{- end}} diff --git a/docs/helpers/templates/env-vars-deprecated.md.tmpl b/docs/helpers/templates/env-vars-deprecated.md.tmpl new file mode 100644 index 0000000000..53c42afd64 --- /dev/null +++ b/docs/helpers/templates/env-vars-deprecated.md.tmpl @@ -0,0 +1,7 @@ +Deprecated between Version {{ .StartVersion }} and {{ .EndVersion }}. + +| Variable | Description | Deprecation Info | +| --- | --- | +{{- range $key, $value := .DeltaFields}} +| {{$value.Name}} | {{$value.Description}} | {{$value.DeprecationInfo}} | +{{- end}} diff --git a/docs/helpers/templates/env-vars-removed.md.tmpl b/docs/helpers/templates/env-vars-removed.md.tmpl new file mode 100644 index 0000000000..c342027873 --- /dev/null +++ b/docs/helpers/templates/env-vars-removed.md.tmpl @@ -0,0 +1,7 @@ +Removed between Version {{ .StartVersion }} and {{ .EndVersion }}. + +| Variable | Description | Deprecation Info | +| --- | --- | +{{- range $key, $value := .DeltaFields}} +| {{$value.Name}} | {{$value.Description}} | {{$value.DeprecationInfo}} | +{{- end}} From 9b899b2921714d7011ffdfb376452e9c3775afa3 Mon Sep 17 00:00:00 2001 From: Christian Richter Date: Thu, 15 Feb 2024 08:24:32 +0100 Subject: [PATCH 05/10] vendor semver Signed-off-by: Christian Richter --- .../rogpeppe/go-internal/semver/forward.go | 39 +++++++++++++++++++ vendor/modules.txt | 1 + 2 files changed, 40 insertions(+) create mode 100644 vendor/github.com/rogpeppe/go-internal/semver/forward.go diff --git a/vendor/github.com/rogpeppe/go-internal/semver/forward.go b/vendor/github.com/rogpeppe/go-internal/semver/forward.go new file mode 100644 index 0000000000..ad55780155 --- /dev/null +++ b/vendor/github.com/rogpeppe/go-internal/semver/forward.go @@ -0,0 +1,39 @@ +// Package semver is a thin forwarding layer on top of +// [golang.org/x/mod/semver]. See that package for documentation. +// +// Deprecated: use [golang.org/x/mod/semver] instead. +package semver + +import "golang.org/x/mod/semver" + +func IsValid(v string) bool { + return semver.IsValid(v) +} + +func Canonical(v string) string { + return semver.Canonical(v) +} + +func Major(v string) string { + return semver.Major(v) +} + +func MajorMinor(v string) string { + return semver.MajorMinor(v) +} + +func Prerelease(v string) string { + return semver.Prerelease(v) +} + +func Build(v string) string { + return semver.Build(v) +} + +func Compare(v, w string) int { + return semver.Compare(v, w) +} + +func Max(v, w string) string { + return semver.Max(v, w) +} diff --git a/vendor/modules.txt b/vendor/modules.txt index 67a6b750b8..b69664c4b2 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -1672,6 +1672,7 @@ github.com/rogpeppe/go-internal/internal/syscall/windows github.com/rogpeppe/go-internal/internal/syscall/windows/sysdll github.com/rogpeppe/go-internal/lockedfile github.com/rogpeppe/go-internal/lockedfile/internal/filelock +github.com/rogpeppe/go-internal/semver # github.com/rs/cors v1.10.1 ## explicit; go 1.13 github.com/rs/cors From c23ae6d13d0d35dadb795999455d74990b18cbf1 Mon Sep 17 00:00:00 2001 From: Christian Richter Date: Thu, 15 Feb 2024 12:58:11 +0100 Subject: [PATCH 06/10] fix template path & clean-up Signed-off-by: Christian Richter --- docs/helpers/env-var-delta.go | 6 + docs/helpers/env_vars.yaml | 226 +++++++++++++++---------------- docs/helpers/markdowncreation.go | 2 +- 3 files changed, 118 insertions(+), 116 deletions(-) diff --git a/docs/helpers/env-var-delta.go b/docs/helpers/env-var-delta.go index ee1f29d6e1..755a144562 100644 --- a/docs/helpers/env-var-delta.go +++ b/docs/helpers/env-var-delta.go @@ -44,6 +44,12 @@ func RenderEnvVarDeltaTable(osArgs []string) { if !semver.IsValid(osArgs[3]) { log.Fatalf("Target version invalid semver: %s", osArgs[3]) } + if semver.Compare(osArgs[2], osArgs[3]) >= 0 { + log.Fatalf("Start version %s is not smaller than target version %s", osArgs[2], osArgs[3]) + } + if semver.Compare(osArgs[2], "v5.0.0") < 0 { + log.Fatalf("This tool does not support versions prior v5.0.0, (given %s)", osArgs[2]) + } startVersion := osArgs[2] endVersion := osArgs[3] fmt.Printf("Generating tables for env-var deltas between version %s and %s...\n", startVersion, endVersion) diff --git a/docs/helpers/env_vars.yaml b/docs/helpers/env_vars.yaml index 965330b496..c0c65f7f68 100644 --- a/docs/helpers/env_vars.yaml +++ b/docs/helpers/env_vars.yaml @@ -151,8 +151,8 @@ ANTIVIRUS_ICAP_TIMEOUT: type: int64 description: Timeout for the ICAP client. introductionVersion: "" - deprecationVersion: "v5.0" - removalVersion: "v6.0" + deprecationVersion: "5.0" + removalVersion: "6.0" deprecationInfo: Changing the envvar type for consistency reasons. ANTIVIRUS_ICAP_URL: name: ANTIVIRUS_ICAP_URL @@ -6443,8 +6443,8 @@ NOTIFICATIONS_SMTP_ENCRYPTION: description: Encryption method for the SMTP communication. Possible values are 'starttls', 'ssl', 'ssltls', 'tls' and 'none'. introductionVersion: "" - deprecationVersion: "v5.0.0" - removalVersion: "v6.0.0" + deprecationVersion: 5.0.0 + removalVersion: 6.0.0 deprecationInfo: The NOTIFICATIONS_SMTP_ENCRYPTION values 'ssl' and 'tls' are deprecated and will be removed in the future. NOTIFICATIONS_SMTP_HOST: @@ -6875,7 +6875,7 @@ OCIS_ADMIN_USER_ID: removalVersion: "" deprecationInfo: "" OCIS_ASYNC_UPLOADS: - name: OCIS_ASYNC_UPLOADS + name: OCIS_ASYNC_UPLOADS;SEARCH_EVENTS_ASYNC_UPLOADS defaultValue: "true" type: bool description: Enable asynchronous file uploads. @@ -6884,28 +6884,28 @@ OCIS_ASYNC_UPLOADS: removalVersion: "" deprecationInfo: "" OCIS_CACHE_AUTH_PASSWORD: - name: OCIS_CACHE_AUTH_PASSWORD;FRONTEND_OCS_STAT_CACHE_AUTH_PASSWORD + name: OCIS_CACHE_AUTH_PASSWORD;GATEWAY_CREATE_HOME_CACHE_AUTH_PASSWORD defaultValue: "" type: string - description: The password to use for authentication. Only applies when using the - 'nats-js-kv' store type. + description: The password to use for authentication. Only applies when store type + 'nats-js-kv' is configured. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_AUTH_USERNAME: - name: OCIS_CACHE_AUTH_USERNAME;FRONTEND_OCS_STAT_CACHE_AUTH_USERNAME + name: OCIS_CACHE_AUTH_USERNAME;GATEWAY_CREATE_HOME_CACHE_AUTH_USERNAME defaultValue: "" type: string - description: The username to use for authentication. Only applies when using the - 'nats-js-kv' store type. + description: The username to use for authentication. Only applies when store type + 'nats-js-kv' is configured. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_DATABASE: name: OCIS_CACHE_DATABASE - defaultValue: cache-stat + defaultValue: cache-createhome type: string description: The database name the configured store should use. introductionVersion: "" @@ -6913,26 +6913,28 @@ OCIS_CACHE_DATABASE: removalVersion: "" deprecationInfo: "" OCIS_CACHE_DISABLE_PERSISTENCE: - name: OCIS_CACHE_DISABLE_PERSISTENCE;FRONTEND_OCS_STAT_CACHE_DISABLE_PERSISTENCE + name: OCIS_CACHE_DISABLE_PERSISTENCE;GATEWAY_CREATE_HOME_CACHE_DISABLE_PERSISTENCE defaultValue: "false" type: bool - description: Disable persistence of the cache. Only applies when using the 'nats-js-kv' - store type. Defaults to false. + description: Disables persistence of the create home cache. Only applies when store + type 'nats-js-kv' is configured. Defaults to false. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_SIZE: - name: OCIS_CACHE_SIZE;FRONTEND_OCS_STAT_CACHE_SIZE + name: OCIS_CACHE_SIZE;GATEWAY_CREATE_HOME_CACHE_SIZE defaultValue: "0" type: int - description: Max number of entries to hold in the cache. + description: The maximum quantity of items in the cache. Only applies when store + type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package + though not exclicitely set as default. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_STORE: - name: OCIS_CACHE_STORE;FRONTEND_OCS_STAT_CACHE_STORE + name: OCIS_CACHE_STORE;GATEWAY_CREATE_HOME_CACHE_STORE defaultValue: memory type: string description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', @@ -6942,7 +6944,7 @@ OCIS_CACHE_STORE: removalVersion: "" deprecationInfo: "" OCIS_CACHE_STORE_NODES: - name: OCIS_CACHE_STORE_NODES;FRONTEND_OCS_STAT_CACHE_STORE_NODES + name: OCIS_CACHE_STORE_NODES;GATEWAY_CREATE_HOME_CACHE_STORE_NODES defaultValue: '[127.0.0.1:9233]' type: '[]string' description: A list of nodes to access the configured store. This has no effect @@ -6954,7 +6956,7 @@ OCIS_CACHE_STORE_NODES: removalVersion: "" deprecationInfo: "" OCIS_CACHE_TTL: - name: OCIS_CACHE_TTL;FRONTEND_OCS_STAT_CACHE_TTL + name: OCIS_CACHE_TTL;GATEWAY_CREATE_HOME_CACHE_TTL defaultValue: 5m0s type: Duration description: Default time to live for user info in the cache. Only applied when @@ -6965,7 +6967,7 @@ OCIS_CACHE_TTL: removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_CREDENTIALS: - name: OCIS_CORS_ALLOW_CREDENTIALS;FRONTEND_CORS_ALLOW_CREDENTIALS + name: OCIS_CORS_ALLOW_CREDENTIALS;SETTINGS_CORS_ALLOW_CREDENTIALS defaultValue: "true" type: bool description: 'Allow credentials for CORS.See following chapter for more details: @@ -6975,11 +6977,8 @@ OCIS_CORS_ALLOW_CREDENTIALS: removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_HEADERS: - name: OCIS_CORS_ALLOW_HEADERS;FRONTEND_CORS_ALLOW_HEADERS - defaultValue: '[Origin Accept Content-Type Depth Authorization Ocs-Apirequest If-None-Match - If-Match Destination Overwrite X-Request-Id X-Requested-With Tus-Resumable Tus-Checksum-Algorithm - Upload-Concat Upload-Length Upload-Metadata Upload-Defer-Length Upload-Expires - Upload-Checksum Upload-Offset X-HTTP-Method-Override Cache-Control]' + name: OCIS_CORS_ALLOW_HEADERS;SETTINGS_CORS_ALLOW_HEADERS + defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id]' type: '[]string' description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. @@ -6989,9 +6988,8 @@ OCIS_CORS_ALLOW_HEADERS: removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_METHODS: - name: OCIS_CORS_ALLOW_METHODS;FRONTEND_CORS_ALLOW_METHODS - defaultValue: '[OPTIONS HEAD GET PUT POST DELETE MKCOL PROPFIND PROPPATCH MOVE COPY - REPORT SEARCH]' + name: OCIS_CORS_ALLOW_METHODS;SETTINGS_CORS_ALLOW_METHODS + defaultValue: '[GET POST PUT PATCH DELETE OPTIONS]' type: '[]string' description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. @@ -7001,7 +6999,7 @@ OCIS_CORS_ALLOW_METHODS: removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_ORIGINS: - name: OCIS_CORS_ALLOW_ORIGINS;FRONTEND_CORS_ALLOW_ORIGINS + name: OCIS_CORS_ALLOW_ORIGINS;SETTINGS_CORS_ALLOW_ORIGINS defaultValue: '[*]' type: '[]string' description: 'A list of allowed CORS origins. See following chapter for more details: @@ -7043,13 +7041,12 @@ OCIS_DEFAULT_LANGUAGE: removalVersion: "" deprecationInfo: "" OCIS_DISABLE_PREVIEWS: - name: OCIS_DISABLE_PREVIEWS;WEB_OPTION_DISABLE_PREVIEWS + name: OCIS_DISABLE_PREVIEWS;WEBDAV_DISABLE_PREVIEWS defaultValue: "false" type: bool - description: Set this option to 'true' to disable previews in all the different - web file listing views. This can speed up file listings in folders with many files. - The only list view that is not affected by this setting is the trash bin, as it - does not allow previewing at all. + description: Set this option to 'true' to disable rendering of thumbnails triggered + via webdav access. Note that when disabled, all access to preview related webdav + paths will return a 404. introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -7103,7 +7100,7 @@ OCIS_ENABLE_RESHARING: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_AUTH_PASSWORD: - name: OCIS_EVENTS_AUTH_PASSWORD;FRONTEND_EVENTS_AUTH_PASSWORD + name: OCIS_EVENTS_AUTH_PASSWORD;SEARCH_EVENTS_AUTH_PASSWORD defaultValue: "" type: string description: The password to authenticate with the events broker. The events broker @@ -7113,7 +7110,7 @@ OCIS_EVENTS_AUTH_PASSWORD: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_AUTH_USERNAME: - name: OCIS_EVENTS_AUTH_USERNAME;FRONTEND_EVENTS_AUTH_USERNAME + name: OCIS_EVENTS_AUTH_USERNAME;SEARCH_EVENTS_AUTH_USERNAME defaultValue: "" type: string description: The username to authenticate with the events broker. The events broker @@ -7123,7 +7120,7 @@ OCIS_EVENTS_AUTH_USERNAME: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_CLUSTER: - name: OCIS_EVENTS_CLUSTER;FRONTEND_EVENTS_CLUSTER + name: OCIS_EVENTS_CLUSTER;SEARCH_EVENTS_CLUSTER defaultValue: ocis-cluster type: string description: The clusterID of the event system. The event system is the message @@ -7134,7 +7131,7 @@ OCIS_EVENTS_CLUSTER: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_ENABLE_TLS: - name: OCIS_EVENTS_ENABLE_TLS;FRONTEND_EVENTS_ENABLE_TLS + name: OCIS_EVENTS_ENABLE_TLS;SEARCH_EVENTS_ENABLE_TLS defaultValue: "false" type: bool description: Enable TLS for the connection to the events broker. The events broker @@ -7144,7 +7141,7 @@ OCIS_EVENTS_ENABLE_TLS: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_ENDPOINT: - name: OCIS_EVENTS_ENDPOINT;FRONTEND_EVENTS_ENDPOINT + name: OCIS_EVENTS_ENDPOINT;SEARCH_EVENTS_ENDPOINT defaultValue: 127.0.0.1:9233 type: string description: The address of the event system. The event system is the message queuing @@ -7154,11 +7151,11 @@ OCIS_EVENTS_ENDPOINT: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE: - name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;SHARING_EVENTS_TLS_ROOT_CA_CERTIFICATE + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;SEARCH_EVENTS_TLS_ROOT_CA_CERTIFICATE defaultValue: "" type: string description: The root CA certificate used to validate the server's TLS certificate. - If provided SHARING_EVENTS_TLS_INSECURE will be seen as false. + If provided SEARCH_EVENTS_TLS_INSECURE will be seen as false. introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -7227,16 +7224,16 @@ OCIS_HTTP_TLS_KEY: removalVersion: "" deprecationInfo: "" OCIS_INSECURE: - name: OCIS_INSECURE;FRONTEND_EVENTS_TLS_INSECURE + name: OCIS_INSECURE;THUMBNAILS_CS3SOURCE_INSECURE defaultValue: "false" type: bool - description: Whether to verify the server TLS certificates. + description: Ignore untrusted SSL certificates when connecting to the CS3 source. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_JWT_SECRET: - name: OCIS_JWT_SECRET;FRONTEND_JWT_SECRET + name: OCIS_JWT_SECRET;SEARCH_JWT_SECRET defaultValue: "" type: string description: The secret to mint and validate jwt tokens. @@ -7245,7 +7242,7 @@ OCIS_JWT_SECRET: removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_BASE_PATH: - name: OCIS_KEYCLOAK_BASE_PATH;INVITATIONS_KEYCLOAK_BASE_PATH + name: OCIS_KEYCLOAK_BASE_PATH;GRAPH_KEYCLOAK_BASE_PATH defaultValue: "" type: string description: The URL to access keycloak. @@ -7254,16 +7251,16 @@ OCIS_KEYCLOAK_BASE_PATH: removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_CLIENT_ID: - name: OCIS_KEYCLOAK_CLIENT_ID;INVITATIONS_KEYCLOAK_CLIENT_ID + name: OCIS_KEYCLOAK_CLIENT_ID;GRAPH_KEYCLOAK_CLIENT_ID defaultValue: "" type: string - description: The client ID to authenticate with keycloak. + description: The client id to authenticate with keycloak. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_CLIENT_REALM: - name: OCIS_KEYCLOAK_CLIENT_REALM;INVITATIONS_KEYCLOAK_CLIENT_REALM + name: OCIS_KEYCLOAK_CLIENT_REALM;GRAPH_KEYCLOAK_CLIENT_REALM defaultValue: "" type: string description: The realm the client is defined in. @@ -7272,7 +7269,7 @@ OCIS_KEYCLOAK_CLIENT_REALM: removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_CLIENT_SECRET: - name: OCIS_KEYCLOAK_CLIENT_SECRET;INVITATIONS_KEYCLOAK_CLIENT_SECRET + name: OCIS_KEYCLOAK_CLIENT_SECRET;GRAPH_KEYCLOAK_CLIENT_SECRET defaultValue: "" type: string description: The client secret to use in authentication. @@ -7281,7 +7278,7 @@ OCIS_KEYCLOAK_CLIENT_SECRET: removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY: - name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;INVITATIONS_KEYCLOAK_INSECURE_SKIP_VERIFY + name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;GRAPH_KEYCLOAK_INSECURE_SKIP_VERIFY defaultValue: "false" type: bool description: Disable TLS certificate validation for Keycloak connections. Do not @@ -7291,7 +7288,7 @@ OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY: removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_USER_REALM: - name: OCIS_KEYCLOAK_USER_REALM;INVITATIONS_KEYCLOAK_USER_REALM + name: OCIS_KEYCLOAK_USER_REALM;GRAPH_KEYCLOAK_USER_REALM defaultValue: "" type: string description: The realm users are defined. @@ -7300,8 +7297,8 @@ OCIS_KEYCLOAK_USER_REALM: removalVersion: "" deprecationInfo: "" OCIS_LDAP_BIND_DN: - name: OCIS_LDAP_BIND_DN;GROUPS_LDAP_BIND_DN - defaultValue: uid=reva,ou=sysusers,o=libregraph-idm + name: OCIS_LDAP_BIND_DN;IDP_LDAP_BIND_DN + defaultValue: uid=idp,ou=sysusers,o=libregraph-idm type: string description: LDAP DN to use for simple bind authentication with the target LDAP server. @@ -7310,7 +7307,7 @@ OCIS_LDAP_BIND_DN: removalVersion: "" deprecationInfo: "" OCIS_LDAP_BIND_PASSWORD: - name: OCIS_LDAP_BIND_PASSWORD;GROUPS_LDAP_BIND_PASSWORD + name: OCIS_LDAP_BIND_PASSWORD;IDP_LDAP_BIND_PASSWORD defaultValue: "" type: string description: Password to use for authenticating the 'bind_dn'. @@ -7319,12 +7316,12 @@ OCIS_LDAP_BIND_PASSWORD: removalVersion: "" deprecationInfo: "" OCIS_LDAP_CACERT: - name: OCIS_LDAP_CACERT;GROUPS_LDAP_CACERT + name: OCIS_LDAP_CACERT;IDP_LDAP_TLS_CACERT defaultValue: /var/lib/ocis/idm/ldap.crt type: string description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root - directory derives from $OCIS_BASE_DATA_PATH:/idm. + directory derives from $OCIS_BASE_DATA_PATH:/idp. introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -7449,7 +7446,7 @@ OCIS_LDAP_GROUP_SCOPE: removalVersion: "" deprecationInfo: "" OCIS_LDAP_INSECURE: - name: OCIS_LDAP_INSECURE;GROUPS_LDAP_INSECURE + name: OCIS_LDAP_INSECURE;IDP_INSECURE defaultValue: "false" type: bool description: Disable TLS certificate validation for the LDAP connections. Do not @@ -7471,17 +7468,16 @@ OCIS_LDAP_SERVER_WRITE_ENABLED: removalVersion: "" deprecationInfo: "" OCIS_LDAP_URI: - name: OCIS_LDAP_URI;GROUPS_LDAP_URI + name: OCIS_LDAP_URI;IDP_LDAP_URI defaultValue: ldaps://localhost:9235 type: string - description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' - and 'ldap://' + description: Url of the LDAP service to use as IDP. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_BASE_DN: - name: OCIS_LDAP_USER_BASE_DN;GROUPS_LDAP_USER_BASE_DN + name: OCIS_LDAP_USER_BASE_DN;IDP_LDAP_BASE_DN defaultValue: ou=users,o=libregraph-idm type: string description: Search base DN for looking up LDAP users. @@ -7499,7 +7495,7 @@ OCIS_LDAP_USER_ENABLED_ATTRIBUTE: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_FILTER: - name: OCIS_LDAP_USER_FILTER;GROUPS_LDAP_USER_FILTER + name: OCIS_LDAP_USER_FILTER;IDP_LDAP_FILTER defaultValue: "" type: string description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. @@ -7508,11 +7504,10 @@ OCIS_LDAP_USER_FILTER: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_OBJECTCLASS: - name: OCIS_LDAP_USER_OBJECTCLASS;GROUPS_LDAP_USER_OBJECTCLASS + name: OCIS_LDAP_USER_OBJECTCLASS;IDP_LDAP_OBJECTCLASS defaultValue: inetOrgPerson type: string - description: The object class to use for users in the default user search filter - ('inetOrgPerson'). + description: LDAP User ObjectClass like 'inetOrgPerson'. introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -7527,11 +7522,10 @@ OCIS_LDAP_USER_SCHEMA_DISPLAYNAME: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_ID: - name: OCIS_LDAP_USER_SCHEMA_ID;GROUPS_LDAP_USER_SCHEMA_ID - defaultValue: ownclouduuid + name: OCIS_LDAP_USER_SCHEMA_ID;IDP_LDAP_UUID_ATTRIBUTE + defaultValue: ownCloudUUID type: string - description: LDAP Attribute to use as the unique id for users. This should be a - stable globally unique id like a UUID. + description: LDAP User UUID attribute like 'uid'. introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -7548,10 +7542,10 @@ OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_MAIL: - name: OCIS_LDAP_USER_SCHEMA_MAIL;GROUPS_LDAP_USER_SCHEMA_MAIL + name: OCIS_LDAP_USER_SCHEMA_MAIL;IDP_LDAP_EMAIL_ATTRIBUTE defaultValue: mail type: string - description: LDAP Attribute to use for the email address of users. + description: LDAP User email attribute like 'mail'. introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -7567,16 +7561,16 @@ OCIS_LDAP_USER_SCHEMA_USER_TYPE: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_USERNAME: - name: OCIS_LDAP_USER_SCHEMA_USERNAME;GROUPS_LDAP_USER_SCHEMA_USERNAME - defaultValue: uid + name: OCIS_LDAP_USER_SCHEMA_USERNAME;IDP_LDAP_NAME_ATTRIBUTE + defaultValue: displayName type: string - description: LDAP Attribute to use for username of users. + description: LDAP User name attribute like 'displayName'. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCOPE: - name: OCIS_LDAP_USER_SCOPE;GROUPS_LDAP_USER_SCOPE + name: OCIS_LDAP_USER_SCOPE;IDP_LDAP_SCOPE defaultValue: sub type: string description: LDAP search scope to use when looking up users. Supported scopes are @@ -7586,7 +7580,7 @@ OCIS_LDAP_USER_SCOPE: removalVersion: "" deprecationInfo: "" OCIS_LOG_COLOR: - name: OCIS_LOG_COLOR;FRONTEND_LOG_COLOR + name: OCIS_LOG_COLOR;THUMBNAILS_LOG_COLOR defaultValue: "false" type: bool description: Activates colorized log output. @@ -7595,7 +7589,7 @@ OCIS_LOG_COLOR: removalVersion: "" deprecationInfo: "" OCIS_LOG_FILE: - name: OCIS_LOG_FILE;FRONTEND_LOG_FILE + name: OCIS_LOG_FILE;THUMBNAILS_LOG_FILE defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. @@ -7604,7 +7598,7 @@ OCIS_LOG_FILE: removalVersion: "" deprecationInfo: "" OCIS_LOG_LEVEL: - name: OCIS_LOG_LEVEL;FRONTEND_LOG_LEVEL + name: OCIS_LOG_LEVEL;THUMBNAILS_LOG_LEVEL defaultValue: "" type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', @@ -7614,7 +7608,7 @@ OCIS_LOG_LEVEL: removalVersion: "" deprecationInfo: "" OCIS_LOG_PRETTY: - name: OCIS_LOG_PRETTY;FRONTEND_LOG_PRETTY + name: OCIS_LOG_PRETTY;THUMBNAILS_LOG_PRETTY defaultValue: "false" type: bool description: Activates pretty log output. @@ -7623,11 +7617,11 @@ OCIS_LOG_PRETTY: removalVersion: "" deprecationInfo: "" OCIS_MACHINE_AUTH_API_KEY: - name: OCIS_MACHINE_AUTH_API_KEY;FRONTEND_MACHINE_AUTH_API_KEY + name: OCIS_MACHINE_AUTH_API_KEY;IDP_MACHINE_AUTH_API_KEY defaultValue: "" type: string - description: The machine auth API key used to validate internal requests necessary - to access resources from other services. + description: Machine auth API key used to validate internal requests necessary for + the access to resources from other services. introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -7644,16 +7638,16 @@ OCIS_OIDC_CLIENT_ID: removalVersion: "" deprecationInfo: "" OCIS_OIDC_ISSUER: - name: OCIS_URL;OCIS_OIDC_ISSUER;WEB_OIDC_AUTHORITY + name: OCIS_URL;OCIS_OIDC_ISSUER;IDP_ISS defaultValue: https://localhost:9200 type: string - description: URL of the OIDC issuer. It defaults to URL of the builtin IDP. + description: The OIDC issuer URL to use. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST: - name: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST;FRONTEND_PASSWORD_POLICY_BANNED_PASSWORDS_LIST + name: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST;SHARING_PASSWORD_POLICY_BANNED_PASSWORDS_LIST defaultValue: "" type: string description: Path to the 'banned passwords list' file. See the documentation for @@ -7663,7 +7657,7 @@ OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_DISABLED: - name: OCIS_PASSWORD_POLICY_DISABLED;FRONTEND_PASSWORD_POLICY_DISABLED + name: OCIS_PASSWORD_POLICY_DISABLED;SHARING_PASSWORD_POLICY_DISABLED defaultValue: "false" type: bool description: Disable the password policy. Defaults to false if not set. @@ -7672,7 +7666,7 @@ OCIS_PASSWORD_POLICY_DISABLED: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_MIN_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_CHARACTERS defaultValue: "8" type: int description: Define the minimum password length. Defaults to 8 if not set. @@ -7681,7 +7675,7 @@ OCIS_PASSWORD_POLICY_MIN_CHARACTERS: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_MIN_DIGITS: - name: OCIS_PASSWORD_POLICY_MIN_DIGITS;FRONTEND_PASSWORD_POLICY_MIN_DIGITS + name: OCIS_PASSWORD_POLICY_MIN_DIGITS;SHARING_PASSWORD_POLICY_MIN_DIGITS defaultValue: "1" type: int description: Define the minimum number of digits. Defaults to 1 if not set. @@ -7690,7 +7684,7 @@ OCIS_PASSWORD_POLICY_MIN_DIGITS: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of uppercase letters. Defaults to 1 if not @@ -7700,7 +7694,7 @@ OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of characters from the special characters @@ -7710,7 +7704,7 @@ OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of lowercase letters. Defaults to 1 if not @@ -7720,7 +7714,7 @@ OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS: removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE: - name: OCIS_PERSISTENT_STORE;POSTPROCESSING_STORE + name: OCIS_PERSISTENT_STORE;USERLOG_STORE defaultValue: memory type: string description: 'The type of the store. Supported values are: ''memory'', ''ocmem'', @@ -7731,7 +7725,7 @@ OCIS_PERSISTENT_STORE: removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE_AUTH_PASSWORD: - name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;POSTPROCESSING_STORE_AUTH_PASSWORD + name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;USERLOG_STORE_AUTH_PASSWORD defaultValue: "" type: string description: The password to authenticate with the store. Only applies when store @@ -7741,7 +7735,7 @@ OCIS_PERSISTENT_STORE_AUTH_PASSWORD: removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE_AUTH_USERNAME: - name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;POSTPROCESSING_STORE_AUTH_USERNAME + name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;USERLOG_STORE_AUTH_USERNAME defaultValue: "" type: string description: The username to authenticate with the store. Only applies when store @@ -7751,7 +7745,7 @@ OCIS_PERSISTENT_STORE_AUTH_USERNAME: removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE_NODES: - name: OCIS_PERSISTENT_STORE_NODES;POSTPROCESSING_STORE_NODES + name: OCIS_PERSISTENT_STORE_NODES;USERLOG_STORE_NODES defaultValue: '[]' type: '[]string' description: A list of nodes to access the configured store. This has no effect @@ -7763,7 +7757,7 @@ OCIS_PERSISTENT_STORE_NODES: removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE_SIZE: - name: OCIS_PERSISTENT_STORE_SIZE;POSTPROCESSING_STORE_SIZE + name: OCIS_PERSISTENT_STORE_SIZE;USERLOG_STORE_SIZE defaultValue: "0" type: int description: The maximum quantity of items in the store. Only applies when store @@ -7774,11 +7768,11 @@ OCIS_PERSISTENT_STORE_SIZE: removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE_TTL: - name: OCIS_PERSISTENT_STORE_TTL;POSTPROCESSING_STORE_TTL - defaultValue: 0s + name: OCIS_PERSISTENT_STORE_TTL;USERLOG_STORE_TTL + defaultValue: 336h0m0s type: Duration - description: Time to live for events in the store. See the Environment Variable - Types description for more details. + description: Time to live for events in the store. Defaults to '336h' (2 weeks). + See the Environment Variable Types description for more details. introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -7796,7 +7790,7 @@ OCIS_REVA_GATEWAY: name: OCIS_REVA_GATEWAY defaultValue: com.owncloud.api.gateway type: string - description: The CS3 gateway endpoint. + description: CS3 gateway used to look up user metadata introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -7824,7 +7818,7 @@ OCIS_REVA_GATEWAY_TLS_MODE: removalVersion: "" deprecationInfo: "" OCIS_SERVICE_ACCOUNT_ID: - name: OCIS_SERVICE_ACCOUNT_ID;FRONTEND_SERVICE_ACCOUNT_ID + name: OCIS_SERVICE_ACCOUNT_ID;SEARCH_SERVICE_ACCOUNT_ID defaultValue: "" type: string description: The ID of the service account the service should use. See the 'auth-service' @@ -7834,7 +7828,7 @@ OCIS_SERVICE_ACCOUNT_ID: removalVersion: "" deprecationInfo: "" OCIS_SERVICE_ACCOUNT_SECRET: - name: OCIS_SERVICE_ACCOUNT_SECRET;FRONTEND_SERVICE_ACCOUNT_SECRET + name: OCIS_SERVICE_ACCOUNT_SECRET;SEARCH_SERVICE_ACCOUNT_SECRET defaultValue: "" type: string description: The service account secret. @@ -7843,7 +7837,7 @@ OCIS_SERVICE_ACCOUNT_SECRET: removalVersion: "" deprecationInfo: "" OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD: - name: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD;FRONTEND_OCS_PUBLIC_SHARE_MUST_HAVE_PASSWORD + name: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD;SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD defaultValue: "true" type: bool description: Set this to true if you want to enforce passwords on all public shares. @@ -7852,11 +7846,13 @@ OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD: removalVersion: "" deprecationInfo: "" OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD: - name: OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD;FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD + name: OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD;SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD defaultValue: "false" type: bool description: Set this to true if you want to enforce passwords on Uploader, Editor - or Contributor shares. + or Contributor shares. If not using the global OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD, + you must define the FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD in + the frontend service. introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -7902,7 +7898,7 @@ OCIS_SYSTEM_USER_IDP: removalVersion: "" deprecationInfo: "" OCIS_TRACING_COLLECTOR: - name: OCIS_TRACING_COLLECTOR;FRONTEND_TRACING_COLLECTOR + name: OCIS_TRACING_COLLECTOR;THUMBNAILS_TRACING_COLLECTOR defaultValue: "" type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. @@ -7912,7 +7908,7 @@ OCIS_TRACING_COLLECTOR: removalVersion: "" deprecationInfo: "" OCIS_TRACING_ENABLED: - name: OCIS_TRACING_ENABLED;FRONTEND_TRACING_ENABLED + name: OCIS_TRACING_ENABLED;THUMBNAILS_TRACING_ENABLED defaultValue: "false" type: bool description: Activates tracing. @@ -7921,7 +7917,7 @@ OCIS_TRACING_ENABLED: removalVersion: "" deprecationInfo: "" OCIS_TRACING_ENDPOINT: - name: OCIS_TRACING_ENDPOINT;FRONTEND_TRACING_ENDPOINT + name: OCIS_TRACING_ENDPOINT;THUMBNAILS_TRACING_ENDPOINT defaultValue: "" type: string description: The endpoint of the tracing agent. @@ -7930,7 +7926,7 @@ OCIS_TRACING_ENDPOINT: removalVersion: "" deprecationInfo: "" OCIS_TRACING_TYPE: - name: OCIS_TRACING_TYPE;FRONTEND_TRACING_TYPE + name: OCIS_TRACING_TYPE;THUMBNAILS_TRACING_TYPE defaultValue: "" type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. @@ -7943,13 +7939,13 @@ OCIS_TRANSFER_SECRET: name: OCIS_TRANSFER_SECRET defaultValue: "" type: string - description: Transfer secret for signing file up- and download requests. + description: The storage transfer secret. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_TRANSLATION_PATH: - name: OCIS_TRANSLATION_PATH;NOTIFICATIONS_TRANSLATION_PATH + name: OCIS_TRANSLATION_PATH;USERLOG_TRANSLATION_PATH defaultValue: "" type: string description: (optional) Set this to a path with custom translations to overwrite @@ -7960,10 +7956,10 @@ OCIS_TRANSLATION_PATH: removalVersion: "" deprecationInfo: "" OCIS_URL: - name: OCIS_URL;FRONTEND_PUBLIC_URL + name: OCIS_URL;OCIS_OIDC_ISSUER;IDP_ISS defaultValue: https://localhost:9200 type: string - description: The public facing URL of the oCIS frontend. + description: The OIDC issuer URL to use. introductionVersion: "" deprecationVersion: "" removalVersion: "" diff --git a/docs/helpers/markdowncreation.go b/docs/helpers/markdowncreation.go index 2893b655f2..2ae8b98ada 100644 --- a/docs/helpers/markdowncreation.go +++ b/docs/helpers/markdowncreation.go @@ -53,7 +53,7 @@ func generateMarkdown(filepath string, servicename string) error { Content: fmt.Sprintf(_configMarkdown, servicename, servicename), }) - tpl := template.Must(template.ParseFiles("index.tmpl")) + tpl := template.Must(template.ParseFiles("templates/index.tmpl")) b := bytes.NewBuffer(nil) if err := tpl.Execute(b, map[string]interface{}{ "ServiceName": head.Header, From ee15599db17e88f622792beeb4a90fed5177e9a5 Mon Sep 17 00:00:00 2001 From: Christian Richter Date: Wed, 20 Mar 2024 15:50:02 +0100 Subject: [PATCH 07/10] fix nilpointer in template Signed-off-by: Christian Richter --- docs/helpers/env_vars.yaml | 520 ++++++++++++++---- .../templates/envar-delta-table.go.tmpl | 2 +- 2 files changed, 421 insertions(+), 101 deletions(-) diff --git a/docs/helpers/env_vars.yaml b/docs/helpers/env_vars.yaml index c0c65f7f68..7cf62b3dd0 100644 --- a/docs/helpers/env_vars.yaml +++ b/docs/helpers/env_vars.yaml @@ -2078,6 +2078,15 @@ CLIENTLOG_JWT_SECRET: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +CLIENTLOG_REVA_GATEWAY: + name: OCIS_REVA_GATEWAY;CLIENTLOG_REVA_GATEWAY + defaultValue: com.owncloud.api.gateway + type: string + description: CS3 gateway used to look up user metadata + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" CLIENTLOG_SERVICE_ACCOUNT_ID: name: OCIS_SERVICE_ACCOUNT_ID;CLIENTLOG_SERVICE_ACCOUNT_ID defaultValue: "" @@ -2540,8 +2549,8 @@ FRONTEND_CORS_ALLOW_HEADERS: deprecationInfo: "" FRONTEND_CORS_ALLOW_METHODS: name: OCIS_CORS_ALLOW_METHODS;FRONTEND_CORS_ALLOW_METHODS - defaultValue: '[OPTIONS HEAD GET PUT POST DELETE MKCOL PROPFIND PROPPATCH MOVE COPY - REPORT SEARCH]' + defaultValue: '[OPTIONS HEAD GET PUT POST PATCH DELETE MKCOL PROPFIND PROPPATCH + MOVE COPY REPORT SEARCH]' type: '[]string' description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. @@ -4475,6 +4484,15 @@ GRAPH_SPACES_GROUPS_CACHE_TTL: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +GRAPH_SPACES_STORAGE_USERS_ADDRESS: + name: GRAPH_SPACES_STORAGE_USERS_ADDRESS + defaultValue: com.owncloud.api.storage-users + type: string + description: The address of the storage-users service. + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" GRAPH_SPACES_USERS_CACHE_TTL: name: GRAPH_SPACES_USERS_CACHE_TTL defaultValue: "60000000000" @@ -5089,10 +5107,10 @@ IDM_ADMIN_USER_ID: removalVersion: "" deprecationInfo: "" IDM_CREATE_DEMO_USERS: - name: SETTINGS_SETUP_DEFAULT_ASSIGNMENTS;IDM_CREATE_DEMO_USERS + name: IDM_CREATE_DEMO_USERS defaultValue: "false" type: bool - description: The default role assignments the demo users should be setup. + description: Flag to enable or disable the creation of the demo users. introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -6864,7 +6882,7 @@ OCDAV_WEBDAV_NAMESPACE: removalVersion: "" deprecationInfo: "" OCIS_ADMIN_USER_ID: - name: OCIS_ADMIN_USER_ID;SETTINGS_ADMIN_USER_ID + name: OCIS_ADMIN_USER_ID;IDM_ADMIN_USER_ID defaultValue: "" type: string description: ID of the user that should receive admin privileges. Consider that @@ -6884,28 +6902,28 @@ OCIS_ASYNC_UPLOADS: removalVersion: "" deprecationInfo: "" OCIS_CACHE_AUTH_PASSWORD: - name: OCIS_CACHE_AUTH_PASSWORD;GATEWAY_CREATE_HOME_CACHE_AUTH_PASSWORD + name: OCIS_CACHE_AUTH_PASSWORD;STORAGE_SYSTEM_CACHE_AUTH_PASSWORD defaultValue: "" type: string - description: The password to use for authentication. Only applies when store type - 'nats-js-kv' is configured. + description: Password for the configured store. Only applies when store type 'nats-js-kv' + is configured. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_AUTH_USERNAME: - name: OCIS_CACHE_AUTH_USERNAME;GATEWAY_CREATE_HOME_CACHE_AUTH_USERNAME + name: OCIS_CACHE_AUTH_USERNAME;STORAGE_SYSTEM_CACHE_AUTH_USERNAME defaultValue: "" type: string - description: The username to use for authentication. Only applies when store type - 'nats-js-kv' is configured. + description: Username for the configured store. Only applies when store type 'nats-js-kv' + is configured. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_DATABASE: name: OCIS_CACHE_DATABASE - defaultValue: cache-createhome + defaultValue: storage-system type: string description: The database name the configured store should use. introductionVersion: "" @@ -6913,28 +6931,28 @@ OCIS_CACHE_DATABASE: removalVersion: "" deprecationInfo: "" OCIS_CACHE_DISABLE_PERSISTENCE: - name: OCIS_CACHE_DISABLE_PERSISTENCE;GATEWAY_CREATE_HOME_CACHE_DISABLE_PERSISTENCE + name: OCIS_CACHE_DISABLE_PERSISTENCE;STORAGE_SYSTEM_CACHE_DISABLE_PERSISTENCE defaultValue: "false" type: bool - description: Disables persistence of the create home cache. Only applies when store - type 'nats-js-kv' is configured. Defaults to false. + description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' + is configured. Defaults to false. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_SIZE: - name: OCIS_CACHE_SIZE;GATEWAY_CREATE_HOME_CACHE_SIZE + name: OCIS_CACHE_SIZE;STORAGE_SYSTEM_CACHE_SIZE defaultValue: "0" type: int - description: The maximum quantity of items in the cache. Only applies when store - type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package - though not exclicitely set as default. + description: The maximum quantity of items in the user info cache. Only applies + when store type 'ocmem' is configured. Defaults to 512 which is derived from the + ocmem package though not exclicitely set as default. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_STORE: - name: OCIS_CACHE_STORE;GATEWAY_CREATE_HOME_CACHE_STORE + name: OCIS_CACHE_STORE;STORAGE_SYSTEM_CACHE_STORE defaultValue: memory type: string description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', @@ -6944,7 +6962,7 @@ OCIS_CACHE_STORE: removalVersion: "" deprecationInfo: "" OCIS_CACHE_STORE_NODES: - name: OCIS_CACHE_STORE_NODES;GATEWAY_CREATE_HOME_CACHE_STORE_NODES + name: OCIS_CACHE_STORE_NODES;STORAGE_SYSTEM_CACHE_STORE_NODES defaultValue: '[127.0.0.1:9233]' type: '[]string' description: A list of nodes to access the configured store. This has no effect @@ -6956,18 +6974,18 @@ OCIS_CACHE_STORE_NODES: removalVersion: "" deprecationInfo: "" OCIS_CACHE_TTL: - name: OCIS_CACHE_TTL;GATEWAY_CREATE_HOME_CACHE_TTL - defaultValue: 5m0s + name: OCIS_CACHE_TTL;STORAGE_SYSTEM_CACHE_TTL + defaultValue: 24m0s type: Duration - description: Default time to live for user info in the cache. Only applied when - access tokens has no expiration. See the Environment Variable Types description + description: Default time to live for user info in the user info cache. Only applied + when access tokens has no expiration. See the Environment Variable Types description for more details. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_CREDENTIALS: - name: OCIS_CORS_ALLOW_CREDENTIALS;SETTINGS_CORS_ALLOW_CREDENTIALS + name: OCIS_CORS_ALLOW_CREDENTIALS;USERLOG_CORS_ALLOW_CREDENTIALS defaultValue: "true" type: bool description: 'Allow credentials for CORS.See following chapter for more details: @@ -6977,8 +6995,9 @@ OCIS_CORS_ALLOW_CREDENTIALS: removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_HEADERS: - name: OCIS_CORS_ALLOW_HEADERS;SETTINGS_CORS_ALLOW_HEADERS - defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id]' + name: OCIS_CORS_ALLOW_HEADERS;USERLOG_CORS_ALLOW_HEADERS + defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id + Ocs-Apirequest]' type: '[]string' description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. @@ -6988,8 +7007,8 @@ OCIS_CORS_ALLOW_HEADERS: removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_METHODS: - name: OCIS_CORS_ALLOW_METHODS;SETTINGS_CORS_ALLOW_METHODS - defaultValue: '[GET POST PUT PATCH DELETE OPTIONS]' + name: OCIS_CORS_ALLOW_METHODS;USERLOG_CORS_ALLOW_METHODS + defaultValue: '[GET]' type: '[]string' description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. @@ -6999,7 +7018,7 @@ OCIS_CORS_ALLOW_METHODS: removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_ORIGINS: - name: OCIS_CORS_ALLOW_ORIGINS;SETTINGS_CORS_ALLOW_ORIGINS + name: OCIS_CORS_ALLOW_ORIGINS;USERLOG_CORS_ALLOW_ORIGINS defaultValue: '[*]' type: '[]string' description: 'A list of allowed CORS origins. See following chapter for more details: @@ -7009,6 +7028,30 @@ OCIS_CORS_ALLOW_ORIGINS: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +OCIS_CORS_EXPOSE_HEADERS: + name: OCIS_CORS_EXPOSE_HEADERS;STORAGE_USERS_CORS_EXPOSE_HEADERS + defaultValue: '[Upload-Offset Location Upload-Length Tus-Version Tus-Resumable Tus-Max-Size + Tus-Extension Upload-Metadata Upload-Defer-Length Upload-Concat Upload-Incomplete + Upload-Draft-Interop-Version]' + type: '[]string' + description: 'A list of exposed CORS headers. See following chapter for more details: + *Access-Control-Expose-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers. + See the Environment Variable Types description for more details.' + introductionVersion: pre5.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCIS_CORS_MAX_AGE: + name: OCIS_CORS_MAX_AGE;STORAGE_USERS_CORS_MAX_AGE + defaultValue: "86400" + type: uint + description: 'The max cache duration of preflight headers. See following chapter + for more details: *Access-Control-Max-Age* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age. + See the Environment Variable Types description for more details.' + introductionVersion: pre5.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" OCIS_DECOMPOSEDFS_METADATA_BACKEND: name: OCIS_DECOMPOSEDFS_METADATA_BACKEND;STORAGE_SYSTEM_OCIS_METADATA_BACKEND defaultValue: messagepack @@ -7072,7 +7115,7 @@ OCIS_DISABLE_SSE,USERLOG_DISABLE_SSE: removalVersion: "" deprecationInfo: "" OCIS_EDITION: - name: OCIS_EDITION;FRONTEND_EDITION + name: OCIS_EDITION;OCDAV_EDITION defaultValue: Community type: string description: "" @@ -7100,7 +7143,7 @@ OCIS_ENABLE_RESHARING: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_AUTH_PASSWORD: - name: OCIS_EVENTS_AUTH_PASSWORD;SEARCH_EVENTS_AUTH_PASSWORD + name: OCIS_EVENTS_AUTH_PASSWORD;USERLOG_EVENTS_AUTH_PASSWORD defaultValue: "" type: string description: The password to authenticate with the events broker. The events broker @@ -7110,7 +7153,7 @@ OCIS_EVENTS_AUTH_PASSWORD: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_AUTH_USERNAME: - name: OCIS_EVENTS_AUTH_USERNAME;SEARCH_EVENTS_AUTH_USERNAME + name: OCIS_EVENTS_AUTH_USERNAME;USERLOG_EVENTS_AUTH_USERNAME defaultValue: "" type: string description: The username to authenticate with the events broker. The events broker @@ -7120,7 +7163,7 @@ OCIS_EVENTS_AUTH_USERNAME: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_CLUSTER: - name: OCIS_EVENTS_CLUSTER;SEARCH_EVENTS_CLUSTER + name: OCIS_EVENTS_CLUSTER;USERLOG_EVENTS_CLUSTER defaultValue: ocis-cluster type: string description: The clusterID of the event system. The event system is the message @@ -7131,7 +7174,7 @@ OCIS_EVENTS_CLUSTER: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_ENABLE_TLS: - name: OCIS_EVENTS_ENABLE_TLS;SEARCH_EVENTS_ENABLE_TLS + name: OCIS_EVENTS_ENABLE_TLS;NATS_EVENTS_ENABLE_TLS defaultValue: "false" type: bool description: Enable TLS for the connection to the events broker. The events broker @@ -7141,7 +7184,7 @@ OCIS_EVENTS_ENABLE_TLS: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_ENDPOINT: - name: OCIS_EVENTS_ENDPOINT;SEARCH_EVENTS_ENDPOINT + name: OCIS_EVENTS_ENDPOINT;USERLOG_EVENTS_ENDPOINT defaultValue: 127.0.0.1:9233 type: string description: The address of the event system. The event system is the message queuing @@ -7151,11 +7194,11 @@ OCIS_EVENTS_ENDPOINT: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE: - name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;SEARCH_EVENTS_TLS_ROOT_CA_CERTIFICATE + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;USERLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE defaultValue: "" type: string description: The root CA certificate used to validate the server's TLS certificate. - If provided SEARCH_EVENTS_TLS_INSECURE will be seen as false. + If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -7233,7 +7276,7 @@ OCIS_INSECURE: removalVersion: "" deprecationInfo: "" OCIS_JWT_SECRET: - name: OCIS_JWT_SECRET;SEARCH_JWT_SECRET + name: OCIS_JWT_SECRET;AUTH_MACHINE_JWT_SECRET defaultValue: "" type: string description: The secret to mint and validate jwt tokens. @@ -7242,7 +7285,7 @@ OCIS_JWT_SECRET: removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_BASE_PATH: - name: OCIS_KEYCLOAK_BASE_PATH;GRAPH_KEYCLOAK_BASE_PATH + name: OCIS_KEYCLOAK_BASE_PATH;INVITATIONS_KEYCLOAK_BASE_PATH defaultValue: "" type: string description: The URL to access keycloak. @@ -7251,16 +7294,16 @@ OCIS_KEYCLOAK_BASE_PATH: removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_CLIENT_ID: - name: OCIS_KEYCLOAK_CLIENT_ID;GRAPH_KEYCLOAK_CLIENT_ID + name: OCIS_KEYCLOAK_CLIENT_ID;INVITATIONS_KEYCLOAK_CLIENT_ID defaultValue: "" type: string - description: The client id to authenticate with keycloak. + description: The client ID to authenticate with keycloak. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_CLIENT_REALM: - name: OCIS_KEYCLOAK_CLIENT_REALM;GRAPH_KEYCLOAK_CLIENT_REALM + name: OCIS_KEYCLOAK_CLIENT_REALM;INVITATIONS_KEYCLOAK_CLIENT_REALM defaultValue: "" type: string description: The realm the client is defined in. @@ -7269,7 +7312,7 @@ OCIS_KEYCLOAK_CLIENT_REALM: removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_CLIENT_SECRET: - name: OCIS_KEYCLOAK_CLIENT_SECRET;GRAPH_KEYCLOAK_CLIENT_SECRET + name: OCIS_KEYCLOAK_CLIENT_SECRET;INVITATIONS_KEYCLOAK_CLIENT_SECRET defaultValue: "" type: string description: The client secret to use in authentication. @@ -7278,7 +7321,7 @@ OCIS_KEYCLOAK_CLIENT_SECRET: removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY: - name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;GRAPH_KEYCLOAK_INSECURE_SKIP_VERIFY + name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;INVITATIONS_KEYCLOAK_INSECURE_SKIP_VERIFY defaultValue: "false" type: bool description: Disable TLS certificate validation for Keycloak connections. Do not @@ -7288,7 +7331,7 @@ OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY: removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_USER_REALM: - name: OCIS_KEYCLOAK_USER_REALM;GRAPH_KEYCLOAK_USER_REALM + name: OCIS_KEYCLOAK_USER_REALM;INVITATIONS_KEYCLOAK_USER_REALM defaultValue: "" type: string description: The realm users are defined. @@ -7297,8 +7340,8 @@ OCIS_KEYCLOAK_USER_REALM: removalVersion: "" deprecationInfo: "" OCIS_LDAP_BIND_DN: - name: OCIS_LDAP_BIND_DN;IDP_LDAP_BIND_DN - defaultValue: uid=idp,ou=sysusers,o=libregraph-idm + name: OCIS_LDAP_BIND_DN;GROUPS_LDAP_BIND_DN + defaultValue: uid=reva,ou=sysusers,o=libregraph-idm type: string description: LDAP DN to use for simple bind authentication with the target LDAP server. @@ -7307,7 +7350,7 @@ OCIS_LDAP_BIND_DN: removalVersion: "" deprecationInfo: "" OCIS_LDAP_BIND_PASSWORD: - name: OCIS_LDAP_BIND_PASSWORD;IDP_LDAP_BIND_PASSWORD + name: OCIS_LDAP_BIND_PASSWORD;GROUPS_LDAP_BIND_PASSWORD defaultValue: "" type: string description: Password to use for authenticating the 'bind_dn'. @@ -7316,31 +7359,31 @@ OCIS_LDAP_BIND_PASSWORD: removalVersion: "" deprecationInfo: "" OCIS_LDAP_CACERT: - name: OCIS_LDAP_CACERT;IDP_LDAP_TLS_CACERT + name: OCIS_LDAP_CACERT;GROUPS_LDAP_CACERT defaultValue: /var/lib/ocis/idm/ldap.crt type: string description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root - directory derives from $OCIS_BASE_DATA_PATH:/idp. + directory derives from $OCIS_BASE_DATA_PATH:/idm. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_DISABLE_USER_MECHANISM: - name: OCIS_LDAP_DISABLE_USER_MECHANISM;GRAPH_DISABLE_USER_MECHANISM + name: OCIS_LDAP_DISABLE_USER_MECHANISM;AUTH_BASIC_DISABLE_USER_MECHANISM defaultValue: attribute type: string - description: An option to control the behavior for disabling users. Supported options + description: An option to control the behavior for disabling users. Valid options are 'none', 'attribute' and 'group'. If set to 'group', disabling a user via API will add the user to the configured group for disabled users, if set to 'attribute' this will be done in the ldap user entry, if set to 'none' the disable request - is not processed. Default is 'attribute'. + is not processed. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_DISABLED_USERS_GROUP_DN: - name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;GRAPH_DISABLED_USERS_GROUP_DN + name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;AUTH_BASIC_DISABLED_USERS_GROUP_DN defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm type: string description: The distinguished name of the group to which added users will be classified @@ -7446,7 +7489,7 @@ OCIS_LDAP_GROUP_SCOPE: removalVersion: "" deprecationInfo: "" OCIS_LDAP_INSECURE: - name: OCIS_LDAP_INSECURE;IDP_INSECURE + name: OCIS_LDAP_INSECURE;GROUPS_LDAP_INSECURE defaultValue: "false" type: bool description: Disable TLS certificate validation for the LDAP connections. Do not @@ -7468,16 +7511,17 @@ OCIS_LDAP_SERVER_WRITE_ENABLED: removalVersion: "" deprecationInfo: "" OCIS_LDAP_URI: - name: OCIS_LDAP_URI;IDP_LDAP_URI + name: OCIS_LDAP_URI;GROUPS_LDAP_URI defaultValue: ldaps://localhost:9235 type: string - description: Url of the LDAP service to use as IDP. + description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' + and 'ldap://' introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_BASE_DN: - name: OCIS_LDAP_USER_BASE_DN;IDP_LDAP_BASE_DN + name: OCIS_LDAP_USER_BASE_DN;GROUPS_LDAP_USER_BASE_DN defaultValue: ou=users,o=libregraph-idm type: string description: Search base DN for looking up LDAP users. @@ -7495,7 +7539,7 @@ OCIS_LDAP_USER_ENABLED_ATTRIBUTE: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_FILTER: - name: OCIS_LDAP_USER_FILTER;IDP_LDAP_FILTER + name: OCIS_LDAP_USER_FILTER;GROUPS_LDAP_USER_FILTER defaultValue: "" type: string description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. @@ -7504,10 +7548,11 @@ OCIS_LDAP_USER_FILTER: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_OBJECTCLASS: - name: OCIS_LDAP_USER_OBJECTCLASS;IDP_LDAP_OBJECTCLASS + name: OCIS_LDAP_USER_OBJECTCLASS;GROUPS_LDAP_USER_OBJECTCLASS defaultValue: inetOrgPerson type: string - description: LDAP User ObjectClass like 'inetOrgPerson'. + description: The object class to use for users in the default user search filter + ('inetOrgPerson'). introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -7522,10 +7567,11 @@ OCIS_LDAP_USER_SCHEMA_DISPLAYNAME: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_ID: - name: OCIS_LDAP_USER_SCHEMA_ID;IDP_LDAP_UUID_ATTRIBUTE - defaultValue: ownCloudUUID + name: OCIS_LDAP_USER_SCHEMA_ID;GROUPS_LDAP_USER_SCHEMA_ID + defaultValue: ownclouduuid type: string - description: LDAP User UUID attribute like 'uid'. + description: LDAP Attribute to use as the unique id for users. This should be a + stable globally unique id like a UUID. introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -7542,10 +7588,10 @@ OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_MAIL: - name: OCIS_LDAP_USER_SCHEMA_MAIL;IDP_LDAP_EMAIL_ATTRIBUTE + name: OCIS_LDAP_USER_SCHEMA_MAIL;GROUPS_LDAP_USER_SCHEMA_MAIL defaultValue: mail type: string - description: LDAP User email attribute like 'mail'. + description: LDAP Attribute to use for the email address of users. introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -7561,16 +7607,16 @@ OCIS_LDAP_USER_SCHEMA_USER_TYPE: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_USERNAME: - name: OCIS_LDAP_USER_SCHEMA_USERNAME;IDP_LDAP_NAME_ATTRIBUTE - defaultValue: displayName + name: OCIS_LDAP_USER_SCHEMA_USERNAME;GROUPS_LDAP_USER_SCHEMA_USERNAME + defaultValue: uid type: string - description: LDAP User name attribute like 'displayName'. + description: LDAP Attribute to use for username of users. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCOPE: - name: OCIS_LDAP_USER_SCOPE;IDP_LDAP_SCOPE + name: OCIS_LDAP_USER_SCOPE;GROUPS_LDAP_USER_SCOPE defaultValue: sub type: string description: LDAP search scope to use when looking up users. Supported scopes are @@ -7617,7 +7663,7 @@ OCIS_LOG_PRETTY: removalVersion: "" deprecationInfo: "" OCIS_MACHINE_AUTH_API_KEY: - name: OCIS_MACHINE_AUTH_API_KEY;IDP_MACHINE_AUTH_API_KEY + name: OCIS_MACHINE_AUTH_API_KEY;AUTH_MACHINE_API_KEY defaultValue: "" type: string description: Machine auth API key used to validate internal requests necessary for @@ -7638,16 +7684,17 @@ OCIS_OIDC_CLIENT_ID: removalVersion: "" deprecationInfo: "" OCIS_OIDC_ISSUER: - name: OCIS_URL;OCIS_OIDC_ISSUER;IDP_ISS + name: OCIS_URL;OCIS_OIDC_ISSUER;GROUPS_IDP_URL defaultValue: https://localhost:9200 type: string - description: The OIDC issuer URL to use. + description: The identity provider value to set in the group IDs of the CS3 group + objects for groups returned by this group provider. introductionVersion: "" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST: - name: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST;SHARING_PASSWORD_POLICY_BANNED_PASSWORDS_LIST + name: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST;FRONTEND_PASSWORD_POLICY_BANNED_PASSWORDS_LIST defaultValue: "" type: string description: Path to the 'banned passwords list' file. See the documentation for @@ -7657,7 +7704,7 @@ OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_DISABLED: - name: OCIS_PASSWORD_POLICY_DISABLED;SHARING_PASSWORD_POLICY_DISABLED + name: OCIS_PASSWORD_POLICY_DISABLED;FRONTEND_PASSWORD_POLICY_DISABLED defaultValue: "false" type: bool description: Disable the password policy. Defaults to false if not set. @@ -7666,7 +7713,7 @@ OCIS_PASSWORD_POLICY_DISABLED: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_MIN_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_CHARACTERS defaultValue: "8" type: int description: Define the minimum password length. Defaults to 8 if not set. @@ -7675,7 +7722,7 @@ OCIS_PASSWORD_POLICY_MIN_CHARACTERS: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_MIN_DIGITS: - name: OCIS_PASSWORD_POLICY_MIN_DIGITS;SHARING_PASSWORD_POLICY_MIN_DIGITS + name: OCIS_PASSWORD_POLICY_MIN_DIGITS;FRONTEND_PASSWORD_POLICY_MIN_DIGITS defaultValue: "1" type: int description: Define the minimum number of digits. Defaults to 1 if not set. @@ -7684,7 +7731,7 @@ OCIS_PASSWORD_POLICY_MIN_DIGITS: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of uppercase letters. Defaults to 1 if not @@ -7694,7 +7741,7 @@ OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of characters from the special characters @@ -7704,7 +7751,7 @@ OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of lowercase letters. Defaults to 1 if not @@ -7818,7 +7865,7 @@ OCIS_REVA_GATEWAY_TLS_MODE: removalVersion: "" deprecationInfo: "" OCIS_SERVICE_ACCOUNT_ID: - name: OCIS_SERVICE_ACCOUNT_ID;SEARCH_SERVICE_ACCOUNT_ID + name: OCIS_SERVICE_ACCOUNT_ID;USERLOG_SERVICE_ACCOUNT_ID defaultValue: "" type: string description: The ID of the service account the service should use. See the 'auth-service' @@ -7828,7 +7875,7 @@ OCIS_SERVICE_ACCOUNT_ID: removalVersion: "" deprecationInfo: "" OCIS_SERVICE_ACCOUNT_SECRET: - name: OCIS_SERVICE_ACCOUNT_SECRET;SEARCH_SERVICE_ACCOUNT_SECRET + name: OCIS_SERVICE_ACCOUNT_SECRET;USERLOG_SERVICE_ACCOUNT_SECRET defaultValue: "" type: string description: The service account secret. @@ -7837,7 +7884,7 @@ OCIS_SERVICE_ACCOUNT_SECRET: removalVersion: "" deprecationInfo: "" OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD: - name: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD;SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD + name: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD;FRONTEND_OCS_PUBLIC_SHARE_MUST_HAVE_PASSWORD defaultValue: "true" type: bool description: Set this to true if you want to enforce passwords on all public shares. @@ -7846,13 +7893,11 @@ OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD: removalVersion: "" deprecationInfo: "" OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD: - name: OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD;SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD + name: OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD;FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD defaultValue: "false" type: bool description: Set this to true if you want to enforce passwords on Uploader, Editor - or Contributor shares. If not using the global OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD, - you must define the FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD in - the frontend service. + or Contributor shares. introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -7868,7 +7913,7 @@ OCIS_SPACES_MAX_QUOTA: removalVersion: "" deprecationInfo: "" OCIS_SYSTEM_USER_API_KEY: - name: OCIS_SYSTEM_USER_API_KEY;SHARING_PUBLIC_CS3_SYSTEM_USER_API_KEY + name: OCIS_SYSTEM_USER_API_KEY defaultValue: "" type: string description: API key for the STORAGE-SYSTEM system user. @@ -7877,10 +7922,10 @@ OCIS_SYSTEM_USER_API_KEY: removalVersion: "" deprecationInfo: "" OCIS_SYSTEM_USER_ID: - name: OCIS_SYSTEM_USER_ID;SHARING_PUBLIC_CS3_SYSTEM_USER_ID + name: OCIS_SYSTEM_USER_ID defaultValue: "" type: string - description: ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID + description: ID of the oCIS storage-system system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format. @@ -7889,7 +7934,7 @@ OCIS_SYSTEM_USER_ID: removalVersion: "" deprecationInfo: "" OCIS_SYSTEM_USER_IDP: - name: OCIS_SYSTEM_USER_IDP;SHARING_PUBLIC_CS3_SYSTEM_USER_IDP + name: OCIS_SYSTEM_USER_IDP;SETTINGS_SYSTEM_USER_IDP defaultValue: internal type: string description: IDP of the oCIS STORAGE-SYSTEM system user. @@ -7939,7 +7984,7 @@ OCIS_TRANSFER_SECRET: name: OCIS_TRANSFER_SECRET defaultValue: "" type: string - description: The storage transfer secret. + description: Transfer secret for signing file up- and download requests. introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -7956,10 +8001,10 @@ OCIS_TRANSLATION_PATH: removalVersion: "" deprecationInfo: "" OCIS_URL: - name: OCIS_URL;OCIS_OIDC_ISSUER;IDP_ISS + name: OCIS_URL;OCDAV_PUBLIC_URL defaultValue: https://localhost:9200 type: string - description: The OIDC issuer URL to use. + description: URL where oCIS is reachable for users. introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -8509,6 +8554,57 @@ OCS_LOG_PRETTY: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +OCS_PRESIGNEDURL_SIGNING_KEYS_STORE: + name: OCIS_CACHE_STORE;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE + defaultValue: nats-js-kv + type: string + description: 'The type of the signing key store. Supported values are: ''redis-sentinel'' + and ''nats-js-kv''. See the text description for details.' + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_PASSWORD: + name: OCIS_CACHE_AUTH_PASSWORD;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the store. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_USERNAME: + name: OCIS_CACHE_AUTH_USERNAME;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the store. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_NODES: + name: OCIS_CACHE_STORE_NODES;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_NODES + defaultValue: '[127.0.0.1:9233]' + type: '[]string' + description: A list of nodes to access the configured store. Note that the behaviour + how nodes are used is dependent on the library of the configured store. See the + Environment Variable Types description for more details. + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_TTL: + name: OCIS_CACHE_TTL;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_TTL + defaultValue: 12h0m0s + type: Duration + description: Default time to live for signing keys. See the Environment Variable + Types description for more details. + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" OCS_TRACING_COLLECTOR: name: OCIS_TRACING_COLLECTOR;OCS_TRACING_COLLECTOR defaultValue: "" @@ -9430,6 +9526,68 @@ PROXY_POLICIES_QUERY: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE: + name: OCIS_CACHE_STORE;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE + defaultValue: nats-js-kv + type: string + description: 'The type of the signing key store. Supported values are: ''redis-sentinel'', + ''nats-js-kv'' and ''ocisstoreservice'' (deprecated). See the text description + for details.' + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_PASSWORD: + name: OCIS_CACHE_AUTH_PASSWORD;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_PASSWORD + defaultValue: "" + type: string + description: The password to authenticate with the store. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_USERNAME: + name: OCIS_CACHE_AUTH_USERNAME;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_USERNAME + defaultValue: "" + type: string + description: The username to authenticate with the store. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_DISABLE_PERSISTENCE: + name: OCIS_CACHE_DISABLE_PERSISTENCE;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_DISABLE_PERSISTENCE + defaultValue: "true" + type: bool + description: Disables persistence of the store. Only applies when store type 'nats-js-kv' + is configured. Defaults to true. + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_NODES: + name: OCIS_CACHE_STORE_NODES;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_NODES + defaultValue: '[127.0.0.1:9233]' + type: '[]string' + description: A list of nodes to access the configured store. Note that the behaviour + how nodes are used is dependent on the library of the configured store. See the + Environment Variable Types description for more details. + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_TTL: + name: OCIS_CACHE_TTL;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_TTL + defaultValue: 12h0m0s + type: Duration + description: Default time to live for signing keys. See the Environment Variable + Types description for more details. + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" PROXY_ROLE_ASSIGNMENT_DRIVER: name: PROXY_ROLE_ASSIGNMENT_DRIVER defaultValue: default @@ -10286,6 +10444,15 @@ SHARING_DEBUG_ZPAGES: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +SHARING_ENABLE_RESHARING: + name: OCIS_ENABLE_RESHARING;SHARING_ENABLE_RESHARING + defaultValue: "true" + type: bool + description: Changing this value is NOT supported. Enables the support for resharing. + introductionVersion: "5.0" + deprecationVersion: "5.0" + removalVersion: "" + deprecationInfo: Resharing will be removed in the future. SHARING_EVENTS_AUTH_PASSWORD: name: OCIS_EVENTS_AUTH_PASSWORD;SHARING_EVENTS_AUTH_PASSWORD defaultValue: "" @@ -10538,7 +10705,7 @@ SHARING_PUBLIC_DRIVER: defaultValue: jsoncs3 type: string description: Driver to be used to persist public shares. Supported values are 'jsoncs3', - 'json' and 'cs3'. + 'json' and 'cs3' (deprecated). introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -10706,7 +10873,7 @@ SHARING_USER_DRIVER: defaultValue: jsoncs3 type: string description: Driver to be used to persist shares. Supported values are 'jsoncs3', - 'json', 'cs3' and 'owncloudsql'. + 'json', 'cs3' (deprecated) and 'owncloudsql'. introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -11761,6 +11928,75 @@ STORAGE_USERS_CLI_MAX_ATTEMPTS_RENAME_FILE: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +STORAGE_USERS_CORS_ALLOW_CREDENTIALS: + name: OCIS_CORS_ALLOW_CREDENTIALS;STORAGE_USERS_CORS_ALLOW_CREDENTIALS + defaultValue: "true" + type: bool + description: 'Allow credentials for CORS.See following chapter for more details: + *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' + introductionVersion: pre5.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_CORS_ALLOW_HEADERS: + name: OCIS_CORS_ALLOW_HEADERS;STORAGE_USERS_CORS_ALLOW_HEADERS + defaultValue: '[Authorization Origin X-Requested-With X-Request-Id X-HTTP-Method-Override + Content-Type Upload-Length Upload-Offset Tus-Resumable Upload-Metadata Upload-Defer-Length + Upload-Concat Upload-Incomplete Upload-Draft-Interop-Version]' + type: '[]string' + description: 'A list of allowed CORS headers. See following chapter for more details: + *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. + See the Environment Variable Types description for more details.' + introductionVersion: pre5.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_CORS_ALLOW_METHODS: + name: OCIS_CORS_ALLOW_METHODS;STORAGE_USERS_CORS_ALLOW_METHODS + defaultValue: '[POST HEAD PATCH OPTIONS GET DELETE]' + type: '[]string' + description: 'A list of allowed CORS methods. See following chapter for more details: + *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. + See the Environment Variable Types description for more details.' + introductionVersion: pre5.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_CORS_ALLOW_ORIGINS: + name: OCIS_CORS_ALLOW_ORIGINS;STORAGE_USERS_CORS_ALLOW_ORIGINS + defaultValue: '[*]' + type: '[]string' + description: 'A list of allowed CORS origins. See following chapter for more details: + *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. + See the Environment Variable Types description for more details.' + introductionVersion: pre5.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_CORS_EXPOSE_HEADERS: + name: OCIS_CORS_EXPOSE_HEADERS;STORAGE_USERS_CORS_EXPOSE_HEADERS + defaultValue: '[Upload-Offset Location Upload-Length Tus-Version Tus-Resumable Tus-Max-Size + Tus-Extension Upload-Metadata Upload-Defer-Length Upload-Concat Upload-Incomplete + Upload-Draft-Interop-Version]' + type: '[]string' + description: 'A list of exposed CORS headers. See following chapter for more details: + *Access-Control-Expose-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers. + See the Environment Variable Types description for more details.' + introductionVersion: pre5.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_CORS_MAX_AGE: + name: OCIS_CORS_MAX_AGE;STORAGE_USERS_CORS_MAX_AGE + defaultValue: "86400" + type: uint + description: 'The max cache duration of preflight headers. See following chapter + for more details: *Access-Control-Max-Age* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age. + See the Environment Variable Types description for more details.' + introductionVersion: pre5.0 + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" STORAGE_USERS_DATA_GATEWAY_URL: name: STORAGE_USERS_DATA_GATEWAY_URL defaultValue: https://localhost:9200/data @@ -12175,6 +12411,16 @@ STORAGE_USERS_LOG_PRETTY: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +STORAGE_USERS_MACHINE_AUTH_API_KEY: + name: OCIS_MACHINE_AUTH_API_KEY;STORAGE_USERS_MACHINE_AUTH_API_KEY + defaultValue: "" + type: string + description: Machine auth API key used to validate internal requests necessary for + the access to resources from other services. + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" STORAGE_USERS_MOUNT_ID: name: STORAGE_USERS_MOUNT_ID defaultValue: "" @@ -12564,6 +12810,60 @@ STORAGE_USERS_S3NG_PROPAGATOR: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +STORAGE_USERS_S3NG_PUT_OBJECT_CONCURRENT_STREAM_PARTS: + name: STORAGE_USERS_S3NG_PUT_OBJECT_CONCURRENT_STREAM_PARTS + defaultValue: "true" + type: bool + description: Always precreate parts when copying objects to S3. + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_PUT_OBJECT_DISABLE_CONTENT_SHA256: + name: STORAGE_USERS_S3NG_PUT_OBJECT_DISABLE_CONTENT_SHA256 + defaultValue: "false" + type: bool + description: Disable sending content sha256 when copying objects to S3. + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_PUT_OBJECT_DISABLE_MULTIPART: + name: STORAGE_USERS_S3NG_PUT_OBJECT_DISABLE_MULTIPART + defaultValue: "true" + type: bool + description: Disable multipart uploads when copying objects to S3 + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_PUT_OBJECT_NUM_THREADS: + name: STORAGE_USERS_S3NG_PUT_OBJECT_NUM_THREADS + defaultValue: "4" + type: uint + description: Number of concurrent uploads to use when copying objects to S3. + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_PUT_OBJECT_PART_SIZE: + name: STORAGE_USERS_S3NG_PUT_OBJECT_PART_SIZE + defaultValue: "0" + type: uint64 + description: Part size for concurrent uploads to S3. + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +STORAGE_USERS_S3NG_PUT_OBJECT_SEND_CONTENT_MD5: + name: STORAGE_USERS_S3NG_PUT_OBJECT_SEND_CONTENT_MD5 + defaultValue: "true" + type: bool + description: Send a Content-MD5 header when copying objects to S3. + introductionVersion: "5.0" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" STORAGE_USERS_S3NG_REGION: name: STORAGE_USERS_S3NG_REGION defaultValue: default @@ -12681,7 +12981,7 @@ STORAGE_USERS_TRANSFER_EXPIRES: name: STORAGE_USERS_TRANSFER_EXPIRES defaultValue: "86400" type: int64 - description: the time after which the token for upload postprocessing expires + description: The time after which the token for upload postprocessing expires introductionVersion: "" deprecationVersion: "" removalVersion: "" @@ -13960,9 +14260,29 @@ USERS_TRACING_TYPE: deprecationVersion: "" removalVersion: "" deprecationInfo: "" +WEB_ASSET_APPS_PATH: + name: WEB_ASSET_APPS_PATH + defaultValue: /var/lib/ocis/web/assets/apps + type: string + description: Serve ownCloud Web apps assets from a path on the filesystem instead + of the builtin assets. + introductionVersion: "5.1" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" +WEB_ASSET_CORE_PATH: + name: WEB_ASSET_CORE_PATH + defaultValue: /var/lib/ocis/web/assets/core + type: string + description: Serve ownCloud Web assets from a path on the filesystem instead of + the builtin assets. + introductionVersion: "5.1" + deprecationVersion: "" + removalVersion: "" + deprecationInfo: "" WEB_ASSET_PATH: name: WEB_ASSET_PATH - defaultValue: /var/lib/ocis/web/assets + defaultValue: "" type: string description: Serve ownCloud Web assets from a path on the filesystem instead of the builtin assets. diff --git a/docs/helpers/templates/envar-delta-table.go.tmpl b/docs/helpers/templates/envar-delta-table.go.tmpl index c33fb7ee78..fe173e6a57 100644 --- a/docs/helpers/templates/envar-delta-table.go.tmpl +++ b/docs/helpers/templates/envar-delta-table.go.tmpl @@ -55,7 +55,7 @@ func main() { for _, field := range fields { variants := strings.Split(field.Name, ";") for _, variant := range variants { - if configFields[variant].Name == "" { + if (configFields[variant] != nil && configFields[variant].Name == "") || configFields[variant] == nil { configFields[variant] = &field } else { fmt.Printf("%v, duplicate key, merging\n", variant) From a9a87433722f742202feedea46ed1c10ad77ede3 Mon Sep 17 00:00:00 2001 From: Christian Richter Date: Wed, 20 Mar 2024 17:01:04 +0100 Subject: [PATCH 08/10] fix typos Signed-off-by: Christian Richter --- docs/helpers/main.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/helpers/main.go b/docs/helpers/main.go index a10faadabe..c0770d066f 100644 --- a/docs/helpers/main.go +++ b/docs/helpers/main.go @@ -21,7 +21,7 @@ func main() { if len(os.Args) != 4 { fmt.Println("Needs two arguments: env-var-delta-table ") fmt.Println("Example: env-var-delta-table v5.0.0 v6.0.0") - fmt.Println("Will not generate usable results vor versions Prior to v5.0.0") + fmt.Println("Will not generate usable results for versions Prior to v5.0.0") } else { RenderEnvVarDeltaTable(os.Args) } @@ -33,7 +33,7 @@ func main() { case "help": fallthrough default: - fmt.Println("Usage: env-var-delta-table [templates|rogue|globals|service-index|env-var-delta-table|all|help]") + fmt.Printf("Usage: %s [templates|rogue|globals|service-index|env-var-delta-table|all|help]\n", os.Args[0]) } } else { // Left here, even though present in the switch case, for backwards compatibility From de1d25ba06b1a18442b5fa68e18aa58a05c6f91a Mon Sep 17 00:00:00 2001 From: Christian Richter Date: Wed, 20 Mar 2024 17:03:41 +0100 Subject: [PATCH 09/10] commit initial env_var db Signed-off-by: Christian Richter --- docs/helpers/env_vars.yaml | 3685 ++++++++++++++++++------------------ 1 file changed, 1842 insertions(+), 1843 deletions(-) diff --git a/docs/helpers/env_vars.yaml b/docs/helpers/env_vars.yaml index 7cf62b3dd0..70682e3148 100644 --- a/docs/helpers/env_vars.yaml +++ b/docs/helpers/env_vars.yaml @@ -4,7 +4,7 @@ ANTIVIRUS_CLAMAV_SOCKET: type: string description: The socket clamav is running on. Note the default value is an example which needs adaption according your OS. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14,7 +14,7 @@ ANTIVIRUS_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -23,7 +23,7 @@ ANTIVIRUS_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -33,7 +33,7 @@ ANTIVIRUS_DEBUG_SCAN_OUTCOME: type: string description: 'A predefined outcome for virus scanning, FOR DEBUG PURPOSES ONLY! (example values: ''found,infected'')' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -42,7 +42,7 @@ ANTIVIRUS_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -52,7 +52,7 @@ ANTIVIRUS_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -62,7 +62,7 @@ ANTIVIRUS_EVENTS_AUTH_PASSWORD: type: string description: The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -72,7 +72,7 @@ ANTIVIRUS_EVENTS_AUTH_USERNAME: type: string description: The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -83,7 +83,7 @@ ANTIVIRUS_EVENTS_CLUSTER: description: The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -93,7 +93,7 @@ ANTIVIRUS_EVENTS_ENABLE_TLS: type: bool description: Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -103,7 +103,7 @@ ANTIVIRUS_EVENTS_ENDPOINT: type: string description: The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -112,7 +112,7 @@ ANTIVIRUS_EVENTS_TLS_INSECURE: defaultValue: "false" type: bool description: Whether to verify the server TLS certificates. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -122,7 +122,7 @@ ANTIVIRUS_EVENTS_TLS_ROOT_CA_CERTIFICATE: type: string description: The root CA certificate used to validate the server's TLS certificate. If provided ANTIVIRUS_EVENTS_TLS_INSECURE will be seen as false. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -132,7 +132,7 @@ ANTIVIRUS_ICAP_SCAN_TIMEOUT: type: Duration description: Scan timeout for the ICAP client. Defaults to '5m' (5 minutes). See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -141,7 +141,7 @@ ANTIVIRUS_ICAP_SERVICE: defaultValue: avscan type: string description: The name of the ICAP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -150,7 +150,7 @@ ANTIVIRUS_ICAP_TIMEOUT: defaultValue: "0" type: int64 description: Timeout for the ICAP client. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "5.0" removalVersion: "6.0" deprecationInfo: Changing the envvar type for consistency reasons. @@ -159,7 +159,7 @@ ANTIVIRUS_ICAP_URL: defaultValue: icap://127.0.0.1:1344 type: string description: URL of the ICAP server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -172,7 +172,7 @@ ANTIVIRUS_INFECTED_FILE_HANDLING: will mark the file as infected but continues further processing. Abort will keep the file in the uploads folder for further admin inspection and will not move it to its final destination.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -181,7 +181,7 @@ ANTIVIRUS_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -190,7 +190,7 @@ ANTIVIRUS_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -200,7 +200,7 @@ ANTIVIRUS_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -209,7 +209,7 @@ ANTIVIRUS_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -221,7 +221,7 @@ ANTIVIRUS_MAX_SCAN_SIZE: bytes of a file will be scanned. 0 means unlimited and is the default. Usable common abbreviations: [KB, KiB, GB, GiB, TB, TiB, PB, PiB, EB, EiB], example: 2GB.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -230,7 +230,7 @@ ANTIVIRUS_SCANNER_TYPE: defaultValue: clamav type: string description: The antivirus scanner to use. Supported values are 'clamav' and 'icap'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -240,7 +240,7 @@ ANTIVIRUS_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -249,7 +249,7 @@ ANTIVIRUS_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -258,7 +258,7 @@ ANTIVIRUS_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -268,7 +268,7 @@ ANTIVIRUS_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -278,7 +278,7 @@ APP_PROVIDER_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -287,7 +287,7 @@ APP_PROVIDER_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -296,7 +296,7 @@ APP_PROVIDER_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -306,7 +306,7 @@ APP_PROVIDER_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing traces in-memory. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -316,7 +316,7 @@ APP_PROVIDER_DRIVER: type: string description: Driver, the APP PROVIDER services uses. Only 'wopi' is supported as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -325,7 +325,7 @@ APP_PROVIDER_EXTERNAL_ADDR: defaultValue: "" type: string description: Address of the app provider, where the GATEWAY service can reach it. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -334,7 +334,7 @@ APP_PROVIDER_GRPC_ADDR: defaultValue: 127.0.0.1:9164 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -343,7 +343,7 @@ APP_PROVIDER_GRPC_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the GPRC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -352,7 +352,7 @@ APP_PROVIDER_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -361,7 +361,7 @@ APP_PROVIDER_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -370,7 +370,7 @@ APP_PROVIDER_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -380,7 +380,7 @@ APP_PROVIDER_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -389,7 +389,7 @@ APP_PROVIDER_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -401,7 +401,7 @@ APP_PROVIDER_SERVICE_NAME: than one app provider. Each app provider configured needs to be identified by a unique service name. Possible examples are: ''app-provider-collabora'', ''app-provider-onlyoffice'', ''app-provider-office365''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -411,7 +411,7 @@ APP_PROVIDER_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -420,7 +420,7 @@ APP_PROVIDER_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -429,7 +429,7 @@ APP_PROVIDER_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -439,7 +439,7 @@ APP_PROVIDER_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -448,7 +448,7 @@ APP_PROVIDER_WOPI_APP_API_KEY: defaultValue: "" type: string description: API key for the wopi app. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -457,7 +457,7 @@ APP_PROVIDER_WOPI_APP_DESKTOP_ONLY: defaultValue: "false" type: bool description: Offer this app only on desktop. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -466,7 +466,7 @@ APP_PROVIDER_WOPI_APP_ICON_URI: defaultValue: "" type: string description: URI to an app icon to be used by clients. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -475,7 +475,7 @@ APP_PROVIDER_WOPI_APP_INTERNAL_URL: defaultValue: "" type: string description: Internal URL to the app, like in your DMZ. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -484,7 +484,7 @@ APP_PROVIDER_WOPI_APP_NAME: defaultValue: "" type: string description: Human readable app name. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -493,7 +493,7 @@ APP_PROVIDER_WOPI_APP_URL: defaultValue: "" type: string description: URL for end users to access the app. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -502,7 +502,7 @@ APP_PROVIDER_WOPI_DISABLE_CHAT: defaultValue: "false" type: bool description: Disable the chat functionality of the office app. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -512,7 +512,7 @@ APP_PROVIDER_WOPI_FOLDER_URL_BASE_URL: type: string description: Base url to navigate back from the app to the containing folder in the file list. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -525,7 +525,7 @@ APP_PROVIDER_WOPI_FOLDER_URL_PATH_TEMPLATE: {{.ResourceInfo.Mtime.Seconds}}, {{.ResourceInfo.Name}}, {{.ResourceInfo.Path}}, {{.ResourceInfo.Type}}, {{.ResourceInfo.Id.SpaceId}}, {{.ResourceInfo.Id.StorageId}}, {{.ResourceInfo.Id.OpaqueId}}, {{.ResourceInfo.MimeType}} - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -535,7 +535,7 @@ APP_PROVIDER_WOPI_INSECURE: type: bool description: Disable TLS certificate validation for requests to the WOPI server and the web office application. Do not set this in production environments. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -544,7 +544,7 @@ APP_PROVIDER_WOPI_WOPI_SERVER_EXTERNAL_URL: defaultValue: "" type: string description: External url of the CS3org WOPI server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -553,7 +553,7 @@ APP_PROVIDER_WOPI_WOPI_SERVER_IOP_SECRET: defaultValue: "" type: string description: Shared secret of the CS3org WOPI server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -563,7 +563,7 @@ APP_REGISTRY_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -572,7 +572,7 @@ APP_REGISTRY_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -581,7 +581,7 @@ APP_REGISTRY_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -591,7 +591,7 @@ APP_REGISTRY_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -600,7 +600,7 @@ APP_REGISTRY_GRPC_ADDR: defaultValue: 127.0.0.1:9242 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -609,7 +609,7 @@ APP_REGISTRY_GRPC_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -618,7 +618,7 @@ APP_REGISTRY_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -627,7 +627,7 @@ APP_REGISTRY_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -636,7 +636,7 @@ APP_REGISTRY_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -646,7 +646,7 @@ APP_REGISTRY_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -655,7 +655,7 @@ APP_REGISTRY_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -665,7 +665,7 @@ APP_REGISTRY_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -674,7 +674,7 @@ APP_REGISTRY_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -683,7 +683,7 @@ APP_REGISTRY_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -693,7 +693,7 @@ APP_REGISTRY_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -703,7 +703,7 @@ AUDIT_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -712,7 +712,7 @@ AUDIT_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -721,7 +721,7 @@ AUDIT_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -731,7 +731,7 @@ AUDIT_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -741,7 +741,7 @@ AUDIT_EVENTS_AUTH_PASSWORD: type: string description: The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -751,7 +751,7 @@ AUDIT_EVENTS_AUTH_USERNAME: type: string description: The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -762,7 +762,7 @@ AUDIT_EVENTS_CLUSTER: description: The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -772,7 +772,7 @@ AUDIT_EVENTS_ENABLE_TLS: type: bool description: Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -782,7 +782,7 @@ AUDIT_EVENTS_ENDPOINT: type: string description: The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -791,7 +791,7 @@ AUDIT_EVENTS_TLS_INSECURE: defaultValue: "false" type: bool description: Whether to verify the server TLS certificates. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -801,7 +801,7 @@ AUDIT_EVENTS_TLS_ROOT_CA_CERTIFICATE: type: string description: The root CA certificate used to validate the server's TLS certificate. If provided AUDIT_EVENTS_TLS_INSECURE will be seen as false. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -810,7 +810,7 @@ AUDIT_FILEPATH: defaultValue: "" type: string description: Filepath of the logfile. Mandatory if LOG_TO_FILE is set to 'true'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -821,7 +821,7 @@ AUDIT_FORMAT: description: Log format. Supported values are '' (empty) and 'json'. Using 'json' is advised, '' (empty) renders the 'minimal' format. See the text description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -830,7 +830,7 @@ AUDIT_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -839,7 +839,7 @@ AUDIT_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -849,7 +849,7 @@ AUDIT_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -858,7 +858,7 @@ AUDIT_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -867,7 +867,7 @@ AUDIT_LOG_TO_CONSOLE: defaultValue: "true" type: bool description: Logs to stdout if set to 'true'. Independent of the LOG_TO_FILE option. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -876,7 +876,7 @@ AUDIT_LOG_TO_FILE: defaultValue: "false" type: bool description: Logs to file if set to 'true'. Independent of the LOG_TO_CONSOLE option. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -886,7 +886,7 @@ AUDIT_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -895,7 +895,7 @@ AUDIT_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -904,7 +904,7 @@ AUDIT_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -914,7 +914,7 @@ AUDIT_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -924,7 +924,7 @@ AUTH_BASIC_AUTH_MANAGER: type: string description: The authentication manager to check if credentials are valid. Supported value is 'ldap'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -934,7 +934,7 @@ AUTH_BASIC_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -943,7 +943,7 @@ AUTH_BASIC_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -952,7 +952,7 @@ AUTH_BASIC_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -962,7 +962,7 @@ AUTH_BASIC_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing traces in-memory. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -975,7 +975,7 @@ AUTH_BASIC_DISABLE_USER_MECHANISM: will add the user to the configured group for disabled users, if set to 'attribute' this will be done in the ldap user entry, if set to 'none' the disable request is not processed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -985,7 +985,7 @@ AUTH_BASIC_DISABLED_USERS_GROUP_DN: type: string description: The distinguished name of the group to which added users will be classified as disabled when 'disable_user_mechanism' is set to 'group'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -994,7 +994,7 @@ AUTH_BASIC_GRPC_ADDR: defaultValue: 127.0.0.1:9146 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1003,7 +1003,7 @@ AUTH_BASIC_GRPC_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1013,7 +1013,7 @@ AUTH_BASIC_IDP_URL: type: string description: The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1022,7 +1022,7 @@ AUTH_BASIC_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1032,7 +1032,7 @@ AUTH_BASIC_LDAP_BIND_DN: type: string description: LDAP DN to use for simple bind authentication with the target LDAP server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1041,7 +1041,7 @@ AUTH_BASIC_LDAP_BIND_PASSWORD: defaultValue: "" type: string description: Password to use for authenticating the 'bind_dn'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1052,7 +1052,7 @@ AUTH_BASIC_LDAP_CACERT: description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1061,7 +1061,7 @@ AUTH_BASIC_LDAP_GROUP_BASE_DN: defaultValue: ou=groups,o=libregraph-idm type: string description: Search base DN for looking up LDAP groups. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1070,7 +1070,7 @@ AUTH_BASIC_LDAP_GROUP_FILTER: defaultValue: "" type: string description: LDAP filter to add to the default filters for group searches. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1080,7 +1080,7 @@ AUTH_BASIC_LDAP_GROUP_OBJECTCLASS: type: string description: The object class to use for groups in the default group search filter ('groupOfNames'). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1090,7 +1090,7 @@ AUTH_BASIC_LDAP_GROUP_SCHEMA_DISPLAYNAME: type: string description: LDAP Attribute to use for the displayname of groups (often the same as groupname attribute). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1099,7 +1099,7 @@ AUTH_BASIC_LDAP_GROUP_SCHEMA_GROUPNAME: defaultValue: cn type: string description: LDAP Attribute to use for the name of groups. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1109,7 +1109,7 @@ AUTH_BASIC_LDAP_GROUP_SCHEMA_ID: type: string description: LDAP Attribute to use as the unique id for groups. This should be a stable globally unique id (e.g. a UUID). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1120,7 +1120,7 @@ AUTH_BASIC_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING: description: Set this to true if the defined 'id' attribute for groups is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute of Active Directory for the group IDs. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1129,7 +1129,7 @@ AUTH_BASIC_LDAP_GROUP_SCHEMA_MAIL: defaultValue: mail type: string description: LDAP Attribute to use for the email address of groups (can be empty). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1138,7 +1138,7 @@ AUTH_BASIC_LDAP_GROUP_SCHEMA_MEMBER: defaultValue: member type: string description: LDAP Attribute that is used for group members. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1148,7 +1148,7 @@ AUTH_BASIC_LDAP_GROUP_SCOPE: type: string description: LDAP search scope to use when looking up groups. Supported values are 'base', 'one' and 'sub'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1158,7 +1158,7 @@ AUTH_BASIC_LDAP_INSECURE: type: bool description: Disable TLS certificate validation for the LDAP connections. Do not set this in production environments. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1168,7 +1168,7 @@ AUTH_BASIC_LDAP_LOGIN_ATTRIBUTES: type: '[]string' description: A list of user object attributes that can be used for login. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1178,7 +1178,7 @@ AUTH_BASIC_LDAP_URI: type: string description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1187,7 +1187,7 @@ AUTH_BASIC_LDAP_USER_BASE_DN: defaultValue: ou=users,o=libregraph-idm type: string description: Search base DN for looking up LDAP users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1196,7 +1196,7 @@ AUTH_BASIC_LDAP_USER_ENABLED_ATTRIBUTE: defaultValue: ownCloudUserEnabled type: string description: LDAP attribute to use as a flag telling if the user is enabled or disabled. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1205,7 +1205,7 @@ AUTH_BASIC_LDAP_USER_FILTER: defaultValue: "" type: string description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1215,7 +1215,7 @@ AUTH_BASIC_LDAP_USER_OBJECTCLASS: type: string description: The object class to use for users in the default user search filter ('inetOrgPerson'). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1224,7 +1224,7 @@ AUTH_BASIC_LDAP_USER_SCHEMA_DISPLAYNAME: defaultValue: displayname type: string description: LDAP Attribute to use for the displayname of users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1234,7 +1234,7 @@ AUTH_BASIC_LDAP_USER_SCHEMA_ID: type: string description: LDAP Attribute to use as the unique ID for users. This should be a stable globally unique ID like a UUID. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1245,7 +1245,7 @@ AUTH_BASIC_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING: description: Set this to true if the defined 'ID' attribute for users is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute of Active Directory for the user IDs. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1254,7 +1254,7 @@ AUTH_BASIC_LDAP_USER_SCHEMA_MAIL: defaultValue: mail type: string description: LDAP Attribute to use for the email address of users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1263,7 +1263,7 @@ AUTH_BASIC_LDAP_USER_SCHEMA_USERNAME: defaultValue: uid type: string description: LDAP Attribute to use for username of users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1273,7 +1273,7 @@ AUTH_BASIC_LDAP_USER_SCOPE: type: string description: LDAP search scope to use when looking up users. Supported values are 'base', 'one' and 'sub'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1282,7 +1282,7 @@ AUTH_BASIC_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1291,7 +1291,7 @@ AUTH_BASIC_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1301,7 +1301,7 @@ AUTH_BASIC_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1310,7 +1310,7 @@ AUTH_BASIC_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1319,7 +1319,7 @@ AUTH_BASIC_OWNCLOUDSQL_DB_HOST: defaultValue: mysql type: string description: Hostname of the database server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1328,7 +1328,7 @@ AUTH_BASIC_OWNCLOUDSQL_DB_NAME: defaultValue: owncloud type: string description: Name of the owncloud database. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1337,7 +1337,7 @@ AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD: defaultValue: "" type: string description: Password for the database user. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1346,7 +1346,7 @@ AUTH_BASIC_OWNCLOUDSQL_DB_PORT: defaultValue: "3306" type: int description: Network port to use for the database connection. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1355,7 +1355,7 @@ AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME: defaultValue: owncloud type: string description: Database user to use for authenticating with the owncloud database. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1365,7 +1365,7 @@ AUTH_BASIC_OWNCLOUDSQL_IDP: type: string description: The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1374,7 +1374,7 @@ AUTH_BASIC_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID: defaultValue: "false" type: bool description: Join the user properties table to read user ID's. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1383,7 +1383,7 @@ AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME: defaultValue: "false" type: bool description: Join the user properties table to read usernames - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1392,7 +1392,7 @@ AUTH_BASIC_OWNCLOUDSQL_NOBODY: defaultValue: "90" type: int64 description: Fallback number if no numeric UID and GID properties are provided. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1403,7 +1403,7 @@ AUTH_BASIC_SKIP_USER_GROUPS_IN_TOKEN: description: Disables the encoding of the user's group memberships in the reva access token. This reduces the token size, especially when users are members of a large number of groups. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1413,7 +1413,7 @@ AUTH_BASIC_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1422,7 +1422,7 @@ AUTH_BASIC_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1431,7 +1431,7 @@ AUTH_BASIC_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1441,7 +1441,7 @@ AUTH_BASIC_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1451,7 +1451,7 @@ AUTH_BEARER_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1460,7 +1460,7 @@ AUTH_BEARER_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1469,7 +1469,7 @@ AUTH_BEARER_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1479,7 +1479,7 @@ AUTH_BEARER_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1488,7 +1488,7 @@ AUTH_BEARER_GRPC_ADDR: defaultValue: 127.0.0.1:9148 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1497,7 +1497,7 @@ AUTH_BEARER_GRPC_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1506,7 +1506,7 @@ AUTH_BEARER_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1515,7 +1515,7 @@ AUTH_BEARER_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1524,7 +1524,7 @@ AUTH_BEARER_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1534,7 +1534,7 @@ AUTH_BEARER_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1543,7 +1543,7 @@ AUTH_BEARER_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1552,7 +1552,7 @@ AUTH_BEARER_OIDC_GID_CLAIM: defaultValue: "" type: string description: Name of the claim, which holds the GID. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1561,7 +1561,7 @@ AUTH_BEARER_OIDC_ID_CLAIM: defaultValue: preferred_username type: string description: Name of the claim, which holds the user identifier. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1570,7 +1570,7 @@ AUTH_BEARER_OIDC_INSECURE: defaultValue: "false" type: bool description: Allow insecure connections to the OIDC issuer. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1579,7 +1579,7 @@ AUTH_BEARER_OIDC_ISSUER: defaultValue: https://localhost:9200 type: string description: URL of the OIDC issuer. It defaults to URL of the builtin IDP. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1588,7 +1588,7 @@ AUTH_BEARER_OIDC_UID_CLAIM: defaultValue: "" type: string description: Name of the claim, which holds the UID. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1599,7 +1599,7 @@ AUTH_BEARER_SKIP_USER_GROUPS_IN_TOKEN: description: Disables the encoding of the user's group memberships in the reva access token. This reduces the token size, especially when users are members of a large number of groups. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1609,7 +1609,7 @@ AUTH_BEARER_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1618,7 +1618,7 @@ AUTH_BEARER_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1627,7 +1627,7 @@ AUTH_BEARER_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1637,17 +1637,17 @@ AUTH_BEARER_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_MACHINE_API_KEY: - name: OCIS_MACHINE_AUTH_API_KEY;AUTH_MACHINE_API_KEY + name: OCIS_MACHINE_AUTH_API_KEY;PROXY_MACHINE_AUTH_API_KEY defaultValue: "" type: string - description: Machine auth API key used to validate internal requests necessary for - the access to resources from other services. - introductionVersion: "" + description: Machine auth API key used to validate internal requests necessary to + access resources from other services. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1657,7 +1657,7 @@ AUTH_MACHINE_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1666,7 +1666,7 @@ AUTH_MACHINE_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1675,7 +1675,7 @@ AUTH_MACHINE_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1685,7 +1685,7 @@ AUTH_MACHINE_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1694,7 +1694,7 @@ AUTH_MACHINE_GRPC_ADDR: defaultValue: 127.0.0.1:9166 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1703,53 +1703,53 @@ AUTH_MACHINE_GRPC_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_MACHINE_JWT_SECRET: - name: OCIS_JWT_SECRET;AUTH_MACHINE_JWT_SECRET + name: OCIS_JWT_SECRET;SETTINGS_JWT_SECRET defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_MACHINE_LOG_COLOR: - name: OCIS_LOG_COLOR;AUTH_MACHINE_LOG_COLOR + name: OCIS_LOG_COLOR;SETTINGS_LOG_COLOR defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_MACHINE_LOG_FILE: - name: OCIS_LOG_FILE;AUTH_MACHINE_LOG_FILE + name: OCIS_LOG_FILE;SETTINGS_LOG_FILE defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_MACHINE_LOG_LEVEL: - name: OCIS_LOG_LEVEL;AUTH_MACHINE_LOG_LEVEL + name: OCIS_LOG_LEVEL;SETTINGS_LOG_LEVEL defaultValue: "" type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_MACHINE_LOG_PRETTY: - name: OCIS_LOG_PRETTY;AUTH_MACHINE_LOG_PRETTY + name: OCIS_LOG_PRETTY;SETTINGS_LOG_PRETTY defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1760,45 +1760,45 @@ AUTH_MACHINE_SKIP_USER_GROUPS_IN_TOKEN: description: Disables the encoding of the user's group memberships in the reva access token. This reduces the token size, especially when users are members of a large number of groups. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_MACHINE_TRACING_COLLECTOR: - name: OCIS_TRACING_COLLECTOR;AUTH_MACHINE_TRACING_COLLECTOR + name: OCIS_TRACING_COLLECTOR;SETTINGS_TRACING_COLLECTOR defaultValue: "" type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_MACHINE_TRACING_ENABLED: - name: OCIS_TRACING_ENABLED;AUTH_MACHINE_TRACING_ENABLED + name: OCIS_TRACING_ENABLED;SETTINGS_TRACING_ENABLED defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_MACHINE_TRACING_ENDPOINT: - name: OCIS_TRACING_ENDPOINT;AUTH_MACHINE_TRACING_ENDPOINT + name: OCIS_TRACING_ENDPOINT;SETTINGS_TRACING_ENDPOINT defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_MACHINE_TRACING_TYPE: - name: OCIS_TRACING_TYPE;AUTH_MACHINE_TRACING_TYPE + name: OCIS_TRACING_TYPE;SETTINGS_TRACING_TYPE defaultValue: "" type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1808,7 +1808,7 @@ AUTH_SERVICE_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1817,7 +1817,7 @@ AUTH_SERVICE_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1826,7 +1826,7 @@ AUTH_SERVICE_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1836,7 +1836,7 @@ AUTH_SERVICE_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1845,7 +1845,7 @@ AUTH_SERVICE_GRPC_ADDR: defaultValue: 127.0.0.1:9199 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1854,7 +1854,7 @@ AUTH_SERVICE_GRPC_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the GRPC service. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1863,7 +1863,7 @@ AUTH_SERVICE_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1872,7 +1872,7 @@ AUTH_SERVICE_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1881,7 +1881,7 @@ AUTH_SERVICE_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1891,7 +1891,7 @@ AUTH_SERVICE_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1900,7 +1900,7 @@ AUTH_SERVICE_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1910,7 +1910,7 @@ AUTH_SERVICE_SERVICE_ACCOUNT_ID: type: string description: The ID of the service account the service should use. See the 'auth-service' service description for more details. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1919,7 +1919,7 @@ AUTH_SERVICE_SERVICE_ACCOUNT_SECRET: defaultValue: "" type: string description: The service account secret. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1929,7 +1929,7 @@ AUTH_SERVICE_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1938,7 +1938,7 @@ AUTH_SERVICE_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1947,7 +1947,7 @@ AUTH_SERVICE_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1957,7 +1957,7 @@ AUTH_SERVICE_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1967,7 +1967,7 @@ CLIENTLOG_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1976,7 +1976,7 @@ CLIENTLOG_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1985,7 +1985,7 @@ CLIENTLOG_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1995,7 +1995,7 @@ CLIENTLOG_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2005,7 +2005,7 @@ CLIENTLOG_EVENTS_AUTH_PASSWORD: type: string description: The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2015,7 +2015,7 @@ CLIENTLOG_EVENTS_AUTH_USERNAME: type: string description: The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2026,7 +2026,7 @@ CLIENTLOG_EVENTS_CLUSTER: description: The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2036,7 +2036,7 @@ CLIENTLOG_EVENTS_ENABLE_TLS: type: bool description: Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2046,7 +2046,7 @@ CLIENTLOG_EVENTS_ENDPOINT: type: string description: The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2055,7 +2055,7 @@ CLIENTLOG_EVENTS_TLS_INSECURE: defaultValue: "false" type: bool description: Whether to verify the server TLS certificates. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2065,7 +2065,7 @@ CLIENTLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE: type: string description: The root CA certificate used to validate the server's TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2074,7 +2074,7 @@ CLIENTLOG_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2093,7 +2093,7 @@ CLIENTLOG_SERVICE_ACCOUNT_ID: type: string description: The ID of the service account the service should use. See the 'auth-service' service description for more details. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2102,7 +2102,7 @@ CLIENTLOG_SERVICE_ACCOUNT_SECRET: defaultValue: "" type: string description: The service account secret. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2112,7 +2112,7 @@ CLIENTLOG_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2121,7 +2121,7 @@ CLIENTLOG_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2130,7 +2130,7 @@ CLIENTLOG_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2140,7 +2140,7 @@ CLIENTLOG_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2149,7 +2149,7 @@ CLIENTLOG_USERLOG_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2158,7 +2158,7 @@ CLIENTLOG_USERLOG_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2168,7 +2168,7 @@ CLIENTLOG_USERLOG_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2177,7 +2177,7 @@ CLIENTLOG_USERLOG_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2187,7 +2187,7 @@ EVENTHISTORY_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2196,7 +2196,7 @@ EVENTHISTORY_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2205,7 +2205,7 @@ EVENTHISTORY_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2215,7 +2215,7 @@ EVENTHISTORY_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2225,7 +2225,7 @@ EVENTHISTORY_EVENTS_AUTH_PASSWORD: type: string description: The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2235,7 +2235,7 @@ EVENTHISTORY_EVENTS_AUTH_USERNAME: type: string description: The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2246,7 +2246,7 @@ EVENTHISTORY_EVENTS_CLUSTER: description: The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2256,7 +2256,7 @@ EVENTHISTORY_EVENTS_ENABLE_TLS: type: bool description: Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2266,7 +2266,7 @@ EVENTHISTORY_EVENTS_ENDPOINT: type: string description: The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2275,7 +2275,7 @@ EVENTHISTORY_EVENTS_TLS_INSECURE: defaultValue: "false" type: bool description: Whether to verify the server TLS certificates. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2285,7 +2285,7 @@ EVENTHISTORY_EVENTS_TLS_ROOT_CA_CERTIFICATE: type: string description: The root CA certificate used to validate the server's TLS certificate. Will be seen as empty if NOTIFICATIONS_EVENTS_TLS_INSECURE is provided. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2294,7 +2294,7 @@ EVENTHISTORY_GRPC_ADDR: defaultValue: 127.0.0.1:0 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2303,7 +2303,7 @@ EVENTHISTORY_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2312,7 +2312,7 @@ EVENTHISTORY_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2322,7 +2322,7 @@ EVENTHISTORY_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2331,7 +2331,7 @@ EVENTHISTORY_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2342,7 +2342,7 @@ EVENTHISTORY_STORE: description: 'The type of the store. Supported values are: ''memory'', ''ocmem'', ''etcd'', ''redis'', ''redis-sentinel'', ''nats-js'', ''noop''. See the text description for details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2352,7 +2352,7 @@ EVENTHISTORY_STORE_AUTH_PASSWORD: type: string description: The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2362,7 +2362,7 @@ EVENTHISTORY_STORE_AUTH_USERNAME: type: string description: The username to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2371,7 +2371,7 @@ EVENTHISTORY_STORE_DATABASE: defaultValue: eventhistory type: string description: The database name the configured store should use. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2383,7 +2383,7 @@ EVENTHISTORY_STORE_NODES: when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2394,7 +2394,7 @@ EVENTHISTORY_STORE_SIZE: description: The maximum quantity of items in the store. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived and used from the ocmem package though no explicit default was set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2403,7 +2403,7 @@ EVENTHISTORY_STORE_TABLE: defaultValue: events type: string description: The database table the store should use. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2413,7 +2413,7 @@ EVENTHISTORY_STORE_TTL: type: Duration description: Time to live for events in the store. Defaults to '336h' (2 weeks). See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2423,7 +2423,7 @@ EVENTHISTORY_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2432,7 +2432,7 @@ EVENTHISTORY_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2441,7 +2441,7 @@ EVENTHISTORY_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2451,7 +2451,7 @@ EVENTHISTORY_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2460,7 +2460,7 @@ FRONTEND_APP_HANDLER_INSECURE: defaultValue: "false" type: bool description: Allow insecure connections to the frontend. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2469,7 +2469,7 @@ FRONTEND_ARCHIVER_INSECURE: defaultValue: "false" type: bool description: Allow insecure connections to the archiver. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2478,7 +2478,7 @@ FRONTEND_ARCHIVER_MAX_NUM_FILES: defaultValue: "10000" type: int64 description: Max number of files that can be packed into an archive. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2487,7 +2487,7 @@ FRONTEND_ARCHIVER_MAX_SIZE: defaultValue: "1073741824" type: int64 description: Max size in bytes of the zip archive the archiver can create. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2497,7 +2497,7 @@ FRONTEND_AUTO_ACCEPT_SHARES: type: bool description: Defines if shares should be auto accepted by default. Users can change this setting individually in their profile. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2508,7 +2508,7 @@ FRONTEND_CHECKSUMS_PREFERRED_UPLOAD_TYPE: description: The supported checksum type for uploads that indicates to clients supporting multiple hash algorithms which one is preferred by the server. Must be one out of the defined list of SUPPORTED_TYPES. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2519,7 +2519,7 @@ FRONTEND_CHECKSUMS_SUPPORTED_TYPES: description: A list of checksum types that indicate to clients which hashes the server can use to verify upload integrity. Supported types are 'sha1', 'md5' and 'adler32'. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2529,7 +2529,7 @@ FRONTEND_CORS_ALLOW_CREDENTIALS: type: bool description: 'Allow credentials for CORS.See following chapter for more details: *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2543,7 +2543,7 @@ FRONTEND_CORS_ALLOW_HEADERS: description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2555,7 +2555,7 @@ FRONTEND_CORS_ALLOW_METHODS: description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2566,7 +2566,7 @@ FRONTEND_CORS_ALLOW_ORIGINS: description: 'A list of allowed CORS origins. See following chapter for more details: *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2575,7 +2575,7 @@ FRONTEND_DATA_GATEWAY_PREFIX: defaultValue: data type: string description: Path prefix for the data gateway. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2585,7 +2585,7 @@ FRONTEND_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2594,7 +2594,7 @@ FRONTEND_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2603,7 +2603,7 @@ FRONTEND_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2613,7 +2613,7 @@ FRONTEND_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2624,7 +2624,7 @@ FRONTEND_DEFAULT_LINK_PERMISSIONS: description: Defines the default permissions a link is being created with. Possible values are 0 (= internal link, for instance members only) and 1 (= public link with viewer permissions). Defaults to 1. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2634,7 +2634,7 @@ FRONTEND_DEFAULT_UPLOAD_PROTOCOL: type: string description: The default upload protocol to use in clients. Currently only 'tus' is avaliable. See the developer API documentation for more details about TUS. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2644,7 +2644,7 @@ FRONTEND_DISABLE_SSE: type: bool description: When set to true, clients are informed that the Server-Sent Events endpoint is not accessible. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2652,8 +2652,8 @@ FRONTEND_EDITION: name: OCIS_EDITION;FRONTEND_EDITION defaultValue: Community type: string - description: "" - introductionVersion: "" + description: Edition of oCIS. Used for branding pruposes. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2662,7 +2662,7 @@ FRONTEND_ENABLE_FAVORITES: defaultValue: "false" type: bool description: Enables the support for favorites in the clients. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2672,7 +2672,7 @@ FRONTEND_ENABLE_FEDERATED_SHARING_INCOMING: type: bool description: Changing this value is NOT supported. Enables support for incoming federated sharing for clients. The backend behaviour is not changed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2682,7 +2682,7 @@ FRONTEND_ENABLE_FEDERATED_SHARING_OUTGOING: type: bool description: Changing this value is NOT supported. Enables support for outgoing federated sharing for clients. The backend behaviour is not changed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2692,17 +2692,17 @@ FRONTEND_ENABLE_RESHARING: type: bool description: Changing this value is NOT supported. Enables the support for resharing in the clients. - introductionVersion: "" - deprecationVersion: "" + introductionVersion: pre5.0 + deprecationVersion: "5.0" removalVersion: "" - deprecationInfo: "" + deprecationInfo: Resharing will be removed in the future. FRONTEND_EVENTS_AUTH_PASSWORD: name: OCIS_EVENTS_AUTH_PASSWORD;FRONTEND_EVENTS_AUTH_PASSWORD defaultValue: "" type: string description: The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2712,7 +2712,7 @@ FRONTEND_EVENTS_AUTH_USERNAME: type: string description: The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2723,7 +2723,7 @@ FRONTEND_EVENTS_CLUSTER: description: The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2733,7 +2733,7 @@ FRONTEND_EVENTS_ENABLE_TLS: type: bool description: Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2743,7 +2743,7 @@ FRONTEND_EVENTS_ENDPOINT: type: string description: The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2752,7 +2752,7 @@ FRONTEND_EVENTS_TLS_INSECURE: defaultValue: "false" type: bool description: Whether to verify the server TLS certificates. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2762,7 +2762,7 @@ FRONTEND_EVENTS_TLS_ROOT_CA_CERTIFICATE: type: string description: The root CA certificate used to validate the server's TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2770,8 +2770,8 @@ FRONTEND_FULL_TEXT_SEARCH_ENABLED: name: FRONTEND_FULL_TEXT_SEARCH_ENABLED defaultValue: "false" type: bool - description: "" - introductionVersion: "" + description: Set to true to signal the web client that full-text search is enabled. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2780,7 +2780,7 @@ FRONTEND_HTTP_ADDR: defaultValue: 127.0.0.1:9140 type: string description: The bind address of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2789,7 +2789,7 @@ FRONTEND_HTTP_PREFIX: defaultValue: "" type: string description: The Path prefix where the frontend can be accessed (defaults to /). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2798,7 +2798,7 @@ FRONTEND_HTTP_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2807,7 +2807,7 @@ FRONTEND_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2819,7 +2819,7 @@ FRONTEND_LDAP_SERVER_WRITE_ENABLED: This can only be set to 'true' when keeping default settings for the LDAP user and group attribute types (the 'OCIS_LDAP_USER_SCHEMA_* and 'OCIS_LDAP_GROUP_SCHEMA_* variables). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2828,7 +2828,7 @@ FRONTEND_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2837,7 +2837,7 @@ FRONTEND_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2847,7 +2847,7 @@ FRONTEND_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2856,7 +2856,7 @@ FRONTEND_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2866,7 +2866,7 @@ FRONTEND_MACHINE_AUTH_API_KEY: type: string description: The machine auth API key used to validate internal requests necessary to access resources from other services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2876,7 +2876,7 @@ FRONTEND_MAX_QUOTA: type: uint64 description: Set the global max quota value in bytes. A value of 0 equals unlimited. The value is provided via capabilities. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2885,7 +2885,7 @@ FRONTEND_OCS_ADDITIONAL_INFO_ATTRIBUTE: defaultValue: '{{.Mail}}' type: string description: Additional information attribute for the user like {{.Mail}}. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2894,7 +2894,7 @@ FRONTEND_OCS_ENABLE_DENIALS: defaultValue: "false" type: bool description: 'EXPERIMENTAL: enable the feature to deny access on folders.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2903,7 +2903,7 @@ FRONTEND_OCS_INCLUDE_OCM_SHAREES: defaultValue: "false" type: bool description: Include OCM sharees when listing sharees. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2913,7 +2913,7 @@ FRONTEND_OCS_LIST_OCM_SHARES: type: bool description: Include OCM shares when listing shares. See the OCM service documentation for more details. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2922,7 +2922,7 @@ FRONTEND_OCS_PERSONAL_NAMESPACE: defaultValue: /users/{{.Id.OpaqueId}} type: string description: Homespace namespace identifier. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2932,7 +2932,7 @@ FRONTEND_OCS_PREFIX: type: string description: URL path prefix for the OCS service. Note that the string must not start with '/'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2941,7 +2941,7 @@ FRONTEND_OCS_PUBLIC_SHARE_MUST_HAVE_PASSWORD: defaultValue: "true" type: bool description: Set this to true if you want to enforce passwords on all public shares. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2951,7 +2951,7 @@ FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD: type: bool description: Set this to true if you want to enforce passwords on Uploader, Editor or Contributor shares. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2961,7 +2961,7 @@ FRONTEND_OCS_SHARE_PREFIX: type: string description: Path prefix for shares as part of an ocis resource. Note that the path must start with '/'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2971,7 +2971,7 @@ FRONTEND_OCS_STAT_CACHE_AUTH_PASSWORD: type: string description: The password to use for authentication. Only applies when using the 'nats-js-kv' store type. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2981,7 +2981,7 @@ FRONTEND_OCS_STAT_CACHE_AUTH_USERNAME: type: string description: The username to use for authentication. Only applies when using the 'nats-js-kv' store type. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2991,7 +2991,7 @@ FRONTEND_OCS_STAT_CACHE_DISABLE_PERSISTENCE: type: bool description: Disable persistence of the cache. Only applies when using the 'nats-js-kv' store type. Defaults to false. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3000,7 +3000,7 @@ FRONTEND_OCS_STAT_CACHE_SIZE: defaultValue: "0" type: int description: Max number of entries to hold in the cache. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3010,7 +3010,7 @@ FRONTEND_OCS_STAT_CACHE_STORE: type: string description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', ''nats-js-kv'', ''noop''. See the text description for details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3022,7 +3022,7 @@ FRONTEND_OCS_STAT_CACHE_STORE_NODES: when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3031,7 +3031,7 @@ FRONTEND_OCS_STAT_CACHE_TABLE: defaultValue: "" type: string description: The database table the store should use. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3042,7 +3042,7 @@ FRONTEND_OCS_STAT_CACHE_TTL: description: Default time to live for user info in the cache. Only applied when access tokens has no expiration. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3052,7 +3052,7 @@ FRONTEND_PASSWORD_POLICY_BANNED_PASSWORDS_LIST: type: string description: Path to the 'banned passwords list' file. See the documentation for more details. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3061,7 +3061,7 @@ FRONTEND_PASSWORD_POLICY_DISABLED: defaultValue: "false" type: bool description: Disable the password policy. Defaults to false if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3070,7 +3070,7 @@ FRONTEND_PASSWORD_POLICY_MIN_CHARACTERS: defaultValue: "8" type: int description: Define the minimum password length. Defaults to 8 if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3079,7 +3079,7 @@ FRONTEND_PASSWORD_POLICY_MIN_DIGITS: defaultValue: "1" type: int description: Define the minimum number of digits. Defaults to 1 if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3089,7 +3089,7 @@ FRONTEND_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS: type: int description: Define the minimum number of uppercase letters. Defaults to 1 if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3099,7 +3099,7 @@ FRONTEND_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS: type: int description: Define the minimum number of characters from the special characters list to be present. Defaults to 1 if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3109,7 +3109,7 @@ FRONTEND_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS: type: int description: Define the minimum number of lowercase letters. Defaults to 1 if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3118,7 +3118,7 @@ FRONTEND_PUBLIC_URL: defaultValue: https://localhost:9200 type: string description: The public facing URL of the oCIS frontend. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3131,7 +3131,7 @@ FRONTEND_READONLY_USER_ATTRIBUTES: ''user.passwordProfile'' (password), ''user.appRoleAssignments'' (role), ''user.memberOf'' (groups), ''user.accountEnabled'' (login allowed), ''drive.quota'' (quota). See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3142,7 +3142,7 @@ FRONTEND_SEARCH_MIN_LENGTH: description: Minimum number of characters to enter before a client should start a search for Share receivers. This setting can be used to customize the user experience if e.g too many results are displayed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3152,7 +3152,7 @@ FRONTEND_SERVICE_ACCOUNT_ID: type: string description: The ID of the service account the service should use. See the 'auth-service' service description for more details. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3161,7 +3161,7 @@ FRONTEND_SERVICE_ACCOUNT_SECRET: defaultValue: "" type: string description: The service account secret. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3171,7 +3171,7 @@ FRONTEND_SKIP_USER_GROUPS_IN_TOKEN: type: bool description: Disables the loading of user's group memberships from the reva access token. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3181,7 +3181,7 @@ FRONTEND_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3190,7 +3190,7 @@ FRONTEND_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3199,7 +3199,7 @@ FRONTEND_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3209,7 +3209,7 @@ FRONTEND_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3218,7 +3218,7 @@ FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE: defaultValue: "" type: string description: Advise TUS to replace PATCH requests by POST requests. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3227,7 +3227,7 @@ FRONTEND_UPLOAD_MAX_CHUNK_SIZE: defaultValue: "10000000" type: int description: Sets the max chunk sizes in bytes for uploads via the clients. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3237,7 +3237,7 @@ GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT: type: bool description: Commit shares to storage grants. This grants access to shared resources for the share receiver directly on the storage. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3247,7 +3247,7 @@ GATEWAY_CREATE_HOME_CACHE_AUTH_PASSWORD: type: string description: The password to use for authentication. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3257,7 +3257,7 @@ GATEWAY_CREATE_HOME_CACHE_AUTH_USERNAME: type: string description: The username to use for authentication. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3267,7 +3267,7 @@ GATEWAY_CREATE_HOME_CACHE_DISABLE_PERSISTENCE: type: bool description: Disables persistence of the create home cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3278,7 +3278,7 @@ GATEWAY_CREATE_HOME_CACHE_SIZE: description: The maximum quantity of items in the cache. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitely set as default. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3288,7 +3288,7 @@ GATEWAY_CREATE_HOME_CACHE_STORE: type: string description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', ''nats-js-kv'', ''noop''. See the text description for details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3300,7 +3300,7 @@ GATEWAY_CREATE_HOME_CACHE_STORE_NODES: when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3311,7 +3311,7 @@ GATEWAY_CREATE_HOME_CACHE_TTL: description: Default time to live for user info in the cache. Only applied when access tokens has no expiration. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3321,7 +3321,7 @@ GATEWAY_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3330,7 +3330,7 @@ GATEWAY_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3339,7 +3339,7 @@ GATEWAY_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3349,7 +3349,7 @@ GATEWAY_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3358,7 +3358,7 @@ GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN: defaultValue: "true" type: bool description: Disable creation of the home space on login. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3367,7 +3367,7 @@ GATEWAY_FRONTEND_PUBLIC_URL: defaultValue: https://localhost:9200 type: string description: The public facing URL of the oCIS frontend. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3376,7 +3376,7 @@ GATEWAY_GRPC_ADDR: defaultValue: 127.0.0.1:9142 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3385,7 +3385,7 @@ GATEWAY_GRPC_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3394,7 +3394,7 @@ GATEWAY_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3403,7 +3403,7 @@ GATEWAY_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3412,7 +3412,7 @@ GATEWAY_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3422,7 +3422,7 @@ GATEWAY_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3431,7 +3431,7 @@ GATEWAY_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3441,7 +3441,7 @@ GATEWAY_PROVIDER_CACHE_AUTH_PASSWORD: type: string description: The password to use for authentication. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3451,7 +3451,7 @@ GATEWAY_PROVIDER_CACHE_AUTH_USERNAME: type: string description: The username to use for authentication. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3461,7 +3461,7 @@ GATEWAY_PROVIDER_CACHE_DISABLE_PERSISTENCE: type: bool description: Disables persistence of the provider cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3472,7 +3472,7 @@ GATEWAY_PROVIDER_CACHE_SIZE: description: The maximum quantity of items in the cache. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitely set as default. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3482,7 +3482,7 @@ GATEWAY_PROVIDER_CACHE_STORE: type: string description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', ''nats-js-kv'', ''noop''. See the text description for details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3494,7 +3494,7 @@ GATEWAY_PROVIDER_CACHE_STORE_NODES: when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3505,7 +3505,7 @@ GATEWAY_PROVIDER_CACHE_TTL: description: Default time to live for user info in the cache. Only applied when access tokens has no expiration. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3514,7 +3514,7 @@ GATEWAY_SHARE_FOLDER_NAME: defaultValue: Shares type: string description: Name of the share folder in users' home space. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3524,7 +3524,7 @@ GATEWAY_SKIP_USER_GROUPS_IN_TOKEN: type: bool description: Disables the loading of user's group memberships from the reva access token. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3533,7 +3533,7 @@ GATEWAY_STORAGE_REGISTRY_CONFIG_JSON: defaultValue: "" type: string description: Additional configuration for the storage registry in json format. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3542,7 +3542,7 @@ GATEWAY_STORAGE_REGISTRY_DRIVER: defaultValue: spaces type: string description: The driver name of the storage registry to use. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3552,7 +3552,7 @@ GATEWAY_STORAGE_REGISTRY_RULES: type: '[]string' description: The rules for the storage registry. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3563,7 +3563,7 @@ GATEWAY_STORAGE_USERS_MOUNT_ID: description: Mount ID of this storage. Admins can set the ID for the storage in this config option manually which is then used to reference the storage. Any reasonable long string is possible, preferably this would be an UUIDv4 format. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3573,7 +3573,7 @@ GATEWAY_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3582,7 +3582,7 @@ GATEWAY_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3591,7 +3591,7 @@ GATEWAY_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3601,7 +3601,7 @@ GATEWAY_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3610,7 +3610,7 @@ GATEWAY_TRANSFER_EXPIRES: defaultValue: "86400" type: int description: Expiry for the gateway tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3619,7 +3619,7 @@ GRAPH_APPLICATION_DISPLAYNAME: defaultValue: ownCloud Infinite Scale type: string description: The ocis application name. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3629,7 +3629,7 @@ GRAPH_APPLICATION_ID: type: string description: The ocis application ID shown in the graph. All app roles are tied to this ID. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3641,7 +3641,7 @@ GRAPH_ASSIGN_DEFAULT_USER_ROLE: this to 'false' if you want to assign roles manually, or if the role assignment should happen at first login. Set this to 'true' (the default) to assign the role 'User' when creating a new user. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3651,7 +3651,7 @@ GRAPH_CACHE_AUTH_PASSWORD: type: string description: The password to authenticate with the cache. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3661,7 +3661,7 @@ GRAPH_CACHE_AUTH_USERNAME: type: string description: The username to authenticate with the cache. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3671,7 +3671,7 @@ GRAPH_CACHE_DISABLE_PERSISTENCE: type: bool description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3682,7 +3682,7 @@ GRAPH_CACHE_SIZE: description: The maximum quantity of items in the store. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitely set as default. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3692,7 +3692,7 @@ GRAPH_CACHE_STORE: type: string description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', ''nats-js-kv'', ''noop''. See the text description for details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3701,7 +3701,7 @@ GRAPH_CACHE_STORE_DATABASE: defaultValue: cache-roles type: string description: The database name the configured store should use. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3713,7 +3713,7 @@ GRAPH_CACHE_STORE_NODES: when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3722,7 +3722,7 @@ GRAPH_CACHE_STORE_TABLE: defaultValue: "" type: string description: The database table the store should use. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3732,7 +3732,7 @@ GRAPH_CACHE_TTL: type: Duration description: Time to live for cache records in the graph. Defaults to '336h' (2 weeks). See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3742,7 +3742,7 @@ GRAPH_CORS_ALLOW_CREDENTIALS: type: bool description: 'Allow credentials for CORS.See following chapter for more details: *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3754,7 +3754,7 @@ GRAPH_CORS_ALLOW_HEADERS: description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3765,7 +3765,7 @@ GRAPH_CORS_ALLOW_METHODS: description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3776,7 +3776,7 @@ GRAPH_CORS_ALLOW_ORIGINS: description: 'A list of allowed CORS origins. See following chapter for more details: *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3786,7 +3786,7 @@ GRAPH_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3795,7 +3795,7 @@ GRAPH_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3804,7 +3804,7 @@ GRAPH_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3814,7 +3814,7 @@ GRAPH_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3827,7 +3827,7 @@ GRAPH_DISABLE_USER_MECHANISM: will add the user to the configured group for disabled users, if set to 'attribute' this will be done in the ldap user entry, if set to 'none' the disable request is not processed. Default is 'attribute'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3837,7 +3837,7 @@ GRAPH_DISABLED_USERS_GROUP_DN: type: string description: The distinguished name of the group to which added users will be classified as disabled when 'disable_user_mechanism' is set to 'group'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3846,17 +3846,17 @@ GRAPH_ENABLE_RESHARING: defaultValue: "true" type: bool description: Changing this value is NOT supported. Enables the support for resharing. - introductionVersion: "" - deprecationVersion: "" + introductionVersion: "5.0" + deprecationVersion: "5.0" removalVersion: "" - deprecationInfo: "" + deprecationInfo: Resharing will be removed in the future. GRAPH_EVENTS_AUTH_PASSWORD: name: OCIS_EVENTS_AUTH_PASSWORD;GRAPH_EVENTS_AUTH_PASSWORD defaultValue: "" type: string description: The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3866,7 +3866,7 @@ GRAPH_EVENTS_AUTH_USERNAME: type: string description: The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3876,7 +3876,7 @@ GRAPH_EVENTS_CLUSTER: type: string description: The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3886,7 +3886,7 @@ GRAPH_EVENTS_ENABLE_TLS: type: bool description: Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3897,7 +3897,7 @@ GRAPH_EVENTS_ENDPOINT: description: The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Set to a empty string to disable emitting events. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3906,7 +3906,7 @@ GRAPH_EVENTS_TLS_INSECURE: defaultValue: "false" type: bool description: Whether to verify the server TLS certificates. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3916,7 +3916,7 @@ GRAPH_EVENTS_TLS_ROOT_CA_CERTIFICATE: type: string description: The root CA certificate used to validate the server's TLS certificate. If provided GRAPH_EVENTS_TLS_INSECURE will be seen as false. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3926,7 +3926,7 @@ GRAPH_GROUP_MEMBERS_PATCH_LIMIT: type: int description: The amount of group members allowed to be added with a single patch request. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3935,7 +3935,7 @@ GRAPH_HTTP_ADDR: defaultValue: 127.0.0.1:9120 type: string description: The bind address of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3944,7 +3944,7 @@ GRAPH_HTTP_API_TOKEN: defaultValue: "" type: string description: An optional API bearer token - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3953,7 +3953,7 @@ GRAPH_HTTP_ROOT: defaultValue: /graph type: string description: Subdirectory that serves as the root for this HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3963,7 +3963,7 @@ GRAPH_IDENTITY_BACKEND: type: string description: The user identity backend to use. Supported backend types are 'ldap' and 'cs3'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3973,7 +3973,7 @@ GRAPH_IDENTITY_SEARCH_MIN_LENGTH: type: int description: The minimum length the search term needs to have for unprivileged users when searching for users or groups. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3982,7 +3982,7 @@ GRAPH_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3991,7 +3991,7 @@ GRAPH_KEYCLOAK_BASE_PATH: defaultValue: "" type: string description: The URL to access keycloak. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4000,7 +4000,7 @@ GRAPH_KEYCLOAK_CLIENT_ID: defaultValue: "" type: string description: The client id to authenticate with keycloak. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4009,7 +4009,7 @@ GRAPH_KEYCLOAK_CLIENT_REALM: defaultValue: "" type: string description: The realm the client is defined in. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4018,7 +4018,7 @@ GRAPH_KEYCLOAK_CLIENT_SECRET: defaultValue: "" type: string description: The client secret to use in authentication. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4028,7 +4028,7 @@ GRAPH_KEYCLOAK_INSECURE_SKIP_VERIFY: type: bool description: Disable TLS certificate validation for Keycloak connections. Do not set this in production environments. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4037,7 +4037,7 @@ GRAPH_KEYCLOAK_USER_REALM: defaultValue: "" type: string description: The realm users are defined. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4047,7 +4047,7 @@ GRAPH_LDAP_BIND_DN: type: string description: LDAP DN to use for simple bind authentication with the target LDAP server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4056,7 +4056,7 @@ GRAPH_LDAP_BIND_PASSWORD: defaultValue: "" type: string description: Password to use for authenticating the 'bind_dn'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4067,7 +4067,7 @@ GRAPH_LDAP_CACERT: description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4076,7 +4076,7 @@ GRAPH_LDAP_EDUCATION_RESOURCES_ENABLED: defaultValue: "false" type: bool description: Enable LDAP support for managing education related resources. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4085,7 +4085,7 @@ GRAPH_LDAP_GROUP_BASE_DN: defaultValue: ou=groups,o=libregraph-idm type: string description: Search base DN for looking up LDAP groups. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4097,7 +4097,7 @@ GRAPH_LDAP_GROUP_CREATE_BASE_DN: to the 'GRAPH_LDAP_GROUP_BASE_DN'. This setting is only relevant when 'GRAPH_LDAP_SERVER_WRITE_ENABLED' is 'true'. It defaults to the value of 'GRAPH_LDAP_GROUP_BASE_DN'. All groups outside of this subtree are treated as readonly groups and cannot be updated. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4106,7 +4106,7 @@ GRAPH_LDAP_GROUP_FILTER: defaultValue: "" type: string description: LDAP filter to add to the default filters for group searches. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4116,7 +4116,7 @@ GRAPH_LDAP_GROUP_ID_ATTRIBUTE: type: string description: LDAP Attribute to use as the unique id for groups. This should be a stable globally unique ID like a UUID. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4125,7 +4125,7 @@ GRAPH_LDAP_GROUP_MEMBER_ATTRIBUTE: defaultValue: member type: string description: LDAP Attribute that is used for group members. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4134,7 +4134,7 @@ GRAPH_LDAP_GROUP_NAME_ATTRIBUTE: defaultValue: cn type: string description: LDAP Attribute to use for the name of groups. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4144,7 +4144,7 @@ GRAPH_LDAP_GROUP_OBJECTCLASS: type: string description: The object class to use for groups in the default group search filter ('groupOfNames'). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4155,7 +4155,7 @@ GRAPH_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING: description: Set this to true if the defined 'ID' attribute for groups is of the 'OCTETSTRING' syntax. This is required when using the 'objectGUID' attribute of Active Directory for the group ID's. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4165,7 +4165,7 @@ GRAPH_LDAP_GROUP_SEARCH_SCOPE: type: string description: LDAP search scope to use when looking up groups. Supported scopes are 'base', 'one' and 'sub'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4175,7 +4175,7 @@ GRAPH_LDAP_INSECURE: type: bool description: Disable TLS certificate validation for the LDAP connections. Do not set this in production environments. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4185,7 +4185,7 @@ GRAPH_LDAP_REFINT_ENABLED: type: bool description: Signals that the server has the refint plugin enabled, which makes some actions not needed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4194,7 +4194,7 @@ GRAPH_LDAP_SCHOOL_BASE_DN: defaultValue: "" type: string description: Search base DN for looking up LDAP schools. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4203,7 +4203,7 @@ GRAPH_LDAP_SCHOOL_FILTER: defaultValue: "" type: string description: LDAP filter to add to the default filters for school searches. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4213,7 +4213,7 @@ GRAPH_LDAP_SCHOOL_ID_ATTRIBUTE: type: string description: LDAP Attribute to use as the unique id for schools. This should be a stable globally unique ID like a UUID. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4222,7 +4222,7 @@ GRAPH_LDAP_SCHOOL_NAME_ATTRIBUTE: defaultValue: "" type: string description: LDAP Attribute to use for the name of a school. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4231,7 +4231,7 @@ GRAPH_LDAP_SCHOOL_NUMBER_ATTRIBUTE: defaultValue: "" type: string description: LDAP Attribute to use for the number of a school. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4240,7 +4240,7 @@ GRAPH_LDAP_SCHOOL_OBJECTCLASS: defaultValue: "" type: string description: The object class to use for schools in the default school search filter. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4250,7 +4250,7 @@ GRAPH_LDAP_SCHOOL_SEARCH_SCOPE: type: string description: LDAP search scope to use when looking up schools. Supported scopes are 'base', 'one' and 'sub'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4260,7 +4260,7 @@ GRAPH_LDAP_SCHOOL_TERMINATION_MIN_GRACE_DAYS: type: int description: When setting a 'terminationDate' for a school, require the date to be at least this number of days in the future. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4269,7 +4269,7 @@ GRAPH_LDAP_SERVER_USE_PASSWORD_MODIFY_EXOP: defaultValue: "true" type: bool description: Use the 'Password Modify Extended Operation' for updating user passwords. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4279,19 +4279,19 @@ GRAPH_LDAP_SERVER_UUID: type: bool description: If set to true, rely on the LDAP Server to generate a unique ID for users and groups, like when using 'entryUUID' as the user ID attribute. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" GRAPH_LDAP_SERVER_WRITE_ENABLED: - name: OCIS_LDAP_SERVER_WRITE_ENABLED;GRAPH_LDAP_SERVER_WRITE_ENABLED + name: OCIS_LDAP_SERVER_WRITE_ENABLED;FRONTEND_LDAP_SERVER_WRITE_ENABLED defaultValue: "true" type: bool description: Allow creating, modifying and deleting LDAP users via the GRAPH API. This can only be set to 'true' when keeping default settings for the LDAP user and group attribute types (the 'OCIS_LDAP_USER_SCHEMA_* and 'OCIS_LDAP_GROUP_SCHEMA_* variables). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4301,7 +4301,7 @@ GRAPH_LDAP_URI: type: string description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4310,7 +4310,7 @@ GRAPH_LDAP_USER_BASE_DN: defaultValue: ou=users,o=libregraph-idm type: string description: Search base DN for looking up LDAP users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4319,7 +4319,7 @@ GRAPH_LDAP_USER_DISPLAYNAME_ATTRIBUTE: defaultValue: displayName type: string description: LDAP Attribute to use for the displayname of users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4328,7 +4328,7 @@ GRAPH_LDAP_USER_EMAIL_ATTRIBUTE: defaultValue: mail type: string description: LDAP Attribute to use for the email address of users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4337,7 +4337,7 @@ GRAPH_LDAP_USER_FILTER: defaultValue: "" type: string description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4346,7 +4346,7 @@ GRAPH_LDAP_USER_NAME_ATTRIBUTE: defaultValue: uid type: string description: LDAP Attribute to use for username of users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4356,7 +4356,7 @@ GRAPH_LDAP_USER_OBJECTCLASS: type: string description: The object class to use for users in the default user search filter ('inetOrgPerson'). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4367,7 +4367,7 @@ GRAPH_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING: description: Set this to true if the defined 'ID' attribute for users is of the 'OCTETSTRING' syntax. This is required when using the 'objectGUID' attribute of Active Directory for the user ID's. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4377,7 +4377,7 @@ GRAPH_LDAP_USER_SCOPE: type: string description: LDAP search scope to use when looking up users. Supported scopes are 'base', 'one' and 'sub'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4387,7 +4387,7 @@ GRAPH_LDAP_USER_TYPE_ATTRIBUTE: type: string description: LDAP Attribute to distinguish between 'Member' and 'Guest' users. Default is 'ownCloudUserType'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4397,7 +4397,7 @@ GRAPH_LDAP_USER_UID_ATTRIBUTE: type: string description: LDAP Attribute to use as the unique ID for users. This should be a stable globally unique ID like a UUID. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4406,7 +4406,7 @@ GRAPH_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4415,7 +4415,7 @@ GRAPH_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4425,7 +4425,7 @@ GRAPH_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4434,7 +4434,7 @@ GRAPH_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4444,7 +4444,7 @@ GRAPH_SERVICE_ACCOUNT_ID: type: string description: The ID of the service account the service should use. See the 'auth-service' service description for more details. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4453,7 +4453,7 @@ GRAPH_SERVICE_ACCOUNT_SECRET: defaultValue: "" type: string description: The service account secret. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4462,7 +4462,7 @@ GRAPH_SPACES_DEFAULT_QUOTA: defaultValue: "1000000000" type: string description: The default quota in bytes. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4471,7 +4471,7 @@ GRAPH_SPACES_EXTENDED_SPACE_PROPERTIES_CACHE_TTL: defaultValue: "60000000000" type: int description: Max TTL in seconds for the spaces property cache. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4480,7 +4480,7 @@ GRAPH_SPACES_GROUPS_CACHE_TTL: defaultValue: "60000000000" type: int description: Max TTL in seconds for the spaces groups cache. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4498,7 +4498,7 @@ GRAPH_SPACES_USERS_CACHE_TTL: defaultValue: "60000000000" type: int description: Max TTL in seconds for the spaces users cache. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4507,7 +4507,7 @@ GRAPH_SPACES_WEBDAV_BASE: defaultValue: https://localhost:9200 type: string description: The public facing URL of WebDAV. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4516,7 +4516,7 @@ GRAPH_SPACES_WEBDAV_PATH: defaultValue: /dav/spaces/ type: string description: The WebDAV subpath for spaces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4526,7 +4526,7 @@ GRAPH_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4535,7 +4535,7 @@ GRAPH_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4544,7 +4544,7 @@ GRAPH_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4554,7 +4554,7 @@ GRAPH_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4563,7 +4563,7 @@ GRAPH_USER_ENABLED_ATTRIBUTE: defaultValue: ownCloudUserEnabled type: string description: LDAP Attribute to use as a flag telling if the user is enabled or disabled. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4575,7 +4575,7 @@ GRAPH_USERNAME_MATCH: 'none'. When set to 'default', user names must not start with a number and are restricted to ASCII characters. When set to 'none', no restrictions are applied. The default value is 'default'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4585,7 +4585,7 @@ GROUPS_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4594,7 +4594,7 @@ GROUPS_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4603,7 +4603,7 @@ GROUPS_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4613,7 +4613,7 @@ GROUPS_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4623,7 +4623,7 @@ GROUPS_DRIVER: type: string description: The driver which should be used by the groups service. Supported values are 'ldap' and 'owncloudsql'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4632,7 +4632,7 @@ GROUPS_GRPC_ADDR: defaultValue: 127.0.0.1:9160 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4641,7 +4641,7 @@ GROUPS_GRPC_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4651,7 +4651,7 @@ GROUPS_IDP_URL: type: string description: The identity provider value to set in the group IDs of the CS3 group objects for groups returned by this group provider. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4660,7 +4660,7 @@ GROUPS_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4670,7 +4670,7 @@ GROUPS_LDAP_BIND_DN: type: string description: LDAP DN to use for simple bind authentication with the target LDAP server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4679,7 +4679,7 @@ GROUPS_LDAP_BIND_PASSWORD: defaultValue: "" type: string description: Password to use for authenticating the 'bind_dn'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4690,7 +4690,7 @@ GROUPS_LDAP_CACERT: description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4699,7 +4699,7 @@ GROUPS_LDAP_GROUP_BASE_DN: defaultValue: ou=groups,o=libregraph-idm type: string description: Search base DN for looking up LDAP groups. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4708,7 +4708,7 @@ GROUPS_LDAP_GROUP_FILTER: defaultValue: "" type: string description: LDAP filter to add to the default filters for group searches. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4718,7 +4718,7 @@ GROUPS_LDAP_GROUP_OBJECTCLASS: type: string description: The object class to use for groups in the default group search filter ('groupOfNames'). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4728,7 +4728,7 @@ GROUPS_LDAP_GROUP_SCHEMA_DISPLAYNAME: type: string description: LDAP Attribute to use for the displayname of groups (often the same as groupname attribute). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4737,7 +4737,7 @@ GROUPS_LDAP_GROUP_SCHEMA_GROUPNAME: defaultValue: cn type: string description: LDAP Attribute to use for the name of groups. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4747,7 +4747,7 @@ GROUPS_LDAP_GROUP_SCHEMA_ID: type: string description: LDAP Attribute to use as the unique id for groups. This should be a stable globally unique ID like a UUID. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4758,7 +4758,7 @@ GROUPS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING: description: Set this to true if the defined 'id' attribute for groups is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute of Active Directory for the group ID's. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4767,7 +4767,7 @@ GROUPS_LDAP_GROUP_SCHEMA_MAIL: defaultValue: mail type: string description: LDAP Attribute to use for the email address of groups (can be empty). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4776,7 +4776,7 @@ GROUPS_LDAP_GROUP_SCHEMA_MEMBER: defaultValue: member type: string description: LDAP Attribute that is used for group members. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4786,7 +4786,7 @@ GROUPS_LDAP_GROUP_SCOPE: type: string description: LDAP search scope to use when looking up groups. Supported scopes are 'base', 'one' and 'sub'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4798,7 +4798,7 @@ GROUPS_LDAP_GROUP_SUBSTRING_FILTER_TYPE: Supported values are 'initial', 'final' and 'any'. The value 'initial' is used for doing prefix only searches, 'final' for doing suffix only searches or 'any' for doing full substring searches - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4808,7 +4808,7 @@ GROUPS_LDAP_INSECURE: type: bool description: Disable TLS certificate validation for the LDAP connections. Do not set this in production environments. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4818,7 +4818,7 @@ GROUPS_LDAP_URI: type: string description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4827,7 +4827,7 @@ GROUPS_LDAP_USER_BASE_DN: defaultValue: ou=users,o=libregraph-idm type: string description: Search base DN for looking up LDAP users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4836,7 +4836,7 @@ GROUPS_LDAP_USER_FILTER: defaultValue: "" type: string description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4846,7 +4846,7 @@ GROUPS_LDAP_USER_OBJECTCLASS: type: string description: The object class to use for users in the default user search filter ('inetOrgPerson'). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4855,7 +4855,7 @@ GROUPS_LDAP_USER_SCHEMA_DISPLAYNAME: defaultValue: displayname type: string description: LDAP Attribute to use for the displayname of users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4865,7 +4865,7 @@ GROUPS_LDAP_USER_SCHEMA_ID: type: string description: LDAP Attribute to use as the unique id for users. This should be a stable globally unique id like a UUID. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4876,7 +4876,7 @@ GROUPS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING: description: Set this to true if the defined 'ID' attribute for users is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute of Active Directory for the user ID's. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4885,7 +4885,7 @@ GROUPS_LDAP_USER_SCHEMA_MAIL: defaultValue: mail type: string description: LDAP Attribute to use for the email address of users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4894,7 +4894,7 @@ GROUPS_LDAP_USER_SCHEMA_USERNAME: defaultValue: uid type: string description: LDAP Attribute to use for username of users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4904,7 +4904,7 @@ GROUPS_LDAP_USER_SCOPE: type: string description: LDAP search scope to use when looking up users. Supported scopes are 'base', 'one' and 'sub'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4913,7 +4913,7 @@ GROUPS_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4922,7 +4922,7 @@ GROUPS_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4932,7 +4932,7 @@ GROUPS_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4941,7 +4941,7 @@ GROUPS_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4950,7 +4950,7 @@ GROUPS_OWNCLOUDSQL_DB_HOST: defaultValue: mysql type: string description: Hostname of the database server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4959,7 +4959,7 @@ GROUPS_OWNCLOUDSQL_DB_NAME: defaultValue: owncloud type: string description: Name of the owncloud database. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4968,7 +4968,7 @@ GROUPS_OWNCLOUDSQL_DB_PASSWORD: defaultValue: "" type: string description: Password for the database user. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4977,7 +4977,7 @@ GROUPS_OWNCLOUDSQL_DB_PORT: defaultValue: "3306" type: int description: Network port to use for the database connection. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4986,7 +4986,7 @@ GROUPS_OWNCLOUDSQL_DB_USERNAME: defaultValue: owncloud type: string description: Database user to use for authenticating with the owncloud database. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4996,7 +4996,7 @@ GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH: type: bool description: Allow 'medial search' when searching for users instead of just doing a prefix search. This allows finding 'Alice' when searching for 'lic'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5006,7 +5006,7 @@ GROUPS_OWNCLOUDSQL_IDP: type: string description: The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5015,7 +5015,7 @@ GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID: defaultValue: "false" type: bool description: Join the user properties table to read user IDs. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5024,7 +5024,7 @@ GROUPS_OWNCLOUDSQL_JOIN_USERNAME: defaultValue: "false" type: bool description: Join the user properties table to read usernames. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5033,7 +5033,7 @@ GROUPS_OWNCLOUDSQL_NOBODY: defaultValue: "90" type: int64 description: Fallback number if no numeric UID and GID properties are provided. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5043,7 +5043,7 @@ GROUPS_SKIP_USER_GROUPS_IN_TOKEN: type: bool description: Disables the loading of user's group memberships from the reva access token. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5053,7 +5053,7 @@ GROUPS_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5062,7 +5062,7 @@ GROUPS_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5071,7 +5071,7 @@ GROUPS_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5081,7 +5081,7 @@ GROUPS_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5091,7 +5091,7 @@ IDM_ADMIN_PASSWORD: type: string description: Password to set for the oCIS 'admin' user. Either cleartext or an argon2id hash. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5102,16 +5102,16 @@ IDM_ADMIN_USER_ID: description: ID of the user that should receive admin privileges. Consider that the UUID can be encoded in some LDAP deployment configurations like in .ldif files. These need to be decoded beforehand. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" IDM_CREATE_DEMO_USERS: - name: IDM_CREATE_DEMO_USERS + name: SETTINGS_SETUP_DEFAULT_ASSIGNMENTS;IDM_CREATE_DEMO_USERS defaultValue: "false" type: bool - description: Flag to enable or disable the creation of the demo users. - introductionVersion: "" + description: The default role assignments the demo users should be setup. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5121,7 +5121,7 @@ IDM_DATABASE_PATH: type: string description: Full path to the IDM backend database. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5131,7 +5131,7 @@ IDM_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5140,7 +5140,7 @@ IDM_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5149,7 +5149,7 @@ IDM_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5159,7 +5159,7 @@ IDM_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5169,7 +5169,7 @@ IDM_IDPSVC_PASSWORD: type: string description: Password to set for the 'idp' service user. Either cleartext or an argon2id hash. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5178,7 +5178,7 @@ IDM_LDAPS_ADDR: defaultValue: 127.0.0.1:9235 type: string description: Listen address for the LDAPS listener (ip-addr:port). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5188,7 +5188,7 @@ IDM_LDAPS_CERT: type: string description: File name of the TLS server certificate for the LDAPS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5198,7 +5198,7 @@ IDM_LDAPS_KEY: type: string description: File name for the TLS certificate key for the server certificate. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5207,7 +5207,7 @@ IDM_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5216,7 +5216,7 @@ IDM_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5226,7 +5226,7 @@ IDM_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5235,7 +5235,7 @@ IDM_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5245,7 +5245,7 @@ IDM_REVASVC_PASSWORD: type: string description: Password to set for the 'reva' service user. Either cleartext or an argon2id hash. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5255,7 +5255,7 @@ IDM_SVC_PASSWORD: type: string description: Password to set for the 'idm' service user. Either cleartext or an argon2id hash. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5265,7 +5265,7 @@ IDM_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5274,7 +5274,7 @@ IDM_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5283,7 +5283,7 @@ IDM_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5293,7 +5293,7 @@ IDM_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5303,7 +5303,7 @@ IDP_ACCESS_TOKEN_EXPIRATION: type: uint64 description: '''Access token lifespan in seconds (time before an access token is expired).''' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5312,7 +5312,7 @@ IDP_ALLOW_CLIENT_GUESTS: defaultValue: "false" type: bool description: Allow guest clients to access oCIS. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5321,7 +5321,7 @@ IDP_ALLOW_DYNAMIC_CLIENT_REGISTRATION: defaultValue: "false" type: bool description: Allow dynamic client registration. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5331,7 +5331,7 @@ IDP_ASSET_PATH: type: string description: Serve IDP assets from a path on the filesystem instead of the builtin assets. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5341,7 +5341,7 @@ IDP_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5350,7 +5350,7 @@ IDP_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5359,7 +5359,7 @@ IDP_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5369,7 +5369,7 @@ IDP_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5378,7 +5378,7 @@ IDP_DYNAMIC_CLIENT_SECRET_DURATION: defaultValue: "0" type: uint64 description: Lifespan in seconds of a dynamically registered OIDC client. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5389,7 +5389,7 @@ IDP_ENCRYPTION_SECRET_FILE: description: Path to the encryption secret file, if unset, a new certificate will be autogenerated upon each restart, thus invalidating all existing sessions. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idp. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5398,7 +5398,7 @@ IDP_ENDPOINT_URI: defaultValue: "" type: string description: URL of the IDP endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5407,7 +5407,7 @@ IDP_HTTP_ADDR: defaultValue: 127.0.0.1:9130 type: string description: The bind address of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5416,7 +5416,7 @@ IDP_HTTP_ROOT: defaultValue: / type: string description: Subdirectory that serves as the root for this HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5425,7 +5425,7 @@ IDP_ID_TOKEN_EXPIRATION: defaultValue: "300" type: uint64 description: ID token lifespan in seconds (time before an ID token is expired). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5435,7 +5435,7 @@ IDP_IDENTITY_MANAGER: type: string description: The identity manager implementation to use. Supported identity managers are 'ldap', 'cs3', 'libregraph' and 'guest'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5445,7 +5445,7 @@ IDP_INSECURE: type: bool description: Disable TLS certificate validation for the LDAP connections. Do not set this in production environments. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5454,7 +5454,7 @@ IDP_ISS: defaultValue: https://localhost:9200 type: string description: The OIDC issuer URL to use. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5463,7 +5463,7 @@ IDP_LDAP_BASE_DN: defaultValue: ou=users,o=libregraph-idm type: string description: Search base DN for looking up LDAP users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5473,7 +5473,7 @@ IDP_LDAP_BIND_DN: type: string description: LDAP DN to use for simple bind authentication with the target LDAP server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5482,7 +5482,7 @@ IDP_LDAP_BIND_PASSWORD: defaultValue: "" type: string description: Password to use for authenticating the 'bind_dn'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5491,7 +5491,7 @@ IDP_LDAP_EMAIL_ATTRIBUTE: defaultValue: mail type: string description: LDAP User email attribute like 'mail'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5500,7 +5500,7 @@ IDP_LDAP_FILTER: defaultValue: "" type: string description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5509,7 +5509,7 @@ IDP_LDAP_LOGIN_ATTRIBUTE: defaultValue: uid type: string description: LDAP User attribute to use for login like 'uid'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5518,7 +5518,7 @@ IDP_LDAP_NAME_ATTRIBUTE: defaultValue: displayName type: string description: LDAP User name attribute like 'displayName'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5527,7 +5527,7 @@ IDP_LDAP_OBJECTCLASS: defaultValue: inetOrgPerson type: string description: LDAP User ObjectClass like 'inetOrgPerson'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5537,7 +5537,7 @@ IDP_LDAP_SCOPE: type: string description: LDAP search scope to use when looking up users. Supported scopes are 'base', 'one' and 'sub'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5548,7 +5548,7 @@ IDP_LDAP_TLS_CACERT: description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idp. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5557,7 +5557,7 @@ IDP_LDAP_URI: defaultValue: ldaps://localhost:9235 type: string description: Url of the LDAP service to use as IDP. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5566,7 +5566,7 @@ IDP_LDAP_UUID_ATTRIBUTE: defaultValue: ownCloudUUID type: string description: LDAP User UUID attribute like 'uid'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5575,7 +5575,7 @@ IDP_LDAP_UUID_ATTRIBUTE_TYPE: defaultValue: text type: string description: LDAP User uuid attribute type like 'text'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5584,7 +5584,7 @@ IDP_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5593,7 +5593,7 @@ IDP_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5603,7 +5603,7 @@ IDP_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5612,7 +5612,7 @@ IDP_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5622,7 +5622,7 @@ IDP_LOGIN_BACKGROUND_URL: type: string description: Configure an alternative URL to the background image for the login page. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5632,7 +5632,7 @@ IDP_MACHINE_AUTH_API_KEY: type: string description: Machine auth API key used to validate internal requests necessary for the access to resources from other services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5641,7 +5641,7 @@ IDP_PASSWORD_RESET_URI: defaultValue: "" type: string description: The URI where a user can reset their password. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5651,7 +5651,7 @@ IDP_REFRESH_TOKEN_EXPIRATION: type: uint64 description: Refresh token lifespan in seconds (time before an refresh token is expired). This also limits the duration of an idle offline session. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5660,7 +5660,7 @@ IDP_SIGN_IN_URI: defaultValue: "" type: string description: IDP sign-in url. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5669,7 +5669,7 @@ IDP_SIGN_OUT_URI: defaultValue: "" type: string description: IDP sign-out url. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5679,7 +5679,7 @@ IDP_SIGNING_KID: type: string description: Value of the KID (Key ID) field which is used in created tokens to uniquely identify the signing-private-key. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5688,7 +5688,7 @@ IDP_SIGNING_METHOD: defaultValue: PS256 type: string description: Signing method of IDP requests like 'PS256' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5699,7 +5699,7 @@ IDP_SIGNING_PRIVATE_KEY_FILES: description: A list of private key files for signing IDP requests. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idp. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5710,7 +5710,7 @@ IDP_TLS: description: Disable or Enable HTTPS for the communication between the Proxy service and the IDP service. If set to 'true', the key and cert files need to be configured and present. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5720,7 +5720,7 @@ IDP_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5729,7 +5729,7 @@ IDP_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5738,7 +5738,7 @@ IDP_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5748,7 +5748,7 @@ IDP_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5758,7 +5758,7 @@ IDP_TRANSPORT_TLS_CERT: type: string description: Path/File name of the TLS server certificate (in PEM format) for the IDP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idp. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5769,7 +5769,7 @@ IDP_TRANSPORT_TLS_KEY: description: Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the IDP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idp. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5778,7 +5778,7 @@ IDP_URI_BASE_PATH: defaultValue: "" type: string description: IDP uri base path (defaults to ''). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5787,7 +5787,7 @@ IDP_USER_ENABLED_ATTRIBUTE: defaultValue: ownCloudUserEnabled type: string description: LDAP Attribute to use as a flag telling if the user is enabled or disabled. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5796,50 +5796,50 @@ IDP_VALIDATION_KEYS_PATH: defaultValue: "" type: string description: Path to validation keys for IDP requests. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" INVITATIONS_CORS_ALLOW_CREDENTIALS: - name: OCIS_CORS_ALLOW_CREDENTIALS;INVITATIONS_CORS_ALLOW_CREDENTIALS - defaultValue: "false" + name: OCIS_CORS_ALLOW_CREDENTIALS;SETTINGS_CORS_ALLOW_CREDENTIALS + defaultValue: "true" type: bool description: 'Allow credentials for CORS.See following chapter for more details: *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" INVITATIONS_CORS_ALLOW_HEADERS: - name: OCIS_CORS_ALLOW_HEADERS;INVITATIONS_CORS_ALLOW_HEADERS - defaultValue: '[]' + name: OCIS_CORS_ALLOW_HEADERS;SETTINGS_CORS_ALLOW_HEADERS + defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id]' type: '[]string' description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" INVITATIONS_CORS_ALLOW_METHODS: - name: OCIS_CORS_ALLOW_METHODS;INVITATIONS_CORS_ALLOW_METHODS - defaultValue: '[]' + name: OCIS_CORS_ALLOW_METHODS;SETTINGS_CORS_ALLOW_METHODS + defaultValue: '[GET POST PUT PATCH DELETE OPTIONS]' type: '[]string' description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" INVITATIONS_CORS_ALLOW_ORIGINS: - name: OCIS_CORS_ALLOW_ORIGINS;INVITATIONS_CORS_ALLOW_ORIGINS + name: OCIS_CORS_ALLOW_ORIGINS;SETTINGS_CORS_ALLOW_ORIGINS defaultValue: '[*]' type: '[]string' description: 'A list of allowed CORS origins. See following chapter for more details: *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5849,7 +5849,7 @@ INVITATIONS_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5858,7 +5858,7 @@ INVITATIONS_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5867,7 +5867,7 @@ INVITATIONS_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5877,7 +5877,7 @@ INVITATIONS_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5886,7 +5886,7 @@ INVITATIONS_HTTP_ADDR: defaultValue: 127.0.0.1:0 type: string description: The bind address of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5895,7 +5895,7 @@ INVITATIONS_HTTP_ROOT: defaultValue: /graph/v1.0 type: string description: Subdirectory that serves as the root for this HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5904,62 +5904,62 @@ INVITATIONS_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" INVITATIONS_KEYCLOAK_BASE_PATH: - name: OCIS_KEYCLOAK_BASE_PATH;INVITATIONS_KEYCLOAK_BASE_PATH + name: OCIS_KEYCLOAK_BASE_PATH;GRAPH_KEYCLOAK_BASE_PATH defaultValue: "" type: string description: The URL to access keycloak. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" INVITATIONS_KEYCLOAK_CLIENT_ID: - name: OCIS_KEYCLOAK_CLIENT_ID;INVITATIONS_KEYCLOAK_CLIENT_ID + name: OCIS_KEYCLOAK_CLIENT_ID;GRAPH_KEYCLOAK_CLIENT_ID defaultValue: "" type: string - description: The client ID to authenticate with keycloak. - introductionVersion: "" + description: The client id to authenticate with keycloak. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" INVITATIONS_KEYCLOAK_CLIENT_REALM: - name: OCIS_KEYCLOAK_CLIENT_REALM;INVITATIONS_KEYCLOAK_CLIENT_REALM + name: OCIS_KEYCLOAK_CLIENT_REALM;GRAPH_KEYCLOAK_CLIENT_REALM defaultValue: "" type: string description: The realm the client is defined in. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" INVITATIONS_KEYCLOAK_CLIENT_SECRET: - name: OCIS_KEYCLOAK_CLIENT_SECRET;INVITATIONS_KEYCLOAK_CLIENT_SECRET + name: OCIS_KEYCLOAK_CLIENT_SECRET;GRAPH_KEYCLOAK_CLIENT_SECRET defaultValue: "" type: string description: The client secret to use in authentication. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" INVITATIONS_KEYCLOAK_INSECURE_SKIP_VERIFY: - name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;INVITATIONS_KEYCLOAK_INSECURE_SKIP_VERIFY + name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;GRAPH_KEYCLOAK_INSECURE_SKIP_VERIFY defaultValue: "false" type: bool description: Disable TLS certificate validation for Keycloak connections. Do not set this in production environments. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" INVITATIONS_KEYCLOAK_USER_REALM: - name: OCIS_KEYCLOAK_USER_REALM;INVITATIONS_KEYCLOAK_USER_REALM + name: OCIS_KEYCLOAK_USER_REALM;GRAPH_KEYCLOAK_USER_REALM defaultValue: "" type: string description: The realm users are defined. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5968,7 +5968,7 @@ INVITATIONS_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5977,7 +5977,7 @@ INVITATIONS_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5987,7 +5987,7 @@ INVITATIONS_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -5996,7 +5996,7 @@ INVITATIONS_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6006,7 +6006,7 @@ INVITATIONS_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6015,7 +6015,7 @@ INVITATIONS_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6024,7 +6024,7 @@ INVITATIONS_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6034,7 +6034,7 @@ INVITATIONS_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6046,7 +6046,7 @@ LDAP_GROUP_SUBSTRING_FILTER_TYPE: Supported values are 'initial', 'final' and 'any'. The value 'initial' is used for doing prefix only searches, 'final' for doing suffix only searches or 'any' for doing full substring searches - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6056,7 +6056,7 @@ LDAP_LOGIN_ATTRIBUTES: type: '[]string' description: A list of user object attributes that can be used for login. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6065,7 +6065,7 @@ LDAP_USER_SCHEMA_DISPLAY_NAME: defaultValue: displayName type: string description: LDAP Attribute to use for the displayname of users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6076,7 +6076,7 @@ LDAP_USER_SUBSTRING_FILTER_TYPE: description: 'Type of substring search filter to use for substring searches for users. Possible values: ''initial'' for doing prefix only searches, ''final'' for doing suffix only searches or ''any'' for doing full substring searches' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6086,7 +6086,7 @@ NATS_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6095,7 +6095,7 @@ NATS_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6104,7 +6104,7 @@ NATS_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6114,7 +6114,7 @@ NATS_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6124,7 +6124,7 @@ NATS_EVENTS_ENABLE_TLS: type: bool description: Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6133,7 +6133,7 @@ NATS_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6142,7 +6142,7 @@ NATS_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6152,7 +6152,7 @@ NATS_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6161,7 +6161,7 @@ NATS_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6170,7 +6170,7 @@ NATS_NATS_CLUSTER_ID: defaultValue: ocis-cluster type: string description: ID of the NATS cluster. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6179,7 +6179,7 @@ NATS_NATS_HOST: defaultValue: 127.0.0.1 type: string description: Bind address. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6188,7 +6188,7 @@ NATS_NATS_PORT: defaultValue: "9233" type: int description: Bind port. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6198,7 +6198,7 @@ NATS_NATS_STORE_DIR: type: string description: The directory where the filesystem storage will store NATS JetStream data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/nats. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6208,7 +6208,7 @@ NATS_TLS_CERT: type: string description: Path/File name of the TLS server certificate (in PEM format) for the NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/nats. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6218,7 +6218,7 @@ NATS_TLS_KEY: type: string description: Path/File name for the TLS certificate key (in PEM format) for the NATS listener. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/nats. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6228,7 +6228,7 @@ NATS_TLS_SKIP_VERIFY_CLIENT_CERT: type: bool description: Whether the NATS server should skip the client certificate verification during the TLS handshake. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6238,7 +6238,7 @@ NATS_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6247,7 +6247,7 @@ NATS_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6256,7 +6256,7 @@ NATS_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6266,7 +6266,7 @@ NATS_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6276,7 +6276,7 @@ NOTIFICATIONS_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6285,7 +6285,7 @@ NOTIFICATIONS_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6294,7 +6294,7 @@ NOTIFICATIONS_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6304,7 +6304,7 @@ NOTIFICATIONS_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6313,7 +6313,7 @@ NOTIFICATIONS_EMAIL_TEMPLATE_PATH: defaultValue: "" type: string description: Path to Email notification templates overriding embedded ones. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6323,7 +6323,7 @@ NOTIFICATIONS_EVENTS_AUTH_PASSWORD: type: string description: The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6333,7 +6333,7 @@ NOTIFICATIONS_EVENTS_AUTH_USERNAME: type: string description: The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6344,7 +6344,7 @@ NOTIFICATIONS_EVENTS_CLUSTER: description: The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6354,7 +6354,7 @@ NOTIFICATIONS_EVENTS_ENABLE_TLS: type: bool description: Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6364,7 +6364,7 @@ NOTIFICATIONS_EVENTS_ENDPOINT: type: string description: The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6373,7 +6373,7 @@ NOTIFICATIONS_EVENTS_TLS_INSECURE: defaultValue: "false" type: bool description: Whether to verify the server TLS certificates. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6383,7 +6383,7 @@ NOTIFICATIONS_EVENTS_TLS_ROOT_CA_CERTIFICATE: type: string description: The root CA certificate used to validate the server's TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6392,7 +6392,7 @@ NOTIFICATIONS_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6401,7 +6401,7 @@ NOTIFICATIONS_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6411,7 +6411,7 @@ NOTIFICATIONS_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6420,7 +6420,7 @@ NOTIFICATIONS_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6430,7 +6430,7 @@ NOTIFICATIONS_SERVICE_ACCOUNT_ID: type: string description: The ID of the service account the service should use. See the 'auth-service' service description for more details. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6439,7 +6439,7 @@ NOTIFICATIONS_SERVICE_ACCOUNT_SECRET: defaultValue: "" type: string description: The service account secret. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6450,7 +6450,7 @@ NOTIFICATIONS_SMTP_AUTHENTICATION: description: Authentication method for the SMTP communication. Possible values are 'login', 'plain', 'crammd5', 'none' or 'auto'. If set to 'auto' or unset, the authentication method is automatically negotiated with the server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6460,7 +6460,7 @@ NOTIFICATIONS_SMTP_ENCRYPTION: type: string description: Encryption method for the SMTP communication. Possible values are 'starttls', 'ssl', 'ssltls', 'tls' and 'none'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: 5.0.0 removalVersion: 6.0.0 deprecationInfo: The NOTIFICATIONS_SMTP_ENCRYPTION values 'ssl' and 'tls' are deprecated @@ -6470,7 +6470,7 @@ NOTIFICATIONS_SMTP_HOST: defaultValue: "" type: string description: SMTP host to connect to. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6479,7 +6479,7 @@ NOTIFICATIONS_SMTP_INSECURE: defaultValue: "false" type: bool description: Allow insecure connections to the SMTP server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6488,7 +6488,7 @@ NOTIFICATIONS_SMTP_PASSWORD: defaultValue: "" type: string description: Password for the SMTP host to connect to. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6497,7 +6497,7 @@ NOTIFICATIONS_SMTP_PORT: defaultValue: "0" type: int description: Port of the SMTP host to connect to. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6506,7 +6506,7 @@ NOTIFICATIONS_SMTP_SENDER: defaultValue: "" type: string description: Sender address of emails that will be sent (e.g. 'ownCloud '. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6515,7 +6515,7 @@ NOTIFICATIONS_SMTP_USERNAME: defaultValue: "" type: string description: Username for the SMTP host to connect to. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6525,7 +6525,7 @@ NOTIFICATIONS_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6534,7 +6534,7 @@ NOTIFICATIONS_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6543,7 +6543,7 @@ NOTIFICATIONS_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6553,7 +6553,7 @@ NOTIFICATIONS_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6564,7 +6564,7 @@ NOTIFICATIONS_TRANSLATION_PATH: description: (optional) Set this to a path with custom translations to overwrite the builtin translations. Note that file and folder naming rules apply, see the documentation for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6574,7 +6574,7 @@ NOTIFICATIONS_WEB_UI_URL: type: string description: The public facing URL of the oCIS Web UI, used e.g. when sending notification eMails - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6585,7 +6585,7 @@ OCDAV_ALLOW_PROPFIND_DEPTH_INFINITY: description: Allow the use of depth infinity in PROPFINDS. When enabled, a propfind will traverse through all subfolders. If many subfolders are expected, depth infinity can cause heavy server load and/or delayed response times. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6595,7 +6595,7 @@ OCDAV_CORS_ALLOW_CREDENTIALS: type: bool description: 'Allow credentials for CORS.See following chapter for more details: *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6609,7 +6609,7 @@ OCDAV_CORS_ALLOW_HEADERS: description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6621,7 +6621,7 @@ OCDAV_CORS_ALLOW_METHODS: description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6632,7 +6632,7 @@ OCDAV_CORS_ALLOW_ORIGINS: description: 'A list of allowed CORS origins. See following chapter for more details: *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6642,7 +6642,7 @@ OCDAV_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6651,7 +6651,7 @@ OCDAV_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6660,7 +6660,7 @@ OCDAV_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6670,16 +6670,16 @@ OCDAV_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCDAV_EDITION: - name: OCIS_EDITION;OCDAV_EDITION + name: OCIS_EDITION;FRONTEND_EDITION defaultValue: Community type: string - description: "" - introductionVersion: "" + description: Edition of oCIS. Used for branding pruposes. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6689,7 +6689,7 @@ OCDAV_FILES_NAMESPACE: type: string description: Jail requests to /dav/files/{username} into this CS3 namespace. Supports template layouting with CS3 User properties. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6699,7 +6699,7 @@ OCDAV_GATEWAY_REQUEST_TIMEOUT: type: int64 description: Request timeout in seconds for requests from the oCDAV service to the GATEWAY service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6708,7 +6708,7 @@ OCDAV_HTTP_ADDR: defaultValue: 127.0.0.1:0 type: string description: The bind address of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6717,7 +6717,7 @@ OCDAV_HTTP_PREFIX: defaultValue: "" type: string description: A URL path prefix for the handler. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6726,7 +6726,7 @@ OCDAV_HTTP_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6735,7 +6735,7 @@ OCDAV_INSECURE: defaultValue: "false" type: bool description: Allow insecure connections to the GATEWAY service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6744,7 +6744,7 @@ OCDAV_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6753,7 +6753,7 @@ OCDAV_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6762,7 +6762,7 @@ OCDAV_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6772,7 +6772,7 @@ OCDAV_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6781,7 +6781,7 @@ OCDAV_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6791,7 +6791,7 @@ OCDAV_MACHINE_AUTH_API_KEY: type: string description: Machine auth API key used to validate internal requests necessary for the access to resources from other services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6800,7 +6800,7 @@ OCDAV_OCM_NAMESPACE: defaultValue: /public type: string description: The human readable path prefix for the ocm shares. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6809,7 +6809,7 @@ OCDAV_PUBLIC_URL: defaultValue: https://localhost:9200 type: string description: URL where oCIS is reachable for users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6819,7 +6819,7 @@ OCDAV_SHARES_NAMESPACE: type: string description: The human readable path for the share jail. Relative to a users personal space root. Upcased intentionally. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6829,7 +6829,7 @@ OCDAV_SKIP_USER_GROUPS_IN_TOKEN: type: bool description: Disables the loading of user's group memberships from the reva access token. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6839,7 +6839,7 @@ OCDAV_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6848,7 +6848,7 @@ OCDAV_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6857,7 +6857,7 @@ OCDAV_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6867,7 +6867,7 @@ OCDAV_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6877,18 +6877,18 @@ OCDAV_WEBDAV_NAMESPACE: type: string description: Jail requests to /dav/webdav into this CS3 namespace. Supports template layouting with CS3 User properties. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_ADMIN_USER_ID: - name: OCIS_ADMIN_USER_ID;IDM_ADMIN_USER_ID + name: OCIS_ADMIN_USER_ID;SETTINGS_ADMIN_USER_ID defaultValue: "" type: string description: ID of the user that should receive admin privileges. Consider that the UUID can be encoded in some LDAP deployment configurations like in .ldif files. These need to be decoded beforehand. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6897,134 +6897,133 @@ OCIS_ASYNC_UPLOADS: defaultValue: "true" type: bool description: Enable asynchronous file uploads. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_AUTH_PASSWORD: - name: OCIS_CACHE_AUTH_PASSWORD;STORAGE_SYSTEM_CACHE_AUTH_PASSWORD + name: OCIS_CACHE_AUTH_PASSWORD;SETTINGS_CACHE_AUTH_PASSWORD defaultValue: "" type: string - description: Password for the configured store. Only applies when store type 'nats-js-kv' - is configured. - introductionVersion: "" + description: The password to authenticate with the cache. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_AUTH_USERNAME: - name: OCIS_CACHE_AUTH_USERNAME;STORAGE_SYSTEM_CACHE_AUTH_USERNAME + name: OCIS_CACHE_AUTH_USERNAME;SETTINGS_CACHE_AUTH_USERNAME defaultValue: "" type: string - description: Username for the configured store. Only applies when store type 'nats-js-kv' - is configured. - introductionVersion: "" + description: The username to authenticate with the cache. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_DATABASE: name: OCIS_CACHE_DATABASE - defaultValue: storage-system + defaultValue: settings-cache type: string description: The database name the configured store should use. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_DISABLE_PERSISTENCE: - name: OCIS_CACHE_DISABLE_PERSISTENCE;STORAGE_SYSTEM_CACHE_DISABLE_PERSISTENCE + name: OCIS_CACHE_DISABLE_PERSISTENCE;SETTINGS_CACHE_DISABLE_PERSISTENCE defaultValue: "false" type: bool description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_SIZE: - name: OCIS_CACHE_SIZE;STORAGE_SYSTEM_CACHE_SIZE + name: OCIS_CACHE_SIZE;SETTINGS_CACHE_SIZE defaultValue: "0" type: int - description: The maximum quantity of items in the user info cache. Only applies - when store type 'ocmem' is configured. Defaults to 512 which is derived from the - ocmem package though not exclicitely set as default. - introductionVersion: "" + description: The maximum quantity of items in the cache. Only applies when store + type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package + though not exclicitely set as default. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_STORE: - name: OCIS_CACHE_STORE;STORAGE_SYSTEM_CACHE_STORE + name: OCIS_CACHE_STORE;SETTINGS_CACHE_STORE defaultValue: memory type: string description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', ''nats-js-kv'', ''noop''. See the text description for details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_STORE_NODES: - name: OCIS_CACHE_STORE_NODES;STORAGE_SYSTEM_CACHE_STORE_NODES + name: OCIS_CACHE_STORE_NODES;SETTINGS_CACHE_STORE_NODES defaultValue: '[127.0.0.1:9233]' type: '[]string' description: A list of nodes to access the configured store. This has no effect when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_TTL: - name: OCIS_CACHE_TTL;STORAGE_SYSTEM_CACHE_TTL - defaultValue: 24m0s + name: OCIS_CACHE_TTL;SETTINGS_CACHE_TTL + defaultValue: 10m0s type: Duration - description: Default time to live for user info in the user info cache. Only applied - when access tokens has no expiration. See the Environment Variable Types description - for more details. - introductionVersion: "" + description: Default time to live for entries in the cache. Only applied when access + tokens has no expiration. See the Environment Variable Types description for more + details. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_CREDENTIALS: - name: OCIS_CORS_ALLOW_CREDENTIALS;USERLOG_CORS_ALLOW_CREDENTIALS + name: OCIS_CORS_ALLOW_CREDENTIALS;SETTINGS_CORS_ALLOW_CREDENTIALS defaultValue: "true" type: bool description: 'Allow credentials for CORS.See following chapter for more details: *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_HEADERS: - name: OCIS_CORS_ALLOW_HEADERS;USERLOG_CORS_ALLOW_HEADERS - defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id - Ocs-Apirequest]' + name: OCIS_CORS_ALLOW_HEADERS;SETTINGS_CORS_ALLOW_HEADERS + defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id]' type: '[]string' description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_METHODS: - name: OCIS_CORS_ALLOW_METHODS;USERLOG_CORS_ALLOW_METHODS - defaultValue: '[GET]' + name: OCIS_CORS_ALLOW_METHODS;SETTINGS_CORS_ALLOW_METHODS + defaultValue: '[GET POST PUT PATCH DELETE OPTIONS]' type: '[]string' description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_ORIGINS: - name: OCIS_CORS_ALLOW_ORIGINS;USERLOG_CORS_ALLOW_ORIGINS + name: OCIS_CORS_ALLOW_ORIGINS;SETTINGS_CORS_ALLOW_ORIGINS defaultValue: '[*]' type: '[]string' description: 'A list of allowed CORS origins. See following chapter for more details: *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7059,7 +7058,7 @@ OCIS_DECOMPOSEDFS_METADATA_BACKEND: description: The backend to use for storing metadata. Supported values are 'messagepack' and 'xattrs'. The setting 'messagepack' uses a dedicated file to store file metadata while 'xattrs' uses extended attributes to store file metadata. Defaults to 'messagepack'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7069,7 +7068,7 @@ OCIS_DECOMPOSEDFS_PROPAGATOR: type: string description: The propagator used for decomposedfs. At the moment, only 'sync' is fully supported, 'async' is available as an experimental option. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7079,7 +7078,7 @@ OCIS_DEFAULT_LANGUAGE: type: string description: The default language used by services and the WebUI. If not defined, English will be used as default. See the documentation for more details. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7090,7 +7089,7 @@ OCIS_DISABLE_PREVIEWS: description: Set this option to 'true' to disable rendering of thumbnails triggered via webdav access. Note that when disabled, all access to preview related webdav paths will return a 404. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7100,7 +7099,7 @@ OCIS_DISABLE_SSE: type: bool description: When set to true, clients are informed that the Server-Sent Events endpoint is not accessible. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7110,16 +7109,16 @@ OCIS_DISABLE_SSE,USERLOG_DISABLE_SSE: type: bool description: Disables server-sent events (sse). When disabled, clients will no longer receive sse notifications. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_EDITION: - name: OCIS_EDITION;OCDAV_EDITION + name: OCIS_EDITION;FRONTEND_EDITION defaultValue: Community type: string - description: "" - introductionVersion: "" + description: Edition of oCIS. Used for branding pruposes. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7128,7 +7127,7 @@ OCIS_EMAIL_TEMPLATE_PATH: defaultValue: "" type: string description: Path to Email notification templates overriding embedded ones. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7138,68 +7137,68 @@ OCIS_ENABLE_RESHARING: type: bool description: Changing this value is NOT supported. Enables the support for resharing in the clients. - introductionVersion: "" - deprecationVersion: "" + introductionVersion: pre5.0 + deprecationVersion: "5.0" removalVersion: "" - deprecationInfo: "" + deprecationInfo: Resharing will be removed in the future. OCIS_EVENTS_AUTH_PASSWORD: - name: OCIS_EVENTS_AUTH_PASSWORD;USERLOG_EVENTS_AUTH_PASSWORD + name: OCIS_EVENTS_AUTH_PASSWORD;FRONTEND_EVENTS_AUTH_PASSWORD defaultValue: "" type: string description: The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_EVENTS_AUTH_USERNAME: - name: OCIS_EVENTS_AUTH_USERNAME;USERLOG_EVENTS_AUTH_USERNAME + name: OCIS_EVENTS_AUTH_USERNAME;FRONTEND_EVENTS_AUTH_USERNAME defaultValue: "" type: string description: The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_EVENTS_CLUSTER: - name: OCIS_EVENTS_CLUSTER;USERLOG_EVENTS_CLUSTER + name: OCIS_EVENTS_CLUSTER;FRONTEND_EVENTS_CLUSTER defaultValue: ocis-cluster type: string description: The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_EVENTS_ENABLE_TLS: - name: OCIS_EVENTS_ENABLE_TLS;NATS_EVENTS_ENABLE_TLS + name: OCIS_EVENTS_ENABLE_TLS;FRONTEND_EVENTS_ENABLE_TLS defaultValue: "false" type: bool description: Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_EVENTS_ENDPOINT: - name: OCIS_EVENTS_ENDPOINT;USERLOG_EVENTS_ENDPOINT + name: OCIS_EVENTS_ENDPOINT;FRONTEND_EVENTS_ENDPOINT defaultValue: 127.0.0.1:9233 type: string description: The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE: - name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;USERLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;AUDIT_EVENTS_TLS_ROOT_CA_CERTIFICATE defaultValue: "" type: string description: The root CA certificate used to validate the server's TLS certificate. - If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. - introductionVersion: "" + If provided AUDIT_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7208,7 +7207,7 @@ OCIS_GATEWAY_GRPC_ADDR: defaultValue: 127.0.0.1:9142 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7218,7 +7217,7 @@ OCIS_GRPC_CLIENT_TLS_CACERT: type: string description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the go-micro based grpc services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7231,7 +7230,7 @@ OCIS_GRPC_CLIENT_TLS_MODE: security for the clients. ''insecure'' allows using transport security, but disables certificate verification (to be used with the autogenerated self-signed certificates). ''on'' enables transport security, including server certificate verification.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7241,7 +7240,7 @@ OCIS_HTTP_TLS_CERTIFICATE: type: string description: Path/File name of the TLS server certificate (in PEM format) for the http services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7252,7 +7251,7 @@ OCIS_HTTP_TLS_ENABLED: description: Activates TLS for the http based services using the server certifcate and key configured via OCIS_HTTP_TLS_CERTIFICATE and OCIS_HTTP_TLS_KEY. If OCIS_HTTP_TLS_CERTIFICATE is not set a temporary server certificate is generated - to be used with PROXY_INSECURE_BACKEND=true. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7262,110 +7261,111 @@ OCIS_HTTP_TLS_KEY: type: string description: Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the http services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_INSECURE: - name: OCIS_INSECURE;THUMBNAILS_CS3SOURCE_INSECURE + name: OCIS_INSECURE;PROXY_OIDC_INSECURE defaultValue: "false" type: bool - description: Ignore untrusted SSL certificates when connecting to the CS3 source. - introductionVersion: "" + description: Disable TLS certificate validation for connections to the IDP. Note + that this is not recommended for production environments. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_JWT_SECRET: - name: OCIS_JWT_SECRET;AUTH_MACHINE_JWT_SECRET + name: OCIS_JWT_SECRET;SETTINGS_JWT_SECRET defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_BASE_PATH: - name: OCIS_KEYCLOAK_BASE_PATH;INVITATIONS_KEYCLOAK_BASE_PATH + name: OCIS_KEYCLOAK_BASE_PATH;GRAPH_KEYCLOAK_BASE_PATH defaultValue: "" type: string description: The URL to access keycloak. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_CLIENT_ID: - name: OCIS_KEYCLOAK_CLIENT_ID;INVITATIONS_KEYCLOAK_CLIENT_ID + name: OCIS_KEYCLOAK_CLIENT_ID;GRAPH_KEYCLOAK_CLIENT_ID defaultValue: "" type: string - description: The client ID to authenticate with keycloak. - introductionVersion: "" + description: The client id to authenticate with keycloak. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_CLIENT_REALM: - name: OCIS_KEYCLOAK_CLIENT_REALM;INVITATIONS_KEYCLOAK_CLIENT_REALM + name: OCIS_KEYCLOAK_CLIENT_REALM;GRAPH_KEYCLOAK_CLIENT_REALM defaultValue: "" type: string description: The realm the client is defined in. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_CLIENT_SECRET: - name: OCIS_KEYCLOAK_CLIENT_SECRET;INVITATIONS_KEYCLOAK_CLIENT_SECRET + name: OCIS_KEYCLOAK_CLIENT_SECRET;GRAPH_KEYCLOAK_CLIENT_SECRET defaultValue: "" type: string description: The client secret to use in authentication. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY: - name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;INVITATIONS_KEYCLOAK_INSECURE_SKIP_VERIFY + name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;GRAPH_KEYCLOAK_INSECURE_SKIP_VERIFY defaultValue: "false" type: bool description: Disable TLS certificate validation for Keycloak connections. Do not set this in production environments. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_USER_REALM: - name: OCIS_KEYCLOAK_USER_REALM;INVITATIONS_KEYCLOAK_USER_REALM + name: OCIS_KEYCLOAK_USER_REALM;GRAPH_KEYCLOAK_USER_REALM defaultValue: "" type: string description: The realm users are defined. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_BIND_DN: - name: OCIS_LDAP_BIND_DN;GROUPS_LDAP_BIND_DN + name: OCIS_LDAP_BIND_DN;AUTH_BASIC_LDAP_BIND_DN defaultValue: uid=reva,ou=sysusers,o=libregraph-idm type: string description: LDAP DN to use for simple bind authentication with the target LDAP server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_BIND_PASSWORD: - name: OCIS_LDAP_BIND_PASSWORD;GROUPS_LDAP_BIND_PASSWORD + name: OCIS_LDAP_BIND_PASSWORD;AUTH_BASIC_LDAP_BIND_PASSWORD defaultValue: "" type: string description: Password to use for authenticating the 'bind_dn'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_CACERT: - name: OCIS_LDAP_CACERT;GROUPS_LDAP_CACERT + name: OCIS_LDAP_CACERT;AUTH_BASIC_LDAP_CACERT defaultValue: /var/lib/ocis/idm/ldap.crt type: string description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7378,7 +7378,7 @@ OCIS_LDAP_DISABLE_USER_MECHANISM: will add the user to the configured group for disabled users, if set to 'attribute' this will be done in the ldap user entry, if set to 'none' the disable request is not processed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7388,113 +7388,113 @@ OCIS_LDAP_DISABLED_USERS_GROUP_DN: type: string description: The distinguished name of the group to which added users will be classified as disabled when 'disable_user_mechanism' is set to 'group'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_BASE_DN: - name: OCIS_LDAP_GROUP_BASE_DN;GROUPS_LDAP_GROUP_BASE_DN + name: OCIS_LDAP_GROUP_BASE_DN;AUTH_BASIC_LDAP_GROUP_BASE_DN defaultValue: ou=groups,o=libregraph-idm type: string description: Search base DN for looking up LDAP groups. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_FILTER: - name: OCIS_LDAP_GROUP_FILTER;GROUPS_LDAP_GROUP_FILTER + name: OCIS_LDAP_GROUP_FILTER;AUTH_BASIC_LDAP_GROUP_FILTER defaultValue: "" type: string description: LDAP filter to add to the default filters for group searches. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_OBJECTCLASS: - name: OCIS_LDAP_GROUP_OBJECTCLASS;GROUPS_LDAP_GROUP_OBJECTCLASS + name: OCIS_LDAP_GROUP_OBJECTCLASS;AUTH_BASIC_LDAP_GROUP_OBJECTCLASS defaultValue: groupOfNames type: string description: The object class to use for groups in the default group search filter ('groupOfNames'). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME: - name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;GROUPS_LDAP_GROUP_SCHEMA_DISPLAYNAME + name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;AUTH_BASIC_LDAP_GROUP_SCHEMA_DISPLAYNAME defaultValue: cn type: string description: LDAP Attribute to use for the displayname of groups (often the same as groupname attribute). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCHEMA_GROUPNAME: - name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;GROUPS_LDAP_GROUP_SCHEMA_GROUPNAME + name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;AUTH_BASIC_LDAP_GROUP_SCHEMA_GROUPNAME defaultValue: cn type: string description: LDAP Attribute to use for the name of groups. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCHEMA_ID: - name: OCIS_LDAP_GROUP_SCHEMA_ID;GROUPS_LDAP_GROUP_SCHEMA_ID + name: OCIS_LDAP_GROUP_SCHEMA_ID;AUTH_BASIC_LDAP_GROUP_SCHEMA_ID defaultValue: ownclouduuid type: string description: LDAP Attribute to use as the unique id for groups. This should be a - stable globally unique ID like a UUID. - introductionVersion: "" + stable globally unique id (e.g. a UUID). + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING: - name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;GROUPS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING + name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;AUTH_BASIC_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING defaultValue: "false" type: bool description: Set this to true if the defined 'id' attribute for groups is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute - of Active Directory for the group ID's. - introductionVersion: "" + of Active Directory for the group IDs. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCHEMA_MAIL: - name: OCIS_LDAP_GROUP_SCHEMA_MAIL;GROUPS_LDAP_GROUP_SCHEMA_MAIL + name: OCIS_LDAP_GROUP_SCHEMA_MAIL;AUTH_BASIC_LDAP_GROUP_SCHEMA_MAIL defaultValue: mail type: string description: LDAP Attribute to use for the email address of groups (can be empty). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCHEMA_MEMBER: - name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;GROUPS_LDAP_GROUP_SCHEMA_MEMBER + name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;AUTH_BASIC_LDAP_GROUP_SCHEMA_MEMBER defaultValue: member type: string description: LDAP Attribute that is used for group members. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCOPE: - name: OCIS_LDAP_GROUP_SCOPE;GROUPS_LDAP_GROUP_SCOPE + name: OCIS_LDAP_GROUP_SCOPE;AUTH_BASIC_LDAP_GROUP_SCOPE defaultValue: sub type: string - description: LDAP search scope to use when looking up groups. Supported scopes are + description: LDAP search scope to use when looking up groups. Supported values are 'base', 'one' and 'sub'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_INSECURE: - name: OCIS_LDAP_INSECURE;GROUPS_LDAP_INSECURE + name: OCIS_LDAP_INSECURE;AUTH_BASIC_LDAP_INSECURE defaultValue: "false" type: bool description: Disable TLS certificate validation for the LDAP connections. Do not set this in production environments. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7506,93 +7506,93 @@ OCIS_LDAP_SERVER_WRITE_ENABLED: This can only be set to 'true' when keeping default settings for the LDAP user and group attribute types (the 'OCIS_LDAP_USER_SCHEMA_* and 'OCIS_LDAP_GROUP_SCHEMA_* variables). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_URI: - name: OCIS_LDAP_URI;GROUPS_LDAP_URI + name: OCIS_LDAP_URI;AUTH_BASIC_LDAP_URI defaultValue: ldaps://localhost:9235 type: string description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_BASE_DN: - name: OCIS_LDAP_USER_BASE_DN;GROUPS_LDAP_USER_BASE_DN + name: OCIS_LDAP_USER_BASE_DN;AUTH_BASIC_LDAP_USER_BASE_DN defaultValue: ou=users,o=libregraph-idm type: string description: Search base DN for looking up LDAP users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_ENABLED_ATTRIBUTE: - name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;IDP_USER_ENABLED_ATTRIBUTE + name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;AUTH_BASIC_LDAP_USER_ENABLED_ATTRIBUTE defaultValue: ownCloudUserEnabled type: string - description: LDAP Attribute to use as a flag telling if the user is enabled or disabled. - introductionVersion: "" + description: LDAP attribute to use as a flag telling if the user is enabled or disabled. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_FILTER: - name: OCIS_LDAP_USER_FILTER;GROUPS_LDAP_USER_FILTER + name: OCIS_LDAP_USER_FILTER;AUTH_BASIC_LDAP_USER_FILTER defaultValue: "" type: string description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_OBJECTCLASS: - name: OCIS_LDAP_USER_OBJECTCLASS;GROUPS_LDAP_USER_OBJECTCLASS + name: OCIS_LDAP_USER_OBJECTCLASS;AUTH_BASIC_LDAP_USER_OBJECTCLASS defaultValue: inetOrgPerson type: string description: The object class to use for users in the default user search filter ('inetOrgPerson'). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_DISPLAYNAME: - name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;GROUPS_LDAP_USER_SCHEMA_DISPLAYNAME + name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;AUTH_BASIC_LDAP_USER_SCHEMA_DISPLAYNAME defaultValue: displayname type: string description: LDAP Attribute to use for the displayname of users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_ID: - name: OCIS_LDAP_USER_SCHEMA_ID;GROUPS_LDAP_USER_SCHEMA_ID + name: OCIS_LDAP_USER_SCHEMA_ID;AUTH_BASIC_LDAP_USER_SCHEMA_ID defaultValue: ownclouduuid type: string - description: LDAP Attribute to use as the unique id for users. This should be a - stable globally unique id like a UUID. - introductionVersion: "" + description: LDAP Attribute to use as the unique ID for users. This should be a + stable globally unique ID like a UUID. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING: - name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;GROUPS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING + name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;AUTH_BASIC_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING defaultValue: "false" type: bool description: Set this to true if the defined 'ID' attribute for users is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute - of Active Directory for the user ID's. - introductionVersion: "" + of Active Directory for the user IDs. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_MAIL: - name: OCIS_LDAP_USER_SCHEMA_MAIL;GROUPS_LDAP_USER_SCHEMA_MAIL + name: OCIS_LDAP_USER_SCHEMA_MAIL;AUTH_BASIC_LDAP_USER_SCHEMA_MAIL defaultValue: mail type: string description: LDAP Attribute to use for the email address of users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7602,73 +7602,73 @@ OCIS_LDAP_USER_SCHEMA_USER_TYPE: type: string description: LDAP Attribute to distinguish between 'Member' and 'Guest' users. Default is 'ownCloudUserType'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_USERNAME: - name: OCIS_LDAP_USER_SCHEMA_USERNAME;GROUPS_LDAP_USER_SCHEMA_USERNAME + name: OCIS_LDAP_USER_SCHEMA_USERNAME;AUTH_BASIC_LDAP_USER_SCHEMA_USERNAME defaultValue: uid type: string description: LDAP Attribute to use for username of users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCOPE: - name: OCIS_LDAP_USER_SCOPE;GROUPS_LDAP_USER_SCOPE + name: OCIS_LDAP_USER_SCOPE;AUTH_BASIC_LDAP_USER_SCOPE defaultValue: sub type: string - description: LDAP search scope to use when looking up users. Supported scopes are + description: LDAP search scope to use when looking up users. Supported values are 'base', 'one' and 'sub'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LOG_COLOR: - name: OCIS_LOG_COLOR;THUMBNAILS_LOG_COLOR + name: OCIS_LOG_COLOR;SETTINGS_LOG_COLOR defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LOG_FILE: - name: OCIS_LOG_FILE;THUMBNAILS_LOG_FILE + name: OCIS_LOG_FILE;SETTINGS_LOG_FILE defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LOG_LEVEL: - name: OCIS_LOG_LEVEL;THUMBNAILS_LOG_LEVEL + name: OCIS_LOG_LEVEL;SETTINGS_LOG_LEVEL defaultValue: "" type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LOG_PRETTY: - name: OCIS_LOG_PRETTY;THUMBNAILS_LOG_PRETTY + name: OCIS_LOG_PRETTY;SETTINGS_LOG_PRETTY defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_MACHINE_AUTH_API_KEY: - name: OCIS_MACHINE_AUTH_API_KEY;AUTH_MACHINE_API_KEY + name: OCIS_MACHINE_AUTH_API_KEY;PROXY_MACHINE_AUTH_API_KEY defaultValue: "" type: string - description: Machine auth API key used to validate internal requests necessary for - the access to resources from other services. - introductionVersion: "" + description: Machine auth API key used to validate internal requests necessary to + access resources from other services. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7679,17 +7679,16 @@ OCIS_OIDC_CLIENT_ID: description: The OIDC client ID which ownCloud Web uses. This client needs to be set up in your IDP. Note that this setting has no effect when using the builtin IDP. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_OIDC_ISSUER: - name: OCIS_URL;OCIS_OIDC_ISSUER;GROUPS_IDP_URL + name: OCIS_URL;OCIS_OIDC_ISSUER;PROXY_OIDC_ISSUER defaultValue: https://localhost:9200 type: string - description: The identity provider value to set in the group IDs of the CS3 group - objects for groups returned by this group provider. - introductionVersion: "" + description: URL of the OIDC issuer. It defaults to URL of the builtin IDP. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7699,7 +7698,7 @@ OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST: type: string description: Path to the 'banned passwords list' file. See the documentation for more details. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7708,7 +7707,7 @@ OCIS_PASSWORD_POLICY_DISABLED: defaultValue: "false" type: bool description: Disable the password policy. Defaults to false if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7717,7 +7716,7 @@ OCIS_PASSWORD_POLICY_MIN_CHARACTERS: defaultValue: "8" type: int description: Define the minimum password length. Defaults to 8 if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7726,7 +7725,7 @@ OCIS_PASSWORD_POLICY_MIN_DIGITS: defaultValue: "1" type: int description: Define the minimum number of digits. Defaults to 1 if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7736,7 +7735,7 @@ OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS: type: int description: Define the minimum number of uppercase letters. Defaults to 1 if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7746,7 +7745,7 @@ OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS: type: int description: Define the minimum number of characters from the special characters list to be present. Defaults to 1 if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7756,71 +7755,71 @@ OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS: type: int description: Define the minimum number of lowercase letters. Defaults to 1 if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE: - name: OCIS_PERSISTENT_STORE;USERLOG_STORE + name: OCIS_PERSISTENT_STORE;EVENTHISTORY_STORE defaultValue: memory type: string description: 'The type of the store. Supported values are: ''memory'', ''ocmem'', ''etcd'', ''redis'', ''redis-sentinel'', ''nats-js'', ''noop''. See the text description for details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE_AUTH_PASSWORD: - name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;USERLOG_STORE_AUTH_PASSWORD + name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;EVENTHISTORY_STORE_AUTH_PASSWORD defaultValue: "" type: string description: The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE_AUTH_USERNAME: - name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;USERLOG_STORE_AUTH_USERNAME + name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;EVENTHISTORY_STORE_AUTH_USERNAME defaultValue: "" type: string description: The username to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE_NODES: - name: OCIS_PERSISTENT_STORE_NODES;USERLOG_STORE_NODES + name: OCIS_PERSISTENT_STORE_NODES;EVENTHISTORY_STORE_NODES defaultValue: '[]' type: '[]string' description: A list of nodes to access the configured store. This has no effect when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE_SIZE: - name: OCIS_PERSISTENT_STORE_SIZE;USERLOG_STORE_SIZE + name: OCIS_PERSISTENT_STORE_SIZE;EVENTHISTORY_STORE_SIZE defaultValue: "0" type: int description: The maximum quantity of items in the store. Only applies when store - type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package - though not exclicitely set as default. - introductionVersion: "" + type 'ocmem' is configured. Defaults to 512 which is derived and used from the + ocmem package though no explicit default was set. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE_TTL: - name: OCIS_PERSISTENT_STORE_TTL;USERLOG_STORE_TTL + name: OCIS_PERSISTENT_STORE_TTL;EVENTHISTORY_STORE_TTL defaultValue: 336h0m0s type: Duration description: Time to live for events in the store. Defaults to '336h' (2 weeks). See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7829,7 +7828,7 @@ OCIS_PUBLIC_URL: defaultValue: https://127.0.0.1:9200 type: string description: URL, where oCIS is reachable for users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7837,8 +7836,8 @@ OCIS_REVA_GATEWAY: name: OCIS_REVA_GATEWAY defaultValue: com.owncloud.api.gateway type: string - description: CS3 gateway used to look up user metadata - introductionVersion: "" + description: The CS3 gateway endpoint. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7847,7 +7846,7 @@ OCIS_REVA_GATEWAY_TLS_CACERT: defaultValue: "" type: string description: The root CA certificate used to validate the gateway's TLS certificate. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7860,26 +7859,28 @@ OCIS_REVA_GATEWAY_TLS_MODE: for the clients. ''insecure'' allows using transport security, but disables certificate verification (to be used with the autogenerated self-signed certificates). ''on'' enables transport security, including server certificate verification.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_SERVICE_ACCOUNT_ID: - name: OCIS_SERVICE_ACCOUNT_ID;USERLOG_SERVICE_ACCOUNT_ID + name: SETTINGS_SERVICE_ACCOUNT_IDS;OCIS_SERVICE_ACCOUNT_ID defaultValue: "" - type: string - description: The ID of the service account the service should use. See the 'auth-service' - service description for more details. - introductionVersion: "" + type: '[]string' + description: 'The list of all service account IDs. These will be assigned the hidden + ''service-account'' role. Note: When using ''OCIS_SERVICE_ACCOUNT_ID'' this will + contain only one value while ''SETTINGS_SERVICE_ACCOUNT_IDS'' can have multiple. + See the ''auth-service'' service description for more details about service accounts.' + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_SERVICE_ACCOUNT_SECRET: - name: OCIS_SERVICE_ACCOUNT_SECRET;USERLOG_SERVICE_ACCOUNT_SECRET + name: OCIS_SERVICE_ACCOUNT_SECRET;PROXY_SERVICE_ACCOUNT_SECRET defaultValue: "" type: string description: The service account secret. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7888,7 +7889,7 @@ OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD: defaultValue: "true" type: bool description: Set this to true if you want to enforce passwords on all public shares. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7898,7 +7899,7 @@ OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD: type: bool description: Set this to true if you want to enforce passwords on Uploader, Editor or Contributor shares. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7908,7 +7909,7 @@ OCIS_SPACES_MAX_QUOTA: type: uint64 description: Set the global max quota value in bytes. A value of 0 equals unlimited. The value is provided via capabilities. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7917,19 +7918,19 @@ OCIS_SYSTEM_USER_API_KEY: defaultValue: "" type: string description: API key for the STORAGE-SYSTEM system user. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_SYSTEM_USER_ID: - name: OCIS_SYSTEM_USER_ID + name: OCIS_SYSTEM_USER_ID;SETTINGS_SYSTEM_USER_ID defaultValue: "" type: string - description: ID of the oCIS storage-system system user. Admins need to set the ID + description: ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7938,45 +7939,45 @@ OCIS_SYSTEM_USER_IDP: defaultValue: internal type: string description: IDP of the oCIS STORAGE-SYSTEM system user. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_TRACING_COLLECTOR: - name: OCIS_TRACING_COLLECTOR;THUMBNAILS_TRACING_COLLECTOR + name: OCIS_TRACING_COLLECTOR;SETTINGS_TRACING_COLLECTOR defaultValue: "" type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_TRACING_ENABLED: - name: OCIS_TRACING_ENABLED;THUMBNAILS_TRACING_ENABLED + name: OCIS_TRACING_ENABLED;SETTINGS_TRACING_ENABLED defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_TRACING_ENDPOINT: - name: OCIS_TRACING_ENDPOINT;THUMBNAILS_TRACING_ENDPOINT + name: OCIS_TRACING_ENDPOINT;SETTINGS_TRACING_ENDPOINT defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_TRACING_TYPE: - name: OCIS_TRACING_TYPE;THUMBNAILS_TRACING_TYPE + name: OCIS_TRACING_TYPE;SETTINGS_TRACING_TYPE defaultValue: "" type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7985,27 +7986,27 @@ OCIS_TRANSFER_SECRET: defaultValue: "" type: string description: Transfer secret for signing file up- and download requests. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_TRANSLATION_PATH: - name: OCIS_TRANSLATION_PATH;USERLOG_TRANSLATION_PATH + name: OCIS_TRANSLATION_PATH;NOTIFICATIONS_TRANSLATION_PATH defaultValue: "" type: string description: (optional) Set this to a path with custom translations to overwrite the builtin translations. Note that file and folder naming rules apply, see the documentation for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_URL: - name: OCIS_URL;OCDAV_PUBLIC_URL + name: OCIS_URL;OCIS_OIDC_ISSUER;PROXY_OIDC_ISSUER defaultValue: https://localhost:9200 type: string - description: URL where oCIS is reachable for users. - introductionVersion: "" + description: URL of the OIDC issuer. It defaults to URL of the builtin IDP. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8015,7 +8016,7 @@ OCM_CORS_ALLOW_CREDENTIALS: type: bool description: 'Allow credentials for CORS.See following chapter for more details: *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8029,7 +8030,7 @@ OCM_CORS_ALLOW_HEADERS: description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8041,7 +8042,7 @@ OCM_CORS_ALLOW_METHODS: description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8052,7 +8053,7 @@ OCM_CORS_ALLOW_ORIGINS: description: 'A list of allowed CORS origins. See following chapter for more details: *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8062,7 +8063,7 @@ OCM_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8071,7 +8072,7 @@ OCM_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8080,7 +8081,7 @@ OCM_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8090,7 +8091,7 @@ OCM_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8099,7 +8100,7 @@ OCM_GRPC_ADDR: defaultValue: 127.0.0.1:9282 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8108,7 +8109,7 @@ OCM_GRPC_PROTOCOL: defaultValue: "" type: string description: The transport protocol of the GRPC service. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8117,7 +8118,7 @@ OCM_HTTP_ADDR: defaultValue: 127.0.0.1:9280 type: string description: The bind address of the HTTP service. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8126,7 +8127,7 @@ OCM_HTTP_PREFIX: defaultValue: "" type: string description: The path prefix where OCM can be accessed (defaults to /). - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8135,7 +8136,7 @@ OCM_HTTP_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the HTTP service. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8144,7 +8145,7 @@ OCM_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8153,7 +8154,7 @@ OCM_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8163,7 +8164,7 @@ OCM_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8172,7 +8173,7 @@ OCM_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8181,7 +8182,7 @@ OCM_MESH_DIRECTORY_URL: defaultValue: "" type: string description: URL of the mesh directory service. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8190,7 +8191,7 @@ OCM_OCM_CORE_DRIVER: defaultValue: json type: string description: Driver to be used for the OCM core. Supported value is only 'json'. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8200,7 +8201,7 @@ OCM_OCM_CORE_JSON_FILE: type: string description: Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8209,7 +8210,7 @@ OCM_OCM_INVITE_MANAGER_DRIVER: defaultValue: json type: string description: Driver to be used to persist OCM invites. Supported value is only 'json'. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8219,7 +8220,7 @@ OCM_OCM_INVITE_MANAGER_INSECURE: type: bool description: Disable TLS certificate validation for the OCM connections. Do not set this in production environments. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8229,7 +8230,7 @@ OCM_OCM_INVITE_MANAGER_JSON_FILE: type: string description: Path to the JSON file where OCM invite data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8239,7 +8240,7 @@ OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE: type: string description: Path to the JSON file where ocm invite data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8249,7 +8250,7 @@ OCM_OCM_PROVIDER_AUTHORIZER_VERIFY_REQUEST_HOSTNAME: type: bool description: Verify the hostname of the incoming request against the hostname of the OCM provider. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8259,7 +8260,7 @@ OCM_OCM_SHARE_PROVIDER_DRIVER: type: string description: Driver to be used for the OCM share provider. Supported value is only 'json'. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8269,7 +8270,7 @@ OCM_OCM_SHARE_PROVIDER_INSECURE: type: bool description: Disable TLS certificate validation for the OCM connections. Do not set this in production environments. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8279,7 +8280,7 @@ OCM_OCM_SHAREPROVIDER_JSON_FILE: type: string description: Path to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8289,7 +8290,7 @@ OCM_OCM_STORAGE_PROVIDER_INSECURE: type: bool description: Disable TLS certificate validation for the OCM connections. Do not set this in production environments. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8299,7 +8300,7 @@ OCM_OCM_STORAGE_PROVIDER_STORAGE_ROOT: type: string description: Directory where the ocm storage provider persists its data like tus upload info files. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8308,7 +8309,7 @@ OCM_OCMD_EXPOSE_RECIPIENT_DISPLAY_NAME: defaultValue: "false" type: bool description: Expose the display name of OCM share recipients. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8318,7 +8319,7 @@ OCM_OCMD_PREFIX: type: string description: URL path prefix for the OCMD service. Note that the string must not start with '/'. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8328,7 +8329,7 @@ OCM_SCIENCEMESH_PREFIX: type: string description: URL path prefix for the ScienceMesh service. Note that the string must not start with '/'. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8338,7 +8339,7 @@ OCM_SERVICE_ACCOUNT_ID: type: string description: The ID of the service account the service should use. See the 'auth-service' service description for more details. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8347,7 +8348,7 @@ OCM_SERVICE_ACCOUNT_SECRET: defaultValue: "" type: string description: The service account secret. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8357,7 +8358,7 @@ OCM_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8366,7 +8367,7 @@ OCM_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8375,7 +8376,7 @@ OCM_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8385,7 +8386,7 @@ OCM_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8394,7 +8395,7 @@ OCM_WEBAPP_TEMPLATE: defaultValue: "" type: string description: Template for the webapp url. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8404,7 +8405,7 @@ OCS_CORS_ALLOW_CREDENTIALS: type: bool description: 'Allow credentials for CORS.See following chapter for more details: *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8416,7 +8417,7 @@ OCS_CORS_ALLOW_HEADERS: description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8427,7 +8428,7 @@ OCS_CORS_ALLOW_METHODS: description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8438,7 +8439,7 @@ OCS_CORS_ALLOW_ORIGINS: description: 'A list of allowed CORS origins. See following chapter for more details: *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8448,7 +8449,7 @@ OCS_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8457,7 +8458,7 @@ OCS_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8466,7 +8467,7 @@ OCS_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8476,7 +8477,7 @@ OCS_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8486,7 +8487,7 @@ OCS_EVENTS_TLS_ROOT_CA_CERTIFICATE: type: string description: The root CA certificate used to validate the server's TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8495,7 +8496,7 @@ OCS_HTTP_ADDR: defaultValue: 127.0.0.1:9110 type: string description: The bind address of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8504,7 +8505,7 @@ OCS_HTTP_ROOT: defaultValue: /ocs type: string description: Subdirectory that serves as the root for this HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8513,7 +8514,7 @@ OCS_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8522,7 +8523,7 @@ OCS_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8531,7 +8532,7 @@ OCS_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8541,7 +8542,7 @@ OCS_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8550,7 +8551,7 @@ OCS_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8611,7 +8612,7 @@ OCS_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8620,7 +8621,7 @@ OCS_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8629,7 +8630,7 @@ OCS_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8639,7 +8640,7 @@ OCS_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8649,7 +8650,7 @@ POLICIES_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8658,7 +8659,7 @@ POLICIES_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8667,7 +8668,7 @@ POLICIES_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8677,7 +8678,7 @@ POLICIES_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8687,7 +8688,7 @@ POLICIES_ENGINE_MIMES: type: string description: Sets the mimes file path which maps mimetypes to associated file extensions. See the text description for details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8698,78 +8699,78 @@ POLICIES_ENGINE_TIMEOUT: description: Sets the timeout the rego expression evaluation can take. Rules default to deny if the timeout was reached. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" POLICIES_EVENTS_AUTH_PASSWORD: - name: OCIS_EVENTS_AUTH_PASSWORD;POLICIES_EVENTS_AUTH_PASSWORD + name: OCIS_EVENTS_AUTH_PASSWORD;FRONTEND_EVENTS_AUTH_PASSWORD defaultValue: "" type: string description: The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" POLICIES_EVENTS_AUTH_USERNAME: - name: OCIS_EVENTS_AUTH_USERNAME;POLICIES_EVENTS_AUTH_USERNAME + name: OCIS_EVENTS_AUTH_USERNAME;FRONTEND_EVENTS_AUTH_USERNAME defaultValue: "" type: string description: The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" POLICIES_EVENTS_CLUSTER: - name: OCIS_EVENTS_CLUSTER;POLICIES_EVENTS_CLUSTER + name: OCIS_EVENTS_CLUSTER;FRONTEND_EVENTS_CLUSTER defaultValue: ocis-cluster type: string description: The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" POLICIES_EVENTS_ENABLE_TLS: - name: OCIS_EVENTS_ENABLE_TLS;POLICIES_EVENTS_ENABLE_TLS + name: OCIS_EVENTS_ENABLE_TLS;FRONTEND_EVENTS_ENABLE_TLS defaultValue: "false" type: bool description: Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" POLICIES_EVENTS_ENDPOINT: - name: OCIS_EVENTS_ENDPOINT;POLICIES_EVENTS_ENDPOINT + name: OCIS_EVENTS_ENDPOINT;FRONTEND_EVENTS_ENDPOINT defaultValue: 127.0.0.1:9233 type: string description: The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" POLICIES_EVENTS_TLS_INSECURE: - name: OCIS_INSECURE;POLICIES_EVENTS_TLS_INSECURE + name: OCIS_INSECURE;PROXY_OIDC_INSECURE defaultValue: "false" type: bool - description: Whether the server should skip the client certificate verification - during the TLS handshake. - introductionVersion: "" + description: Disable TLS certificate validation for connections to the IDP. Note + that this is not recommended for production environments. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" POLICIES_EVENTS_TLS_ROOT_CA_CERTIFICATE: - name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;POLICIES_EVENTS_TLS_ROOT_CA_CERTIFICATE + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;AUDIT_EVENTS_TLS_ROOT_CA_CERTIFICATE defaultValue: "" type: string description: The root CA certificate used to validate the server's TLS certificate. - If provided POLICIES_EVENTS_TLS_INSECURE will be seen as false. - introductionVersion: "" + If provided AUDIT_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8778,7 +8779,7 @@ POLICIES_GRPC_ADDR: defaultValue: 127.0.0.1:9125 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8787,7 +8788,7 @@ POLICIES_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8796,7 +8797,7 @@ POLICIES_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8806,7 +8807,7 @@ POLICIES_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8815,7 +8816,7 @@ POLICIES_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8825,7 +8826,7 @@ POLICIES_POSTPROCESSING_QUERY: type: string description: Defines the 'Complete Rules' variable defined in the rego rule set this step uses for its evaluation. Defaults to deny if the variable was not found. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8835,7 +8836,7 @@ POLICIES_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8844,7 +8845,7 @@ POLICIES_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8853,7 +8854,7 @@ POLICIES_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8863,7 +8864,7 @@ POLICIES_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8873,7 +8874,7 @@ POSTPROCESSING_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8882,7 +8883,7 @@ POSTPROCESSING_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8891,7 +8892,7 @@ POSTPROCESSING_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8901,7 +8902,7 @@ POSTPROCESSING_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8915,7 +8916,7 @@ POSTPROCESSING_DELAY: the delay step will be processed as last step. In such a case, a log entry will be written on service startup to remind the admin about that situation. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8925,7 +8926,7 @@ POSTPROCESSING_EVENTS_AUTH_PASSWORD: type: string description: The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8935,7 +8936,7 @@ POSTPROCESSING_EVENTS_AUTH_USERNAME: type: string description: The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8946,7 +8947,7 @@ POSTPROCESSING_EVENTS_CLUSTER: description: The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8956,7 +8957,7 @@ POSTPROCESSING_EVENTS_ENABLE_TLS: type: bool description: Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8966,7 +8967,7 @@ POSTPROCESSING_EVENTS_ENDPOINT: type: string description: The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8976,7 +8977,7 @@ POSTPROCESSING_EVENTS_TLS_INSECURE: type: bool description: Whether the ocis server should skip the client certificate verification during the TLS handshake. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8986,7 +8987,7 @@ POSTPROCESSING_EVENTS_TLS_ROOT_CA_CERTIFICATE: type: string description: The root CA certificate used to validate the server's TLS certificate. If provided POSTPROCESSING_EVENTS_TLS_INSECURE will be seen as false. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8995,7 +8996,7 @@ POSTPROCESSING_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9004,7 +9005,7 @@ POSTPROCESSING_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9014,7 +9015,7 @@ POSTPROCESSING_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9023,7 +9024,7 @@ POSTPROCESSING_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9032,7 +9033,7 @@ POSTPROCESSING_MAX_RETRIES: defaultValue: "14" type: int description: The maximum number of retries for a failed postprocessing step. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9042,7 +9043,7 @@ POSTPROCESSING_RETRY_BACKOFF_DURATION: type: Duration description: The base for the exponential backoff duration before retrying a failed postprocessing step. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9054,7 +9055,7 @@ POSTPROCESSING_STEPS: Currently supported values by the system are: ''virusscan'', ''policies'' and ''delay''. Custom steps are allowed. See the documentation for instructions. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9065,7 +9066,7 @@ POSTPROCESSING_STORE: description: 'The type of the store. Supported values are: ''memory'', ''ocmem'', ''etcd'', ''redis'', ''redis-sentinel'', ''nats-js'', ''noop''. See the text description for details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9075,7 +9076,7 @@ POSTPROCESSING_STORE_AUTH_PASSWORD: type: string description: The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9085,7 +9086,7 @@ POSTPROCESSING_STORE_AUTH_USERNAME: type: string description: The username to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9094,7 +9095,7 @@ POSTPROCESSING_STORE_DATABASE: defaultValue: postprocessing type: string description: The database name the configured store should use. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9106,7 +9107,7 @@ POSTPROCESSING_STORE_NODES: when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9117,7 +9118,7 @@ POSTPROCESSING_STORE_SIZE: description: The maximum quantity of items in the store. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitely set as default. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9126,7 +9127,7 @@ POSTPROCESSING_STORE_TABLE: defaultValue: postprocessing type: string description: The database table the store should use. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9136,7 +9137,7 @@ POSTPROCESSING_STORE_TTL: type: Duration description: Time to live for events in the store. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9146,7 +9147,7 @@ POSTPROCESSING_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9155,7 +9156,7 @@ POSTPROCESSING_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9164,7 +9165,7 @@ POSTPROCESSING_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9174,7 +9175,7 @@ POSTPROCESSING_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9184,7 +9185,7 @@ PROXY_ACCOUNT_BACKEND_TYPE: type: string description: Account backend the PROXY service should use. Currently only 'cs3' is possible here. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9195,7 +9196,7 @@ PROXY_AUTOPROVISION_ACCOUNTS: description: Set this to 'true' to automatically provision users that do not yet exist in the users service on-demand upon first sign-in. To use this a write-enabled libregraph user backend needs to be setup an running. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9205,7 +9206,7 @@ PROXY_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9214,7 +9215,7 @@ PROXY_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9223,7 +9224,7 @@ PROXY_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9233,7 +9234,7 @@ PROXY_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9242,7 +9243,7 @@ PROXY_ENABLE_BASIC_AUTH: defaultValue: "false" type: bool description: Set this to true to enable 'basic authentication' (username/password). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9251,7 +9252,7 @@ PROXY_ENABLE_PRESIGNEDURLS: defaultValue: "true" type: bool description: Allow OCS to get a signing key to sign requests. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9260,7 +9261,7 @@ PROXY_HTTP_ADDR: defaultValue: 0.0.0.0:9200 type: string description: The bind address of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9269,7 +9270,7 @@ PROXY_HTTP_ROOT: defaultValue: / type: string description: Subdirectory that serves as the root for this HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9279,7 +9280,7 @@ PROXY_HTTPS_CACERT: type: string description: Path/File for the root CA certificate used to validate the server’s TLS certificate for https enabled backend services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9288,7 +9289,7 @@ PROXY_INSECURE_BACKENDS: defaultValue: "false" type: bool description: Disable TLS certificate validation for all HTTP backend connections. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9297,7 +9298,7 @@ PROXY_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9306,7 +9307,7 @@ PROXY_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9316,7 +9317,7 @@ PROXY_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9325,7 +9326,7 @@ PROXY_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9335,7 +9336,7 @@ PROXY_MACHINE_AUTH_API_KEY: type: string description: Machine auth API key used to validate internal requests necessary to access resources from other services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9348,7 +9349,7 @@ PROXY_OIDC_ACCESS_TOKEN_VERIFY_METHOD: for accessing the IPD's userinfo endpoint will be done. When using 'jwt', it tries to parse the access token as a jwt token and verifies the signature using the keys published on the IDP's 'jwks_uri'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9358,7 +9359,7 @@ PROXY_OIDC_INSECURE: type: bool description: Disable TLS certificate validation for connections to the IDP. Note that this is not recommended for production environments. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9367,7 +9368,7 @@ PROXY_OIDC_ISSUER: defaultValue: https://localhost:9200 type: string description: URL of the OIDC issuer. It defaults to URL of the builtin IDP. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9377,7 +9378,7 @@ PROXY_OIDC_JWKS_REFRESH_INTERVAL: type: uint64 description: The interval for refreshing the JWKS (JSON Web Key Set) in minutes in the background via a new HTTP request to the IDP. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9388,7 +9389,7 @@ PROXY_OIDC_JWKS_REFRESH_RATE_LIMIT: description: Limits the rate in seconds at which refresh requests are performed for unknown keys. This is used to prevent malicious clients from imposing high network load on the IDP via ocis. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9397,7 +9398,7 @@ PROXY_OIDC_JWKS_REFRESH_TIMEOUT: defaultValue: "10" type: uint64 description: The timeout in seconds for an outgoing JWKS request. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9407,7 +9408,7 @@ PROXY_OIDC_JWKS_REFRESH_UNKNOWN_KID: type: bool description: If set to 'true', the JWKS refresh request will occur every time an unknown KEY ID (KID) is seen. Always set a 'refresh_limit' when enabling this. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9418,7 +9419,7 @@ PROXY_OIDC_REWRITE_WELLKNOWN: description: Enables rewriting the /.well-known/openid-configuration to the configured OIDC issuer. Needed by the Desktop Client, Android Client and iOS Client to discover the OIDC provider. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9428,7 +9429,7 @@ PROXY_OIDC_SKIP_USER_INFO: type: bool description: Do not look up user claims at the userinfo endpoint and directly read them from the access token. Incompatible with 'PROXY_OIDC_ACCESS_TOKEN_VERIFY_METHOD=none'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9438,7 +9439,7 @@ PROXY_OIDC_USERINFO_CACHE_AUTH_PASSWORD: type: string description: The password to authenticate with the cache. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9448,7 +9449,7 @@ PROXY_OIDC_USERINFO_CACHE_AUTH_USERNAME: type: string description: The username to authenticate with the cache. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9458,7 +9459,7 @@ PROXY_OIDC_USERINFO_CACHE_DISABLE_PERSISTENCE: type: bool description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9469,7 +9470,7 @@ PROXY_OIDC_USERINFO_CACHE_SIZE: description: The maximum quantity of items in the user info cache. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitely set as default. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9479,7 +9480,7 @@ PROXY_OIDC_USERINFO_CACHE_STORE: type: string description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', ''nats-js-kv'', ''noop''. See the text description for details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9491,7 +9492,7 @@ PROXY_OIDC_USERINFO_CACHE_STORE_NODES: when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9500,7 +9501,7 @@ PROXY_OIDC_USERINFO_CACHE_TABLE: defaultValue: "" type: string description: The database table the store should use. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9511,7 +9512,7 @@ PROXY_OIDC_USERINFO_CACHE_TTL: description: Default time to live for user info in the user info cache. Only applied when access tokens has no expiration. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9522,7 +9523,7 @@ PROXY_POLICIES_QUERY: description: Defines the 'Complete Rules' variable defined in the rego rule set this step uses for its evaluation. Rules default to deny if the variable was not found. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9597,7 +9598,7 @@ PROXY_ROLE_ASSIGNMENT_DRIVER: to users which don''t have a role assigned at the time they login. ''oidc'' will assign the role based on the value of a claim (configured via PROXY_ROLE_ASSIGNMENT_OIDC_CLAIM) from the users OIDC claims.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9606,7 +9607,7 @@ PROXY_ROLE_ASSIGNMENT_OIDC_CLAIM: defaultValue: roles type: string description: The OIDC claim used to create the users role assignment. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9616,7 +9617,7 @@ PROXY_SERVICE_ACCOUNT_ID: type: string description: The ID of the service account the service should use. See the 'auth-service' service description for more details. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9625,7 +9626,7 @@ PROXY_SERVICE_ACCOUNT_SECRET: defaultValue: "" type: string description: The service account secret. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9636,7 +9637,7 @@ PROXY_TLS: description: Enable/Disable HTTPS for external HTTP services. Must be set to 'true' if the built-in IDP service an no reverse proxy is used. See the text description for details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9646,7 +9647,7 @@ PROXY_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9655,7 +9656,7 @@ PROXY_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9664,7 +9665,7 @@ PROXY_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9674,7 +9675,7 @@ PROXY_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9684,7 +9685,7 @@ PROXY_TRANSPORT_TLS_CERT: type: string description: Path/File name of the TLS server certificate (in PEM format) for the external http services. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/proxy. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9695,7 +9696,7 @@ PROXY_TRANSPORT_TLS_KEY: description: Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the external http services. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/proxy. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9705,7 +9706,7 @@ PROXY_USER_CS3_CLAIM: type: string description: The name of a CS3 user attribute (claim) that should be mapped to the 'user_oidc_claim'. Supported values are 'username', 'mail' and 'userid'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9718,7 +9719,7 @@ PROXY_USER_OIDC_CLAIM: stable and non re-assignable identifier. The availability of claims depends on your Identity Provider. There are common claims available for most Identity providers like 'email' or 'preferred_username' but you can also add your own claim. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9727,7 +9728,7 @@ SEARCH_CONTENT_EXTRACTION_SIZE_LIMIT: defaultValue: "20971520" type: uint64 description: Maximum file size in bytes that is allowed for content extraction. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9737,7 +9738,7 @@ SEARCH_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9746,7 +9747,7 @@ SEARCH_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9755,7 +9756,7 @@ SEARCH_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9765,7 +9766,7 @@ SEARCH_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9775,7 +9776,7 @@ SEARCH_ENGINE_BLEVE_DATA_PATH: type: string description: The directory where the filesystem will store search data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/search. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9785,7 +9786,7 @@ SEARCH_ENGINE_TYPE: type: string description: 'Defines which search engine to use. Defaults to ''bleve''. Supported values are: ''bleve''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9794,7 +9795,7 @@ SEARCH_EVENTS_ASYNC_UPLOADS: defaultValue: "true" type: bool description: Enable asynchronous file uploads. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9804,7 +9805,7 @@ SEARCH_EVENTS_AUTH_PASSWORD: type: string description: The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9814,7 +9815,7 @@ SEARCH_EVENTS_AUTH_USERNAME: type: string description: The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9825,7 +9826,7 @@ SEARCH_EVENTS_CLUSTER: description: The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9835,7 +9836,7 @@ SEARCH_EVENTS_ENABLE_TLS: type: bool description: Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9845,7 +9846,7 @@ SEARCH_EVENTS_ENDPOINT: type: string description: The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9856,7 +9857,7 @@ SEARCH_EVENTS_NUM_CONSUMERS: description: The amount of concurrent event consumers to start. Event consumers are used for searching files. Multiple consumers increase parallelisation, but will also increase CPU and memory demands. The default value is 0. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9866,7 +9867,7 @@ SEARCH_EVENTS_REINDEX_DEBOUNCE_DURATION: type: int description: The duration in milliseconds the reindex debouncer waits before triggering a reindex of a space that was modified. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9875,7 +9876,7 @@ SEARCH_EVENTS_TLS_INSECURE: defaultValue: "false" type: bool description: Whether to verify the server TLS certificates. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9885,7 +9886,7 @@ SEARCH_EVENTS_TLS_ROOT_CA_CERTIFICATE: type: string description: The root CA certificate used to validate the server's TLS certificate. If provided SEARCH_EVENTS_TLS_INSECURE will be seen as false. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9894,7 +9895,7 @@ SEARCH_EXTRACTOR_CS3SOURCE_INSECURE: defaultValue: "false" type: bool description: Ignore untrusted SSL certificates when connecting to the CS3 source. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9904,7 +9905,7 @@ SEARCH_EXTRACTOR_TIKA_CLEAN_STOP_WORDS: type: bool description: Defines if stop words should be cleaned or not. See the documentation for more details. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9913,7 +9914,7 @@ SEARCH_EXTRACTOR_TIKA_TIKA_URL: defaultValue: http://127.0.0.1:9998 type: string description: URL of the tika server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9923,7 +9924,7 @@ SEARCH_EXTRACTOR_TYPE: type: string description: 'Defines the content extraction engine. Defaults to ''basic''. Supported values are: ''basic'' and ''tika''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9932,7 +9933,7 @@ SEARCH_GRPC_ADDR: defaultValue: 127.0.0.1:9220 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9941,7 +9942,7 @@ SEARCH_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9950,7 +9951,7 @@ SEARCH_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9959,7 +9960,7 @@ SEARCH_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9969,7 +9970,7 @@ SEARCH_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9978,7 +9979,7 @@ SEARCH_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9988,7 +9989,7 @@ SEARCH_SERVICE_ACCOUNT_ID: type: string description: The ID of the service account the service should use. See the 'auth-service' service description for more details. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9997,7 +9998,7 @@ SEARCH_SERVICE_ACCOUNT_SECRET: defaultValue: "" type: string description: The service account secret. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10007,7 +10008,7 @@ SEARCH_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10016,7 +10017,7 @@ SEARCH_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10025,7 +10026,7 @@ SEARCH_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10035,7 +10036,7 @@ SEARCH_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10046,7 +10047,7 @@ SETTINGS_ADMIN_USER_ID: description: ID of the user that should receive admin privileges. Consider that the UUID can be encoded in some LDAP deployment configurations like in .ldif files. These need to be decoded beforehand. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10056,7 +10057,7 @@ SETTINGS_BUNDLES_PATH: type: string description: The path to a JSON file with a list of bundles. If not defined, the default bundles will be loaded. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10066,7 +10067,7 @@ SETTINGS_CACHE_AUTH_PASSWORD: type: string description: The password to authenticate with the cache. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10076,7 +10077,7 @@ SETTINGS_CACHE_AUTH_USERNAME: type: string description: The username to authenticate with the cache. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10086,7 +10087,7 @@ SETTINGS_CACHE_DISABLE_PERSISTENCE: type: bool description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10097,7 +10098,7 @@ SETTINGS_CACHE_SIZE: description: The maximum quantity of items in the cache. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitely set as default. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10107,7 +10108,7 @@ SETTINGS_CACHE_STORE: type: string description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', ''nats-js-kv'', ''noop''. See the text description for details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10119,7 +10120,7 @@ SETTINGS_CACHE_STORE_NODES: when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10130,7 +10131,7 @@ SETTINGS_CACHE_TTL: description: Default time to live for entries in the cache. Only applied when access tokens has no expiration. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10140,7 +10141,7 @@ SETTINGS_CORS_ALLOW_CREDENTIALS: type: bool description: 'Allow credentials for CORS.See following chapter for more details: *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10151,7 +10152,7 @@ SETTINGS_CORS_ALLOW_HEADERS: description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10162,7 +10163,7 @@ SETTINGS_CORS_ALLOW_METHODS: description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10173,7 +10174,7 @@ SETTINGS_CORS_ALLOW_ORIGINS: description: 'A list of allowed CORS origins. See following chapter for more details: *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10183,7 +10184,7 @@ SETTINGS_DATA_PATH: type: string description: The directory where the filesystem storage will store ocis settings. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/settings. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10193,7 +10194,7 @@ SETTINGS_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10202,7 +10203,7 @@ SETTINGS_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10211,7 +10212,7 @@ SETTINGS_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10221,7 +10222,7 @@ SETTINGS_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10230,7 +10231,7 @@ SETTINGS_DIRECTORY_CACHE_TABLE: defaultValue: settings_dirs type: string description: The database table the store should use for the directory cache. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10239,7 +10240,7 @@ SETTINGS_FILE_CACHE_TABLE: defaultValue: settings_files type: string description: The database table the store should use for the file cache. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10248,7 +10249,7 @@ SETTINGS_GRPC_ADDR: defaultValue: 127.0.0.1:9191 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10257,7 +10258,7 @@ SETTINGS_HTTP_ADDR: defaultValue: 127.0.0.1:9190 type: string description: The bind address of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10266,7 +10267,7 @@ SETTINGS_HTTP_ROOT: defaultValue: / type: string description: Subdirectory that serves as the root for this HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10275,7 +10276,7 @@ SETTINGS_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10284,7 +10285,7 @@ SETTINGS_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10293,7 +10294,7 @@ SETTINGS_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10303,7 +10304,7 @@ SETTINGS_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10312,7 +10313,7 @@ SETTINGS_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10324,7 +10325,7 @@ SETTINGS_SERVICE_ACCOUNT_IDS: ''service-account'' role. Note: When using ''OCIS_SERVICE_ACCOUNT_ID'' this will contain only one value while ''SETTINGS_SERVICE_ACCOUNT_IDS'' can have multiple. See the ''auth-service'' service description for more details about service accounts.' - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10333,7 +10334,7 @@ SETTINGS_SETUP_DEFAULT_ASSIGNMENTS: defaultValue: "false" type: bool description: The default role assignments the demo users should be setup. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10343,7 +10344,7 @@ SETTINGS_STORE_TYPE: type: string description: Store type configures the persistency driver. Supported values are 'metadata' and 'filesystem'. Note that the value 'filesystem' is considered deprecated. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10355,7 +10356,7 @@ SETTINGS_SYSTEM_USER_ID: for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10364,7 +10365,7 @@ SETTINGS_SYSTEM_USER_IDP: defaultValue: internal type: string description: IDP of the oCIS STORAGE-SYSTEM system user. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10374,7 +10375,7 @@ SETTINGS_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10383,7 +10384,7 @@ SETTINGS_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10392,7 +10393,7 @@ SETTINGS_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10402,7 +10403,7 @@ SETTINGS_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10412,7 +10413,7 @@ SHARING_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10421,7 +10422,7 @@ SHARING_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10430,7 +10431,7 @@ SHARING_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10440,16 +10441,17 @@ SHARING_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" SHARING_ENABLE_RESHARING: - name: OCIS_ENABLE_RESHARING;SHARING_ENABLE_RESHARING + name: OCIS_ENABLE_RESHARING;FRONTEND_ENABLE_RESHARING defaultValue: "true" type: bool - description: Changing this value is NOT supported. Enables the support for resharing. - introductionVersion: "5.0" + description: Changing this value is NOT supported. Enables the support for resharing + in the clients. + introductionVersion: pre5.0 deprecationVersion: "5.0" removalVersion: "" deprecationInfo: Resharing will be removed in the future. @@ -10458,7 +10460,7 @@ SHARING_EVENTS_AUTH_PASSWORD: defaultValue: "" type: string description: Password for the events broker. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10467,7 +10469,7 @@ SHARING_EVENTS_AUTH_USERNAME: defaultValue: "" type: string description: Username for the events broker. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10478,7 +10480,7 @@ SHARING_EVENTS_CLUSTER: description: The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10488,7 +10490,7 @@ SHARING_EVENTS_ENABLE_TLS: type: bool description: Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10498,7 +10500,7 @@ SHARING_EVENTS_ENDPOINT: type: string description: The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10507,7 +10509,7 @@ SHARING_EVENTS_TLS_INSECURE: defaultValue: "false" type: bool description: Whether to verify the server TLS certificates. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10517,7 +10519,7 @@ SHARING_EVENTS_TLS_ROOT_CA_CERTIFICATE: type: string description: The root CA certificate used to validate the server's TLS certificate. If provided SHARING_EVENTS_TLS_INSECURE will be seen as false. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10526,7 +10528,7 @@ SHARING_GRPC_ADDR: defaultValue: 127.0.0.1:9150 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10535,7 +10537,7 @@ SHARING_GRPC_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10544,7 +10546,7 @@ SHARING_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10553,7 +10555,7 @@ SHARING_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10562,7 +10564,7 @@ SHARING_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10572,7 +10574,7 @@ SHARING_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10581,7 +10583,7 @@ SHARING_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10590,74 +10592,74 @@ SHARING_OCM_PROVIDER_AUTHORIZER_DRIVER: defaultValue: json type: string description: Driver to be used to persist ocm invites. Supported value is only 'json'. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" SHARING_PASSWORD_POLICY_BANNED_PASSWORDS_LIST: - name: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST;SHARING_PASSWORD_POLICY_BANNED_PASSWORDS_LIST + name: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST;FRONTEND_PASSWORD_POLICY_BANNED_PASSWORDS_LIST defaultValue: "" type: string description: Path to the 'banned passwords list' file. See the documentation for more details. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" SHARING_PASSWORD_POLICY_DISABLED: - name: OCIS_PASSWORD_POLICY_DISABLED;SHARING_PASSWORD_POLICY_DISABLED + name: OCIS_PASSWORD_POLICY_DISABLED;FRONTEND_PASSWORD_POLICY_DISABLED defaultValue: "false" type: bool description: Disable the password policy. Defaults to false if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" SHARING_PASSWORD_POLICY_MIN_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_CHARACTERS defaultValue: "8" type: int description: Define the minimum password length. Defaults to 8 if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" SHARING_PASSWORD_POLICY_MIN_DIGITS: - name: OCIS_PASSWORD_POLICY_MIN_DIGITS;SHARING_PASSWORD_POLICY_MIN_DIGITS + name: OCIS_PASSWORD_POLICY_MIN_DIGITS;FRONTEND_PASSWORD_POLICY_MIN_DIGITS defaultValue: "1" type: int description: Define the minimum number of digits. Defaults to 1 if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" SHARING_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of uppercase letters. Defaults to 1 if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" SHARING_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of characters from the special characters list to be present. Defaults to 1 if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" SHARING_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of lowercase letters. Defaults to 1 if not set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10666,7 +10668,7 @@ SHARING_PUBLIC_CS3_PROVIDER_ADDR: defaultValue: com.owncloud.api.storage-system type: string description: GRPC address of the STORAGE-SYSTEM service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10675,7 +10677,7 @@ SHARING_PUBLIC_CS3_SYSTEM_USER_API_KEY: defaultValue: "" type: string description: API key for the STORAGE-SYSTEM system user. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10687,7 +10689,7 @@ SHARING_PUBLIC_CS3_SYSTEM_USER_ID: for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10696,7 +10698,7 @@ SHARING_PUBLIC_CS3_SYSTEM_USER_IDP: defaultValue: internal type: string description: IDP of the oCIS STORAGE-SYSTEM system user. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10706,7 +10708,7 @@ SHARING_PUBLIC_DRIVER: type: string description: Driver to be used to persist public shares. Supported values are 'jsoncs3', 'json' and 'cs3' (deprecated). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10717,7 +10719,7 @@ SHARING_PUBLIC_JSON_FILE: description: Path to the JSON file where public share meta-data will be stored. This JSON file contains the information about public shares that have been created. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10726,7 +10728,7 @@ SHARING_PUBLIC_JSONCS3_PROVIDER_ADDR: defaultValue: com.owncloud.api.storage-system type: string description: GRPC address of the STORAGE-SYSTEM service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10735,7 +10737,7 @@ SHARING_PUBLIC_JSONCS3_SYSTEM_USER_API_KEY: defaultValue: "" type: string description: API key for the STORAGE-SYSTEM system user. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10747,7 +10749,7 @@ SHARING_PUBLIC_JSONCS3_SYSTEM_USER_ID: for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10756,28 +10758,26 @@ SHARING_PUBLIC_JSONCS3_SYSTEM_USER_IDP: defaultValue: internal type: string description: IDP of the oCIS STORAGE-SYSTEM system user. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD: - name: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD;SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD + name: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD;FRONTEND_OCS_PUBLIC_SHARE_MUST_HAVE_PASSWORD defaultValue: "true" type: bool description: Set this to true if you want to enforce passwords on all public shares. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD: - name: OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD;SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD + name: OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD;FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD defaultValue: "false" type: bool description: Set this to true if you want to enforce passwords on Uploader, Editor - or Contributor shares. If not using the global OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD, - you must define the FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD in - the frontend service. - introductionVersion: "" + or Contributor shares. + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10787,7 +10787,7 @@ SHARING_SKIP_USER_GROUPS_IN_TOKEN: type: bool description: Disables the loading of user's group memberships from the reva access token. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10797,7 +10797,7 @@ SHARING_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10806,7 +10806,7 @@ SHARING_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10815,7 +10815,7 @@ SHARING_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10825,7 +10825,7 @@ SHARING_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10834,7 +10834,7 @@ SHARING_USER_CS3_PROVIDER_ADDR: defaultValue: com.owncloud.api.storage-system type: string description: GRPC address of the STORAGE-SYSTEM service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10843,7 +10843,7 @@ SHARING_USER_CS3_SYSTEM_USER_API_KEY: defaultValue: "" type: string description: API key for the STORAGE-SYSTEM system user. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10855,7 +10855,7 @@ SHARING_USER_CS3_SYSTEM_USER_ID: for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10864,7 +10864,7 @@ SHARING_USER_CS3_SYSTEM_USER_IDP: defaultValue: internal type: string description: IDP of the oCIS STORAGE-SYSTEM system user. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10874,7 +10874,7 @@ SHARING_USER_DRIVER: type: string description: Driver to be used to persist shares. Supported values are 'jsoncs3', 'json', 'cs3' (deprecated) and 'owncloudsql'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10884,7 +10884,7 @@ SHARING_USER_JSON_FILE: type: string description: Path to the JSON file where shares will be persisted. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10893,7 +10893,7 @@ SHARING_USER_JSONCS3_CACHE_TTL: defaultValue: "0" type: int description: TTL for the internal caches in seconds. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10902,37 +10902,37 @@ SHARING_USER_JSONCS3_PROVIDER_ADDR: defaultValue: com.owncloud.api.storage-system type: string description: GRPC address of the STORAGE-SYSTEM service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" SHARING_USER_JSONCS3_SYSTEM_USER_API_KEY: - name: OCIS_SYSTEM_USER_API_KEY;SHARING_USER_JSONCS3_SYSTEM_USER_API_KEY + name: OCIS_SYSTEM_USER_API_KEY defaultValue: "" type: string description: API key for the STORAGE-SYSTEM system user. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" SHARING_USER_JSONCS3_SYSTEM_USER_ID: - name: OCIS_SYSTEM_USER_ID;SHARING_USER_JSONCS3_SYSTEM_USER_ID + name: OCIS_SYSTEM_USER_ID;SETTINGS_SYSTEM_USER_ID defaultValue: "" type: string description: ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" SHARING_USER_JSONCS3_SYSTEM_USER_IDP: - name: OCIS_SYSTEM_USER_IDP;SHARING_USER_JSONCS3_SYSTEM_USER_IDP + name: OCIS_SYSTEM_USER_IDP;SETTINGS_SYSTEM_USER_IDP defaultValue: internal type: string description: IDP of the oCIS STORAGE-SYSTEM system user. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10941,7 +10941,7 @@ SHARING_USER_OWNCLOUDSQL_DB_HOST: defaultValue: mysql type: string description: Hostname or IP of the database server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10950,7 +10950,7 @@ SHARING_USER_OWNCLOUDSQL_DB_NAME: defaultValue: owncloud type: string description: Name of the database to be used. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10959,7 +10959,7 @@ SHARING_USER_OWNCLOUDSQL_DB_PASSWORD: defaultValue: "" type: string description: Password for the database. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10968,7 +10968,7 @@ SHARING_USER_OWNCLOUDSQL_DB_PORT: defaultValue: "3306" type: int description: Port that the database server is listening on. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10977,7 +10977,7 @@ SHARING_USER_OWNCLOUDSQL_DB_USERNAME: defaultValue: owncloud type: string description: Username for the database. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10986,7 +10986,7 @@ SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID: defaultValue: "" type: string description: Mount ID of the ownCloudSQL users storage for mapping ownCloud 10 shares. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10996,7 +10996,7 @@ SSE_CORS_ALLOW_CREDENTIALS: type: bool description: 'Allow credentials for CORS.See following chapter for more details: *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11008,7 +11008,7 @@ SSE_CORS_ALLOW_HEADERS: description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11019,7 +11019,7 @@ SSE_CORS_ALLOW_METHODS: description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11030,7 +11030,7 @@ SSE_CORS_ALLOW_ORIGINS: description: 'A list of allowed CORS origins. See following chapter for more details: *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11040,7 +11040,7 @@ SSE_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11049,7 +11049,7 @@ SSE_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11058,7 +11058,7 @@ SSE_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11068,7 +11068,7 @@ SSE_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11078,7 +11078,7 @@ SSE_EVENTS_AUTH_PASSWORD: type: string description: The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11088,7 +11088,7 @@ SSE_EVENTS_AUTH_USERNAME: type: string description: The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11099,7 +11099,7 @@ SSE_EVENTS_CLUSTER: description: The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11109,7 +11109,7 @@ SSE_EVENTS_ENABLE_TLS: type: bool description: Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11119,7 +11119,7 @@ SSE_EVENTS_ENDPOINT: type: string description: The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11128,7 +11128,7 @@ SSE_EVENTS_TLS_INSECURE: defaultValue: "false" type: bool description: Whether to verify the server TLS certificates. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11138,7 +11138,7 @@ SSE_EVENTS_TLS_ROOT_CA_CERTIFICATE: type: string description: The root CA certificate used to validate the server's TLS certificate. If provided SSE_EVENTS_TLS_INSECURE will be seen as false. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11147,7 +11147,7 @@ SSE_HTTP_ADDR: defaultValue: 127.0.0.1:0 type: string description: The bind address of the HTTP service. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11156,7 +11156,7 @@ SSE_HTTP_ROOT: defaultValue: / type: string description: Subdirectory that serves as the root for this HTTP service. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11165,7 +11165,7 @@ SSE_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11174,7 +11174,7 @@ SSE_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11183,7 +11183,7 @@ SSE_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11193,7 +11193,7 @@ SSE_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11202,7 +11202,7 @@ SSE_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11212,7 +11212,7 @@ SSE_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11221,7 +11221,7 @@ SSE_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11230,7 +11230,7 @@ SSE_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11240,7 +11240,7 @@ SSE_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11249,7 +11249,7 @@ STORAGE_GATEWAY_GRPC_ADDR: defaultValue: com.owncloud.api.storage-system type: string description: GRPC address of the STORAGE-SYSTEM service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11258,7 +11258,7 @@ STORAGE_GRPC_ADDR: defaultValue: com.owncloud.api.storage-system type: string description: GRPC address of the STORAGE-SYSTEM service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11268,7 +11268,7 @@ STORAGE_PUBLICLINK_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11277,7 +11277,7 @@ STORAGE_PUBLICLINK_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11286,7 +11286,7 @@ STORAGE_PUBLICLINK_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11296,7 +11296,7 @@ STORAGE_PUBLICLINK_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11305,7 +11305,7 @@ STORAGE_PUBLICLINK_GRPC_ADDR: defaultValue: 127.0.0.1:9178 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11314,7 +11314,7 @@ STORAGE_PUBLICLINK_GRPC_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11323,7 +11323,7 @@ STORAGE_PUBLICLINK_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11332,7 +11332,7 @@ STORAGE_PUBLICLINK_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11341,7 +11341,7 @@ STORAGE_PUBLICLINK_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11351,7 +11351,7 @@ STORAGE_PUBLICLINK_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11360,7 +11360,7 @@ STORAGE_PUBLICLINK_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11370,7 +11370,7 @@ STORAGE_PUBLICLINK_SKIP_USER_GROUPS_IN_TOKEN: type: bool description: Disables the loading of user's group memberships from the reva access token. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11381,7 +11381,7 @@ STORAGE_PUBLICLINK_STORAGE_PROVIDER_MOUNT_ID: description: Mount ID of this storage. Admins can set the ID for the storage in this config option manually which is then used to reference the storage. Any reasonable long string is possible, preferably this would be an UUIDv4 format. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11391,7 +11391,7 @@ STORAGE_PUBLICLINK_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11400,7 +11400,7 @@ STORAGE_PUBLICLINK_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11409,7 +11409,7 @@ STORAGE_PUBLICLINK_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11419,7 +11419,7 @@ STORAGE_PUBLICLINK_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11429,7 +11429,7 @@ STORAGE_SHARES_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11438,7 +11438,7 @@ STORAGE_SHARES_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11447,7 +11447,7 @@ STORAGE_SHARES_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11457,7 +11457,7 @@ STORAGE_SHARES_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11466,7 +11466,7 @@ STORAGE_SHARES_GRPC_ADDR: defaultValue: 127.0.0.1:9154 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11475,7 +11475,7 @@ STORAGE_SHARES_GRPC_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11484,7 +11484,7 @@ STORAGE_SHARES_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11493,7 +11493,7 @@ STORAGE_SHARES_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11502,7 +11502,7 @@ STORAGE_SHARES_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11512,7 +11512,7 @@ STORAGE_SHARES_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11521,7 +11521,7 @@ STORAGE_SHARES_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11532,7 +11532,7 @@ STORAGE_SHARES_MOUNT_ID: description: Mount ID of this storage. Admins can set the ID for the storage in this config option manually which is then used to reference the storage. Any reasonable long string is possible, preferably this would be an UUIDv4 format. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11541,7 +11541,7 @@ STORAGE_SHARES_READ_ONLY: defaultValue: "false" type: bool description: Set this storage to be read-only. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11551,7 +11551,7 @@ STORAGE_SHARES_SKIP_USER_GROUPS_IN_TOKEN: type: bool description: Disables the loading of user's group memberships from the reva access token. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11561,7 +11561,7 @@ STORAGE_SHARES_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11570,7 +11570,7 @@ STORAGE_SHARES_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11579,7 +11579,7 @@ STORAGE_SHARES_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11589,7 +11589,7 @@ STORAGE_SHARES_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11598,7 +11598,7 @@ STORAGE_SHARES_USER_SHARE_PROVIDER_ENDPOINT: defaultValue: com.owncloud.api.sharing type: string description: GRPC endpoint of the SHARING service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11608,7 +11608,7 @@ STORAGE_SYSTEM_CACHE_AUTH_PASSWORD: type: string description: Password for the configured store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11618,7 +11618,7 @@ STORAGE_SYSTEM_CACHE_AUTH_USERNAME: type: string description: Username for the configured store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11628,7 +11628,7 @@ STORAGE_SYSTEM_CACHE_DISABLE_PERSISTENCE: type: bool description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11639,7 +11639,7 @@ STORAGE_SYSTEM_CACHE_SIZE: description: The maximum quantity of items in the user info cache. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitely set as default. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11649,7 +11649,7 @@ STORAGE_SYSTEM_CACHE_STORE: type: string description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', ''nats-js-kv'', ''noop''. See the text description for details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11661,7 +11661,7 @@ STORAGE_SYSTEM_CACHE_STORE_NODES: when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11672,7 +11672,7 @@ STORAGE_SYSTEM_CACHE_TTL: description: Default time to live for user info in the user info cache. Only applied when access tokens has no expiration. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11682,7 +11682,7 @@ STORAGE_SYSTEM_DATA_SERVER_URL: type: string description: URL of the data server, needs to be reachable by other services using this service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11692,7 +11692,7 @@ STORAGE_SYSTEM_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11701,7 +11701,7 @@ STORAGE_SYSTEM_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11710,7 +11710,7 @@ STORAGE_SYSTEM_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11720,7 +11720,7 @@ STORAGE_SYSTEM_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11729,7 +11729,7 @@ STORAGE_SYSTEM_DRIVER: defaultValue: ocis type: string description: The driver which should be used by the service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11738,7 +11738,7 @@ STORAGE_SYSTEM_GRPC_ADDR: defaultValue: 127.0.0.1:9215 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11747,7 +11747,7 @@ STORAGE_SYSTEM_GRPC_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the GPRC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11756,7 +11756,7 @@ STORAGE_SYSTEM_HTTP_ADDR: defaultValue: 127.0.0.1:9216 type: string description: The bind address of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11765,7 +11765,7 @@ STORAGE_SYSTEM_HTTP_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11774,7 +11774,7 @@ STORAGE_SYSTEM_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11783,7 +11783,7 @@ STORAGE_SYSTEM_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11792,7 +11792,7 @@ STORAGE_SYSTEM_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11802,7 +11802,7 @@ STORAGE_SYSTEM_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11811,7 +11811,7 @@ STORAGE_SYSTEM_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11822,7 +11822,7 @@ STORAGE_SYSTEM_OCIS_LOCK_CYCLE_DURATION_FACTOR: description: When trying to lock files, ocis will multiply the cycle with this factor and use it as a millisecond timeout. Values of 0 or below will be ignored and the default value of 30 will be used. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11834,7 +11834,7 @@ STORAGE_SYSTEM_OCIS_MAX_ACQUIRE_LOCK_CYCLES: the lock before failing. After each try it will wait for an increasing amount of time. Values of 0 or below will be ignored and the default value of 20 will be used. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11845,7 +11845,7 @@ STORAGE_SYSTEM_OCIS_METADATA_BACKEND: description: The backend to use for storing metadata. Supported values are 'messagepack' and 'xattrs'. The setting 'messagepack' uses a dedicated file to store file metadata while 'xattrs' uses extended attributes to store file metadata. Defaults to 'messagepack'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11855,7 +11855,7 @@ STORAGE_SYSTEM_OCIS_ROOT: type: string description: Path for the directory where the STORAGE-SYSTEM service stores it's persistent data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11865,7 +11865,7 @@ STORAGE_SYSTEM_SKIP_USER_GROUPS_IN_TOKEN: type: bool description: Disables the loading of user's group memberships from the reva access token. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11875,7 +11875,7 @@ STORAGE_SYSTEM_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11884,7 +11884,7 @@ STORAGE_SYSTEM_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11893,7 +11893,7 @@ STORAGE_SYSTEM_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11903,7 +11903,7 @@ STORAGE_SYSTEM_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11914,7 +11914,7 @@ STORAGE_USERS_ASYNC_PROPAGATOR_PROPAGATION_DELAY: description: The delay between a change made to a tree and the propagation start on treesize and treetime. Multiple propagations are computed to a single one. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11924,7 +11924,7 @@ STORAGE_USERS_CLI_MAX_ATTEMPTS_RENAME_FILE: type: int description: The maximum number of attempts to rename a file when a user restores a file to an existing destination with the same name. The minimum value is 100. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12002,7 +12002,7 @@ STORAGE_USERS_DATA_GATEWAY_URL: defaultValue: https://localhost:9200/data type: string description: URL of the data gateway server - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12012,7 +12012,7 @@ STORAGE_USERS_DATA_SERVER_URL: type: string description: URL of the data server, needs to be reachable by the data gateway provided by the frontend service or the user if directly exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12022,7 +12022,7 @@ STORAGE_USERS_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12031,7 +12031,7 @@ STORAGE_USERS_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12040,7 +12040,7 @@ STORAGE_USERS_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12050,7 +12050,7 @@ STORAGE_USERS_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12063,7 +12063,7 @@ STORAGE_USERS_DRIVER: driver stores all data (blob and meta data) in an POSIX compliant volume. The ''s3ng'' driver stores metadata in a POSIX compliant volume and uploads blobs to the s3 bucket.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12073,7 +12073,7 @@ STORAGE_USERS_EVENTS_AUTH_PASSWORD: type: string description: The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12083,7 +12083,7 @@ STORAGE_USERS_EVENTS_AUTH_USERNAME: type: string description: The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12094,7 +12094,7 @@ STORAGE_USERS_EVENTS_CLUSTER: description: The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12104,7 +12104,7 @@ STORAGE_USERS_EVENTS_ENABLE_TLS: type: bool description: Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12114,7 +12114,7 @@ STORAGE_USERS_EVENTS_ENDPOINT: type: string description: The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12126,7 +12126,7 @@ STORAGE_USERS_EVENTS_NUM_CONSUMERS: are used for post-processing files. Multiple consumers increase parallelisation, but will also increase CPU and memory demands. The setting has no effect when the OCIS_ASYNC_UPLOADS is set to false. The default and minimum value is 1. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12135,7 +12135,7 @@ STORAGE_USERS_EVENTS_TLS_INSECURE: defaultValue: "false" type: bool description: Whether to verify the server TLS certificates. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12145,7 +12145,7 @@ STORAGE_USERS_EVENTS_TLS_ROOT_CA_CERTIFICATE: type: string description: The root CA certificate used to validate the server's TLS certificate. If provided STORAGE_USERS_EVENTS_TLS_INSECURE will be seen as false. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12155,90 +12155,90 @@ STORAGE_USERS_EXPOSE_DATA_SERVER: type: bool description: Exposes the data server directly to users and bypasses the data gateway. Ensure that the data server address is reachable by users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" STORAGE_USERS_FILEMETADATA_CACHE_AUTH_PASSWORD: - name: OCIS_CACHE_AUTH_PASSWORD;STORAGE_USERS_FILEMETADATA_CACHE_AUTH_PASSWORD + name: OCIS_CACHE_AUTH_PASSWORD;SETTINGS_CACHE_AUTH_PASSWORD defaultValue: "" type: string - description: The password to authenticate with the cache store. Only applies when - store type 'nats-js-kv' is configured. - introductionVersion: "" + description: The password to authenticate with the cache. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" STORAGE_USERS_FILEMETADATA_CACHE_AUTH_USERNAME: - name: OCIS_CACHE_AUTH_USERNAME;STORAGE_USERS_FILEMETADATA_CACHE_AUTH_USERNAME + name: OCIS_CACHE_AUTH_USERNAME;SETTINGS_CACHE_AUTH_USERNAME defaultValue: "" type: string - description: The username to authenticate with the cache store. Only applies when - store type 'nats-js-kv' is configured. - introductionVersion: "" + description: The username to authenticate with the cache. Only applies when store + type 'nats-js-kv' is configured. + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" STORAGE_USERS_FILEMETADATA_CACHE_DISABLE_PERSISTENCE: - name: OCIS_CACHE_DISABLE_PERSISTENCE;STORAGE_USERS_FILEMETADATA_CACHE_DISABLE_PERSISTENCE + name: OCIS_CACHE_DISABLE_PERSISTENCE;SETTINGS_CACHE_DISABLE_PERSISTENCE defaultValue: "false" type: bool description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" STORAGE_USERS_FILEMETADATA_CACHE_SIZE: - name: OCIS_CACHE_SIZE;STORAGE_USERS_FILEMETADATA_CACHE_SIZE + name: OCIS_CACHE_SIZE;SETTINGS_CACHE_SIZE defaultValue: "0" type: int - description: The maximum quantity of items in the user info cache. Only applies - when store type 'ocmem' is configured. Defaults to 512 which is derived from the - ocmem package though not exclicitely set as default. - introductionVersion: "" + description: The maximum quantity of items in the cache. Only applies when store + type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package + though not exclicitely set as default. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" STORAGE_USERS_FILEMETADATA_CACHE_STORE: - name: OCIS_CACHE_STORE;STORAGE_USERS_FILEMETADATA_CACHE_STORE + name: OCIS_CACHE_STORE;SETTINGS_CACHE_STORE defaultValue: memory type: string description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', ''nats-js-kv'', ''noop''. See the text description for details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" STORAGE_USERS_FILEMETADATA_CACHE_STORE_NODES: - name: OCIS_CACHE_STORE_NODES;STORAGE_USERS_FILEMETADATA_CACHE_STORE_NODES + name: OCIS_CACHE_STORE_NODES;SETTINGS_CACHE_STORE_NODES defaultValue: '[127.0.0.1:9233]' type: '[]string' description: A list of nodes to access the configured store. This has no effect when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" STORAGE_USERS_FILEMETADATA_CACHE_TTL: - name: OCIS_CACHE_TTL;STORAGE_USERS_FILEMETADATA_CACHE_TTL - defaultValue: 24m0s + name: OCIS_CACHE_TTL;SETTINGS_CACHE_TTL + defaultValue: 10m0s type: Duration - description: Default time to live for user info in the user info cache. Only applied - when access tokens has no expiration. See the Environment Variable Types description - for more details. - introductionVersion: "" + description: Default time to live for entries in the cache. Only applied when access + tokens has no expiration. See the Environment Variable Types description for more + details. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" STORAGE_USERS_GATEWAY_GRPC_ADDR: - name: OCIS_GATEWAY_GRPC_ADDR;STORAGE_USERS_GATEWAY_GRPC_ADDR + name: OCIS_GATEWAY_GRPC_ADDR;GATEWAY_GRPC_ADDR defaultValue: 127.0.0.1:9142 type: string - description: The bind address of the gateway GRPC address. - introductionVersion: "" + description: The bind address of the GRPC service. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12250,7 +12250,7 @@ STORAGE_USERS_GRACEFUL_SHUTDOWN_TIMEOUT: shutdown cleanly before exiting with an error that gets logged. Note: This setting is only applicable when running the ''storage-users'' service as a standalone service. See the text description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12259,7 +12259,7 @@ STORAGE_USERS_GRPC_ADDR: defaultValue: 127.0.0.1:9157 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12268,7 +12268,7 @@ STORAGE_USERS_GRPC_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the GPRC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12277,7 +12277,7 @@ STORAGE_USERS_HTTP_ADDR: defaultValue: 127.0.0.1:9158 type: string description: The bind address of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12286,7 +12286,7 @@ STORAGE_USERS_HTTP_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12296,7 +12296,7 @@ STORAGE_USERS_ID_CACHE_AUTH_PASSWORD: type: string description: The password to authenticate with the cache store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12306,7 +12306,7 @@ STORAGE_USERS_ID_CACHE_AUTH_USERNAME: type: string description: The username to authenticate with the cache store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12316,7 +12316,7 @@ STORAGE_USERS_ID_CACHE_DISABLE_PERSISTENCE: type: bool description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12327,7 +12327,7 @@ STORAGE_USERS_ID_CACHE_SIZE: description: The maximum quantity of items in the user info cache. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitely set as default. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12337,7 +12337,7 @@ STORAGE_USERS_ID_CACHE_STORE: type: string description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', ''nats-js-kv'', ''noop''. See the text description for details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12349,7 +12349,7 @@ STORAGE_USERS_ID_CACHE_STORE_NODES: when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12361,7 +12361,7 @@ STORAGE_USERS_ID_CACHE_TTL: when access tokens have no expiration. Defaults to 300s which is derived from the underlaying package though not explicitly set as default. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12370,7 +12370,7 @@ STORAGE_USERS_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12379,7 +12379,7 @@ STORAGE_USERS_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12388,7 +12388,7 @@ STORAGE_USERS_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12398,7 +12398,7 @@ STORAGE_USERS_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12407,7 +12407,7 @@ STORAGE_USERS_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12426,7 +12426,7 @@ STORAGE_USERS_MOUNT_ID: defaultValue: "" type: string description: Mount ID of this storage. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12436,7 +12436,7 @@ STORAGE_USERS_OCIS_GENERAL_SPACE_ALIAS_TEMPLATE: lower}}' type: string description: Template string to construct general space aliases. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12447,7 +12447,7 @@ STORAGE_USERS_OCIS_LOCK_CYCLE_DURATION_FACTOR: description: When trying to lock files, ocis will multiply the cycle with this factor and use it as a millisecond timeout. Values of 0 or below will be ignored and the default value of 30 will be used. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12459,7 +12459,7 @@ STORAGE_USERS_OCIS_MAX_ACQUIRE_LOCK_CYCLES: the lock before failing. After each try it will wait for an increasing amount of time. Values of 0 or below will be ignored and the default value of 20 will be used. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12470,39 +12470,38 @@ STORAGE_USERS_OCIS_MAX_CONCURRENCY: description: Maximum number of concurrent go-routines. Higher values can potentially get work done faster but will also cause more load on the system. Values of 0 or below will be ignored and the default value of 100 will be used. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" STORAGE_USERS_OCIS_MAX_QUOTA: - name: OCIS_SPACES_MAX_QUOTA;STORAGE_USERS_OCIS_MAX_QUOTA + name: OCIS_SPACES_MAX_QUOTA;FRONTEND_MAX_QUOTA defaultValue: "0" type: uint64 - description: Set a global max quota for spaces in bytes. A value of 0 equals unlimited. - If not using the global OCIS_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA - in the frontend service. - introductionVersion: "" + description: Set the global max quota value in bytes. A value of 0 equals unlimited. + The value is provided via capabilities. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" STORAGE_USERS_OCIS_METADATA_BACKEND: - name: OCIS_DECOMPOSEDFS_METADATA_BACKEND;STORAGE_USERS_OCIS_METADATA_BACKEND + name: OCIS_DECOMPOSEDFS_METADATA_BACKEND;STORAGE_SYSTEM_OCIS_METADATA_BACKEND defaultValue: messagepack type: string description: The backend to use for storing metadata. Supported values are 'messagepack' and 'xattrs'. The setting 'messagepack' uses a dedicated file to store file metadata while 'xattrs' uses extended attributes to store file metadata. Defaults to 'messagepack'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" STORAGE_USERS_OCIS_PERMISSIONS_ENDPOINT: - name: STORAGE_USERS_PERMISSION_ENDPOINT;STORAGE_USERS_OCIS_PERMISSIONS_ENDPOINT + name: STORAGE_USERS_PERMISSION_ENDPOINT;STORAGE_USERS_S3NG_PERMISSIONS_ENDPOINT defaultValue: com.owncloud.api.settings type: string description: Endpoint of the permissions service. The endpoints can differ for 'ocis' and 's3ng'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12511,17 +12510,17 @@ STORAGE_USERS_OCIS_PERSONAL_SPACE_ALIAS_TEMPLATE: defaultValue: '{{.SpaceType}}/{{.User.Username \| lower}}' type: string description: Template string to construct personal space aliases. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" STORAGE_USERS_OCIS_PROPAGATOR: - name: OCIS_DECOMPOSEDFS_PROPAGATOR;STORAGE_USERS_OCIS_PROPAGATOR + name: OCIS_DECOMPOSEDFS_PROPAGATOR;STORAGE_USERS_S3NG_PROPAGATOR defaultValue: sync type: string description: The propagator used for decomposedfs. At the moment, only 'sync' is fully supported, 'async' is available as an experimental option. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12531,7 +12530,7 @@ STORAGE_USERS_OCIS_ROOT: type: string description: The directory where the filesystem storage will store blobs and metadata. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12540,7 +12539,7 @@ STORAGE_USERS_OCIS_SHARE_FOLDER: defaultValue: /Shares type: string description: Name of the folder jailing all shares. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12549,7 +12548,7 @@ STORAGE_USERS_OCIS_USER_LAYOUT: defaultValue: '{{.Id.OpaqueId}}' type: string description: Template string for the user storage layout in the user directory. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12559,7 +12558,7 @@ STORAGE_USERS_OWNCLOUDSQL_DATADIR: type: string description: The directory where the filesystem storage will store SQL migration data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/owncloud. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12568,7 +12567,7 @@ STORAGE_USERS_OWNCLOUDSQL_DB_HOST: defaultValue: "" type: string description: Hostname or IP of the database server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12577,7 +12576,7 @@ STORAGE_USERS_OWNCLOUDSQL_DB_NAME: defaultValue: owncloud type: string description: Name of the database to be used. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12586,7 +12585,7 @@ STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD: defaultValue: owncloud type: string description: Password for the database. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12595,7 +12594,7 @@ STORAGE_USERS_OWNCLOUDSQL_DB_PORT: defaultValue: "3306" type: int description: Port that the database server is listening on. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12604,7 +12603,7 @@ STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME: defaultValue: owncloud type: string description: Username for the database. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12614,7 +12613,7 @@ STORAGE_USERS_OWNCLOUDSQL_LAYOUT: type: string description: Path layout to use to navigate into a users folder in an owncloud data directory - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12623,7 +12622,7 @@ STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER: defaultValue: /Shares type: string description: Name of the folder jailing all shares. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12633,7 +12632,7 @@ STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR: type: string description: The directory where the filesystem will store uploads temporarily. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/uploadinfo. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12642,7 +12641,7 @@ STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT: defaultValue: com.owncloud.api.users type: string description: Endpoint of the users provider. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12652,7 +12651,7 @@ STORAGE_USERS_PERMISSION_ENDPOINT: type: string description: Endpoint of the permissions service. The endpoints can differ for 'ocis' and 's3ng'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12663,7 +12662,7 @@ STORAGE_USERS_PURGE_TRASH_BIN_PERSONAL_DELETE_BEFORE: description: Specifies the period of time in which items that have been in the personal trash-bin for longer than this value should be deleted. A value of 0 means no automatic deletion. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12674,18 +12673,18 @@ STORAGE_USERS_PURGE_TRASH_BIN_PROJECT_DELETE_BEFORE: description: Specifies the period of time in which items that have been in the project trash-bin for longer than this value should be deleted. A value of 0 means no automatic deletion. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" STORAGE_USERS_PURGE_TRASH_BIN_USER_ID: - name: OCIS_ADMIN_USER_ID;STORAGE_USERS_PURGE_TRASH_BIN_USER_ID + name: OCIS_ADMIN_USER_ID;SETTINGS_ADMIN_USER_ID defaultValue: "" type: string - description: ID of the user who collects all necessary information for deletion. - Consider that the UUID can be encoded in some LDAP deployment configurations like - in .ldif files. These need to be decoded beforehand. - introductionVersion: "" + description: ID of the user that should receive admin privileges. Consider that + the UUID can be encoded in some LDAP deployment configurations like in .ldif files. + These need to be decoded beforehand. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12694,7 +12693,7 @@ STORAGE_USERS_READ_ONLY: defaultValue: "false" type: bool description: Set this storage to be read-only. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12703,7 +12702,7 @@ STORAGE_USERS_S3NG_ACCESS_KEY: defaultValue: "" type: string description: Access key for the S3 bucket. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12712,7 +12711,7 @@ STORAGE_USERS_S3NG_BUCKET: defaultValue: "" type: string description: Name of the S3 bucket. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12721,7 +12720,7 @@ STORAGE_USERS_S3NG_ENDPOINT: defaultValue: "" type: string description: Endpoint for the S3 bucket. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12731,7 +12730,7 @@ STORAGE_USERS_S3NG_GENERAL_SPACE_ALIAS_TEMPLATE: lower}}' type: string description: Template string to construct general space aliases. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12742,7 +12741,7 @@ STORAGE_USERS_S3NG_LOCK_CYCLE_DURATION_FACTOR: description: When trying to lock files, ocis will multiply the cycle with this factor and use it as a millisecond timeout. Values of 0 or below will be ignored and the default value of 30 will be used. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12754,7 +12753,7 @@ STORAGE_USERS_S3NG_MAX_ACQUIRE_LOCK_CYCLES: the lock before failing. After each try it will wait for an increasing amount of time. Values of 0 or below will be ignored and the default value of 20 will be used. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12765,7 +12764,7 @@ STORAGE_USERS_S3NG_MAX_CONCURRENCY: description: Maximum number of concurrent go-routines. Higher values can potentially get work done faster but will also cause more load on the system. Values of 0 or below will be ignored and the default value of 100 will be used. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12777,7 +12776,7 @@ STORAGE_USERS_S3NG_METADATA_BACKEND: and 'messagepack'. The setting 'xattrs' uses extended attributes to store file metadata while 'messagepack' uses a dedicated file to store file metadata. Defaults to 'xattrs'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12787,7 +12786,7 @@ STORAGE_USERS_S3NG_PERMISSIONS_ENDPOINT: type: string description: Endpoint of the permissions service. The endpoints can differ for 'ocis' and 's3ng'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12796,7 +12795,7 @@ STORAGE_USERS_S3NG_PERSONAL_SPACE_ALIAS_TEMPLATE: defaultValue: '{{.SpaceType}}/{{.User.Username \| lower}}' type: string description: Template string to construct personal space aliases. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12806,7 +12805,7 @@ STORAGE_USERS_S3NG_PROPAGATOR: type: string description: The propagator used for decomposedfs. At the moment, only 'sync' is fully supported, 'async' is available as an experimental option. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12869,7 +12868,7 @@ STORAGE_USERS_S3NG_REGION: defaultValue: default type: string description: Region of the S3 bucket. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12879,7 +12878,7 @@ STORAGE_USERS_S3NG_ROOT: type: string description: The directory where the filesystem storage will store metadata for blobs. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12888,7 +12887,7 @@ STORAGE_USERS_S3NG_SECRET_KEY: defaultValue: "" type: string description: Secret key for the S3 bucket. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12897,7 +12896,7 @@ STORAGE_USERS_S3NG_SHARE_FOLDER: defaultValue: /Shares type: string description: Name of the folder jailing all shares. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12906,7 +12905,7 @@ STORAGE_USERS_S3NG_USER_LAYOUT: defaultValue: '{{.Id.OpaqueId}}' type: string description: Template string for the user storage layout in the user directory. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12916,7 +12915,7 @@ STORAGE_USERS_SERVICE_ACCOUNT_ID: type: string description: The ID of the service account the service should use. See the 'auth-service' service description for more details. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12925,7 +12924,7 @@ STORAGE_USERS_SERVICE_ACCOUNT_SECRET: defaultValue: "" type: string description: The service account secret. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12935,7 +12934,7 @@ STORAGE_USERS_SKIP_USER_GROUPS_IN_TOKEN: type: bool description: Disables the loading of user's group memberships from the reva access token. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12945,7 +12944,7 @@ STORAGE_USERS_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12954,7 +12953,7 @@ STORAGE_USERS_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12963,7 +12962,7 @@ STORAGE_USERS_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12973,7 +12972,7 @@ STORAGE_USERS_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12982,7 +12981,7 @@ STORAGE_USERS_TRANSFER_EXPIRES: defaultValue: "86400" type: int64 description: The time after which the token for upload postprocessing expires - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12993,7 +12992,7 @@ STORAGE_USERS_UPLOAD_EXPIRATION: description: Duration in seconds after which uploads will expire. Note that when setting this to a low number, uploads could be cancelled before they are finished and return a 403 to the user. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13003,138 +13002,138 @@ STORE_DATA_PATH: type: string description: The directory where the filesystem storage will store ocis settings. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/store. - introductionVersion: "" - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + introductionVersion: pre5.0 + deprecationVersion: "5.0" + removalVersion: 6.0.0 + deprecationInfo: The store service is optional and will be removed. STORE_DEBUG_ADDR: name: STORE_DEBUG_ADDR defaultValue: 127.0.0.1:9464 type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + introductionVersion: pre5.0 + deprecationVersion: "5.0" + removalVersion: 6.0.0 + deprecationInfo: The store service is optional and will be removed. STORE_DEBUG_PPROF: name: STORE_DEBUG_PPROF defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + introductionVersion: pre5.0 + deprecationVersion: "5.0" + removalVersion: 6.0.0 + deprecationInfo: The store service is optional and will be removed. STORE_DEBUG_TOKEN: name: STORE_DEBUG_TOKEN defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + introductionVersion: pre5.0 + deprecationVersion: "5.0" + removalVersion: 6.0.0 + deprecationInfo: The store service is optional and will be removed. STORE_DEBUG_ZPAGES: name: STORE_DEBUG_ZPAGES defaultValue: "false" type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + introductionVersion: pre5.0 + deprecationVersion: "5.0" + removalVersion: 6.0.0 + deprecationInfo: The store service is optional and will be removed. STORE_GRPC_ADDR: name: STORE_GRPC_ADDR defaultValue: 127.0.0.1:9460 type: string description: The bind address of the GRPC service. - introductionVersion: "" - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + introductionVersion: pre5.0 + deprecationVersion: "5.0" + removalVersion: 6.0.0 + deprecationInfo: The store service is optional and will be removed. STORE_LOG_COLOR: name: OCIS_LOG_COLOR;STORE_LOG_COLOR defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + introductionVersion: pre5.0 + deprecationVersion: "5.0" + removalVersion: 6.0.0 + deprecationInfo: The store service is optional and will be removed. STORE_LOG_FILE: name: OCIS_LOG_FILE;STORE_LOG_FILE defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + introductionVersion: pre5.0 + deprecationVersion: "5.0" + removalVersion: 6.0.0 + deprecationInfo: The store service is optional and will be removed. STORE_LOG_LEVEL: name: OCIS_LOG_LEVEL;STORE_LOG_LEVEL defaultValue: "" type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + introductionVersion: pre5.0 + deprecationVersion: "5.0" + removalVersion: 6.0.0 + deprecationInfo: The store service is optional and will be removed. STORE_LOG_PRETTY: name: OCIS_LOG_PRETTY;STORE_LOG_PRETTY defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + introductionVersion: pre5.0 + deprecationVersion: "5.0" + removalVersion: 6.0.0 + deprecationInfo: The store service is optional and will be removed. STORE_TRACING_COLLECTOR: name: OCIS_TRACING_COLLECTOR;STORE_TRACING_COLLECTOR defaultValue: "" type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + introductionVersion: pre5.0 + deprecationVersion: "5.0" + removalVersion: 6.0.0 + deprecationInfo: The store service is optional and will be removed. STORE_TRACING_ENABLED: name: OCIS_TRACING_ENABLED;STORE_TRACING_ENABLED defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + introductionVersion: pre5.0 + deprecationVersion: "5.0" + removalVersion: 6.0.0 + deprecationInfo: The store service is optional and will be removed. STORE_TRACING_ENDPOINT: name: OCIS_TRACING_ENDPOINT;STORE_TRACING_ENDPOINT defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + introductionVersion: pre5.0 + deprecationVersion: "5.0" + removalVersion: 6.0.0 + deprecationInfo: The store service is optional and will be removed. STORE_TRACING_TYPE: name: OCIS_TRACING_TYPE;STORE_TRACING_TYPE defaultValue: "" type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + introductionVersion: pre5.0 + deprecationVersion: "5.0" + removalVersion: 6.0.0 + deprecationInfo: The store service is optional and will be removed. THUMBNAILS_CS3SOURCE_INSECURE: name: OCIS_INSECURE;THUMBNAILS_CS3SOURCE_INSECURE defaultValue: "false" type: bool description: Ignore untrusted SSL certificates when connecting to the CS3 source. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13143,7 +13142,7 @@ THUMBNAILS_DATA_ENDPOINT: defaultValue: http://127.0.0.1:9186/thumbnails/data type: string description: The HTTP endpoint where the actual thumbnail file can be downloaded. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13153,7 +13152,7 @@ THUMBNAILS_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13162,7 +13161,7 @@ THUMBNAILS_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13171,7 +13170,7 @@ THUMBNAILS_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13181,7 +13180,7 @@ THUMBNAILS_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13191,7 +13190,7 @@ THUMBNAILS_FILESYSTEMSTORAGE_ROOT: type: string description: The directory where the filesystem storage will store the thumbnails. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/thumbnails. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13200,7 +13199,7 @@ THUMBNAILS_GRPC_ADDR: defaultValue: 127.0.0.1:9185 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13209,7 +13208,7 @@ THUMBNAILS_HTTP_ADDR: defaultValue: 127.0.0.1:9186 type: string description: The bind address of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13218,7 +13217,7 @@ THUMBNAILS_HTTP_ROOT: defaultValue: /thumbnails type: string description: Subdirectory that serves as the root for this HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13227,7 +13226,7 @@ THUMBNAILS_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13236,7 +13235,7 @@ THUMBNAILS_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13246,7 +13245,7 @@ THUMBNAILS_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13255,7 +13254,7 @@ THUMBNAILS_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13267,7 +13266,7 @@ THUMBNAILS_RESOLUTIONS: description: The supported list of target resolutions in the format WidthxHeight like 32x32. You can define any resolution as required. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13277,7 +13276,7 @@ THUMBNAILS_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13286,7 +13285,7 @@ THUMBNAILS_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13295,7 +13294,7 @@ THUMBNAILS_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13305,7 +13304,7 @@ THUMBNAILS_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13314,7 +13313,7 @@ THUMBNAILS_TRANSFER_TOKEN: defaultValue: "" type: string description: The secret to sign JWT to download the actual thumbnail file. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13323,7 +13322,7 @@ THUMBNAILS_TXT_FONTMAP_FILE: defaultValue: "" type: string description: The path to a font file for txt thumbnails. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13332,7 +13331,7 @@ THUMBNAILS_WEBDAVSOURCE_INSECURE: defaultValue: "false" type: bool description: Ignore untrusted SSL certificates when connecting to the webdav source. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13342,7 +13341,7 @@ USERLOG_CORS_ALLOW_CREDENTIALS: type: bool description: 'Allow credentials for CORS.See following chapter for more details: *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13354,7 +13353,7 @@ USERLOG_CORS_ALLOW_HEADERS: description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13365,7 +13364,7 @@ USERLOG_CORS_ALLOW_METHODS: description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13376,7 +13375,7 @@ USERLOG_CORS_ALLOW_ORIGINS: description: 'A list of allowed CORS origins. See following chapter for more details: *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13386,7 +13385,7 @@ USERLOG_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13395,7 +13394,7 @@ USERLOG_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13404,7 +13403,7 @@ USERLOG_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13414,7 +13413,7 @@ USERLOG_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13424,7 +13423,7 @@ USERLOG_EVENTS_AUTH_PASSWORD: type: string description: The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13434,7 +13433,7 @@ USERLOG_EVENTS_AUTH_USERNAME: type: string description: The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13445,7 +13444,7 @@ USERLOG_EVENTS_CLUSTER: description: The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13455,7 +13454,7 @@ USERLOG_EVENTS_ENABLE_TLS: type: bool description: Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13465,7 +13464,7 @@ USERLOG_EVENTS_ENDPOINT: type: string description: The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13474,7 +13473,7 @@ USERLOG_EVENTS_TLS_INSECURE: defaultValue: "false" type: bool description: Whether to verify the server TLS certificates. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13484,7 +13483,7 @@ USERLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE: type: string description: The root CA certificate used to validate the server's TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13495,7 +13494,7 @@ USERLOG_GLOBAL_NOTIFICATIONS_SECRET: description: The secret to secure the global notifications endpoint. Only system admins and users knowing that secret can call the global notifications POST/DELETE endpoints. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13504,7 +13503,7 @@ USERLOG_HTTP_ADDR: defaultValue: 127.0.0.1:0 type: string description: The bind address of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13513,7 +13512,7 @@ USERLOG_HTTP_ROOT: defaultValue: / type: string description: Subdirectory that serves as the root for this HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13522,7 +13521,7 @@ USERLOG_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13531,7 +13530,7 @@ USERLOG_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13540,7 +13539,7 @@ USERLOG_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13550,7 +13549,7 @@ USERLOG_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13559,57 +13558,59 @@ USERLOG_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERLOG_SERVICE_ACCOUNT_ID: - name: OCIS_SERVICE_ACCOUNT_ID;USERLOG_SERVICE_ACCOUNT_ID + name: SETTINGS_SERVICE_ACCOUNT_IDS;OCIS_SERVICE_ACCOUNT_ID defaultValue: "" - type: string - description: The ID of the service account the service should use. See the 'auth-service' - service description for more details. - introductionVersion: "" + type: '[]string' + description: 'The list of all service account IDs. These will be assigned the hidden + ''service-account'' role. Note: When using ''OCIS_SERVICE_ACCOUNT_ID'' this will + contain only one value while ''SETTINGS_SERVICE_ACCOUNT_IDS'' can have multiple. + See the ''auth-service'' service description for more details about service accounts.' + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERLOG_SERVICE_ACCOUNT_SECRET: - name: OCIS_SERVICE_ACCOUNT_SECRET;USERLOG_SERVICE_ACCOUNT_SECRET + name: OCIS_SERVICE_ACCOUNT_SECRET;PROXY_SERVICE_ACCOUNT_SECRET defaultValue: "" type: string description: The service account secret. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERLOG_STORE: - name: OCIS_PERSISTENT_STORE;USERLOG_STORE + name: OCIS_PERSISTENT_STORE;EVENTHISTORY_STORE defaultValue: memory type: string description: 'The type of the store. Supported values are: ''memory'', ''ocmem'', ''etcd'', ''redis'', ''redis-sentinel'', ''nats-js'', ''noop''. See the text description for details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERLOG_STORE_AUTH_PASSWORD: - name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;USERLOG_STORE_AUTH_PASSWORD + name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;EVENTHISTORY_STORE_AUTH_PASSWORD defaultValue: "" type: string description: The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERLOG_STORE_AUTH_USERNAME: - name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;USERLOG_STORE_AUTH_USERNAME + name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;EVENTHISTORY_STORE_AUTH_USERNAME defaultValue: "" type: string description: The username to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13618,30 +13619,30 @@ USERLOG_STORE_DATABASE: defaultValue: userlog type: string description: The database name the configured store should use. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERLOG_STORE_NODES: - name: OCIS_PERSISTENT_STORE_NODES;USERLOG_STORE_NODES + name: OCIS_PERSISTENT_STORE_NODES;EVENTHISTORY_STORE_NODES defaultValue: '[]' type: '[]string' description: A list of nodes to access the configured store. This has no effect when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERLOG_STORE_SIZE: - name: OCIS_PERSISTENT_STORE_SIZE;USERLOG_STORE_SIZE + name: OCIS_PERSISTENT_STORE_SIZE;EVENTHISTORY_STORE_SIZE defaultValue: "0" type: int description: The maximum quantity of items in the store. Only applies when store - type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package - though not exclicitely set as default. - introductionVersion: "" + type 'ocmem' is configured. Defaults to 512 which is derived and used from the + ocmem package though no explicit default was set. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13650,17 +13651,17 @@ USERLOG_STORE_TABLE: defaultValue: events type: string description: The database table the store should use. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERLOG_STORE_TTL: - name: OCIS_PERSISTENT_STORE_TTL;USERLOG_STORE_TTL + name: OCIS_PERSISTENT_STORE_TTL;EVENTHISTORY_STORE_TTL defaultValue: 336h0m0s type: Duration description: Time to live for events in the store. Defaults to '336h' (2 weeks). See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13670,7 +13671,7 @@ USERLOG_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13679,7 +13680,7 @@ USERLOG_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13688,7 +13689,7 @@ USERLOG_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13698,18 +13699,18 @@ USERLOG_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERLOG_TRANSLATION_PATH: - name: OCIS_TRANSLATION_PATH;USERLOG_TRANSLATION_PATH + name: OCIS_TRANSLATION_PATH;NOTIFICATIONS_TRANSLATION_PATH defaultValue: "" type: string description: (optional) Set this to a path with custom translations to overwrite the builtin translations. Note that file and folder naming rules apply, see the documentation for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13719,7 +13720,7 @@ USERS_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13728,7 +13729,7 @@ USERS_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13737,7 +13738,7 @@ USERS_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13747,7 +13748,7 @@ USERS_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13757,7 +13758,7 @@ USERS_DRIVER: type: string description: The driver which should be used by the users service. Supported values are 'ldap' and 'owncloudsql'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13766,7 +13767,7 @@ USERS_GRPC_ADDR: defaultValue: 127.0.0.1:9144 type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13775,17 +13776,16 @@ USERS_GRPC_PROTOCOL: defaultValue: tcp type: string description: The transport protocol of the GPRC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_IDP_URL: - name: OCIS_URL;OCIS_OIDC_ISSUER;USERS_IDP_URL + name: OCIS_URL;OCIS_OIDC_ISSUER;PROXY_OIDC_ISSUER defaultValue: https://localhost:9200 type: string - description: The identity provider value to set in the userids of the CS3 user objects - for users returned by this user provider. - introductionVersion: "" + description: URL of the OIDC issuer. It defaults to URL of the builtin IDP. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13794,42 +13794,42 @@ USERS_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_BIND_DN: - name: OCIS_LDAP_BIND_DN;USERS_LDAP_BIND_DN + name: OCIS_LDAP_BIND_DN;AUTH_BASIC_LDAP_BIND_DN defaultValue: uid=reva,ou=sysusers,o=libregraph-idm type: string description: LDAP DN to use for simple bind authentication with the target LDAP server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_BIND_PASSWORD: - name: OCIS_LDAP_BIND_PASSWORD;USERS_LDAP_BIND_PASSWORD + name: OCIS_LDAP_BIND_PASSWORD;AUTH_BASIC_LDAP_BIND_PASSWORD defaultValue: "" type: string description: Password to use for authenticating the 'bind_dn'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_CACERT: - name: OCIS_LDAP_CACERT;USERS_LDAP_CACERT + name: OCIS_LDAP_CACERT;AUTH_BASIC_LDAP_CACERT defaultValue: /var/lib/ocis/idm/ldap.crt type: string description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/idm. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_DISABLE_USER_MECHANISM: - name: OCIS_LDAP_DISABLE_USER_MECHANISM;USERS_LDAP_DISABLE_USER_MECHANISM + name: OCIS_LDAP_DISABLE_USER_MECHANISM;AUTH_BASIC_DISABLE_USER_MECHANISM defaultValue: attribute type: string description: An option to control the behavior for disabling users. Valid options @@ -13837,228 +13837,228 @@ USERS_LDAP_DISABLE_USER_MECHANISM: will add the user to the configured group for disabled users, if set to 'attribute' this will be done in the ldap user entry, if set to 'none' the disable request is not processed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_DISABLED_USERS_GROUP_DN: - name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;USERS_LDAP_DISABLED_USERS_GROUP_DN + name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;AUTH_BASIC_DISABLED_USERS_GROUP_DN defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm type: string description: The distinguished name of the group to which added users will be classified as disabled when 'disable_user_mechanism' is set to 'group'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_GROUP_BASE_DN: - name: OCIS_LDAP_GROUP_BASE_DN;USERS_LDAP_GROUP_BASE_DN + name: OCIS_LDAP_GROUP_BASE_DN;AUTH_BASIC_LDAP_GROUP_BASE_DN defaultValue: ou=groups,o=libregraph-idm type: string description: Search base DN for looking up LDAP groups. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_GROUP_FILTER: - name: OCIS_LDAP_GROUP_FILTER;USERS_LDAP_GROUP_FILTER + name: OCIS_LDAP_GROUP_FILTER;AUTH_BASIC_LDAP_GROUP_FILTER defaultValue: "" type: string description: LDAP filter to add to the default filters for group searches. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_GROUP_OBJECTCLASS: - name: OCIS_LDAP_GROUP_OBJECTCLASS;USERS_LDAP_GROUP_OBJECTCLASS + name: OCIS_LDAP_GROUP_OBJECTCLASS;AUTH_BASIC_LDAP_GROUP_OBJECTCLASS defaultValue: groupOfNames type: string description: The object class to use for groups in the default group search filter - like 'groupOfNames'. - introductionVersion: "" + ('groupOfNames'). + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_GROUP_SCHEMA_DISPLAYNAME: - name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;USERS_LDAP_GROUP_SCHEMA_DISPLAYNAME + name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;AUTH_BASIC_LDAP_GROUP_SCHEMA_DISPLAYNAME defaultValue: cn type: string description: LDAP Attribute to use for the displayname of groups (often the same as groupname attribute). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_GROUP_SCHEMA_GROUPNAME: - name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;USERS_LDAP_GROUP_SCHEMA_GROUPNAME + name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;AUTH_BASIC_LDAP_GROUP_SCHEMA_GROUPNAME defaultValue: cn type: string description: LDAP Attribute to use for the name of groups. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_GROUP_SCHEMA_ID: - name: OCIS_LDAP_GROUP_SCHEMA_ID;USERS_LDAP_GROUP_SCHEMA_ID + name: OCIS_LDAP_GROUP_SCHEMA_ID;AUTH_BASIC_LDAP_GROUP_SCHEMA_ID defaultValue: ownclouduuid type: string - description: LDAP Attribute to use as the unique ID for groups. This should be a - stable globally unique ID like a UUID. - introductionVersion: "" + description: LDAP Attribute to use as the unique id for groups. This should be a + stable globally unique id (e.g. a UUID). + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING: - name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;USERS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING + name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;AUTH_BASIC_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING defaultValue: "false" type: bool description: Set this to true if the defined 'id' attribute for groups is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute - of Active Directory for the group ID's. - introductionVersion: "" + of Active Directory for the group IDs. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_GROUP_SCHEMA_MAIL: - name: OCIS_LDAP_GROUP_SCHEMA_MAIL;USERS_LDAP_GROUP_SCHEMA_MAIL + name: OCIS_LDAP_GROUP_SCHEMA_MAIL;AUTH_BASIC_LDAP_GROUP_SCHEMA_MAIL defaultValue: mail type: string description: LDAP Attribute to use for the email address of groups (can be empty). - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_GROUP_SCHEMA_MEMBER: - name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;USERS_LDAP_GROUP_SCHEMA_MEMBER + name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;AUTH_BASIC_LDAP_GROUP_SCHEMA_MEMBER defaultValue: member type: string description: LDAP Attribute that is used for group members. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_GROUP_SCOPE: - name: OCIS_LDAP_GROUP_SCOPE;USERS_LDAP_GROUP_SCOPE + name: OCIS_LDAP_GROUP_SCOPE;AUTH_BASIC_LDAP_GROUP_SCOPE defaultValue: sub type: string description: LDAP search scope to use when looking up groups. Supported values are 'base', 'one' and 'sub'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_INSECURE: - name: OCIS_LDAP_INSECURE;USERS_LDAP_INSECURE + name: OCIS_LDAP_INSECURE;AUTH_BASIC_LDAP_INSECURE defaultValue: "false" type: bool description: Disable TLS certificate validation for the LDAP connections. Do not set this in production environments. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_URI: - name: OCIS_LDAP_URI;USERS_LDAP_URI + name: OCIS_LDAP_URI;AUTH_BASIC_LDAP_URI defaultValue: ldaps://localhost:9235 type: string description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_USER_BASE_DN: - name: OCIS_LDAP_USER_BASE_DN;USERS_LDAP_USER_BASE_DN + name: OCIS_LDAP_USER_BASE_DN;AUTH_BASIC_LDAP_USER_BASE_DN defaultValue: ou=users,o=libregraph-idm type: string description: Search base DN for looking up LDAP users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_USER_ENABLED_ATTRIBUTE: - name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;USERS_LDAP_USER_ENABLED_ATTRIBUTE + name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;AUTH_BASIC_LDAP_USER_ENABLED_ATTRIBUTE defaultValue: ownCloudUserEnabled type: string description: LDAP attribute to use as a flag telling if the user is enabled or disabled. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_USER_FILTER: - name: OCIS_LDAP_USER_FILTER;USERS_LDAP_USER_FILTER + name: OCIS_LDAP_USER_FILTER;AUTH_BASIC_LDAP_USER_FILTER defaultValue: "" type: string description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_USER_OBJECTCLASS: - name: OCIS_LDAP_USER_OBJECTCLASS;USERS_LDAP_USER_OBJECTCLASS + name: OCIS_LDAP_USER_OBJECTCLASS;AUTH_BASIC_LDAP_USER_OBJECTCLASS defaultValue: inetOrgPerson type: string description: The object class to use for users in the default user search filter - like 'inetOrgPerson'. - introductionVersion: "" + ('inetOrgPerson'). + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_USER_SCHEMA_DISPLAYNAME: - name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;USERS_LDAP_USER_SCHEMA_DISPLAYNAME + name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;AUTH_BASIC_LDAP_USER_SCHEMA_DISPLAYNAME defaultValue: displayname type: string description: LDAP Attribute to use for the displayname of users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_USER_SCHEMA_ID: - name: OCIS_LDAP_USER_SCHEMA_ID;USERS_LDAP_USER_SCHEMA_ID + name: OCIS_LDAP_USER_SCHEMA_ID;AUTH_BASIC_LDAP_USER_SCHEMA_ID defaultValue: ownclouduuid type: string description: LDAP Attribute to use as the unique ID for users. This should be a stable globally unique ID like a UUID. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING: - name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;USERS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING + name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;AUTH_BASIC_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING defaultValue: "false" type: bool description: Set this to true if the defined 'ID' attribute for users is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute - of Active Directory for the user ID's. - introductionVersion: "" + of Active Directory for the user IDs. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_USER_SCHEMA_MAIL: - name: OCIS_LDAP_USER_SCHEMA_MAIL;USERS_LDAP_USER_SCHEMA_MAIL + name: OCIS_LDAP_USER_SCHEMA_MAIL;AUTH_BASIC_LDAP_USER_SCHEMA_MAIL defaultValue: mail type: string description: LDAP Attribute to use for the email address of users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_USER_SCHEMA_USERNAME: - name: OCIS_LDAP_USER_SCHEMA_USERNAME;USERS_LDAP_USER_SCHEMA_USERNAME + name: OCIS_LDAP_USER_SCHEMA_USERNAME;AUTH_BASIC_LDAP_USER_SCHEMA_USERNAME defaultValue: uid type: string description: LDAP Attribute to use for username of users. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_USER_SCOPE: - name: OCIS_LDAP_USER_SCOPE;USERS_LDAP_USER_SCOPE + name: OCIS_LDAP_USER_SCOPE;AUTH_BASIC_LDAP_USER_SCOPE defaultValue: sub type: string description: LDAP search scope to use when looking up users. Supported values are 'base', 'one' and 'sub'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14069,17 +14069,17 @@ USERS_LDAP_USER_SUBSTRING_FILTER_TYPE: description: 'Type of substring search filter to use for substring searches for users. Possible values: ''initial'' for doing prefix only searches, ''final'' for doing suffix only searches or ''any'' for doing full substring searches' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" USERS_LDAP_USER_TYPE_ATTRIBUTE: - name: OCIS_LDAP_USER_SCHEMA_USER_TYPE;USERS_LDAP_USER_TYPE_ATTRIBUTE + name: OCIS_LDAP_USER_SCHEMA_USER_TYPE;GRAPH_LDAP_USER_TYPE_ATTRIBUTE defaultValue: ownCloudUserType type: string description: LDAP Attribute to distinguish between 'Member' and 'Guest' users. Default is 'ownCloudUserType'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14088,7 +14088,7 @@ USERS_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14097,7 +14097,7 @@ USERS_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14107,7 +14107,7 @@ USERS_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14116,7 +14116,7 @@ USERS_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14125,7 +14125,7 @@ USERS_OWNCLOUDSQL_DB_HOST: defaultValue: mysql type: string description: Hostname of the database server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14134,7 +14134,7 @@ USERS_OWNCLOUDSQL_DB_NAME: defaultValue: owncloud type: string description: Name of the owncloud database. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14143,7 +14143,7 @@ USERS_OWNCLOUDSQL_DB_PASSWORD: defaultValue: secret type: string description: Password for the database user. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14152,7 +14152,7 @@ USERS_OWNCLOUDSQL_DB_PORT: defaultValue: "3306" type: int description: Network port to use for the database connection. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14161,7 +14161,7 @@ USERS_OWNCLOUDSQL_DB_USERNAME: defaultValue: owncloud type: string description: Database user to use for authenticating with the owncloud database. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14171,7 +14171,7 @@ USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH: type: bool description: Allow 'medial search' when searching for users instead of just doing a prefix search. This allows finding 'Alice' when searching for 'lic'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14181,7 +14181,7 @@ USERS_OWNCLOUDSQL_IDP: type: string description: The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14190,7 +14190,7 @@ USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID: defaultValue: "false" type: bool description: Join the user properties table to read user IDs. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14199,7 +14199,7 @@ USERS_OWNCLOUDSQL_JOIN_USERNAME: defaultValue: "false" type: bool description: Join the user properties table to read usernames - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14208,7 +14208,7 @@ USERS_OWNCLOUDSQL_NOBODY: defaultValue: "90" type: int64 description: Fallback number if no numeric UID and GID properties are provided. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14218,7 +14218,7 @@ USERS_SKIP_USER_GROUPS_IN_TOKEN: type: bool description: Disables the loading of user's group memberships from the reva access token. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14228,7 +14228,7 @@ USERS_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14237,7 +14237,7 @@ USERS_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14246,7 +14246,7 @@ USERS_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14256,7 +14256,7 @@ USERS_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14286,16 +14286,16 @@ WEB_ASSET_PATH: type: string description: Serve ownCloud Web assets from a path on the filesystem instead of the builtin assets. - introductionVersion: "" - deprecationVersion: "" - removalVersion: "" - deprecationInfo: "" + introductionVersion: pre5.0 + deprecationVersion: 5.1.0 + removalVersion: 6.0.0 + deprecationInfo: The WEB_ASSET_PATH is deprecated and will be removed in the future. WEB_CACHE_TTL: name: WEB_CACHE_TTL defaultValue: "604800" type: int description: Cache policy in seconds for ownCloud Web assets. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14305,7 +14305,7 @@ WEB_CORS_ALLOW_CREDENTIALS: type: bool description: 'Allow credentials for CORS. See following chapter for more details: *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14319,7 +14319,7 @@ WEB_CORS_ALLOW_HEADERS: description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14331,7 +14331,7 @@ WEB_CORS_ALLOW_METHODS: description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14342,7 +14342,7 @@ WEB_CORS_ALLOW_ORIGINS: description: 'A list of allowed CORS origins. See following chapter for more details: *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14352,7 +14352,7 @@ WEB_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14361,7 +14361,7 @@ WEB_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14370,7 +14370,7 @@ WEB_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14380,7 +14380,7 @@ WEB_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14389,7 +14389,7 @@ WEB_GATEWAY_GRPC_ADDR: defaultValue: com.owncloud.api.gateway type: string description: The bind address of the GRPC service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14398,7 +14398,7 @@ WEB_HTTP_ADDR: defaultValue: 127.0.0.1:9100 type: string description: The bind address of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14407,7 +14407,7 @@ WEB_HTTP_ROOT: defaultValue: / type: string description: Subdirectory that serves as the root for this HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14416,7 +14416,7 @@ WEB_JWT_SECRET: defaultValue: "" type: string description: The secret to mint and validate jwt tokens. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14425,7 +14425,7 @@ WEB_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14434,7 +14434,7 @@ WEB_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14444,7 +14444,7 @@ WEB_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14453,7 +14453,7 @@ WEB_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14462,7 +14462,7 @@ WEB_OIDC_AUTHORITY: defaultValue: https://localhost:9200 type: string description: URL of the OIDC issuer. It defaults to URL of the builtin IDP. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14473,7 +14473,7 @@ WEB_OIDC_CLIENT_ID: description: The OIDC client ID which ownCloud Web uses. This client needs to be set up in your IDP. Note that this setting has no effect when using the builtin IDP. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14483,7 +14483,7 @@ WEB_OIDC_METADATA_URL: type: string description: URL for the OIDC well-known configuration endpoint. Defaults to the oCIS API URL + '/.well-known/openid-configuration'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14494,7 +14494,7 @@ WEB_OIDC_POST_LOGOUT_REDIRECT_URI: description: This value needs to point to a valid and reachable web page. The web client will trigger a redirect to that page directly after the logout action. The default value is empty and redirects to the login page. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14503,7 +14503,7 @@ WEB_OIDC_RESPONSE_TYPE: defaultValue: code type: string description: The OIDC response type to use for authentication. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14514,7 +14514,7 @@ WEB_OIDC_SCOPE: description: OIDC scopes to request during authentication to authorize access to user details. Defaults to 'openid profile email'. Values are separated by blank. More example values but not limited to are 'address' or 'phone' etc. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14524,7 +14524,7 @@ WEB_OPTION_CONCURRENT_REQUESTS_RESOURCE_BATCH_ACTIONS: type: int description: Defines the maximum number of concurrent requests per file/folder/space batch action. Defaults to 4. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14534,7 +14534,7 @@ WEB_OPTION_CONCURRENT_REQUESTS_SHARES_CREATE: type: int description: Defines the maximum number of concurrent requests per sharing invite batch. Defaults to 4. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14544,7 +14544,7 @@ WEB_OPTION_CONCURRENT_REQUESTS_SHARES_LIST: type: int description: Defines the maximum number of concurrent requests when loading individual share information inside listings. Defaults to 2. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14554,7 +14554,7 @@ WEB_OPTION_CONCURRENT_REQUESTS_SSE: type: int description: Defines the maximum number of concurrent requests in SSE event handlers. Defaults to 4. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14563,7 +14563,7 @@ WEB_OPTION_CONTEXTHELPERS_READ_MORE: defaultValue: "true" type: bool description: Specifies whether the 'Read more' link should be displayed or not. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14575,19 +14575,18 @@ WEB_OPTION_DISABLE_FEEDBACK_LINK: Keeping it enabled by setting the value to 'false' or with the absence of the option, allows ownCloud to get feedback from your user base through a dedicated survey website. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" WEB_OPTION_DISABLE_PREVIEWS: - name: OCIS_DISABLE_PREVIEWS;WEB_OPTION_DISABLE_PREVIEWS + name: OCIS_DISABLE_PREVIEWS;WEBDAV_DISABLE_PREVIEWS defaultValue: "false" type: bool - description: Set this option to 'true' to disable previews in all the different - web file listing views. This can speed up file listings in folders with many files. - The only list view that is not affected by this setting is the trash bin, as it - does not allow previewing at all. - introductionVersion: "" + description: Set this option to 'true' to disable rendering of thumbnails triggered + via webdav access. Note that when disabled, all access to preview related webdav + paths will return a 404. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14599,7 +14598,7 @@ WEB_OPTION_DISABLED_EXTENSIONS: The ID can e.g. be taken from the ''index.ts'' file of the web extension. Example: ''com.github.owncloud.web.files.search,com.github.owncloud.web.files.print''. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14614,7 +14613,7 @@ WEB_OPTION_HOME_FOLDER: specific home path can be used. This uses the twig template variable style and allows picking a value or a substring of a value of the authenticated user. Examples are '/Shares', '/{{.Id}}' and '/{{substr 0 3 .Id}}/{{.Id}'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14625,7 +14624,7 @@ WEB_OPTION_HOVERABLE_QUICK_ACTIONS: description: Set this option to 'true' to hide quick actions (buttons appearing on file rows) and only show them when the user hovers over the row with his mouse. Defaults to 'false'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14635,7 +14634,7 @@ WEB_OPTION_LOGIN_URL: type: string description: 'Specifies the target URL to the login page. This is helpful when an external IdP is used. This option is disabled by default. Example URL like: https://www.myidp.com/login.' - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14646,7 +14645,7 @@ WEB_OPTION_LOGOUT_URL: description: Adds a link to the user's profile page to point him to an external page, where he can manage his session and devices. This is helpful when an external IdP is used. This option is disabled by default. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14656,7 +14655,7 @@ WEB_OPTION_OPEN_APPS_IN_TAB: type: bool description: Configures whether apps and extensions should generally open in a new tab. Defaults to false. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14667,7 +14666,7 @@ WEB_OPTION_OPEN_LINKS_WITH_DEFAULT_APP: description: Specifies whether single file link shares should be opened with the default app or not. If not opened by the default app, the Web UI just displays the file details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14679,7 +14678,7 @@ WEB_OPTION_PREVIEW_FILE_MIMETYPES: description: A list of mimeTypes to specify which ones will be previewed in the UI. For example, to only preview jpg and text files, set this option to 'image/jpeg,text/plain'. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14691,7 +14690,7 @@ WEB_OPTION_ROUTING_ID_BASED: because otherwise spaces with name clashes cannot be resolved correctly. Note: Only disable this if you can guarantee on the server side, that spaces of the same namespace cannot have name clashes.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14701,7 +14700,7 @@ WEB_OPTION_RUNNING_ON_EOS: type: bool description: Set this option to 'true' if running on an EOS storage backend (https://eos-web.web.cern.ch/eos-web/) to enable its specific features. Defaults to 'false'. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14711,7 +14710,7 @@ WEB_OPTION_SHARING_RECIPIENTS_PER_PAGE: type: int description: Sets the number of users shown as recipients in the dropdown menu when sharing resources. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14721,7 +14720,7 @@ WEB_OPTION_SIDEBAR_SHARES_SHOW_ALL_ON_LOAD: type: bool description: Sets the list of the (link) shares list in the sidebar to be initially expanded. Default is a collapsed state, only showing the first three shares. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14733,7 +14732,7 @@ WEB_OPTION_TOKEN_STORAGE_LOCAL: when set to 'true' or in the session storage when set to 'false'. If stored in the local storage, login state will be persisted across multiple browser tabs, means no additional logins are required. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14745,7 +14744,7 @@ WEB_OPTION_USER_LIST_REQUIRES_FILTER: in the Web admin settings. Set this option to 'true' if running in an environment with a lot of users and listing all users could slow down performance. Defaults to 'false'. - introductionVersion: "" + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14755,7 +14754,7 @@ WEB_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14764,7 +14763,7 @@ WEB_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14773,7 +14772,7 @@ WEB_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14783,7 +14782,7 @@ WEB_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14794,7 +14793,7 @@ WEB_UI_CONFIG_FILE: description: Read the ownCloud Web json based configuration from this path/file. The config file takes precedence over WEB_OPTION_xxx environment variables. See the text description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14803,7 +14802,7 @@ WEB_UI_CONFIG_SERVER: defaultValue: https://localhost:9200 type: string description: URL, where the oCIS APIs are reachable for ownCloud Web. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14813,7 +14812,7 @@ WEB_UI_THEME_PATH: type: string description: Subpath/file to load the theme. Will be appended to the URL of the theme server. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14822,7 +14821,7 @@ WEB_UI_THEME_SERVER: defaultValue: https://localhost:9200 type: string description: Base URL to load themes from. Will be prepended to the theme path. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14832,7 +14831,7 @@ WEBDAV_CORS_ALLOW_CREDENTIALS: type: bool description: 'Allow credentials for CORS.See following chapter for more details: *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14844,7 +14843,7 @@ WEBDAV_CORS_ALLOW_HEADERS: description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14855,7 +14854,7 @@ WEBDAV_CORS_ALLOW_METHODS: description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14866,7 +14865,7 @@ WEBDAV_CORS_ALLOW_ORIGINS: description: 'A list of allowed CORS origins. See following chapter for more details: *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14876,7 +14875,7 @@ WEBDAV_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14885,7 +14884,7 @@ WEBDAV_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14894,7 +14893,7 @@ WEBDAV_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14904,7 +14903,7 @@ WEBDAV_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14915,7 +14914,7 @@ WEBDAV_DISABLE_PREVIEWS: description: Set this option to 'true' to disable rendering of thumbnails triggered via webdav access. Note that when disabled, all access to preview related webdav paths will return a 404. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14924,7 +14923,7 @@ WEBDAV_HTTP_ADDR: defaultValue: 127.0.0.1:9115 type: string description: The bind address of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14933,7 +14932,7 @@ WEBDAV_HTTP_ROOT: defaultValue: / type: string description: Subdirectory that serves as the root for this HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14942,7 +14941,7 @@ WEBDAV_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14951,7 +14950,7 @@ WEBDAV_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14961,7 +14960,7 @@ WEBDAV_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14970,7 +14969,7 @@ WEBDAV_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14980,7 +14979,7 @@ WEBDAV_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14989,7 +14988,7 @@ WEBDAV_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14998,7 +14997,7 @@ WEBDAV_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15008,7 +15007,7 @@ WEBDAV_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15017,7 +15016,7 @@ WEBDAV_WEBDAV_NAMESPACE: defaultValue: /users/{{.Id.OpaqueId}} type: string description: CS3 path layout to use when forwarding /webdav requests - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15027,7 +15026,7 @@ WEBFINGER_CORS_ALLOW_CREDENTIALS: type: bool description: 'Allow credentials for CORS.See following chapter for more details: *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15038,7 +15037,7 @@ WEBFINGER_CORS_ALLOW_HEADERS: description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15049,7 +15048,7 @@ WEBFINGER_CORS_ALLOW_METHODS: description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15060,7 +15059,7 @@ WEBFINGER_CORS_ALLOW_ORIGINS: description: 'A list of allowed CORS origins. See following chapter for more details: *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. See the Environment Variable Types description for more details.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15070,7 +15069,7 @@ WEBFINGER_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15079,7 +15078,7 @@ WEBFINGER_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15088,7 +15087,7 @@ WEBFINGER_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15098,7 +15097,7 @@ WEBFINGER_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15107,7 +15106,7 @@ WEBFINGER_HTTP_ADDR: defaultValue: 127.0.0.1:0 type: string description: The bind address of the HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15116,7 +15115,7 @@ WEBFINGER_HTTP_ROOT: defaultValue: / type: string description: Subdirectory that serves as the root for this HTTP service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15125,7 +15124,7 @@ WEBFINGER_INSECURE: defaultValue: "false" type: bool description: Allow insecure connections to the WEBFINGER service. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15134,7 +15133,7 @@ WEBFINGER_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15143,7 +15142,7 @@ WEBFINGER_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15153,7 +15152,7 @@ WEBFINGER_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15162,7 +15161,7 @@ WEBFINGER_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15171,7 +15170,7 @@ WEBFINGER_OIDC_ISSUER: defaultValue: https://localhost:9200 type: string description: The identity provider href for the openid-discovery relation. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15183,7 +15182,7 @@ WEBFINGER_OWNCLOUD_SERVER_INSTANCE_URL: confused with the product ownCloud Server). It defaults to the OCIS_URL but can be overridden to support some reverse proxy corner cases. To shard the deployment, multiple instances can be configured in the configuration file. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15193,7 +15192,7 @@ WEBFINGER_RELATIONS: type: '[]string' description: A list of relation URIs or registered relation types to add to webfinger responses. See the Environment Variable Types description for more details. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15203,7 +15202,7 @@ WEBFINGER_TRACING_COLLECTOR: type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15212,7 +15211,7 @@ WEBFINGER_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15221,7 +15220,7 @@ WEBFINGER_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15231,7 +15230,7 @@ WEBFINGER_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: "" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" From b86d893ee9d89a6e57113a195e2f9297db1ec086 Mon Sep 17 00:00:00 2001 From: Christian Richter Date: Wed, 20 Mar 2024 17:25:53 +0100 Subject: [PATCH 10/10] add safeguard for proper semver fields Signed-off-by: Christian Richter --- docs/helpers/env-var-delta.go | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/helpers/env-var-delta.go b/docs/helpers/env-var-delta.go index 755a144562..7d917e6821 100644 --- a/docs/helpers/env-var-delta.go +++ b/docs/helpers/env-var-delta.go @@ -74,16 +74,25 @@ func RenderEnvVarDeltaTable(osArgs []string) { } fmt.Printf("Success, found %d entries\n", len(configFields)) for _, field := range configFields { - if field.DeprecationVersion != "" { - fmt.Printf("Processing field %s\n", field.Name) + if field.IntroductionVersion != "" && + field.IntroductionVersion != "pre5.0" && + !semver.IsValid(field.IntroductionVersion) && + field.IntroductionVersion[0] != 'v' { + field.IntroductionVersion = "v" + field.IntroductionVersion } - if field.RemovalVersion != "" && semver.Compare(startVersion, field.RemovalVersion) < 0 && semver.Compare(endVersion, field.RemovalVersion) >= 0 { + if field.IntroductionVersion != "pre5.0" && !semver.IsValid(field.IntroductionVersion) { + fmt.Printf("Invalid semver for field %s: %s\n", field.Name, field.IntroductionVersion) + os.Exit(1) + } + //fmt.Printf("Processing field %s dv: %s, iv: %s\n", field.Name, field.DeprecationVersion, field.IntroductionVersion) + if semver.IsValid(field.RemovalVersion) && semver.Compare(startVersion, field.RemovalVersion) < 0 && semver.Compare(endVersion, field.RemovalVersion) >= 0 { variableList["removed"] = append(variableList["removed"], field) } - if field.DeprecationVersion != "" && semver.Compare(startVersion, field.DeprecationVersion) <= 0 && semver.Compare(endVersion, field.DeprecationVersion) > 0 { + if semver.IsValid(field.DeprecationVersion) && semver.Compare(startVersion, field.DeprecationVersion) <= 0 && semver.Compare(endVersion, field.DeprecationVersion) > 0 { variableList["deprecated"] = append(variableList["deprecated"], field) } - if field.IntroductionVersion != "" && semver.Compare(startVersion, field.IntroductionVersion) <= 0 && semver.Compare(endVersion, field.IntroductionVersion) > 0 { + if semver.IsValid(field.IntroductionVersion) && semver.Compare(startVersion, field.IntroductionVersion) <= 0 && semver.Compare(endVersion, field.IntroductionVersion) >= 0 { + fmt.Printf("Adding field %s iv: %s\n", field.Name, field.IntroductionVersion) variableList["added"] = append(variableList["added"], field) } }