[docs-only] Update envvars.yaml based on recent changes

This commit is contained in:
Martin Mattel
2024-11-06 15:29:42 +01:00
parent 331e134398
commit 7f8b8cd124
+158 -130
View File
@@ -430,6 +430,16 @@ ANTIVIRUS_EVENTS_TLS_ROOT_CA_CERTIFICATE:
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
ANTIVIRUS_ICAP_SCAN_TIMEOUT:
name: ANTIVIRUS_ICAP_SCAN_TIMEOUT
defaultValue: 5m0s
type: Duration
description: Scan timeout for the ICAP client. Defaults to '5m' (5 minutes). See
the Environment Variable Types description for more details.
introductionVersion: "5.0"
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
ANTIVIRUS_ICAP_SERVICE: ANTIVIRUS_ICAP_SERVICE:
name: ANTIVIRUS_ICAP_SERVICE name: ANTIVIRUS_ICAP_SERVICE
defaultValue: avscan defaultValue: avscan
@@ -7975,12 +7985,12 @@ OCDAV_WEBDAV_NAMESPACE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_ADMIN_USER_ID: OCIS_ADMIN_USER_ID:
name: OCIS_ADMIN_USER_ID;STORAGE_USERS_PURGE_TRASH_BIN_USER_ID name: OCIS_ADMIN_USER_ID;IDM_ADMIN_USER_ID
defaultValue: "" defaultValue: ""
type: string type: string
description: ID of the user who collects all necessary information for deletion. description: ID of the user that should receive admin privileges. Consider that
Consider that the UUID can be encoded in some LDAP deployment configurations like the UUID can be encoded in some LDAP deployment configurations like in .ldif files.
in .ldif files. These need to be decoded beforehand. These need to be decoded beforehand.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -8005,28 +8015,28 @@ OCIS_ASYNC_UPLOADS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_AUTH_PASSWORD: OCIS_CACHE_AUTH_PASSWORD:
name: OCIS_CACHE_AUTH_PASSWORD;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_PASSWORD name: OCIS_CACHE_AUTH_PASSWORD;STORAGE_SYSTEM_CACHE_AUTH_PASSWORD
defaultValue: "" defaultValue: ""
type: string type: string
description: The password to authenticate with the store. Only applies when store description: Password for the configured store. Only applies when store type 'nats-js-kv'
type 'nats-js-kv' is configured. 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;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_USERNAME name: OCIS_CACHE_AUTH_USERNAME;STORAGE_SYSTEM_CACHE_AUTH_USERNAME
defaultValue: "" defaultValue: ""
type: string type: string
description: The username to authenticate with the store. Only applies when store description: Username for the configured store. Only applies when store type 'nats-js-kv'
type 'nats-js-kv' is configured. 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-stat defaultValue: storage-system
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
@@ -8034,11 +8044,11 @@ OCIS_CACHE_DATABASE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_DISABLE_PERSISTENCE: OCIS_CACHE_DISABLE_PERSISTENCE:
name: OCIS_CACHE_DISABLE_PERSISTENCE;FRONTEND_OCS_STAT_CACHE_DISABLE_PERSISTENCE name: OCIS_CACHE_DISABLE_PERSISTENCE;STORAGE_SYSTEM_CACHE_DISABLE_PERSISTENCE
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Disable persistence of the cache. Only applies when using the 'nats-js-kv' description: Disables persistence of the cache. Only applies when store type 'nats-js-kv'
store type. Defaults to false. is configured. Defaults to false.
introductionVersion: "5.0" introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -8055,38 +8065,40 @@ OCIS_CACHE_SIZE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_STORE: OCIS_CACHE_STORE:
name: OCIS_CACHE_STORE;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE name: OCIS_CACHE_STORE;STORAGE_SYSTEM_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'',
and ''nats-js-kv''. See the text description for details.' ''nats-js-kv'', ''noop''. See the text description for details.'
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_STORE_NODES: OCIS_CACHE_STORE_NODES:
name: OCIS_CACHE_STORE_NODES;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_NODES name: OCIS_CACHE_STORE_NODES;STORAGE_SYSTEM_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' store is configured. Note that the behaviour how nodes are used
Environment Variable Types description for more details. is dependent on the library of the configured store. See the Environment Variable
introductionVersion: "5.0" Types description for more details.
introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_TTL: OCIS_CACHE_TTL:
name: OCIS_CACHE_TTL;OCS_PRESIGNEDURL_SIGNING_KEYS_STORE_TTL name: OCIS_CACHE_TTL;STORAGE_SYSTEM_CACHE_TTL
defaultValue: 12h0m0s defaultValue: 24m0s
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 user info cache. Only applied
Types description for more details. when 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;OCS_CORS_ALLOW_CREDENTIALS name: OCIS_CORS_ALLOW_CREDENTIALS;GRAPH_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:
@@ -8096,9 +8108,9 @@ OCIS_CORS_ALLOW_CREDENTIALS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_HEADERS: OCIS_CORS_ALLOW_HEADERS:
name: OCIS_CORS_ALLOW_HEADERS;OCS_CORS_ALLOW_HEADERS name: OCIS_CORS_ALLOW_HEADERS;GRAPH_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
Cache-Control]' Purge Restore]'
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.
@@ -8108,7 +8120,7 @@ OCIS_CORS_ALLOW_HEADERS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_METHODS: OCIS_CORS_ALLOW_METHODS:
name: OCIS_CORS_ALLOW_METHODS;OCS_CORS_ALLOW_METHODS name: OCIS_CORS_ALLOW_METHODS;GRAPH_CORS_ALLOW_METHODS
defaultValue: '[GET POST PUT PATCH DELETE OPTIONS]' 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:
@@ -8119,7 +8131,7 @@ OCIS_CORS_ALLOW_METHODS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_ORIGINS: OCIS_CORS_ALLOW_ORIGINS:
name: OCIS_CORS_ALLOW_ORIGINS;OCS_CORS_ALLOW_ORIGINS name: OCIS_CORS_ALLOW_ORIGINS;GRAPH_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:
@@ -8244,16 +8256,16 @@ OCIS_EMAIL_TEMPLATE_PATH:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_ENABLE_OCM: OCIS_ENABLE_OCM:
name: OCIS_ENABLE_OCM;FRONTEND_OCS_INCLUDE_OCM_SHAREES name: OCIS_ENABLE_OCM;GRAPH_INCLUDE_OCM_SHAREES
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Include OCM sharees when listing sharees. description: Include OCM sharees when listing users.
introductionVersion: "5.0" introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EVENTS_AUTH_PASSWORD: OCIS_EVENTS_AUTH_PASSWORD:
name: OCIS_EVENTS_AUTH_PASSWORD;FRONTEND_EVENTS_AUTH_PASSWORD name: OCIS_EVENTS_AUTH_PASSWORD;NOTIFICATIONS_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
@@ -8263,7 +8275,7 @@ OCIS_EVENTS_AUTH_PASSWORD:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EVENTS_AUTH_USERNAME: OCIS_EVENTS_AUTH_USERNAME:
name: OCIS_EVENTS_AUTH_USERNAME;FRONTEND_EVENTS_AUTH_USERNAME name: OCIS_EVENTS_AUTH_USERNAME;NOTIFICATIONS_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
@@ -8273,42 +8285,42 @@ OCIS_EVENTS_AUTH_USERNAME:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EVENTS_CLUSTER: OCIS_EVENTS_CLUSTER:
name: OCIS_EVENTS_CLUSTER;FRONTEND_EVENTS_CLUSTER name: OCIS_EVENTS_CLUSTER;NOTIFICATIONS_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.
Mandatory when using NATS as event system. Mandatory when using NATS as event system.
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EVENTS_ENABLE_TLS: OCIS_EVENTS_ENABLE_TLS:
name: OCIS_EVENTS_ENABLE_TLS;FRONTEND_EVENTS_ENABLE_TLS name: OCIS_EVENTS_ENABLE_TLS;NOTIFICATIONS_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: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EVENTS_ENDPOINT: OCIS_EVENTS_ENDPOINT:
name: OCIS_EVENTS_ENDPOINT;FRONTEND_EVENTS_ENDPOINT name: OCIS_EVENTS_ENDPOINT;NOTIFICATIONS_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. service. It is used as message broker for the microservice architecture.
introductionVersion: "5.0" introductionVersion: pre5.0
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;STORAGE_USERS_EVENTS_TLS_ROOT_CA_CERTIFICATE name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;NOTIFICATIONS_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 STORAGE_USERS_EVENTS_TLS_INSECURE will be seen as false. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -8346,10 +8358,10 @@ OCIS_GRPC_CLIENT_TLS_MODE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_GRPC_PROTOCOL: OCIS_GRPC_PROTOCOL:
name: OCIS_GRPC_PROTOCOL;APP_REGISTRY_GRPC_PROTOCOL name: OCIS_GRPC_PROTOCOL;STORAGE_SYSTEM_GRPC_PROTOCOL
defaultValue: "" defaultValue: ""
type: string type: string
description: The transport protocol of the GRPC service. description: The transport protocol of the GPRC service.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -8386,16 +8398,16 @@ OCIS_HTTP_TLS_KEY:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_INSECURE: OCIS_INSECURE:
name: OCIS_INSECURE;FRONTEND_EVENTS_TLS_INSECURE name: OCIS_INSECURE;NOTIFICATIONS_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: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_JWT_SECRET: OCIS_JWT_SECRET:
name: OCIS_JWT_SECRET;OCS_JWT_SECRET name: OCIS_JWT_SECRET;STORAGE_SYSTEM_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.
@@ -8404,7 +8416,7 @@ OCIS_JWT_SECRET:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_BASE_PATH: OCIS_KEYCLOAK_BASE_PATH:
name: OCIS_KEYCLOAK_BASE_PATH;INVITATIONS_KEYCLOAK_BASE_PATH name: OCIS_KEYCLOAK_BASE_PATH;GRAPH_KEYCLOAK_BASE_PATH
defaultValue: "" defaultValue: ""
type: string type: string
description: The URL to access keycloak. description: The URL to access keycloak.
@@ -8413,16 +8425,16 @@ OCIS_KEYCLOAK_BASE_PATH:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_CLIENT_ID: OCIS_KEYCLOAK_CLIENT_ID:
name: OCIS_KEYCLOAK_CLIENT_ID;INVITATIONS_KEYCLOAK_CLIENT_ID name: OCIS_KEYCLOAK_CLIENT_ID;GRAPH_KEYCLOAK_CLIENT_ID
defaultValue: "" defaultValue: ""
type: string type: string
description: The client ID to authenticate with keycloak. description: The client id to authenticate with keycloak.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_CLIENT_REALM: OCIS_KEYCLOAK_CLIENT_REALM:
name: OCIS_KEYCLOAK_CLIENT_REALM;INVITATIONS_KEYCLOAK_CLIENT_REALM name: OCIS_KEYCLOAK_CLIENT_REALM;GRAPH_KEYCLOAK_CLIENT_REALM
defaultValue: "" defaultValue: ""
type: string type: string
description: The realm the client is defined in. description: The realm the client is defined in.
@@ -8431,7 +8443,7 @@ OCIS_KEYCLOAK_CLIENT_REALM:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_CLIENT_SECRET: OCIS_KEYCLOAK_CLIENT_SECRET:
name: OCIS_KEYCLOAK_CLIENT_SECRET;INVITATIONS_KEYCLOAK_CLIENT_SECRET name: OCIS_KEYCLOAK_CLIENT_SECRET;GRAPH_KEYCLOAK_CLIENT_SECRET
defaultValue: "" defaultValue: ""
type: string type: string
description: The client secret to use in authentication. description: The client secret to use in authentication.
@@ -8440,7 +8452,7 @@ OCIS_KEYCLOAK_CLIENT_SECRET:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY:
name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;INVITATIONS_KEYCLOAK_INSECURE_SKIP_VERIFY name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;GRAPH_KEYCLOAK_INSECURE_SKIP_VERIFY
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Disable TLS certificate validation for Keycloak connections. Do not description: Disable TLS certificate validation for Keycloak connections. Do not
@@ -8450,7 +8462,7 @@ OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_USER_REALM: OCIS_KEYCLOAK_USER_REALM:
name: OCIS_KEYCLOAK_USER_REALM;INVITATIONS_KEYCLOAK_USER_REALM name: OCIS_KEYCLOAK_USER_REALM;GRAPH_KEYCLOAK_USER_REALM
defaultValue: "" defaultValue: ""
type: string type: string
description: The realm users are defined. description: The realm users are defined.
@@ -8459,8 +8471,8 @@ OCIS_KEYCLOAK_USER_REALM:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_BIND_DN: OCIS_LDAP_BIND_DN:
name: OCIS_LDAP_BIND_DN;IDP_LDAP_BIND_DN name: OCIS_LDAP_BIND_DN;GRAPH_LDAP_BIND_DN
defaultValue: uid=idp,ou=sysusers,o=libregraph-idm defaultValue: uid=libregraph,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.
@@ -8469,7 +8481,7 @@ OCIS_LDAP_BIND_DN:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_BIND_PASSWORD: OCIS_LDAP_BIND_PASSWORD:
name: OCIS_LDAP_BIND_PASSWORD;IDP_LDAP_BIND_PASSWORD name: OCIS_LDAP_BIND_PASSWORD;GRAPH_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'.
@@ -8478,31 +8490,31 @@ OCIS_LDAP_BIND_PASSWORD:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_CACERT: OCIS_LDAP_CACERT:
name: OCIS_LDAP_CACERT;IDP_LDAP_TLS_CACERT name: OCIS_LDAP_CACERT;GRAPH_LDAP_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/idp. directory derives from $OCIS_BASE_DATA_PATH/idm.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_DISABLE_USER_MECHANISM: OCIS_LDAP_DISABLE_USER_MECHANISM:
name: OCIS_LDAP_DISABLE_USER_MECHANISM;USERS_LDAP_DISABLE_USER_MECHANISM name: OCIS_LDAP_DISABLE_USER_MECHANISM;GRAPH_DISABLE_USER_MECHANISM
defaultValue: attribute defaultValue: attribute
type: string type: string
description: An option to control the behavior for disabling users. Valid options description: An option to control the behavior for disabling users. Supported options
are 'none', 'attribute' and 'group'. If set to 'group', disabling a user via API are 'none', 'attribute' and 'group'. If set to 'group', disabling a user via API
will add the user to the configured group for disabled users, if set to 'attribute' will add the user to the configured group for disabled users, if set to 'attribute'
this will be done in the ldap user entry, if set to 'none' the disable request this will be done in the ldap user entry, if set to 'none' the disable request
is not processed. is not processed. Default is 'attribute'.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_DISABLED_USERS_GROUP_DN: OCIS_LDAP_DISABLED_USERS_GROUP_DN:
name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;USERS_LDAP_DISABLED_USERS_GROUP_DN name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;GRAPH_DISABLED_USERS_GROUP_DN
defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm
type: string type: string
description: The distinguished name of the group to which added users will be classified description: The distinguished name of the group to which added users will be classified
@@ -8512,7 +8524,7 @@ OCIS_LDAP_DISABLED_USERS_GROUP_DN:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_BASE_DN: OCIS_LDAP_GROUP_BASE_DN:
name: OCIS_LDAP_GROUP_BASE_DN;USERS_LDAP_GROUP_BASE_DN name: OCIS_LDAP_GROUP_BASE_DN;GRAPH_LDAP_GROUP_BASE_DN
defaultValue: ou=groups,o=libregraph-idm defaultValue: ou=groups,o=libregraph-idm
type: string type: string
description: Search base DN for looking up LDAP groups. description: Search base DN for looking up LDAP groups.
@@ -8521,7 +8533,7 @@ OCIS_LDAP_GROUP_BASE_DN:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_FILTER: OCIS_LDAP_GROUP_FILTER:
name: OCIS_LDAP_GROUP_FILTER;USERS_LDAP_GROUP_FILTER name: OCIS_LDAP_GROUP_FILTER;GRAPH_LDAP_GROUP_FILTER
defaultValue: "" defaultValue: ""
type: string type: string
description: LDAP filter to add to the default filters for group searches. description: LDAP filter to add to the default filters for group searches.
@@ -8530,17 +8542,17 @@ OCIS_LDAP_GROUP_FILTER:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_OBJECTCLASS: OCIS_LDAP_GROUP_OBJECTCLASS:
name: OCIS_LDAP_GROUP_OBJECTCLASS;USERS_LDAP_GROUP_OBJECTCLASS name: OCIS_LDAP_GROUP_OBJECTCLASS;GRAPH_LDAP_GROUP_OBJECTCLASS
defaultValue: groupOfNames defaultValue: groupOfNames
type: string type: string
description: The object class to use for groups in the default group search filter description: The object class to use for groups in the default group search filter
like 'groupOfNames'. ('groupOfNames').
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME:
name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;USERS_LDAP_GROUP_SCHEMA_DISPLAYNAME name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;GROUPS_LDAP_GROUP_SCHEMA_DISPLAYNAME
defaultValue: cn defaultValue: cn
type: string type: string
description: LDAP Attribute to use for the displayname of groups (often the same description: LDAP Attribute to use for the displayname of groups (often the same
@@ -8550,7 +8562,7 @@ OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_GROUPNAME: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME:
name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;USERS_LDAP_GROUP_SCHEMA_GROUPNAME name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;GRAPH_LDAP_GROUP_NAME_ATTRIBUTE
defaultValue: cn defaultValue: cn
type: string type: string
description: LDAP Attribute to use for the name of groups. description: LDAP Attribute to use for the name of groups.
@@ -8559,28 +8571,28 @@ OCIS_LDAP_GROUP_SCHEMA_GROUPNAME:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_ID: OCIS_LDAP_GROUP_SCHEMA_ID:
name: OCIS_LDAP_GROUP_SCHEMA_ID;USERS_LDAP_GROUP_SCHEMA_ID name: OCIS_LDAP_GROUP_SCHEMA_ID;GRAPH_LDAP_GROUP_ID_ATTRIBUTE
defaultValue: ownclouduuid defaultValue: owncloudUUID
type: string type: string
description: LDAP Attribute to use as the unique ID for groups. This should be a description: LDAP Attribute to use as the unique id for groups. This should be a
stable globally unique ID like a UUID. stable globally unique ID like a UUID.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING:
name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;USERS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;GRAPH_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Set this to true if the defined 'id' attribute for groups is of the description: Set this to true if the defined 'ID' attribute for groups is of the
'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute 'OCTETSTRING' syntax. This is required when using the 'objectGUID' attribute of
of Active Directory for the group ID's. Active Directory for the group ID's.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_MAIL: OCIS_LDAP_GROUP_SCHEMA_MAIL:
name: OCIS_LDAP_GROUP_SCHEMA_MAIL;USERS_LDAP_GROUP_SCHEMA_MAIL name: OCIS_LDAP_GROUP_SCHEMA_MAIL;GROUPS_LDAP_GROUP_SCHEMA_MAIL
defaultValue: mail defaultValue: mail
type: string type: string
description: LDAP Attribute to use for the email address of groups (can be empty). description: LDAP Attribute to use for the email address of groups (can be empty).
@@ -8589,7 +8601,7 @@ OCIS_LDAP_GROUP_SCHEMA_MAIL:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_MEMBER: OCIS_LDAP_GROUP_SCHEMA_MEMBER:
name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;USERS_LDAP_GROUP_SCHEMA_MEMBER name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;GRAPH_LDAP_GROUP_MEMBER_ATTRIBUTE
defaultValue: member defaultValue: member
type: string type: string
description: LDAP Attribute that is used for group members. description: LDAP Attribute that is used for group members.
@@ -8598,17 +8610,17 @@ OCIS_LDAP_GROUP_SCHEMA_MEMBER:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_SCOPE: OCIS_LDAP_GROUP_SCOPE:
name: OCIS_LDAP_GROUP_SCOPE;USERS_LDAP_GROUP_SCOPE name: OCIS_LDAP_GROUP_SCOPE;GRAPH_LDAP_GROUP_SEARCH_SCOPE
defaultValue: sub defaultValue: sub
type: string type: string
description: LDAP search scope to use when looking up groups. Supported values are description: LDAP search scope to use when looking up groups. Supported scopes are
'base', 'one' and 'sub'. 'base', 'one' and 'sub'.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_INSECURE: OCIS_LDAP_INSECURE:
name: OCIS_LDAP_INSECURE;IDP_INSECURE name: OCIS_LDAP_INSECURE;GRAPH_LDAP_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
@@ -8618,7 +8630,7 @@ OCIS_LDAP_INSECURE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_SERVER_WRITE_ENABLED: OCIS_LDAP_SERVER_WRITE_ENABLED:
name: OCIS_LDAP_SERVER_WRITE_ENABLED;FRONTEND_LDAP_SERVER_WRITE_ENABLED name: OCIS_LDAP_SERVER_WRITE_ENABLED;GRAPH_LDAP_SERVER_WRITE_ENABLED
defaultValue: "true" defaultValue: "true"
type: bool type: bool
description: Allow creating, modifying and deleting LDAP users via the GRAPH API. description: Allow creating, modifying and deleting LDAP users via the GRAPH API.
@@ -8630,16 +8642,17 @@ OCIS_LDAP_SERVER_WRITE_ENABLED:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_URI: OCIS_LDAP_URI:
name: OCIS_LDAP_URI;IDP_LDAP_URI name: OCIS_LDAP_URI;GRAPH_LDAP_URI
defaultValue: ldaps://localhost:9235 defaultValue: ldaps://localhost:9235
type: string type: string
description: Url of the LDAP service to use as IDP. description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://'
and 'ldap://'
introductionVersion: 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;IDP_LDAP_BASE_DN name: OCIS_LDAP_USER_BASE_DN;GRAPH_LDAP_USER_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.
@@ -8648,7 +8661,7 @@ 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;IDP_USER_ENABLED_ATTRIBUTE name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;GRAPH_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.
@@ -8657,7 +8670,7 @@ OCIS_LDAP_USER_ENABLED_ATTRIBUTE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_FILTER: OCIS_LDAP_USER_FILTER:
name: OCIS_LDAP_USER_FILTER;IDP_LDAP_FILTER name: OCIS_LDAP_USER_FILTER;GRAPH_LDAP_USER_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)'.
@@ -8666,54 +8679,56 @@ OCIS_LDAP_USER_FILTER:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_OBJECTCLASS: OCIS_LDAP_USER_OBJECTCLASS:
name: OCIS_LDAP_USER_OBJECTCLASS;IDP_LDAP_OBJECTCLASS name: OCIS_LDAP_USER_OBJECTCLASS;GRAPH_LDAP_USER_OBJECTCLASS
defaultValue: inetOrgPerson defaultValue: inetOrgPerson
type: string type: string
description: LDAP User ObjectClass like 'inetOrgPerson'. description: The object class to use for users in the default user search filter
('inetOrgPerson').
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_DISPLAYNAME: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME:
name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;USERS_LDAP_USER_SCHEMA_DISPLAYNAME name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;LDAP_USER_SCHEMA_DISPLAY_NAME;GRAPH_LDAP_USER_DISPLAYNAME_ATTRIBUTE
defaultValue: displayname defaultValue: displayName
type: string type: string
description: LDAP Attribute to use for the displayname of users. description: LDAP Attribute to use for the display name of users.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_ID: OCIS_LDAP_USER_SCHEMA_ID:
name: OCIS_LDAP_USER_SCHEMA_ID;IDP_LDAP_UUID_ATTRIBUTE name: OCIS_LDAP_USER_SCHEMA_ID;GRAPH_LDAP_USER_UID_ATTRIBUTE
defaultValue: ownCloudUUID defaultValue: owncloudUUID
type: string type: string
description: LDAP User UUID attribute like 'uid'. description: LDAP Attribute to use as the unique ID for users. This should be a
stable globally unique ID like a UUID.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING:
name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;USERS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;GRAPH_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Set this to true if the defined 'ID' attribute for users is of the description: Set this to true if the defined 'ID' attribute for users is of the
'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute 'OCTETSTRING' syntax. This is required when using the 'objectGUID' attribute of
of Active Directory for the user ID's. Active Directory for the user ID's.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_MAIL: OCIS_LDAP_USER_SCHEMA_MAIL:
name: OCIS_LDAP_USER_SCHEMA_MAIL;IDP_LDAP_EMAIL_ATTRIBUTE name: OCIS_LDAP_USER_SCHEMA_MAIL;GRAPH_LDAP_USER_EMAIL_ATTRIBUTE
defaultValue: mail defaultValue: mail
type: string type: string
description: LDAP User email attribute like 'mail'. description: LDAP Attribute to use for the email address of users.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_USER_TYPE: OCIS_LDAP_USER_SCHEMA_USER_TYPE:
name: OCIS_LDAP_USER_SCHEMA_USER_TYPE;USERS_LDAP_USER_TYPE_ATTRIBUTE name: OCIS_LDAP_USER_SCHEMA_USER_TYPE;GRAPH_LDAP_USER_TYPE_ATTRIBUTE
defaultValue: ownCloudUserType defaultValue: ownCloudUserType
type: string type: string
description: LDAP Attribute to distinguish between 'Member' and 'Guest' users. Default description: LDAP Attribute to distinguish between 'Member' and 'Guest' users. Default
@@ -8723,16 +8738,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;IDP_LDAP_NAME_ATTRIBUTE name: OCIS_LDAP_USER_SCHEMA_USERNAME;GRAPH_LDAP_USER_NAME_ATTRIBUTE
defaultValue: displayName defaultValue: uid
type: string type: string
description: LDAP User name attribute like 'displayName'. description: LDAP Attribute to use for username of users.
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;IDP_LDAP_SCOPE name: OCIS_LDAP_USER_SCOPE;GRAPH_LDAP_USER_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
@@ -8742,7 +8757,7 @@ OCIS_LDAP_USER_SCOPE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_COLOR: OCIS_LOG_COLOR:
name: OCIS_LOG_COLOR;OCS_LOG_COLOR name: OCIS_LOG_COLOR;STORAGE_SYSTEM_LOG_COLOR
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Activates colorized log output. description: Activates colorized log output.
@@ -8751,7 +8766,7 @@ OCIS_LOG_COLOR:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_FILE: OCIS_LOG_FILE:
name: OCIS_LOG_FILE;OCS_LOG_FILE name: OCIS_LOG_FILE;STORAGE_SYSTEM_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.
@@ -8760,7 +8775,7 @@ OCIS_LOG_FILE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_LEVEL: OCIS_LOG_LEVEL:
name: OCIS_LOG_LEVEL;OCS_LOG_LEVEL name: OCIS_LOG_LEVEL;STORAGE_SYSTEM_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'',
@@ -8770,7 +8785,7 @@ OCIS_LOG_LEVEL:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_PRETTY: OCIS_LOG_PRETTY:
name: OCIS_LOG_PRETTY;OCS_LOG_PRETTY name: OCIS_LOG_PRETTY;STORAGE_SYSTEM_LOG_PRETTY
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Activates pretty log output. description: Activates pretty log output.
@@ -8788,6 +8803,17 @@ OCIS_MACHINE_AUTH_API_KEY:
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_MAX_CONCURRENCY:
name: OCIS_MAX_CONCURRENCY;STORAGE_USERS_S3NG_MAX_CONCURRENCY
defaultValue: "5"
type: int
description: Maximum number of concurrent go-routines. Higher values can potentially
get work done faster but will also cause more load on the system. Values of 0
or below will be ignored and the default value of 100 will be used.
introductionVersion: pre5.0
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
OCIS_OIDC_CLIENT_ID: OCIS_OIDC_CLIENT_ID:
name: OCIS_OIDC_CLIENT_ID;WEB_OIDC_CLIENT_ID name: OCIS_OIDC_CLIENT_ID;WEB_OIDC_CLIENT_ID
defaultValue: web defaultValue: web
@@ -8979,7 +9005,7 @@ OCIS_REVA_GATEWAY_TLS_MODE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SERVICE_ACCOUNT_ID: OCIS_SERVICE_ACCOUNT_ID:
name: OCIS_SERVICE_ACCOUNT_ID;FRONTEND_SERVICE_ACCOUNT_ID name: OCIS_SERVICE_ACCOUNT_ID;NOTIFICATIONS_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'
@@ -8989,7 +9015,7 @@ OCIS_SERVICE_ACCOUNT_ID:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SERVICE_ACCOUNT_SECRET: OCIS_SERVICE_ACCOUNT_SECRET:
name: OCIS_SERVICE_ACCOUNT_SECRET;FRONTEND_SERVICE_ACCOUNT_SECRET name: OCIS_SERVICE_ACCOUNT_SECRET;NOTIFICATIONS_SERVICE_ACCOUNT_SECRET
defaultValue: "" defaultValue: ""
type: string type: string
description: The service account secret. description: The service account secret.
@@ -9047,10 +9073,10 @@ OCIS_SYSTEM_USER_API_KEY:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SYSTEM_USER_ID: OCIS_SYSTEM_USER_ID:
name: OCIS_SYSTEM_USER_ID;SETTINGS_SYSTEM_USER_ID name: OCIS_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
for the STORAGE-SYSTEM system user in this config option which is then used to 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 reference the user. Any reasonable long string is possible, preferably this would
be an UUIDv4 format. be an UUIDv4 format.
@@ -9068,7 +9094,7 @@ OCIS_SYSTEM_USER_IDP:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_COLLECTOR: OCIS_TRACING_COLLECTOR:
name: OCIS_TRACING_COLLECTOR;OCS_TRACING_COLLECTOR name: OCIS_TRACING_COLLECTOR;STORAGE_SYSTEM_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.
@@ -9078,7 +9104,7 @@ OCIS_TRACING_COLLECTOR:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_ENABLED: OCIS_TRACING_ENABLED:
name: OCIS_TRACING_ENABLED;OCS_TRACING_ENABLED name: OCIS_TRACING_ENABLED;STORAGE_SYSTEM_TRACING_ENABLED
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Activates tracing. description: Activates tracing.
@@ -9087,7 +9113,7 @@ OCIS_TRACING_ENABLED:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_ENDPOINT: OCIS_TRACING_ENDPOINT:
name: OCIS_TRACING_ENDPOINT;OCS_TRACING_ENDPOINT name: OCIS_TRACING_ENDPOINT;STORAGE_SYSTEM_TRACING_ENDPOINT
defaultValue: "" defaultValue: ""
type: string type: string
description: The endpoint of the tracing agent. description: The endpoint of the tracing agent.
@@ -9096,7 +9122,7 @@ OCIS_TRACING_ENDPOINT:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_TYPE: OCIS_TRACING_TYPE:
name: OCIS_TRACING_TYPE;OCS_TRACING_TYPE name: OCIS_TRACING_TYPE;STORAGE_SYSTEM_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'.
@@ -9115,7 +9141,7 @@ OCIS_TRANSFER_SECRET:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRANSLATION_PATH: OCIS_TRANSLATION_PATH:
name: OCIS_TRANSLATION_PATH;USERLOG_TRANSLATION_PATH name: OCIS_TRANSLATION_PATH;NOTIFICATIONS_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
@@ -9126,20 +9152,22 @@ OCIS_TRANSLATION_PATH:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_URL: OCIS_URL:
name: OCIS_URL;FRONTEND_PUBLIC_URL name: OCIS_URL;NOTIFICATIONS_WEB_UI_URL
defaultValue: https://localhost:9200 defaultValue: https://localhost:9200
type: string type: string
description: The public facing URL of the oCIS frontend. description: The public facing URL of the oCIS Web UI, used e.g. when sending notification
eMails
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: 7.0.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
@@ -12560,7 +12588,7 @@ SSE_KEEPALIVE_INTERVAL:
type: Duration type: Duration
description: To prevent intermediate proxies from closing the SSE connection, send description: To prevent intermediate proxies from closing the SSE connection, send
periodic SSE comments to keep it open. periodic SSE comments to keep it open.
introductionVersion: "7.0" introductionVersion: 7.0.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
@@ -13856,7 +13884,7 @@ STORAGE_USERS_OCIS_MAX_ACQUIRE_LOCK_CYCLES:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
STORAGE_USERS_OCIS_MAX_CONCURRENCY: STORAGE_USERS_OCIS_MAX_CONCURRENCY:
name: STORAGE_USERS_OCIS_MAX_CONCURRENCY name: OCIS_MAX_CONCURRENCY;STORAGE_USERS_OCIS_MAX_CONCURRENCY
defaultValue: "5" defaultValue: "5"
type: int type: int
description: Maximum number of concurrent go-routines. Higher values can potentially description: Maximum number of concurrent go-routines. Higher values can potentially
@@ -14247,7 +14275,7 @@ STORAGE_USERS_S3NG_MAX_ACQUIRE_LOCK_CYCLES:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
STORAGE_USERS_S3NG_MAX_CONCURRENCY: STORAGE_USERS_S3NG_MAX_CONCURRENCY:
name: STORAGE_USERS_S3NG_MAX_CONCURRENCY name: OCIS_MAX_CONCURRENCY;STORAGE_USERS_S3NG_MAX_CONCURRENCY
defaultValue: "5" defaultValue: "5"
type: int type: int
description: Maximum number of concurrent go-routines. Higher values can potentially description: Maximum number of concurrent go-routines. Higher values can potentially