Merge pull request #10299 from owncloud/env_var_yaml_update

[docs-only][chore] Regular env_vars.yaml update
This commit is contained in:
Martin
2024-10-15 13:38:52 +02:00
committed by GitHub
+126 -127
View File
@@ -7936,28 +7936,28 @@ OCIS_ASYNC_UPLOADS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_AUTH_PASSWORD: OCIS_CACHE_AUTH_PASSWORD:
name: OCIS_CACHE_AUTH_PASSWORD;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_PASSWORD name: OCIS_CACHE_AUTH_PASSWORD;GATEWAY_CREATE_HOME_CACHE_AUTH_PASSWORD
defaultValue: "" defaultValue: ""
type: string type: string
description: The password to authenticate with the store. Only applies when store description: The password to use for authentication. Only applies when store type
type 'nats-js-kv' is configured. 'nats-js-kv' is configured.
introductionVersion: "5.0" introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_AUTH_USERNAME: OCIS_CACHE_AUTH_USERNAME:
name: OCIS_CACHE_AUTH_USERNAME;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_USERNAME name: OCIS_CACHE_AUTH_USERNAME;GATEWAY_CREATE_HOME_CACHE_AUTH_USERNAME
defaultValue: "" defaultValue: ""
type: string type: string
description: The username to authenticate with the store. Only applies when store description: The username to use for authentication. Only applies when store type
type 'nats-js-kv' is configured. 'nats-js-kv' is configured.
introductionVersion: "5.0" introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_DATABASE: OCIS_CACHE_DATABASE:
name: OCIS_CACHE_DATABASE name: OCIS_CACHE_DATABASE
defaultValue: cache-userinfo defaultValue: cache-createhome
type: string type: string
description: The database name the configured store should use. description: The database name the configured store should use.
introductionVersion: pre5.0 introductionVersion: pre5.0
@@ -7965,60 +7965,61 @@ OCIS_CACHE_DATABASE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_DISABLE_PERSISTENCE: OCIS_CACHE_DISABLE_PERSISTENCE:
name: OCIS_CACHE_DISABLE_PERSISTENCE;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_DISABLE_PERSISTENCE name: OCIS_CACHE_DISABLE_PERSISTENCE;GATEWAY_CREATE_HOME_CACHE_DISABLE_PERSISTENCE
defaultValue: "true" defaultValue: "false"
type: bool type: bool
description: Disables persistence of the store. Only applies when store type 'nats-js-kv' description: Disables persistence of the create home cache. Only applies when store
is configured. Defaults to true. type 'nats-js-kv' is configured. Defaults to false.
introductionVersion: "5.0" introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_SIZE: OCIS_CACHE_SIZE:
name: OCIS_CACHE_SIZE;PROXY_OIDC_USERINFO_CACHE_SIZE name: OCIS_CACHE_SIZE;GATEWAY_CREATE_HOME_CACHE_SIZE
defaultValue: "0" defaultValue: "0"
type: int type: int
description: The maximum quantity of items in the user info cache. Only applies description: The maximum quantity of items in the cache. Only applies when store
when store type 'ocmem' is configured. Defaults to 512 which is derived from the type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package
ocmem package though not explicitly set as default. though not explicitly set as default.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_STORE: OCIS_CACHE_STORE:
name: OCIS_CACHE_STORE;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE name: OCIS_CACHE_STORE;GATEWAY_CREATE_HOME_CACHE_STORE
defaultValue: nats-js-kv defaultValue: memory
type: string type: string
description: 'The type of the signing key store. Supported values are: ''redis-sentinel'', description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'',
''nats-js-kv'' and ''ocisstoreservice'' (deprecated). See the text description ''nats-js-kv'', ''noop''. See the text description for details.'
for details.' introductionVersion: pre5.0
introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_STORE_NODES: OCIS_CACHE_STORE_NODES:
name: OCIS_CACHE_STORE_NODES;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_NODES name: OCIS_CACHE_STORE_NODES;GATEWAY_CREATE_HOME_CACHE_STORE_NODES
defaultValue: '[127.0.0.1:9233]' defaultValue: '[127.0.0.1:9233]'
type: '[]string' type: '[]string'
description: A list of nodes to access the configured store. Note that the behaviour description: A list of nodes to access the configured store. This has no effect
how nodes are used is dependent on the library of the configured store. See the when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes
Environment Variable Types description for more details. are used is dependent on the library of the configured store. See the Environment
introductionVersion: "5.0" Variable Types description for more details.
introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_TTL: OCIS_CACHE_TTL:
name: OCIS_CACHE_TTL;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_TTL name: OCIS_CACHE_TTL;GATEWAY_CREATE_HOME_CACHE_TTL
defaultValue: 12h0m0s defaultValue: 5m0s
type: Duration type: Duration
description: Default time to live for signing keys. See the Environment Variable description: Default time to live for user info in the cache. Only applied when
Types description for more details. access tokens has no expiration. See the Environment Variable Types description
introductionVersion: "5.0" for more details.
introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_CREDENTIALS: OCIS_CORS_ALLOW_CREDENTIALS:
name: OCIS_CORS_ALLOW_CREDENTIALS;AUTH_APP_CORS_ALLOW_CREDENTIALS name: OCIS_CORS_ALLOW_CREDENTIALS;WEBDAV_CORS_ALLOW_CREDENTIALS
defaultValue: "true" defaultValue: "true"
type: bool type: bool
description: 'Allow credentials for CORS.See following chapter for more details: description: 'Allow credentials for CORS.See following chapter for more details:
@@ -8028,9 +8029,9 @@ OCIS_CORS_ALLOW_CREDENTIALS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_HEADERS: OCIS_CORS_ALLOW_HEADERS:
name: OCIS_CORS_ALLOW_HEADERS;AUTH_APP_CORS_ALLOW_HEADERS name: OCIS_CORS_ALLOW_HEADERS;WEBDAV_CORS_ALLOW_HEADERS
defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id
Ocs-Apirequest]' Cache-Control]'
type: '[]string' type: '[]string'
description: 'A list of allowed CORS headers. See following chapter for more details: description: 'A list of allowed CORS headers. See following chapter for more details:
*Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers.
@@ -8040,8 +8041,8 @@ OCIS_CORS_ALLOW_HEADERS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_METHODS: OCIS_CORS_ALLOW_METHODS:
name: OCIS_CORS_ALLOW_METHODS;AUTH_APP_CORS_ALLOW_METHODS name: OCIS_CORS_ALLOW_METHODS;WEBDAV_CORS_ALLOW_METHODS
defaultValue: '[GET POST DELETE]' defaultValue: '[GET POST PUT PATCH DELETE OPTIONS]'
type: '[]string' type: '[]string'
description: 'A list of allowed CORS methods. See following chapter for more details: description: 'A list of allowed CORS methods. See following chapter for more details:
*Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method.
@@ -8051,7 +8052,7 @@ OCIS_CORS_ALLOW_METHODS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_ORIGINS: OCIS_CORS_ALLOW_ORIGINS:
name: OCIS_CORS_ALLOW_ORIGINS;AUTH_APP_CORS_ALLOW_ORIGINS name: OCIS_CORS_ALLOW_ORIGINS;WEBDAV_CORS_ALLOW_ORIGINS
defaultValue: '[*]' defaultValue: '[*]'
type: '[]string' type: '[]string'
description: 'A list of allowed CORS origins. See following chapter for more details: description: 'A list of allowed CORS origins. See following chapter for more details:
@@ -8112,7 +8113,7 @@ OCIS_DEFAULT_LANGUAGE:
type: string type: string
description: The default language used by services and the WebUI. If not defined, description: The default language used by services and the WebUI. If not defined,
English will be used as default. See the documentation for more details. English will be used as default. See the documentation for more details.
introductionVersion: '%%NEXT%%' introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
@@ -8158,7 +8159,7 @@ OCIS_DISABLE_VERSIONING:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EDITION: OCIS_EDITION:
name: OCIS_EDITION;FRONTEND_EDITION name: OCIS_EDITION;OCDAV_EDITION
defaultValue: Community defaultValue: Community
type: string type: string
description: Edition of oCIS. Used for branding purposes. description: Edition of oCIS. Used for branding purposes.
@@ -8195,72 +8196,72 @@ OCIS_ENABLE_RESHARING:
removalVersion: "" removalVersion: ""
deprecationInfo: Resharing will be removed in the future. deprecationInfo: Resharing will be removed in the future.
OCIS_EVENTS_AUTH_PASSWORD: OCIS_EVENTS_AUTH_PASSWORD:
name: OCIS_EVENTS_AUTH_PASSWORD;PROXY_EVENTS_AUTH_PASSWORD name: OCIS_EVENTS_AUTH_PASSWORD;SSE_EVENTS_AUTH_PASSWORD
defaultValue: "" defaultValue: ""
type: string type: string
description: The password to authenticate with the events broker. The events broker description: The password to authenticate with the events broker. The events broker
is the ocis service which receives and delivers events between the services. is the ocis service which receives and delivers events between the services.
introductionVersion: '%%NEXT%%' introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EVENTS_AUTH_USERNAME: OCIS_EVENTS_AUTH_USERNAME:
name: OCIS_EVENTS_AUTH_USERNAME;PROXY_EVENTS_AUTH_USERNAME name: OCIS_EVENTS_AUTH_USERNAME;SSE_EVENTS_AUTH_USERNAME
defaultValue: "" defaultValue: ""
type: string type: string
description: The username to authenticate with the events broker. The events broker description: The username to authenticate with the events broker. The events broker
is the ocis service which receives and delivers events between the services. is the ocis service which receives and delivers events between the services.
introductionVersion: '%%NEXT%%' introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EVENTS_CLUSTER: OCIS_EVENTS_CLUSTER:
name: OCIS_EVENTS_CLUSTER;PROXY_EVENTS_CLUSTER name: OCIS_EVENTS_CLUSTER;SSE_EVENTS_CLUSTER
defaultValue: ocis-cluster defaultValue: ocis-cluster
type: string type: string
description: The clusterID of the event system. The event system is the message description: The clusterID of the event system. The event system is the message
queuing service. It is used as message broker for the microservice architecture. queuing service. It is used as message broker for the microservice architecture.
introductionVersion: '%%NEXT%%' Mandatory when using NATS as event system.
introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EVENTS_ENABLE_TLS: OCIS_EVENTS_ENABLE_TLS:
name: OCIS_EVENTS_ENABLE_TLS;PROXY_EVENTS_ENABLE_TLS name: OCIS_EVENTS_ENABLE_TLS;SSE_EVENTS_ENABLE_TLS
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Enable TLS for the connection to the events broker. The events broker description: Enable TLS for the connection to the events broker. The events broker
is the ocis service which receives and delivers events between the services. is the ocis service which receives and delivers events between the services.
introductionVersion: '%%NEXT%%' introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EVENTS_ENDPOINT: OCIS_EVENTS_ENDPOINT:
name: OCIS_EVENTS_ENDPOINT;PROXY_EVENTS_ENDPOINT name: OCIS_EVENTS_ENDPOINT;SSE_EVENTS_ENDPOINT
defaultValue: 127.0.0.1:9233 defaultValue: 127.0.0.1:9233
type: string type: string
description: The address of the event system. The event system is the message queuing description: The address of the event system. The event system is the message queuing
service. It is used as message broker for the microservice architecture. Set to service. It is used as message broker for the microservice architecture.
a empty string to disable emitting events. introductionVersion: "5.0"
introductionVersion: '%%NEXT%%'
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE:
name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;PROXY_EVENTS_TLS_ROOT_CA_CERTIFICATE name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;SSE_EVENTS_TLS_ROOT_CA_CERTIFICATE
defaultValue: "" defaultValue: ""
type: string type: string
description: The root CA certificate used to validate the server's TLS certificate. description: The root CA certificate used to validate the server's TLS certificate.
If provided PROXY_EVENTS_TLS_INSECURE will be seen as false. If provided SSE_EVENTS_TLS_INSECURE will be seen as false.
introductionVersion: '%%NEXT%%' introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_GATEWAY_GRPC_ADDR: OCIS_GATEWAY_GRPC_ADDR:
name: OCIS_GATEWAY_GRPC_ADDR;STORAGE_USERS_GATEWAY_GRPC_ADDR name: OCIS_GATEWAY_GRPC_ADDR;GATEWAY_GRPC_ADDR
defaultValue: 127.0.0.1:9142 defaultValue: 127.0.0.1:9142
type: string type: string
description: The bind address of the gateway GRPC address. description: The bind address of the GRPC service.
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
@@ -8288,11 +8289,11 @@ OCIS_GRPC_CLIENT_TLS_MODE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_GRPC_PROTOCOL: OCIS_GRPC_PROTOCOL:
name: OCIS_GRPC_PROTOCOL;AUTH_APP_GRPC_PROTOCOL name: OCIS_GRPC_PROTOCOL;GROUPS_GRPC_PROTOCOL
defaultValue: "" defaultValue: ""
type: string type: string
description: The transport protocol of the GRPC service. description: The transport protocol of the GRPC service.
introductionVersion: '%%NEXT%%' introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
@@ -8328,16 +8329,16 @@ OCIS_HTTP_TLS_KEY:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_INSECURE: OCIS_INSECURE:
name: OCIS_INSECURE;PROXY_EVENTS_TLS_INSECURE name: OCIS_INSECURE;SSE_EVENTS_TLS_INSECURE
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Whether to verify the server TLS certificates. description: Whether to verify the server TLS certificates.
introductionVersion: '%%NEXT%%' introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_JWT_SECRET: OCIS_JWT_SECRET:
name: OCIS_JWT_SECRET;CLIENTLOG_JWT_SECRET name: OCIS_JWT_SECRET;SSE_JWT_SECRET
defaultValue: "" defaultValue: ""
type: string type: string
description: The secret to mint and validate jwt tokens. description: The secret to mint and validate jwt tokens.
@@ -8401,8 +8402,8 @@ OCIS_KEYCLOAK_USER_REALM:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_BIND_DN: OCIS_LDAP_BIND_DN:
name: OCIS_LDAP_BIND_DN;GROUPS_LDAP_BIND_DN name: OCIS_LDAP_BIND_DN;IDP_LDAP_BIND_DN
defaultValue: uid=reva,ou=sysusers,o=libregraph-idm defaultValue: uid=idp,ou=sysusers,o=libregraph-idm
type: string type: string
description: LDAP DN to use for simple bind authentication with the target LDAP description: LDAP DN to use for simple bind authentication with the target LDAP
server. server.
@@ -8411,7 +8412,7 @@ OCIS_LDAP_BIND_DN:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_BIND_PASSWORD: OCIS_LDAP_BIND_PASSWORD:
name: OCIS_LDAP_BIND_PASSWORD;GROUPS_LDAP_BIND_PASSWORD name: OCIS_LDAP_BIND_PASSWORD;IDP_LDAP_BIND_PASSWORD
defaultValue: "" defaultValue: ""
type: string type: string
description: Password to use for authenticating the 'bind_dn'. description: Password to use for authenticating the 'bind_dn'.
@@ -8420,12 +8421,12 @@ OCIS_LDAP_BIND_PASSWORD:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_CACERT: OCIS_LDAP_CACERT:
name: OCIS_LDAP_CACERT;GROUPS_LDAP_CACERT name: OCIS_LDAP_CACERT;IDP_LDAP_TLS_CACERT
defaultValue: /var/lib/ocis/idm/ldap.crt defaultValue: /var/lib/ocis/idm/ldap.crt
type: string type: string
description: Path/File name for the root CA certificate (in PEM format) used to description: Path/File name for the root CA certificate (in PEM format) used to
validate TLS server certificates of the LDAP service. If not defined, the root validate TLS server certificates of the LDAP service. If not defined, the root
directory derives from $OCIS_BASE_DATA_PATH/idm. directory derives from $OCIS_BASE_DATA_PATH/idp.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -8550,7 +8551,7 @@ OCIS_LDAP_GROUP_SCOPE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_INSECURE: OCIS_LDAP_INSECURE:
name: OCIS_LDAP_INSECURE;GROUPS_LDAP_INSECURE name: OCIS_LDAP_INSECURE;IDP_INSECURE
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Disable TLS certificate validation for the LDAP connections. Do not description: Disable TLS certificate validation for the LDAP connections. Do not
@@ -8572,17 +8573,16 @@ OCIS_LDAP_SERVER_WRITE_ENABLED:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_URI: OCIS_LDAP_URI:
name: OCIS_LDAP_URI;GROUPS_LDAP_URI name: OCIS_LDAP_URI;IDP_LDAP_URI
defaultValue: ldaps://localhost:9235 defaultValue: ldaps://localhost:9235
type: string type: string
description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' description: Url of the LDAP service to use as IDP.
and 'ldap://'
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_BASE_DN: OCIS_LDAP_USER_BASE_DN:
name: OCIS_LDAP_USER_BASE_DN;GROUPS_LDAP_USER_BASE_DN name: OCIS_LDAP_USER_BASE_DN;IDP_LDAP_BASE_DN
defaultValue: ou=users,o=libregraph-idm defaultValue: ou=users,o=libregraph-idm
type: string type: string
description: Search base DN for looking up LDAP users. description: Search base DN for looking up LDAP users.
@@ -8591,16 +8591,16 @@ OCIS_LDAP_USER_BASE_DN:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_ENABLED_ATTRIBUTE: OCIS_LDAP_USER_ENABLED_ATTRIBUTE:
name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;AUTH_BASIC_LDAP_USER_ENABLED_ATTRIBUTE name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;IDP_USER_ENABLED_ATTRIBUTE
defaultValue: ownCloudUserEnabled defaultValue: ownCloudUserEnabled
type: string type: string
description: LDAP attribute to use as a flag telling if the user is enabled or disabled. description: LDAP Attribute to use as a flag telling if the user is enabled or disabled.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_FILTER: OCIS_LDAP_USER_FILTER:
name: OCIS_LDAP_USER_FILTER;GROUPS_LDAP_USER_FILTER name: OCIS_LDAP_USER_FILTER;IDP_LDAP_FILTER
defaultValue: "" defaultValue: ""
type: string type: string
description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'.
@@ -8609,11 +8609,10 @@ OCIS_LDAP_USER_FILTER:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_OBJECTCLASS: OCIS_LDAP_USER_OBJECTCLASS:
name: OCIS_LDAP_USER_OBJECTCLASS;GROUPS_LDAP_USER_OBJECTCLASS name: OCIS_LDAP_USER_OBJECTCLASS;IDP_LDAP_OBJECTCLASS
defaultValue: inetOrgPerson defaultValue: inetOrgPerson
type: string type: string
description: The object class to use for users in the default user search filter description: LDAP User ObjectClass like 'inetOrgPerson'.
('inetOrgPerson').
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -8628,11 +8627,10 @@ OCIS_LDAP_USER_SCHEMA_DISPLAYNAME:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_ID: OCIS_LDAP_USER_SCHEMA_ID:
name: OCIS_LDAP_USER_SCHEMA_ID;GROUPS_LDAP_USER_SCHEMA_ID name: OCIS_LDAP_USER_SCHEMA_ID;IDP_LDAP_UUID_ATTRIBUTE
defaultValue: ownclouduuid defaultValue: ownCloudUUID
type: string type: string
description: LDAP Attribute to use as the unique id for users. This should be a description: LDAP User UUID attribute like 'uid'.
stable globally unique id like a UUID.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -8649,10 +8647,10 @@ OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_MAIL: OCIS_LDAP_USER_SCHEMA_MAIL:
name: OCIS_LDAP_USER_SCHEMA_MAIL;GROUPS_LDAP_USER_SCHEMA_MAIL name: OCIS_LDAP_USER_SCHEMA_MAIL;IDP_LDAP_EMAIL_ATTRIBUTE
defaultValue: mail defaultValue: mail
type: string type: string
description: LDAP Attribute to use for the email address of users. description: LDAP User email attribute like 'mail'.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -8668,16 +8666,16 @@ OCIS_LDAP_USER_SCHEMA_USER_TYPE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_USERNAME: OCIS_LDAP_USER_SCHEMA_USERNAME:
name: OCIS_LDAP_USER_SCHEMA_USERNAME;GROUPS_LDAP_USER_SCHEMA_USERNAME name: OCIS_LDAP_USER_SCHEMA_USERNAME;IDP_LDAP_NAME_ATTRIBUTE
defaultValue: uid defaultValue: displayName
type: string type: string
description: LDAP Attribute to use for username of users. description: LDAP User name attribute like 'displayName'.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCOPE: OCIS_LDAP_USER_SCOPE:
name: OCIS_LDAP_USER_SCOPE;GROUPS_LDAP_USER_SCOPE name: OCIS_LDAP_USER_SCOPE;IDP_LDAP_SCOPE
defaultValue: sub defaultValue: sub
type: string type: string
description: LDAP search scope to use when looking up users. Supported scopes are description: LDAP search scope to use when looking up users. Supported scopes are
@@ -8687,7 +8685,7 @@ OCIS_LDAP_USER_SCOPE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_COLOR: OCIS_LOG_COLOR:
name: OCIS_LOG_COLOR;PROXY_LOG_COLOR name: OCIS_LOG_COLOR;WEBDAV_LOG_COLOR
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Activates colorized log output. description: Activates colorized log output.
@@ -8696,7 +8694,7 @@ OCIS_LOG_COLOR:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_FILE: OCIS_LOG_FILE:
name: OCIS_LOG_FILE;PROXY_LOG_FILE name: OCIS_LOG_FILE;WEBDAV_LOG_FILE
defaultValue: "" defaultValue: ""
type: string type: string
description: The path to the log file. Activates logging to this file if set. description: The path to the log file. Activates logging to this file if set.
@@ -8705,7 +8703,7 @@ OCIS_LOG_FILE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_LEVEL: OCIS_LOG_LEVEL:
name: OCIS_LOG_LEVEL;PROXY_LOG_LEVEL name: OCIS_LOG_LEVEL;WEBDAV_LOG_LEVEL
defaultValue: "" defaultValue: ""
type: string type: string
description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'',
@@ -8715,7 +8713,7 @@ OCIS_LOG_LEVEL:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_PRETTY: OCIS_LOG_PRETTY:
name: OCIS_LOG_PRETTY;PROXY_LOG_PRETTY name: OCIS_LOG_PRETTY;WEBDAV_LOG_PRETTY
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Activates pretty log output. description: Activates pretty log output.
@@ -8724,11 +8722,11 @@ OCIS_LOG_PRETTY:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_MACHINE_AUTH_API_KEY: OCIS_MACHINE_AUTH_API_KEY:
name: OCIS_MACHINE_AUTH_API_KEY;PROXY_MACHINE_AUTH_API_KEY name: OCIS_MACHINE_AUTH_API_KEY;IDP_MACHINE_AUTH_API_KEY
defaultValue: "" defaultValue: ""
type: string type: string
description: Machine auth API key used to validate internal requests necessary to description: Machine auth API key used to validate internal requests necessary for
access resources from other services. the access to resources from other services.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -8745,10 +8743,10 @@ OCIS_OIDC_CLIENT_ID:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_OIDC_ISSUER: OCIS_OIDC_ISSUER:
name: OCIS_URL;OCIS_OIDC_ISSUER;PROXY_OIDC_ISSUER name: OCIS_URL;OCIS_OIDC_ISSUER;IDP_ISS
defaultValue: https://localhost:9200 defaultValue: https://localhost:9200
type: string type: string
description: URL of the OIDC issuer. It defaults to URL of the builtin IDP. description: The OIDC issuer URL to use.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -8821,7 +8819,7 @@ OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PERSISTENT_STORE: OCIS_PERSISTENT_STORE:
name: OCIS_PERSISTENT_STORE;ACTIVITYLOG_STORE name: OCIS_PERSISTENT_STORE;EVENTHISTORY_STORE
defaultValue: nats-js-kv defaultValue: nats-js-kv
type: string type: string
description: 'The type of the store. Supported values are: ''memory'', ''ocmem'', description: 'The type of the store. Supported values are: ''memory'', ''ocmem'',
@@ -8832,7 +8830,7 @@ OCIS_PERSISTENT_STORE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PERSISTENT_STORE_AUTH_PASSWORD: OCIS_PERSISTENT_STORE_AUTH_PASSWORD:
name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;ACTIVITYLOG_STORE_AUTH_PASSWORD name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;EVENTHISTORY_STORE_AUTH_PASSWORD
defaultValue: "" defaultValue: ""
type: string type: string
description: The password to authenticate with the store. Only applies when store description: The password to authenticate with the store. Only applies when store
@@ -8842,7 +8840,7 @@ OCIS_PERSISTENT_STORE_AUTH_PASSWORD:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PERSISTENT_STORE_AUTH_USERNAME: OCIS_PERSISTENT_STORE_AUTH_USERNAME:
name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;ACTIVITYLOG_STORE_AUTH_USERNAME name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;EVENTHISTORY_STORE_AUTH_USERNAME
defaultValue: "" defaultValue: ""
type: string type: string
description: The username to authenticate with the store. Only applies when store description: The username to authenticate with the store. Only applies when store
@@ -8852,7 +8850,7 @@ OCIS_PERSISTENT_STORE_AUTH_USERNAME:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PERSISTENT_STORE_NODES: OCIS_PERSISTENT_STORE_NODES:
name: OCIS_PERSISTENT_STORE_NODES;ACTIVITYLOG_STORE_NODES name: OCIS_PERSISTENT_STORE_NODES;EVENTHISTORY_STORE_NODES
defaultValue: '[127.0.0.1:9233]' defaultValue: '[127.0.0.1:9233]'
type: '[]string' type: '[]string'
description: A list of nodes to access the configured store. This has no effect description: A list of nodes to access the configured store. This has no effect
@@ -8864,22 +8862,22 @@ OCIS_PERSISTENT_STORE_NODES:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PERSISTENT_STORE_SIZE: OCIS_PERSISTENT_STORE_SIZE:
name: OCIS_PERSISTENT_STORE_SIZE;ACTIVITYLOG_STORE_SIZE name: OCIS_PERSISTENT_STORE_SIZE;EVENTHISTORY_STORE_SIZE
defaultValue: "0" defaultValue: "0"
type: int type: int
description: The maximum quantity of items in the store. Only applies when store description: The maximum quantity of items in the store. Only applies when store
type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package type 'ocmem' is configured. Defaults to 512 which is derived and used from the
though not explicitly set as default. ocmem package though no explicit default was set.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PERSISTENT_STORE_TTL: OCIS_PERSISTENT_STORE_TTL:
name: OCIS_PERSISTENT_STORE_TTL;ACTIVITYLOG_STORE_TTL name: OCIS_PERSISTENT_STORE_TTL;EVENTHISTORY_STORE_TTL
defaultValue: 0s defaultValue: 336h0m0s
type: Duration type: Duration
description: Time to live for events in the store. See the Environment Variable description: Time to live for events in the store. Defaults to '336h' (2 weeks).
Types description for more details. See the Environment Variable Types description for more details.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -8897,7 +8895,7 @@ OCIS_REVA_GATEWAY:
name: OCIS_REVA_GATEWAY name: OCIS_REVA_GATEWAY
defaultValue: com.owncloud.api.gateway defaultValue: com.owncloud.api.gateway
type: string type: string
description: The CS3 gateway endpoint. description: CS3 gateway used to look up user metadata
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -8925,7 +8923,7 @@ OCIS_REVA_GATEWAY_TLS_MODE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SERVICE_ACCOUNT_ID: OCIS_SERVICE_ACCOUNT_ID:
name: OCIS_SERVICE_ACCOUNT_ID;PROXY_SERVICE_ACCOUNT_ID name: OCIS_SERVICE_ACCOUNT_ID;USERLOG_SERVICE_ACCOUNT_ID
defaultValue: "" defaultValue: ""
type: string type: string
description: The ID of the service account the service should use. See the 'auth-service' description: The ID of the service account the service should use. See the 'auth-service'
@@ -8935,7 +8933,7 @@ OCIS_SERVICE_ACCOUNT_ID:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SERVICE_ACCOUNT_SECRET: OCIS_SERVICE_ACCOUNT_SECRET:
name: OCIS_SERVICE_ACCOUNT_SECRET;PROXY_SERVICE_ACCOUNT_SECRET name: OCIS_SERVICE_ACCOUNT_SECRET;USERLOG_SERVICE_ACCOUNT_SECRET
defaultValue: "" defaultValue: ""
type: string type: string
description: The service account secret. description: The service account secret.
@@ -8984,7 +8982,7 @@ OCIS_SPACES_MAX_QUOTA:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SYSTEM_USER_API_KEY: OCIS_SYSTEM_USER_API_KEY:
name: OCIS_SYSTEM_USER_API_KEY;SHARING_PUBLIC_CS3_SYSTEM_USER_API_KEY name: OCIS_SYSTEM_USER_API_KEY
defaultValue: "" defaultValue: ""
type: string type: string
description: API key for the STORAGE-SYSTEM system user. description: API key for the STORAGE-SYSTEM system user.
@@ -8993,7 +8991,7 @@ OCIS_SYSTEM_USER_API_KEY:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SYSTEM_USER_ID: OCIS_SYSTEM_USER_ID:
name: OCIS_SYSTEM_USER_ID;SHARING_PUBLIC_CS3_SYSTEM_USER_ID name: OCIS_SYSTEM_USER_ID;SETTINGS_SYSTEM_USER_ID
defaultValue: "" defaultValue: ""
type: string type: string
description: ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID description: ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID
@@ -9005,7 +9003,7 @@ OCIS_SYSTEM_USER_ID:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SYSTEM_USER_IDP: OCIS_SYSTEM_USER_IDP:
name: OCIS_SYSTEM_USER_IDP;SHARING_PUBLIC_CS3_SYSTEM_USER_IDP name: OCIS_SYSTEM_USER_IDP;SETTINGS_SYSTEM_USER_IDP
defaultValue: internal defaultValue: internal
type: string type: string
description: IDP of the oCIS STORAGE-SYSTEM system user. description: IDP of the oCIS STORAGE-SYSTEM system user.
@@ -9014,7 +9012,7 @@ OCIS_SYSTEM_USER_IDP:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_COLLECTOR: OCIS_TRACING_COLLECTOR:
name: OCIS_TRACING_COLLECTOR;PROXY_TRACING_COLLECTOR name: OCIS_TRACING_COLLECTOR;WEBDAV_TRACING_COLLECTOR
defaultValue: "" defaultValue: ""
type: string type: string
description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces.
@@ -9024,7 +9022,7 @@ OCIS_TRACING_COLLECTOR:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_ENABLED: OCIS_TRACING_ENABLED:
name: OCIS_TRACING_ENABLED;PROXY_TRACING_ENABLED name: OCIS_TRACING_ENABLED;WEBDAV_TRACING_ENABLED
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Activates tracing. description: Activates tracing.
@@ -9033,7 +9031,7 @@ OCIS_TRACING_ENABLED:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_ENDPOINT: OCIS_TRACING_ENDPOINT:
name: OCIS_TRACING_ENDPOINT;PROXY_TRACING_ENDPOINT name: OCIS_TRACING_ENDPOINT;WEBDAV_TRACING_ENDPOINT
defaultValue: "" defaultValue: ""
type: string type: string
description: The endpoint of the tracing agent. description: The endpoint of the tracing agent.
@@ -9042,7 +9040,7 @@ OCIS_TRACING_ENDPOINT:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_TYPE: OCIS_TRACING_TYPE:
name: OCIS_TRACING_TYPE;PROXY_TRACING_TYPE name: OCIS_TRACING_TYPE;WEBDAV_TRACING_TYPE
defaultValue: "" defaultValue: ""
type: string type: string
description: The type of tracing. Defaults to '', which is the same as 'jaeger'. description: The type of tracing. Defaults to '', which is the same as 'jaeger'.
@@ -9055,37 +9053,38 @@ OCIS_TRANSFER_SECRET:
name: OCIS_TRANSFER_SECRET name: OCIS_TRANSFER_SECRET
defaultValue: "" defaultValue: ""
type: string type: string
description: Transfer secret for signing file up- and download requests. description: The storage transfer secret.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRANSLATION_PATH: OCIS_TRANSLATION_PATH:
name: OCIS_TRANSLATION_PATH;ACTIVITYLOG_TRANSLATION_PATH name: OCIS_TRANSLATION_PATH;USERLOG_TRANSLATION_PATH
defaultValue: "" defaultValue: ""
type: string type: string
description: (optional) Set this to a path with custom translations to overwrite description: (optional) Set this to a path with custom translations to overwrite
the builtin translations. Note that file and folder naming rules apply, see the the builtin translations. Note that file and folder naming rules apply, see the
documentation for more details. documentation for more details.
introductionVersion: '%%NEXT%%' introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_URL: OCIS_URL:
name: OCIS_URL;OCIS_OIDC_ISSUER;PROXY_OIDC_ISSUER name: OCIS_URL;OCIS_PUBLIC_URL
defaultValue: https://localhost:9200 defaultValue: https://127.0.0.1:9200
type: string type: string
description: URL of the OIDC issuer. It defaults to URL of the builtin IDP. description: URL, where oCIS is reachable for users.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_WOPI_DISABLE_CHAT: OCIS_WOPI_DISABLE_CHAT:
name: APP_PROVIDER_WOPI_DISABLE_CHAT;OCIS_WOPI_DISABLE_CHAT name: COLLABORATION_WOPI_DISABLE_CHAT;OCIS_WOPI_DISABLE_CHAT
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Disable the chat functionality of the office app. description: Disable chat in the office web frontend. This feature applies to OnlyOffice
introductionVersion: pre5.0 and Microsoft.
introductionVersion: '%%NEXT%%'
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""