From d515e264188801eb45c356720fd76c836f4c4918 Mon Sep 17 00:00:00 2001 From: Martin Mattel Date: Tue, 18 Aug 2026 15:31:27 +0200 Subject: [PATCH] fix: [8.1] the env_vars.yaml file had incorrect data --- .../services/persistent_files/env_vars.yaml | 965 +++++++++--------- 1 file changed, 479 insertions(+), 486 deletions(-) diff --git a/ocis_helpers/services/persistent_files/env_vars.yaml b/ocis_helpers/services/persistent_files/env_vars.yaml index 1ca8c186..77a95172 100644 --- a/ocis_helpers/services/persistent_files/env_vars.yaml +++ b/ocis_helpers/services/persistent_files/env_vars.yaml @@ -813,11 +813,12 @@ APP_PROVIDER_WOPI_APP_URL: removalVersion: "" deprecationInfo: "" APP_PROVIDER_WOPI_DISABLE_CHAT: - name: APP_PROVIDER_WOPI_DISABLE_CHAT;OCIS_WOPI_DISABLE_CHAT + name: COLLABORATION_WOPI_DISABLE_CHAT;OCIS_WOPI_DISABLE_CHAT defaultValue: "false" type: bool - description: Disable the chat functionality of the office app. - introductionVersion: pre5.0 + description: Disable chat in the office web frontend. This feature applies to OnlyOffice + and Microsoft. + introductionVersion: 7.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -1515,7 +1516,7 @@ AUTH_BASIC_DEBUG_ZPAGES: removalVersion: "" deprecationInfo: "" AUTH_BASIC_DISABLE_USER_MECHANISM: - name: OCIS_LDAP_DISABLE_USER_MECHANISM;USERS_LDAP_DISABLE_USER_MECHANISM + name: OCIS_LDAP_DISABLE_USER_MECHANISM;AUTH_BASIC_DISABLE_USER_MECHANISM defaultValue: attribute type: string description: An option to control the behavior for disabling users. Valid options @@ -1528,7 +1529,7 @@ AUTH_BASIC_DISABLE_USER_MECHANISM: removalVersion: "" deprecationInfo: "" AUTH_BASIC_DISABLED_USERS_GROUP_DN: - name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;USERS_LDAP_DISABLED_USERS_GROUP_DN + name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;AUTH_BASIC_DISABLED_USERS_GROUP_DN defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm type: string description: The distinguished name of the group to which added users will be classified @@ -1547,8 +1548,8 @@ AUTH_BASIC_GRPC_ADDR: removalVersion: "" deprecationInfo: "" AUTH_BASIC_GRPC_PROTOCOL: - name: OCIS_GRPC_PROTOCOL;APP_REGISTRY_GRPC_PROTOCOL - defaultValue: "" + name: OCIS_GRPC_PROTOCOL;AUTH_BASIC_GRPC_PROTOCOL + defaultValue: tcp type: string description: The transport protocol of the GRPC service. introductionVersion: pre5.0 @@ -1556,17 +1557,17 @@ AUTH_BASIC_GRPC_PROTOCOL: removalVersion: "" deprecationInfo: "" AUTH_BASIC_IDP_URL: - name: OCIS_URL;APP_PROVIDER_WOPI_FOLDER_URL_BASE_URL - defaultValue: https://localhost:9200/ + name: OCIS_URL;OCIS_OIDC_ISSUER;AUTH_BASIC_IDP_URL + defaultValue: https://localhost:9200 type: string - description: Base url to navigate back from the app to the containing folder in - the file list. + 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 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_BASIC_JWT_SECRET: - name: OCIS_JWT_SECRET;APP_REGISTRY_JWT_SECRET + name: OCIS_JWT_SECRET;AUTH_BASIC_JWT_SECRET defaultValue: "" type: string description: The secret to mint and validate jwt tokens. @@ -1575,8 +1576,8 @@ AUTH_BASIC_JWT_SECRET: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_BIND_DN: - name: OCIS_LDAP_BIND_DN;IDP_LDAP_BIND_DN - defaultValue: uid=idp,ou=sysusers,o=libregraph-idm + name: OCIS_LDAP_BIND_DN;AUTH_BASIC_LDAP_BIND_DN + defaultValue: uid=reva,ou=sysusers,o=libregraph-idm type: string description: LDAP DN to use for simple bind authentication with the target LDAP server. @@ -1585,7 +1586,7 @@ AUTH_BASIC_LDAP_BIND_DN: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_BIND_PASSWORD: - name: OCIS_LDAP_BIND_PASSWORD;IDP_LDAP_BIND_PASSWORD + name: OCIS_LDAP_BIND_PASSWORD;AUTH_BASIC_LDAP_BIND_PASSWORD defaultValue: "" type: string description: Password to use for authenticating the 'bind_dn'. @@ -1594,18 +1595,18 @@ AUTH_BASIC_LDAP_BIND_PASSWORD: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_CACERT: - name: OCIS_LDAP_CACERT;IDP_LDAP_TLS_CACERT + name: OCIS_LDAP_CACERT;AUTH_BASIC_LDAP_CACERT defaultValue: /var/lib/ocis/idm/ldap.crt type: string description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root - directory derives from $OCIS_BASE_DATA_PATH/idp. + directory derives from $OCIS_BASE_DATA_PATH/idm. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_GROUP_BASE_DN: - name: OCIS_LDAP_GROUP_BASE_DN;USERS_LDAP_GROUP_BASE_DN + name: OCIS_LDAP_GROUP_BASE_DN;AUTH_BASIC_LDAP_GROUP_BASE_DN defaultValue: ou=groups,o=libregraph-idm type: string description: Search base DN for looking up LDAP groups. @@ -1614,7 +1615,7 @@ AUTH_BASIC_LDAP_GROUP_BASE_DN: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_GROUP_FILTER: - name: OCIS_LDAP_GROUP_FILTER;USERS_LDAP_GROUP_FILTER + name: OCIS_LDAP_GROUP_FILTER;AUTH_BASIC_LDAP_GROUP_FILTER defaultValue: "" type: string description: LDAP filter to add to the default filters for group searches. @@ -1623,17 +1624,17 @@ AUTH_BASIC_LDAP_GROUP_FILTER: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_GROUP_OBJECTCLASS: - name: OCIS_LDAP_GROUP_OBJECTCLASS;USERS_LDAP_GROUP_OBJECTCLASS + name: OCIS_LDAP_GROUP_OBJECTCLASS;AUTH_BASIC_LDAP_GROUP_OBJECTCLASS defaultValue: groupOfNames type: string description: The object class to use for groups in the default group search filter - like 'groupOfNames'. + ('groupOfNames'). introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_GROUP_SCHEMA_DISPLAYNAME: - name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;USERS_LDAP_GROUP_SCHEMA_DISPLAYNAME + name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;AUTH_BASIC_LDAP_GROUP_SCHEMA_DISPLAYNAME defaultValue: cn type: string description: LDAP Attribute to use for the displayname of groups (often the same @@ -1643,7 +1644,7 @@ AUTH_BASIC_LDAP_GROUP_SCHEMA_DISPLAYNAME: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_GROUP_SCHEMA_GROUPNAME: - name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;USERS_LDAP_GROUP_SCHEMA_GROUPNAME + name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;AUTH_BASIC_LDAP_GROUP_SCHEMA_GROUPNAME defaultValue: cn type: string description: LDAP Attribute to use for the name of groups. @@ -1652,28 +1653,28 @@ AUTH_BASIC_LDAP_GROUP_SCHEMA_GROUPNAME: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_GROUP_SCHEMA_ID: - name: OCIS_LDAP_GROUP_SCHEMA_ID;USERS_LDAP_GROUP_SCHEMA_ID + name: OCIS_LDAP_GROUP_SCHEMA_ID;AUTH_BASIC_LDAP_GROUP_SCHEMA_ID defaultValue: ownclouduuid type: string - description: LDAP Attribute to use as the unique ID for groups. This should be a - stable globally unique ID like a UUID. + description: LDAP Attribute to use as the unique id for groups. This should be a + stable globally unique id (e.g. a UUID). introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING: - name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;USERS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING + name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;AUTH_BASIC_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING defaultValue: "false" type: bool description: Set this to true if the defined 'id' attribute for groups is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute - of Active Directory for the group ID's. + of Active Directory for the group IDs. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_GROUP_SCHEMA_MAIL: - name: OCIS_LDAP_GROUP_SCHEMA_MAIL;USERS_LDAP_GROUP_SCHEMA_MAIL + name: OCIS_LDAP_GROUP_SCHEMA_MAIL;AUTH_BASIC_LDAP_GROUP_SCHEMA_MAIL defaultValue: mail type: string description: LDAP Attribute to use for the email address of groups (can be empty). @@ -1682,7 +1683,7 @@ AUTH_BASIC_LDAP_GROUP_SCHEMA_MAIL: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_GROUP_SCHEMA_MEMBER: - name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;USERS_LDAP_GROUP_SCHEMA_MEMBER + name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;AUTH_BASIC_LDAP_GROUP_SCHEMA_MEMBER defaultValue: member type: string description: LDAP Attribute that is used for group members. @@ -1691,7 +1692,7 @@ AUTH_BASIC_LDAP_GROUP_SCHEMA_MEMBER: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_GROUP_SCOPE: - name: OCIS_LDAP_GROUP_SCOPE;USERS_LDAP_GROUP_SCOPE + name: OCIS_LDAP_GROUP_SCOPE;AUTH_BASIC_LDAP_GROUP_SCOPE defaultValue: sub type: string description: LDAP search scope to use when looking up groups. Supported values are @@ -1701,7 +1702,7 @@ AUTH_BASIC_LDAP_GROUP_SCOPE: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_INSECURE: - name: OCIS_LDAP_INSECURE;IDP_INSECURE + name: OCIS_LDAP_INSECURE;AUTH_BASIC_LDAP_INSECURE defaultValue: "false" type: bool description: Disable TLS certificate validation for the LDAP connections. Do not @@ -1721,7 +1722,7 @@ AUTH_BASIC_LDAP_LOGIN_ATTRIBUTES: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_POOL_CHECKOUT_TIMEOUT: - name: OCIS_LDAP_POOL_CHECKOUT_TIMEOUT;USERS_LDAP_POOL_CHECKOUT_TIMEOUT + name: OCIS_LDAP_POOL_CHECKOUT_TIMEOUT;AUTH_BASIC_LDAP_POOL_CHECKOUT_TIMEOUT defaultValue: 30s type: Duration description: Maximum time to wait for a pooled LDAP connection to become available @@ -1732,7 +1733,7 @@ AUTH_BASIC_LDAP_POOL_CHECKOUT_TIMEOUT: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_POOL_ENABLED: - name: OCIS_LDAP_POOL_ENABLED;USERS_LDAP_POOL_ENABLED + name: OCIS_LDAP_POOL_ENABLED;AUTH_BASIC_LDAP_POOL_ENABLED defaultValue: "false" type: bool description: Enable a bounded pool of LDAP connections instead of a single long-lived @@ -1742,7 +1743,7 @@ AUTH_BASIC_LDAP_POOL_ENABLED: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_POOL_SIZE: - name: OCIS_LDAP_POOL_SIZE;USERS_LDAP_POOL_SIZE + name: OCIS_LDAP_POOL_SIZE;AUTH_BASIC_LDAP_POOL_SIZE defaultValue: "5" type: int description: Maximum number of concurrently open LDAP connections when 'OCIS_LDAP_POOL_ENABLED' @@ -1752,7 +1753,7 @@ AUTH_BASIC_LDAP_POOL_SIZE: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_RETRY_BASE_DELAY: - name: OCIS_LDAP_RETRY_BASE_DELAY;USERS_LDAP_RETRY_BASE_DELAY + name: OCIS_LDAP_RETRY_BASE_DELAY;AUTH_BASIC_LDAP_RETRY_BASE_DELAY defaultValue: 0s type: Duration description: Base delay for exponential backoff between LDAP retries (e.g. '100ms'). @@ -1762,7 +1763,7 @@ AUTH_BASIC_LDAP_RETRY_BASE_DELAY: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_RETRY_MAX_COUNT: - name: OCIS_LDAP_RETRY_MAX_COUNT;USERS_LDAP_RETRY_MAX_COUNT + name: OCIS_LDAP_RETRY_MAX_COUNT;AUTH_BASIC_LDAP_RETRY_MAX_COUNT defaultValue: "1" type: int description: Maximum number of retries for failed LDAP operations. Applies to both @@ -1772,7 +1773,7 @@ AUTH_BASIC_LDAP_RETRY_MAX_COUNT: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_RETRY_MAX_DELAY: - name: OCIS_LDAP_RETRY_MAX_DELAY;USERS_LDAP_RETRY_MAX_DELAY + name: OCIS_LDAP_RETRY_MAX_DELAY;AUTH_BASIC_LDAP_RETRY_MAX_DELAY defaultValue: 0s type: Duration description: Maximum delay cap for exponential backoff between LDAP retries (e.g. @@ -1782,16 +1783,17 @@ AUTH_BASIC_LDAP_RETRY_MAX_DELAY: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_URI: - name: OCIS_LDAP_URI;IDP_LDAP_URI + name: OCIS_LDAP_URI;AUTH_BASIC_LDAP_URI defaultValue: ldaps://localhost:9235 type: string - description: Url of the LDAP service to use as IDP. + description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' + and 'ldap://' introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_USER_BASE_DN: - name: OCIS_LDAP_USER_BASE_DN;IDP_LDAP_BASE_DN + name: OCIS_LDAP_USER_BASE_DN;AUTH_BASIC_LDAP_USER_BASE_DN defaultValue: ou=users,o=libregraph-idm type: string description: Search base DN for looking up LDAP users. @@ -1800,16 +1802,16 @@ AUTH_BASIC_LDAP_USER_BASE_DN: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_USER_ENABLED_ATTRIBUTE: - name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;IDP_USER_ENABLED_ATTRIBUTE + name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;AUTH_BASIC_LDAP_USER_ENABLED_ATTRIBUTE defaultValue: ownCloudUserEnabled type: string - description: LDAP Attribute to use as a flag telling if the user is enabled or disabled. + description: LDAP attribute to use as a flag telling if the user is enabled or disabled. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_USER_FILTER: - name: OCIS_LDAP_USER_FILTER;IDP_LDAP_FILTER + name: OCIS_LDAP_USER_FILTER;AUTH_BASIC_LDAP_USER_FILTER defaultValue: "" type: string description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. @@ -1818,16 +1820,17 @@ AUTH_BASIC_LDAP_USER_FILTER: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_USER_OBJECTCLASS: - name: OCIS_LDAP_USER_OBJECTCLASS;IDP_LDAP_OBJECTCLASS + name: OCIS_LDAP_USER_OBJECTCLASS;AUTH_BASIC_LDAP_USER_OBJECTCLASS defaultValue: inetOrgPerson type: string - description: LDAP User ObjectClass like 'inetOrgPerson'. + description: The object class to use for users in the default user search filter + ('inetOrgPerson'). introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_USER_SCHEMA_DISPLAYNAME: - name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;USERS_LDAP_USER_SCHEMA_DISPLAYNAME + name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;AUTH_BASIC_LDAP_USER_SCHEMA_DISPLAYNAME defaultValue: displayname type: string description: LDAP Attribute to use for the displayname of users. @@ -1836,55 +1839,56 @@ AUTH_BASIC_LDAP_USER_SCHEMA_DISPLAYNAME: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_USER_SCHEMA_ID: - name: OCIS_LDAP_USER_SCHEMA_ID;IDP_LDAP_UUID_ATTRIBUTE - defaultValue: ownCloudUUID + name: OCIS_LDAP_USER_SCHEMA_ID;AUTH_BASIC_LDAP_USER_SCHEMA_ID + defaultValue: ownclouduuid type: string - description: LDAP User UUID attribute like 'uid'. + description: LDAP Attribute to use as the unique ID for users. This should be a + stable globally unique ID like a UUID. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING: - name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;USERS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING + name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;AUTH_BASIC_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING defaultValue: "false" type: bool description: Set this to true if the defined 'ID' attribute for users is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute - of Active Directory for the user ID's. + of Active Directory for the user IDs. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_USER_SCHEMA_MAIL: - name: OCIS_LDAP_USER_SCHEMA_MAIL;IDP_LDAP_EMAIL_ATTRIBUTE + name: OCIS_LDAP_USER_SCHEMA_MAIL;AUTH_BASIC_LDAP_USER_SCHEMA_MAIL defaultValue: mail type: string - description: LDAP User email attribute like 'mail'. + description: LDAP Attribute to use for the email address of users. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_USER_SCHEMA_USERNAME: - name: OCIS_LDAP_USER_SCHEMA_USERNAME;IDP_LDAP_NAME_ATTRIBUTE - defaultValue: displayName + name: OCIS_LDAP_USER_SCHEMA_USERNAME;AUTH_BASIC_LDAP_USER_SCHEMA_USERNAME + defaultValue: uid type: string - description: LDAP User name attribute like 'displayName'. + description: LDAP Attribute to use for username of users. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_BASIC_LDAP_USER_SCOPE: - name: OCIS_LDAP_USER_SCOPE;IDP_LDAP_SCOPE + name: OCIS_LDAP_USER_SCOPE;AUTH_BASIC_LDAP_USER_SCOPE defaultValue: sub type: string - description: LDAP search scope to use when looking up users. Supported scopes are + description: LDAP search scope to use when looking up users. Supported values are 'base', 'one' and 'sub'. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" AUTH_BASIC_LOG_COLOR: - name: OCIS_LOG_COLOR;APP_REGISTRY_LOG_COLOR + name: OCIS_LOG_COLOR;AUTH_BASIC_LOG_COLOR defaultValue: "false" type: bool description: Activates colorized log output. @@ -1893,7 +1897,7 @@ AUTH_BASIC_LOG_COLOR: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LOG_FILE: - name: OCIS_LOG_FILE;APP_REGISTRY_LOG_FILE + name: OCIS_LOG_FILE;AUTH_BASIC_LOG_FILE defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. @@ -1902,7 +1906,7 @@ AUTH_BASIC_LOG_FILE: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LOG_LEVEL: - name: OCIS_LOG_LEVEL;APP_REGISTRY_LOG_LEVEL + name: OCIS_LOG_LEVEL;AUTH_BASIC_LOG_LEVEL defaultValue: "" type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', @@ -1912,7 +1916,7 @@ AUTH_BASIC_LOG_LEVEL: removalVersion: "" deprecationInfo: "" AUTH_BASIC_LOG_PRETTY: - name: OCIS_LOG_PRETTY;APP_REGISTRY_LOG_PRETTY + name: OCIS_LOG_PRETTY;AUTH_BASIC_LOG_PRETTY defaultValue: "false" type: bool description: Activates pretty log output. @@ -2014,7 +2018,7 @@ AUTH_BASIC_SKIP_USER_GROUPS_IN_TOKEN: removalVersion: "" deprecationInfo: "" AUTH_BASIC_TRACING_COLLECTOR: - name: OCIS_TRACING_COLLECTOR;APP_REGISTRY_TRACING_COLLECTOR + name: OCIS_TRACING_COLLECTOR;AUTH_BASIC_TRACING_COLLECTOR defaultValue: "" type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. @@ -2024,7 +2028,7 @@ AUTH_BASIC_TRACING_COLLECTOR: removalVersion: "" deprecationInfo: "" AUTH_BASIC_TRACING_ENABLED: - name: OCIS_TRACING_ENABLED;APP_REGISTRY_TRACING_ENABLED + name: OCIS_TRACING_ENABLED;AUTH_BASIC_TRACING_ENABLED defaultValue: "false" type: bool description: Activates tracing. @@ -2033,7 +2037,7 @@ AUTH_BASIC_TRACING_ENABLED: removalVersion: "" deprecationInfo: "" AUTH_BASIC_TRACING_ENDPOINT: - name: OCIS_TRACING_ENDPOINT;APP_REGISTRY_TRACING_ENDPOINT + name: OCIS_TRACING_ENDPOINT;AUTH_BASIC_TRACING_ENDPOINT defaultValue: "" type: string description: The endpoint of the tracing agent. @@ -2042,7 +2046,7 @@ AUTH_BASIC_TRACING_ENDPOINT: removalVersion: "" deprecationInfo: "" AUTH_BASIC_TRACING_TYPE: - name: OCIS_TRACING_TYPE;APP_REGISTRY_TRACING_TYPE + name: OCIS_TRACING_TYPE;AUTH_BASIC_TRACING_TYPE defaultValue: "" type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. @@ -2606,7 +2610,7 @@ CLIENTLOG_DEBUG_ZPAGES: removalVersion: "" deprecationInfo: "" CLIENTLOG_EVENTS_AUTH_PASSWORD: - name: OCIS_EVENTS_AUTH_PASSWORD;AUDIT_EVENTS_AUTH_PASSWORD + name: OCIS_EVENTS_AUTH_PASSWORD;CLIENTLOG_EVENTS_AUTH_PASSWORD defaultValue: "" type: string description: The password to authenticate with the events broker. The events broker @@ -2616,7 +2620,7 @@ CLIENTLOG_EVENTS_AUTH_PASSWORD: removalVersion: "" deprecationInfo: "" CLIENTLOG_EVENTS_AUTH_USERNAME: - name: OCIS_EVENTS_AUTH_USERNAME;AUDIT_EVENTS_AUTH_USERNAME + name: OCIS_EVENTS_AUTH_USERNAME;CLIENTLOG_EVENTS_AUTH_USERNAME defaultValue: "" type: string description: The username to authenticate with the events broker. The events broker @@ -2626,52 +2630,52 @@ CLIENTLOG_EVENTS_AUTH_USERNAME: removalVersion: "" deprecationInfo: "" CLIENTLOG_EVENTS_CLUSTER: - name: OCIS_EVENTS_CLUSTER;AUDIT_EVENTS_CLUSTER + name: OCIS_EVENTS_CLUSTER;CLIENTLOG_EVENTS_CLUSTER defaultValue: ocis-cluster type: string description: The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system. - introductionVersion: pre5.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" CLIENTLOG_EVENTS_ENABLE_TLS: - name: OCIS_EVENTS_ENABLE_TLS;AUDIT_EVENTS_ENABLE_TLS + name: OCIS_EVENTS_ENABLE_TLS;CLIENTLOG_EVENTS_ENABLE_TLS defaultValue: "false" type: bool description: Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. - introductionVersion: pre5.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" CLIENTLOG_EVENTS_ENDPOINT: - name: OCIS_EVENTS_ENDPOINT;AUDIT_EVENTS_ENDPOINT + name: OCIS_EVENTS_ENDPOINT;CLIENTLOG_EVENTS_ENDPOINT defaultValue: 127.0.0.1:9233 type: string description: The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. - introductionVersion: pre5.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" CLIENTLOG_EVENTS_TLS_INSECURE: - name: OCIS_INSECURE;OCDAV_INSECURE + name: OCIS_INSECURE;CLIENTLOG_EVENTS_TLS_INSECURE defaultValue: "false" type: bool - description: Allow insecure connections to the GATEWAY service. - introductionVersion: pre5.0 + description: Whether to verify the server TLS certificates. + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" CLIENTLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE: - name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;AUDIT_EVENTS_TLS_ROOT_CA_CERTIFICATE + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;CLIENTLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE defaultValue: "" type: string description: The root CA certificate used to validate the server's TLS certificate. - If provided AUDIT_EVENTS_TLS_INSECURE will be seen as false. - introductionVersion: pre5.0 + If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2685,7 +2689,7 @@ CLIENTLOG_JWT_SECRET: removalVersion: "" deprecationInfo: "" CLIENTLOG_SERVICE_ACCOUNT_ID: - name: OCIS_SERVICE_ACCOUNT_ID;STORAGE_USERS_SERVICE_ACCOUNT_ID + name: OCIS_SERVICE_ACCOUNT_ID;CLIENTLOG_SERVICE_ACCOUNT_ID defaultValue: "" type: string description: The ID of the service account the service should use. See the 'auth-service' @@ -2695,7 +2699,7 @@ CLIENTLOG_SERVICE_ACCOUNT_ID: removalVersion: "" deprecationInfo: "" CLIENTLOG_SERVICE_ACCOUNT_SECRET: - name: OCIS_SERVICE_ACCOUNT_SECRET;STORAGE_USERS_SERVICE_ACCOUNT_SECRET + name: OCIS_SERVICE_ACCOUNT_SECRET;CLIENTLOG_SERVICE_ACCOUNT_SECRET defaultValue: "" type: string description: The service account secret. @@ -3087,12 +3091,12 @@ COLLABORATION_STORE_TLS_ROOT_CA_CERTIFICATE: removalVersion: "" deprecationInfo: "" COLLABORATION_STORE_TTL: - name: OCIS_PERSISTENT_STORE_TTL;COLLABORATION_STORE_TTL - defaultValue: 30m0s + name: OCIS_PERSISTENT_STORE_TTL;POSTPROCESSING_STORE_TTL + defaultValue: 0s type: Duration - description: Time to live for events in the store. Defaults to '30m' (30 minutes). - See the Environment Variable Types description for more details. - introductionVersion: 7.0.0 + description: Time to live for events in the store. See the Environment Variable + Types description for more details. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3135,11 +3139,12 @@ COLLABORATION_TRACING_TYPE: removalVersion: "" deprecationInfo: "" COLLABORATION_WOPI_DISABLE_CHAT: - name: APP_PROVIDER_WOPI_DISABLE_CHAT;OCIS_WOPI_DISABLE_CHAT + name: COLLABORATION_WOPI_DISABLE_CHAT;OCIS_WOPI_DISABLE_CHAT defaultValue: "false" type: bool - description: Disable the chat functionality of the office app. - introductionVersion: pre5.0 + description: Disable chat in the office web frontend. This feature applies to OnlyOffice + and Microsoft. + introductionVersion: 7.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3599,7 +3604,7 @@ FRONTEND_CONFIGURABLE_NOTIFICATIONS: removalVersion: "" deprecationInfo: "" FRONTEND_CORS_ALLOW_CREDENTIALS: - name: OCIS_CORS_ALLOW_CREDENTIALS;OCDAV_CORS_ALLOW_CREDENTIALS + name: OCIS_CORS_ALLOW_CREDENTIALS;FRONTEND_CORS_ALLOW_CREDENTIALS defaultValue: "false" type: bool description: 'Allow credentials for CORS.See following chapter for more details: @@ -3609,7 +3614,7 @@ FRONTEND_CORS_ALLOW_CREDENTIALS: removalVersion: "" deprecationInfo: "" FRONTEND_CORS_ALLOW_HEADERS: - name: OCIS_CORS_ALLOW_HEADERS;OCDAV_CORS_ALLOW_HEADERS + name: OCIS_CORS_ALLOW_HEADERS;FRONTEND_CORS_ALLOW_HEADERS defaultValue: '[Origin Accept Content-Type Depth Authorization Ocs-Apirequest If-None-Match If-Match Destination Overwrite X-Request-Id X-Requested-With Tus-Resumable Tus-Checksum-Algorithm Upload-Concat Upload-Length Upload-Metadata Upload-Defer-Length Upload-Expires @@ -3623,9 +3628,9 @@ FRONTEND_CORS_ALLOW_HEADERS: removalVersion: "" deprecationInfo: "" FRONTEND_CORS_ALLOW_METHODS: - name: OCIS_CORS_ALLOW_METHODS;OCDAV_CORS_ALLOW_METHODS - defaultValue: '[OPTIONS HEAD GET PUT POST DELETE MKCOL PROPFIND PROPPATCH MOVE COPY - REPORT SEARCH]' + name: OCIS_CORS_ALLOW_METHODS;FRONTEND_CORS_ALLOW_METHODS + defaultValue: '[OPTIONS HEAD GET PUT POST PATCH DELETE MKCOL PROPFIND PROPPATCH + MOVE COPY REPORT SEARCH]' type: '[]string' description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. @@ -3635,7 +3640,7 @@ FRONTEND_CORS_ALLOW_METHODS: removalVersion: "" deprecationInfo: "" FRONTEND_CORS_ALLOW_ORIGINS: - name: OCIS_CORS_ALLOW_ORIGINS;OCDAV_CORS_ALLOW_ORIGINS + name: OCIS_CORS_ALLOW_ORIGINS;FRONTEND_CORS_ALLOW_ORIGINS defaultValue: '[https://localhost:9200]' type: '[]string' description: 'A list of allowed CORS origins. See following chapter for more details: @@ -3742,11 +3747,12 @@ FRONTEND_ENABLE_FAVORITES: removalVersion: "" deprecationInfo: "" FRONTEND_ENABLE_FEDERATED_SHARING_INCOMING: - name: OCIS_ENABLE_OCM;GRAPH_INCLUDE_OCM_SHAREES + name: OCIS_ENABLE_OCM;FRONTEND_ENABLE_FEDERATED_SHARING_INCOMING defaultValue: "false" type: bool - description: Include OCM sharees when listing users. - introductionVersion: "5.0" + description: Changing this value is NOT supported. Enables support for incoming + federated sharing for clients. The backend behaviour is not changed. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -3761,12 +3767,12 @@ FRONTEND_ENABLE_FEDERATED_SHARING_OUTGOING: removalVersion: "" deprecationInfo: "" FRONTEND_ENABLE_VAULT_MODE: - name: OCIS_ENABLE_VAULT_MODE;PROXY_ENABLE_VAULT_MODE + name: OCIS_ENABLE_VAULT_MODE;FRONTEND_ENABLE_VAULT_MODE defaultValue: "false" type: bool - description: Set this to true to automatically create a new vault home for the user - if it does not exist. Only applicapable if the storage-users-vault service, a - special configured storage-users service is configured. + description: Enable vault mode. When enabled, the capabilities endpoint will report + vault as enabled and the capabilities?vault=true endpoint will return capabilities + with public sharing and federation disabled. introductionVersion: 8.1.0 deprecationVersion: "" removalVersion: "" @@ -3887,7 +3893,7 @@ FRONTEND_JWT_SECRET: removalVersion: "" deprecationInfo: "" FRONTEND_LDAP_SERVER_WRITE_ENABLED: - name: OCIS_LDAP_SERVER_WRITE_ENABLED;GRAPH_LDAP_SERVER_WRITE_ENABLED + name: OCIS_LDAP_SERVER_WRITE_ENABLED;FRONTEND_LDAP_SERVER_WRITE_ENABLED defaultValue: "true" type: bool description: Allow creating, modifying and deleting LDAP users via the GRAPH API. @@ -3936,39 +3942,38 @@ FRONTEND_LOG_PRETTY: removalVersion: "" deprecationInfo: "" FRONTEND_MACHINE_AUTH_API_KEY: - name: OCIS_MACHINE_AUTH_API_KEY;OCDAV_MACHINE_AUTH_API_KEY + name: OCIS_MACHINE_AUTH_API_KEY;FRONTEND_MACHINE_AUTH_API_KEY defaultValue: "" type: string - description: Machine auth API key used to validate internal requests necessary for - the access to resources from other services. + description: The machine auth API key used to validate internal requests necessary + to access resources from other services. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" FRONTEND_MAX_CONCURRENCY: - name: OCIS_MAX_CONCURRENCY;STORAGE_USERS_S3NG_MAX_CONCURRENCY - defaultValue: "5" + name: OCIS_MAX_CONCURRENCY;FRONTEND_MAX_CONCURRENCY + defaultValue: "1" 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 + or below will be ignored and the default value will be used. + introductionVersion: 7.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" FRONTEND_MAX_QUOTA: - name: OCIS_SPACES_MAX_QUOTA;STORAGE_USERS_OCIS_MAX_QUOTA + name: OCIS_SPACES_MAX_QUOTA;FRONTEND_MAX_QUOTA defaultValue: "0" type: uint64 - description: Set a global max quota for spaces in bytes. A value of 0 equals unlimited. - If not using the global OCIS_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA - in the frontend service. + description: Set the global max quota value in bytes. A value of 0 equals unlimited. + The value is provided via capabilities. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" FRONTEND_PASSWORD_POLICY_BANNED_PASSWORDS_LIST: - name: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST;SHARING_PASSWORD_POLICY_BANNED_PASSWORDS_LIST + name: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST;FRONTEND_PASSWORD_POLICY_BANNED_PASSWORDS_LIST defaultValue: "" type: string description: Path to the 'banned passwords list' file. This only impacts public @@ -3978,7 +3983,7 @@ FRONTEND_PASSWORD_POLICY_BANNED_PASSWORDS_LIST: removalVersion: "" deprecationInfo: "" FRONTEND_PASSWORD_POLICY_DISABLED: - name: OCIS_PASSWORD_POLICY_DISABLED;SHARING_PASSWORD_POLICY_DISABLED + name: OCIS_PASSWORD_POLICY_DISABLED;FRONTEND_PASSWORD_POLICY_DISABLED defaultValue: "false" type: bool description: Disable the password policy. Defaults to false if not set. @@ -3987,7 +3992,7 @@ FRONTEND_PASSWORD_POLICY_DISABLED: removalVersion: "" deprecationInfo: "" FRONTEND_PASSWORD_POLICY_MIN_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_CHARACTERS defaultValue: "8" type: int description: Define the minimum password length. Defaults to 8 if not set. @@ -3996,7 +4001,7 @@ FRONTEND_PASSWORD_POLICY_MIN_CHARACTERS: removalVersion: "" deprecationInfo: "" FRONTEND_PASSWORD_POLICY_MIN_DIGITS: - name: OCIS_PASSWORD_POLICY_MIN_DIGITS;SHARING_PASSWORD_POLICY_MIN_DIGITS + name: OCIS_PASSWORD_POLICY_MIN_DIGITS;FRONTEND_PASSWORD_POLICY_MIN_DIGITS defaultValue: "1" type: int description: Define the minimum number of digits. Defaults to 1 if not set. @@ -4005,7 +4010,7 @@ FRONTEND_PASSWORD_POLICY_MIN_DIGITS: removalVersion: "" deprecationInfo: "" FRONTEND_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of uppercase letters. Defaults to 1 if not @@ -4015,7 +4020,7 @@ FRONTEND_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS: removalVersion: "" deprecationInfo: "" FRONTEND_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of characters from the special characters @@ -4025,7 +4030,7 @@ FRONTEND_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS: removalVersion: "" deprecationInfo: "" FRONTEND_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of lowercase letters. Defaults to 1 if not @@ -4153,10 +4158,10 @@ FRONTEND_UPLOAD_MAX_CHUNK_SIZE: removalVersion: "" deprecationInfo: "" FRONTEND_USER_SEARCH_DISPLAYED_ATTRIBUTES: - name: OCIS_USER_SEARCH_DISPLAYED_ATTRIBUTES + name: OCIS_USER_SEARCH_DISPLAYED_ATTRIBUTES;FRONTEND_USER_SEARCH_DISPLAYED_ATTRIBUTES defaultValue: '[]' type: '[]string' - description: The attributes to display in the user search results. + description: A list of user attributes to display in the user search results. introductionVersion: 7.3.0 deprecationVersion: "" removalVersion: "" @@ -4309,11 +4314,11 @@ GATEWAY_GROUPS_ENDPOINT: removalVersion: "" deprecationInfo: "" GATEWAY_GRPC_ADDR: - name: OCIS_GATEWAY_GRPC_ADDR;STORAGE_USERS_GATEWAY_GRPC_ADDR + name: OCIS_GATEWAY_GRPC_ADDR;GATEWAY_GRPC_ADDR defaultValue: 127.0.0.1:9142 type: string - description: The bind address of the gateway GRPC address. - introductionVersion: "5.0" + description: The bind address of the GRPC service. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -4423,7 +4428,7 @@ GATEWAY_PROVIDER_CACHE_DISABLE_PERSISTENCE: removalVersion: "" deprecationInfo: "" GATEWAY_PROVIDER_CACHE_ENABLE_TLS: - name: OCIS_CACHE_ENABLE_TLS;STORAGE_SYSTEM_CACHE_ENABLE_TLS + name: OCIS_CACHE_ENABLE_TLS;GATEWAY_PROVIDER_CACHE_ENABLE_TLS defaultValue: "false" type: bool description: Activate TLS for the connection to the cache store. Only applies when @@ -4455,7 +4460,7 @@ GATEWAY_PROVIDER_CACHE_STORE_NODES: removalVersion: "" deprecationInfo: "" GATEWAY_PROVIDER_CACHE_TLS_INSECURE: - name: OCIS_CACHE_TLS_INSECURE;STORAGE_SYSTEM_CACHE_TLS_INSECURE + name: OCIS_CACHE_TLS_INSECURE;GATEWAY_PROVIDER_CACHE_TLS_INSECURE defaultValue: "false" type: bool description: Disable TLS certificate verification for the cache store connection. @@ -4465,7 +4470,7 @@ GATEWAY_PROVIDER_CACHE_TLS_INSECURE: removalVersion: "" deprecationInfo: "" GATEWAY_PROVIDER_CACHE_TLS_ROOT_CA_CERTIFICATE: - name: OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE;STORAGE_SYSTEM_CACHE_TLS_ROOT_CA_CERTIFICATE + name: OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE;GATEWAY_PROVIDER_CACHE_TLS_ROOT_CA_CERTIFICATE defaultValue: "" type: string description: Path to the PEM-encoded root CA certificate for the cache store TLS @@ -4694,7 +4699,7 @@ GRAPH_AVAILABLE_ROLES: removalVersion: "" deprecationInfo: "" GRAPH_CACHE_AUTH_PASSWORD: - name: OCIS_CACHE_AUTH_PASSWORD;GRAPH_CACHE_AUTH_PASSWORD + name: OCIS_CACHE_AUTH_PASSWORD;SETTINGS_CACHE_AUTH_PASSWORD defaultValue: "" type: string description: The password to authenticate with the cache. Only applies when store @@ -4704,7 +4709,7 @@ GRAPH_CACHE_AUTH_PASSWORD: removalVersion: "" deprecationInfo: "" GRAPH_CACHE_AUTH_USERNAME: - name: OCIS_CACHE_AUTH_USERNAME;GRAPH_CACHE_AUTH_USERNAME + name: OCIS_CACHE_AUTH_USERNAME;SETTINGS_CACHE_AUTH_USERNAME defaultValue: "" type: string description: The username to authenticate with the cache. Only applies when store @@ -4714,7 +4719,7 @@ GRAPH_CACHE_AUTH_USERNAME: removalVersion: "" deprecationInfo: "" GRAPH_CACHE_DISABLE_PERSISTENCE: - name: OCIS_CACHE_DISABLE_PERSISTENCE;GRAPH_CACHE_DISABLE_PERSISTENCE + name: OCIS_CACHE_DISABLE_PERSISTENCE;SETTINGS_CACHE_DISABLE_PERSISTENCE defaultValue: "false" type: bool description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' @@ -4724,7 +4729,7 @@ GRAPH_CACHE_DISABLE_PERSISTENCE: removalVersion: "" deprecationInfo: "" GRAPH_CACHE_ENABLE_TLS: - name: OCIS_CACHE_ENABLE_TLS;GRAPH_CACHE_ENABLE_TLS + name: OCIS_CACHE_ENABLE_TLS;SETTINGS_CACHE_ENABLE_TLS defaultValue: "false" type: bool description: Activate TLS for the connection to the cache store. Only applies when @@ -4734,7 +4739,7 @@ GRAPH_CACHE_ENABLE_TLS: removalVersion: "" deprecationInfo: "" GRAPH_CACHE_STORE: - name: OCIS_CACHE_STORE;GRAPH_CACHE_STORE + name: OCIS_CACHE_STORE;SETTINGS_CACHE_STORE defaultValue: memory type: string description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', @@ -4753,11 +4758,11 @@ GRAPH_CACHE_STORE_DATABASE: removalVersion: "" deprecationInfo: "" GRAPH_CACHE_STORE_NODES: - name: OCIS_CACHE_STORE_NODES;GRAPH_CACHE_STORE_NODES + name: OCIS_CACHE_STORE_NODES;SETTINGS_CACHE_STORE_NODES defaultValue: '[127.0.0.1:9233]' type: '[]string' description: A list of nodes to access the configured store. This has no effect - when 'memory' 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 Types description for more details. introductionVersion: pre5.0 @@ -4774,7 +4779,7 @@ GRAPH_CACHE_STORE_TABLE: removalVersion: "" deprecationInfo: "" GRAPH_CACHE_TLS_INSECURE: - name: OCIS_CACHE_TLS_INSECURE;GRAPH_CACHE_TLS_INSECURE + name: OCIS_CACHE_TLS_INSECURE;SETTINGS_CACHE_TLS_INSECURE defaultValue: "false" type: bool description: Disable TLS certificate verification for the cache store connection. @@ -4784,7 +4789,7 @@ GRAPH_CACHE_TLS_INSECURE: removalVersion: "" deprecationInfo: "" GRAPH_CACHE_TLS_ROOT_CA_CERTIFICATE: - name: OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE;GRAPH_CACHE_TLS_ROOT_CA_CERTIFICATE + name: OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE;SETTINGS_CACHE_TLS_ROOT_CA_CERTIFICATE defaultValue: "" type: string description: Path to the PEM-encoded root CA certificate for the cache store TLS @@ -4794,11 +4799,12 @@ GRAPH_CACHE_TLS_ROOT_CA_CERTIFICATE: removalVersion: "" deprecationInfo: "" GRAPH_CACHE_TTL: - name: OCIS_CACHE_TTL;GRAPH_CACHE_TTL - defaultValue: 336h0m0s + name: OCIS_CACHE_TTL;SETTINGS_CACHE_TTL + defaultValue: 10m0s type: Duration - description: Time to live for cache records in the graph. Defaults to '336h' (2 - weeks). See the Environment Variable Types description for more details. + description: Default time to live for entries in the cache. Only applied when access + tokens has no expiration. See the Environment Variable Types description for more + details. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -4886,20 +4892,20 @@ GRAPH_DEBUG_ZPAGES: removalVersion: "" deprecationInfo: "" GRAPH_DISABLE_USER_MECHANISM: - name: OCIS_LDAP_DISABLE_USER_MECHANISM;GRAPH_DISABLE_USER_MECHANISM + name: OCIS_LDAP_DISABLE_USER_MECHANISM;AUTH_BASIC_DISABLE_USER_MECHANISM defaultValue: attribute type: string - description: An option to control the behavior for disabling users. Supported options + description: An option to control the behavior for disabling users. Valid options are 'none', 'attribute' and 'group'. If set to 'group', disabling a user via API will add the user to the configured group for disabled users, if set to 'attribute' this will be done in the ldap user entry, if set to 'none' the disable request - is not processed. Default is 'attribute'. + is not processed. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" GRAPH_DISABLED_USERS_GROUP_DN: - name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;GRAPH_DISABLED_USERS_GROUP_DN + name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;AUTH_BASIC_DISABLED_USERS_GROUP_DN defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm type: string description: The distinguished name of the group to which added users will be classified @@ -4909,18 +4915,18 @@ GRAPH_DISABLED_USERS_GROUP_DN: removalVersion: "" deprecationInfo: "" GRAPH_ENABLE_VAULT_MODE: - name: OCIS_ENABLE_VAULT_MODE;GRAPH_ENABLE_VAULT_MODE + name: OCIS_ENABLE_VAULT_MODE;PROXY_ENABLE_VAULT_MODE defaultValue: "false" type: bool - description: Enable vault mode in addition to the regular graph service. This only - applies when the additional storage-users-vault service is running, which is a - special configured storage-users service. + description: Set this to true to automatically create a new vault home for the user + if it does not exist. Only applicapable if the storage-users-vault service, a + special configured storage-users service is configured. introductionVersion: 8.1.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" GRAPH_EVENTS_AUTH_PASSWORD: - name: OCIS_EVENTS_AUTH_PASSWORD;GRAPH_EVENTS_AUTH_PASSWORD + name: OCIS_EVENTS_AUTH_PASSWORD;POSTPROCESSING_EVENTS_AUTH_PASSWORD defaultValue: "" type: string description: The password to authenticate with the events broker. The events broker @@ -4930,7 +4936,7 @@ GRAPH_EVENTS_AUTH_PASSWORD: removalVersion: "" deprecationInfo: "" GRAPH_EVENTS_AUTH_USERNAME: - name: OCIS_EVENTS_AUTH_USERNAME;GRAPH_EVENTS_AUTH_USERNAME + name: OCIS_EVENTS_AUTH_USERNAME;POSTPROCESSING_EVENTS_AUTH_USERNAME defaultValue: "" type: string description: The username to authenticate with the events broker. The events broker @@ -4940,17 +4946,18 @@ GRAPH_EVENTS_AUTH_USERNAME: removalVersion: "" deprecationInfo: "" GRAPH_EVENTS_CLUSTER: - name: OCIS_EVENTS_CLUSTER;GRAPH_EVENTS_CLUSTER + name: OCIS_EVENTS_CLUSTER;POSTPROCESSING_EVENTS_CLUSTER defaultValue: ocis-cluster type: string description: The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. + Mandatory when using NATS as event system. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" GRAPH_EVENTS_ENABLE_TLS: - name: OCIS_EVENTS_ENABLE_TLS;GRAPH_EVENTS_ENABLE_TLS + name: OCIS_EVENTS_ENABLE_TLS;POSTPROCESSING_EVENTS_ENABLE_TLS defaultValue: "false" type: bool description: Enable TLS for the connection to the events broker. The events broker @@ -4960,12 +4967,11 @@ GRAPH_EVENTS_ENABLE_TLS: removalVersion: "" deprecationInfo: "" GRAPH_EVENTS_ENDPOINT: - name: OCIS_EVENTS_ENDPOINT;GRAPH_EVENTS_ENDPOINT + name: OCIS_EVENTS_ENDPOINT;POSTPROCESSING_EVENTS_ENDPOINT defaultValue: 127.0.0.1:9233 type: string description: The address of the event system. The event system is the message queuing - service. It is used as message broker for the microservice architecture. Set to - a empty string to disable emitting events. + service. It is used as message broker for the microservice architecture. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -4980,11 +4986,11 @@ GRAPH_EVENTS_TLS_INSECURE: removalVersion: "" deprecationInfo: "" GRAPH_EVENTS_TLS_ROOT_CA_CERTIFICATE: - name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;GRAPH_EVENTS_TLS_ROOT_CA_CERTIFICATE + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;POSTPROCESSING_EVENTS_TLS_ROOT_CA_CERTIFICATE defaultValue: "" type: string description: The root CA certificate used to validate the server's TLS certificate. - If provided GRAPH_EVENTS_TLS_INSECURE will be seen as false. + If provided POSTPROCESSING_EVENTS_TLS_INSECURE will be seen as false. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -5047,16 +5053,16 @@ GRAPH_IDENTITY_SEARCH_MIN_LENGTH: removalVersion: "" deprecationInfo: "" GRAPH_INCLUDE_OCM_SHAREES: - name: OCIS_ENABLE_OCM;GRAPH_INCLUDE_OCM_SHAREES + name: OCIS_ENABLE_OCM defaultValue: "false" type: bool - description: Include OCM sharees when listing users. + description: Include OCM sharees when listing sharees. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" GRAPH_JWT_SECRET: - name: OCIS_JWT_SECRET;GRAPH_JWT_SECRET + name: OCIS_JWT_SECRET;USERLOG_JWT_SECRET defaultValue: "" type: string description: The secret to mint and validate jwt tokens. @@ -5120,8 +5126,8 @@ GRAPH_KEYCLOAK_USER_REALM: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_BIND_DN: - name: OCIS_LDAP_BIND_DN;GRAPH_LDAP_BIND_DN - defaultValue: uid=libregraph,ou=sysusers,o=libregraph-idm + name: OCIS_LDAP_BIND_DN;IDP_LDAP_BIND_DN + defaultValue: uid=idp,ou=sysusers,o=libregraph-idm type: string description: LDAP DN to use for simple bind authentication with the target LDAP server. @@ -5130,7 +5136,7 @@ GRAPH_LDAP_BIND_DN: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_BIND_PASSWORD: - name: OCIS_LDAP_BIND_PASSWORD;GRAPH_LDAP_BIND_PASSWORD + name: OCIS_LDAP_BIND_PASSWORD;IDP_LDAP_BIND_PASSWORD defaultValue: "" type: string description: Password to use for authenticating the 'bind_dn'. @@ -5139,12 +5145,12 @@ GRAPH_LDAP_BIND_PASSWORD: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_CACERT: - name: OCIS_LDAP_CACERT;GRAPH_LDAP_CACERT + name: OCIS_LDAP_CACERT;IDP_LDAP_TLS_CACERT defaultValue: /var/lib/ocis/idm/ldap.crt type: string description: Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the LDAP service. If not defined, the root - directory derives from $OCIS_BASE_DATA_PATH/idm. + directory derives from $OCIS_BASE_DATA_PATH/idp. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -5180,7 +5186,7 @@ GRAPH_LDAP_GROUP_ADDITIONAL_OBJECTCLASSES: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_GROUP_BASE_DN: - name: OCIS_LDAP_GROUP_BASE_DN;GRAPH_LDAP_GROUP_BASE_DN + name: OCIS_LDAP_GROUP_BASE_DN;GROUPS_LDAP_GROUP_BASE_DN defaultValue: ou=groups,o=libregraph-idm type: string description: Search base DN for looking up LDAP groups. @@ -5201,7 +5207,7 @@ GRAPH_LDAP_GROUP_CREATE_BASE_DN: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_GROUP_FILTER: - name: OCIS_LDAP_GROUP_FILTER;GRAPH_LDAP_GROUP_FILTER + name: OCIS_LDAP_GROUP_FILTER;GROUPS_LDAP_GROUP_FILTER defaultValue: "" type: string description: LDAP filter to add to the default filters for group searches. @@ -5210,8 +5216,8 @@ GRAPH_LDAP_GROUP_FILTER: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_GROUP_ID_ATTRIBUTE: - name: OCIS_LDAP_GROUP_SCHEMA_ID;GRAPH_LDAP_GROUP_ID_ATTRIBUTE - defaultValue: owncloudUUID + name: OCIS_LDAP_GROUP_SCHEMA_ID;GROUPS_LDAP_GROUP_SCHEMA_ID + defaultValue: ownclouduuid type: string description: LDAP Attribute to use as the unique id for groups. This should be a stable globally unique ID like a UUID. @@ -5220,7 +5226,7 @@ GRAPH_LDAP_GROUP_ID_ATTRIBUTE: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_GROUP_MEMBER_ATTRIBUTE: - name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;GRAPH_LDAP_GROUP_MEMBER_ATTRIBUTE + name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;GROUPS_LDAP_GROUP_SCHEMA_MEMBER defaultValue: member type: string description: LDAP Attribute that is used for group members. @@ -5229,7 +5235,7 @@ GRAPH_LDAP_GROUP_MEMBER_ATTRIBUTE: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_GROUP_NAME_ATTRIBUTE: - name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;GRAPH_LDAP_GROUP_NAME_ATTRIBUTE + name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;GROUPS_LDAP_GROUP_SCHEMA_GROUPNAME defaultValue: cn type: string description: LDAP Attribute to use for the name of groups. @@ -5238,7 +5244,7 @@ GRAPH_LDAP_GROUP_NAME_ATTRIBUTE: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_GROUP_OBJECTCLASS: - name: OCIS_LDAP_GROUP_OBJECTCLASS;GRAPH_LDAP_GROUP_OBJECTCLASS + name: OCIS_LDAP_GROUP_OBJECTCLASS;GROUPS_LDAP_GROUP_OBJECTCLASS defaultValue: groupOfNames type: string description: The object class to use for groups in the default group search filter @@ -5248,18 +5254,18 @@ GRAPH_LDAP_GROUP_OBJECTCLASS: removalVersion: "" deprecationInfo: "" GRAPH_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;GROUPS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING defaultValue: "false" type: bool - description: Set this to true if the defined 'ID' attribute for groups is of the - 'OCTETSTRING' syntax. This is required when using the 'objectGUID' attribute of - Active Directory for the group ID's. + description: Set this to true if the defined 'id' attribute for groups is of the + 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute + of Active Directory for the group ID's. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" GRAPH_LDAP_GROUP_SEARCH_SCOPE: - name: OCIS_LDAP_GROUP_SCOPE;GRAPH_LDAP_GROUP_SEARCH_SCOPE + name: OCIS_LDAP_GROUP_SCOPE;GROUPS_LDAP_GROUP_SCOPE defaultValue: sub type: string description: LDAP search scope to use when looking up groups. Supported scopes are @@ -5269,7 +5275,7 @@ GRAPH_LDAP_GROUP_SEARCH_SCOPE: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_INSECURE: - name: OCIS_LDAP_INSECURE;GRAPH_LDAP_INSECURE + name: OCIS_LDAP_INSECURE;IDP_INSECURE defaultValue: "false" type: bool description: Disable TLS certificate validation for the LDAP connections. Do not @@ -5279,7 +5285,7 @@ GRAPH_LDAP_INSECURE: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_POOL_CHECKOUT_TIMEOUT: - name: OCIS_LDAP_POOL_CHECKOUT_TIMEOUT;GRAPH_LDAP_POOL_CHECKOUT_TIMEOUT + name: OCIS_LDAP_POOL_CHECKOUT_TIMEOUT;GROUPS_LDAP_POOL_CHECKOUT_TIMEOUT defaultValue: 30s type: Duration description: Maximum time to wait for a pooled LDAP connection to become available @@ -5290,7 +5296,7 @@ GRAPH_LDAP_POOL_CHECKOUT_TIMEOUT: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_POOL_ENABLED: - name: OCIS_LDAP_POOL_ENABLED;GRAPH_LDAP_POOL_ENABLED + name: OCIS_LDAP_POOL_ENABLED;GROUPS_LDAP_POOL_ENABLED defaultValue: "false" type: bool description: Enable a bounded pool of LDAP connections instead of a single long-lived @@ -5300,7 +5306,7 @@ GRAPH_LDAP_POOL_ENABLED: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_POOL_SIZE: - name: OCIS_LDAP_POOL_SIZE;GRAPH_LDAP_POOL_SIZE + name: OCIS_LDAP_POOL_SIZE;GROUPS_LDAP_POOL_SIZE defaultValue: "5" type: int description: Maximum number of concurrently open LDAP connections when 'OCIS_LDAP_POOL_ENABLED' @@ -5330,7 +5336,7 @@ GRAPH_LDAP_REQUIRE_EXTERNAL_ID: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_RETRY_BASE_DELAY: - name: OCIS_LDAP_RETRY_BASE_DELAY;GRAPH_LDAP_RETRY_BASE_DELAY + name: OCIS_LDAP_RETRY_BASE_DELAY;GROUPS_LDAP_RETRY_BASE_DELAY defaultValue: 0s type: Duration description: Base delay for exponential backoff between LDAP retries (e.g. '100ms'). @@ -5340,19 +5346,17 @@ GRAPH_LDAP_RETRY_BASE_DELAY: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_RETRY_MAX_COUNT: - name: OCIS_LDAP_RETRY_MAX_COUNT;GRAPH_LDAP_RETRY_MAX_COUNT + name: OCIS_LDAP_RETRY_MAX_COUNT;GROUPS_LDAP_RETRY_MAX_COUNT defaultValue: "1" type: int - description: Maximum number of retries for failed LDAP operations. Reads retry on - transient and network errors; writes retry only when the connection failed before - the request was sent (e.g. a reused idle connection found closed), so the request - provably never reached the server and cannot be double-applied. Default 1. + description: Maximum number of retries for failed LDAP operations. Applies to both + read and write operations (with different retryable error sets). Default 1. introductionVersion: 8.2.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" GRAPH_LDAP_RETRY_MAX_DELAY: - name: OCIS_LDAP_RETRY_MAX_DELAY;GRAPH_LDAP_RETRY_MAX_DELAY + name: OCIS_LDAP_RETRY_MAX_DELAY;GROUPS_LDAP_RETRY_MAX_DELAY defaultValue: 0s type: Duration description: Maximum delay cap for exponential backoff between LDAP retries (e.g. @@ -5456,7 +5460,7 @@ GRAPH_LDAP_SERVER_UUID: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_SERVER_WRITE_ENABLED: - name: OCIS_LDAP_SERVER_WRITE_ENABLED;GRAPH_LDAP_SERVER_WRITE_ENABLED + name: OCIS_LDAP_SERVER_WRITE_ENABLED;FRONTEND_LDAP_SERVER_WRITE_ENABLED defaultValue: "true" type: bool description: Allow creating, modifying and deleting LDAP users via the GRAPH API. @@ -5481,17 +5485,16 @@ GRAPH_LDAP_UPDATE_LAST_SIGNIN_DATE: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_URI: - name: OCIS_LDAP_URI;GRAPH_LDAP_URI + name: OCIS_LDAP_URI;IDP_LDAP_URI defaultValue: ldaps://localhost:9235 type: string - description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' - and 'ldap://' + description: Url of the LDAP service to use as IDP. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" GRAPH_LDAP_USER_BASE_DN: - name: OCIS_LDAP_USER_BASE_DN;GRAPH_LDAP_USER_BASE_DN + name: OCIS_LDAP_USER_BASE_DN;IDP_LDAP_BASE_DN defaultValue: ou=users,o=libregraph-idm type: string description: Search base DN for looking up LDAP users. @@ -5500,25 +5503,25 @@ GRAPH_LDAP_USER_BASE_DN: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_USER_DISPLAYNAME_ATTRIBUTE: - name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;GRAPH_LDAP_USER_DISPLAYNAME_ATTRIBUTE - defaultValue: displayName + name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;GROUPS_LDAP_USER_SCHEMA_DISPLAYNAME + defaultValue: displayname 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 deprecationVersion: "" removalVersion: "" deprecationInfo: "" GRAPH_LDAP_USER_EMAIL_ATTRIBUTE: - name: OCIS_LDAP_USER_SCHEMA_MAIL;GRAPH_LDAP_USER_EMAIL_ATTRIBUTE + name: OCIS_LDAP_USER_SCHEMA_MAIL;IDP_LDAP_EMAIL_ATTRIBUTE defaultValue: mail type: string - description: LDAP Attribute to use for the email address of users. + description: LDAP User email attribute like 'mail'. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" GRAPH_LDAP_USER_FILTER: - name: OCIS_LDAP_USER_FILTER;GRAPH_LDAP_USER_FILTER + name: OCIS_LDAP_USER_FILTER;IDP_LDAP_FILTER defaultValue: "" type: string description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. @@ -5527,37 +5530,36 @@ GRAPH_LDAP_USER_FILTER: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_USER_NAME_ATTRIBUTE: - name: OCIS_LDAP_USER_SCHEMA_USERNAME;GRAPH_LDAP_USER_NAME_ATTRIBUTE - defaultValue: uid + name: OCIS_LDAP_USER_SCHEMA_USERNAME;IDP_LDAP_NAME_ATTRIBUTE + defaultValue: displayName type: string - description: LDAP Attribute to use for username of users. + description: LDAP User name attribute like 'displayName'. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" GRAPH_LDAP_USER_OBJECTCLASS: - name: OCIS_LDAP_USER_OBJECTCLASS;GRAPH_LDAP_USER_OBJECTCLASS + name: OCIS_LDAP_USER_OBJECTCLASS;IDP_LDAP_OBJECTCLASS defaultValue: inetOrgPerson type: string - description: The object class to use for users in the default user search filter - ('inetOrgPerson'). + description: LDAP User ObjectClass like 'inetOrgPerson'. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" GRAPH_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING: - name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;GRAPH_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING + name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;GROUPS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING defaultValue: "false" type: bool description: Set this to true if the defined 'ID' attribute for users is of the - 'OCTETSTRING' syntax. This is required when using the 'objectGUID' attribute of - Active Directory for the user ID's. + 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute + of Active Directory for the user ID's. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" GRAPH_LDAP_USER_SCOPE: - name: OCIS_LDAP_USER_SCOPE;GRAPH_LDAP_USER_SCOPE + name: OCIS_LDAP_USER_SCOPE;IDP_LDAP_SCOPE defaultValue: sub type: string description: LDAP search scope to use when looking up users. Supported scopes are @@ -5577,11 +5579,10 @@ GRAPH_LDAP_USER_TYPE_ATTRIBUTE: removalVersion: "" deprecationInfo: "" GRAPH_LDAP_USER_UID_ATTRIBUTE: - name: OCIS_LDAP_USER_SCHEMA_ID;GRAPH_LDAP_USER_UID_ATTRIBUTE - defaultValue: owncloudUUID + name: OCIS_LDAP_USER_SCHEMA_ID;IDP_LDAP_UUID_ATTRIBUTE + defaultValue: ownCloudUUID type: string - description: LDAP Attribute to use as the unique ID for users. This should be a - stable globally unique ID like a UUID. + description: LDAP User UUID attribute like 'uid'. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -5624,16 +5625,18 @@ GRAPH_LOG_PRETTY: removalVersion: "" deprecationInfo: "" GRAPH_MAX_CONCURRENCY: - name: OCIS_MAX_CONCURRENCY;GRAPH_MAX_CONCURRENCY - defaultValue: "20" + name: OCIS_MAX_CONCURRENCY;USERLOG_MAX_CONCURRENCY + defaultValue: "1" type: int - description: The maximum number of concurrent requests the service will handle. + 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: "" GRAPH_SERVICE_ACCOUNT_ID: - name: OCIS_SERVICE_ACCOUNT_ID;GRAPH_SERVICE_ACCOUNT_ID + name: OCIS_SERVICE_ACCOUNT_ID;USERLOG_SERVICE_ACCOUNT_ID defaultValue: "" type: string description: The ID of the service account the service should use. See the 'auth-service' @@ -5643,7 +5646,7 @@ GRAPH_SERVICE_ACCOUNT_ID: removalVersion: "" deprecationInfo: "" GRAPH_SERVICE_ACCOUNT_SECRET: - name: OCIS_SERVICE_ACCOUNT_SECRET;GRAPH_SERVICE_ACCOUNT_SECRET + name: OCIS_SERVICE_ACCOUNT_SECRET;USERLOG_SERVICE_ACCOUNT_SECRET defaultValue: "" type: string description: The service account secret. @@ -5763,18 +5766,18 @@ GRAPH_TRACING_TYPE: removalVersion: "" deprecationInfo: "" GRAPH_TRANSLATION_PATH: - name: OCIS_TRANSLATION_PATH;GRAPH_TRANSLATION_PATH + name: OCIS_TRANSLATION_PATH;USERLOG_TRANSLATION_PATH defaultValue: "" type: string description: (optional) Set this to a path with custom translations to overwrite the builtin translations. Note that file and folder naming rules apply, see the documentation for more details. - introductionVersion: 7.0.0 + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" GRAPH_USER_ENABLED_ATTRIBUTE: - name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;GRAPH_USER_ENABLED_ATTRIBUTE + name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;IDP_USER_ENABLED_ATTRIBUTE defaultValue: ownCloudUserEnabled type: string description: LDAP Attribute to use as a flag telling if the user is enabled or disabled. @@ -8269,7 +8272,7 @@ OCIS_ASSET_THEMES_PATH: removalVersion: "" deprecationInfo: "" OCIS_ASYNC_UPLOADS: - name: OCIS_ASYNC_UPLOADS + name: OCIS_ASYNC_UPLOADS;SEARCH_EVENTS_ASYNC_UPLOADS defaultValue: "true" type: bool description: Enable asynchronous file uploads. @@ -8278,39 +8281,36 @@ OCIS_ASYNC_UPLOADS: removalVersion: "" deprecationInfo: "" OCIS_CACHE_AUTH_PASSWORD: - name: OCIS_CACHE_AUTH_PASSWORD;STORAGE_SYSTEM_CACHE_AUTH_PASSWORD + name: OCIS_CACHE_AUTH_PASSWORD;SETTINGS_CACHE_AUTH_PASSWORD defaultValue: "" type: string - description: Password for the configured store. Only applies when store type 'nats-js-kv' - is configured. + description: The password to authenticate with the cache. Only applies when store + type 'nats-js-kv' is configured. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" - deprecationInfo: 'The use of OCIS_CACHE_AUTH_PASSWORD in the frontend service is - deprecated because the OCS API is deprecated OCS API is deprecated | | | | | | | | | ' + deprecationInfo: "" OCIS_CACHE_AUTH_USERNAME: - name: OCIS_CACHE_AUTH_USERNAME;STORAGE_SYSTEM_CACHE_AUTH_USERNAME + name: OCIS_CACHE_AUTH_USERNAME;SETTINGS_CACHE_AUTH_USERNAME defaultValue: "" type: string - description: Username for the configured store. Only applies when store type 'nats-js-kv' - is configured. + description: The username to authenticate with the cache. Only applies when store + type 'nats-js-kv' is configured. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" - deprecationInfo: 'The use of OCIS_CACHE_AUTH_USERNAME in the frontend service is - deprecated because the OCS API is deprecated OCS API is deprecated | | | | | | | | | ' + deprecationInfo: "" OCIS_CACHE_DATABASE: name: OCIS_CACHE_DATABASE - defaultValue: storage-system + defaultValue: settings-cache type: string description: The database name the configured store should use. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" - deprecationInfo: 'The use of OCIS_CACHE_DATABASE in the frontend service is deprecated - because the OCS API is deprecated | | | | | | ' + deprecationInfo: "" OCIS_CACHE_DISABLE_PERSISTENCE: - name: OCIS_CACHE_DISABLE_PERSISTENCE;STORAGE_SYSTEM_CACHE_DISABLE_PERSISTENCE + name: OCIS_CACHE_DISABLE_PERSISTENCE;SETTINGS_CACHE_DISABLE_PERSISTENCE defaultValue: "false" type: bool description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' @@ -8318,10 +8318,9 @@ OCIS_CACHE_DISABLE_PERSISTENCE: introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" - deprecationInfo: 'The use of OCIS_CACHE_DISABLE_PERSISTENCE in the frontend service - is deprecated because the OCS API is deprecated | | | | | | | | ' + deprecationInfo: "" OCIS_CACHE_ENABLE_TLS: - name: OCIS_CACHE_ENABLE_TLS;STORAGE_SYSTEM_CACHE_ENABLE_TLS + name: OCIS_CACHE_ENABLE_TLS;SETTINGS_CACHE_ENABLE_TLS defaultValue: "false" type: bool description: Activate TLS for the connection to the cache store. Only applies when @@ -8331,7 +8330,7 @@ OCIS_CACHE_ENABLE_TLS: removalVersion: "" deprecationInfo: "" OCIS_CACHE_STORE: - name: OCIS_CACHE_STORE;STORAGE_SYSTEM_CACHE_STORE + name: OCIS_CACHE_STORE;SETTINGS_CACHE_STORE defaultValue: memory type: string description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', @@ -8339,10 +8338,9 @@ OCIS_CACHE_STORE: introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" - deprecationInfo: 'The use of OCIS_CACHE_STORE in the frontend service is deprecated - because the OCS API is deprecated | | | | | | | | | ' + deprecationInfo: "" OCIS_CACHE_STORE_NODES: - name: OCIS_CACHE_STORE_NODES;STORAGE_SYSTEM_CACHE_STORE_NODES + name: OCIS_CACHE_STORE_NODES;SETTINGS_CACHE_STORE_NODES defaultValue: '[127.0.0.1:9233]' type: '[]string' description: A list of nodes to access the configured store. This has no effect @@ -8352,10 +8350,9 @@ OCIS_CACHE_STORE_NODES: introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" - deprecationInfo: 'The use of OCIS_CACHE_STORE_NODES in the frontend service is deprecated - because the OCS API is deprecated | | | | | | | | | ' + deprecationInfo: "" OCIS_CACHE_TLS_INSECURE: - name: OCIS_CACHE_TLS_INSECURE;STORAGE_SYSTEM_CACHE_TLS_INSECURE + name: OCIS_CACHE_TLS_INSECURE;SETTINGS_CACHE_TLS_INSECURE defaultValue: "false" type: bool description: Disable TLS certificate verification for the cache store connection. @@ -8365,7 +8362,7 @@ OCIS_CACHE_TLS_INSECURE: removalVersion: "" deprecationInfo: "" OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE: - name: OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE;STORAGE_SYSTEM_CACHE_TLS_ROOT_CA_CERTIFICATE + name: OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE;SETTINGS_CACHE_TLS_ROOT_CA_CERTIFICATE defaultValue: "" type: string description: Path to the PEM-encoded root CA certificate for the cache store TLS @@ -8375,17 +8372,16 @@ OCIS_CACHE_TLS_ROOT_CA_CERTIFICATE: removalVersion: "" deprecationInfo: "" OCIS_CACHE_TTL: - name: OCIS_CACHE_TTL;STORAGE_SYSTEM_CACHE_TTL - defaultValue: 24m0s + name: OCIS_CACHE_TTL;SETTINGS_CACHE_TTL + defaultValue: 10m0s type: Duration - description: Default time to live for user info in the user info cache. Only applied - when access tokens has no expiration. See the Environment Variable Types description - for more details. + description: Default time to live for entries in the cache. Only applied when access + tokens has no expiration. See the Environment Variable Types description for more + details. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" - deprecationInfo: 'The use of OCIS_CACHE_TTL in the frontend service is deprecated - because the OCS API is deprecated | | | | | | | | | ' + deprecationInfo: "" OCIS_CLAIM_MANAGED_SPACES_CLAIMNAME: name: OCIS_CLAIM_MANAGED_SPACES_CLAIMNAME defaultValue: "" @@ -8424,8 +8420,8 @@ OCIS_CLAIM_MANAGED_SPACES_REGEXP: removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_CREDENTIALS: - name: OCIS_CORS_ALLOW_CREDENTIALS;OCDAV_CORS_ALLOW_CREDENTIALS - defaultValue: "false" + name: OCIS_CORS_ALLOW_CREDENTIALS;USERLOG_CORS_ALLOW_CREDENTIALS + defaultValue: "true" type: bool description: 'Allow credentials for CORS.See following chapter for more details: *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' @@ -8434,11 +8430,9 @@ OCIS_CORS_ALLOW_CREDENTIALS: removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_HEADERS: - name: OCIS_CORS_ALLOW_HEADERS;OCDAV_CORS_ALLOW_HEADERS - defaultValue: '[Origin Accept Content-Type Depth Authorization Ocs-Apirequest If-None-Match - If-Match Destination Overwrite X-Request-Id X-Requested-With Tus-Resumable Tus-Checksum-Algorithm - Upload-Concat Upload-Length Upload-Metadata Upload-Defer-Length Upload-Expires - Upload-Checksum Upload-Offset X-HTTP-Method-Override Cache-Control]' + name: OCIS_CORS_ALLOW_HEADERS;USERLOG_CORS_ALLOW_HEADERS + defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id + Ocs-Apirequest]' type: '[]string' description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. @@ -8448,9 +8442,8 @@ OCIS_CORS_ALLOW_HEADERS: removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_METHODS: - name: OCIS_CORS_ALLOW_METHODS;OCDAV_CORS_ALLOW_METHODS - defaultValue: '[OPTIONS HEAD GET PUT POST DELETE MKCOL PROPFIND PROPPATCH MOVE COPY - REPORT SEARCH]' + name: OCIS_CORS_ALLOW_METHODS;USERLOG_CORS_ALLOW_METHODS + defaultValue: '[GET]' type: '[]string' description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. @@ -8460,8 +8453,8 @@ OCIS_CORS_ALLOW_METHODS: removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_ORIGINS: - name: OCIS_CORS_ALLOW_ORIGINS;OCDAV_CORS_ALLOW_ORIGINS - defaultValue: '[https://localhost:9200]' + name: OCIS_CORS_ALLOW_ORIGINS;USERLOG_CORS_ALLOW_ORIGINS + defaultValue: '[*]' type: '[]string' description: 'A list of allowed CORS origins. See following chapter for more details: *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. @@ -8510,7 +8503,7 @@ OCIS_DEFAULT_LANGUAGE: type: string description: The default language used by services and the WebUI. If not defined, English will be used as default. See the documentation for more details. - introductionVersion: 7.0.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8574,10 +8567,10 @@ OCIS_EMAIL_TEMPLATE_PATH: removalVersion: "" deprecationInfo: "" OCIS_ENABLE_OCM: - name: OCIS_ENABLE_OCM;GRAPH_INCLUDE_OCM_SHAREES + name: OCIS_ENABLE_OCM defaultValue: "false" type: bool - description: Include OCM sharees when listing users. + description: Include OCM sharees when listing sharees. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" @@ -8594,7 +8587,7 @@ OCIS_ENABLE_VAULT_MODE: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_AUTH_PASSWORD: - name: OCIS_EVENTS_AUTH_PASSWORD;AUDIT_EVENTS_AUTH_PASSWORD + name: OCIS_EVENTS_AUTH_PASSWORD;POSTPROCESSING_EVENTS_AUTH_PASSWORD defaultValue: "" type: string description: The password to authenticate with the events broker. The events broker @@ -8604,7 +8597,7 @@ OCIS_EVENTS_AUTH_PASSWORD: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_AUTH_USERNAME: - name: OCIS_EVENTS_AUTH_USERNAME;AUDIT_EVENTS_AUTH_USERNAME + name: OCIS_EVENTS_AUTH_USERNAME;POSTPROCESSING_EVENTS_AUTH_USERNAME defaultValue: "" type: string description: The username to authenticate with the events broker. The events broker @@ -8614,7 +8607,7 @@ OCIS_EVENTS_AUTH_USERNAME: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_CLUSTER: - name: OCIS_EVENTS_CLUSTER;AUDIT_EVENTS_CLUSTER + name: OCIS_EVENTS_CLUSTER;POSTPROCESSING_EVENTS_CLUSTER defaultValue: ocis-cluster type: string description: The clusterID of the event system. The event system is the message @@ -8625,7 +8618,7 @@ OCIS_EVENTS_CLUSTER: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_ENABLE_TLS: - name: OCIS_EVENTS_ENABLE_TLS;AUDIT_EVENTS_ENABLE_TLS + name: OCIS_EVENTS_ENABLE_TLS;POSTPROCESSING_EVENTS_ENABLE_TLS defaultValue: "false" type: bool description: Enable TLS for the connection to the events broker. The events broker @@ -8635,7 +8628,7 @@ OCIS_EVENTS_ENABLE_TLS: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_ENDPOINT: - name: OCIS_EVENTS_ENDPOINT;AUDIT_EVENTS_ENDPOINT + name: OCIS_EVENTS_ENDPOINT;POSTPROCESSING_EVENTS_ENDPOINT defaultValue: 127.0.0.1:9233 type: string description: The address of the event system. The event system is the message queuing @@ -8645,21 +8638,21 @@ OCIS_EVENTS_ENDPOINT: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE: - name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;AUDIT_EVENTS_TLS_ROOT_CA_CERTIFICATE + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;POSTPROCESSING_EVENTS_TLS_ROOT_CA_CERTIFICATE defaultValue: "" type: string description: The root CA certificate used to validate the server's TLS certificate. - If provided AUDIT_EVENTS_TLS_INSECURE will be seen as false. + If provided POSTPROCESSING_EVENTS_TLS_INSECURE will be seen as false. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_GATEWAY_GRPC_ADDR: - name: OCIS_GATEWAY_GRPC_ADDR;STORAGE_USERS_GATEWAY_GRPC_ADDR + name: OCIS_GATEWAY_GRPC_ADDR;GATEWAY_GRPC_ADDR defaultValue: 127.0.0.1:9142 type: string - description: The bind address of the gateway GRPC address. - introductionVersion: "5.0" + description: The bind address of the GRPC service. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8687,7 +8680,7 @@ OCIS_GRPC_CLIENT_TLS_MODE: removalVersion: "" deprecationInfo: "" OCIS_GRPC_PROTOCOL: - name: OCIS_GRPC_PROTOCOL;APP_REGISTRY_GRPC_PROTOCOL + name: OCIS_GRPC_PROTOCOL;STORAGE_SHARES_GRPC_PROTOCOL defaultValue: "" type: string description: The transport protocol of the GRPC service. @@ -8727,16 +8720,17 @@ OCIS_HTTP_TLS_KEY: removalVersion: "" deprecationInfo: "" OCIS_INSECURE: - name: OCIS_INSECURE;OCDAV_INSECURE + name: OCIS_INSECURE;POSTPROCESSING_EVENTS_TLS_INSECURE defaultValue: "false" type: bool - description: Allow insecure connections to the GATEWAY service. + description: Whether the ocis server should skip the client certificate verification + during the TLS handshake. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_JWT_SECRET: - name: OCIS_JWT_SECRET;APP_REGISTRY_JWT_SECRET + name: OCIS_JWT_SECRET;USERLOG_JWT_SECRET defaultValue: "" type: string description: The secret to mint and validate jwt tokens. @@ -8840,7 +8834,7 @@ OCIS_LDAP_CROSS_INSTANCE_REFERENCE_TEMPLATE: removalVersion: "" deprecationInfo: "" OCIS_LDAP_DISABLE_USER_MECHANISM: - name: OCIS_LDAP_DISABLE_USER_MECHANISM;USERS_LDAP_DISABLE_USER_MECHANISM + name: OCIS_LDAP_DISABLE_USER_MECHANISM;AUTH_BASIC_DISABLE_USER_MECHANISM defaultValue: attribute type: string description: An option to control the behavior for disabling users. Valid options @@ -8853,7 +8847,7 @@ OCIS_LDAP_DISABLE_USER_MECHANISM: removalVersion: "" deprecationInfo: "" 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;AUTH_BASIC_DISABLED_USERS_GROUP_DN defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm type: string description: The distinguished name of the group to which added users will be classified @@ -8883,7 +8877,7 @@ OCIS_LDAP_GROUP_AFFILIATION_ATTRIBUTE: removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_BASE_DN: - name: OCIS_LDAP_GROUP_BASE_DN;USERS_LDAP_GROUP_BASE_DN + name: OCIS_LDAP_GROUP_BASE_DN;GROUPS_LDAP_GROUP_BASE_DN defaultValue: ou=groups,o=libregraph-idm type: string description: Search base DN for looking up LDAP groups. @@ -8892,7 +8886,7 @@ OCIS_LDAP_GROUP_BASE_DN: removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_FILTER: - name: OCIS_LDAP_GROUP_FILTER;USERS_LDAP_GROUP_FILTER + name: OCIS_LDAP_GROUP_FILTER;GROUPS_LDAP_GROUP_FILTER defaultValue: "" type: string description: LDAP filter to add to the default filters for group searches. @@ -8901,17 +8895,17 @@ OCIS_LDAP_GROUP_FILTER: removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_OBJECTCLASS: - name: OCIS_LDAP_GROUP_OBJECTCLASS;USERS_LDAP_GROUP_OBJECTCLASS + name: OCIS_LDAP_GROUP_OBJECTCLASS;GROUPS_LDAP_GROUP_OBJECTCLASS defaultValue: groupOfNames type: string description: The object class to use for groups in the default group search filter - like 'groupOfNames'. + ('groupOfNames'). introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" 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 type: string description: LDAP Attribute to use for the displayname of groups (often the same @@ -8921,7 +8915,7 @@ OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME: removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCHEMA_GROUPNAME: - name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;USERS_LDAP_GROUP_SCHEMA_GROUPNAME + name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;GROUPS_LDAP_GROUP_SCHEMA_GROUPNAME defaultValue: cn type: string description: LDAP Attribute to use for the name of groups. @@ -8930,17 +8924,17 @@ OCIS_LDAP_GROUP_SCHEMA_GROUPNAME: removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCHEMA_ID: - name: OCIS_LDAP_GROUP_SCHEMA_ID;USERS_LDAP_GROUP_SCHEMA_ID + name: OCIS_LDAP_GROUP_SCHEMA_ID;GROUPS_LDAP_GROUP_SCHEMA_ID defaultValue: ownclouduuid type: string - description: LDAP Attribute to use as the unique ID for groups. This should be a + description: LDAP Attribute to use as the unique id for groups. This should be a stable globally unique ID like a UUID. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" 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;GROUPS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING defaultValue: "false" type: bool description: Set this to true if the defined 'id' attribute for groups is of the @@ -8951,7 +8945,7 @@ OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING: removalVersion: "" deprecationInfo: "" 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 type: string description: LDAP Attribute to use for the email address of groups (can be empty). @@ -8960,7 +8954,7 @@ OCIS_LDAP_GROUP_SCHEMA_MAIL: removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCHEMA_MEMBER: - name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;USERS_LDAP_GROUP_SCHEMA_MEMBER + name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;GROUPS_LDAP_GROUP_SCHEMA_MEMBER defaultValue: member type: string description: LDAP Attribute that is used for group members. @@ -8969,10 +8963,10 @@ OCIS_LDAP_GROUP_SCHEMA_MEMBER: removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCOPE: - name: OCIS_LDAP_GROUP_SCOPE;USERS_LDAP_GROUP_SCOPE + name: OCIS_LDAP_GROUP_SCOPE;GROUPS_LDAP_GROUP_SCOPE defaultValue: sub type: string - description: LDAP search scope to use when looking up groups. Supported values are + description: LDAP search scope to use when looking up groups. Supported scopes are 'base', 'one' and 'sub'. introductionVersion: pre5.0 deprecationVersion: "" @@ -9037,7 +9031,7 @@ OCIS_LDAP_INSTANCE_URL_TEMPLATE: removalVersion: "" deprecationInfo: "" OCIS_LDAP_POOL_CHECKOUT_TIMEOUT: - name: OCIS_LDAP_POOL_CHECKOUT_TIMEOUT;USERS_LDAP_POOL_CHECKOUT_TIMEOUT + name: OCIS_LDAP_POOL_CHECKOUT_TIMEOUT;GROUPS_LDAP_POOL_CHECKOUT_TIMEOUT defaultValue: 30s type: Duration description: Maximum time to wait for a pooled LDAP connection to become available @@ -9048,7 +9042,7 @@ OCIS_LDAP_POOL_CHECKOUT_TIMEOUT: removalVersion: "" deprecationInfo: "" OCIS_LDAP_POOL_ENABLED: - name: OCIS_LDAP_POOL_ENABLED;USERS_LDAP_POOL_ENABLED + name: OCIS_LDAP_POOL_ENABLED;GROUPS_LDAP_POOL_ENABLED defaultValue: "false" type: bool description: Enable a bounded pool of LDAP connections instead of a single long-lived @@ -9058,7 +9052,7 @@ OCIS_LDAP_POOL_ENABLED: removalVersion: "" deprecationInfo: "" OCIS_LDAP_POOL_SIZE: - name: OCIS_LDAP_POOL_SIZE;USERS_LDAP_POOL_SIZE + name: OCIS_LDAP_POOL_SIZE;GROUPS_LDAP_POOL_SIZE defaultValue: "5" type: int description: Maximum number of concurrently open LDAP connections when 'OCIS_LDAP_POOL_ENABLED' @@ -9078,7 +9072,7 @@ OCIS_LDAP_PRECISE_SEARCH_ATTRIBUTE: removalVersion: "" deprecationInfo: "" OCIS_LDAP_RETRY_BASE_DELAY: - name: OCIS_LDAP_RETRY_BASE_DELAY;USERS_LDAP_RETRY_BASE_DELAY + name: OCIS_LDAP_RETRY_BASE_DELAY;GROUPS_LDAP_RETRY_BASE_DELAY defaultValue: 0s type: Duration description: Base delay for exponential backoff between LDAP retries (e.g. '100ms'). @@ -9088,7 +9082,7 @@ OCIS_LDAP_RETRY_BASE_DELAY: removalVersion: "" deprecationInfo: "" OCIS_LDAP_RETRY_MAX_COUNT: - name: OCIS_LDAP_RETRY_MAX_COUNT;USERS_LDAP_RETRY_MAX_COUNT + name: OCIS_LDAP_RETRY_MAX_COUNT;GROUPS_LDAP_RETRY_MAX_COUNT defaultValue: "1" type: int description: Maximum number of retries for failed LDAP operations. Applies to both @@ -9098,7 +9092,7 @@ OCIS_LDAP_RETRY_MAX_COUNT: removalVersion: "" deprecationInfo: "" OCIS_LDAP_RETRY_MAX_DELAY: - name: OCIS_LDAP_RETRY_MAX_DELAY;USERS_LDAP_RETRY_MAX_DELAY + name: OCIS_LDAP_RETRY_MAX_DELAY;GROUPS_LDAP_RETRY_MAX_DELAY defaultValue: 0s type: Duration description: Maximum delay cap for exponential backoff between LDAP retries (e.g. @@ -9108,7 +9102,7 @@ OCIS_LDAP_RETRY_MAX_DELAY: removalVersion: "" deprecationInfo: "" 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" type: bool description: Allow creating, modifying and deleting LDAP users via the GRAPH API. @@ -9196,7 +9190,7 @@ OCIS_LDAP_USER_OBJECTCLASS: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_DISPLAYNAME: - name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;USERS_LDAP_USER_SCHEMA_DISPLAYNAME + name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;GROUPS_LDAP_USER_SCHEMA_DISPLAYNAME defaultValue: displayname type: string description: LDAP Attribute to use for the displayname of users. @@ -9225,7 +9219,7 @@ OCIS_LDAP_USER_SCHEMA_ID: removalVersion: "" deprecationInfo: "" 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;GROUPS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING defaultValue: "false" type: bool description: Set this to true if the defined 'ID' attribute for users is of the @@ -9274,7 +9268,7 @@ OCIS_LDAP_USER_SCOPE: removalVersion: "" deprecationInfo: "" OCIS_LOG_COLOR: - name: OCIS_LOG_COLOR;APP_REGISTRY_LOG_COLOR + name: OCIS_LOG_COLOR;POSTPROCESSING_LOG_COLOR defaultValue: "false" type: bool description: Activates colorized log output. @@ -9283,7 +9277,7 @@ OCIS_LOG_COLOR: removalVersion: "" deprecationInfo: "" OCIS_LOG_FILE: - name: OCIS_LOG_FILE;APP_REGISTRY_LOG_FILE + name: OCIS_LOG_FILE;POSTPROCESSING_LOG_FILE defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. @@ -9292,7 +9286,7 @@ OCIS_LOG_FILE: removalVersion: "" deprecationInfo: "" OCIS_LOG_LEVEL: - name: OCIS_LOG_LEVEL;APP_REGISTRY_LOG_LEVEL + name: OCIS_LOG_LEVEL;POSTPROCESSING_LOG_LEVEL defaultValue: "" type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', @@ -9302,7 +9296,7 @@ OCIS_LOG_LEVEL: removalVersion: "" deprecationInfo: "" OCIS_LOG_PRETTY: - name: OCIS_LOG_PRETTY;APP_REGISTRY_LOG_PRETTY + name: OCIS_LOG_PRETTY;POSTPROCESSING_LOG_PRETTY defaultValue: "false" type: bool description: Activates pretty log output. @@ -9311,23 +9305,23 @@ OCIS_LOG_PRETTY: removalVersion: "" deprecationInfo: "" OCIS_MACHINE_AUTH_API_KEY: - name: OCIS_MACHINE_AUTH_API_KEY;OCDAV_MACHINE_AUTH_API_KEY + name: OCIS_MACHINE_AUTH_API_KEY;PROXY_MACHINE_AUTH_API_KEY defaultValue: "" type: string - description: Machine auth API key used to validate internal requests necessary for - the access to resources from other services. + description: Machine auth API key used to validate internal requests necessary to + access resources from other services. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_MAX_CONCURRENCY: - name: OCIS_MAX_CONCURRENCY;STORAGE_USERS_S3NG_MAX_CONCURRENCY - defaultValue: "5" + name: OCIS_MAX_CONCURRENCY;USERLOG_MAX_CONCURRENCY + defaultValue: "1" 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 + or below will be ignored and the default value will be used. + introductionVersion: 7.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9414,9 +9408,10 @@ OCIS_MULTI_INSTANCE_MASTER_ID: name: OCIS_MULTI_INSTANCE_MASTER_ID defaultValue: "" type: string - description: The master instance ID for multi-instance setups. When set, LDAP user - filters are enhanced to also match users belonging to the master instance. - introductionVersion: "7.0" + description: The master ID that grants access to all instances. Users with this + ID in their memberOf or guestOf claims can access any instance. Leave empty to + disable. + introductionVersion: 8.1.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9451,17 +9446,16 @@ OCIS_OIDC_CLIENT_ID: removalVersion: "" deprecationInfo: "" OCIS_OIDC_ISSUER: - name: OCIS_URL;APP_PROVIDER_WOPI_FOLDER_URL_BASE_URL - defaultValue: https://localhost:9200/ + name: OCIS_URL;OCIS_OIDC_ISSUER + defaultValue: https://localhost:9200 type: string - description: Base url to navigate back from the app to the containing folder in - the file list. + description: The OIDC issuer URL to assign to the demo users. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST: - name: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST;SHARING_PASSWORD_POLICY_BANNED_PASSWORDS_LIST + name: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST;FRONTEND_PASSWORD_POLICY_BANNED_PASSWORDS_LIST defaultValue: "" type: string description: Path to the 'banned passwords list' file. This only impacts public @@ -9471,7 +9465,7 @@ OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_DISABLED: - name: OCIS_PASSWORD_POLICY_DISABLED;SHARING_PASSWORD_POLICY_DISABLED + name: OCIS_PASSWORD_POLICY_DISABLED;FRONTEND_PASSWORD_POLICY_DISABLED defaultValue: "false" type: bool description: Disable the password policy. Defaults to false if not set. @@ -9480,7 +9474,7 @@ OCIS_PASSWORD_POLICY_DISABLED: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_MIN_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_CHARACTERS defaultValue: "8" type: int description: Define the minimum password length. Defaults to 8 if not set. @@ -9489,7 +9483,7 @@ OCIS_PASSWORD_POLICY_MIN_CHARACTERS: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_MIN_DIGITS: - name: OCIS_PASSWORD_POLICY_MIN_DIGITS;SHARING_PASSWORD_POLICY_MIN_DIGITS + name: OCIS_PASSWORD_POLICY_MIN_DIGITS;FRONTEND_PASSWORD_POLICY_MIN_DIGITS defaultValue: "1" type: int description: Define the minimum number of digits. Defaults to 1 if not set. @@ -9498,7 +9492,7 @@ OCIS_PASSWORD_POLICY_MIN_DIGITS: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of uppercase letters. Defaults to 1 if not @@ -9508,7 +9502,7 @@ OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of characters from the special characters @@ -9518,7 +9512,7 @@ OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS: removalVersion: "" deprecationInfo: "" OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of lowercase letters. Defaults to 1 if not @@ -9528,37 +9522,37 @@ OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS: removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE: - name: OCIS_PERSISTENT_STORE;COLLABORATION_STORE + name: OCIS_PERSISTENT_STORE;POSTPROCESSING_STORE defaultValue: nats-js-kv type: string - description: 'The type of the store. Supported values are: ''memory'', ''nats-js-kv'', - ''redis-sentinel'', ''noop''. See the text description for details.' - introductionVersion: 7.0.0 + description: 'The type of the store. Supported values are: ''memory'', ''redis-sentinel'', + ''nats-js-kv'', ''noop''. See the text description for details.' + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE_AUTH_PASSWORD: - name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;COLLABORATION_STORE_AUTH_PASSWORD + name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;POSTPROCESSING_STORE_AUTH_PASSWORD defaultValue: "" type: string description: The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 7.0.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE_AUTH_USERNAME: - name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;COLLABORATION_STORE_AUTH_USERNAME + name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;POSTPROCESSING_STORE_AUTH_USERNAME defaultValue: "" type: string description: The username to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 7.0.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE_ENABLE_TLS: - name: OCIS_PERSISTENT_STORE_ENABLE_TLS;COLLABORATION_STORE_ENABLE_TLS + name: OCIS_PERSISTENT_STORE_ENABLE_TLS;POSTPROCESSING_STORE_ENABLE_TLS defaultValue: "false" type: bool description: Activate TLS for the connection to the store. Only applies when store @@ -9568,19 +9562,19 @@ OCIS_PERSISTENT_STORE_ENABLE_TLS: removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE_NODES: - name: OCIS_PERSISTENT_STORE_NODES;COLLABORATION_STORE_NODES + name: OCIS_PERSISTENT_STORE_NODES;POSTPROCESSING_STORE_NODES defaultValue: '[127.0.0.1:9233]' type: '[]string' description: A list of nodes to access the configured store. This has no effect when 'memory' store is configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. - introductionVersion: 7.0.0 + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE_TLS_INSECURE: - name: OCIS_PERSISTENT_STORE_TLS_INSECURE;COLLABORATION_STORE_TLS_INSECURE + name: OCIS_PERSISTENT_STORE_TLS_INSECURE;POSTPROCESSING_STORE_TLS_INSECURE defaultValue: "false" type: bool description: Disable TLS certificate verification for the store connection. Only @@ -9590,7 +9584,7 @@ OCIS_PERSISTENT_STORE_TLS_INSECURE: removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE: - name: OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE;COLLABORATION_STORE_TLS_ROOT_CA_CERTIFICATE + name: OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE;POSTPROCESSING_STORE_TLS_ROOT_CA_CERTIFICATE defaultValue: "" type: string description: Path to the PEM-encoded root CA certificate for the store TLS connection. @@ -9600,12 +9594,12 @@ OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE: removalVersion: "" deprecationInfo: "" OCIS_PERSISTENT_STORE_TTL: - name: OCIS_PERSISTENT_STORE_TTL;COLLABORATION_STORE_TTL - defaultValue: 30m0s + name: OCIS_PERSISTENT_STORE_TTL;POSTPROCESSING_STORE_TTL + defaultValue: 0s type: Duration - description: Time to live for events in the store. Defaults to '30m' (30 minutes). - See the Environment Variable Types description for more details. - introductionVersion: 7.0.0 + description: Time to live for events in the store. See the Environment Variable + Types description for more details. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9622,7 +9616,7 @@ OCIS_REVA_GATEWAY: name: OCIS_REVA_GATEWAY defaultValue: com.owncloud.api.gateway type: string - description: The CS3 gateway endpoint. + description: CS3 gateway used to look up user metadata introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -9650,7 +9644,7 @@ OCIS_REVA_GATEWAY_TLS_MODE: removalVersion: "" deprecationInfo: "" OCIS_SERVICE_ACCOUNT_ID: - name: OCIS_SERVICE_ACCOUNT_ID;STORAGE_USERS_SERVICE_ACCOUNT_ID + name: OCIS_SERVICE_ACCOUNT_ID;USERLOG_SERVICE_ACCOUNT_ID defaultValue: "" type: string description: The ID of the service account the service should use. See the 'auth-service' @@ -9660,7 +9654,7 @@ OCIS_SERVICE_ACCOUNT_ID: removalVersion: "" deprecationInfo: "" OCIS_SERVICE_ACCOUNT_SECRET: - name: OCIS_SERVICE_ACCOUNT_SECRET;STORAGE_USERS_SERVICE_ACCOUNT_SECRET + name: OCIS_SERVICE_ACCOUNT_SECRET;USERLOG_SERVICE_ACCOUNT_SECRET defaultValue: "" type: string description: The service account secret. @@ -9669,31 +9663,30 @@ OCIS_SERVICE_ACCOUNT_SECRET: removalVersion: "" deprecationInfo: "" OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD: - name: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD;SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD + name: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD defaultValue: "true" type: bool description: Set this to true if you want to enforce passwords on all public shares. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" - deprecationInfo: 'The OCS API is deprecated | ' + deprecationInfo: "" OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD: - name: OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD;SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD + name: OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD defaultValue: "false" type: bool - description: Set this to true if you want to enforce passwords on Uploader, Editor - or Contributor shares. + description: Set this to true if you want to enforce passwords for writable shares. + Only effective if the setting for 'passwords on all public shares' is set to false. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" - deprecationInfo: 'The OCS API is deprecated | ' + deprecationInfo: "" OCIS_SPACES_MAX_QUOTA: - name: OCIS_SPACES_MAX_QUOTA;STORAGE_USERS_OCIS_MAX_QUOTA + name: OCIS_SPACES_MAX_QUOTA;FRONTEND_MAX_QUOTA defaultValue: "0" type: uint64 - description: Set a global max quota for spaces in bytes. A value of 0 equals unlimited. - If not using the global OCIS_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA - in the frontend service. + description: Set the global max quota value in bytes. A value of 0 equals unlimited. + The value is provided via capabilities. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -9708,10 +9701,10 @@ OCIS_SYSTEM_USER_API_KEY: removalVersion: "" deprecationInfo: "" OCIS_SYSTEM_USER_ID: - name: OCIS_SYSTEM_USER_ID + name: OCIS_SYSTEM_USER_ID;SETTINGS_SYSTEM_USER_ID defaultValue: "" type: string - description: ID of the oCIS storage-system system user. Admins need to set the ID + description: ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format. @@ -9720,7 +9713,7 @@ OCIS_SYSTEM_USER_ID: removalVersion: "" deprecationInfo: "" OCIS_SYSTEM_USER_IDP: - name: OCIS_SYSTEM_USER_IDP;SHARING_PUBLIC_CS3_SYSTEM_USER_IDP + name: OCIS_SYSTEM_USER_IDP;SETTINGS_SYSTEM_USER_IDP defaultValue: internal type: string description: IDP of the oCIS STORAGE-SYSTEM system user. @@ -9729,40 +9722,40 @@ OCIS_SYSTEM_USER_IDP: removalVersion: "" deprecationInfo: "" OCIS_TRACING_COLLECTOR: - name: OCIS_TRACING_COLLECTOR;APP_REGISTRY_TRACING_COLLECTOR + name: OCIS_TRACING_COLLECTOR;POSTPROCESSING_TRACING_COLLECTOR defaultValue: "" type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: pre5.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_TRACING_ENABLED: - name: OCIS_TRACING_ENABLED;APP_REGISTRY_TRACING_ENABLED + name: OCIS_TRACING_ENABLED;POSTPROCESSING_TRACING_ENABLED defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: pre5.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_TRACING_ENDPOINT: - name: OCIS_TRACING_ENDPOINT;APP_REGISTRY_TRACING_ENDPOINT + name: OCIS_TRACING_ENDPOINT;POSTPROCESSING_TRACING_ENDPOINT defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: pre5.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_TRACING_TYPE: - name: OCIS_TRACING_TYPE;APP_REGISTRY_TRACING_TYPE + name: OCIS_TRACING_TYPE;POSTPROCESSING_TRACING_TYPE defaultValue: "" type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger', 'otlp' and '' as of now. - introductionVersion: pre5.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9776,41 +9769,41 @@ OCIS_TRANSFER_SECRET: removalVersion: "" deprecationInfo: "" OCIS_TRANSLATION_PATH: - name: OCIS_TRANSLATION_PATH;ACTIVITYLOG_TRANSLATION_PATH + name: OCIS_TRANSLATION_PATH;USERLOG_TRANSLATION_PATH defaultValue: "" type: string description: (optional) Set this to a path with custom translations to overwrite the builtin translations. Note that file and folder naming rules apply, see the documentation for more details. - introductionVersion: 7.0.0 + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_URL: - name: OCIS_URL;APP_PROVIDER_WOPI_FOLDER_URL_BASE_URL - defaultValue: https://localhost:9200/ + name: OCIS_URL;OCIS_OIDC_ISSUER + defaultValue: https://localhost:9200 type: string - description: Base url to navigate back from the app to the containing folder in - the file list. + description: The OIDC issuer URL to assign to the demo users. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_USER_SEARCH_DISPLAYED_ATTRIBUTES: - name: OCIS_USER_SEARCH_DISPLAYED_ATTRIBUTES + name: OCIS_USER_SEARCH_DISPLAYED_ATTRIBUTES;FRONTEND_USER_SEARCH_DISPLAYED_ATTRIBUTES defaultValue: '[]' type: '[]string' - description: The attributes to display in the user search results. + description: A list of user attributes to display in the user search results. introductionVersion: 7.3.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" 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" type: bool - description: Disable the chat functionality of the office app. - introductionVersion: pre5.0 + description: Disable chat in the office web frontend. This feature applies to OnlyOffice + and Microsoft. + introductionVersion: 7.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -10992,32 +10985,32 @@ POSTPROCESSING_STEPS: removalVersion: "" deprecationInfo: "" POSTPROCESSING_STORE: - name: OCIS_PERSISTENT_STORE;COLLABORATION_STORE + name: OCIS_PERSISTENT_STORE;POSTPROCESSING_STORE defaultValue: nats-js-kv type: string - description: 'The type of the store. Supported values are: ''memory'', ''nats-js-kv'', - ''redis-sentinel'', ''noop''. See the text description for details.' - introductionVersion: 7.0.0 + description: 'The type of the store. Supported values are: ''memory'', ''redis-sentinel'', + ''nats-js-kv'', ''noop''. See the text description for details.' + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" POSTPROCESSING_STORE_AUTH_PASSWORD: - name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;COLLABORATION_STORE_AUTH_PASSWORD + name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;POSTPROCESSING_STORE_AUTH_PASSWORD defaultValue: "" type: string description: The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 7.0.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" POSTPROCESSING_STORE_AUTH_USERNAME: - name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;COLLABORATION_STORE_AUTH_USERNAME + name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;POSTPROCESSING_STORE_AUTH_USERNAME defaultValue: "" type: string description: The username to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 7.0.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11031,7 +11024,7 @@ POSTPROCESSING_STORE_DATABASE: removalVersion: "" deprecationInfo: "" POSTPROCESSING_STORE_ENABLE_TLS: - name: OCIS_PERSISTENT_STORE_ENABLE_TLS;COLLABORATION_STORE_ENABLE_TLS + name: OCIS_PERSISTENT_STORE_ENABLE_TLS;POSTPROCESSING_STORE_ENABLE_TLS defaultValue: "false" type: bool description: Activate TLS for the connection to the store. Only applies when store @@ -11041,14 +11034,14 @@ POSTPROCESSING_STORE_ENABLE_TLS: removalVersion: "" deprecationInfo: "" POSTPROCESSING_STORE_NODES: - name: OCIS_PERSISTENT_STORE_NODES;COLLABORATION_STORE_NODES + name: OCIS_PERSISTENT_STORE_NODES;POSTPROCESSING_STORE_NODES defaultValue: '[127.0.0.1:9233]' type: '[]string' description: A list of nodes to access the configured store. This has no effect when 'memory' store is configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. - introductionVersion: 7.0.0 + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11062,7 +11055,7 @@ POSTPROCESSING_STORE_TABLE: removalVersion: "" deprecationInfo: "" POSTPROCESSING_STORE_TLS_INSECURE: - name: OCIS_PERSISTENT_STORE_TLS_INSECURE;COLLABORATION_STORE_TLS_INSECURE + name: OCIS_PERSISTENT_STORE_TLS_INSECURE;POSTPROCESSING_STORE_TLS_INSECURE defaultValue: "false" type: bool description: Disable TLS certificate verification for the store connection. Only @@ -11072,7 +11065,7 @@ POSTPROCESSING_STORE_TLS_INSECURE: removalVersion: "" deprecationInfo: "" POSTPROCESSING_STORE_TLS_ROOT_CA_CERTIFICATE: - name: OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE;COLLABORATION_STORE_TLS_ROOT_CA_CERTIFICATE + name: OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE;POSTPROCESSING_STORE_TLS_ROOT_CA_CERTIFICATE defaultValue: "" type: string description: Path to the PEM-encoded root CA certificate for the store TLS connection. @@ -11082,12 +11075,12 @@ POSTPROCESSING_STORE_TLS_ROOT_CA_CERTIFICATE: removalVersion: "" deprecationInfo: "" POSTPROCESSING_STORE_TTL: - name: OCIS_PERSISTENT_STORE_TTL;COLLABORATION_STORE_TTL - defaultValue: 30m0s + name: OCIS_PERSISTENT_STORE_TTL;POSTPROCESSING_STORE_TTL + defaultValue: 0s type: Duration - description: Time to live for events in the store. Defaults to '30m' (30 minutes). - See the Environment Variable Types description for more details. - introductionVersion: 7.0.0 + description: Time to live for events in the store. See the Environment Variable + Types description for more details. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -11962,7 +11955,7 @@ SEARCH_ENGINE_TYPE: removalVersion: "" deprecationInfo: "" SEARCH_EVENTS_ASYNC_UPLOADS: - name: OCIS_ASYNC_UPLOADS + name: OCIS_ASYNC_UPLOADS;SEARCH_EVENTS_ASYNC_UPLOADS defaultValue: "true" type: bool description: Enable asynchronous file uploads. @@ -12212,7 +12205,7 @@ SEARCH_TRACING_TYPE: removalVersion: "" deprecationInfo: "" SETTINGS_ADMIN_USER_ID: - name: OCIS_ADMIN_USER_ID;IDM_ADMIN_USER_ID + name: OCIS_ADMIN_USER_ID;SETTINGS_ADMIN_USER_ID defaultValue: "" type: string description: ID of the user that should receive admin privileges. Consider that @@ -12537,10 +12530,10 @@ SETTINGS_STORAGE_GRPC_ADDR: removalVersion: "" deprecationInfo: "" SETTINGS_SYSTEM_USER_ID: - name: OCIS_SYSTEM_USER_ID + name: OCIS_SYSTEM_USER_ID;SETTINGS_SYSTEM_USER_ID defaultValue: "" type: string - description: ID of the oCIS storage-system system user. Admins need to set the ID + description: ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format. @@ -12549,7 +12542,7 @@ SETTINGS_SYSTEM_USER_ID: removalVersion: "" deprecationInfo: "" SETTINGS_SYSTEM_USER_IDP: - name: OCIS_SYSTEM_USER_IDP;SHARING_PUBLIC_CS3_SYSTEM_USER_IDP + name: OCIS_SYSTEM_USER_IDP;SETTINGS_SYSTEM_USER_IDP defaultValue: internal type: string description: IDP of the oCIS STORAGE-SYSTEM system user. @@ -12596,13 +12589,13 @@ SETTINGS_TRACING_TYPE: removalVersion: "" deprecationInfo: "" SETTINGS_TRANSLATION_PATH: - name: OCIS_TRANSLATION_PATH;ACTIVITYLOG_TRANSLATION_PATH + name: OCIS_TRANSLATION_PATH;SETTINGS_TRANSLATION_PATH defaultValue: "" type: string description: (optional) Set this to a path with custom translations to overwrite the builtin translations. Note that file and folder naming rules apply, see the documentation for more details. - introductionVersion: 7.0.0 + introductionVersion: 7.1.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12722,8 +12715,8 @@ SHARING_GRPC_ADDR: removalVersion: "" deprecationInfo: "" SHARING_GRPC_PROTOCOL: - name: OCIS_GRPC_PROTOCOL;SHARING_GRPC_PROTOCOL - defaultValue: tcp + name: OCIS_GRPC_PROTOCOL;STORAGE_SHARES_GRPC_PROTOCOL + defaultValue: "" type: string description: The transport protocol of the GRPC service. introductionVersion: pre5.0 @@ -12786,7 +12779,7 @@ SHARING_OCM_PROVIDER_AUTHORIZER_DRIVER: removalVersion: "" deprecationInfo: "" SHARING_PASSWORD_POLICY_BANNED_PASSWORDS_LIST: - name: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST;SHARING_PASSWORD_POLICY_BANNED_PASSWORDS_LIST + name: OCIS_PASSWORD_POLICY_BANNED_PASSWORDS_LIST;FRONTEND_PASSWORD_POLICY_BANNED_PASSWORDS_LIST defaultValue: "" type: string description: Path to the 'banned passwords list' file. This only impacts public @@ -12796,7 +12789,7 @@ SHARING_PASSWORD_POLICY_BANNED_PASSWORDS_LIST: removalVersion: "" deprecationInfo: "" SHARING_PASSWORD_POLICY_DISABLED: - name: OCIS_PASSWORD_POLICY_DISABLED;SHARING_PASSWORD_POLICY_DISABLED + name: OCIS_PASSWORD_POLICY_DISABLED;FRONTEND_PASSWORD_POLICY_DISABLED defaultValue: "false" type: bool description: Disable the password policy. Defaults to false if not set. @@ -12805,7 +12798,7 @@ SHARING_PASSWORD_POLICY_DISABLED: removalVersion: "" deprecationInfo: "" SHARING_PASSWORD_POLICY_MIN_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_CHARACTERS defaultValue: "8" type: int description: Define the minimum password length. Defaults to 8 if not set. @@ -12814,7 +12807,7 @@ SHARING_PASSWORD_POLICY_MIN_CHARACTERS: removalVersion: "" deprecationInfo: "" SHARING_PASSWORD_POLICY_MIN_DIGITS: - name: OCIS_PASSWORD_POLICY_MIN_DIGITS;SHARING_PASSWORD_POLICY_MIN_DIGITS + name: OCIS_PASSWORD_POLICY_MIN_DIGITS;FRONTEND_PASSWORD_POLICY_MIN_DIGITS defaultValue: "1" type: int description: Define the minimum number of digits. Defaults to 1 if not set. @@ -12823,7 +12816,7 @@ SHARING_PASSWORD_POLICY_MIN_DIGITS: removalVersion: "" deprecationInfo: "" SHARING_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of uppercase letters. Defaults to 1 if not @@ -12833,7 +12826,7 @@ SHARING_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS: removalVersion: "" deprecationInfo: "" SHARING_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of characters from the special characters @@ -12843,7 +12836,7 @@ SHARING_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS: removalVersion: "" deprecationInfo: "" SHARING_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS: - name: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS;SHARING_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS + name: OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS;FRONTEND_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS defaultValue: "1" type: int description: Define the minimum number of lowercase letters. Defaults to 1 if not @@ -12952,7 +12945,7 @@ SHARING_PUBLIC_JSONCS3_SYSTEM_USER_IDP: removalVersion: "" deprecationInfo: "" SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD: - name: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD;SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD + name: OCIS_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD defaultValue: "true" type: bool description: Set this to true if you want to enforce passwords on all public shares. @@ -12961,11 +12954,11 @@ SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD: removalVersion: "" deprecationInfo: "" SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD: - name: OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD;SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD + name: OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD defaultValue: "false" type: bool - description: Set this to true if you want to enforce passwords on Uploader, Editor - or Contributor shares. + description: Set this to true if you want to enforce passwords for writable shares. + Only effective if the setting for 'passwords on all public shares' is set to false. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" @@ -13107,7 +13100,7 @@ SHARING_USER_JSONCS3_PROVIDER_ADDR: removalVersion: "" deprecationInfo: "" SHARING_USER_JSONCS3_SYSTEM_USER_API_KEY: - name: OCIS_SYSTEM_USER_API_KEY;SHARING_USER_JSONCS3_SYSTEM_USER_API_KEY + name: OCIS_SYSTEM_USER_API_KEY defaultValue: "" type: string description: API key for the STORAGE-SYSTEM system user. @@ -13116,7 +13109,7 @@ SHARING_USER_JSONCS3_SYSTEM_USER_API_KEY: removalVersion: "" deprecationInfo: "" SHARING_USER_JSONCS3_SYSTEM_USER_ID: - name: OCIS_SYSTEM_USER_ID;SHARING_USER_JSONCS3_SYSTEM_USER_ID + name: OCIS_SYSTEM_USER_ID;SETTINGS_SYSTEM_USER_ID defaultValue: "" type: string description: ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID @@ -13128,7 +13121,7 @@ SHARING_USER_JSONCS3_SYSTEM_USER_ID: removalVersion: "" deprecationInfo: "" SHARING_USER_JSONCS3_SYSTEM_USER_IDP: - name: OCIS_SYSTEM_USER_IDP;SHARING_USER_JSONCS3_SYSTEM_USER_IDP + name: OCIS_SYSTEM_USER_IDP;SETTINGS_SYSTEM_USER_IDP defaultValue: internal type: string description: IDP of the oCIS STORAGE-SYSTEM system user. @@ -13615,22 +13608,22 @@ STORAGE_PUBLICLINK_STORAGE_PROVIDER_MOUNT_ID: removalVersion: "" deprecationInfo: "" STORAGE_PUBLICLINK_STORE_AUTH_PASSWORD: - name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;STORAGE_PUBLICLINK_STORE_AUTH_PASSWORD + name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;POSTPROCESSING_STORE_AUTH_PASSWORD defaultValue: "" type: string description: The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.0.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" STORAGE_PUBLICLINK_STORE_AUTH_USERNAME: - name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;STORAGE_PUBLICLINK_STORE_AUTH_USERNAME + name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;POSTPROCESSING_STORE_AUTH_USERNAME defaultValue: "" type: string description: The username to authenticate with the store. Only applies when store type 'nats-js-kv' is configured. - introductionVersion: 8.0.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13644,7 +13637,7 @@ STORAGE_PUBLICLINK_STORE_DATABASE: removalVersion: "" deprecationInfo: "" STORAGE_PUBLICLINK_STORE_ENABLE_TLS: - name: OCIS_PERSISTENT_STORE_ENABLE_TLS;STORAGE_PUBLICLINK_STORE_ENABLE_TLS + name: OCIS_PERSISTENT_STORE_ENABLE_TLS;POSTPROCESSING_STORE_ENABLE_TLS defaultValue: "false" type: bool description: Activate TLS for the connection to the store. Only applies when store @@ -13654,24 +13647,24 @@ STORAGE_PUBLICLINK_STORE_ENABLE_TLS: removalVersion: "" deprecationInfo: "" STORAGE_PUBLICLINK_STORE_NODES: - name: OCIS_PERSISTENT_STORE_NODES;STORAGE_PUBLICLINK_STORE_NODES + name: OCIS_PERSISTENT_STORE_NODES;POSTPROCESSING_STORE_NODES defaultValue: '[127.0.0.1:9233]' type: '[]string' description: A list of nodes to access the configured store. This has no effect when 'memory' store is configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details. - introductionVersion: 8.0.0 + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" STORAGE_PUBLICLINK_STORE_STORE: - name: OCIS_PERSISTENT_STORE;STORAGE_PUBLICLINK_STORE_STORE + name: OCIS_PERSISTENT_STORE;POSTPROCESSING_STORE defaultValue: nats-js-kv type: string - description: 'The type of the store. Supported values are: ''memory'', ''nats-js-kv'', - ''redis-sentinel'', ''noop''. See the text description for details.' - introductionVersion: 8.0.0 + description: 'The type of the store. Supported values are: ''memory'', ''redis-sentinel'', + ''nats-js-kv'', ''noop''. See the text description for details.' + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13685,7 +13678,7 @@ STORAGE_PUBLICLINK_STORE_TABLE: removalVersion: "" deprecationInfo: "" STORAGE_PUBLICLINK_STORE_TLS_INSECURE: - name: OCIS_PERSISTENT_STORE_TLS_INSECURE;STORAGE_PUBLICLINK_STORE_TLS_INSECURE + name: OCIS_PERSISTENT_STORE_TLS_INSECURE;POSTPROCESSING_STORE_TLS_INSECURE defaultValue: "false" type: bool description: Disable TLS certificate verification for the store connection. Only @@ -13695,7 +13688,7 @@ STORAGE_PUBLICLINK_STORE_TLS_INSECURE: removalVersion: "" deprecationInfo: "" STORAGE_PUBLICLINK_STORE_TLS_ROOT_CA_CERTIFICATE: - name: OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE;STORAGE_PUBLICLINK_STORE_TLS_ROOT_CA_CERTIFICATE + name: OCIS_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE;POSTPROCESSING_STORE_TLS_ROOT_CA_CERTIFICATE defaultValue: "" type: string description: Path to the PEM-encoded root CA certificate for the store TLS connection. @@ -14602,11 +14595,11 @@ STORAGE_USERS_FILEMETADATA_CACHE_TTL: removalVersion: "" deprecationInfo: "" STORAGE_USERS_GATEWAY_GRPC_ADDR: - name: OCIS_GATEWAY_GRPC_ADDR;STORAGE_USERS_GATEWAY_GRPC_ADDR + name: OCIS_GATEWAY_GRPC_ADDR;GATEWAY_GRPC_ADDR defaultValue: 127.0.0.1:9142 type: string - description: The bind address of the gateway GRPC address. - introductionVersion: "5.0" + description: The bind address of the GRPC service. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14799,12 +14792,12 @@ STORAGE_USERS_LOG_PRETTY: removalVersion: "" deprecationInfo: "" STORAGE_USERS_MACHINE_AUTH_API_KEY: - name: OCIS_MACHINE_AUTH_API_KEY;STORAGE_USERS_MACHINE_AUTH_API_KEY + name: OCIS_MACHINE_AUTH_API_KEY;PROXY_MACHINE_AUTH_API_KEY defaultValue: "" type: string - description: Machine auth API key used to validate internal requests necessary for - the access to resources from other services. - introductionVersion: "5.0" + description: Machine auth API key used to validate internal requests necessary to + access resources from other services. + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14870,12 +14863,11 @@ STORAGE_USERS_OCIS_MAX_CONCURRENCY: removalVersion: "" deprecationInfo: "" STORAGE_USERS_OCIS_MAX_QUOTA: - name: OCIS_SPACES_MAX_QUOTA;STORAGE_USERS_OCIS_MAX_QUOTA + name: OCIS_SPACES_MAX_QUOTA;FRONTEND_MAX_QUOTA defaultValue: "0" type: uint64 - description: Set a global max quota for spaces in bytes. A value of 0 equals unlimited. - If not using the global OCIS_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA - in the frontend service. + description: Set the global max quota value in bytes. A value of 0 equals unlimited. + The value is provided via capabilities. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -15161,12 +15153,12 @@ STORAGE_USERS_PURGE_TRASH_BIN_PROJECT_DELETE_BEFORE: removalVersion: "" deprecationInfo: "" STORAGE_USERS_PURGE_TRASH_BIN_USER_ID: - name: OCIS_ADMIN_USER_ID;STORAGE_USERS_PURGE_TRASH_BIN_USER_ID + name: OCIS_ADMIN_USER_ID;IDM_ADMIN_USER_ID defaultValue: "" type: string - description: ID of the user who collects all necessary information for deletion. - Consider that the UUID can be encoded in some LDAP deployment configurations like - in .ldif files. These need to be decoded beforehand. + description: ID of the user that should receive admin privileges. Consider that + the UUID can be encoded in some LDAP deployment configurations like in .ldif files. + These need to be decoded beforehand. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -15498,46 +15490,46 @@ STORAGE_USERS_UPLOAD_EXPIRATION: removalVersion: "" deprecationInfo: "" THUMBNAILS_CORS_ALLOW_CREDENTIALS: - name: OCIS_CORS_ALLOW_CREDENTIALS;THUMBNAILS_CORS_ALLOW_CREDENTIALS + name: OCIS_CORS_ALLOW_CREDENTIALS;USERLOG_CORS_ALLOW_CREDENTIALS defaultValue: "true" type: bool description: 'Allow credentials for CORS.See following chapter for more details: *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' - introductionVersion: "6.0" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" THUMBNAILS_CORS_ALLOW_HEADERS: - name: OCIS_CORS_ALLOW_HEADERS;THUMBNAILS_CORS_ALLOW_HEADERS + name: OCIS_CORS_ALLOW_HEADERS;USERLOG_CORS_ALLOW_HEADERS defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id - Cache-Control]' + Ocs-Apirequest]' type: '[]string' description: 'A list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details.' - introductionVersion: "6.0" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" THUMBNAILS_CORS_ALLOW_METHODS: - name: OCIS_CORS_ALLOW_METHODS;THUMBNAILS_CORS_ALLOW_METHODS - defaultValue: '[GET POST PUT PATCH DELETE OPTIONS]' + name: OCIS_CORS_ALLOW_METHODS;USERLOG_CORS_ALLOW_METHODS + defaultValue: '[GET]' type: '[]string' description: 'A list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details.' - introductionVersion: "6.0" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" THUMBNAILS_CORS_ALLOW_ORIGINS: - name: OCIS_CORS_ALLOW_ORIGINS;THUMBNAILS_CORS_ALLOW_ORIGINS + name: OCIS_CORS_ALLOW_ORIGINS;USERLOG_CORS_ALLOW_ORIGINS defaultValue: '[*]' type: '[]string' description: 'A list of allowed CORS origins. See following chapter for more details: *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. See the Environment Variable Types description for more details.' - introductionVersion: "6.0" + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15635,7 +15627,7 @@ THUMBNAILS_HTTP_ROOT: removalVersion: "" deprecationInfo: "" THUMBNAILS_LOG_COLOR: - name: OCIS_LOG_COLOR;THUMBNAILS_LOG_COLOR + name: OCIS_LOG_COLOR;POSTPROCESSING_LOG_COLOR defaultValue: "false" type: bool description: Activates colorized log output. @@ -15644,7 +15636,7 @@ THUMBNAILS_LOG_COLOR: removalVersion: "" deprecationInfo: "" THUMBNAILS_LOG_FILE: - name: OCIS_LOG_FILE;THUMBNAILS_LOG_FILE + name: OCIS_LOG_FILE;POSTPROCESSING_LOG_FILE defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. @@ -15653,7 +15645,7 @@ THUMBNAILS_LOG_FILE: removalVersion: "" deprecationInfo: "" THUMBNAILS_LOG_LEVEL: - name: OCIS_LOG_LEVEL;THUMBNAILS_LOG_LEVEL + name: OCIS_LOG_LEVEL;POSTPROCESSING_LOG_LEVEL defaultValue: "" type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', @@ -15663,7 +15655,7 @@ THUMBNAILS_LOG_LEVEL: removalVersion: "" deprecationInfo: "" THUMBNAILS_LOG_PRETTY: - name: OCIS_LOG_PRETTY;THUMBNAILS_LOG_PRETTY + name: OCIS_LOG_PRETTY;POSTPROCESSING_LOG_PRETTY defaultValue: "false" type: bool description: Activates pretty log output. @@ -15723,40 +15715,40 @@ THUMBNAILS_RESOLUTIONS: removalVersion: "" deprecationInfo: "" THUMBNAILS_TRACING_COLLECTOR: - name: OCIS_TRACING_COLLECTOR;THUMBNAILS_TRACING_COLLECTOR + name: OCIS_TRACING_COLLECTOR;POSTPROCESSING_TRACING_COLLECTOR defaultValue: "" type: string description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset. - introductionVersion: pre5.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" THUMBNAILS_TRACING_ENABLED: - name: OCIS_TRACING_ENABLED;THUMBNAILS_TRACING_ENABLED + name: OCIS_TRACING_ENABLED;POSTPROCESSING_TRACING_ENABLED defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: pre5.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" THUMBNAILS_TRACING_ENDPOINT: - name: OCIS_TRACING_ENDPOINT;THUMBNAILS_TRACING_ENDPOINT + name: OCIS_TRACING_ENDPOINT;POSTPROCESSING_TRACING_ENDPOINT defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: pre5.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" THUMBNAILS_TRACING_TYPE: - name: OCIS_TRACING_TYPE;THUMBNAILS_TRACING_TYPE + name: OCIS_TRACING_TYPE;POSTPROCESSING_TRACING_TYPE defaultValue: "" type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger', 'otlp' and '' as of now. - introductionVersion: pre5.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -15779,10 +15771,11 @@ THUMBNAILS_TXT_FONTMAP_FILE: removalVersion: "" deprecationInfo: "" THUMBNAILS_WEBDAVSOURCE_INSECURE: - name: OCIS_INSECURE;THUMBNAILS_WEBDAVSOURCE_INSECURE + name: OCIS_INSECURE;POSTPROCESSING_EVENTS_TLS_INSECURE defaultValue: "false" type: bool - description: Ignore untrusted SSL certificates when connecting to the webdav source. + description: Whether the ocis server should skip the client certificate verification + during the TLS handshake. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -16360,7 +16353,7 @@ USERS_LDAP_GROUP_OBJECTCLASS: removalVersion: "" deprecationInfo: "" USERS_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 type: string description: LDAP Attribute to use for the displayname of groups (often the same @@ -16400,7 +16393,7 @@ USERS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING: removalVersion: "" deprecationInfo: "" USERS_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 type: string description: LDAP Attribute to use for the email address of groups (can be empty). @@ -17615,10 +17608,10 @@ WEBFINGER_LOG_PRETTY: removalVersion: "" deprecationInfo: "" WEBFINGER_OIDC_ISSUER: - name: OCIS_URL;OCIS_OIDC_ISSUER;WEBFINGER_OIDC_ISSUER + name: OCIS_URL;OCIS_OIDC_ISSUER defaultValue: https://localhost:9200 type: string - description: The identity provider href for the openid-discovery relation. + description: The OIDC issuer URL to assign to the demo users. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: ""