mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-05-08 04:20:59 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #10207 from owncloud/update_env_vars.yaml

Browse Source 
[docs-only][chore] Update env_vars.yaml
This commit is contained in:
Martin
2024-10-02 00:49:49 +02:00
committed by GitHub
parent 32c4ffba82 571b5b89a7
commit 879dfa7c5d
1 changed files with 107 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/helpers/env_vars.yaml
+107 -111
View File
@@ -7927,7 +7927,7 @@ OCIS_ASSET_THEMES_PATH:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_ASYNC_UPLOADS: OCIS_ASYNC_UPLOADS:
name: OCIS_ASYNC_UPLOADS;SEARCH_EVENTS_ASYNC_UPLOADS name: OCIS_ASYNC_UPLOADS
defaultValue: "true" defaultValue: "true"
type: bool type: bool
description: Enable asynchronous file uploads. description: Enable asynchronous file uploads.
@@ -8019,8 +8019,8 @@ OCIS_CACHE_TTL:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_CREDENTIALS: OCIS_CORS_ALLOW_CREDENTIALS:
name: OCIS_CORS_ALLOW_CREDENTIALS;WEBFINGER_CORS_ALLOW_CREDENTIALS name: OCIS_CORS_ALLOW_CREDENTIALS;USERLOG_CORS_ALLOW_CREDENTIALS
defaultValue: "false" defaultValue: "true"
type: bool type: bool
description: 'Allow credentials for CORS.See following chapter for more details: description: 'Allow credentials for CORS.See following chapter for more details:
*Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.' *Access-Control-Allow-Credentials* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.'
@@ -8029,8 +8029,9 @@ OCIS_CORS_ALLOW_CREDENTIALS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_HEADERS: OCIS_CORS_ALLOW_HEADERS:
name: OCIS_CORS_ALLOW_HEADERS;WEBFINGER_CORS_ALLOW_HEADERS name: OCIS_CORS_ALLOW_HEADERS;USERLOG_CORS_ALLOW_HEADERS
defaultValue: '[]' defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id
Ocs-Apirequest]'
type: '[]string' type: '[]string'
description: 'A list of allowed CORS headers. See following chapter for more details: description: 'A list of allowed CORS headers. See following chapter for more details:
*Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers.
@@ -8040,8 +8041,8 @@ OCIS_CORS_ALLOW_HEADERS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_METHODS: OCIS_CORS_ALLOW_METHODS:
name: OCIS_CORS_ALLOW_METHODS;WEBFINGER_CORS_ALLOW_METHODS name: OCIS_CORS_ALLOW_METHODS;USERLOG_CORS_ALLOW_METHODS
defaultValue: '[]' defaultValue: '[GET]'
type: '[]string' type: '[]string'
description: 'A list of allowed CORS methods. See following chapter for more details: description: 'A list of allowed CORS methods. See following chapter for more details:
*Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. *Access-Control-Request-Method* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method.
@@ -8051,8 +8052,8 @@ OCIS_CORS_ALLOW_METHODS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_ORIGINS: OCIS_CORS_ALLOW_ORIGINS:
name: OCIS_CORS_ALLOW_ORIGINS;WEBFINGER_CORS_ALLOW_ORIGINS name: OCIS_CORS_ALLOW_ORIGINS;USERLOG_CORS_ALLOW_ORIGINS
defaultValue: '[https://localhost:9200]' defaultValue: '[*]'
type: '[]string' type: '[]string'
description: 'A list of allowed CORS origins. See following chapter for more details: description: 'A list of allowed CORS origins. See following chapter for more details:
*Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. *Access-Control-Allow-Origin* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin.
@@ -8195,7 +8196,7 @@ OCIS_ENABLE_RESHARING:
removalVersion: "" removalVersion: ""
deprecationInfo: Resharing will be removed in the future. deprecationInfo: Resharing will be removed in the future.
OCIS_EVENTS_AUTH_PASSWORD: OCIS_EVENTS_AUTH_PASSWORD:
name: OCIS_EVENTS_AUTH_PASSWORD;CLIENTLOG_EVENTS_AUTH_PASSWORD name: OCIS_EVENTS_AUTH_PASSWORD;ANTIVIRUS_EVENTS_AUTH_PASSWORD
defaultValue: "" defaultValue: ""
type: string type: string
description: The password to authenticate with the events broker. The events broker description: The password to authenticate with the events broker. The events broker
@@ -8205,7 +8206,7 @@ OCIS_EVENTS_AUTH_PASSWORD:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EVENTS_AUTH_USERNAME: OCIS_EVENTS_AUTH_USERNAME:
name: OCIS_EVENTS_AUTH_USERNAME;CLIENTLOG_EVENTS_AUTH_USERNAME name: OCIS_EVENTS_AUTH_USERNAME;ANTIVIRUS_EVENTS_AUTH_USERNAME
defaultValue: "" defaultValue: ""
type: string type: string
description: The username to authenticate with the events broker. The events broker description: The username to authenticate with the events broker. The events broker
@@ -8215,43 +8216,43 @@ OCIS_EVENTS_AUTH_USERNAME:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EVENTS_CLUSTER: OCIS_EVENTS_CLUSTER:
name: OCIS_EVENTS_CLUSTER;CLIENTLOG_EVENTS_CLUSTER name: OCIS_EVENTS_CLUSTER;ANTIVIRUS_EVENTS_CLUSTER
defaultValue: ocis-cluster defaultValue: ocis-cluster
type: string type: string
description: The clusterID of the event system. The event system is the message description: The clusterID of the event system. The event system is the message
queuing service. It is used as message broker for the microservice architecture. queuing service. It is used as message broker for the microservice architecture.
Mandatory when using NATS as event system. Mandatory when using NATS as event system.
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EVENTS_ENABLE_TLS: OCIS_EVENTS_ENABLE_TLS:
name: OCIS_EVENTS_ENABLE_TLS;CLIENTLOG_EVENTS_ENABLE_TLS name: OCIS_EVENTS_ENABLE_TLS;ANTIVIRUS_EVENTS_ENABLE_TLS
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Enable TLS for the connection to the events broker. The events broker description: Enable TLS for the connection to the events broker. The events broker
is the ocis service which receives and delivers events between the services. is the ocis service which receives and delivers events between the services.
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EVENTS_ENDPOINT: OCIS_EVENTS_ENDPOINT:
name: OCIS_EVENTS_ENDPOINT;CLIENTLOG_EVENTS_ENDPOINT name: OCIS_EVENTS_ENDPOINT;ANTIVIRUS_EVENTS_ENDPOINT
defaultValue: 127.0.0.1:9233 defaultValue: 127.0.0.1:9233
type: string type: string
description: The address of the event system. The event system is the message queuing description: The address of the event system. The event system is the message queuing
service. It is used as message broker for the microservice architecture. service. It is used as message broker for the microservice architecture.
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE:
name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;CLIENTLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE name: OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE;ANTIVIRUS_EVENTS_TLS_ROOT_CA_CERTIFICATE
defaultValue: "" defaultValue: ""
type: string type: string
description: The root CA certificate used to validate the server's TLS certificate. description: The root CA certificate used to validate the server's TLS certificate.
If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. If provided ANTIVIRUS_EVENTS_TLS_INSECURE will be seen as false.
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
@@ -8288,11 +8289,11 @@ OCIS_GRPC_CLIENT_TLS_MODE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_GRPC_PROTOCOL: OCIS_GRPC_PROTOCOL:
name: OCIS_GRPC_PROTOCOL;AUTH_MACHINE_GRPC_PROTOCOL name: OCIS_GRPC_PROTOCOL;COLLABORATION_GRPC_PROTOCOL
defaultValue: "" defaultValue: ""
type: string type: string
description: The transport protocol of the GRPC service. description: The transport protocol of the GRPC service.
introductionVersion: pre5.0 introductionVersion: '%%NEXT%%'
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
@@ -8328,25 +8329,25 @@ OCIS_HTTP_TLS_KEY:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_INSECURE: OCIS_INSECURE:
name: OCIS_INSECURE;CLIENTLOG_EVENTS_TLS_INSECURE name: OCIS_INSECURE;AUTH_BEARER_OIDC_INSECURE
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Whether to verify the server TLS certificates. description: Allow insecure connections to the OIDC issuer.
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_JWT_SECRET: OCIS_JWT_SECRET:
name: OCIS_JWT_SECRET;CLIENTLOG_JWT_SECRET name: OCIS_JWT_SECRET;COLLABORATION_JWT_SECRET
defaultValue: "" defaultValue: ""
type: string type: string
description: The secret to mint and validate jwt tokens. description: The secret to mint and validate jwt tokens.
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_BASE_PATH: OCIS_KEYCLOAK_BASE_PATH:
name: OCIS_KEYCLOAK_BASE_PATH;GRAPH_KEYCLOAK_BASE_PATH name: OCIS_KEYCLOAK_BASE_PATH;INVITATIONS_KEYCLOAK_BASE_PATH
defaultValue: "" defaultValue: ""
type: string type: string
description: The URL to access keycloak. description: The URL to access keycloak.
@@ -8355,16 +8356,16 @@ OCIS_KEYCLOAK_BASE_PATH:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_CLIENT_ID: OCIS_KEYCLOAK_CLIENT_ID:
name: OCIS_KEYCLOAK_CLIENT_ID;GRAPH_KEYCLOAK_CLIENT_ID name: OCIS_KEYCLOAK_CLIENT_ID;INVITATIONS_KEYCLOAK_CLIENT_ID
defaultValue: "" defaultValue: ""
type: string type: string
description: The client id to authenticate with keycloak. description: The client ID to authenticate with keycloak.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_CLIENT_REALM: OCIS_KEYCLOAK_CLIENT_REALM:
name: OCIS_KEYCLOAK_CLIENT_REALM;GRAPH_KEYCLOAK_CLIENT_REALM name: OCIS_KEYCLOAK_CLIENT_REALM;INVITATIONS_KEYCLOAK_CLIENT_REALM
defaultValue: "" defaultValue: ""
type: string type: string
description: The realm the client is defined in. description: The realm the client is defined in.
@@ -8373,7 +8374,7 @@ OCIS_KEYCLOAK_CLIENT_REALM:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_CLIENT_SECRET: OCIS_KEYCLOAK_CLIENT_SECRET:
name: OCIS_KEYCLOAK_CLIENT_SECRET;GRAPH_KEYCLOAK_CLIENT_SECRET name: OCIS_KEYCLOAK_CLIENT_SECRET;INVITATIONS_KEYCLOAK_CLIENT_SECRET
defaultValue: "" defaultValue: ""
type: string type: string
description: The client secret to use in authentication. description: The client secret to use in authentication.
@@ -8382,7 +8383,7 @@ OCIS_KEYCLOAK_CLIENT_SECRET:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY:
name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;GRAPH_KEYCLOAK_INSECURE_SKIP_VERIFY name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;INVITATIONS_KEYCLOAK_INSECURE_SKIP_VERIFY
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Disable TLS certificate validation for Keycloak connections. Do not description: Disable TLS certificate validation for Keycloak connections. Do not
@@ -8392,7 +8393,7 @@ OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_USER_REALM: OCIS_KEYCLOAK_USER_REALM:
name: OCIS_KEYCLOAK_USER_REALM;GRAPH_KEYCLOAK_USER_REALM name: OCIS_KEYCLOAK_USER_REALM;INVITATIONS_KEYCLOAK_USER_REALM
defaultValue: "" defaultValue: ""
type: string type: string
description: The realm users are defined. description: The realm users are defined.
@@ -8401,8 +8402,8 @@ OCIS_KEYCLOAK_USER_REALM:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_BIND_DN: OCIS_LDAP_BIND_DN:
name: OCIS_LDAP_BIND_DN;GROUPS_LDAP_BIND_DN name: OCIS_LDAP_BIND_DN;IDP_LDAP_BIND_DN
defaultValue: uid=reva,ou=sysusers,o=libregraph-idm defaultValue: uid=idp,ou=sysusers,o=libregraph-idm
type: string type: string
description: LDAP DN to use for simple bind authentication with the target LDAP description: LDAP DN to use for simple bind authentication with the target LDAP
server. server.
@@ -8411,7 +8412,7 @@ OCIS_LDAP_BIND_DN:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_BIND_PASSWORD: OCIS_LDAP_BIND_PASSWORD:
name: OCIS_LDAP_BIND_PASSWORD;GROUPS_LDAP_BIND_PASSWORD name: OCIS_LDAP_BIND_PASSWORD;IDP_LDAP_BIND_PASSWORD
defaultValue: "" defaultValue: ""
type: string type: string
description: Password to use for authenticating the 'bind_dn'. description: Password to use for authenticating the 'bind_dn'.
@@ -8420,31 +8421,31 @@ OCIS_LDAP_BIND_PASSWORD:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_CACERT: OCIS_LDAP_CACERT:
name: OCIS_LDAP_CACERT;GROUPS_LDAP_CACERT name: OCIS_LDAP_CACERT;IDP_LDAP_TLS_CACERT
defaultValue: /var/lib/ocis/idm/ldap.crt defaultValue: /var/lib/ocis/idm/ldap.crt
type: string type: string
description: Path/File name for the root CA certificate (in PEM format) used to description: Path/File name for the root CA certificate (in PEM format) used to
validate TLS server certificates of the LDAP service. If not defined, the root validate TLS server certificates of the LDAP service. If not defined, the root
directory derives from $OCIS_BASE_DATA_PATH:/idm. directory derives from $OCIS_BASE_DATA_PATH:/idp.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_DISABLE_USER_MECHANISM: OCIS_LDAP_DISABLE_USER_MECHANISM:
name: OCIS_LDAP_DISABLE_USER_MECHANISM;USERS_LDAP_DISABLE_USER_MECHANISM name: OCIS_LDAP_DISABLE_USER_MECHANISM;GRAPH_DISABLE_USER_MECHANISM
defaultValue: attribute defaultValue: attribute
type: string type: string
description: An option to control the behavior for disabling users. Valid options description: An option to control the behavior for disabling users. Supported options
are 'none', 'attribute' and 'group'. If set to 'group', disabling a user via API are 'none', 'attribute' and 'group'. If set to 'group', disabling a user via API
will add the user to the configured group for disabled users, if set to 'attribute' will add the user to the configured group for disabled users, if set to 'attribute'
this will be done in the ldap user entry, if set to 'none' the disable request this will be done in the ldap user entry, if set to 'none' the disable request
is not processed. is not processed. Default is 'attribute'.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_DISABLED_USERS_GROUP_DN: OCIS_LDAP_DISABLED_USERS_GROUP_DN:
name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;USERS_LDAP_DISABLED_USERS_GROUP_DN name: OCIS_LDAP_DISABLED_USERS_GROUP_DN;GRAPH_DISABLED_USERS_GROUP_DN
defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm
type: string type: string
description: The distinguished name of the group to which added users will be classified description: The distinguished name of the group to which added users will be classified
@@ -8550,7 +8551,7 @@ OCIS_LDAP_GROUP_SCOPE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_INSECURE: OCIS_LDAP_INSECURE:
name: OCIS_LDAP_INSECURE;GROUPS_LDAP_INSECURE name: OCIS_LDAP_INSECURE;IDP_INSECURE
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Disable TLS certificate validation for the LDAP connections. Do not description: Disable TLS certificate validation for the LDAP connections. Do not
@@ -8572,17 +8573,16 @@ OCIS_LDAP_SERVER_WRITE_ENABLED:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_URI: OCIS_LDAP_URI:
name: OCIS_LDAP_URI;GROUPS_LDAP_URI name: OCIS_LDAP_URI;IDP_LDAP_URI
defaultValue: ldaps://localhost:9235 defaultValue: ldaps://localhost:9235
type: string type: string
description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' description: Url of the LDAP service to use as IDP.
and 'ldap://'
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_BASE_DN: OCIS_LDAP_USER_BASE_DN:
name: OCIS_LDAP_USER_BASE_DN;GROUPS_LDAP_USER_BASE_DN name: OCIS_LDAP_USER_BASE_DN;IDP_LDAP_BASE_DN
defaultValue: ou=users,o=libregraph-idm defaultValue: ou=users,o=libregraph-idm
type: string type: string
description: Search base DN for looking up LDAP users. description: Search base DN for looking up LDAP users.
@@ -8591,16 +8591,16 @@ OCIS_LDAP_USER_BASE_DN:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_ENABLED_ATTRIBUTE: OCIS_LDAP_USER_ENABLED_ATTRIBUTE:
name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;USERS_LDAP_USER_ENABLED_ATTRIBUTE name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;IDP_USER_ENABLED_ATTRIBUTE
defaultValue: ownCloudUserEnabled defaultValue: ownCloudUserEnabled
type: string type: string
description: LDAP attribute to use as a flag telling if the user is enabled or disabled. description: LDAP Attribute to use as a flag telling if the user is enabled or disabled.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_FILTER: OCIS_LDAP_USER_FILTER:
name: OCIS_LDAP_USER_FILTER;GROUPS_LDAP_USER_FILTER name: OCIS_LDAP_USER_FILTER;IDP_LDAP_FILTER
defaultValue: "" defaultValue: ""
type: string type: string
description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'.
@@ -8609,11 +8609,10 @@ OCIS_LDAP_USER_FILTER:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_OBJECTCLASS: OCIS_LDAP_USER_OBJECTCLASS:
name: OCIS_LDAP_USER_OBJECTCLASS;GROUPS_LDAP_USER_OBJECTCLASS name: OCIS_LDAP_USER_OBJECTCLASS;IDP_LDAP_OBJECTCLASS
defaultValue: inetOrgPerson defaultValue: inetOrgPerson
type: string type: string
description: The object class to use for users in the default user search filter description: LDAP User ObjectClass like 'inetOrgPerson'.
('inetOrgPerson').
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -8628,11 +8627,10 @@ OCIS_LDAP_USER_SCHEMA_DISPLAYNAME:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_ID: OCIS_LDAP_USER_SCHEMA_ID:
name: OCIS_LDAP_USER_SCHEMA_ID;GROUPS_LDAP_USER_SCHEMA_ID name: OCIS_LDAP_USER_SCHEMA_ID;IDP_LDAP_UUID_ATTRIBUTE
defaultValue: ownclouduuid defaultValue: ownCloudUUID
type: string type: string
description: LDAP Attribute to use as the unique id for users. This should be a description: LDAP User UUID attribute like 'uid'.
stable globally unique id like a UUID.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -8649,16 +8647,16 @@ OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_MAIL: OCIS_LDAP_USER_SCHEMA_MAIL:
name: OCIS_LDAP_USER_SCHEMA_MAIL;GROUPS_LDAP_USER_SCHEMA_MAIL name: OCIS_LDAP_USER_SCHEMA_MAIL;IDP_LDAP_EMAIL_ATTRIBUTE
defaultValue: mail defaultValue: mail
type: string type: string
description: LDAP Attribute to use for the email address of users. description: LDAP User email attribute like 'mail'.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_USER_TYPE: OCIS_LDAP_USER_SCHEMA_USER_TYPE:
name: OCIS_LDAP_USER_SCHEMA_USER_TYPE;USERS_LDAP_USER_TYPE_ATTRIBUTE name: OCIS_LDAP_USER_SCHEMA_USER_TYPE;GRAPH_LDAP_USER_TYPE_ATTRIBUTE
defaultValue: ownCloudUserType defaultValue: ownCloudUserType
type: string type: string
description: LDAP Attribute to distinguish between 'Member' and 'Guest' users. Default description: LDAP Attribute to distinguish between 'Member' and 'Guest' users. Default
@@ -8668,16 +8666,16 @@ OCIS_LDAP_USER_SCHEMA_USER_TYPE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_USERNAME: OCIS_LDAP_USER_SCHEMA_USERNAME:
name: OCIS_LDAP_USER_SCHEMA_USERNAME;GROUPS_LDAP_USER_SCHEMA_USERNAME name: OCIS_LDAP_USER_SCHEMA_USERNAME;IDP_LDAP_NAME_ATTRIBUTE
defaultValue: uid defaultValue: displayName
type: string type: string
description: LDAP Attribute to use for username of users. description: LDAP User name attribute like 'displayName'.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCOPE: OCIS_LDAP_USER_SCOPE:
name: OCIS_LDAP_USER_SCOPE;GROUPS_LDAP_USER_SCOPE name: OCIS_LDAP_USER_SCOPE;IDP_LDAP_SCOPE
defaultValue: sub defaultValue: sub
type: string type: string
description: LDAP search scope to use when looking up users. Supported scopes are description: LDAP search scope to use when looking up users. Supported scopes are
@@ -8687,44 +8685,44 @@ OCIS_LDAP_USER_SCOPE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_COLOR: OCIS_LOG_COLOR:
name: OCIS_LOG_COLOR;CLIENTLOG_USERLOG_LOG_COLOR name: OCIS_LOG_COLOR;IDM_LOG_COLOR
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Activates colorized log output. description: Activates colorized log output.
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_FILE: OCIS_LOG_FILE:
name: OCIS_LOG_FILE;CLIENTLOG_USERLOG_LOG_FILE name: OCIS_LOG_FILE;IDM_LOG_FILE
defaultValue: "" defaultValue: ""
type: string type: string
description: The path to the log file. Activates logging to this file if set. description: The path to the log file. Activates logging to this file if set.
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_LEVEL: OCIS_LOG_LEVEL:
name: OCIS_LOG_LEVEL;CLIENTLOG_USERLOG_LOG_LEVEL name: OCIS_LOG_LEVEL;IDM_LOG_LEVEL
defaultValue: "" defaultValue: ""
type: string type: string
description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'', description: 'The log level. Valid values are: ''panic'', ''fatal'', ''error'',
''warn'', ''info'', ''debug'', ''trace''.' ''warn'', ''info'', ''debug'', ''trace''.'
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_PRETTY: OCIS_LOG_PRETTY:
name: OCIS_LOG_PRETTY;CLIENTLOG_USERLOG_LOG_PRETTY name: OCIS_LOG_PRETTY;IDM_LOG_PRETTY
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Activates pretty log output. description: Activates pretty log output.
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_MACHINE_AUTH_API_KEY: OCIS_MACHINE_AUTH_API_KEY:
name: OCIS_MACHINE_AUTH_API_KEY;AUTH_MACHINE_API_KEY name: OCIS_MACHINE_AUTH_API_KEY;OCDAV_MACHINE_AUTH_API_KEY
defaultValue: "" defaultValue: ""
type: string type: string
description: Machine auth API key used to validate internal requests necessary for description: Machine auth API key used to validate internal requests necessary for
@@ -8745,10 +8743,10 @@ OCIS_OIDC_CLIENT_ID:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_OIDC_ISSUER: OCIS_OIDC_ISSUER:
name: OCIS_URL;OCIS_OIDC_ISSUER;WEBFINGER_OIDC_ISSUER name: OCIS_URL;OCIS_OIDC_ISSUER
defaultValue: https://localhost:9200 defaultValue: https://localhost:9200
type: string 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 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -8821,8 +8819,8 @@ OCIS_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PERSISTENT_STORE: OCIS_PERSISTENT_STORE:
name: OCIS_PERSISTENT_STORE;EVENTHISTORY_STORE name: OCIS_PERSISTENT_STORE;USERLOG_STORE
defaultValue: nats-js-kv defaultValue: memory
type: string type: string
description: 'The type of the store. Supported values are: ''memory'', ''ocmem'', description: 'The type of the store. Supported values are: ''memory'', ''ocmem'',
''etcd'', ''redis'', ''redis-sentinel'', ''nats-js'', ''noop''. See the text description ''etcd'', ''redis'', ''redis-sentinel'', ''nats-js'', ''noop''. See the text description
@@ -8832,7 +8830,7 @@ OCIS_PERSISTENT_STORE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PERSISTENT_STORE_AUTH_PASSWORD: OCIS_PERSISTENT_STORE_AUTH_PASSWORD:
name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;EVENTHISTORY_STORE_AUTH_PASSWORD name: OCIS_PERSISTENT_STORE_AUTH_PASSWORD;USERLOG_STORE_AUTH_PASSWORD
defaultValue: "" defaultValue: ""
type: string type: string
description: The password to authenticate with the store. Only applies when store description: The password to authenticate with the store. Only applies when store
@@ -8842,7 +8840,7 @@ OCIS_PERSISTENT_STORE_AUTH_PASSWORD:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PERSISTENT_STORE_AUTH_USERNAME: OCIS_PERSISTENT_STORE_AUTH_USERNAME:
name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;EVENTHISTORY_STORE_AUTH_USERNAME name: OCIS_PERSISTENT_STORE_AUTH_USERNAME;USERLOG_STORE_AUTH_USERNAME
defaultValue: "" defaultValue: ""
type: string type: string
description: The username to authenticate with the store. Only applies when store description: The username to authenticate with the store. Only applies when store
@@ -8852,8 +8850,8 @@ OCIS_PERSISTENT_STORE_AUTH_USERNAME:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PERSISTENT_STORE_NODES: OCIS_PERSISTENT_STORE_NODES:
name: OCIS_PERSISTENT_STORE_NODES;EVENTHISTORY_STORE_NODES name: OCIS_PERSISTENT_STORE_NODES;USERLOG_STORE_NODES
defaultValue: '[127.0.0.1:9233]' defaultValue: '[]'
type: '[]string' type: '[]string'
description: A list of nodes to access the configured store. This has no effect description: A list of nodes to access the configured store. This has no effect
when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes
@@ -8864,18 +8862,18 @@ OCIS_PERSISTENT_STORE_NODES:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PERSISTENT_STORE_SIZE: OCIS_PERSISTENT_STORE_SIZE:
name: OCIS_PERSISTENT_STORE_SIZE;EVENTHISTORY_STORE_SIZE name: OCIS_PERSISTENT_STORE_SIZE;USERLOG_STORE_SIZE
defaultValue: "0" defaultValue: "0"
type: int type: int
description: The maximum quantity of items in the store. Only applies when store description: The maximum quantity of items in the store. Only applies when store
type 'ocmem' is configured. Defaults to 512 which is derived and used from the type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package
ocmem package though no explicit default was set. though not exclicitly set as default.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_PERSISTENT_STORE_TTL: OCIS_PERSISTENT_STORE_TTL:
name: OCIS_PERSISTENT_STORE_TTL;EVENTHISTORY_STORE_TTL name: OCIS_PERSISTENT_STORE_TTL;USERLOG_STORE_TTL
defaultValue: 336h0m0s defaultValue: 336h0m0s
type: Duration type: Duration
description: Time to live for events in the store. Defaults to '336h' (2 weeks). description: Time to live for events in the store. Defaults to '336h' (2 weeks).
@@ -8894,11 +8892,11 @@ OCIS_PUBLIC_URL:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_REVA_GATEWAY: OCIS_REVA_GATEWAY:
name: OCIS_REVA_GATEWAY;CLIENTLOG_REVA_GATEWAY name: OCIS_REVA_GATEWAY;COLLABORATION_CS3API_GATEWAY_NAME
defaultValue: com.owncloud.api.gateway defaultValue: com.owncloud.api.gateway
type: string type: string
description: CS3 gateway used to look up user metadata description: CS3 gateway used to look up user metadata.
introductionVersion: "5.0" introductionVersion: 6.0.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
@@ -8925,7 +8923,7 @@ OCIS_REVA_GATEWAY_TLS_MODE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SERVICE_ACCOUNT_ID: OCIS_SERVICE_ACCOUNT_ID:
name: OCIS_SERVICE_ACCOUNT_ID;CLIENTLOG_SERVICE_ACCOUNT_ID name: OCIS_SERVICE_ACCOUNT_ID;USERLOG_SERVICE_ACCOUNT_ID
defaultValue: "" defaultValue: ""
type: string type: string
description: The ID of the service account the service should use. See the 'auth-service' description: The ID of the service account the service should use. See the 'auth-service'
@@ -8935,7 +8933,7 @@ OCIS_SERVICE_ACCOUNT_ID:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SERVICE_ACCOUNT_SECRET: OCIS_SERVICE_ACCOUNT_SECRET:
name: OCIS_SERVICE_ACCOUNT_SECRET;CLIENTLOG_SERVICE_ACCOUNT_SECRET name: OCIS_SERVICE_ACCOUNT_SECRET;USERLOG_SERVICE_ACCOUNT_SECRET
defaultValue: "" defaultValue: ""
type: string type: string
description: The service account secret. description: The service account secret.
@@ -8974,11 +8972,12 @@ OCIS_SHOW_USER_EMAIL_IN_RESULTS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SPACES_MAX_QUOTA: OCIS_SPACES_MAX_QUOTA:
name: OCIS_SPACES_MAX_QUOTA;FRONTEND_MAX_QUOTA name: OCIS_SPACES_MAX_QUOTA;STORAGE_USERS_OCIS_MAX_QUOTA
defaultValue: "0" defaultValue: "0"
type: uint64 type: uint64
description: Set the global max quota value in bytes. A value of 0 equals unlimited. description: Set a global max quota for spaces in bytes. A value of 0 equals unlimited.
The value is provided via capabilities. If not using the global OCIS_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA
in the frontend service.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -8993,10 +8992,10 @@ OCIS_SYSTEM_USER_API_KEY:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SYSTEM_USER_ID: OCIS_SYSTEM_USER_ID:
name: OCIS_SYSTEM_USER_ID name: OCIS_SYSTEM_USER_ID;SETTINGS_SYSTEM_USER_ID
defaultValue: "" defaultValue: ""
type: string type: string
description: ID of the oCIS storage-system system user. Admins need to set the ID description: ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID
for the STORAGE-SYSTEM system user in this config option which is then used to for the STORAGE-SYSTEM system user in this config option which is then used to
reference the user. Any reasonable long string is possible, preferably this would reference the user. Any reasonable long string is possible, preferably this would
be an UUIDv4 format. be an UUIDv4 format.
@@ -9014,40 +9013,40 @@ OCIS_SYSTEM_USER_IDP:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_COLLECTOR: OCIS_TRACING_COLLECTOR:
name: OCIS_TRACING_COLLECTOR;CLIENTLOG_TRACING_COLLECTOR name: OCIS_TRACING_COLLECTOR;IDM_TRACING_COLLECTOR
defaultValue: "" defaultValue: ""
type: string type: string
description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. description: The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces.
Only used if the tracing endpoint is unset. Only used if the tracing endpoint is unset.
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_ENABLED: OCIS_TRACING_ENABLED:
name: OCIS_TRACING_ENABLED;CLIENTLOG_TRACING_ENABLED name: OCIS_TRACING_ENABLED;IDM_TRACING_ENABLED
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Activates tracing. description: Activates tracing.
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_ENDPOINT: OCIS_TRACING_ENDPOINT:
name: OCIS_TRACING_ENDPOINT;CLIENTLOG_TRACING_ENDPOINT name: OCIS_TRACING_ENDPOINT;IDM_TRACING_ENDPOINT
defaultValue: "" defaultValue: ""
type: string type: string
description: The endpoint of the tracing agent. description: The endpoint of the tracing agent.
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_TYPE: OCIS_TRACING_TYPE:
name: OCIS_TRACING_TYPE;CLIENTLOG_TRACING_TYPE name: OCIS_TRACING_TYPE;IDM_TRACING_TYPE
defaultValue: "" defaultValue: ""
type: string type: string
description: The type of tracing. Defaults to '', which is the same as 'jaeger'. description: The type of tracing. Defaults to '', which is the same as 'jaeger'.
Allowed tracing types are 'jaeger' and '' as of now. Allowed tracing types are 'jaeger' and '' as of now.
introductionVersion: "5.0" introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
@@ -9061,24 +9060,21 @@ OCIS_TRANSFER_SECRET:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRANSLATION_PATH: OCIS_TRANSLATION_PATH:
name: OCIS_TRANSLATION_PATH;GRAPH_TRANSLATION_PATH name: OCIS_TRANSLATION_PATH;USERLOG_TRANSLATION_PATH
defaultValue: "" defaultValue: ""
type: string type: string
description: (optional) Set this to a path with custom translations to overwrite description: (optional) Set this to a path with custom translations to overwrite
the builtin translations. Note that file and folder naming rules apply, see the the builtin translations. Note that file and folder naming rules apply, see the
documentation for more details. documentation for more details.
introductionVersion: '%%NEXT%%' introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_URL: OCIS_URL:
name: OCIS_URL;WEBFINGER_OWNCLOUD_SERVER_INSTANCE_URL name: OCIS_URL;OCIS_OIDC_ISSUER
defaultValue: https://localhost:9200 defaultValue: https://localhost:9200
type: string type: string
description: The URL for the legacy ownCloud server instance relation (not to be description: The OIDC issuer URL to assign to the demo users.
confused with the product ownCloud Server). It defaults to the OCIS_URL but can
be overridden to support some reverse proxy corner cases. To shard the deployment,
multiple instances can be configured in the configuration file.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""