From 9531878555cfd3613159dd2fe95d8d7b4bfce200 Mon Sep 17 00:00:00 2001 From: Martin Date: Wed, 6 Jul 2022 06:31:26 +0000 Subject: [PATCH] commit c24a8cd6187526ccafc78db4e8e306b34d915486 Merge: 2e640424c 9a211daa9 Author: Martin Date: Wed Jul 6 08:27:21 2022 +0200 Merge pull request #4108 from owncloud/fix_adoc Update the adoc table generation --- grpc_apis/ocis/messages/search/v0/grpc.md | 2 +- grpc_apis/ocis/messages/settings/v0/grpc.md | 2 +- grpc_apis/ocis/messages/store/v0/grpc.md | 2 +- grpc_apis/ocis/messages/thumbnails/v0/grpc.md | 2 +- grpc_apis/ocis/services/search/v0/grpc.md | 2 +- grpc_apis/ocis/services/settings/v0/grpc.md | 2 +- grpc_apis/ocis/services/store/v0/grpc.md | 2 +- grpc_apis/ocis/services/thumbnails/v0/grpc.md | 2 +- helpers/adoc-generator.go.tmpl | 6 +- .../adoc/app-provider_configvars.adoc | 108 ++++----- .../adoc/app-registry_configvars.adoc | 64 +++--- services/_includes/adoc/audit_configvars.adoc | 60 ++--- .../_includes/adoc/auth-basic_configvars.adoc | 212 +++++++++--------- .../adoc/auth-bearer_configvars.adoc | 88 ++++---- .../adoc/auth-machine_configvars.adoc | 72 +++--- .../_includes/adoc/frontend_configvars.adoc | 160 ++++++------- .../_includes/adoc/gateway_configvars.adoc | 140 ++++++------ .../adoc/graph-explorer_configvars.adoc | 72 +++--- services/_includes/adoc/graph_configvars.adoc | 184 +++++++-------- .../_includes/adoc/groups_configvars.adoc | 208 ++++++++--------- services/_includes/adoc/idm_configvars.adoc | 88 ++++---- services/_includes/adoc/idp_configvars.adoc | 208 ++++++++--------- services/_includes/adoc/nats_configvars.adoc | 48 ++-- .../adoc/notifications_configvars.adoc | 68 +++--- services/_includes/adoc/ocdav_configvars.adoc | 100 ++++----- services/_includes/adoc/ocs_configvars.adoc | 72 +++--- services/_includes/adoc/proxy_configvars.adoc | 124 +++++----- .../_includes/adoc/search_configvars.adoc | 76 +++---- .../_includes/adoc/settings_configvars.adoc | 108 ++++----- .../_includes/adoc/sharing_configvars.adoc | 148 ++++++------ .../adoc/storage-publiclink_configvars.adoc | 72 +++--- .../adoc/storage-shares_configvars.adoc | 80 +++---- .../adoc/storage-system_configvars.adoc | 104 ++++----- .../adoc/storage-users_configvars.adoc | 212 +++++++++--------- services/_includes/adoc/store_configvars.adoc | 56 ++--- .../_includes/adoc/thumbnails_configvars.adoc | 92 ++++---- services/_includes/adoc/users_configvars.adoc | 212 +++++++++--------- services/_includes/adoc/web_configvars.adoc | 104 ++++----- .../_includes/adoc/webdav_configvars.adoc | 68 +++--- templates/ADOC.tmpl | 4 +- 40 files changed, 1717 insertions(+), 1717 deletions(-) diff --git a/grpc_apis/ocis/messages/search/v0/grpc.md b/grpc_apis/ocis/messages/search/v0/grpc.md index 78da78dee46..765a3c6910c 100644 --- a/grpc_apis/ocis/messages/search/v0/grpc.md +++ b/grpc_apis/ocis/messages/search/v0/grpc.md @@ -1,7 +1,7 @@ --- title: "ocis.messages.search.v0" url: /grpc_apis/ocis_messages_search_v0 -date: 2022-07-06T00:52:15Z +date: 2022-07-06T06:29:02Z weight: 50 geekdocRepo: https://github.com/owncloud/ocis --- diff --git a/grpc_apis/ocis/messages/settings/v0/grpc.md b/grpc_apis/ocis/messages/settings/v0/grpc.md index 1e8f250107c..aada830ddec 100644 --- a/grpc_apis/ocis/messages/settings/v0/grpc.md +++ b/grpc_apis/ocis/messages/settings/v0/grpc.md @@ -1,7 +1,7 @@ --- title: "ocis.messages.settings.v0" url: /grpc_apis/ocis_messages_settings_v0 -date: 2022-07-06T00:52:15Z +date: 2022-07-06T06:29:02Z weight: 50 geekdocRepo: https://github.com/owncloud/ocis --- diff --git a/grpc_apis/ocis/messages/store/v0/grpc.md b/grpc_apis/ocis/messages/store/v0/grpc.md index cbebddd8c00..131d995e52d 100644 --- a/grpc_apis/ocis/messages/store/v0/grpc.md +++ b/grpc_apis/ocis/messages/store/v0/grpc.md @@ -1,7 +1,7 @@ --- title: "ocis.messages.store.v0" url: /grpc_apis/ocis_messages_store_v0 -date: 2022-07-06T00:52:15Z +date: 2022-07-06T06:29:02Z weight: 50 geekdocRepo: https://github.com/owncloud/ocis --- diff --git a/grpc_apis/ocis/messages/thumbnails/v0/grpc.md b/grpc_apis/ocis/messages/thumbnails/v0/grpc.md index 0a53af3ba39..88c02943817 100644 --- a/grpc_apis/ocis/messages/thumbnails/v0/grpc.md +++ b/grpc_apis/ocis/messages/thumbnails/v0/grpc.md @@ -1,7 +1,7 @@ --- title: "ocis.messages.thumbnails.v0" url: /grpc_apis/ocis_messages_thumbnails_v0 -date: 2022-07-06T00:52:15Z +date: 2022-07-06T06:29:02Z weight: 50 geekdocRepo: https://github.com/owncloud/ocis --- diff --git a/grpc_apis/ocis/services/search/v0/grpc.md b/grpc_apis/ocis/services/search/v0/grpc.md index 37f7674f343..b0d34d8bde6 100644 --- a/grpc_apis/ocis/services/search/v0/grpc.md +++ b/grpc_apis/ocis/services/search/v0/grpc.md @@ -1,7 +1,7 @@ --- title: "ocis.services.search.v0" url: /grpc_apis/ocis_services_search_v0 -date: 2022-07-06T00:52:15Z +date: 2022-07-06T06:29:02Z weight: 50 geekdocRepo: https://github.com/owncloud/ocis --- diff --git a/grpc_apis/ocis/services/settings/v0/grpc.md b/grpc_apis/ocis/services/settings/v0/grpc.md index 285ef4aa2dd..712ce34b24c 100644 --- a/grpc_apis/ocis/services/settings/v0/grpc.md +++ b/grpc_apis/ocis/services/settings/v0/grpc.md @@ -1,7 +1,7 @@ --- title: "ocis.services.settings.v0" url: /grpc_apis/ocis_services_settings_v0 -date: 2022-07-06T00:52:15Z +date: 2022-07-06T06:29:02Z weight: 50 geekdocRepo: https://github.com/owncloud/ocis --- diff --git a/grpc_apis/ocis/services/store/v0/grpc.md b/grpc_apis/ocis/services/store/v0/grpc.md index 6c1b87803bb..418ad986bb2 100644 --- a/grpc_apis/ocis/services/store/v0/grpc.md +++ b/grpc_apis/ocis/services/store/v0/grpc.md @@ -1,7 +1,7 @@ --- title: "ocis.services.store.v0" url: /grpc_apis/ocis_services_store_v0 -date: 2022-07-06T00:52:15Z +date: 2022-07-06T06:29:02Z weight: 50 geekdocRepo: https://github.com/owncloud/ocis --- diff --git a/grpc_apis/ocis/services/thumbnails/v0/grpc.md b/grpc_apis/ocis/services/thumbnails/v0/grpc.md index ba37d7d7b27..07f3349b052 100644 --- a/grpc_apis/ocis/services/thumbnails/v0/grpc.md +++ b/grpc_apis/ocis/services/thumbnails/v0/grpc.md @@ -1,7 +1,7 @@ --- title: "ocis.services.thumbnails.v0" url: /grpc_apis/ocis_services_thumbnails_v0 -date: 2022-07-06T00:52:15Z +date: 2022-07-06T06:29:02Z weight: 50 geekdocRepo: https://github.com/owncloud/ocis --- diff --git a/helpers/adoc-generator.go.tmpl b/helpers/adoc-generator.go.tmpl index 775c17ec724..d091b047768 100644 --- a/helpers/adoc-generator.go.tmpl +++ b/helpers/adoc-generator.go.tmpl @@ -89,9 +89,9 @@ func GetAnnotatedVariables(s interface{}) []ConfigField { } v := fmt.Sprintf("%v", value.Interface()) td := strings.Split(env, ";") - re := regexp.MustCompile(`^(https?:\/\/)`) - v = re.ReplaceAllString(v,"\\$1") - re = regexp.MustCompile(`(https?:\/\/)`) + // re := regexp.MustCompile(`^(https?:\/\/)`) + // v = re.ReplaceAllString(v,"\\$1") + re := regexp.MustCompile(`(https?:\/\/)`) desc = re.ReplaceAllString(desc, "\\$1") re = regexp.MustCompile(`(\|)`) v = re.ReplaceAllString(v, "\\$1") diff --git a/services/_includes/adoc/app-provider_configvars.adoc b/services/_includes/adoc/app-provider_configvars.adoc index 695945e5292..fc34884156e 100644 --- a/services/_includes/adoc/app-provider_configvars.adoc +++ b/services/_includes/adoc/app-provider_configvars.adoc @@ -11,199 +11,199 @@ `APP_PROVIDER_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `APP_PROVIDER_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `APP_PROVIDER_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `APP_PROVIDER_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `APP_PROVIDER_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `APP_PROVIDER_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `APP_PROVIDER_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `APP_PROVIDER_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`APP_PROVIDER_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9165 +pass:[127.0.0.1:9165] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`APP_PROVIDER_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`APP_PROVIDER_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`APP_PROVIDER_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing traces in-memory. +pass:[Enables zpages, which can be used for collecting and viewing traces in-memory.] |`APP_PROVIDER_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9164 +pass:[127.0.0.1:9164] a| [subs=-attributes] -The bind address of the GRPC service. +pass:[The bind address of the GRPC service.] |`APP_PROVIDER_GRPC_PROTOCOL` | string a| [subs=-attributes] -tcp +pass:[tcp] a| [subs=-attributes] -The transport protocol of the grpc service. +pass:[The transport protocol of the grpc service.] |`OCIS_JWT_SECRET` + `APP_PROVIDER_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`APP_PROVIDER_EXTERNAL_ADDR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Address of the app provider, where the gateway service can reach it. +pass:[Address of the app provider, where the gateway service can reach it.] |`APP_PROVIDER_DRIVER` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Driver, which the app provider uses. Only "wopi" is supported as of now. +pass:[Driver, which the app provider uses. Only "wopi" is supported as of now.] |`APP_PROVIDER_WOPI_APP_API_KEY` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -API key for the wopi app. +pass:[API key for the wopi app.] |`APP_PROVIDER_WOPI_APP_DESKTOP_ONLY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Offer this app only on desktop. +pass:[Offer this app only on desktop.] |`APP_PROVIDER_WOPI_APP_ICON_URI` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -URI to an app icon to be used by clients. +pass:[URI to an app icon to be used by clients.] |`APP_PROVIDER_WOPI_APP_INTERNAL_URL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Internal URL to the app, eg in your DMZ. +pass:[Internal URL to the app, eg in your DMZ.] |`APP_PROVIDER_WOPI_APP_NAME` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Human readable app name. +pass:[Human readable app name.] |`APP_PROVIDER_WOPI_APP_URL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -URL for end users to access the app. +pass:[URL for end users to access the app.] |`APP_PROVIDER_WOPI_INSECURE` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Allow insecure connections to the app. +pass:[Allow insecure connections to the app.] |`APP_PROVIDER_WOPI_WOPI_SERVER_IOP_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Shared secret of the CS3org WOPI server. +pass:[Shared secret of the CS3org WOPI server.] |`APP_PROVIDER_WOPI_WOPI_SERVER_EXTERNAL_URL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -External url of the CS3org WOPI server. +pass:[External url of the CS3org WOPI server.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/app-registry_configvars.adoc b/services/_includes/adoc/app-registry_configvars.adoc index 945631cd99b..b625aa7b8fd 100644 --- a/services/_includes/adoc/app-registry_configvars.adoc +++ b/services/_includes/adoc/app-registry_configvars.adoc @@ -11,122 +11,122 @@ `APP_REGISTRY_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `APP_REGISTRY_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `APP_REGISTRY_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `APP_REGISTRY_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `APP_REGISTRY_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `APP_REGISTRY_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `APP_REGISTRY_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `APP_REGISTRY_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`APP_REGISTRY_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9243 +pass:[127.0.0.1:9243] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`APP_REGISTRY_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`APP_REGISTRY_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`APP_REGISTRY_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`APP_REGISTRY_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9242 +pass:[127.0.0.1:9242] a| [subs=-attributes] -The bind address of the GRPC service. +pass:[The bind address of the GRPC service.] |`APP_REGISTRY_GRPC_PROTOCOL` | string a| [subs=-attributes] -tcp +pass:[tcp] a| [subs=-attributes] -The transport protocol of the grpc service. +pass:[The transport protocol of the grpc service.] |`OCIS_JWT_SECRET` + `APP_REGISTRY_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/audit_configvars.adoc b/services/_includes/adoc/audit_configvars.adoc index b3997a43b53..15d50167933 100644 --- a/services/_includes/adoc/audit_configvars.adoc +++ b/services/_includes/adoc/audit_configvars.adoc @@ -11,110 +11,110 @@ `AUDIT_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `AUDIT_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `AUDIT_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `AUDIT_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`AUDIT_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9234 +pass:[127.0.0.1:9234] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`AUDIT_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`AUDIT_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`AUDIT_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`AUDIT_EVENTS_ENDPOINT` | string a| [subs=-attributes] -127.0.0.1:9233 +pass:[127.0.0.1:9233] a| [subs=-attributes] -The address of the streaming service. +pass:[The address of the streaming service.] |`AUDIT_EVENTS_CLUSTER` | string a| [subs=-attributes] -ocis-cluster +pass:[ocis-cluster] a| [subs=-attributes] -The clusterID of the streaming service. Mandatory when using nats. +pass:[The clusterID of the streaming service. Mandatory when using nats.] |`AUDIT_EVENTS_GROUP` | string a| [subs=-attributes] -audit +pass:[audit] a| [subs=-attributes] -The consumergroup of the service. One group will only get one copy of an event. +pass:[The consumergroup of the service. One group will only get one copy of an event.] |`AUDIT_LOG_TO_CONSOLE` | bool a| [subs=-attributes] -true +pass:[true] a| [subs=-attributes] -Logs to Stdout if true. Independent of the log to file option. +pass:[Logs to Stdout if true. Independent of the log to file option.] |`AUDIT_LOG_TO_FILE` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Logs to file if true. Independent of the log to Stdout file option. +pass:[Logs to file if true. Independent of the log to Stdout file option.] |`AUDIT_FILEPATH` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Filepath to the logfile. Mandatory if LogToFile is true. +pass:[Filepath to the logfile. Mandatory if LogToFile is true.] |`AUDIT_FORMAT` | string a| [subs=-attributes] -json +pass:[json] a| [subs=-attributes] -Log format. using json is advised. +pass:[Log format. using json is advised.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/auth-basic_configvars.adoc b/services/_includes/adoc/auth-basic_configvars.adoc index 8f3aaef17b3..aaf5cad0090 100644 --- a/services/_includes/adoc/auth-basic_configvars.adoc +++ b/services/_includes/adoc/auth-basic_configvars.adoc @@ -11,408 +11,408 @@ `AUTH_BASIC_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `AUTH_BASIC_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `AUTH_BASIC_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `AUTH_BASIC_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `AUTH_BASIC_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `AUTH_BASIC_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `AUTH_BASIC_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `AUTH_BASIC_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`AUTH_BASIC_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9147 +pass:[127.0.0.1:9147] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`AUTH_BASIC_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`AUTH_BASIC_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`AUTH_BASIC_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing traces in-memory. +pass:[Enables zpages, which can be used for collecting and viewing traces in-memory.] |`AUTH_BASIC_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9146 +pass:[127.0.0.1:9146] a| [subs=-attributes] -The bind address of the GRPC service. +pass:[The bind address of the GRPC service.] |`AUTH_BASIC_GRPC_PROTOCOL` | string a| [subs=-attributes] -tcp +pass:[tcp] a| [subs=-attributes] -The transport protocol of the grpc service. +pass:[The transport protocol of the grpc service.] |`OCIS_JWT_SECRET` + `AUTH_BASIC_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`AUTH_BASIC_SKIP_USER_GROUPS_IN_TOKEN` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -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. +pass:[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.] |`AUTH_BASIC_AUTH_PROVIDER` | string a| [subs=-attributes] -ldap +pass:[ldap] a| [subs=-attributes] -The auth provider which should be used by the service (e.g. 'ldap'). +pass:[The auth provider which should be used by the service (e.g. 'ldap').] |`LDAP_URI` + `AUTH_BASIC_LDAP_URI` | string a| [subs=-attributes] -ldaps://localhost:9235 +pass:[ldaps://localhost:9235] a| [subs=-attributes] -URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://' +pass:[URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://'] |`LDAP_CACERT` + `AUTH_BASIC_LDAP_CACERT` | string a| [subs=-attributes] -~/.ocis/idm/ldap.crt +pass:[~/.ocis/idm/ldap.crt] a| [subs=-attributes] -Path to a CA certificate file for validating the LDAP server's TLS certificate. If empty the system default CA bundle will be used. +pass:[Path to a CA certificate file for validating the LDAP server's TLS certificate. If empty the system default CA bundle will be used.] |`LDAP_INSECURE` + `AUTH_BASIC_LDAP_INSECURE` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Disable TLS certificate validation for the LDAP connections. Do not set this in production environments. +pass:[Disable TLS certificate validation for the LDAP connections. Do not set this in production environments.] |`LDAP_BIND_DN` + `AUTH_BASIC_LDAP_BIND_DN` | string a| [subs=-attributes] -uid=reva,ou=sysusers,o=libregraph-idm +pass:[uid=reva,ou=sysusers,o=libregraph-idm] a| [subs=-attributes] -LDAP DN to use for simple bind authentication with the target LDAP server. +pass:[LDAP DN to use for simple bind authentication with the target LDAP server.] |`LDAP_BIND_PASSWORD` + `AUTH_BASIC_LDAP_BIND_PASSWORD` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Password to use for authenticating the 'bind_dn'. +pass:[Password to use for authenticating the 'bind_dn'.] |`LDAP_USER_BASE_DN` + `AUTH_BASIC_LDAP_USER_BASE_DN` | string a| [subs=-attributes] -ou=users,o=libregraph-idm +pass:[ou=users,o=libregraph-idm] a| [subs=-attributes] -Search base DN for looking up LDAP users. +pass:[Search base DN for looking up LDAP users.] |`LDAP_GROUP_BASE_DN` + `AUTH_BASIC_LDAP_GROUP_BASE_DN` | string a| [subs=-attributes] -ou=groups,o=libregraph-idm +pass:[ou=groups,o=libregraph-idm] a| [subs=-attributes] -Search base DN for looking up LDAP groups. +pass:[Search base DN for looking up LDAP groups.] |`LDAP_USER_SCOPE` + `AUTH_BASIC_LDAP_USER_SCOPE` | string a| [subs=-attributes] -sub +pass:[sub] a| [subs=-attributes] -LDAP search scope to use when looking up users ('base', 'one', 'sub'). +pass:[LDAP search scope to use when looking up users ('base', 'one', 'sub').] |`LDAP_GROUP_SCOPE` + `AUTH_BASIC_LDAP_GROUP_SCOPE` | string a| [subs=-attributes] -sub +pass:[sub] a| [subs=-attributes] -LDAP search scope to use when looking up gruops ('base', 'one', 'sub'). +pass:[LDAP search scope to use when looking up gruops ('base', 'one', 'sub').] |`LDAP_USER_FILTER` + `AUTH_BASIC_LDAP_USER_FILTER` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -LDAP filter to add to the default filters for user search (e.g. '(objectclass=ownCloud)'). +pass:[LDAP filter to add to the default filters for user search (e.g. '(objectclass=ownCloud)').] |`LDAP_GROUP_FILTER` + `AUTH_BASIC_LDAP_GROUP_FILTER` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -LDAP filter to add to the default filters for group searches. +pass:[LDAP filter to add to the default filters for group searches.] |`LDAP_USER_OBJECTCLASS` + `AUTH_BASIC_LDAP_USER_OBJECTCLASS` | string a| [subs=-attributes] -inetOrgPerson +pass:[inetOrgPerson] a| [subs=-attributes] -The object class to use for users in the default user search filter ('inetOrgPerson'). +pass:[The object class to use for users in the default user search filter ('inetOrgPerson').] |`LDAP_GROUP_OBJECTCLASS` + `AUTH_BASIC_LDAP_GROUP_OBJECTCLASS` | string a| [subs=-attributes] -groupOfNames +pass:[groupOfNames] a| [subs=-attributes] -The object class to use for groups in the default group search filter ('groupOfNames'). +pass:[The object class to use for groups in the default group search filter ('groupOfNames'). ] |`LDAP_LOGIN_ATTRIBUTES` + `AUTH_BASIC_LDAP_LOGIN_ATTRIBUTES` | a| [subs=-attributes] -[uid mail] +pass:[[uid mail]] a| [subs=-attributes] -The user object attributes, that can be used for login. +pass:[The user object attributes, that can be used for login.] |`OCIS_URL` + `OCIS_OIDC_ISSUER` + `AUTH_BASIC_IDP_URL` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. +pass:[The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider.] |`LDAP_USER_SCHEMA_ID` + `AUTH_BASIC_LDAP_USER_SCHEMA_ID` | string a| [subs=-attributes] -ownclouduuid +pass:[ownclouduuid] a| [subs=-attributes] -LDAP Attribute to use as the unique id for users. This should be a stable globally unique id (e.g. a UUID). +pass:[LDAP Attribute to use as the unique id for users. This should be a stable globally unique id (e.g. a UUID).] |`LDAP_USER_SCHEMA_ID_IS_OCTETSTRING` + `AUTH_BASIC_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -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. +pass:[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.] |`LDAP_USER_SCHEMA_MAIL` + `AUTH_BASIC_LDAP_USER_SCHEMA_MAIL` | string a| [subs=-attributes] -mail +pass:[mail] a| [subs=-attributes] -LDAP Attribute to use for the email address of users. +pass:[LDAP Attribute to use for the email address of users.] |`LDAP_USER_SCHEMA_DISPLAYNAME` + `AUTH_BASIC_LDAP_USER_SCHEMA_DISPLAYNAME` | string a| [subs=-attributes] -displayname +pass:[displayname] a| [subs=-attributes] -LDAP Attribute to use for the displayname of users. +pass:[LDAP Attribute to use for the displayname of users.] |`LDAP_USER_SCHEMA_USERNAME` + `AUTH_BASIC_LDAP_USER_SCHEMA_USERNAME` | string a| [subs=-attributes] -uid +pass:[uid] a| [subs=-attributes] -LDAP Attribute to use for username of users. +pass:[LDAP Attribute to use for username of users.] |`LDAP_GROUP_SCHEMA_ID` + `AUTH_BASIC_LDAP_GROUP_SCHEMA_ID` | string a| [subs=-attributes] -ownclouduuid +pass:[ownclouduuid] a| [subs=-attributes] -LDAP Attribute to use as the unique id for groups. This should be a stable globally unique id (e.g. a UUID). +pass:[LDAP Attribute to use as the unique id for groups. This should be a stable globally unique id (e.g. a UUID).] |`LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING` + `AUTH_BASIC_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -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. +pass:[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.] |`LDAP_GROUP_SCHEMA_MAIL` + `AUTH_BASIC_LDAP_GROUP_SCHEMA_MAIL` | string a| [subs=-attributes] -mail +pass:[mail] a| [subs=-attributes] -LDAP Attribute to use for the email address of groups (can be empty). +pass:[LDAP Attribute to use for the email address of groups (can be empty).] |`LDAP_GROUP_SCHEMA_DISPLAYNAME` + `AUTH_BASIC_LDAP_GROUP_SCHEMA_DISPLAYNAME` | string a| [subs=-attributes] -cn +pass:[cn] a| [subs=-attributes] -LDAP Attribute to use for the displayname of groups (often the same as groupname attribute) +pass:[LDAP Attribute to use for the displayname of groups (often the same as groupname attribute)] |`LDAP_GROUP_SCHEMA_GROUPNAME` + `AUTH_BASIC_LDAP_GROUP_SCHEMA_GROUPNAME` | string a| [subs=-attributes] -cn +pass:[cn] a| [subs=-attributes] -LDAP Attribute to use for the name of groups +pass:[LDAP Attribute to use for the name of groups] |`LDAP_GROUP_SCHEMA_MEMBER` + `AUTH_BASIC_LDAP_GROUP_SCHEMA_MEMBER` | string a| [subs=-attributes] -member +pass:[member] a| [subs=-attributes] -LDAP Attribute that is used for group members. +pass:[LDAP Attribute that is used for group members.] |`AUTH_BASIC_OWNCLOUDSQL_DB_USERNAME` | string a| [subs=-attributes] -owncloud +pass:[owncloud] a| [subs=-attributes] -Database user to use for authenticating with the owncloud database. +pass:[Database user to use for authenticating with the owncloud database.] |`AUTH_BASIC_OWNCLOUDSQL_DB_PASSWORD` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Password for the database user. +pass:[Password for the database user.] |`AUTH_BASIC_OWNCLOUDSQL_DB_HOST` | string a| [subs=-attributes] -mysql +pass:[mysql] a| [subs=-attributes] -Hostname of the database server. +pass:[Hostname of the database server.] |`AUTH_BASIC_OWNCLOUDSQL_DB_PORT` | int a| [subs=-attributes] -3306 +pass:[3306] a| [subs=-attributes] -Network port to use for the database connection. +pass:[Network port to use for the database connection.] |`AUTH_BASIC_OWNCLOUDSQL_DB_NAME` | string a| [subs=-attributes] -owncloud +pass:[owncloud] a| [subs=-attributes] -Name of the owncloud database. +pass:[Name of the owncloud database.] |`AUTH_BASIC_OWNCLOUDSQL_IDP` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. +pass:[The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider.] |`AUTH_BASIC_OWNCLOUDSQL_NOBODY` | int64 a| [subs=-attributes] -90 +pass:[90] a| [subs=-attributes] -Fallback number if no numeric UID and GID properties are provided. +pass:[Fallback number if no numeric UID and GID properties are provided.] |`AUTH_BASIC_OWNCLOUDSQL_JOIN_USERNAME` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Join the user properties table to read usernames +pass:[Join the user properties table to read usernames] |`AUTH_BASIC_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Join the user properties table to read user ids (boolean). +pass:[Join the user properties table to read user ids (boolean).] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/auth-bearer_configvars.adoc b/services/_includes/adoc/auth-bearer_configvars.adoc index a4e974ff7c1..1ebba96e3cd 100644 --- a/services/_includes/adoc/auth-bearer_configvars.adoc +++ b/services/_includes/adoc/auth-bearer_configvars.adoc @@ -11,167 +11,167 @@ `AUTH_BEARER_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `AUTH_BEARER_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `AUTH_BEARER_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `AUTH_BEARER_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `AUTH_BEARER_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `AUTH_BEARER_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `AUTH_BEARER_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `AUTH_BEARER_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`AUTH_BEARER_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9149 +pass:[127.0.0.1:9149] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`AUTH_BEARER_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`AUTH_BEARER_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`AUTH_BEARER_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`AUTH_BEARER_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9148 +pass:[127.0.0.1:9148] a| [subs=-attributes] -The bind address of the GRPC service. +pass:[The bind address of the GRPC service.] |`AUTH_BEARER_GRPC_PROTOCOL` | string a| [subs=-attributes] -tcp +pass:[tcp] a| [subs=-attributes] -The transport protocol of the grpc service. +pass:[The transport protocol of the grpc service.] |`OCIS_JWT_SECRET` + `AUTH_BEARER_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`AUTH_BEARER_SKIP_USER_GROUPS_IN_TOKEN` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_URL` + `OCIS_OIDC_ISSUER` + `AUTH_BEARER_OIDC_ISSUER` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -URL of the OIDC issuer. It defaults to URL of the builtin IDP. +pass:[URL of the OIDC issuer. It defaults to URL of the builtin IDP.] |`OCIS_INSECURE` + `AUTH_BEARER_OIDC_INSECURE` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Allow insecure connections to the OIDC issuer. +pass:[Allow insecure connections to the OIDC issuer.] |`AUTH_BEARER_OIDC_ID_CLAIM` | string a| [subs=-attributes] -preferred_username +pass:[preferred_username] a| [subs=-attributes] -Name of the claim, which holds the user identifier. +pass:[Name of the claim, which holds the user identifier.] |`AUTH_BEARER_OIDC_UID_CLAIM` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Name of the claim, which holds the UID. +pass:[Name of the claim, which holds the UID.] |`AUTH_BEARER_OIDC_GID_CLAIM` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Name of the claim, which holds the GID. +pass:[Name of the claim, which holds the GID.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/auth-machine_configvars.adoc b/services/_includes/adoc/auth-machine_configvars.adoc index 4a2b7701629..646988fa788 100644 --- a/services/_includes/adoc/auth-machine_configvars.adoc +++ b/services/_includes/adoc/auth-machine_configvars.adoc @@ -11,137 +11,137 @@ `AUTH_MACHINE_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `AUTH_MACHINE_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `AUTH_MACHINE_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `AUTH_MACHINE_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `AUTH_MACHINE_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `AUTH_MACHINE_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `AUTH_MACHINE_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `AUTH_MACHINE_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`AUTH_MACHINE_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9167 +pass:[127.0.0.1:9167] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`AUTH_MACHINE_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`AUTH_MACHINE_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`AUTH_MACHINE_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`AUTH_MACHINE_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9166 +pass:[127.0.0.1:9166] a| [subs=-attributes] -The bind address of the GRPC service. +pass:[The bind address of the GRPC service.] |`AUTH_MACHINE_GRPC_PROTOCOL` | string a| [subs=-attributes] -tcp +pass:[tcp] a| [subs=-attributes] -The transport protocol of the grpc service. +pass:[The transport protocol of the grpc service.] |`OCIS_JWT_SECRET` + `AUTH_MACHINE_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`AUTH_MACHINE_SKIP_USER_GROUPS_IN_TOKEN` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_MACHINE_AUTH_API_KEY` + `AUTH_MACHINE_API_KEY` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Machine auth API key used to validate internal requests necessary for the access to resources from other services. +pass:[Machine auth API key used to validate internal requests necessary for the access to resources from other services.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/frontend_configvars.adoc b/services/_includes/adoc/frontend_configvars.adoc index 5efdf4a873a..34e24c6ae88 100644 --- a/services/_includes/adoc/frontend_configvars.adoc +++ b/services/_includes/adoc/frontend_configvars.adoc @@ -11,294 +11,294 @@ `FRONTEND_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `FRONTEND_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `FRONTEND_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `FRONTEND_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `FRONTEND_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `FRONTEND_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `FRONTEND_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `FRONTEND_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`FRONTEND_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9141 +pass:[127.0.0.1:9141] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`FRONTEND_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`FRONTEND_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`FRONTEND_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`FRONTEND_HTTP_ADDR` | string a| [subs=-attributes] -127.0.0.1:9140 +pass:[127.0.0.1:9140] a| [subs=-attributes] -The bind address of the HTTP service. +pass:[The bind address of the HTTP service.] |`FRONTEND_HTTP_PROTOCOL` | string a| [subs=-attributes] -tcp +pass:[tcp] a| [subs=-attributes] -The transport protocol of the http service. +pass:[The transport protocol of the http service.] |`FRONTEND_HTTP_PREFIX` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The Path prefix where the frontend can be accessed (defaults to /). +pass:[The Path prefix where the frontend can be accessed (defaults to /).] |`STORAGE_TRANSFER_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Transfer secret for signing file up- and download requests. +pass:[Transfer secret for signing file up- and download requests.] |`OCIS_JWT_SECRET` + `FRONTEND_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`OCIS_MACHINE_AUTH_API_KEY` + `FRONTEND_MACHINE_AUTH_API_KEY` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Machine auth API key used to validate internal requests necessary for the access to resources from other services. +pass:[Machine auth API key used to validate internal requests necessary for the access to resources from other services.] |`FRONTEND_SKIP_USER_GROUPS_IN_TOKEN` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Disables the loading of user's group memberships from the reva access token. +pass:[Disables the loading of user's group memberships from the reva access token.] |`FRONTEND_ENABLE_FAVORITES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables the support for favorites in the frontend. +pass:[Enables the support for favorites in the frontend.] |`FRONTEND_ENABLE_PROJECT_SPACES` | bool a| [subs=-attributes] -true +pass:[true] a| [subs=-attributes] -Indicates to clients that project spaces are supposed to be made available. +pass:[Indicates to clients that project spaces are supposed to be made available.] |`FRONTEND_ENABLE_SHARE_JAIL` | bool a| [subs=-attributes] -true +pass:[true] a| [subs=-attributes] -Indicates to clients that the share jail is supposed to be used. +pass:[Indicates to clients that the share jail is supposed to be used.] |`FRONTEND_UPLOAD_MAX_CHUNK_SIZE` | int a| [subs=-attributes] -100000000 +pass:[100000000] a| [subs=-attributes] -Sets the max chunk sizes for uploads via the frontend. +pass:[Sets the max chunk sizes for uploads via the frontend.] |`FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Advise TUS to replace PATCH requests by POST requests. +pass:[Advise TUS to replace PATCH requests by POST requests.] |`FRONTEND_DEFAULT_UPLOAD_PROTOCOL` | string a| [subs=-attributes] -tus +pass:[tus] a| [subs=-attributes] -The default upload protocol to use in the frontend (e.g. tus). +pass:[The default upload protocol to use in the frontend (e.g. tus).] |`FRONTEND_ENABLE_RESHARING` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables the support for resharing in the frontend. +pass:[Enables the support for resharing in the frontend.] |`OCIS_URL` + `FRONTEND_PUBLIC_URL` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -The public facing url of the ocis frontend. +pass:[The public facing url of the ocis frontend.] |`OCIS_INSECURE` + `FRONTEND_APP_HANDLER_INSECURE` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Allow insecure connections to the frontend. +pass:[Allow insecure connections to the frontend.] |`FRONTEND_ARCHIVER_MAX_NUM_FILES` | int64 a| [subs=-attributes] -10000 +pass:[10000] a| [subs=-attributes] -Max number of files that can be packed into an archive. +pass:[Max number of files that can be packed into an archive.] |`FRONTEND_ARCHIVER_MAX_SIZE` | int64 a| [subs=-attributes] -1073741824 +pass:[1073741824] a| [subs=-attributes] -Max size of the zip archive the archiver can create. +pass:[Max size of the zip archive the archiver can create.] |`OCIS_INSECURE` + `FRONTEND_ARCHIVER_INSECURE` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Allow insecure connections to the archiver. +pass:[Allow insecure connections to the archiver.] |`FRONTEND_DATA_GATEWAY_PREFIX` | string a| [subs=-attributes] -data +pass:[data] a| [subs=-attributes] - +pass:[] |`FRONTEND_OCS_PREFIX` | string a| [subs=-attributes] -ocs +pass:[ocs] a| [subs=-attributes] -Path prefix for the ocs service +pass:[Path prefix for the ocs service] |`FRONTEND_OCS_SHARE_PREFIX` | string a| [subs=-attributes] -/Shares +pass:[/Shares] a| [subs=-attributes] -Path prefix for shares. +pass:[Path prefix for shares.] |`FRONTEND_OCS_HOME_NAMESPACE` | string a| [subs=-attributes] -/users/{{.Id.OpaqueId}} +pass:[/users/{{.Id.OpaqueId}}] a| [subs=-attributes] -Homespace namespace identifier. +pass:[Homespace namespace identifier.] |`FRONTEND_OCS_ADDITIONAL_INFO_ATTRIBUTE` | string a| [subs=-attributes] -{{.Mail}} +pass:[{{.Mail}}] a| [subs=-attributes] -Additional information attribute for the user (e.g. {{.Mail}} +pass:[Additional information attribute for the user (e.g. {{.Mail}}] |`FRONTEND_OCS_RESOURCE_INFO_CACHE_TTL` | int a| [subs=-attributes] -0 +pass:[0] a| [subs=-attributes] -Max TTL for the resource info cache +pass:[Max TTL for the resource info cache] |`FRONTEND_CHECKSUMS_SUPPORTED_TYPES` | a| [subs=-attributes] -[sha1 md5 adler32] +pass:[[sha1 md5 adler32]] a| [subs=-attributes] -Supported checksum types to be announced to the client (e.g. md5) +pass:[Supported checksum types to be announced to the client (e.g. md5)] |`FRONTEND_CHECKSUMS_PREFERRED_UPLOAD_TYPES` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Preferred checksum types to be announced to the client for uploads (e.g. md5) +pass:[Preferred checksum types to be announced to the client for uploads (e.g. md5)] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/gateway_configvars.adoc b/services/_includes/adoc/gateway_configvars.adoc index fc20d9c0b34..c01ba9f71bc 100644 --- a/services/_includes/adoc/gateway_configvars.adoc +++ b/services/_includes/adoc/gateway_configvars.adoc @@ -11,256 +11,256 @@ `GATEWAY_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `GATEWAY_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `GATEWAY_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `GATEWAY_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `GATEWAY_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `GATEWAY_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `GATEWAY_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `GATEWAY_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`GATEWAY_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9143 +pass:[127.0.0.1:9143] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`GATEWAY_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`GATEWAY_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`GATEWAY_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`GATEWAY_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The bind address of the GRPC service. +pass:[The bind address of the GRPC service.] |`GATEWAY_GRPC_PROTOCOL` | string a| [subs=-attributes] -tcp +pass:[tcp] a| [subs=-attributes] -The transport protocol of the grpc service. +pass:[The transport protocol of the grpc service.] |`OCIS_JWT_SECRET` + `GATEWAY_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`GATEWAY_SKIP_USER_GROUPS_IN_TOKEN` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Disables the loading of user's group memberships from the reva access token. +pass:[Disables the loading of user's group memberships from the reva access token.] |`GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT` | bool a| [subs=-attributes] -true +pass:[true] a| [subs=-attributes] -Commit shares to storage grants. This grants access to shared resources for the share receiver directly on the storage. +pass:[Commit shares to storage grants. This grants access to shared resources for the share receiver directly on the storage.] |`GATEWAY_SHARE_FOLDER_NAME` | string a| [subs=-attributes] -Shares +pass:[Shares] a| [subs=-attributes] -Name of the share folder in users' home space. +pass:[Name of the share folder in users' home space.] |`GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN` | bool a| [subs=-attributes] -true +pass:[true] a| [subs=-attributes] -Disable creation of the home space on login. +pass:[Disable creation of the home space on login.] |`STORAGE_TRANSFER_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The storage transfer secret +pass:[The storage transfer secret] |`GATEWAY_TRANSFER_EXPIRES` | int a| [subs=-attributes] -86400 +pass:[86400] a| [subs=-attributes] -Expiry for the gateway tokens +pass:[Expiry for the gateway tokens] |`GATEWAY_ETAG_CACHE_TTL` | int a| [subs=-attributes] -0 +pass:[0] a| [subs=-attributes] -Max TTL in seconds for the gateway's ETAG cache. +pass:[Max TTL in seconds for the gateway's ETAG cache.] |`OCIS_URL` + `GATEWAY_FRONTEND_PUBLIC_URL` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -The public facing url of the ocis frontend. +pass:[The public facing url of the ocis frontend.] |`GATEWAY_USERS_ENDPOINT` | string a| [subs=-attributes] -localhost:9144 +pass:[localhost:9144] a| [subs=-attributes] -The users api endpoint. +pass:[The users api endpoint.] |`GATEWAY_GROUPS_ENDPOINT` | string a| [subs=-attributes] -localhost:9160 +pass:[localhost:9160] a| [subs=-attributes] -The groups api endpoint. +pass:[The groups api endpoint.] |`GATEWAY_PERMISSIONS_ENDPOINT` | string a| [subs=-attributes] -localhost:9191 +pass:[localhost:9191] a| [subs=-attributes] -The permission api endpoint. +pass:[The permission api endpoint.] |`GATEWAY_SHARING_ENDPOINT` | string a| [subs=-attributes] -localhost:9150 +pass:[localhost:9150] a| [subs=-attributes] -The share api endpoint. +pass:[The share api endpoint.] |`GATEWAY_AUTH_BASIC_ENDPOINT` | string a| [subs=-attributes] -localhost:9146 +pass:[localhost:9146] a| [subs=-attributes] -The auth basic api endpoint. +pass:[The auth basic api endpoint.] |`GATEWAY_AUTH_BEARER_ENDPOINT` | string a| [subs=-attributes] -localhost:9148 +pass:[localhost:9148] a| [subs=-attributes] -The auth bearer api endpoint. +pass:[The auth bearer api endpoint.] |`GATEWAY_AUTH_MACHINE_ENDPOINT` | string a| [subs=-attributes] -localhost:9166 +pass:[localhost:9166] a| [subs=-attributes] -The auth machine api endpoint. +pass:[The auth machine api endpoint.] |`GATEWAY_STORAGE_PUBLIC_LINK_ENDPOINT` | string a| [subs=-attributes] -localhost:9178 +pass:[localhost:9178] a| [subs=-attributes] -The storage puliclink api endpoint. +pass:[The storage puliclink api endpoint.] |`GATEWAY_STORAGE_USERS_ENDPOINT` | string a| [subs=-attributes] -localhost:9157 +pass:[localhost:9157] a| [subs=-attributes] -The storage users api endpoint. +pass:[The storage users api endpoint.] |`GATEWAY_STORAGE_SHARES_ENDPOINT` | string a| [subs=-attributes] -localhost:9154 +pass:[localhost:9154] a| [subs=-attributes] -The storage shares api endpoint. +pass:[The storage shares api endpoint.] |`GATEWAY_APP_REGISTRY_ENDPOINT` | string a| [subs=-attributes] -localhost:9242 +pass:[localhost:9242] a| [subs=-attributes] -The app registry api endpoint. +pass:[The app registry api endpoint.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/graph-explorer_configvars.adoc b/services/_includes/adoc/graph-explorer_configvars.adoc index e77b48feee1..f91ead27620 100644 --- a/services/_includes/adoc/graph-explorer_configvars.adoc +++ b/services/_includes/adoc/graph-explorer_configvars.adoc @@ -11,138 +11,138 @@ `GRAPH_EXPLORER_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `GRAPH_EXPLORER_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `GRAPH_EXPLORER_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `GRAPH_EXPLORER_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `GRAPH_EXPLORER_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `GRAPH_EXPLORER_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `GRAPH_EXPLORER_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `GRAPH_EXPLORER_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`GRAPH_EXPLORER_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9136 +pass:[127.0.0.1:9136] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`GRAPH_EXPLORER_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`GRAPH_EXPLORER_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`GRAPH_EXPLORER_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`GRAPH_EXPLORER_HTTP_ADDR` | string a| [subs=-attributes] -127.0.0.1:9135 +pass:[127.0.0.1:9135] a| [subs=-attributes] -The bind address of the HTTP service. +pass:[The bind address of the HTTP service.] |`GRAPH_EXPLORER_HTTP_ROOT` | string a| [subs=-attributes] -/graph-explorer +pass:[/graph-explorer] a| [subs=-attributes] -Subdirectory that serves as the root for this HTTP service. +pass:[Subdirectory that serves as the root for this HTTP service.] |`GRAPH_EXPLORER_CLIENT_ID` | string a| [subs=-attributes] -ocis-explorer.js +pass:[ocis-explorer.js] a| [subs=-attributes] -OIDC client id, the graph explorer uses. This client needs to be set up in your IDP. +pass:[OIDC client id, the graph explorer uses. This client needs to be set up in your IDP.] |`OCIS_URL` + `OCIS_OIDC_ISSUER` + `GRAPH_EXPLORER_ISSUER` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -URL of the OIDC issuer. It defaults to URL of the builtin IDP. +pass:[URL of the OIDC issuer. It defaults to URL of the builtin IDP.] |`OCIS_URL` + `GRAPH_EXPLORER_GRAPH_URL_BASE` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -Base URL, where the graph explorer is reachable for users. +pass:[Base URL, where the graph explorer is reachable for users.] |`GRAPH_EXPLORER_GRAPH_URL_PATH` | string a| [subs=-attributes] -/graph +pass:[/graph] a| [subs=-attributes] -URL path, where the graph explorer is reachable for users. +pass:[URL path, where the graph explorer is reachable for users.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/graph_configvars.adoc b/services/_includes/adoc/graph_configvars.adoc index 9a5dca5bdcc..b23e76c3351 100644 --- a/services/_includes/adoc/graph_configvars.adoc +++ b/services/_includes/adoc/graph_configvars.adoc @@ -11,353 +11,353 @@ `GRAPH_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `GRAPH_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `GRAPH_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `GRAPH_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `GRAPH_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `GRAPH_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `GRAPH_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `GRAPH_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`GRAPH_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9124 +pass:[127.0.0.1:9124] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`GRAPH_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`GRAPH_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`GRAPH_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`GRAPH_HTTP_ADDR` | string a| [subs=-attributes] -127.0.0.1:9120 +pass:[127.0.0.1:9120] a| [subs=-attributes] -The bind address of the HTTP service. +pass:[The bind address of the HTTP service.] |`GRAPH_HTTP_ROOT` | string a| [subs=-attributes] -/graph +pass:[/graph] a| [subs=-attributes] -Subdirectory that serves as the root for this HTTP service. +pass:[Subdirectory that serves as the root for this HTTP service.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`OCIS_JWT_SECRET` + `GRAPH_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`OCIS_URL` + `GRAPH_SPACES_WEBDAV_BASE` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -The public facing URL of WebDAV. +pass:[The public facing URL of WebDAV.] |`GRAPH_SPACES_WEBDAV_PATH` | string a| [subs=-attributes] -/dav/spaces/ +pass:[/dav/spaces/] a| [subs=-attributes] -The WebDAV subpath for spaces. +pass:[The WebDAV subpath for spaces.] |`GRAPH_SPACES_DEFAULT_QUOTA` | string a| [subs=-attributes] -1000000000 +pass:[1000000000] a| [subs=-attributes] -The default quota in bytes. +pass:[The default quota in bytes.] |`OCIS_INSECURE` + `GRAPH_SPACES_INSECURE` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Allow insecure connetctions to the spaces. +pass:[Allow insecure connetctions to the spaces.] |`GRAPH_SPACES_EXTENDED_SPACE_PROPERTIES_CACHE_TTL` | int a| [subs=-attributes] -0 +pass:[0] a| [subs=-attributes] -Max TTL for the spaces property cache. +pass:[Max TTL for the spaces property cache.] |`GRAPH_IDENTITY_BACKEND` | string a| [subs=-attributes] -ldap +pass:[ldap] a| [subs=-attributes] -The user identity backend to use, defaults to 'ldap', can be 'cs3'. +pass:[The user identity backend to use, defaults to 'ldap', can be 'cs3'.] |`LDAP_URI` + `GRAPH_LDAP_URI` | string a| [subs=-attributes] -ldaps://localhost:9235 +pass:[ldaps://localhost:9235] a| [subs=-attributes] -URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://' +pass:[URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://'] |`LDAP_CACERT` + `GRAPH_LDAP_CACERT` | string a| [subs=-attributes] -~/.ocis/idm/ldap.crt +pass:[~/.ocis/idm/ldap.crt] a| [subs=-attributes] -The certificate to verify TLS connections +pass:[The certificate to verify TLS connections] |`LDAP_INSECURE` + `GRAPH_LDAP_INSECURE` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Disable TLS certificate validation for the LDAP connections. Do not set this in production environments. +pass:[Disable TLS certificate validation for the LDAP connections. Do not set this in production environments.] |`LDAP_BIND_DN` + `GRAPH_LDAP_BIND_DN` | string a| [subs=-attributes] -uid=libregraph,ou=sysusers,o=libregraph-idm +pass:[uid=libregraph,ou=sysusers,o=libregraph-idm] a| [subs=-attributes] -LDAP DN to use for simple bind authentication with the target LDAP server. +pass:[LDAP DN to use for simple bind authentication with the target LDAP server.] |`LDAP_BIND_PASSWORD` + `GRAPH_LDAP_BIND_PASSWORD` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Password to use for authenticating the 'bind_dn'. +pass:[Password to use for authenticating the 'bind_dn'.] |`GRAPH_LDAP_SERVER_UUID` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -If set to true, rely on the LDAP Server to generate a unique ID for users and groups, e.g. when using 'entryUUID' as the user id attribute. +pass:[If set to true, rely on the LDAP Server to generate a unique ID for users and groups, e.g. when using 'entryUUID' as the user id attribute.] |`GRAPH_LDAP_SERVER_USE_PASSWORD_MODIFY_EXOP` | bool a| [subs=-attributes] -true +pass:[true] a| [subs=-attributes] -User the Password Modify Extended Operation for updating user passwords +pass:[User the Password Modify Extended Operation for updating user passwords] |`GRAPH_LDAP_SERVER_WRITE_ENABLED` | bool a| [subs=-attributes] -true +pass:[true] a| [subs=-attributes] -Allow to create, modify and delete LDAP users via graph API. This is only works when the default Schema is used. +pass:[Allow to create, modify and delete LDAP users via graph API. This is only works when the default Schema is used.] |`LDAP_USER_BASE_DN` + `GRAPH_LDAP_USER_BASE_DN` | string a| [subs=-attributes] -ou=users,o=libregraph-idm +pass:[ou=users,o=libregraph-idm] a| [subs=-attributes] -Search base DN for looking up LDAP users. +pass:[Search base DN for looking up LDAP users.] |`LDAP_USER_SCOPE` + `GRAPH_LDAP_USER_SCOPE` | string a| [subs=-attributes] -sub +pass:[sub] a| [subs=-attributes] -LDAP search scope to use when looking up users ('base', 'one', 'sub'). +pass:[LDAP search scope to use when looking up users ('base', 'one', 'sub').] |`LDAP_USER_FILTER` + `GRAPH_LDAP_USER_FILTER` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -LDAP filter to add to the default filters for user search (e.g. '(objectclass=ownCloud)'). +pass:[LDAP filter to add to the default filters for user search (e.g. '(objectclass=ownCloud)').] |`LDAP_USER_OBJECTCLASS` + `GRAPH_LDAP_USER_OBJECTCLASS` | string a| [subs=-attributes] -inetOrgPerson +pass:[inetOrgPerson] a| [subs=-attributes] -The object class to use for users in the default user search filter ('inetOrgPerson'). +pass:[The object class to use for users in the default user search filter ('inetOrgPerson').] |`LDAP_USER_SCHEMA_MAIL` + `GRAPH_LDAP_USER_EMAIL_ATTRIBUTE` | string a| [subs=-attributes] -mail +pass:[mail] a| [subs=-attributes] -LDAP Attribute to use for the email address of users. +pass:[LDAP Attribute to use for the email address of users.] |`LDAP_USER_SCHEMA_DISPLAY_NAME` + `GRAPH_LDAP_USER_DISPLAYNAME_ATTRIBUTE` | string a| [subs=-attributes] -displayName +pass:[displayName] a| [subs=-attributes] -LDAP Attribute to use for the displayname of users. +pass:[LDAP Attribute to use for the displayname of users.] |`LDAP_USER_SCHEMA_USERNAME` + `GRAPH_LDAP_USER_NAME_ATTRIBUTE` | string a| [subs=-attributes] -uid +pass:[uid] a| [subs=-attributes] -LDAP Attribute to use for username of users. +pass:[LDAP Attribute to use for username of users.] |`LDAP_USER_SCHEMA_ID` + `GRAPH_LDAP_USER_UID_ATTRIBUTE` | string a| [subs=-attributes] -owncloudUUID +pass:[owncloudUUID] a| [subs=-attributes] -LDAP Attribute to use as the unique id for users. This should be a stable globally unique id (e.g. a UUID). +pass:[LDAP Attribute to use as the unique id for users. This should be a stable globally unique id (e.g. a UUID).] |`LDAP_GROUP_BASE_DN` + `GRAPH_LDAP_GROUP_BASE_DN` | string a| [subs=-attributes] -ou=groups,o=libregraph-idm +pass:[ou=groups,o=libregraph-idm] a| [subs=-attributes] -Search base DN for looking up LDAP groups. +pass:[Search base DN for looking up LDAP groups.] |`LDAP_GROUP_SCOPE` + `GRAPH_LDAP_GROUP_SEARCH_SCOPE` | string a| [subs=-attributes] -sub +pass:[sub] a| [subs=-attributes] -LDAP search scope to use when looking up gruops ('base', 'one', 'sub'). +pass:[LDAP search scope to use when looking up gruops ('base', 'one', 'sub').] |`LDAP_GROUP_FILTER` + `GRAPH_LDAP_GROUP_FILTER` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -LDAP filter to add to the default filters for group searches. +pass:[LDAP filter to add to the default filters for group searches.] |`LDAP_GROUP_OBJECTCLASS` + `GRAPH_LDAP_GROUP_OBJECTCLASS` | string a| [subs=-attributes] -groupOfNames +pass:[groupOfNames] a| [subs=-attributes] -The object class to use for groups in the default group search filter ('groupOfNames'). +pass:[The object class to use for groups in the default group search filter ('groupOfNames'). ] |`LDAP_GROUP_SCHEMA_GROUPNAME` + `GRAPH_LDAP_GROUP_NAME_ATTRIBUTE` | string a| [subs=-attributes] -cn +pass:[cn] a| [subs=-attributes] -LDAP Attribute to use for the name of groups +pass:[LDAP Attribute to use for the name of groups] |`LDAP_GROUP_SCHEMA_ID` + `GRAPH_LDAP_GROUP_ID_ATTRIBUTE` | string a| [subs=-attributes] -owncloudUUID +pass:[owncloudUUID] a| [subs=-attributes] -LDAP Attribute to use as the unique id for groups. This should be a stable globally unique id (e.g. a UUID). +pass:[LDAP Attribute to use as the unique id for groups. This should be a stable globally unique id (e.g. a UUID).] |`GRAPH_EVENTS_ENDPOINT` | string a| [subs=-attributes] -127.0.0.1:9233 +pass:[127.0.0.1:9233] a| [subs=-attributes] -the address of the streaming service +pass:[the address of the streaming service] |`GRAPH_EVENTS_CLUSTER` | string a| [subs=-attributes] -ocis-cluster +pass:[ocis-cluster] a| [subs=-attributes] -the clusterID of the streaming service. Mandatory when using nats +pass:[the clusterID of the streaming service. Mandatory when using nats] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/groups_configvars.adoc b/services/_includes/adoc/groups_configvars.adoc index 75e7772c4df..33ba46e99d3 100644 --- a/services/_includes/adoc/groups_configvars.adoc +++ b/services/_includes/adoc/groups_configvars.adoc @@ -11,400 +11,400 @@ `GROUPS_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `GROUPS_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `GROUPS_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `GROUPS_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `GROUPS_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `GROUPS_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `GROUPS_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `GROUPS_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`GROUPS_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9161 +pass:[127.0.0.1:9161] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`GROUPS_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`GROUPS_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`GROUPS_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`GROUPS_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9160 +pass:[127.0.0.1:9160] a| [subs=-attributes] -The bind address of the GRPC service. +pass:[The bind address of the GRPC service.] |`GROUPS_GRPC_PROTOCOL` | string a| [subs=-attributes] -tcp +pass:[tcp] a| [subs=-attributes] -The transport protocol of the grpc service. +pass:[The transport protocol of the grpc service.] |`OCIS_JWT_SECRET` + `GROUPS_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`GROUPS_SKIP_USER_GROUPS_IN_TOKEN` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Disables the loading of user's group memberships from the reva access token. +pass:[Disables the loading of user's group memberships from the reva access token.] |`LDAP_URI` + `GROUPS_LDAP_URI` | string a| [subs=-attributes] -ldaps://localhost:9235 +pass:[ldaps://localhost:9235] a| [subs=-attributes] -URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://' +pass:[URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://'] |`LDAP_CACERT` + `GROUPS_LDAP_CACERT` | string a| [subs=-attributes] -~/.ocis/idm/ldap.crt +pass:[~/.ocis/idm/ldap.crt] a| [subs=-attributes] -Path to a CA certificate file for validating the LDAP server's TLS certificate. If empty the system default CA bundle will be used. +pass:[Path to a CA certificate file for validating the LDAP server's TLS certificate. If empty the system default CA bundle will be used.] |`LDAP_INSECURE` + `GROUPS_LDAP_INSECURE` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Disable TLS certificate validation for the LDAP connections. Do not set this in production environments. +pass:[Disable TLS certificate validation for the LDAP connections. Do not set this in production environments.] |`LDAP_BIND_DN` + `GROUPS_LDAP_BIND_DN` | string a| [subs=-attributes] -uid=reva,ou=sysusers,o=libregraph-idm +pass:[uid=reva,ou=sysusers,o=libregraph-idm] a| [subs=-attributes] -LDAP DN to use for simple bind authentication with the target LDAP server. +pass:[LDAP DN to use for simple bind authentication with the target LDAP server.] |`LDAP_BIND_PASSWORD` + `GROUPS_LDAP_BIND_PASSWORD` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Password to use for authenticating the 'bind_dn'. +pass:[Password to use for authenticating the 'bind_dn'.] |`LDAP_USER_BASE_DN` + `GROUPS_LDAP_USER_BASE_DN` | string a| [subs=-attributes] -ou=users,o=libregraph-idm +pass:[ou=users,o=libregraph-idm] a| [subs=-attributes] -Search base DN for looking up LDAP users. +pass:[Search base DN for looking up LDAP users.] |`LDAP_GROUP_BASE_DN` + `GROUPS_LDAP_GROUP_BASE_DN` | string a| [subs=-attributes] -ou=groups,o=libregraph-idm +pass:[ou=groups,o=libregraph-idm] a| [subs=-attributes] -Search base DN for looking up LDAP groups. +pass:[Search base DN for looking up LDAP groups.] |`LDAP_USER_SCOPE` + `GROUPS_LDAP_USER_SCOPE` | string a| [subs=-attributes] -sub +pass:[sub] a| [subs=-attributes] -LDAP search scope to use when looking up users ('base', 'one', 'sub'). +pass:[LDAP search scope to use when looking up users ('base', 'one', 'sub').] |`LDAP_GROUP_SCOPE` + `GROUPS_LDAP_GROUP_SCOPE` | string a| [subs=-attributes] -sub +pass:[sub] a| [subs=-attributes] -LDAP search scope to use when looking up gruops ('base', 'one', 'sub'). +pass:[LDAP search scope to use when looking up gruops ('base', 'one', 'sub').] |`LDAP_USER_FILTER` + `GROUPS_LDAP_USER_FILTER` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -LDAP filter to add to the default filters for user search (e.g. '(objectclass=ownCloud)'). +pass:[LDAP filter to add to the default filters for user search (e.g. '(objectclass=ownCloud)').] |`LDAP_GROUP_FILTER` + `GROUPS_LDAP_GROUP_FILTER` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -LDAP filter to add to the default filters for group searches. +pass:[LDAP filter to add to the default filters for group searches.] |`LDAP_USER_OBJECTCLASS` + `GROUPS_LDAP_USER_OBJECTCLASS` | string a| [subs=-attributes] -inetOrgPerson +pass:[inetOrgPerson] a| [subs=-attributes] -The object class to use for users in the default user search filter ('inetOrgPerson'). +pass:[The object class to use for users in the default user search filter ('inetOrgPerson').] |`LDAP_GROUP_OBJECTCLASS` + `GROUPS_LDAP_GROUP_OBJECTCLASS` | string a| [subs=-attributes] -groupOfNames +pass:[groupOfNames] a| [subs=-attributes] -The object class to use for groups in the default group search filter ('groupOfNames'). +pass:[The object class to use for groups in the default group search filter ('groupOfNames').] |`OCIS_URL` + `OCIS_OIDC_ISSUER` + `GROUPS_IDP_URL` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -The identity provider value to set in the groupids of the CS3 group objects for groups returned by this group provider. +pass:[The identity provider value to set in the groupids of the CS3 group objects for groups returned by this group provider.] |`LDAP_USER_SCHEMA_ID` + `GROUPS_LDAP_USER_SCHEMA_ID` | string a| [subs=-attributes] -ownclouduuid +pass:[ownclouduuid] a| [subs=-attributes] -LDAP Attribute to use as the unique id for users. This should be a stable globally unique id (e.g. a UUID). +pass:[LDAP Attribute to use as the unique id for users. This should be a stable globally unique id (e.g. a UUID).] |`LDAP_USER_SCHEMA_ID_IS_OCTETSTRING` + `GROUPS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -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. +pass:[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.] |`LDAP_USER_SCHEMA_MAIL` + `GROUPS_LDAP_USER_SCHEMA_MAIL` | string a| [subs=-attributes] -mail +pass:[mail] a| [subs=-attributes] -LDAP Attribute to use for the email address of users. +pass:[LDAP Attribute to use for the email address of users.] |`LDAP_USER_SCHEMA_DISPLAYNAME` + `GROUPS_LDAP_USER_SCHEMA_DISPLAYNAME` | string a| [subs=-attributes] -displayname +pass:[displayname] a| [subs=-attributes] -LDAP Attribute to use for the displayname of users. +pass:[LDAP Attribute to use for the displayname of users.] |`LDAP_USER_SCHEMA_USERNAME` + `GROUPS_LDAP_USER_SCHEMA_USERNAME` | string a| [subs=-attributes] -uid +pass:[uid] a| [subs=-attributes] -LDAP Attribute to use for username of users. +pass:[LDAP Attribute to use for username of users.] |`LDAP_GROUP_SCHEMA_ID` + `GROUPS_LDAP_GROUP_SCHEMA_ID` | string a| [subs=-attributes] -ownclouduuid +pass:[ownclouduuid] a| [subs=-attributes] -LDAP Attribute to use as the unique id for groups. This should be a stable globally unique id (e.g. a UUID). +pass:[LDAP Attribute to use as the unique id for groups. This should be a stable globally unique id (e.g. a UUID).] |`LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING` + `GROUPS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -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. +pass:[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.] |`LDAP_GROUP_SCHEMA_MAIL` + `GROUPS_LDAP_GROUP_SCHEMA_MAIL` | string a| [subs=-attributes] -mail +pass:[mail] a| [subs=-attributes] -LDAP Attribute to use for the email address of groups (can be empty). +pass:[LDAP Attribute to use for the email address of groups (can be empty).] |`LDAP_GROUP_SCHEMA_DISPLAYNAME` + `GROUPS_LDAP_GROUP_SCHEMA_DISPLAYNAME` | string a| [subs=-attributes] -cn +pass:[cn] a| [subs=-attributes] -LDAP Attribute to use for the displayname of groups (often the same as groupname attribute) +pass:[LDAP Attribute to use for the displayname of groups (often the same as groupname attribute)] |`LDAP_GROUP_SCHEMA_GROUPNAME` + `GROUPS_LDAP_GROUP_SCHEMA_GROUPNAME` | string a| [subs=-attributes] -cn +pass:[cn] a| [subs=-attributes] -LDAP Attribute to use for the name of groups +pass:[LDAP Attribute to use for the name of groups] |`LDAP_GROUP_SCHEMA_MEMBER` + `GROUPS_LDAP_GROUP_SCHEMA_MEMBER` | string a| [subs=-attributes] -member +pass:[member] a| [subs=-attributes] -LDAP Attribute that is used for group members. +pass:[LDAP Attribute that is used for group members.] |`GROUPS_OWNCLOUDSQL_DB_USERNAME` | string a| [subs=-attributes] -owncloud +pass:[owncloud] a| [subs=-attributes] -Database user to use for authenticating with the owncloud database. +pass:[Database user to use for authenticating with the owncloud database.] |`GROUPS_OWNCLOUDSQL_DB_PASSWORD` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Password for the database user. +pass:[Password for the database user.] |`GROUPS_OWNCLOUDSQL_DB_HOST` | string a| [subs=-attributes] -mysql +pass:[mysql] a| [subs=-attributes] -Hostname of the database server. +pass:[Hostname of the database server.] |`GROUPS_OWNCLOUDSQL_DB_PORT` | int a| [subs=-attributes] -3306 +pass:[3306] a| [subs=-attributes] -Network port to use for the database connection. +pass:[Network port to use for the database connection.] |`GROUPS_OWNCLOUDSQL_DB_NAME` | string a| [subs=-attributes] -owncloud +pass:[owncloud] a| [subs=-attributes] -Name of the owncloud database. +pass:[Name of the owncloud database.] |`GROUPS_OWNCLOUDSQL_IDP` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. +pass:[The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider.] |`GROUPS_OWNCLOUDSQL_NOBODY` | int64 a| [subs=-attributes] -90 +pass:[90] a| [subs=-attributes] -Fallback number if no numeric UID and GID properties are provided. +pass:[Fallback number if no numeric UID and GID properties are provided.] |`GROUPS_OWNCLOUDSQL_JOIN_USERNAME` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Join the user properties table to read usernames (boolean) +pass:[Join the user properties table to read usernames (boolean)] |`GROUPS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Join the user properties table to read user ids (boolean). +pass:[Join the user properties table to read user ids (boolean).] |`GROUPS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Allow 'medial search' when searching for users instead of just doing a prefix search. (Allows finding 'Alice' when searching for 'lic'.) +pass:[Allow 'medial search' when searching for users instead of just doing a prefix search. (Allows finding 'Alice' when searching for 'lic'.)] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/idm_configvars.adoc b/services/_includes/adoc/idm_configvars.adoc index c351f7833a5..92f86a84064 100644 --- a/services/_includes/adoc/idm_configvars.adoc +++ b/services/_includes/adoc/idm_configvars.adoc @@ -11,165 +11,165 @@ `IDM_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `IDM_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `IDM_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `IDM_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `IDM_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `IDM_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `IDM_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `IDM_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`IDM_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9239 +pass:[127.0.0.1:9239] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`IDM_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`IDM_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`IDM_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`IDM_LDAPS_ADDR` | string a| [subs=-attributes] -127.0.0.1:9235 +pass:[127.0.0.1:9235] a| [subs=-attributes] -Listen address for the ldaps listener (ip-addr:port) +pass:[Listen address for the ldaps listener (ip-addr:port)] |`IDM_LDAPS_CERT` | string a| [subs=-attributes] -~/.ocis/idm/ldap.crt +pass:[~/.ocis/idm/ldap.crt] a| [subs=-attributes] -File name of the TLS server certificate for the ldaps listener +pass:[File name of the TLS server certificate for the ldaps listener] |`IDM_LDAPS_KEY` | string a| [subs=-attributes] -~/.ocis/idm/ldap.key +pass:[~/.ocis/idm/ldap.key] a| [subs=-attributes] -File name for the TLS certificate key for the server certificate +pass:[File name for the TLS certificate key for the server certificate] |`IDM_DATABASE_PATH` | string a| [subs=-attributes] -~/.ocis/idm/ocis.boltdb +pass:[~/.ocis/idm/ocis.boltdb] a| [subs=-attributes] -Full path to the idm backend database +pass:[Full path to the idm backend database] |`IDM_CREATE_DEMO_USERS` + `ACCOUNTS_DEMO_USERS_AND_GROUPS` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Flag to enabe/disable the creation of the demo users +pass:[Flag to enabe/disable the creation of the demo users] |`IDM_ADMIN_PASSWORD` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Password to set for the ocis "admin" user. Either cleartext or an argon2id hash +pass:[Password to set for the ocis "admin" user. Either cleartext or an argon2id hash] |`IDM_SVC_PASSWORD` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Password to set for the "idm" service user. Either cleartext or an argon2id hash +pass:[Password to set for the "idm" service user. Either cleartext or an argon2id hash] |`IDM_REVASVC_PASSWORD` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Password to set for the "reva" service user. Either cleartext or an argon2id hash +pass:[Password to set for the "reva" service user. Either cleartext or an argon2id hash] |`IDM_IDPSVC_PASSWORD` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Password to set for the "idp" service user. Either cleartext or an argon2id hash +pass:[Password to set for the "idp" service user. Either cleartext or an argon2id hash] |`OCIS_ADMIN_USER_ID` + `IDM_ADMIN_USER_ID` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -ID of a user, that should receive admin privileges. +pass:[ID of a user, that should receive admin privileges.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/idp_configvars.adoc b/services/_includes/adoc/idp_configvars.adoc index 14bb7edc497..ca41f5352a9 100644 --- a/services/_includes/adoc/idp_configvars.adoc +++ b/services/_includes/adoc/idp_configvars.adoc @@ -10,389 +10,389 @@ |`IDP_PASSWORD_RESET_URI` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The URI where a user can reset their password. +pass:[The URI where a user can reset their password.] |`OCIS_TRACING_ENABLED` + `IDP_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `IDP_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `IDP_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `IDP_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `IDP_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `IDP_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `IDP_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `IDP_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`IDP_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9134 +pass:[127.0.0.1:9134] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`IDP_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`IDP_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`IDP_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`IDP_HTTP_ADDR` | string a| [subs=-attributes] -127.0.0.1:9130 +pass:[127.0.0.1:9130] a| [subs=-attributes] -The bind address of the HTTP service. +pass:[The bind address of the HTTP service.] |`IDP_HTTP_ROOT` | string a| [subs=-attributes] -/ +pass:[/] a| [subs=-attributes] -Subdirectory that serves as the root for this HTTP service. +pass:[Subdirectory that serves as the root for this HTTP service.] |`IDP_TRANSPORT_TLS_CERT` | string a| [subs=-attributes] -~/.ocis/idp/server.crt +pass:[~/.ocis/idp/server.crt] a| [subs=-attributes] - +pass:[] |`IDP_TRANSPORT_TLS_KEY` | string a| [subs=-attributes] -~/.ocis/idp/server.key +pass:[~/.ocis/idp/server.key] a| [subs=-attributes] - +pass:[] |`IDP_TLS` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] - +pass:[] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -CS3 gateway used to authenticate and look up users +pass:[CS3 gateway used to authenticate and look up users] |`OCIS_MACHINE_AUTH_API_KEY` + `IDP_MACHINE_AUTH_API_KEY` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Machine auth API key used to validate internal requests necessary for the access to resources from other services. +pass:[Machine auth API key used to validate internal requests necessary for the access to resources from other services.] |`IDP_ASSET_PATH` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Serve IDP assets from a path on the filesystem instead of the builtin assets. +pass:[Serve IDP assets from a path on the filesystem instead of the builtin assets.] |`OCIS_URL` + `OCIS_OIDC_ISSUER` + `IDP_ISS` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -The OIDC issuer URL to use. +pass:[The OIDC issuer URL to use.] |`IDP_IDENTITY_MANAGER` | string a| [subs=-attributes] -ldap +pass:[ldap] a| [subs=-attributes] -The identity manager implementation to use, defaults to 'ldap', can be changed to 'cs3', 'kc', 'libregraph', 'cookie' or 'guest'. +pass:[The identity manager implementation to use, defaults to 'ldap', can be changed to 'cs3', 'kc', 'libregraph', 'cookie' or 'guest'.] |`IDP_URI_BASE_PATH` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Idp uri base path (defaults to ""). +pass:[Idp uri base path (defaults to "").] |`IDP_SIGN_IN_URI` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Idp sign-in url. +pass:[Idp sign-in url.] |`IDP_SIGN_OUT_URI` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Idp sign-out url. +pass:[Idp sign-out url.] |`IDP_ENDPOINT_URI` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Url of IDP endpoint. +pass:[Url of IDP endpoint.] |`LDAP_INSECURE` + `IDP_INSECURE` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Allow insecure connections to the user backend (eg. LDAP, CS3 api, ...). +pass:[Allow insecure connections to the user backend (eg. LDAP, CS3 api, ...).] |`IDP_ALLOW_CLIENT_GUESTS` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Allow guest clients to access ocis. +pass:[Allow guest clients to access ocis.] |`IDP_ALLOW_DYNAMIC_CLIENT_REGISTRATION` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Allow dynamic client registration. +pass:[Allow dynamic client registration.] |`IDP_ENCRYPTION_SECRET_FILE` | string a| [subs=-attributes] -~/.ocis/idp/encryption.key +pass:[~/.ocis/idp/encryption.key] a| [subs=-attributes] -Path to the encryption secret file, if unset, a new certificate will be autogenerated upon each restart, thus invalidating all existing sessions. +pass:[Path to the encryption secret file, if unset, a new certificate will be autogenerated upon each restart, thus invalidating all existing sessions.] |`IDP_SIGNING_KID` | string a| [subs=-attributes] -private-key +pass:[private-key] a| [subs=-attributes] -Value of the KID (Key ID) field which is used in created tokens to uniquely identify the signing-private-key. +pass:[Value of the KID (Key ID) field which is used in created tokens to uniquely identify the signing-private-key.] |`IDP_SIGNING_METHOD` | string a| [subs=-attributes] -PS256 +pass:[PS256] a| [subs=-attributes] -Signing method of idp requests (e.g. PS256) +pass:[Signing method of idp requests (e.g. PS256)] |`IDP_SIGNING_PRIVATE_KEY_FILES` | a| [subs=-attributes] -[~/.ocis/idp/private-key.pem] +pass:[[~/.ocis/idp/private-key.pem]] a| [subs=-attributes] -Private key files for signing idp requests. +pass:[Private key files for signing idp requests.] |`IDP_VALIDATION_KEYS_PATH` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Path to validation keys for idp requests. +pass:[Path to validation keys for idp requests.] |`IDP_ACCESS_TOKEN_EXPIRATION` | uint64 a| [subs=-attributes] -86400 +pass:[86400] a| [subs=-attributes] -Expiration time for idp access token (in seconds). +pass:[Expiration time for idp access token (in seconds).] |`IDP_ID_TOKEN_EXPIRATION` | uint64 a| [subs=-attributes] -3600 +pass:[3600] a| [subs=-attributes] -Expiration time for idp id tokens (in seconds). +pass:[Expiration time for idp id tokens (in seconds).] |`IDP_REFRESH_TOKEN_EXPIRATION` | uint64 a| [subs=-attributes] -94608000 +pass:[94608000] a| [subs=-attributes] -Expiration time for refresh tokens (in seconds). +pass:[Expiration time for refresh tokens (in seconds).] |`IDP_DYNAMIC_CLIENT_SECRET_DURATION` | uint64 a| [subs=-attributes] -0 +pass:[0] a| [subs=-attributes] -Expiration time for dynamic clients (in seconds). +pass:[Expiration time for dynamic clients (in seconds).] |`LDAP_URI` + `IDP_LDAP_URI` | string a| [subs=-attributes] -ldaps://localhost:9235 +pass:[ldaps://localhost:9235] a| [subs=-attributes] -Url of the LDAP service to use as idp. +pass:[Url of the LDAP service to use as idp.] |`LDAP_CACERT` + `IDP_LDAP_TLS_CACERT` | string a| [subs=-attributes] -~/.ocis/idm/ldap.crt +pass:[~/.ocis/idm/ldap.crt] a| [subs=-attributes] -Path to the tls cert for the ldap service. +pass:[Path to the tls cert for the ldap service.] |`LDAP_BIND_DN` + `IDP_LDAP_BIND_DN` | string a| [subs=-attributes] -uid=idp,ou=sysusers,o=libregraph-idm +pass:[uid=idp,ou=sysusers,o=libregraph-idm] a| [subs=-attributes] -LDAP DN to use for simple bind authentication with the target LDAP server. +pass:[LDAP DN to use for simple bind authentication with the target LDAP server.] |`LDAP_BIND_PASSWORD` + `IDP_LDAP_BIND_PASSWORD` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Password to use for authenticating the 'bind_dn'. +pass:[Password to use for authenticating the 'bind_dn'.] |`LDAP_USER_BASE_DN` + `IDP_LDAP_BASE_DN` | string a| [subs=-attributes] -ou=users,o=libregraph-idm +pass:[ou=users,o=libregraph-idm] a| [subs=-attributes] -Search base DN for looking up LDAP users. +pass:[Search base DN for looking up LDAP users.] |`LDAP_USER_SCOPE` + `IDP_LDAP_SCOPE` | string a| [subs=-attributes] -sub +pass:[sub] a| [subs=-attributes] -LDAP search scope to use when looking up users ('base', 'one', 'sub'). +pass:[LDAP search scope to use when looking up users ('base', 'one', 'sub').] |`IDP_LDAP_LOGIN_ATTRIBUTE` | string a| [subs=-attributes] -uid +pass:[uid] a| [subs=-attributes] -LDAP User attribute to use for login (e.g. uid). +pass:[LDAP User attribute to use for login (e.g. uid).] |`LDAP_USER_SCHEMA_MAIL` + `IDP_LDAP_EMAIL_ATTRIBUTE` | string a| [subs=-attributes] -mail +pass:[mail] a| [subs=-attributes] -LDAP User email attribute (e.g. mail). +pass:[LDAP User email attribute (e.g. mail).] |`LDAP_USER_SCHEMA_USERNAME` + `IDP_LDAP_NAME_ATTRIBUTE` | string a| [subs=-attributes] -displayName +pass:[displayName] a| [subs=-attributes] -LDAP User name attribute (e.g. displayName). +pass:[LDAP User name attribute (e.g. displayName).] |`LDAP_USER_SCHEMA_ID` + `IDP_LDAP_UUID_ATTRIBUTE` | string a| [subs=-attributes] -uid +pass:[uid] a| [subs=-attributes] -LDAP User uuid attribute (e.g. uid). +pass:[LDAP User uuid attribute (e.g. uid).] |`IDP_LDAP_UUID_ATTRIBUTE_TYPE` | string a| [subs=-attributes] -text +pass:[text] a| [subs=-attributes] -LDAP User uuid attribute type (e.g. text). +pass:[LDAP User uuid attribute type (e.g. text).] |`LDAP_USER_FILTER` + `IDP_LDAP_FILTER` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -LDAP filter to add to the default filters for user search (e.g. '(objectclass=ownCloud)'). +pass:[LDAP filter to add to the default filters for user search (e.g. '(objectclass=ownCloud)').] |`LDAP_USER_OBJECTCLASS` + `IDP_LDAP_OBJECTCLASS` | string a| [subs=-attributes] -inetOrgPerson +pass:[inetOrgPerson] a| [subs=-attributes] -LDAP User ObjectClass (e.g. inetOrgPerson). +pass:[LDAP User ObjectClass (e.g. inetOrgPerson).] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/nats_configvars.adoc b/services/_includes/adoc/nats_configvars.adoc index 2ab5723317a..02b2b90afcb 100644 --- a/services/_includes/adoc/nats_configvars.adoc +++ b/services/_includes/adoc/nats_configvars.adoc @@ -11,89 +11,89 @@ `NATS_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `NATS_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `NATS_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `NATS_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`NATS_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9234 +pass:[127.0.0.1:9234] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`NATS_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`NATS_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`NATS_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`NATS_NATS_HOST` | string a| [subs=-attributes] -127.0.0.1 +pass:[127.0.0.1] a| [subs=-attributes] -Bind address. +pass:[Bind address.] |`NATS_NATS_PORT` | int a| [subs=-attributes] -9233 +pass:[9233] a| [subs=-attributes] -Bind port: +pass:[Bind port:] |`NATS_NATS_CLUSTER_ID` | string a| [subs=-attributes] -ocis-cluster +pass:[ocis-cluster] a| [subs=-attributes] -ID of the NATS cluster. +pass:[ID of the NATS cluster.] |`NATS_NATS_STORE_DIR` | string a| [subs=-attributes] -~/.ocis/nats +pass:[~/.ocis/nats] a| [subs=-attributes] -Path for the NATS JetStream persistence directory. +pass:[Path for the NATS JetStream persistence directory.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/notifications_configvars.adoc b/services/_includes/adoc/notifications_configvars.adoc index 3b6d0e44cc7..980c4d8c2f6 100644 --- a/services/_includes/adoc/notifications_configvars.adoc +++ b/services/_includes/adoc/notifications_configvars.adoc @@ -11,126 +11,126 @@ `NOTIFICATIONS_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `NOTIFICATIONS_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `NOTIFICATIONS_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `NOTIFICATIONS_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`NOTIFICATIONS_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9174 +pass:[127.0.0.1:9174] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`NOTIFICATIONS_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`NOTIFICATIONS_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`NOTIFICATIONS_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`NOTIFICATIONS_SMTP_HOST` | string a| [subs=-attributes] -127.0.0.1 +pass:[127.0.0.1] a| [subs=-attributes] -SMTP host, to connect to. +pass:[SMTP host, to connect to.] |`NOTIFICATIONS_SMTP_PORT` | string a| [subs=-attributes] -1025 +pass:[1025] a| [subs=-attributes] -Port of the SMTP host, to connect to. +pass:[Port of the SMTP host, to connect to.] |`NOTIFICATIONS_SMTP_SENDER` | string a| [subs=-attributes] -noreply@example.com +pass:[noreply@example.com] a| [subs=-attributes] -Sender of emails, that will be sent. +pass:[Sender of emails, that will be sent.] |`NOTIFICATIONS_SMTP_PASSWORD` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Password of the SMTP host, to connect to. +pass:[Password of the SMTP host, to connect to.] |`NOTIFICATIONS_EVENTS_ENDPOINT` | string a| [subs=-attributes] -127.0.0.1:9233 +pass:[127.0.0.1:9233] a| [subs=-attributes] -Endpoint of the event system. +pass:[Endpoint of the event system.] |`NOTIFICATIONS_EVENTS_CLUSTER` | string a| [subs=-attributes] -ocis-cluster +pass:[ocis-cluster] a| [subs=-attributes] -Cluster ID of the event system. +pass:[Cluster ID of the event system.] |`NOTIFICATIONS_EVENTS_GROUP` | string a| [subs=-attributes] -notifications +pass:[notifications] a| [subs=-attributes] -Name of the event group / queue on the event system. +pass:[Name of the event group / queue on the event system.] |`REVA_GATEWAY` + `NOTIFICATIONS_REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -CS3 gateway used to look up user metadata +pass:[CS3 gateway used to look up user metadata] |`OCIS_MACHINE_AUTH_API_KEY` + `NOTIFICATIONS_MACHINE_AUTH_API_KEY` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Machine auth API key used to validate internal requests necessary for the access to resources from other services. +pass:[Machine auth API key used to validate internal requests necessary for the access to resources from other services.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/ocdav_configvars.adoc b/services/_includes/adoc/ocdav_configvars.adoc index 8b3463f4250..65ae7929d20 100644 --- a/services/_includes/adoc/ocdav_configvars.adoc +++ b/services/_includes/adoc/ocdav_configvars.adoc @@ -11,188 +11,188 @@ `OCDAV_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `OCDAV_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `OCDAV_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `OCDAV_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `OCDAV_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `OCDAV_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `OCDAV_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `OCDAV_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`OCDAV_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9163 +pass:[127.0.0.1:9163] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`OCDAV_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`OCDAV_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`OCDAV_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`OCDAV_HTTP_ADDR` | string a| [subs=-attributes] -127.0.0.1:0 +pass:[127.0.0.1:0] a| [subs=-attributes] -The bind address of the HTTP service. +pass:[The bind address of the HTTP service.] |`OCDAV_HTTP_PROTOCOL` | string a| [subs=-attributes] -tcp +pass:[tcp] a| [subs=-attributes] -The transport protocol of the http service. +pass:[The transport protocol of the http service.] |`OCDAV_HTTP_PREFIX` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -A URL path prefix for the handler. +pass:[A URL path prefix for the handler.] |`OCIS_JWT_SECRET` + `OCDAV_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`OCDAV_SKIP_USER_GROUPS_IN_TOKEN` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Disables the loading of user's group memberships from the reva access token. +pass:[Disables the loading of user's group memberships from the reva access token.] |`OCDAV_WEBDAV_NAMESPACE` | string a| [subs=-attributes] -/users/{{.Id.OpaqueId}} +pass:[/users/{{.Id.OpaqueId}}] a| [subs=-attributes] -Jail requests to /dav/webdav into this CS3 namespace. Supports template layouting with CS3 User properties. +pass:[Jail requests to /dav/webdav into this CS3 namespace. Supports template layouting with CS3 User properties.] |`OCDAV_FILES_NAMESPACE` | string a| [subs=-attributes] -/users/{{.Id.OpaqueId}} +pass:[/users/{{.Id.OpaqueId}}] a| [subs=-attributes] -Jail requests to /dav/files/{username} into this CS3 namespace. Supports template layouting with CS3 User properties. +pass:[Jail requests to /dav/files/{username} into this CS3 namespace. Supports template layouting with CS3 User properties.] |`OCDAV_SHARES_NAMESPACE` | string a| [subs=-attributes] -/Shares +pass:[/Shares] a| [subs=-attributes] -The human readable path for the share jail. Relative to a users personal space root. Upcased intentionally. +pass:[The human readable path for the share jail. Relative to a users personal space root. Upcased intentionally.] |`OCIS_URL` + `OCDAV_PUBLIC_URL` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -URL, where oCIS is reachable for users. +pass:[URL, where oCIS is reachable for users.] |`OCIS_INSECURE` + `OCDAV_INSECURE` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] - +pass:[] |`OCDAV_GATEWAY_REQUEST_TIMEOUT` | int64 a| [subs=-attributes] -84300 +pass:[84300] a| [subs=-attributes] -Request timeout in seconds for requests from the oCDAV service to the gateway service. +pass:[Request timeout in seconds for requests from the oCDAV service to the gateway service.] |`OCIS_MACHINE_AUTH_API_KEY` + `OCDAV_MACHINE_AUTH_API_KEY` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Machine auth API key used to validate internal requests necessary for the access to resources from other services. +pass:[Machine auth API key used to validate internal requests necessary for the access to resources from other services.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/ocs_configvars.adoc b/services/_includes/adoc/ocs_configvars.adoc index 27c23fd3f9e..46a9d4e4523 100644 --- a/services/_includes/adoc/ocs_configvars.adoc +++ b/services/_includes/adoc/ocs_configvars.adoc @@ -11,139 +11,139 @@ `OCS_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `OCS_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `OCS_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `OCS_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `OCS_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `OCS_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `OCS_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `OCS_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`OCS_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9114 +pass:[127.0.0.1:9114] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`OCS_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`OCS_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`OCS_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`OCS_HTTP_ADDR` | string a| [subs=-attributes] -127.0.0.1:9110 +pass:[127.0.0.1:9110] a| [subs=-attributes] -The bind address of the HTTP service. +pass:[The bind address of the HTTP service.] |`OCS_HTTP_ROOT` | string a| [subs=-attributes] -/ocs +pass:[/ocs] a| [subs=-attributes] -Subdirectory that serves as the root for this HTTP service. +pass:[Subdirectory that serves as the root for this HTTP service.] |`OCIS_JWT_SECRET` + `OCS_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`OCIS_URL` + `OCIS_OIDC_ISSUER` + `OCS_IDM_ADDRESS` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -URL of the OIDC issuer. It defaults to URL of the builtin IDP. +pass:[URL of the OIDC issuer. It defaults to URL of the builtin IDP.] |`OCIS_MACHINE_AUTH_API_KEY` + `OCS_MACHINE_AUTH_API_KEY` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Machine auth API key used to validate internal requests necessary for the access to resources from other services. +pass:[Machine auth API key used to validate internal requests necessary for the access to resources from other services.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/proxy_configvars.adoc b/services/_includes/adoc/proxy_configvars.adoc index df5a100e577..ef16718a38d 100644 --- a/services/_includes/adoc/proxy_configvars.adoc +++ b/services/_includes/adoc/proxy_configvars.adoc @@ -11,231 +11,231 @@ `PROXY_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `PROXY_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `PROXY_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `PROXY_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `PROXY_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `PROXY_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `PROXY_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `PROXY_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`PROXY_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9205 +pass:[127.0.0.1:9205] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`PROXY_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`PROXY_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`PROXY_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`PROXY_HTTP_ADDR` | string a| [subs=-attributes] -0.0.0.0:9200 +pass:[0.0.0.0:9200] a| [subs=-attributes] -The bind address of the HTTP service. +pass:[The bind address of the HTTP service.] |`PROXY_HTTP_ROOT` | string a| [subs=-attributes] -/ +pass:[/] a| [subs=-attributes] -Subdirectory that serves as the root for this HTTP service. +pass:[Subdirectory that serves as the root for this HTTP service.] |`PROXY_TRANSPORT_TLS_CERT` | string a| [subs=-attributes] -~/.ocis/proxy/server.crt +pass:[~/.ocis/proxy/server.crt] a| [subs=-attributes] - +pass:[] |`PROXY_TRANSPORT_TLS_KEY` | string a| [subs=-attributes] -~/.ocis/proxy/server.key +pass:[~/.ocis/proxy/server.key] a| [subs=-attributes] - +pass:[] |`PROXY_TLS` | bool a| [subs=-attributes] -true +pass:[true] a| [subs=-attributes] - +pass:[] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`OCIS_URL` + `OCIS_OIDC_ISSUER` + `PROXY_OIDC_ISSUER` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -URL of the OIDC issuer. It defaults to URL of the builtin IDP. +pass:[URL of the OIDC issuer. It defaults to URL of the builtin IDP.] |`OCIS_INSECURE` + `PROXY_OIDC_INSECURE` | bool a| [subs=-attributes] -true +pass:[true] a| [subs=-attributes] -Disable TLS certificate validation for connections to the IDP. (not recommended for production environments. +pass:[Disable TLS certificate validation for connections to the IDP. (not recommended for production environments.] |`PROXY_OIDC_USERINFO_CACHE_SIZE` | int a| [subs=-attributes] -1024 +pass:[1024] a| [subs=-attributes] -Cache size for oidc user info. +pass:[Cache size for oidc user info.] |`PROXY_OIDC_USERINFO_CACHE_TTL` | int a| [subs=-attributes] -10 +pass:[10] a| [subs=-attributes] -Max TTL for the oidc user info cache. +pass:[Max TTL for the oidc user info cache.] |`OCIS_JWT_SECRET` + `PROXY_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`PROXY_ENABLE_PRESIGNEDURLS` | bool a| [subs=-attributes] -true +pass:[true] a| [subs=-attributes] -Allow ocs to get a signing key to sign requests. +pass:[Allow ocs to get a signing key to sign requests.] |`PROXY_ACCOUNT_BACKEND_TYPE` | string a| [subs=-attributes] -cs3 +pass:[cs3] a| [subs=-attributes] -Account backend the proxy should use, currenly only 'cs3' is possible here. +pass:[Account backend the proxy should use, currenly only 'cs3' is possible here.] |`PROXY_USER_OIDC_CLAIM` | string a| [subs=-attributes] -email +pass:[email] a| [subs=-attributes] -The name of an OpenID Connect claim that should be used for resolving users with the account backend. Currently defaults to 'email'. +pass:[The name of an OpenID Connect claim that should be used for resolving users with the account backend. Currently defaults to 'email'.] |`PROXY_USER_CS3_CLAIM` | string a| [subs=-attributes] -mail +pass:[mail] a| [subs=-attributes] -The name of a CS3 user attribute (claim) that should be mapped to the 'user_oidc_claim'. Currently defaults to 'mail' (other possible values are: 'username', 'displayname') +pass:[The name of a CS3 user attribute (claim) that should be mapped to the 'user_oidc_claim'. Currently defaults to 'mail' (other possible values are: 'username', 'displayname')] |`OCIS_MACHINE_AUTH_API_KEY` + `PROXY_MACHINE_AUTH_API_KEY` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Machine auth API key used to validate internal requests necessary for the access to resources from other services. +pass:[Machine auth API key used to validate internal requests necessary for the access to resources from other services.] |`PROXY_AUTOPROVISION_ACCOUNTS` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Set this to 'true' to automatically provsion users that do not yet exist in the users service on-demand upon first signin. To use this a write-enabled libregraph user backend needs to be setup an running. +pass:[Set this to 'true' to automatically provsion users that do not yet exist in the users service on-demand upon first signin. To use this a write-enabled libregraph user backend needs to be setup an running.] |`PROXY_ENABLE_BASIC_AUTH` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Set this to true to enable 'basic' (username/password) authentication. +pass:[Set this to true to enable 'basic' (username/password) authentication.] |`PROXY_INSECURE_BACKENDS` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Disable TLS certificate validation for all http backend connections. +pass:[Disable TLS certificate validation for all http backend connections.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/search_configvars.adoc b/services/_includes/adoc/search_configvars.adoc index 72f7137e82b..fcd26e04c3e 100644 --- a/services/_includes/adoc/search_configvars.adoc +++ b/services/_includes/adoc/search_configvars.adoc @@ -11,143 +11,143 @@ `SEARCH_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `SEARCH_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `SEARCH_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `SEARCH_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `SEARCH_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `SEARCH_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `SEARCH_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `SEARCH_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`SEARCH_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9224 +pass:[127.0.0.1:9224] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`SEARCH_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`SEARCH_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`SEARCH_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`SEARCH_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9220 +pass:[127.0.0.1:9220] a| [subs=-attributes] -The bind address of the GRPC service. +pass:[The bind address of the GRPC service.] |`SEARCH_DATA_PATH` | string a| [subs=-attributes] -~/.ocis/search +pass:[~/.ocis/search] a| [subs=-attributes] -Path for the search persistence directory. +pass:[Path for the search persistence directory.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`SEARCH_EVENTS_ENDPOINT` | string a| [subs=-attributes] -127.0.0.1:9233 +pass:[127.0.0.1:9233] a| [subs=-attributes] -the address of the streaming service +pass:[the address of the streaming service] |`SEARCH_EVENTS_CLUSTER` | string a| [subs=-attributes] -ocis-cluster +pass:[ocis-cluster] a| [subs=-attributes] -the clusterID of the streaming service. Mandatory when using nats +pass:[the clusterID of the streaming service. Mandatory when using nats] |`SEARCH_EVENTS_GROUP` | string a| [subs=-attributes] -search +pass:[search] a| [subs=-attributes] -the customergroup of the service. One group will only get one copy of an event +pass:[the customergroup of the service. One group will only get one copy of an event] |`OCIS_MACHINE_AUTH_API_KEY` + `SEARCH_MACHINE_AUTH_API_KEY` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Machine auth API key used to validate internal requests necessary for the access to resources from other services. +pass:[Machine auth API key used to validate internal requests necessary for the access to resources from other services.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/settings_configvars.adoc b/services/_includes/adoc/settings_configvars.adoc index 3a0e987d184..866d577a484 100644 --- a/services/_includes/adoc/settings_configvars.adoc +++ b/services/_includes/adoc/settings_configvars.adoc @@ -11,203 +11,203 @@ `SETTINGS_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `SETTINGS_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `SETTINGS_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `SETTINGS_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `SETTINGS_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `SETTINGS_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `SETTINGS_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `SETTINGS_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`SETTINGS_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9194 +pass:[127.0.0.1:9194] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`SETTINGS_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`SETTINGS_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`SETTINGS_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`SETTINGS_HTTP_ADDR` | string a| [subs=-attributes] -127.0.0.1:9190 +pass:[127.0.0.1:9190] a| [subs=-attributes] -The bind address of the HTTP service. +pass:[The bind address of the HTTP service.] |`SETTINGS_HTTP_ROOT` | string a| [subs=-attributes] -/ +pass:[/] a| [subs=-attributes] -Subdirectory that serves as the root for this HTTP service. +pass:[Subdirectory that serves as the root for this HTTP service.] |`SETTINGS_CACHE_TTL` | int a| [subs=-attributes] -604800 +pass:[604800] a| [subs=-attributes] -Browser cache control max-age value in seconds for settings Web UI assets. +pass:[Browser cache control max-age value in seconds for settings Web UI assets.] |`SETTINGS_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9191 +pass:[127.0.0.1:9191] a| [subs=-attributes] -The bind address of the GRPC service. +pass:[The bind address of the GRPC service.] |`SETTINGS_STORE_TYPE` | string a| [subs=-attributes] -metadata +pass:[metadata] a| [subs=-attributes] -Store type configures the persistency driver. Possible values are "metadata" and "filesystem". +pass:[Store type configures the persistency driver. Possible values are "metadata" and "filesystem".] |`SETTINGS_DATA_PATH` | string a| [subs=-attributes] -~/.ocis/settings +pass:[~/.ocis/settings] a| [subs=-attributes] -Path for the persistence directory. +pass:[Path for the persistence directory.] |`STORAGE_GATEWAY_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9215 +pass:[127.0.0.1:9215] a| [subs=-attributes] -GRPC address of the storage-system service. +pass:[GRPC address of the storage-system service.] |`STORAGE_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9215 +pass:[127.0.0.1:9215] a| [subs=-attributes] -GRPC address of the storage-system service. +pass:[GRPC address of the storage-system service.] |`OCIS_SYSTEM_USER_ID` + `SETTINGS_SYSTEM_USER_ID` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_SYSTEM_USER_IDP` + `SETTINGS_SYSTEM_USER_IDP` | string a| [subs=-attributes] -internal +pass:[internal] a| [subs=-attributes] -IDP of the oCIS storage-system system user. +pass:[IDP of the oCIS storage-system system user.] |`OCIS_SYSTEM_USER_API_KEY` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -API key for the storage-system system user. +pass:[API key for the storage-system system user.] |`OCIS_ADMIN_USER_ID` + `SETTINGS_ADMIN_USER_ID` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -ID of a user, that should receive admin privileges. +pass:[ID of a user, that should receive admin privileges.] |`SETTINGS_ASSET_PATH` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Serve settings Web UI assets from a path on the filesystem instead of the builtin assets. Can be used for development and customization. +pass:[Serve settings Web UI assets from a path on the filesystem instead of the builtin assets. Can be used for development and customization.] |`OCIS_JWT_SECRET` + `SETTINGS_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`SETTINGS_SETUP_DEFAULT_ASSIGNMENTS` + `ACCOUNTS_DEMO_USERS_AND_GROUPS` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -If the default role assignments for the demo users should be setup. +pass:[If the default role assignments for the demo users should be setup.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/sharing_configvars.adoc b/services/_includes/adoc/sharing_configvars.adoc index 75b757c5191..1a9f79b5cfb 100644 --- a/services/_includes/adoc/sharing_configvars.adoc +++ b/services/_includes/adoc/sharing_configvars.adoc @@ -11,275 +11,275 @@ `SHARING_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `SHARING_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `SHARING_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `SHARING_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `SHARING_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `SHARING_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `SHARING_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `SHARING_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`SHARING_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9151 +pass:[127.0.0.1:9151] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`SHARING_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`SHARING_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`SHARING_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`SHARING_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9150 +pass:[127.0.0.1:9150] a| [subs=-attributes] -The bind address of the GRPC service. +pass:[The bind address of the GRPC service.] |`SHARING_GRPC_PROTOCOL` | string a| [subs=-attributes] -tcp +pass:[tcp] a| [subs=-attributes] -The transport protocol of the grpc service. +pass:[The transport protocol of the grpc service.] |`OCIS_JWT_SECRET` + `SHARING_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`SHARING_EVENTS_ENDPOINT` | string a| [subs=-attributes] -127.0.0.1:9233 +pass:[127.0.0.1:9233] a| [subs=-attributes] -the address of the streaming service +pass:[the address of the streaming service] |`SHARING_EVENTS_CLUSTER` | string a| [subs=-attributes] -ocis-cluster +pass:[ocis-cluster] a| [subs=-attributes] -the clusterID of the streaming service. Mandatory when using nats +pass:[the clusterID of the streaming service. Mandatory when using nats] |`SHARING_SKIP_USER_GROUPS_IN_TOKEN` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Disables the loading of user's group memberships from the reva access token. +pass:[Disables the loading of user's group memberships from the reva access token.] |`SHARING_USER_DRIVER` | string a| [subs=-attributes] -cs3 +pass:[cs3] a| [subs=-attributes] -Driver to be used to persist shares. Possible values: "json", "cs3", "owncloudsql" +pass:[Driver to be used to persist shares. Possible values: "json", "cs3", "owncloudsql"] |`SHARING_USER_JSON_FILE` | string a| [subs=-attributes] -~/.ocis/storage/shares.json +pass:[~/.ocis/storage/shares.json] a| [subs=-attributes] -Path to the json file where shares will be persisted. +pass:[Path to the json file where shares will be persisted.] |`SHARING_USER_CS3_PROVIDER_ADDR` | string a| [subs=-attributes] -127.0.0.1:9215 +pass:[127.0.0.1:9215] a| [subs=-attributes] -GRPC address of the storage-system extension. +pass:[GRPC address of the storage-system extension.] |`OCIS_SYSTEM_USER_ID` + `SHARING_USER_CS3_SYSTEM_USER_ID` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_SYSTEM_USER_IDP` + `SHARING_USER_CS3_SYSTEM_USER_IDP` | string a| [subs=-attributes] -internal +pass:[internal] a| [subs=-attributes] -IDP of the oCIS storage-system system user. +pass:[IDP of the oCIS storage-system system user.] |`OCIS_SYSTEM_USER_API_KEY` + `SHARING_USER_CS3_SYSTEM_USER_API_KEY` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -API key for the storage-system system user. +pass:[API key for the storage-system system user.] |`SHARING_USER_OWNCLOUDSQL_DB_USERNAME` | string a| [subs=-attributes] -owncloud +pass:[owncloud] a| [subs=-attributes] -Username for the database. +pass:[Username for the database.] |`SHARING_USER_OWNCLOUDSQL_DB_PASSWORD` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Password for the database. +pass:[Password for the database.] |`SHARING_USER_OWNCLOUDSQL_DB_HOST` | string a| [subs=-attributes] -mysql +pass:[mysql] a| [subs=-attributes] -Hostname or IP of the database server. +pass:[Hostname or IP of the database server.] |`SHARING_USER_OWNCLOUDSQL_DB_PORT` | int a| [subs=-attributes] -3306 +pass:[3306] a| [subs=-attributes] -Port that the database server is listening on. +pass:[Port that the database server is listening on.] |`SHARING_USER_OWNCLOUDSQL_DB_NAME` | string a| [subs=-attributes] -owncloud +pass:[owncloud] a| [subs=-attributes] -Name of the database to be used. +pass:[Name of the database to be used.] |`SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Mount ID of the ownCloudSQL users storage for mapping ownCloud 10 shares. +pass:[Mount ID of the ownCloudSQL users storage for mapping ownCloud 10 shares.] |`SHARING_PUBLIC_DRIVER` | string a| [subs=-attributes] -cs3 +pass:[cs3] a| [subs=-attributes] -Driver to be used to persist public shares. Possible values: "json", "cs3" +pass:[Driver to be used to persist public shares. Possible values: "json", "cs3"] |`SHARING_PUBLIC_JSON_FILE` | string a| [subs=-attributes] -~/.ocis/storage/publicshares.json +pass:[~/.ocis/storage/publicshares.json] a| [subs=-attributes] -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. +pass:[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.] |`SHARING_PUBLIC_CS3_PROVIDER_ADDR` | string a| [subs=-attributes] -127.0.0.1:9215 +pass:[127.0.0.1:9215] a| [subs=-attributes] -GRPC address of the storage-system extension. +pass:[GRPC address of the storage-system extension.] |`OCIS_SYSTEM_USER_ID` + `SHARING_PUBLIC_CS3_SYSTEM_USER_ID` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_SYSTEM_USER_IDP` + `SHARING_PUBLIC_CS3_SYSTEM_USER_IDP` | string a| [subs=-attributes] -internal +pass:[internal] a| [subs=-attributes] -IDP of the oCIS storage-system system user. +pass:[IDP of the oCIS storage-system system user.] |`OCIS_SYSTEM_USER_API_KEY` + `SHARING_USER_CS3_SYSTEM_USER_API_KEY` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -API key for the storage-system system user. +pass:[API key for the storage-system system user.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/storage-publiclink_configvars.adoc b/services/_includes/adoc/storage-publiclink_configvars.adoc index 837b8aaee11..5b40a982f90 100644 --- a/services/_includes/adoc/storage-publiclink_configvars.adoc +++ b/services/_includes/adoc/storage-publiclink_configvars.adoc @@ -11,136 +11,136 @@ `STORAGE_PUBLICLINK_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `STORAGE_PUBLICLINK_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `STORAGE_PUBLICLINK_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `STORAGE_PUBLICLINK_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `STORAGE_PUBLICLINK_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `STORAGE_PUBLICLINK_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `STORAGE_PUBLICLINK_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `STORAGE_PUBLICLINK_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`STORAGE_PUBLICLINK_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9179 +pass:[127.0.0.1:9179] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`STORAGE_PUBLICLINK_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`STORAGE_PUBLICLINK_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`STORAGE_PUBLICLINK_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`STORAGE_PUBLICLINK_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9178 +pass:[127.0.0.1:9178] a| [subs=-attributes] -The bind address of the GRPC service. +pass:[The bind address of the GRPC service.] |`STORAGE_PUBLICLINK_GRPC_PROTOCOL` | string a| [subs=-attributes] -tcp +pass:[tcp] a| [subs=-attributes] -The transport protocol of the grpc service. +pass:[The transport protocol of the grpc service.] |`OCIS_JWT_SECRET` + `STORAGE_PUBLICLINK_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`STORAGE_PUBLICLINK_SKIP_USER_GROUPS_IN_TOKEN` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Disables the loading of user's group memberships from the reva access token. +pass:[Disables the loading of user's group memberships from the reva access token.] |`STORAGE_PUBLICLINK_STORAGE_PROVIDER_MOUNT_ID` | string a| [subs=-attributes] -7993447f-687f-490d-875c-ac95e89a62a4 +pass:[7993447f-687f-490d-875c-ac95e89a62a4] a| [subs=-attributes] -Mount ID of this storage. +pass:[Mount ID of this storage.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/storage-shares_configvars.adoc b/services/_includes/adoc/storage-shares_configvars.adoc index b931dba3a5a..913fbf87ef0 100644 --- a/services/_includes/adoc/storage-shares_configvars.adoc +++ b/services/_includes/adoc/storage-shares_configvars.adoc @@ -11,150 +11,150 @@ `STORAGE_SHARES_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `STORAGE_SHARES_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `STORAGE_SHARES_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `STORAGE_SHARES_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `STORAGE_SHARES_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `STORAGE_SHARES_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `STORAGE_SHARES_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `STORAGE_SHARES_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`STORAGE_SHARES_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9156 +pass:[127.0.0.1:9156] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`STORAGE_SHARES_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`STORAGE_SHARES_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`STORAGE_SHARES_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`STORAGE_SHARES_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9154 +pass:[127.0.0.1:9154] a| [subs=-attributes] -The bind address of the GRPC service. +pass:[The bind address of the GRPC service.] |`STORAGE_SHARES_GRPC_PROTOCOL` | string a| [subs=-attributes] -tcp +pass:[tcp] a| [subs=-attributes] -The transport protocol of the grpc service. +pass:[The transport protocol of the grpc service.] |`OCIS_JWT_SECRET` + `STORAGE_SHARES_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`STORAGE_SHARES_SKIP_USER_GROUPS_IN_TOKEN` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Disables the loading of user's group memberships from the reva access token. +pass:[Disables the loading of user's group memberships from the reva access token.] |`STORAGE_SHARES_MOUNT_ID` | string a| [subs=-attributes] -7639e57c-4433-4a12-8201-722fd0009154 +pass:[7639e57c-4433-4a12-8201-722fd0009154] a| [subs=-attributes] -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. +pass:[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.] |`STORAGE_SHARES_READ_ONLY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Set this storage to be read-only. +pass:[Set this storage to be read-only.] |`STORAGE_SHARES_USER_SHARE_PROVIDER_ENDPOINT` | string a| [subs=-attributes] -localhost:9150 +pass:[localhost:9150] a| [subs=-attributes] -GRPC endpoint of the sharing extension. +pass:[GRPC endpoint of the sharing extension.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/storage-system_configvars.adoc b/services/_includes/adoc/storage-system_configvars.adoc index 9b8fe5463ba..5b0836ea05f 100644 --- a/services/_includes/adoc/storage-system_configvars.adoc +++ b/services/_includes/adoc/storage-system_configvars.adoc @@ -11,192 +11,192 @@ `STORAGE_SYSTEM_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `STORAGE_SYSTEM_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `STORAGE_SYSTEM_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `STORAGE_SYSTEM_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `STORAGE_SYSTEM_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `STORAGE_SYSTEM_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `STORAGE_SYSTEM_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `STORAGE_SYSTEM_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`STORAGE_SYSTEM_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9217 +pass:[127.0.0.1:9217] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`STORAGE_SYSTEM_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`STORAGE_SYSTEM_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`STORAGE_SYSTEM_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`STORAGE_SYSTEM_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9215 +pass:[127.0.0.1:9215] a| [subs=-attributes] -The bind address of the GRPC service. +pass:[The bind address of the GRPC service.] |`STORAGE_SYSTEM_GRPC_PROTOCOL` | string a| [subs=-attributes] -tcp +pass:[tcp] a| [subs=-attributes] -The transport protocol of the grpc service. +pass:[The transport protocol of the grpc service.] |`STORAGE_SYSTEM_HTTP_ADDR` | string a| [subs=-attributes] -127.0.0.1:9216 +pass:[127.0.0.1:9216] a| [subs=-attributes] -The bind address of the HTTP service. +pass:[The bind address of the HTTP service.] |`STORAGE_SYSTEM_HTTP_PROTOCOL` | string a| [subs=-attributes] -tcp +pass:[tcp] a| [subs=-attributes] -The transport protocol of the http service. +pass:[The transport protocol of the http service.] |`STORAGE_SYSTEM_EVENTS_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -the address of the streaming service +pass:[the address of the streaming service] |`STORAGE_SYSTEM_EVENTS_CLUSTER` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -the clusterID of the streaming service. Mandatory when using nats +pass:[the clusterID of the streaming service. Mandatory when using nats] |`OCIS_JWT_SECRET` + `STORAGE_SYSTEM_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`OCIS_SYSTEM_USER_ID` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_SYSTEM_USER_API_KEY` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -API key for the storage-system system user. +pass:[API key for the storage-system system user.] |`STORAGE_SYSTEM_SKIP_USER_GROUPS_IN_TOKEN` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Disables the loading of user's group memberships from the reva access token. +pass:[Disables the loading of user's group memberships from the reva access token.] |`STORAGE_SYSTEM_DRIVER` | string a| [subs=-attributes] -ocis +pass:[ocis] a| [subs=-attributes] -The driver which should be used by the service +pass:[The driver which should be used by the service] |`STORAGE_SYSTEM_OCIS_ROOT` | string a| [subs=-attributes] -~/.ocis/storage/metadata +pass:[~/.ocis/storage/metadata] a| [subs=-attributes] -Path for the directory where the storage-system service stores it's persistent data. +pass:[Path for the directory where the storage-system service stores it's persistent data.] |`STORAGE_SYSTEM_DATA_SERVER_URL` | string a| [subs=-attributes] -\http://localhost:9216/data +pass:[http://localhost:9216/data] a| [subs=-attributes] -URL of the data server, needs to be reachable by services using this service. +pass:[URL of the data server, needs to be reachable by services using this service.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/storage-users_configvars.adoc b/services/_includes/adoc/storage-users_configvars.adoc index 62bbb9229ed..d263c5f798c 100644 --- a/services/_includes/adoc/storage-users_configvars.adoc +++ b/services/_includes/adoc/storage-users_configvars.adoc @@ -11,382 +11,382 @@ `STORAGE_USERS_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `STORAGE_USERS_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `STORAGE_USERS_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `STORAGE_USERS_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `STORAGE_USERS_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `STORAGE_USERS_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `STORAGE_USERS_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `STORAGE_USERS_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`STORAGE_USERS_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9159 +pass:[127.0.0.1:9159] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`STORAGE_USERS_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`STORAGE_USERS_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`STORAGE_USERS_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`STORAGE_USERS_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9157 +pass:[127.0.0.1:9157] a| [subs=-attributes] -The bind address of the GRPC service. +pass:[The bind address of the GRPC service.] |`STORAGE_USERS_GRPC_PROTOCOL` | string a| [subs=-attributes] -tcp +pass:[tcp] a| [subs=-attributes] -The transport protocol of the grpc service. +pass:[The transport protocol of the grpc service.] |`STORAGE_USERS_HTTP_ADDR` | string a| [subs=-attributes] -127.0.0.1:9158 +pass:[127.0.0.1:9158] a| [subs=-attributes] -The bind address of the HTTP service. +pass:[The bind address of the HTTP service.] |`STORAGE_USERS_HTTP_PROTOCOL` | string a| [subs=-attributes] -tcp +pass:[tcp] a| [subs=-attributes] -The transport protocol of the http service. +pass:[The transport protocol of the http service.] |`OCIS_JWT_SECRET` + `STORAGE_USERS_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`STORAGE_USERS_SKIP_USER_GROUPS_IN_TOKEN` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Disables the loading of user's group memberships from the reva access token. +pass:[Disables the loading of user's group memberships from the reva access token.] |`STORAGE_USERS_DRIVER` | string a| [subs=-attributes] -ocis +pass:[ocis] a| [subs=-attributes] -The storage driver which should be used by the service +pass:[The storage driver which should be used by the service] |`STORAGE_USERS_OCIS_ROOT` | string a| [subs=-attributes] -~/.ocis/storage/users +pass:[~/.ocis/storage/users] a| [subs=-attributes] -Path for the persistence directory. +pass:[Path for the persistence directory.] |`STORAGE_USERS_OCIS_USER_LAYOUT` | string a| [subs=-attributes] -{{.Id.OpaqueId}} +pass:[{{.Id.OpaqueId}}] a| [subs=-attributes] -Template string for the user storage layout in the persistence directory. +pass:[Template string for the user storage layout in the persistence directory.] |`STORAGE_USERS_PERMISSION_ENDPOINT,STORAGE_USERS_OCIS_PERMISSIONS_ENDPOINT` | string a| [subs=-attributes] -127.0.0.1:9191 +pass:[127.0.0.1:9191] a| [subs=-attributes] -Endpoint of the permissions service. +pass:[Endpoint of the permissions service.] |`STORAGE_USERS_OCIS_PERSONAL_SPACE_ALIAS_TEMPLATE` | string a| [subs=-attributes] -{{.SpaceType}}/{{.User.Username \| lower}} +pass:[{{.SpaceType}}/{{.User.Username \| lower}}] a| [subs=-attributes] -Template string to construct personal space aliases. +pass:[Template string to construct personal space aliases.] |`STORAGE_USERS_OCIS_GENERAL_SPACE_ALIAS_TEMPLATE` | string a| [subs=-attributes] -{{.SpaceType}}/{{.SpaceName \| replace " " "-" \| lower}} +pass:[{{.SpaceType}}/{{.SpaceName \| replace " " "-" \| lower}}] a| [subs=-attributes] -Template string to construct general space aliases. +pass:[Template string to construct general space aliases.] |`STORAGE_USERS_OCIS_SHARE_FOLDER` | string a| [subs=-attributes] -/Shares +pass:[/Shares] a| [subs=-attributes] -Name of the folder jailing all shares. +pass:[Name of the folder jailing all shares.] |`STORAGE_USERS_S3NG_ROOT` | string a| [subs=-attributes] -~/.ocis/storage/users +pass:[~/.ocis/storage/users] a| [subs=-attributes] -Path for the persistence directory. +pass:[Path for the persistence directory.] |`STORAGE_USERS_S3NG_USER_LAYOUT` | string a| [subs=-attributes] -{{.Id.OpaqueId}} +pass:[{{.Id.OpaqueId}}] a| [subs=-attributes] -Template string for the user storage layout in the persistence directory. +pass:[Template string for the user storage layout in the persistence directory.] |`STORAGE_USERS_PERMISSION_ENDPOINT` + `STORAGE_USERS_S3NG_PERMISSIONS_ENDPOINT` | string a| [subs=-attributes] -127.0.0.1:9191 +pass:[127.0.0.1:9191] a| [subs=-attributes] -Endpoint of the permissions service. +pass:[Endpoint of the permissions service.] |`STORAGE_USERS_S3NG_REGION` | string a| [subs=-attributes] -default +pass:[default] a| [subs=-attributes] -Region of the S3 bucket. +pass:[Region of the S3 bucket.] |`STORAGE_USERS_S3NG_ACCESS_KEY` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Access key for the S3 bucket. +pass:[Access key for the S3 bucket.] |`STORAGE_USERS_S3NG_SECRET_KEY` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Secret key for the S3 bucket. +pass:[Secret key for the S3 bucket.] |`STORAGE_USERS_S3NG_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Endpoint for the S3 bucket. +pass:[Endpoint for the S3 bucket.] |`STORAGE_USERS_S3NG_BUCKET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Name of the S3 bucket. +pass:[Name of the S3 bucket.] |`STORAGE_USERS_S3NG_PERSONAL_SPACE_ALIAS_TEMPLATE` | string a| [subs=-attributes] -{{.SpaceType}}/{{.User.Username \| lower}} +pass:[{{.SpaceType}}/{{.User.Username \| lower}}] a| [subs=-attributes] -Template string to construct personal space aliases. +pass:[Template string to construct personal space aliases.] |`STORAGE_USERS_S3NG_GENERAL_SPACE_ALIAS_TEMPLATE` | string a| [subs=-attributes] -{{.SpaceType}}/{{.SpaceName \| replace " " "-" \| lower}} +pass:[{{.SpaceType}}/{{.SpaceName \| replace " " "-" \| lower}}] a| [subs=-attributes] -Template string to construct general space aliases. +pass:[Template string to construct general space aliases.] |`STORAGE_USERS_S3NG_SHARE_FOLDER` | string a| [subs=-attributes] -/Shares +pass:[/Shares] a| [subs=-attributes] -Name of the folder jailing all shares. +pass:[Name of the folder jailing all shares.] |`STORAGE_USERS_OWNCLOUDSQL_DATADIR` | string a| [subs=-attributes] -~/.ocis/storage/owncloud +pass:[~/.ocis/storage/owncloud] a| [subs=-attributes] -Path for the persistence directory. +pass:[Path for the persistence directory.] |`STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER` | string a| [subs=-attributes] -/Shares +pass:[/Shares] a| [subs=-attributes] -name of the folder jailing all shares. +pass:[name of the folder jailing all shares.] |`STORAGE_USERS_OWNCLOUDSQL_LAYOUT` | string a| [subs=-attributes] -{{.Username}} +pass:[{{.Username}}] a| [subs=-attributes] -path layout to use to navigate into a users folder in an owncloud data dir +pass:[path layout to use to navigate into a users folder in an owncloud data dir] |`STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR` | string a| [subs=-attributes] -~/.ocis/storage/uploadinfo +pass:[~/.ocis/storage/uploadinfo] a| [subs=-attributes] -Path to a directory, where uploads will be stored temporarily. +pass:[Path to a directory, where uploads will be stored temporarily.] |`STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME` | string a| [subs=-attributes] -owncloud +pass:[owncloud] a| [subs=-attributes] -Username for the database. +pass:[Username for the database.] |`STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD` | string a| [subs=-attributes] -owncloud +pass:[owncloud] a| [subs=-attributes] -Password for the database. +pass:[Password for the database.] |`STORAGE_USERS_OWNCLOUDSQL_DB_HOST` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Hostname or IP of the database server. +pass:[Hostname or IP of the database server.] |`STORAGE_USERS_OWNCLOUDSQL_DB_PORT` | int a| [subs=-attributes] -3306 +pass:[3306] a| [subs=-attributes] -Port that the database server is listening on. +pass:[Port that the database server is listening on.] |`STORAGE_USERS_OWNCLOUDSQL_DB_NAME` | string a| [subs=-attributes] -owncloud +pass:[owncloud] a| [subs=-attributes] -Name of the database to be used. +pass:[Name of the database to be used.] |`STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT` | string a| [subs=-attributes] -localhost:9144 +pass:[localhost:9144] a| [subs=-attributes] -Endpoint of the users provider. +pass:[Endpoint of the users provider.] |`STORAGE_USERS_DATA_SERVER_URL` | string a| [subs=-attributes] -\http://localhost:9158/data +pass:[http://localhost:9158/data] a| [subs=-attributes] -URL of the data server, needs to be reachable by the data gateway provided by the frontend service or the user if directly exposed. +pass:[URL of the data server, needs to be reachable by the data gateway provided by the frontend service or the user if directly exposed.] |`STORAGE_USERS_EVENTS_ENDPOINT` | string a| [subs=-attributes] -127.0.0.1:9233 +pass:[127.0.0.1:9233] a| [subs=-attributes] -the address of the streaming service +pass:[the address of the streaming service] |`STORAGE_USERS_EVENTS_CLUSTER` | string a| [subs=-attributes] -ocis-cluster +pass:[ocis-cluster] a| [subs=-attributes] -the clusterID of the streaming service. Mandatory when using nats +pass:[the clusterID of the streaming service. Mandatory when using nats] |`STORAGE_USERS_MOUNT_ID` | string a| [subs=-attributes] -1284d238-aa92-42ce-bdc4-0b0000009157 +pass:[1284d238-aa92-42ce-bdc4-0b0000009157] a| [subs=-attributes] -Mount ID of this storage. +pass:[Mount ID of this storage.] |`STORAGE_USERS_EXPOSE_DATA_SERVER` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Exposes the data server directly to users and bypasses the data gateway. Ensure that the data server address is reachable by users. +pass:[Exposes the data server directly to users and bypasses the data gateway. Ensure that the data server address is reachable by users.] |`STORAGE_USERS_READ_ONLY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Set this storage to be read-only. +pass:[Set this storage to be read-only.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/store_configvars.adoc b/services/_includes/adoc/store_configvars.adoc index ead94cb9fa8..6b8516428c7 100644 --- a/services/_includes/adoc/store_configvars.adoc +++ b/services/_includes/adoc/store_configvars.adoc @@ -11,107 +11,107 @@ `STORE_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `STORE_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `STORE_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `STORE_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `STORE_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `STORE_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `STORE_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `STORE_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`STORE_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9464 +pass:[127.0.0.1:9464] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`STORE_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`STORE_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`STORE_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`STORE_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9460 +pass:[127.0.0.1:9460] a| [subs=-attributes] -The bind address of the GRPC service. +pass:[The bind address of the GRPC service.] |`STORE_DATA_PATH` | string a| [subs=-attributes] -~/.ocis/store +pass:[~/.ocis/store] a| [subs=-attributes] -Path for the store persistence directory. +pass:[Path for the store persistence directory.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/thumbnails_configvars.adoc b/services/_includes/adoc/thumbnails_configvars.adoc index aa952f79121..04c588be236 100644 --- a/services/_includes/adoc/thumbnails_configvars.adoc +++ b/services/_includes/adoc/thumbnails_configvars.adoc @@ -11,172 +11,172 @@ `THUMBNAILS_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `THUMBNAILS_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `THUMBNAILS_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `THUMBNAILS_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `THUMBNAILS_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `THUMBNAILS_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `THUMBNAILS_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `THUMBNAILS_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`THUMBNAILS_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9189 +pass:[127.0.0.1:9189] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`THUMBNAILS_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`THUMBNAILS_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`THUMBNAILS_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`THUMBNAILS_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9185 +pass:[127.0.0.1:9185] a| [subs=-attributes] -The address off the grpc service. +pass:[The address off the grpc service.] |`THUMBNAILS_HTTP_ADDR` | string a| [subs=-attributes] -127.0.0.1:9186 +pass:[127.0.0.1:9186] a| [subs=-attributes] -The bind address of the HTTP service. +pass:[The bind address of the HTTP service.] |`THUMBNAILS_HTTP_ROOT` | string a| [subs=-attributes] -/thumbnails +pass:[/thumbnails] a| [subs=-attributes] -Subdirectory that serves as the root for this HTTP service. +pass:[Subdirectory that serves as the root for this HTTP service.] |`THUMBNAILS_RESOLUTIONS` | a| [subs=-attributes] -[16x16 32x32 64x64 128x128 1920x1080 3840x2160 7680x4320] +pass:[[16x16 32x32 64x64 128x128 1920x1080 3840x2160 7680x4320]] a| [subs=-attributes] -The supported target resolutions in the format WidthxHeight e.g. 32x32. You can provide multiple resolutions separated by a comma. +pass:[The supported target resolutions in the format WidthxHeight e.g. 32x32. You can provide multiple resolutions separated by a comma.] |`THUMBNAILS_FILESYSTEMSTORAGE_ROOT` | string a| [subs=-attributes] -~/.ocis/thumbnails +pass:[~/.ocis/thumbnails] a| [subs=-attributes] -The directory where the filesystem storage will store the thumbnails. +pass:[The directory where the filesystem storage will store the thumbnails.] |`OCIS_INSECURE` + `THUMBNAILS_WEBDAVSOURCE_INSECURE` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Ignore untrusted SSL certificates when connecting to the webdav source. +pass:[Ignore untrusted SSL certificates when connecting to the webdav source.] |`OCIS_INSECURE` + `THUMBNAILS_CS3SOURCE_INSECURE` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Ignore untrusted SSL certificates when connecting to the CS3 source. +pass:[Ignore untrusted SSL certificates when connecting to the CS3 source.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`THUMBNAILS_TXT_FONTMAP_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to a font file for txt thumbnails. +pass:[The path to a font file for txt thumbnails.] |`THUMBNAILS_TRANSFER_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to sign JWT to download the actual thumbnail file. +pass:[The secret to sign JWT to download the actual thumbnail file.] |`THUMBNAILS_DATA_ENDPOINT` | string a| [subs=-attributes] -\http://127.0.0.1:9186/thumbnails/data +pass:[http://127.0.0.1:9186/thumbnails/data] a| [subs=-attributes] -The HTTP endpoint where the actual thumbnail file can be downloaded. +pass:[The HTTP endpoint where the actual thumbnail file can be downloaded.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/users_configvars.adoc b/services/_includes/adoc/users_configvars.adoc index 6753e214e8f..61e1e2e4647 100644 --- a/services/_includes/adoc/users_configvars.adoc +++ b/services/_includes/adoc/users_configvars.adoc @@ -11,407 +11,407 @@ `USERS_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `USERS_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `USERS_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `USERS_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `USERS_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `USERS_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `USERS_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `USERS_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`USERS_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9145 +pass:[127.0.0.1:9145] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`USERS_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`USERS_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`USERS_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`USERS_GRPC_ADDR` | string a| [subs=-attributes] -127.0.0.1:9144 +pass:[127.0.0.1:9144] a| [subs=-attributes] -The bind address of the GRPC service. +pass:[The bind address of the GRPC service.] |`USERS_GRPC_PROTOCOL` | string a| [subs=-attributes] -tcp +pass:[tcp] a| [subs=-attributes] -The transport protocol of the grpc service. +pass:[The transport protocol of the grpc service.] |`OCIS_JWT_SECRET` + `USERS_JWT_SECRET` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The secret to mint and validate jwt tokens. +pass:[The secret to mint and validate jwt tokens.] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |`USERS_SKIP_USER_GROUPS_IN_TOKEN` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Disables the loading of user's group memberships from the reva access token. +pass:[Disables the loading of user's group memberships from the reva access token.] |`USERS_DRIVER` | string a| [subs=-attributes] -ldap +pass:[ldap] a| [subs=-attributes] -The user driver which should be used by the users service. Defaults to 'ldap', can be 'owncloudsql', 'json' or 'rest' +pass:[The user driver which should be used by the users service. Defaults to 'ldap', can be 'owncloudsql', 'json' or 'rest'] |`LDAP_URI` + `USERS_LDAP_URI` | string a| [subs=-attributes] -ldaps://localhost:9235 +pass:[ldaps://localhost:9235] a| [subs=-attributes] -URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://' +pass:[URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' and 'ldap://'] |`LDAP_CACERT` + `USERS_LDAP_CACERT` | string a| [subs=-attributes] -~/.ocis/idm/ldap.crt +pass:[~/.ocis/idm/ldap.crt] a| [subs=-attributes] -Path to a CA certificate file for validating the LDAP server's TLS certificate. If empty the system default CA bundle will be used. +pass:[Path to a CA certificate file for validating the LDAP server's TLS certificate. If empty the system default CA bundle will be used.] |`LDAP_INSECURE` + `USERS_LDAP_INSECURE` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Disable TLS certificate validation for the LDAP connections. Do not set this in production environments. +pass:[Disable TLS certificate validation for the LDAP connections. Do not set this in production environments.] |`LDAP_BIND_DN` + `USERS_LDAP_BIND_DN` | string a| [subs=-attributes] -uid=reva,ou=sysusers,o=libregraph-idm +pass:[uid=reva,ou=sysusers,o=libregraph-idm] a| [subs=-attributes] -LDAP DN to use for simple bind authentication with the target LDAP server. +pass:[LDAP DN to use for simple bind authentication with the target LDAP server.] |`LDAP_BIND_PASSWORD` + `USERS_LDAP_BIND_PASSWORD` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Password to use for authenticating the 'bind_dn'. +pass:[Password to use for authenticating the 'bind_dn'.] |`LDAP_USER_BASE_DN` + `USERS_LDAP_USER_BASE_DN` | string a| [subs=-attributes] -ou=users,o=libregraph-idm +pass:[ou=users,o=libregraph-idm] a| [subs=-attributes] -Search base DN for looking up LDAP users. +pass:[Search base DN for looking up LDAP users.] |`LDAP_GROUP_BASE_DN` + `USERS_LDAP_GROUP_BASE_DN` | string a| [subs=-attributes] -ou=groups,o=libregraph-idm +pass:[ou=groups,o=libregraph-idm] a| [subs=-attributes] -Search base DN for looking up LDAP groups. +pass:[Search base DN for looking up LDAP groups.] |`LDAP_USER_SCOPE` + `USERS_LDAP_USER_SCOPE` | string a| [subs=-attributes] -sub +pass:[sub] a| [subs=-attributes] -LDAP search scope to use when looking up users ('base', 'one', 'sub'). +pass:[LDAP search scope to use when looking up users ('base', 'one', 'sub').] |`LDAP_GROUP_SCOPE` + `USERS_LDAP_GROUP_SCOPE` | string a| [subs=-attributes] -sub +pass:[sub] a| [subs=-attributes] -LDAP search scope to use when looking up gruops ('base', 'one', 'sub'). +pass:[LDAP search scope to use when looking up gruops ('base', 'one', 'sub').] |`LDAP_USER_FILTER` + `USERS_LDAP_USER_FILTER` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -LDAP filter to add to the default filters for user search (e.g. '(objectclass=ownCloud)'). +pass:[LDAP filter to add to the default filters for user search (e.g. '(objectclass=ownCloud)').] |`LDAP_GROUP_FILTER` + `USERS_LDAP_GROUP_FILTER` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -LDAP filter to add to the default filters for group searches. +pass:[LDAP filter to add to the default filters for group searches.] |`LDAP_USER_OBJECTCLASS` + `USERS_LDAP_USER_OBJECTCLASS` | string a| [subs=-attributes] -inetOrgPerson +pass:[inetOrgPerson] a| [subs=-attributes] -The object class to use for users in the default user search filter ('inetOrgPerson'). +pass:[The object class to use for users in the default user search filter ('inetOrgPerson').] |`LDAP_GROUP_OBJECTCLASS` + `USERS_LDAP_GROUP_OBJECTCLASS` | string a| [subs=-attributes] -groupOfNames +pass:[groupOfNames] a| [subs=-attributes] -The object class to use for groups in the default group search filter ('groupOfNames'). +pass:[The object class to use for groups in the default group search filter ('groupOfNames'). ] |`OCIS_URL` + `OCIS_OIDC_ISSUER` + `USERS_IDP_URL` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. +pass:[The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider.] |`LDAP_USER_SCHEMA_ID` + `USERS_LDAP_USER_SCHEMA_ID` | string a| [subs=-attributes] -ownclouduuid +pass:[ownclouduuid] a| [subs=-attributes] -LDAP Attribute to use as the unique id for users. This should be a stable globally unique id (e.g. a UUID). +pass:[LDAP Attribute to use as the unique id for users. This should be a stable globally unique id (e.g. a UUID).] |`LDAP_USER_SCHEMA_ID_IS_OCTETSTRING` + `USERS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -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. +pass:[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.] |`LDAP_USER_SCHEMA_MAIL` + `USERS_LDAP_USER_SCHEMA_MAIL` | string a| [subs=-attributes] -mail +pass:[mail] a| [subs=-attributes] -LDAP Attribute to use for the email address of users. +pass:[LDAP Attribute to use for the email address of users.] |`LDAP_USER_SCHEMA_DISPLAYNAME` + `USERS_LDAP_USER_SCHEMA_DISPLAYNAME` | string a| [subs=-attributes] -displayname +pass:[displayname] a| [subs=-attributes] -LDAP Attribute to use for the displayname of users. +pass:[LDAP Attribute to use for the displayname of users.] |`LDAP_USER_SCHEMA_USERNAME` + `USERS_LDAP_USER_SCHEMA_USERNAME` | string a| [subs=-attributes] -uid +pass:[uid] a| [subs=-attributes] -LDAP Attribute to use for username of users. +pass:[LDAP Attribute to use for username of users.] |`LDAP_GROUP_SCHEMA_ID` + `USERS_LDAP_GROUP_SCHEMA_ID` | string a| [subs=-attributes] -ownclouduuid +pass:[ownclouduuid] a| [subs=-attributes] -LDAP Attribute to use as the unique id for groups. This should be a stable globally unique id (e.g. a UUID). +pass:[LDAP Attribute to use as the unique id for groups. This should be a stable globally unique id (e.g. a UUID).] |`LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING` + `USERS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -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. +pass:[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.] |`LDAP_GROUP_SCHEMA_MAIL` + `USERS_LDAP_GROUP_SCHEMA_MAIL` | string a| [subs=-attributes] -mail +pass:[mail] a| [subs=-attributes] -LDAP Attribute to use for the email address of groups (can be empty). +pass:[LDAP Attribute to use for the email address of groups (can be empty).] |`LDAP_GROUP_SCHEMA_DISPLAYNAME` + `USERS_LDAP_GROUP_SCHEMA_DISPLAYNAME` | string a| [subs=-attributes] -cn +pass:[cn] a| [subs=-attributes] -LDAP Attribute to use for the displayname of groups (often the same as groupname attribute) +pass:[LDAP Attribute to use for the displayname of groups (often the same as groupname attribute)] |`LDAP_GROUP_SCHEMA_GROUPNAME` + `USERS_LDAP_GROUP_SCHEMA_GROUPNAME` | string a| [subs=-attributes] -cn +pass:[cn] a| [subs=-attributes] -LDAP Attribute to use for the name of groups +pass:[LDAP Attribute to use for the name of groups] |`LDAP_GROUP_SCHEMA_MEMBER` + `USERS_LDAP_GROUP_SCHEMA_MEMBER` | string a| [subs=-attributes] -member +pass:[member] a| [subs=-attributes] -LDAP Attribute that is used for group members. +pass:[LDAP Attribute that is used for group members.] |`USERS_OWNCLOUDSQL_DB_USERNAME` | string a| [subs=-attributes] -owncloud +pass:[owncloud] a| [subs=-attributes] -Database user to use for authenticating with the owncloud database. +pass:[Database user to use for authenticating with the owncloud database.] |`USERS_OWNCLOUDSQL_DB_PASSWORD` | string a| [subs=-attributes] -secret +pass:[secret] a| [subs=-attributes] -Password for the database user. +pass:[Password for the database user.] |`USERS_OWNCLOUDSQL_DB_HOST` | string a| [subs=-attributes] -mysql +pass:[mysql] a| [subs=-attributes] -Hostname of the database server. +pass:[Hostname of the database server.] |`USERS_OWNCLOUDSQL_DB_PORT` | int a| [subs=-attributes] -3306 +pass:[3306] a| [subs=-attributes] -Network port to use for the database connection. +pass:[Network port to use for the database connection.] |`USERS_OWNCLOUDSQL_DB_NAME` | string a| [subs=-attributes] -owncloud +pass:[owncloud] a| [subs=-attributes] -Name of the owncloud database. +pass:[Name of the owncloud database.] |`USERS_OWNCLOUDSQL_IDP` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. +pass:[The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider.] |`USERS_OWNCLOUDSQL_NOBODY` | int64 a| [subs=-attributes] -90 +pass:[90] a| [subs=-attributes] -Fallback number if no numeric UID and GID properties are provided. +pass:[Fallback number if no numeric UID and GID properties are provided.] |`USERS_OWNCLOUDSQL_JOIN_USERNAME` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Join the user properties table to read usernames +pass:[Join the user properties table to read usernames] |`USERS_OWNCLOUDSQL_JOIN_OWNCLOUD_UUID` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Join the user properties table to read user ids (boolean). +pass:[Join the user properties table to read user ids (boolean).] |`USERS_OWNCLOUDSQL_ENABLE_MEDIAL_SEARCH` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Allow 'medial search' when searching for users instead of just doing a prefix search. (Allows finding 'Alice' when searching for 'lic'.) +pass:[Allow 'medial search' when searching for users instead of just doing a prefix search. (Allows finding 'Alice' when searching for 'lic'.)] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/web_configvars.adoc b/services/_includes/adoc/web_configvars.adoc index d885c23cd26..a5f0fc7cdaf 100644 --- a/services/_includes/adoc/web_configvars.adoc +++ b/services/_includes/adoc/web_configvars.adoc @@ -11,195 +11,195 @@ `WEB_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `WEB_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `WEB_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `WEB_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `WEB_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `WEB_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `WEB_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `WEB_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`WEB_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9104 +pass:[127.0.0.1:9104] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`WEB_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`WEB_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`WEB_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`WEB_HTTP_ADDR` | string a| [subs=-attributes] -127.0.0.1:9100 +pass:[127.0.0.1:9100] a| [subs=-attributes] -The bind address of the HTTP service. +pass:[The bind address of the HTTP service.] |`WEB_HTTP_ROOT` | string a| [subs=-attributes] -/ +pass:[/] a| [subs=-attributes] -Subdirectory that serves as the root for this HTTP service. +pass:[Subdirectory that serves as the root for this HTTP service.] |`WEB_CACHE_TTL` | int a| [subs=-attributes] -604800 +pass:[604800] a| [subs=-attributes] -Cache policy in seconds for ownCloud Web assets. +pass:[Cache policy in seconds for ownCloud Web assets.] |`WEB_ASSET_PATH` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Serve ownCloud Web assets from a path on the filesystem instead of the builtin assets. +pass:[Serve ownCloud Web assets from a path on the filesystem instead of the builtin assets.] |`WEB_UI_CONFIG` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Read the ownCloud Web configuration from this file. +pass:[Read the ownCloud Web configuration from this file.] |`WEB_UI_PATH` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Read the ownCloud Web configuration from this file path. +pass:[Read the ownCloud Web configuration from this file path.] |`OCIS_URL` + `WEB_UI_THEME_SERVER` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -URL to load themes from. Will be prepended to the theme path. +pass:[URL to load themes from. Will be prepended to the theme path.] |`WEB_UI_THEME_PATH` | string a| [subs=-attributes] -/themes/owncloud/theme.json +pass:[/themes/owncloud/theme.json] a| [subs=-attributes] -URL path to load themes from. The theme server will be prepended. +pass:[URL path to load themes from. The theme server will be prepended.] |`OCIS_URL` + `WEB_UI_CONFIG_SERVER` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -URL, where the oCIS APIs are reachable for ownCloud Web. +pass:[URL, where the oCIS APIs are reachable for ownCloud Web.] |`WEB_OIDC_METADATA_URL` | string a| [subs=-attributes] -\https://localhost:9200/.well-known/openid-configuration +pass:[https://localhost:9200/.well-known/openid-configuration] a| [subs=-attributes] -URL for the OIDC well-known configuration endpoint. Defaults to the oCIS API URL + "/.well-known/openid-configuration". +pass:[URL for the OIDC well-known configuration endpoint. Defaults to the oCIS API URL + "/.well-known/openid-configuration".] |`OCIS_URL` + `OCIS_OIDC_ISSUER` + `WEB_OIDC_AUTHORITY` | string a| [subs=-attributes] -\https://localhost:9200 +pass:[https://localhost:9200] a| [subs=-attributes] -URL of the OIDC issuer. It defaults to URL of the builtin IDP. +pass:[URL of the OIDC issuer. It defaults to URL of the builtin IDP.] |`WEB_OIDC_CLIENT_ID` | string a| [subs=-attributes] -web +pass:[web] a| [subs=-attributes] -OIDC client ID, which ownCloud Web uses. This client needs to be set up in your IDP. +pass:[OIDC client ID, which ownCloud Web uses. This client needs to be set up in your IDP.] |`WEB_OIDC_RESPONSE_TYPE` | string a| [subs=-attributes] -code +pass:[code] a| [subs=-attributes] -OIDC response type to use for authentication. +pass:[OIDC response type to use for authentication.] |`WEB_OIDC_SCOPE` | string a| [subs=-attributes] -openid profile email +pass:[openid profile email] a| [subs=-attributes] -OIDC scopes to request during authentication. +pass:[OIDC scopes to request during authentication.] |=== Since Version: `+` added, `-` deprecated diff --git a/services/_includes/adoc/webdav_configvars.adoc b/services/_includes/adoc/webdav_configvars.adoc index a330fe5cedf..416138310a5 100644 --- a/services/_includes/adoc/webdav_configvars.adoc +++ b/services/_includes/adoc/webdav_configvars.adoc @@ -11,129 +11,129 @@ `WEBDAV_TRACING_ENABLED` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates tracing. +pass:[Activates tracing.] |`OCIS_TRACING_TYPE` + `WEBDAV_TRACING_TYPE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now. +pass:[The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.] |`OCIS_TRACING_ENDPOINT` + `WEBDAV_TRACING_ENDPOINT` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The endpoint of the tracing agent. +pass:[The endpoint of the tracing agent.] |`OCIS_TRACING_COLLECTOR` + `WEBDAV_TRACING_COLLECTOR` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -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. +pass:[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.] |`OCIS_LOG_LEVEL` + `WEBDAV_LOG_LEVEL` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". +pass:[The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".] |`OCIS_LOG_PRETTY` + `WEBDAV_LOG_PRETTY` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates pretty log output. +pass:[Activates pretty log output.] |`OCIS_LOG_COLOR` + `WEBDAV_LOG_COLOR` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Activates colorized log output. +pass:[Activates colorized log output.] |`OCIS_LOG_FILE` + `WEBDAV_LOG_FILE` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -The path to the log file. Activates logging to this file if set. +pass:[The path to the log file. Activates logging to this file if set.] |`WEBDAV_DEBUG_ADDR` | string a| [subs=-attributes] -127.0.0.1:9119 +pass:[127.0.0.1:9119] a| [subs=-attributes] -Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. +pass:[Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.] |`WEBDAV_DEBUG_TOKEN` | string a| [subs=-attributes] - +pass:[] a| [subs=-attributes] -Token to secure the metrics endpoint +pass:[Token to secure the metrics endpoint] |`WEBDAV_DEBUG_PPROF` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables pprof, which can be used for profiling +pass:[Enables pprof, which can be used for profiling] |`WEBDAV_DEBUG_ZPAGES` | bool a| [subs=-attributes] -false +pass:[false] a| [subs=-attributes] -Enables zpages, which can be used for collecting and viewing in-memory traces. +pass:[Enables zpages, which can be used for collecting and viewing in-memory traces.] |`WEBDAV_HTTP_ADDR` | string a| [subs=-attributes] -127.0.0.1:9115 +pass:[127.0.0.1:9115] a| [subs=-attributes] -The bind address of the HTTP service. +pass:[The bind address of the HTTP service.] |`WEBDAV_HTTP_ROOT` | string a| [subs=-attributes] -/ +pass:[/] a| [subs=-attributes] -Subdirectory that serves as the root for this HTTP service. +pass:[Subdirectory that serves as the root for this HTTP service.] |`OCIS_URL` + `OCIS_PUBLIC_URL` | string a| [subs=-attributes] -\https://127.0.0.1:9200 +pass:[https://127.0.0.1:9200] a| [subs=-attributes] -URL, where oCIS is reachable for users. +pass:[URL, where oCIS is reachable for users.] |`WEBDAV_WEBDAV_NAMESPACE` | string a| [subs=-attributes] -/users/{{.Id.OpaqueId}} +pass:[/users/{{.Id.OpaqueId}}] a| [subs=-attributes] -CS3 path layout to use when forwarding /webdav requests +pass:[CS3 path layout to use when forwarding /webdav requests] |`REVA_GATEWAY` | string a| [subs=-attributes] -127.0.0.1:9142 +pass:[127.0.0.1:9142] a| [subs=-attributes] -The CS3 gateway endpoint. +pass:[The CS3 gateway endpoint.] |=== Since Version: `+` added, `-` deprecated diff --git a/templates/ADOC.tmpl b/templates/ADOC.tmpl index cf5ecf13d3b..74b0aef9d76 100644 --- a/templates/ADOC.tmpl +++ b/templates/ADOC.tmpl @@ -15,9 +15,9 @@ {{- end }} | {{.Type}} a| [subs=-attributes] -{{.DefaultValue}} +pass:[{{.DefaultValue}}] a| [subs=-attributes] -{{.Description}} +pass:[{{.Description}}] {{- end }} |===