[docs-only] Update env_vars.yaml

This commit is contained in:
Martin Mattel
2024-11-15 14:46:41 +01:00
parent ee61c32ab9
commit 22725da7e0

View File

@@ -3814,7 +3814,7 @@ FRONTEND_MACHINE_AUTH_API_KEY:
deprecationInfo: "" deprecationInfo: ""
FRONTEND_MAX_CONCURRENCY: FRONTEND_MAX_CONCURRENCY:
name: OCIS_MAX_CONCURRENCY;FRONTEND_MAX_CONCURRENCY name: OCIS_MAX_CONCURRENCY;FRONTEND_MAX_CONCURRENCY
defaultValue: "25" defaultValue: "1"
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
get work done faster but will also cause more load on the system. Values of 0 get work done faster but will also cause more load on the system. Values of 0
@@ -6222,10 +6222,10 @@ IDM_ADMIN_USER_ID:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
IDM_CREATE_DEMO_USERS: IDM_CREATE_DEMO_USERS:
name: SETTINGS_SETUP_DEFAULT_ASSIGNMENTS;IDM_CREATE_DEMO_USERS name: IDM_CREATE_DEMO_USERS
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: The default role assignments the demo users should be setup. description: Flag to enable or disable the creation of the demo users.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -7996,7 +7996,7 @@ OCDAV_WEBDAV_NAMESPACE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_ADMIN_USER_ID: OCIS_ADMIN_USER_ID:
name: OCIS_ADMIN_USER_ID;SETTINGS_ADMIN_USER_ID name: OCIS_ADMIN_USER_ID;IDM_ADMIN_USER_ID
defaultValue: "" defaultValue: ""
type: string type: string
description: ID of the user that should receive admin privileges. Consider that description: ID of the user that should receive admin privileges. Consider that
@@ -8026,28 +8026,28 @@ OCIS_ASYNC_UPLOADS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_AUTH_PASSWORD: OCIS_CACHE_AUTH_PASSWORD:
name: OCIS_CACHE_AUTH_PASSWORD;GRAPH_CACHE_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 cache. 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;GRAPH_CACHE_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 cache. 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-userinfo 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
@@ -8055,7 +8055,7 @@ OCIS_CACHE_DATABASE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_DISABLE_PERSISTENCE: OCIS_CACHE_DISABLE_PERSISTENCE:
name: OCIS_CACHE_DISABLE_PERSISTENCE;GRAPH_CACHE_DISABLE_PERSISTENCE name: OCIS_CACHE_DISABLE_PERSISTENCE;STORAGE_SYSTEM_CACHE_DISABLE_PERSISTENCE
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' description: Disables persistence of the cache. Only applies when store type 'nats-js-kv'
@@ -8076,7 +8076,7 @@ OCIS_CACHE_SIZE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_STORE: OCIS_CACHE_STORE:
name: OCIS_CACHE_STORE;GRAPH_CACHE_STORE name: OCIS_CACHE_STORE;STORAGE_SYSTEM_CACHE_STORE
defaultValue: memory defaultValue: memory
type: string type: string
description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'',
@@ -8086,11 +8086,11 @@ OCIS_CACHE_STORE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_STORE_NODES: OCIS_CACHE_STORE_NODES:
name: OCIS_CACHE_STORE_NODES;GRAPH_CACHE_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. This has no effect description: A list of nodes to access the configured store. This has no effect
when 'memory' store are configured. Note that the behaviour how nodes are used when 'memory' store is configured. Note that the behaviour how nodes are used
is dependent on the library of the configured store. See the Environment Variable is dependent on the library of the configured store. See the Environment Variable
Types description for more details. Types description for more details.
introductionVersion: pre5.0 introductionVersion: pre5.0
@@ -8098,18 +8098,19 @@ OCIS_CACHE_STORE_NODES:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_TTL: OCIS_CACHE_TTL:
name: OCIS_CACHE_TTL;GRAPH_CACHE_TTL name: OCIS_CACHE_TTL;STORAGE_SYSTEM_CACHE_TTL
defaultValue: 336h0m0s defaultValue: 24m0s
type: Duration type: Duration
description: Time to live for cache records in the graph. Defaults to '336h' (2 description: Default time to live for user info in the user info cache. Only applied
weeks). See the Environment Variable Types description for more details. when access tokens has no expiration. See the Environment Variable Types description
for more details.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_CREDENTIALS: OCIS_CORS_ALLOW_CREDENTIALS:
name: OCIS_CORS_ALLOW_CREDENTIALS;ACTIVITYLOG_CORS_ALLOW_CREDENTIALS name: OCIS_CORS_ALLOW_CREDENTIALS;OCDAV_CORS_ALLOW_CREDENTIALS
defaultValue: "true" defaultValue: "false"
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:
*Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.'
@@ -8118,9 +8119,11 @@ OCIS_CORS_ALLOW_CREDENTIALS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_HEADERS: OCIS_CORS_ALLOW_HEADERS:
name: OCIS_CORS_ALLOW_HEADERS;ACTIVITYLOG_CORS_ALLOW_HEADERS name: OCIS_CORS_ALLOW_HEADERS;OCDAV_CORS_ALLOW_HEADERS
defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id defaultValue: '[Origin Accept Content-Type Depth Authorization Ocs-Apirequest If-None-Match
Ocs-Apirequest]' If-Match Destination Overwrite X-Request-Id X-Requested-With Tus-Resumable Tus-Checksum-Algorithm
Upload-Concat Upload-Length Upload-Metadata Upload-Defer-Length Upload-Expires
Upload-Checksum Upload-Offset X-HTTP-Method-Override Cache-Control]'
type: '[]string' 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.
@@ -8130,8 +8133,9 @@ OCIS_CORS_ALLOW_HEADERS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_METHODS: OCIS_CORS_ALLOW_METHODS:
name: OCIS_CORS_ALLOW_METHODS;ACTIVITYLOG_CORS_ALLOW_METHODS name: OCIS_CORS_ALLOW_METHODS;OCDAV_CORS_ALLOW_METHODS
defaultValue: '[GET]' defaultValue: '[OPTIONS HEAD GET PUT POST DELETE MKCOL PROPFIND PROPPATCH MOVE COPY
REPORT SEARCH]'
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.
@@ -8141,8 +8145,8 @@ OCIS_CORS_ALLOW_METHODS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_ORIGINS: OCIS_CORS_ALLOW_ORIGINS:
name: OCIS_CORS_ALLOW_ORIGINS;ACTIVITYLOG_CORS_ALLOW_ORIGINS name: OCIS_CORS_ALLOW_ORIGINS;OCDAV_CORS_ALLOW_ORIGINS
defaultValue: '[*]' defaultValue: '[https://localhost:9200]'
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:
*Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin.
@@ -8202,7 +8206,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: 7.0.0 introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
@@ -8266,16 +8270,16 @@ OCIS_EMAIL_TEMPLATE_PATH:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_ENABLE_OCM: OCIS_ENABLE_OCM:
name: OCIS_ENABLE_OCM;GRAPH_INCLUDE_OCM_SHAREES name: OCIS_ENABLE_OCM;FRONTEND_OCS_INCLUDE_OCM_SHAREES
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Include OCM sharees when listing users. description: Include OCM sharees when listing sharees.
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 name: OCIS_EVENTS_AUTH_PASSWORD;ANTIVIRUS_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
@@ -8285,7 +8289,7 @@ OCIS_EVENTS_AUTH_PASSWORD:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EVENTS_AUTH_USERNAME: OCIS_EVENTS_AUTH_USERNAME:
name: OCIS_EVENTS_AUTH_USERNAME name: OCIS_EVENTS_AUTH_USERNAME;ANTIVIRUS_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
@@ -8295,43 +8299,43 @@ OCIS_EVENTS_AUTH_USERNAME:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EVENTS_CLUSTER: OCIS_EVENTS_CLUSTER:
name: OCIS_EVENTS_CLUSTER name: OCIS_EVENTS_CLUSTER;ANTIVIRUS_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 name: OCIS_EVENTS_ENABLE_TLS;ANTIVIRUS_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 name: OCIS_EVENTS_ENDPOINT;ANTIVIRUS_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 name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;ANTIVIRUS_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 NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. If provided ANTIVIRUS_EVENTS_TLS_INSECURE will be seen as false.
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
@@ -8368,7 +8372,7 @@ OCIS_GRPC_CLIENT_TLS_MODE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_GRPC_PROTOCOL: OCIS_GRPC_PROTOCOL:
name: OCIS_GRPC_PROTOCOL;APP_PROVIDER_GRPC_PROTOCOL name: OCIS_GRPC_PROTOCOL;STORAGE_SYSTEM_GRPC_PROTOCOL
defaultValue: "" defaultValue: ""
type: string type: string
description: The transport protocol of the GPRC service. description: The transport protocol of the GPRC service.
@@ -8408,16 +8412,16 @@ OCIS_HTTP_TLS_KEY:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_INSECURE: OCIS_INSECURE:
name: OCIS_INSECURE name: OCIS_INSECURE;OCDAV_INSECURE
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Whether to verify the server TLS certificates. description: Allow insecure connections to the GATEWAY service.
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_JWT_SECRET: OCIS_JWT_SECRET:
name: OCIS_JWT_SECRET;APP_PROVIDER_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.
@@ -8426,7 +8430,7 @@ OCIS_JWT_SECRET:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_BASE_PATH: OCIS_KEYCLOAK_BASE_PATH:
name: OCIS_KEYCLOAK_BASE_PATH;GRAPH_KEYCLOAK_BASE_PATH name: OCIS_KEYCLOAK_BASE_PATH;INVITATIONS_KEYCLOAK_BASE_PATH
defaultValue: "" defaultValue: ""
type: string type: string
description: The URL to access keycloak. description: The URL to access keycloak.
@@ -8435,16 +8439,16 @@ OCIS_KEYCLOAK_BASE_PATH:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_CLIENT_ID: OCIS_KEYCLOAK_CLIENT_ID:
name: OCIS_KEYCLOAK_CLIENT_ID;GRAPH_KEYCLOAK_CLIENT_ID name: OCIS_KEYCLOAK_CLIENT_ID;INVITATIONS_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;GRAPH_KEYCLOAK_CLIENT_REALM name: OCIS_KEYCLOAK_CLIENT_REALM;INVITATIONS_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.
@@ -8453,7 +8457,7 @@ OCIS_KEYCLOAK_CLIENT_REALM:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_CLIENT_SECRET: OCIS_KEYCLOAK_CLIENT_SECRET:
name: OCIS_KEYCLOAK_CLIENT_SECRET;GRAPH_KEYCLOAK_CLIENT_SECRET name: OCIS_KEYCLOAK_CLIENT_SECRET;INVITATIONS_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.
@@ -8462,7 +8466,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;GRAPH_KEYCLOAK_INSECURE_SKIP_VERIFY name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;INVITATIONS_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
@@ -8472,7 +8476,7 @@ OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_USER_REALM: OCIS_KEYCLOAK_USER_REALM:
name: OCIS_KEYCLOAK_USER_REALM;GRAPH_KEYCLOAK_USER_REALM name: OCIS_KEYCLOAK_USER_REALM;INVITATIONS_KEYCLOAK_USER_REALM
defaultValue: "" defaultValue: ""
type: string type: string
description: The realm users are defined. description: The realm users are defined.
@@ -8481,8 +8485,8 @@ OCIS_KEYCLOAK_USER_REALM:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_BIND_DN: OCIS_LDAP_BIND_DN:
name: OCIS_LDAP_BIND_DN;GRAPH_LDAP_BIND_DN name: OCIS_LDAP_BIND_DN;AUTH_BASIC_LDAP_BIND_DN
defaultValue: uid=libregraph,ou=sysusers,o=libregraph-idm defaultValue: uid=reva,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.
@@ -8491,7 +8495,7 @@ OCIS_LDAP_BIND_DN:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_BIND_PASSWORD: OCIS_LDAP_BIND_PASSWORD:
name: OCIS_LDAP_BIND_PASSWORD;GRAPH_LDAP_BIND_PASSWORD name: OCIS_LDAP_BIND_PASSWORD;AUTH_BASIC_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'.
@@ -8500,7 +8504,7 @@ OCIS_LDAP_BIND_PASSWORD:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_CACERT: OCIS_LDAP_CACERT:
name: OCIS_LDAP_CACERT;GRAPH_LDAP_CACERT name: OCIS_LDAP_CACERT;AUTH_BASIC_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
@@ -8511,20 +8515,20 @@ OCIS_LDAP_CACERT:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_DISABLE_USER_MECHANISM: OCIS_LDAP_DISABLE_USER_MECHANISM:
name: OCIS_LDAP_DISABLE_USER_MECHANISM;GRAPH_DISABLE_USER_MECHANISM name: OCIS_LDAP_DISABLE_USER_MECHANISM;AUTH_BASIC_DISABLE_USER_MECHANISM
defaultValue: attribute defaultValue: attribute
type: string type: string
description: An option to control the behavior for disabling users. Supported options description: An option to control the behavior for disabling users. Valid options
are 'none', 'attribute' and 'group'. If set to 'group', disabling a user via API 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. Default is 'attribute'. is not processed.
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;GRAPH_DISABLED_USERS_GROUP_DN name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;AUTH_BASIC_DISABLED_USERS_GROUP_DN
defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm 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
@@ -8534,7 +8538,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;GRAPH_LDAP_GROUP_BASE_DN name: OCIS_LDAP_GROUP_BASE_DN;AUTH_BASIC_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.
@@ -8543,7 +8547,7 @@ OCIS_LDAP_GROUP_BASE_DN:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_FILTER: OCIS_LDAP_GROUP_FILTER:
name: OCIS_LDAP_GROUP_FILTER;GRAPH_LDAP_GROUP_FILTER name: OCIS_LDAP_GROUP_FILTER;AUTH_BASIC_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.
@@ -8552,7 +8556,7 @@ OCIS_LDAP_GROUP_FILTER:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_OBJECTCLASS: OCIS_LDAP_GROUP_OBJECTCLASS:
name: OCIS_LDAP_GROUP_OBJECTCLASS;GRAPH_LDAP_GROUP_OBJECTCLASS name: OCIS_LDAP_GROUP_OBJECTCLASS;AUTH_BASIC_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
@@ -8562,7 +8566,7 @@ OCIS_LDAP_GROUP_OBJECTCLASS:
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;AUTH_BASIC_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
@@ -8572,7 +8576,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;GRAPH_LDAP_GROUP_NAME_ATTRIBUTE name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;AUTH_BASIC_LDAP_GROUP_SCHEMA_GROUPNAME
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.
@@ -8581,28 +8585,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;GRAPH_LDAP_GROUP_ID_ATTRIBUTE name: OCIS_LDAP_GROUP_SCHEMA_ID;AUTH_BASIC_LDAP_GROUP_SCHEMA_ID
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 (e.g. 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;GRAPH_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;AUTH_BASIC_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 required when using the 'objectGUID' attribute of 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute
Active Directory for the group ID's. of Active Directory for the group IDs.
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;AUTH_BASIC_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).
@@ -8611,7 +8615,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;GRAPH_LDAP_GROUP_MEMBER_ATTRIBUTE name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;AUTH_BASIC_LDAP_GROUP_SCHEMA_MEMBER
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.
@@ -8620,17 +8624,17 @@ OCIS_LDAP_GROUP_SCHEMA_MEMBER:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_SCOPE: OCIS_LDAP_GROUP_SCOPE:
name: OCIS_LDAP_GROUP_SCOPE;GRAPH_LDAP_GROUP_SEARCH_SCOPE name: OCIS_LDAP_GROUP_SCOPE;AUTH_BASIC_LDAP_GROUP_SCOPE
defaultValue: sub defaultValue: sub
type: string type: string
description: LDAP search scope to use when looking up groups. Supported scopes are description: LDAP search scope to use when looking up groups. Supported values are
'base', 'one' and 'sub'. '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;GRAPH_LDAP_INSECURE name: OCIS_LDAP_INSECURE;AUTH_BASIC_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
@@ -8640,7 +8644,7 @@ OCIS_LDAP_INSECURE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_SERVER_WRITE_ENABLED: OCIS_LDAP_SERVER_WRITE_ENABLED:
name: OCIS_LDAP_SERVER_WRITE_ENABLED;GRAPH_LDAP_SERVER_WRITE_ENABLED name: OCIS_LDAP_SERVER_WRITE_ENABLED;FRONTEND_LDAP_SERVER_WRITE_ENABLED
defaultValue: "true" 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.
@@ -8652,7 +8656,7 @@ OCIS_LDAP_SERVER_WRITE_ENABLED:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_URI: OCIS_LDAP_URI:
name: OCIS_LDAP_URI;GRAPH_LDAP_URI name: OCIS_LDAP_URI;AUTH_BASIC_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: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://'
@@ -8662,7 +8666,7 @@ OCIS_LDAP_URI:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_BASE_DN: OCIS_LDAP_USER_BASE_DN:
name: OCIS_LDAP_USER_BASE_DN;GRAPH_LDAP_USER_BASE_DN name: OCIS_LDAP_USER_BASE_DN;AUTH_BASIC_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.
@@ -8671,16 +8675,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;GRAPH_USER_ENABLED_ATTRIBUTE name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;AUTH_BASIC_LDAP_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;GRAPH_LDAP_USER_FILTER name: OCIS_LDAP_USER_FILTER;AUTH_BASIC_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)'.
@@ -8689,7 +8693,7 @@ OCIS_LDAP_USER_FILTER:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_OBJECTCLASS: OCIS_LDAP_USER_OBJECTCLASS:
name: OCIS_LDAP_USER_OBJECTCLASS;GRAPH_LDAP_USER_OBJECTCLASS name: OCIS_LDAP_USER_OBJECTCLASS;AUTH_BASIC_LDAP_USER_OBJECTCLASS
defaultValue: inetOrgPerson defaultValue: inetOrgPerson
type: string type: string
description: The object class to use for users in the default user search filter description: The object class to use for users in the default user search filter
@@ -8699,17 +8703,17 @@ OCIS_LDAP_USER_OBJECTCLASS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_DISPLAYNAME: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME:
name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;LDAP_USER_SCHEMA_DISPLAY_NAME;GRAPH_LDAP_USER_DISPLAYNAME_ATTRIBUTE name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;AUTH_BASIC_LDAP_USER_SCHEMA_DISPLAYNAME
defaultValue: displayName defaultValue: displayname
type: string type: string
description: LDAP Attribute to use for the display name of users. description: LDAP Attribute to use for the displayname 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;GRAPH_LDAP_USER_UID_ATTRIBUTE name: OCIS_LDAP_USER_SCHEMA_ID;AUTH_BASIC_LDAP_USER_SCHEMA_ID
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 Attribute to use as the unique ID for users. This should be a
stable globally unique ID like a UUID. stable globally unique ID like a UUID.
@@ -8718,18 +8722,18 @@ OCIS_LDAP_USER_SCHEMA_ID:
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;GRAPH_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;AUTH_BASIC_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 required when using the 'objectGUID' attribute of 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute
Active Directory for the user ID's. of Active Directory for the user IDs.
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;GRAPH_LDAP_USER_EMAIL_ATTRIBUTE name: OCIS_LDAP_USER_SCHEMA_MAIL;AUTH_BASIC_LDAP_USER_SCHEMA_MAIL
defaultValue: mail defaultValue: mail
type: string type: string
description: LDAP Attribute to use for the email address of users. description: LDAP Attribute to use for the email address of users.
@@ -8748,7 +8752,7 @@ 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;GRAPH_LDAP_USER_NAME_ATTRIBUTE name: OCIS_LDAP_USER_SCHEMA_USERNAME;AUTH_BASIC_LDAP_USER_SCHEMA_USERNAME
defaultValue: uid defaultValue: uid
type: string type: string
description: LDAP Attribute to use for username of users. description: LDAP Attribute to use for username of users.
@@ -8757,17 +8761,17 @@ OCIS_LDAP_USER_SCHEMA_USERNAME:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCOPE: OCIS_LDAP_USER_SCOPE:
name: OCIS_LDAP_USER_SCOPE;GRAPH_LDAP_USER_SCOPE name: OCIS_LDAP_USER_SCOPE;AUTH_BASIC_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 values are
'base', 'one' and 'sub'. 'base', 'one' and 'sub'.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_COLOR: OCIS_LOG_COLOR:
name: OCIS_LOG_COLOR;APP_PROVIDER_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.
@@ -8776,7 +8780,7 @@ OCIS_LOG_COLOR:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_FILE: OCIS_LOG_FILE:
name: OCIS_LOG_FILE;APP_PROVIDER_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.
@@ -8785,7 +8789,7 @@ OCIS_LOG_FILE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_LEVEL: OCIS_LOG_LEVEL:
name: OCIS_LOG_LEVEL;APP_PROVIDER_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'',
@@ -8795,7 +8799,7 @@ OCIS_LOG_LEVEL:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_PRETTY: OCIS_LOG_PRETTY:
name: OCIS_LOG_PRETTY;APP_PROVIDER_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.
@@ -8804,18 +8808,18 @@ OCIS_LOG_PRETTY:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_MACHINE_AUTH_API_KEY: OCIS_MACHINE_AUTH_API_KEY:
name: OCIS_MACHINE_AUTH_API_KEY;AUTH_APP_MACHINE_AUTH_API_KEY name: OCIS_MACHINE_AUTH_API_KEY;OCDAV_MACHINE_AUTH_API_KEY
defaultValue: "" defaultValue: ""
type: string type: string
description: The machine auth API key used to validate internal requests necessary description: Machine auth API key used to validate internal requests necessary for
to access resources from other services. the access to resources from other services.
introductionVersion: 7.0.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_MAX_CONCURRENCY: OCIS_MAX_CONCURRENCY:
name: OCIS_MAX_CONCURRENCY;USERLOG_MAX_CONCURRENCY name: OCIS_MAX_CONCURRENCY;FRONTEND_MAX_CONCURRENCY
defaultValue: "5" defaultValue: "1"
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
get work done faster but will also cause more load on the system. Values of 0 get work done faster but will also cause more load on the system. Values of 0
@@ -8836,16 +8840,17 @@ 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;AUTH_BASIC_IDP_URL
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 identity provider value to set in the userids of the CS3 user objects
for users returned by this user provider.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST:
name: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST;SHARING_PASSWORD_POLICY_BANNED_PASSWORDS_LIST name: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST;FRONTEND_PASSWORD_POLICY_BANNED_PASSWORDS_LIST
defaultValue: "" defaultValue: ""
type: string type: string
description: Path to the 'banned passwords list' file. This only impacts public description: Path to the 'banned passwords list' file. This only impacts public
@@ -8855,7 +8860,7 @@ OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PASSWORD_POLICY_DISABLED: OCIS_PASSWORD_POLICY_DISABLED:
name: OCIS_PASSWORD_POLICY_DISABLED;SHARING_PASSWORD_POLICY_DISABLED name: OCIS_PASSWORD_POLICY_DISABLED;FRONTEND_PASSWORD_POLICY_DISABLED
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Disable the password policy. Defaults to false if not set. description: Disable the password policy. Defaults to false if not set.
@@ -8864,7 +8869,7 @@ OCIS_PASSWORD_POLICY_DISABLED:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PASSWORD_POLICY_MIN_CHARACTERS: OCIS_PASSWORD_POLICY_MIN_CHARACTERS:
name: OCIS_PASSWORD_POLICY_MIN_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_CHARACTERS name: OCIS_PASSWORD_POLICY_MIN_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_CHARACTERS
defaultValue: "8" defaultValue: "8"
type: int type: int
description: Define the minimum password length. Defaults to 8 if not set. description: Define the minimum password length. Defaults to 8 if not set.
@@ -8873,7 +8878,7 @@ OCIS_PASSWORD_POLICY_MIN_CHARACTERS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PASSWORD_POLICY_MIN_DIGITS: OCIS_PASSWORD_POLICY_MIN_DIGITS:
name: OCIS_PASSWORD_POLICY_MIN_DIGITS;SHARING_PASSWORD_POLICY_MIN_DIGITS name: OCIS_PASSWORD_POLICY_MIN_DIGITS;FRONTEND_PASSWORD_POLICY_MIN_DIGITS
defaultValue: "1" defaultValue: "1"
type: int type: int
description: Define the minimum number of digits. Defaults to 1 if not set. description: Define the minimum number of digits. Defaults to 1 if not set.
@@ -8882,7 +8887,7 @@ OCIS_PASSWORD_POLICY_MIN_DIGITS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS:
name: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS name: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS
defaultValue: "1" defaultValue: "1"
type: int type: int
description: Define the minimum number of uppercase letters. Defaults to 1 if not description: Define the minimum number of uppercase letters. Defaults to 1 if not
@@ -8892,7 +8897,7 @@ OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS:
name: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS name: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS
defaultValue: "1" defaultValue: "1"
type: int type: int
description: Define the minimum number of characters from the special characters description: Define the minimum number of characters from the special characters
@@ -8902,7 +8907,7 @@ OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS:
name: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS name: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS
defaultValue: "1" defaultValue: "1"
type: int type: int
description: Define the minimum number of lowercase letters. Defaults to 1 if not description: Define the minimum number of lowercase letters. Defaults to 1 if not
@@ -8912,8 +8917,8 @@ 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;USERLOG_STORE
defaultValue: nats-js-kv defaultValue: memory
type: string type: string
description: 'The type of the store. Supported values are: ''memory'', ''nats-js-kv'', description: 'The type of the store. Supported values are: ''memory'', ''nats-js-kv'',
''redis-sentinel'', ''noop''. See the text description for details.' ''redis-sentinel'', ''noop''. See the text description for details.'
@@ -8922,7 +8927,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;USERLOG_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
@@ -8932,7 +8937,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;USERLOG_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
@@ -8942,8 +8947,8 @@ 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;USERLOG_STORE_NODES
defaultValue: '[127.0.0.1:9233]' defaultValue: '[]'
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
when 'memory' store is configured. Note that the behaviour how nodes are used when 'memory' store is configured. Note that the behaviour how nodes are used
@@ -8965,11 +8970,11 @@ OCIS_PERSISTENT_STORE_SIZE:
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;USERLOG_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: ""
@@ -9015,7 +9020,7 @@ OCIS_REVA_GATEWAY_TLS_MODE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SERVICE_ACCOUNT_ID: OCIS_SERVICE_ACCOUNT_ID:
name: OCIS_SERVICE_ACCOUNT_ID;ACTIVITYLOG_SERVICE_ACCOUNT_ID name: OCIS_SERVICE_ACCOUNT_ID;FRONTEND_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'
@@ -9025,7 +9030,7 @@ OCIS_SERVICE_ACCOUNT_ID:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SERVICE_ACCOUNT_SECRET: OCIS_SERVICE_ACCOUNT_SECRET:
name: OCIS_SERVICE_ACCOUNT_SECRET;ACTIVITYLOG_SERVICE_ACCOUNT_SECRET name: OCIS_SERVICE_ACCOUNT_SECRET;FRONTEND_SERVICE_ACCOUNT_SECRET
defaultValue: "" defaultValue: ""
type: string type: string
description: The service account secret. description: The service account secret.
@@ -9034,7 +9039,7 @@ OCIS_SERVICE_ACCOUNT_SECRET:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD:
name: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD;SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD name: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD;FRONTEND_OCS_PUBLIC_SHARE_MUST_HAVE_PASSWORD
defaultValue: "true" defaultValue: "true"
type: bool type: bool
description: Set this to true if you want to enforce passwords on all public shares. description: Set this to true if you want to enforce passwords on all public shares.
@@ -9043,13 +9048,11 @@ OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD: OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD:
name: OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD;SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD name: OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD;FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Set this to true if you want to enforce passwords on Uploader, Editor description: Set this to true if you want to enforce passwords for writable shares.
or Contributor shares. If not using the global OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD, Only effective if the setting for 'passwords on all public shares' is set to false.
you must define the FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD in
the frontend service.
introductionVersion: "5.0" introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -9066,18 +9069,17 @@ OCIS_SHOW_USER_EMAIL_IN_RESULTS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SPACES_MAX_QUOTA: OCIS_SPACES_MAX_QUOTA:
name: OCIS_SPACES_MAX_QUOTA;STORAGE_USERS_OCIS_MAX_QUOTA name: OCIS_SPACES_MAX_QUOTA;FRONTEND_MAX_QUOTA
defaultValue: "0" defaultValue: "0"
type: uint64 type: uint64
description: Set a global max quota for spaces in bytes. A value of 0 equals unlimited. description: Set the global max quota value in bytes. A value of 0 equals unlimited.
If not using the global OCIS_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA The value is provided via capabilities.
in the frontend service.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
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.
@@ -9086,10 +9088,10 @@ 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
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.
@@ -9107,7 +9109,7 @@ OCIS_SYSTEM_USER_IDP:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_COLLECTOR: OCIS_TRACING_COLLECTOR:
name: OCIS_TRACING_COLLECTOR;APP_PROVIDER_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.
@@ -9117,7 +9119,7 @@ OCIS_TRACING_COLLECTOR:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_ENABLED: OCIS_TRACING_ENABLED:
name: OCIS_TRACING_ENABLED;APP_PROVIDER_TRACING_ENABLED name: OCIS_TRACING_ENABLED;STORAGE_SYSTEM_TRACING_ENABLED
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Activates tracing. description: Activates tracing.
@@ -9126,7 +9128,7 @@ OCIS_TRACING_ENABLED:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_ENDPOINT: OCIS_TRACING_ENDPOINT:
name: OCIS_TRACING_ENDPOINT;APP_PROVIDER_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.
@@ -9135,7 +9137,7 @@ OCIS_TRACING_ENDPOINT:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_TYPE: OCIS_TRACING_TYPE:
name: OCIS_TRACING_TYPE;APP_PROVIDER_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'.
@@ -9154,22 +9156,21 @@ OCIS_TRANSFER_SECRET:
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: 7.0.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_URL: OCIS_URL:
name: OCIS_URL;APP_PROVIDER_WOPI_FOLDER_URL_BASE_URL name: OCIS_URL;OCDAV_PUBLIC_URL
defaultValue: https://localhost:9200/ defaultValue: https://localhost:9200
type: string type: string
description: Base url to navigate back from the app to the containing folder in description: URL where oCIS is reachable for users.
the file list.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -12322,6 +12323,17 @@ SHARING_USER_JSONCS3_CACHE_TTL:
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
SHARING_USER_JSONCS3_MAX_CONCURRENCY:
name: OCIS_MAX_CONCURRENCY;SHARING_USER_JSONCS3_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 will be used.
introductionVersion: 7.0.0
deprecationVersion: ""
removalVersion: ""
deprecationInfo: ""
SHARING_USER_JSONCS3_PROVIDER_ADDR: SHARING_USER_JSONCS3_PROVIDER_ADDR:
name: SHARING_USER_JSONCS3_PROVIDER_ADDR name: SHARING_USER_JSONCS3_PROVIDER_ADDR
defaultValue: com.owncloud.api.storage-system defaultValue: com.owncloud.api.storage-system
@@ -15064,7 +15076,7 @@ USERLOG_LOG_PRETTY:
deprecationInfo: "" deprecationInfo: ""
USERLOG_MAX_CONCURRENCY: USERLOG_MAX_CONCURRENCY:
name: OCIS_MAX_CONCURRENCY;USERLOG_MAX_CONCURRENCY name: OCIS_MAX_CONCURRENCY;USERLOG_MAX_CONCURRENCY
defaultValue: "5" defaultValue: "1"
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
get work done faster but will also cause more load on the system. Values of 0 get work done faster but will also cause more load on the system. Values of 0