diff --git a/docs/helpers/env_vars.yaml b/docs/helpers/env_vars.yaml index 7e751f91e..672bda702 100644 --- a/docs/helpers/env_vars.yaml +++ b/docs/helpers/env_vars.yaml @@ -66,7 +66,7 @@ ACTIVITYLOG_STORE_SIZE: type: int description: The maximum quantity of items in the store. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package - though not explicitly set as default. + though not exclicitly set as default. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -2287,7 +2287,7 @@ COLLABORATION_APP_ADDR: defaultValue: https://127.0.0.1:9980 type: string description: The URL where the WOPI app is located, such as https://127.0.0.1:8080. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2296,7 +2296,7 @@ COLLABORATION_APP_DESCRIPTION: defaultValue: Open office documents with Collabora type: string description: App description - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2305,7 +2305,7 @@ COLLABORATION_APP_ICON: defaultValue: image-edit type: string description: Icon for the app - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2314,7 +2314,7 @@ COLLABORATION_APP_INSECURE: defaultValue: "false" type: bool description: Skip TLS certificate verification when connecting to the WOPI app - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2323,7 +2323,7 @@ COLLABORATION_APP_LOCKNAME: defaultValue: com.github.owncloud.collaboration type: string description: Name for the app lock - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2331,8 +2331,8 @@ COLLABORATION_APP_NAME: name: COLLABORATION_APP_NAME defaultValue: Collabora type: string - description: The name of the app - introductionVersion: '%%NEXT%%' + description: The name of the app, either Collabora, OnlyOffice or Microsoft365 + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2341,7 +2341,7 @@ COLLABORATION_CS3API_DATAGATEWAY_INSECURE: defaultValue: "false" type: bool description: Connect to the CS3API data gateway insecurely. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2349,8 +2349,8 @@ COLLABORATION_CS3API_GATEWAY_NAME: name: OCIS_REVA_GATEWAY;COLLABORATION_CS3API_GATEWAY_NAME defaultValue: com.owncloud.api.gateway type: string - description: The service name of the CS3API gateway. - introductionVersion: '%%NEXT%%' + description: CS3 gateway used to look up user metadata. + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2360,7 +2360,7 @@ COLLABORATION_DEBUG_ADDR: type: string description: Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2369,7 +2369,7 @@ COLLABORATION_DEBUG_PPROF: defaultValue: "false" type: bool description: Enables pprof, which can be used for profiling. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2378,7 +2378,7 @@ COLLABORATION_DEBUG_TOKEN: defaultValue: "" type: string description: Token to secure the metrics endpoint. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2388,7 +2388,7 @@ COLLABORATION_DEBUG_ZPAGES: type: bool description: Enables zpages, which can be used for collecting and viewing in-memory traces. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2397,7 +2397,7 @@ COLLABORATION_GRPC_ADDR: defaultValue: 127.0.0.1:9301 type: string description: The bind address of the GRPC service. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2406,7 +2406,7 @@ COLLABORATION_HTTP_ADDR: defaultValue: 127.0.0.1:9300 type: string description: The bind address of the HTTP service. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2424,7 +2424,7 @@ COLLABORATION_LOG_COLOR: defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2433,7 +2433,7 @@ COLLABORATION_LOG_FILE: defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2443,7 +2443,7 @@ COLLABORATION_LOG_LEVEL: type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2452,7 +2452,7 @@ COLLABORATION_LOG_PRETTY: defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2462,7 +2462,7 @@ COLLABORATION_TRACING_COLLECTOR: 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: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2471,7 +2471,7 @@ COLLABORATION_TRACING_ENABLED: defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2480,7 +2480,7 @@ COLLABORATION_TRACING_ENDPOINT: defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2490,7 +2490,7 @@ COLLABORATION_TRACING_TYPE: type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2500,7 +2500,7 @@ COLLABORATION_WOPI_SECRET: type: string description: Used to mint and verify WOPI JWT tokens and encrypt and decrypt the REVA JWT token embedded in the WOPI JWT token. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2511,7 +2511,7 @@ COLLABORATION_WOPI_SRC: description: The WOPISrc base URL containing schema, host and port. Set this to the schema and domain where the collaboration service is reachable for the wopi app, such as https://office.owncloud.test. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -2804,7 +2804,7 @@ FRONTEND_APP_HANDLER_SECURE_VIEW_APP_ADDR: type: string description: Service name or address of the app provider to use for secure view. Should match the service name or address of the registered CS3 app provider. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -6802,11 +6802,11 @@ NOTIFICATIONS_SMTP_ENCRYPTION: name: NOTIFICATIONS_SMTP_ENCRYPTION defaultValue: none type: string - description: Encryption method for the SMTP communication. Possible values are - 'starttls', 'ssl', 'ssltls', 'tls' and 'none'. + description: Encryption method for the SMTP communication. Possible values are 'starttls', + 'ssl', 'ssltls', 'tls' and 'none'. introductionVersion: pre5.0 deprecationVersion: 5.0.0 - removalVersion: 6.0.0 + removalVersion: 7.0.0 deprecationInfo: The NOTIFICATIONS_SMTP_ENCRYPTION values 'ssl' and 'tls' are deprecated and will be removed in the future. NOTIFICATIONS_SMTP_HOST: @@ -7226,12 +7226,12 @@ OCDAV_WEBDAV_NAMESPACE: removalVersion: "" deprecationInfo: "" OCIS_ADMIN_USER_ID: - name: OCIS_ADMIN_USER_ID;STORAGE_USERS_PURGE_TRASH_BIN_USER_ID + name: OCIS_ADMIN_USER_ID;IDM_ADMIN_USER_ID defaultValue: "" 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: "" @@ -7242,12 +7242,12 @@ OCIS_ASSET_THEMES_PATH: type: string description: Serve ownCloud themes from a path on the filesystem instead of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/web/assets/themes - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" 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. @@ -7256,28 +7256,28 @@ OCIS_ASYNC_UPLOADS: removalVersion: "" deprecationInfo: "" OCIS_CACHE_AUTH_PASSWORD: - name: OCIS_CACHE_AUTH_PASSWORD;STORAGE_USERS_ID_CACHE_AUTH_PASSWORD + name: OCIS_CACHE_AUTH_PASSWORD;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_PASSWORD defaultValue: "" type: string - description: The password to authenticate with the cache store. Only applies when - store type 'nats-js-kv' is configured. + description: The password to authenticate with the store. Only applies when store + type 'nats-js-kv' is configured. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_AUTH_USERNAME: - name: OCIS_CACHE_AUTH_USERNAME;STORAGE_USERS_ID_CACHE_AUTH_USERNAME + name: OCIS_CACHE_AUTH_USERNAME;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_AUTH_USERNAME defaultValue: "" type: string - description: The username to authenticate with the cache store. Only applies when - store type 'nats-js-kv' is configured. + description: The username to authenticate with the store. Only applies when store + type 'nats-js-kv' is configured. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_DATABASE: name: OCIS_CACHE_DATABASE - defaultValue: ids-storage-users + defaultValue: cache-userinfo type: string description: The database name the configured store should use. introductionVersion: pre5.0 @@ -7285,102 +7285,102 @@ OCIS_CACHE_DATABASE: removalVersion: "" deprecationInfo: "" OCIS_CACHE_DISABLE_PERSISTENCE: - name: OCIS_CACHE_DISABLE_PERSISTENCE;STORAGE_USERS_ID_CACHE_DISABLE_PERSISTENCE - defaultValue: "false" + name: OCIS_CACHE_DISABLE_PERSISTENCE;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_DISABLE_PERSISTENCE + defaultValue: "true" type: bool - description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' - is configured. Defaults to false. + description: Disables persistence of the store. Only applies when store type 'nats-js-kv' + is configured. Defaults to true. introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_SIZE: - name: OCIS_CACHE_SIZE;STORAGE_USERS_ID_CACHE_SIZE + name: OCIS_CACHE_SIZE;PROXY_OIDC_USERINFO_CACHE_SIZE defaultValue: "0" type: int description: The maximum quantity of items in the user info cache. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the - ocmem package though not exclicitly set as default. + ocmem package though not explicitly set as default. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_STORE: - name: OCIS_CACHE_STORE;STORAGE_USERS_ID_CACHE_STORE - defaultValue: memory + name: OCIS_CACHE_STORE;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE + defaultValue: nats-js-kv type: string - description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', - ''nats-js-kv'', ''noop''. See the text description for details.' - introductionVersion: pre5.0 + description: 'The type of the signing key store. Supported values are: ''redis-sentinel'', + ''nats-js-kv'' and ''ocisstoreservice'' (deprecated). See the text description + for details.' + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_STORE_NODES: - name: OCIS_CACHE_STORE_NODES;STORAGE_USERS_ID_CACHE_STORE_NODES + name: OCIS_CACHE_STORE_NODES;PROXY_PRESIGNEDURL_SIGNING_KEYS_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' or 'ocmem' stores are 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 + description: A list of nodes to access the configured store. 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: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CACHE_TTL: - name: OCIS_CACHE_TTL;STORAGE_USERS_ID_CACHE_TTL - defaultValue: 24m0s + name: OCIS_CACHE_TTL;PROXY_PRESIGNEDURL_SIGNING_KEYS_STORE_TTL + defaultValue: 12h0m0s type: Duration - description: Default time to live for user info in the user info cache. Only applied - when access tokens have no expiration. Defaults to 300s which is derived from - the underlaying package though not explicitly set as default. See the Environment - Variable Types description for more details. - introductionVersion: pre5.0 + description: Default time to live for signing keys. See the Environment Variable + Types description for more details. + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_CREDENTIALS: - name: OCIS_CORS_ALLOW_CREDENTIALS;STORAGE_USERS_CORS_ALLOW_CREDENTIALS + name: OCIS_CORS_ALLOW_CREDENTIALS;OCM_CORS_ALLOW_CREDENTIALS defaultValue: "false" 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: pre5.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_HEADERS: - name: OCIS_CORS_ALLOW_HEADERS;STORAGE_USERS_CORS_ALLOW_HEADERS - defaultValue: '[Authorization Origin X-Requested-With X-Request-Id X-HTTP-Method-Override - Content-Type Upload-Length Upload-Offset Tus-Resumable Upload-Metadata Upload-Defer-Length - Upload-Concat Upload-Incomplete Upload-Draft-Interop-Version]' + name: OCIS_CORS_ALLOW_HEADERS;OCM_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]' 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: pre5.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_METHODS: - name: OCIS_CORS_ALLOW_METHODS;STORAGE_USERS_CORS_ALLOW_METHODS - defaultValue: '[POST HEAD PATCH OPTIONS GET DELETE]' + name: OCIS_CORS_ALLOW_METHODS;OCM_CORS_ALLOW_METHODS + defaultValue: '[OPTIONS HEAD GET PUT POST 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. See the Environment Variable Types description for more details.' - introductionVersion: pre5.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_CORS_ALLOW_ORIGINS: - name: OCIS_CORS_ALLOW_ORIGINS;STORAGE_USERS_CORS_ALLOW_ORIGINS + name: OCIS_CORS_ALLOW_ORIGINS;OCM_CORS_ALLOW_ORIGINS defaultValue: '[https://localhost:9200]' 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: pre5.0 + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -7409,7 +7409,7 @@ OCIS_CORS_MAX_AGE: removalVersion: "" deprecationInfo: "" OCIS_DECOMPOSEDFS_METADATA_BACKEND: - name: OCIS_DECOMPOSEDFS_METADATA_BACKEND;STORAGE_USERS_OCIS_METADATA_BACKEND + name: OCIS_DECOMPOSEDFS_METADATA_BACKEND;STORAGE_SYSTEM_OCIS_METADATA_BACKEND defaultValue: messagepack type: string description: The backend to use for storing metadata. Supported values are 'messagepack' @@ -7499,7 +7499,7 @@ OCIS_ENABLE_RESHARING: removalVersion: "" deprecationInfo: Resharing will be removed in the future. OCIS_EVENTS_AUTH_PASSWORD: - name: OCIS_EVENTS_AUTH_PASSWORD;STORAGE_USERS_EVENTS_AUTH_PASSWORD + name: OCIS_EVENTS_AUTH_PASSWORD;AUDIT_EVENTS_AUTH_PASSWORD defaultValue: "" type: string description: The password to authenticate with the events broker. The events broker @@ -7509,7 +7509,7 @@ OCIS_EVENTS_AUTH_PASSWORD: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_AUTH_USERNAME: - name: OCIS_EVENTS_AUTH_USERNAME;STORAGE_USERS_EVENTS_AUTH_USERNAME + name: OCIS_EVENTS_AUTH_USERNAME;AUDIT_EVENTS_AUTH_USERNAME defaultValue: "" type: string description: The username to authenticate with the events broker. The events broker @@ -7519,7 +7519,7 @@ OCIS_EVENTS_AUTH_USERNAME: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_CLUSTER: - name: OCIS_EVENTS_CLUSTER;STORAGE_USERS_EVENTS_CLUSTER + name: OCIS_EVENTS_CLUSTER;AUDIT_EVENTS_CLUSTER defaultValue: ocis-cluster type: string description: The clusterID of the event system. The event system is the message @@ -7530,7 +7530,7 @@ OCIS_EVENTS_CLUSTER: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_ENABLE_TLS: - name: OCIS_EVENTS_ENABLE_TLS;STORAGE_USERS_EVENTS_ENABLE_TLS + name: OCIS_EVENTS_ENABLE_TLS;AUDIT_EVENTS_ENABLE_TLS defaultValue: "false" type: bool description: Enable TLS for the connection to the events broker. The events broker @@ -7540,7 +7540,7 @@ OCIS_EVENTS_ENABLE_TLS: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_ENDPOINT: - name: OCIS_EVENTS_ENDPOINT;STORAGE_USERS_EVENTS_ENDPOINT + name: OCIS_EVENTS_ENDPOINT;AUDIT_EVENTS_ENDPOINT defaultValue: 127.0.0.1:9233 type: string description: The address of the event system. The event system is the message queuing @@ -7550,21 +7550,21 @@ OCIS_EVENTS_ENDPOINT: removalVersion: "" deprecationInfo: "" OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE: - name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;STORAGE_USERS_EVENTS_TLS_ROOT_CA_CERTIFICATE + name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;AUDIT_EVENTS_TLS_ROOT_CA_CERTIFICATE defaultValue: "" type: string description: The root CA certificate used to validate the server's TLS certificate. - If provided STORAGE_USERS_EVENTS_TLS_INSECURE will be seen as false. + If provided AUDIT_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: "" @@ -7623,10 +7623,10 @@ OCIS_HTTP_TLS_KEY: removalVersion: "" deprecationInfo: "" OCIS_INSECURE: - name: OCIS_INSECURE;AUTH_BEARER_OIDC_INSECURE + name: OCIS_INSECURE;AUDIT_EVENTS_TLS_INSECURE defaultValue: "false" type: bool - description: Allow insecure connections to the OIDC issuer. + description: Whether to verify the server TLS certificates. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -7641,7 +7641,7 @@ OCIS_JWT_SECRET: removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_BASE_PATH: - name: OCIS_KEYCLOAK_BASE_PATH;GRAPH_KEYCLOAK_BASE_PATH + name: OCIS_KEYCLOAK_BASE_PATH;INVITATIONS_KEYCLOAK_BASE_PATH defaultValue: "" type: string description: The URL to access keycloak. @@ -7650,16 +7650,16 @@ OCIS_KEYCLOAK_BASE_PATH: removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_CLIENT_ID: - name: OCIS_KEYCLOAK_CLIENT_ID;GRAPH_KEYCLOAK_CLIENT_ID + name: OCIS_KEYCLOAK_CLIENT_ID;INVITATIONS_KEYCLOAK_CLIENT_ID defaultValue: "" type: string - description: The client id to authenticate with keycloak. + description: The client ID to authenticate with keycloak. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_CLIENT_REALM: - name: OCIS_KEYCLOAK_CLIENT_REALM;GRAPH_KEYCLOAK_CLIENT_REALM + name: OCIS_KEYCLOAK_CLIENT_REALM;INVITATIONS_KEYCLOAK_CLIENT_REALM defaultValue: "" type: string description: The realm the client is defined in. @@ -7668,7 +7668,7 @@ OCIS_KEYCLOAK_CLIENT_REALM: removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_CLIENT_SECRET: - name: OCIS_KEYCLOAK_CLIENT_SECRET;GRAPH_KEYCLOAK_CLIENT_SECRET + name: OCIS_KEYCLOAK_CLIENT_SECRET;INVITATIONS_KEYCLOAK_CLIENT_SECRET defaultValue: "" type: string description: The client secret to use in authentication. @@ -7677,7 +7677,7 @@ OCIS_KEYCLOAK_CLIENT_SECRET: removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY: - name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;GRAPH_KEYCLOAK_INSECURE_SKIP_VERIFY + name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;INVITATIONS_KEYCLOAK_INSECURE_SKIP_VERIFY defaultValue: "false" type: bool description: Disable TLS certificate validation for Keycloak connections. Do not @@ -7687,7 +7687,7 @@ OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY: removalVersion: "" deprecationInfo: "" OCIS_KEYCLOAK_USER_REALM: - name: OCIS_KEYCLOAK_USER_REALM;GRAPH_KEYCLOAK_USER_REALM + name: OCIS_KEYCLOAK_USER_REALM;INVITATIONS_KEYCLOAK_USER_REALM defaultValue: "" type: string description: The realm users are defined. @@ -7696,8 +7696,8 @@ OCIS_KEYCLOAK_USER_REALM: removalVersion: "" deprecationInfo: "" OCIS_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;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. @@ -7706,7 +7706,7 @@ OCIS_LDAP_BIND_DN: removalVersion: "" deprecationInfo: "" OCIS_LDAP_BIND_PASSWORD: - name: OCIS_LDAP_BIND_PASSWORD;GRAPH_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'. @@ -7715,7 +7715,7 @@ OCIS_LDAP_BIND_PASSWORD: removalVersion: "" deprecationInfo: "" OCIS_LDAP_CACERT: - name: OCIS_LDAP_CACERT;GRAPH_LDAP_CACERT + name: OCIS_LDAP_CACERT;AUTH_BASIC_LDAP_CACERT defaultValue: /var/lib/ocis/idm/ldap.crt type: string description: Path/File name for the root CA certificate (in PEM format) used to @@ -7726,20 +7726,20 @@ OCIS_LDAP_CACERT: removalVersion: "" deprecationInfo: "" OCIS_LDAP_DISABLE_USER_MECHANISM: - name: OCIS_LDAP_DISABLE_USER_MECHANISM;GRAPH_DISABLE_USER_MECHANISM + name: OCIS_LDAP_DISABLE_USER_MECHANISM;AUTH_BASIC_DISABLE_USER_MECHANISM defaultValue: attribute 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: "" OCIS_LDAP_DISABLED_USERS_GROUP_DN: - name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;GRAPH_DISABLED_USERS_GROUP_DN + name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;AUTH_BASIC_DISABLED_USERS_GROUP_DN defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm type: string description: The distinguished name of the group to which added users will be classified @@ -7749,7 +7749,7 @@ OCIS_LDAP_DISABLED_USERS_GROUP_DN: removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_BASE_DN: - name: OCIS_LDAP_GROUP_BASE_DN;GRAPH_LDAP_GROUP_BASE_DN + name: OCIS_LDAP_GROUP_BASE_DN;AUTH_BASIC_LDAP_GROUP_BASE_DN defaultValue: ou=groups,o=libregraph-idm type: string description: Search base DN for looking up LDAP groups. @@ -7758,7 +7758,7 @@ OCIS_LDAP_GROUP_BASE_DN: removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_FILTER: - name: OCIS_LDAP_GROUP_FILTER;GRAPH_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. @@ -7767,7 +7767,7 @@ OCIS_LDAP_GROUP_FILTER: removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_OBJECTCLASS: - name: OCIS_LDAP_GROUP_OBJECTCLASS;GRAPH_LDAP_GROUP_OBJECTCLASS + name: OCIS_LDAP_GROUP_OBJECTCLASS;AUTH_BASIC_LDAP_GROUP_OBJECTCLASS defaultValue: groupOfNames type: string description: The object class to use for groups in the default group search filter @@ -7777,7 +7777,7 @@ OCIS_LDAP_GROUP_OBJECTCLASS: removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME: - name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;USERS_LDAP_GROUP_SCHEMA_DISPLAYNAME + name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;AUTH_BASIC_LDAP_GROUP_SCHEMA_DISPLAYNAME defaultValue: cn type: string description: LDAP Attribute to use for the displayname of groups (often the same @@ -7787,7 +7787,7 @@ OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME: removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCHEMA_GROUPNAME: - name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;GRAPH_LDAP_GROUP_NAME_ATTRIBUTE + name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;AUTH_BASIC_LDAP_GROUP_SCHEMA_GROUPNAME defaultValue: cn type: string description: LDAP Attribute to use for the name of groups. @@ -7796,28 +7796,28 @@ OCIS_LDAP_GROUP_SCHEMA_GROUPNAME: removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCHEMA_ID: - name: OCIS_LDAP_GROUP_SCHEMA_ID;GRAPH_LDAP_GROUP_ID_ATTRIBUTE - defaultValue: owncloudUUID + 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. + stable globally unique id (e.g. a UUID). introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING: - name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;GRAPH_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING + name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;AUTH_BASIC_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING defaultValue: "false" 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 IDs. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCHEMA_MAIL: - name: OCIS_LDAP_GROUP_SCHEMA_MAIL;USERS_LDAP_GROUP_SCHEMA_MAIL + name: OCIS_LDAP_GROUP_SCHEMA_MAIL;AUTH_BASIC_LDAP_GROUP_SCHEMA_MAIL defaultValue: mail type: string description: LDAP Attribute to use for the email address of groups (can be empty). @@ -7826,7 +7826,7 @@ OCIS_LDAP_GROUP_SCHEMA_MAIL: removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCHEMA_MEMBER: - name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;GRAPH_LDAP_GROUP_MEMBER_ATTRIBUTE + name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;AUTH_BASIC_LDAP_GROUP_SCHEMA_MEMBER defaultValue: member type: string description: LDAP Attribute that is used for group members. @@ -7835,17 +7835,17 @@ OCIS_LDAP_GROUP_SCHEMA_MEMBER: removalVersion: "" deprecationInfo: "" OCIS_LDAP_GROUP_SCOPE: - name: OCIS_LDAP_GROUP_SCOPE;GRAPH_LDAP_GROUP_SEARCH_SCOPE + name: OCIS_LDAP_GROUP_SCOPE;AUTH_BASIC_LDAP_GROUP_SCOPE defaultValue: sub type: string - description: LDAP search scope to use when looking up groups. Supported scopes are + description: LDAP search scope to use when looking up groups. Supported values are 'base', 'one' and 'sub'. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_INSECURE: - name: OCIS_LDAP_INSECURE;GRAPH_LDAP_INSECURE + name: OCIS_LDAP_INSECURE;AUTH_BASIC_LDAP_INSECURE defaultValue: "false" type: bool description: Disable TLS certificate validation for the LDAP connections. Do not @@ -7855,7 +7855,7 @@ OCIS_LDAP_INSECURE: 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. @@ -7867,7 +7867,7 @@ OCIS_LDAP_SERVER_WRITE_ENABLED: removalVersion: "" deprecationInfo: "" OCIS_LDAP_URI: - name: OCIS_LDAP_URI;GRAPH_LDAP_URI + name: OCIS_LDAP_URI;AUTH_BASIC_LDAP_URI defaultValue: ldaps://localhost:9235 type: string description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' @@ -7877,7 +7877,7 @@ OCIS_LDAP_URI: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_BASE_DN: - name: OCIS_LDAP_USER_BASE_DN;GRAPH_LDAP_USER_BASE_DN + name: OCIS_LDAP_USER_BASE_DN;AUTH_BASIC_LDAP_USER_BASE_DN defaultValue: ou=users,o=libregraph-idm type: string description: Search base DN for looking up LDAP users. @@ -7886,16 +7886,16 @@ OCIS_LDAP_USER_BASE_DN: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_ENABLED_ATTRIBUTE: - name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;GRAPH_USER_ENABLED_ATTRIBUTE + name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;AUTH_BASIC_LDAP_USER_ENABLED_ATTRIBUTE defaultValue: ownCloudUserEnabled 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: "" OCIS_LDAP_USER_FILTER: - name: OCIS_LDAP_USER_FILTER;GRAPH_LDAP_USER_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)'. @@ -7904,7 +7904,7 @@ OCIS_LDAP_USER_FILTER: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_OBJECTCLASS: - name: OCIS_LDAP_USER_OBJECTCLASS;GRAPH_LDAP_USER_OBJECTCLASS + name: OCIS_LDAP_USER_OBJECTCLASS;AUTH_BASIC_LDAP_USER_OBJECTCLASS defaultValue: inetOrgPerson type: string description: The object class to use for users in the default user search filter @@ -7914,7 +7914,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;AUTH_BASIC_LDAP_USER_SCHEMA_DISPLAYNAME defaultValue: displayname type: string description: LDAP Attribute to use for the displayname of users. @@ -7923,8 +7923,8 @@ OCIS_LDAP_USER_SCHEMA_DISPLAYNAME: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_ID: - name: OCIS_LDAP_USER_SCHEMA_ID;GRAPH_LDAP_USER_UID_ATTRIBUTE - defaultValue: owncloudUUID + name: OCIS_LDAP_USER_SCHEMA_ID;AUTH_BASIC_LDAP_USER_SCHEMA_ID + 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. @@ -7933,18 +7933,18 @@ OCIS_LDAP_USER_SCHEMA_ID: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING: - name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;GRAPH_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING + name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;AUTH_BASIC_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING defaultValue: "false" 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 IDs. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_MAIL: - name: OCIS_LDAP_USER_SCHEMA_MAIL;GRAPH_LDAP_USER_EMAIL_ATTRIBUTE + name: OCIS_LDAP_USER_SCHEMA_MAIL;AUTH_BASIC_LDAP_USER_SCHEMA_MAIL defaultValue: mail type: string description: LDAP Attribute to use for the email address of users. @@ -7953,7 +7953,7 @@ OCIS_LDAP_USER_SCHEMA_MAIL: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_USER_TYPE: - name: OCIS_LDAP_USER_SCHEMA_USER_TYPE;GRAPH_LDAP_USER_TYPE_ATTRIBUTE + name: OCIS_LDAP_USER_SCHEMA_USER_TYPE;USERS_LDAP_USER_TYPE_ATTRIBUTE defaultValue: ownCloudUserType type: string description: LDAP Attribute to distinguish between 'Member' and 'Guest' users. Default @@ -7963,7 +7963,7 @@ OCIS_LDAP_USER_SCHEMA_USER_TYPE: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCHEMA_USERNAME: - name: OCIS_LDAP_USER_SCHEMA_USERNAME;GRAPH_LDAP_USER_NAME_ATTRIBUTE + name: OCIS_LDAP_USER_SCHEMA_USERNAME;AUTH_BASIC_LDAP_USER_SCHEMA_USERNAME defaultValue: uid type: string description: LDAP Attribute to use for username of users. @@ -7972,59 +7972,59 @@ OCIS_LDAP_USER_SCHEMA_USERNAME: removalVersion: "" deprecationInfo: "" OCIS_LDAP_USER_SCOPE: - name: OCIS_LDAP_USER_SCOPE;GRAPH_LDAP_USER_SCOPE + name: OCIS_LDAP_USER_SCOPE;AUTH_BASIC_LDAP_USER_SCOPE defaultValue: sub 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: "" OCIS_LOG_COLOR: - name: OCIS_LOG_COLOR;COLLABORATION_LOG_COLOR + name: OCIS_LOG_COLOR;AUDIT_LOG_COLOR defaultValue: "false" type: bool description: Activates colorized log output. - introductionVersion: '%%NEXT%%' + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LOG_FILE: - name: OCIS_LOG_FILE;COLLABORATION_LOG_FILE + name: OCIS_LOG_FILE;AUDIT_LOG_FILE defaultValue: "" type: string description: The path to the log file. Activates logging to this file if set. - introductionVersion: '%%NEXT%%' + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LOG_LEVEL: - name: OCIS_LOG_LEVEL;COLLABORATION_LOG_LEVEL + name: OCIS_LOG_LEVEL;AUDIT_LOG_LEVEL defaultValue: "" type: string description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', ''warn'', ''info'', ''debug'', ''trace''.' - introductionVersion: '%%NEXT%%' + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_LOG_PRETTY: - name: OCIS_LOG_PRETTY;COLLABORATION_LOG_PRETTY + name: OCIS_LOG_PRETTY;AUDIT_LOG_PRETTY defaultValue: "false" type: bool description: Activates pretty log output. - introductionVersion: '%%NEXT%%' + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_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: "" @@ -8040,10 +8040,11 @@ OCIS_OIDC_CLIENT_ID: removalVersion: "" deprecationInfo: "" OCIS_OIDC_ISSUER: - name: OCIS_URL;OCIS_OIDC_ISSUER;AUTH_BEARER_OIDC_ISSUER + name: OCIS_URL;OCIS_OIDC_ISSUER;AUTH_BASIC_IDP_URL defaultValue: https://localhost:9200 type: string - description: URL of the OIDC issuer. It defaults to URL of the builtin IDP. + description: The identity provider value to set in the userids of the CS3 user objects + for users returned by this user provider. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -8189,11 +8190,11 @@ OCIS_PUBLIC_URL: removalVersion: "" deprecationInfo: "" OCIS_REVA_GATEWAY: - name: OCIS_REVA_GATEWAY;COLLABORATION_CS3API_GATEWAY_NAME + name: OCIS_REVA_GATEWAY defaultValue: com.owncloud.api.gateway type: string - description: The service name of the CS3API gateway. - introductionVersion: '%%NEXT%%' + description: CS3 gateway used to look up user metadata + introductionVersion: "5.0" deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8220,7 +8221,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;ACTIVITYLOG_SERVICE_ACCOUNT_ID defaultValue: "" type: string description: The ID of the service account the service should use. See the 'auth-service' @@ -8230,7 +8231,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;ACTIVITYOG_SERVICE_ACCOUNT_SECRET defaultValue: "" type: string description: The service account secret. @@ -8262,17 +8263,16 @@ OCIS_SHOW_USER_EMAIL_IN_RESULTS: defaultValue: "false" type: bool description: Mask user email addresses in responses. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" 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: "" @@ -8299,7 +8299,7 @@ OCIS_SYSTEM_USER_ID: removalVersion: "" deprecationInfo: "" OCIS_SYSTEM_USER_IDP: - name: OCIS_SYSTEM_USER_IDP;SETTINGS_SYSTEM_USER_IDP + name: OCIS_SYSTEM_USER_IDP;SHARING_PUBLIC_CS3_SYSTEM_USER_IDP defaultValue: internal type: string description: IDP of the oCIS STORAGE-SYSTEM system user. @@ -8308,40 +8308,40 @@ OCIS_SYSTEM_USER_IDP: removalVersion: "" deprecationInfo: "" OCIS_TRACING_COLLECTOR: - name: OCIS_TRACING_COLLECTOR;COLLABORATION_TRACING_COLLECTOR + name: OCIS_TRACING_COLLECTOR;AUDIT_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: '%%NEXT%%' + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_TRACING_ENABLED: - name: OCIS_TRACING_ENABLED;COLLABORATION_TRACING_ENABLED + name: OCIS_TRACING_ENABLED;AUDIT_TRACING_ENABLED defaultValue: "false" type: bool description: Activates tracing. - introductionVersion: '%%NEXT%%' + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_TRACING_ENDPOINT: - name: OCIS_TRACING_ENDPOINT;COLLABORATION_TRACING_ENDPOINT + name: OCIS_TRACING_ENDPOINT;AUDIT_TRACING_ENDPOINT defaultValue: "" type: string description: The endpoint of the tracing agent. - introductionVersion: '%%NEXT%%' + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" OCIS_TRACING_TYPE: - name: OCIS_TRACING_TYPE;COLLABORATION_TRACING_TYPE + name: OCIS_TRACING_TYPE;AUDIT_TRACING_TYPE defaultValue: "" type: string description: The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. - introductionVersion: '%%NEXT%%' + introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -8366,10 +8366,11 @@ OCIS_TRANSLATION_PATH: removalVersion: "" deprecationInfo: "" OCIS_URL: - name: OCIS_URL;OCIS_OIDC_ISSUER;AUTH_BEARER_OIDC_ISSUER + name: OCIS_URL;OCIS_OIDC_ISSUER;AUTH_BASIC_IDP_URL defaultValue: https://localhost:9200 type: string - description: URL of the OIDC issuer. It defaults to URL of the builtin IDP. + description: The identity provider value to set in the userids of the CS3 user objects + for users returned by this user provider. introductionVersion: pre5.0 deprecationVersion: "" removalVersion: "" @@ -9569,7 +9570,7 @@ PROXY_AUTOPROVISION_CLAIM_DISPLAYNAME: defaultValue: name type: string description: The name of the OIDC claim that holds the display name. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9578,7 +9579,7 @@ PROXY_AUTOPROVISION_CLAIM_EMAIL: defaultValue: email type: string description: The name of the OIDC claim that holds the email. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9587,7 +9588,7 @@ PROXY_AUTOPROVISION_CLAIM_USERNAME: defaultValue: preferred_username type: string description: The name of the OIDC claim that holds the username. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -9596,7 +9597,7 @@ PROXY_CSP_CONFIG_FILE_LOCATION: defaultValue: "" type: string description: The location of the CSP configuration file. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12846,7 +12847,7 @@ STORAGE_USERS_OCIS_GENERAL_SPACE_PATH_TEMPLATE: defaultValue: "" type: string description: Template string to construct the paths of the projects space roots. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -12929,7 +12930,7 @@ STORAGE_USERS_OCIS_PERSONAL_SPACE_PATH_TEMPLATE: defaultValue: "" type: string description: Template string to construct the paths of the personal space roots. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13070,7 +13071,7 @@ STORAGE_USERS_PERMISSION_ENDPOINT: type: string description: Endpoint of the permissions service. The endpoints can differ for 'ocis', 'posix' and 's3ng'. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13079,7 +13080,7 @@ STORAGE_USERS_POSIX_GENERAL_SPACE_PATH_TEMPLATE: defaultValue: projects/{{.SpaceId}} type: string description: Template string to construct the paths of the projects space roots. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13089,7 +13090,7 @@ STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT: type: string description: Endpoint of the permissions service. The endpoints can differ for 'ocis', 'posix' and 's3ng'. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13098,7 +13099,7 @@ STORAGE_USERS_POSIX_PERSONAL_SPACE_PATH_TEMPLATE: defaultValue: users/{{.User.Username}} type: string description: Template string to construct the paths of the personal space roots. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13108,7 +13109,7 @@ STORAGE_USERS_POSIX_ROOT: type: string description: The directory where the filesystem storage will store its data. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/storage/owncloud. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13117,7 +13118,7 @@ STORAGE_USERS_POSIX_USE_SPACE_GROUPS: defaultValue: "false" type: bool description: Use space groups to manage permissions on spaces. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13127,7 +13128,7 @@ STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS: type: string description: Comma-separated list of kafka brokers to read the watchfolder events from. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13138,7 +13139,7 @@ STORAGE_USERS_POSIX_WATCH_PATH: description: Path to the watch directory/file. Only applies to the 'gpfsfileauditlogging' and 'inotifywait' watcher, in which case it is the path of the file audit log file/base directory to watch. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13149,7 +13150,7 @@ STORAGE_USERS_POSIX_WATCH_TYPE: description: Type of the watcher to use for getting notified about changes to the filesystem. Currently available options are 'inotifywait' (default), 'gpfswatchfolder' and 'gpfsfileauditlogging'. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13237,7 +13238,7 @@ STORAGE_USERS_S3NG_GENERAL_SPACE_PATH_TEMPLATE: defaultValue: "" type: string description: Template string to construct the paths of the projects space roots. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13311,7 +13312,7 @@ STORAGE_USERS_S3NG_PERSONAL_SPACE_PATH_TEMPLATE: defaultValue: "" type: string description: Template string to construct the paths of the personal space roots. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13520,7 +13521,7 @@ STORE_DATA_PATH: If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/store. introductionVersion: pre5.0 deprecationVersion: "5.0" - removalVersion: 6.0.0 + removalVersion: 7.0.0 deprecationInfo: The store service is optional and will be removed. STORE_DEBUG_ADDR: name: STORE_DEBUG_ADDR @@ -13530,7 +13531,7 @@ STORE_DEBUG_ADDR: debug endpoints will be exposed. introductionVersion: pre5.0 deprecationVersion: "5.0" - removalVersion: 6.0.0 + removalVersion: 7.0.0 deprecationInfo: The store service is optional and will be removed. STORE_DEBUG_PPROF: name: STORE_DEBUG_PPROF @@ -13539,7 +13540,7 @@ STORE_DEBUG_PPROF: description: Enables pprof, which can be used for profiling. introductionVersion: pre5.0 deprecationVersion: "5.0" - removalVersion: 6.0.0 + removalVersion: 7.0.0 deprecationInfo: The store service is optional and will be removed. STORE_DEBUG_TOKEN: name: STORE_DEBUG_TOKEN @@ -13548,7 +13549,7 @@ STORE_DEBUG_TOKEN: description: Token to secure the metrics endpoint. introductionVersion: pre5.0 deprecationVersion: "5.0" - removalVersion: 6.0.0 + removalVersion: 7.0.0 deprecationInfo: The store service is optional and will be removed. STORE_DEBUG_ZPAGES: name: STORE_DEBUG_ZPAGES @@ -13558,7 +13559,7 @@ STORE_DEBUG_ZPAGES: traces. introductionVersion: pre5.0 deprecationVersion: "5.0" - removalVersion: 6.0.0 + removalVersion: 7.0.0 deprecationInfo: The store service is optional and will be removed. STORE_GRPC_ADDR: name: STORE_GRPC_ADDR @@ -13567,7 +13568,7 @@ STORE_GRPC_ADDR: description: The bind address of the GRPC service. introductionVersion: pre5.0 deprecationVersion: "5.0" - removalVersion: 6.0.0 + removalVersion: 7.0.0 deprecationInfo: The store service is optional and will be removed. STORE_LOG_COLOR: name: OCIS_LOG_COLOR;STORE_LOG_COLOR @@ -13576,7 +13577,7 @@ STORE_LOG_COLOR: description: Activates colorized log output. introductionVersion: pre5.0 deprecationVersion: "5.0" - removalVersion: 6.0.0 + removalVersion: 7.0.0 deprecationInfo: The store service is optional and will be removed. STORE_LOG_FILE: name: OCIS_LOG_FILE;STORE_LOG_FILE @@ -13585,7 +13586,7 @@ STORE_LOG_FILE: description: The path to the log file. Activates logging to this file if set. introductionVersion: pre5.0 deprecationVersion: "5.0" - removalVersion: 6.0.0 + removalVersion: 7.0.0 deprecationInfo: The store service is optional and will be removed. STORE_LOG_LEVEL: name: OCIS_LOG_LEVEL;STORE_LOG_LEVEL @@ -13595,7 +13596,7 @@ STORE_LOG_LEVEL: ''warn'', ''info'', ''debug'', ''trace''.' introductionVersion: pre5.0 deprecationVersion: "5.0" - removalVersion: 6.0.0 + removalVersion: 7.0.0 deprecationInfo: The store service is optional and will be removed. STORE_LOG_PRETTY: name: OCIS_LOG_PRETTY;STORE_LOG_PRETTY @@ -13604,7 +13605,7 @@ STORE_LOG_PRETTY: description: Activates pretty log output. introductionVersion: pre5.0 deprecationVersion: "5.0" - removalVersion: 6.0.0 + removalVersion: 7.0.0 deprecationInfo: The store service is optional and will be removed. STORE_TRACING_COLLECTOR: name: OCIS_TRACING_COLLECTOR;STORE_TRACING_COLLECTOR @@ -13614,7 +13615,7 @@ STORE_TRACING_COLLECTOR: Only used if the tracing endpoint is unset. introductionVersion: pre5.0 deprecationVersion: "5.0" - removalVersion: 6.0.0 + removalVersion: 7.0.0 deprecationInfo: The store service is optional and will be removed. STORE_TRACING_ENABLED: name: OCIS_TRACING_ENABLED;STORE_TRACING_ENABLED @@ -13623,7 +13624,7 @@ STORE_TRACING_ENABLED: description: Activates tracing. introductionVersion: pre5.0 deprecationVersion: "5.0" - removalVersion: 6.0.0 + removalVersion: 7.0.0 deprecationInfo: The store service is optional and will be removed. STORE_TRACING_ENDPOINT: name: OCIS_TRACING_ENDPOINT;STORE_TRACING_ENDPOINT @@ -13632,7 +13633,7 @@ STORE_TRACING_ENDPOINT: description: The endpoint of the tracing agent. introductionVersion: pre5.0 deprecationVersion: "5.0" - removalVersion: 6.0.0 + removalVersion: 7.0.0 deprecationInfo: The store service is optional and will be removed. STORE_TRACING_TYPE: name: OCIS_TRACING_TYPE;STORE_TRACING_TYPE @@ -13642,7 +13643,7 @@ STORE_TRACING_TYPE: Allowed tracing types are 'jaeger' and '' as of now. introductionVersion: pre5.0 deprecationVersion: "5.0" - removalVersion: 6.0.0 + removalVersion: 7.0.0 deprecationInfo: The store service is optional and will be removed. THUMBNAILS_CS3SOURCE_INSECURE: name: OCIS_INSECURE;THUMBNAILS_CS3SOURCE_INSECURE @@ -13780,7 +13781,7 @@ THUMBNAILS_MAX_CONCURRENT_REQUESTS: type: int description: Number of maximum concurrent thumbnail requests. Default is 0 which is unlimited. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13789,7 +13790,7 @@ THUMBNAILS_MAX_INPUT_HEIGHT: defaultValue: "7680" type: int description: The maximum height of an input image which is being processed. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13800,7 +13801,7 @@ THUMBNAILS_MAX_INPUT_IMAGE_FILE_SIZE: description: 'The maximum file size of an input image which is being processed. Usable common abbreviations: [KB, KiB, MB, MiB, GB, GiB, TB, TiB, PB, PiB, EB, EiB], example: 2GB.' - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -13809,7 +13810,7 @@ THUMBNAILS_MAX_INPUT_WIDTH: defaultValue: "7680" type: int description: The maximum width of an input image which is being processed. - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14820,7 +14821,7 @@ WEB_ASSET_APPS_PATH: type: string description: Serve ownCloud Web apps assets from a path on the filesystem instead of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/web/assets/apps - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14830,7 +14831,7 @@ WEB_ASSET_CORE_PATH: type: string description: Serve ownCloud Web assets from a path on the filesystem instead of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/web/assets/core - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" @@ -14842,7 +14843,7 @@ WEB_ASSET_PATH: the builtin assets. introductionVersion: pre5.0 deprecationVersion: 5.1.0 - removalVersion: 6.0.0 + removalVersion: 7.0.0 deprecationInfo: The WEB_ASSET_PATH is deprecated and will be removed in the future. WEB_ASSET_THEMES_PATH: name: OCIS_ASSET_THEMES_PATH;WEB_ASSET_THEMES_PATH @@ -14850,7 +14851,7 @@ WEB_ASSET_THEMES_PATH: type: string description: Serve ownCloud themes from a path on the filesystem instead of the builtin assets. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/web/assets/themes - introductionVersion: '%%NEXT%%' + introductionVersion: 6.0.0 deprecationVersion: "" removalVersion: "" deprecationInfo: "" diff --git a/docs/helpers/extended_vars.yaml b/docs/helpers/extended_vars.yaml index 6ccd862ab..4cac7da82 100644 --- a/docs/helpers/extended_vars.yaml +++ b/docs/helpers/extended_vars.yaml @@ -52,7 +52,7 @@ variables: on supervision of ownCloud Support.' do_ignore: false - rawname: _registryAddressEnv - path: ocis-pkg/natsjsregistry/registry.go:165 + path: ocis-pkg/natsjsregistry/registry.go:166 foundincode: true name: MICRO_REGISTRY_ADDRESS type: string @@ -69,7 +69,7 @@ variables: description: "" do_ignore: true - rawname: _registryPasswordEnv - path: ocis-pkg/natsjsregistry/registry.go:193 + path: ocis-pkg/natsjsregistry/registry.go:194 foundincode: true name: MICRO_REGISTRY_AUTH_PASSWORD type: string @@ -77,7 +77,7 @@ variables: description: Optional when using nats to authenticate with the nats cluster. do_ignore: false - rawname: _registryUsernameEnv - path: ocis-pkg/natsjsregistry/registry.go:193 + path: ocis-pkg/natsjsregistry/registry.go:194 foundincode: true name: MICRO_REGISTRY_AUTH_USERNAME type: string