[docs-only] [chore] updates from make -C docs docs-generate

This commit is contained in:
mmattel
2024-04-08 14:04:13 +02:00
parent 80ef8ca458
commit 781ab559bf
2 changed files with 83 additions and 87 deletions
+82 -86
View File
@@ -6902,28 +6902,28 @@ OCIS_ASYNC_UPLOADS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_AUTH_PASSWORD: OCIS_CACHE_AUTH_PASSWORD:
name: OCIS_CACHE_AUTH_PASSWORD;STORAGE_SYSTEM_CACHE_AUTH_PASSWORD name: OCIS_CACHE_AUTH_PASSWORD;FRONTEND_OCS_STAT_CACHE_AUTH_PASSWORD
defaultValue: "" defaultValue: ""
type: string type: string
description: Password for the configured store. Only applies when store type 'nats-js-kv' description: The password to use for authentication. Only applies when using the
is configured. 'nats-js-kv' store type.
introductionVersion: "5.0" introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_AUTH_USERNAME: OCIS_CACHE_AUTH_USERNAME:
name: OCIS_CACHE_AUTH_USERNAME;STORAGE_SYSTEM_CACHE_AUTH_USERNAME name: OCIS_CACHE_AUTH_USERNAME;FRONTEND_OCS_STAT_CACHE_AUTH_USERNAME
defaultValue: "" defaultValue: ""
type: string type: string
description: Username for the configured store. Only applies when store type 'nats-js-kv' description: The username to use for authentication. Only applies when using the
is configured. 'nats-js-kv' store type.
introductionVersion: "5.0" introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_DATABASE: OCIS_CACHE_DATABASE:
name: OCIS_CACHE_DATABASE name: OCIS_CACHE_DATABASE
defaultValue: storage-system defaultValue: cache-stat
type: string type: string
description: The database name the configured store should use. description: The database name the configured store should use.
introductionVersion: pre5.0 introductionVersion: pre5.0
@@ -6931,28 +6931,26 @@ OCIS_CACHE_DATABASE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_DISABLE_PERSISTENCE: OCIS_CACHE_DISABLE_PERSISTENCE:
name: OCIS_CACHE_DISABLE_PERSISTENCE;STORAGE_SYSTEM_CACHE_DISABLE_PERSISTENCE name: OCIS_CACHE_DISABLE_PERSISTENCE;FRONTEND_OCS_STAT_CACHE_DISABLE_PERSISTENCE
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Disables persistence of the cache. Only applies when store type 'nats-js-kv' description: Disable persistence of the cache. Only applies when using the 'nats-js-kv'
is configured. Defaults to false. store type. Defaults to false.
introductionVersion: "5.0" introductionVersion: "5.0"
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_SIZE: OCIS_CACHE_SIZE:
name: OCIS_CACHE_SIZE;STORAGE_SYSTEM_CACHE_SIZE name: OCIS_CACHE_SIZE;FRONTEND_OCS_STAT_CACHE_SIZE
defaultValue: "0" defaultValue: "0"
type: int type: int
description: The maximum quantity of items in the user info cache. Only applies description: Max number of entries to hold in the cache.
when store type 'ocmem' is configured. Defaults to 512 which is derived from the
ocmem package though not exclicitely set as default.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_STORE: OCIS_CACHE_STORE:
name: OCIS_CACHE_STORE;STORAGE_SYSTEM_CACHE_STORE name: OCIS_CACHE_STORE;FRONTEND_OCS_STAT_CACHE_STORE
defaultValue: memory defaultValue: memory
type: string type: string
description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'', description: 'The type of the cache store. Supported values are: ''memory'', ''redis-sentinel'',
@@ -6962,7 +6960,7 @@ OCIS_CACHE_STORE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_STORE_NODES: OCIS_CACHE_STORE_NODES:
name: OCIS_CACHE_STORE_NODES;STORAGE_SYSTEM_CACHE_STORE_NODES name: OCIS_CACHE_STORE_NODES;FRONTEND_OCS_STAT_CACHE_STORE_NODES
defaultValue: '[127.0.0.1:9233]' defaultValue: '[127.0.0.1:9233]'
type: '[]string' type: '[]string'
description: A list of nodes to access the configured store. This has no effect description: A list of nodes to access the configured store. This has no effect
@@ -6974,18 +6972,18 @@ OCIS_CACHE_STORE_NODES:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CACHE_TTL: OCIS_CACHE_TTL:
name: OCIS_CACHE_TTL;STORAGE_SYSTEM_CACHE_TTL name: OCIS_CACHE_TTL;FRONTEND_OCS_STAT_CACHE_TTL
defaultValue: 24m0s defaultValue: 5m0s
type: Duration type: Duration
description: Default time to live for user info in the user info cache. Only applied description: Default time to live for user info in the cache. Only applied when
when access tokens has no expiration. See the Environment Variable Types description access tokens has no expiration. See the Environment Variable Types description
for more details. for more details.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_CREDENTIALS: OCIS_CORS_ALLOW_CREDENTIALS:
name: OCIS_CORS_ALLOW_CREDENTIALS;USERLOG_CORS_ALLOW_CREDENTIALS name: OCIS_CORS_ALLOW_CREDENTIALS;WEBDAV_CORS_ALLOW_CREDENTIALS
defaultValue: "true" defaultValue: "true"
type: bool type: bool
description: 'Allow credentials for CORS.See following chapter for more details: description: 'Allow credentials for CORS.See following chapter for more details:
@@ -6995,9 +6993,9 @@ OCIS_CORS_ALLOW_CREDENTIALS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_HEADERS: OCIS_CORS_ALLOW_HEADERS:
name: OCIS_CORS_ALLOW_HEADERS;USERLOG_CORS_ALLOW_HEADERS name: OCIS_CORS_ALLOW_HEADERS;WEBDAV_CORS_ALLOW_HEADERS
defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id defaultValue: '[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id
Ocs-Apirequest]' Cache-Control]'
type: '[]string' type: '[]string'
description: 'A list of allowed CORS headers. See following chapter for more details: description: 'A list of allowed CORS headers. See following chapter for more details:
*Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. *Access-Control-Request-Headers* at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers.
@@ -7007,8 +7005,8 @@ OCIS_CORS_ALLOW_HEADERS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_METHODS: OCIS_CORS_ALLOW_METHODS:
name: OCIS_CORS_ALLOW_METHODS;USERLOG_CORS_ALLOW_METHODS name: OCIS_CORS_ALLOW_METHODS;WEBDAV_CORS_ALLOW_METHODS
defaultValue: '[GET]' defaultValue: '[GET POST PUT PATCH DELETE OPTIONS]'
type: '[]string' type: '[]string'
description: 'A list of allowed CORS methods. See following chapter for more details: description: 'A list of allowed CORS methods. See following chapter for more details:
*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.
@@ -7018,7 +7016,7 @@ OCIS_CORS_ALLOW_METHODS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_CORS_ALLOW_ORIGINS: OCIS_CORS_ALLOW_ORIGINS:
name: OCIS_CORS_ALLOW_ORIGINS;USERLOG_CORS_ALLOW_ORIGINS name: OCIS_CORS_ALLOW_ORIGINS;WEBDAV_CORS_ALLOW_ORIGINS
defaultValue: '[*]' defaultValue: '[*]'
type: '[]string' type: '[]string'
description: 'A list of allowed CORS origins. See following chapter for more details: description: 'A list of allowed CORS origins. See following chapter for more details:
@@ -7285,7 +7283,7 @@ OCIS_JWT_SECRET:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_BASE_PATH: OCIS_KEYCLOAK_BASE_PATH:
name: OCIS_KEYCLOAK_BASE_PATH;INVITATIONS_KEYCLOAK_BASE_PATH name: OCIS_KEYCLOAK_BASE_PATH;GRAPH_KEYCLOAK_BASE_PATH
defaultValue: "" defaultValue: ""
type: string type: string
description: The URL to access keycloak. description: The URL to access keycloak.
@@ -7294,16 +7292,16 @@ OCIS_KEYCLOAK_BASE_PATH:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_CLIENT_ID: OCIS_KEYCLOAK_CLIENT_ID:
name: OCIS_KEYCLOAK_CLIENT_ID;INVITATIONS_KEYCLOAK_CLIENT_ID name: OCIS_KEYCLOAK_CLIENT_ID;GRAPH_KEYCLOAK_CLIENT_ID
defaultValue: "" defaultValue: ""
type: string type: string
description: The client ID to authenticate with keycloak. description: The client id to authenticate with keycloak.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_CLIENT_REALM: OCIS_KEYCLOAK_CLIENT_REALM:
name: OCIS_KEYCLOAK_CLIENT_REALM;INVITATIONS_KEYCLOAK_CLIENT_REALM name: OCIS_KEYCLOAK_CLIENT_REALM;GRAPH_KEYCLOAK_CLIENT_REALM
defaultValue: "" defaultValue: ""
type: string type: string
description: The realm the client is defined in. description: The realm the client is defined in.
@@ -7312,7 +7310,7 @@ OCIS_KEYCLOAK_CLIENT_REALM:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_CLIENT_SECRET: OCIS_KEYCLOAK_CLIENT_SECRET:
name: OCIS_KEYCLOAK_CLIENT_SECRET;INVITATIONS_KEYCLOAK_CLIENT_SECRET name: OCIS_KEYCLOAK_CLIENT_SECRET;GRAPH_KEYCLOAK_CLIENT_SECRET
defaultValue: "" defaultValue: ""
type: string type: string
description: The client secret to use in authentication. description: The client secret to use in authentication.
@@ -7321,7 +7319,7 @@ OCIS_KEYCLOAK_CLIENT_SECRET:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY:
name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;INVITATIONS_KEYCLOAK_INSECURE_SKIP_VERIFY name: OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY;GRAPH_KEYCLOAK_INSECURE_SKIP_VERIFY
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Disable TLS certificate validation for Keycloak connections. Do not description: Disable TLS certificate validation for Keycloak connections. Do not
@@ -7331,7 +7329,7 @@ OCIS_KEYCLOAK_INSECURE_SKIP_VERIFY:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_KEYCLOAK_USER_REALM: OCIS_KEYCLOAK_USER_REALM:
name: OCIS_KEYCLOAK_USER_REALM;INVITATIONS_KEYCLOAK_USER_REALM name: OCIS_KEYCLOAK_USER_REALM;GRAPH_KEYCLOAK_USER_REALM
defaultValue: "" defaultValue: ""
type: string type: string
description: The realm users are defined. description: The realm users are defined.
@@ -7340,7 +7338,7 @@ OCIS_KEYCLOAK_USER_REALM:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_BIND_DN: OCIS_LDAP_BIND_DN:
name: OCIS_LDAP_BIND_DN;USERS_LDAP_BIND_DN name: OCIS_LDAP_BIND_DN;AUTH_BASIC_LDAP_BIND_DN
defaultValue: uid=reva,ou=sysusers,o=libregraph-idm defaultValue: uid=reva,ou=sysusers,o=libregraph-idm
type: string type: string
description: LDAP DN to use for simple bind authentication with the target LDAP description: LDAP DN to use for simple bind authentication with the target LDAP
@@ -7350,7 +7348,7 @@ OCIS_LDAP_BIND_DN:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_BIND_PASSWORD: OCIS_LDAP_BIND_PASSWORD:
name: OCIS_LDAP_BIND_PASSWORD;USERS_LDAP_BIND_PASSWORD name: OCIS_LDAP_BIND_PASSWORD;AUTH_BASIC_LDAP_BIND_PASSWORD
defaultValue: "" defaultValue: ""
type: string type: string
description: Password to use for authenticating the 'bind_dn'. description: Password to use for authenticating the 'bind_dn'.
@@ -7359,7 +7357,7 @@ OCIS_LDAP_BIND_PASSWORD:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_CACERT: OCIS_LDAP_CACERT:
name: OCIS_LDAP_CACERT;USERS_LDAP_CACERT name: OCIS_LDAP_CACERT;AUTH_BASIC_LDAP_CACERT
defaultValue: /var/lib/ocis/idm/ldap.crt defaultValue: /var/lib/ocis/idm/ldap.crt
type: string type: string
description: Path/File name for the root CA certificate (in PEM format) used to description: Path/File name for the root CA certificate (in PEM format) used to
@@ -7370,7 +7368,7 @@ OCIS_LDAP_CACERT:
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;AUTH_BASIC_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. Valid options
@@ -7383,7 +7381,7 @@ OCIS_LDAP_DISABLE_USER_MECHANISM:
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;AUTH_BASIC_DISABLED_USERS_GROUP_DN
defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm defaultValue: cn=DisabledUsersGroup,ou=groups,o=libregraph-idm
type: string type: string
description: The distinguished name of the group to which added users will be classified description: The distinguished name of the group to which added users will be classified
@@ -7393,7 +7391,7 @@ OCIS_LDAP_DISABLED_USERS_GROUP_DN:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_BASE_DN: OCIS_LDAP_GROUP_BASE_DN:
name: OCIS_LDAP_GROUP_BASE_DN;USERS_LDAP_GROUP_BASE_DN name: OCIS_LDAP_GROUP_BASE_DN;AUTH_BASIC_LDAP_GROUP_BASE_DN
defaultValue: ou=groups,o=libregraph-idm defaultValue: ou=groups,o=libregraph-idm
type: string type: string
description: Search base DN for looking up LDAP groups. description: Search base DN for looking up LDAP groups.
@@ -7402,7 +7400,7 @@ OCIS_LDAP_GROUP_BASE_DN:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_FILTER: OCIS_LDAP_GROUP_FILTER:
name: OCIS_LDAP_GROUP_FILTER;USERS_LDAP_GROUP_FILTER name: OCIS_LDAP_GROUP_FILTER;AUTH_BASIC_LDAP_GROUP_FILTER
defaultValue: "" defaultValue: ""
type: string type: string
description: LDAP filter to add to the default filters for group searches. description: LDAP filter to add to the default filters for group searches.
@@ -7411,17 +7409,17 @@ OCIS_LDAP_GROUP_FILTER:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_OBJECTCLASS: OCIS_LDAP_GROUP_OBJECTCLASS:
name: OCIS_LDAP_GROUP_OBJECTCLASS;USERS_LDAP_GROUP_OBJECTCLASS name: OCIS_LDAP_GROUP_OBJECTCLASS;AUTH_BASIC_LDAP_GROUP_OBJECTCLASS
defaultValue: groupOfNames defaultValue: groupOfNames
type: string type: string
description: The object class to use for groups in the default group search filter description: The object class to use for groups in the default group search filter
like 'groupOfNames'. ('groupOfNames').
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME:
name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;USERS_LDAP_GROUP_SCHEMA_DISPLAYNAME name: OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME;AUTH_BASIC_LDAP_GROUP_SCHEMA_DISPLAYNAME
defaultValue: cn defaultValue: cn
type: string type: string
description: LDAP Attribute to use for the displayname of groups (often the same description: LDAP Attribute to use for the displayname of groups (often the same
@@ -7431,7 +7429,7 @@ OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_GROUPNAME: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME:
name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;USERS_LDAP_GROUP_SCHEMA_GROUPNAME name: OCIS_LDAP_GROUP_SCHEMA_GROUPNAME;AUTH_BASIC_LDAP_GROUP_SCHEMA_GROUPNAME
defaultValue: cn defaultValue: cn
type: string type: string
description: LDAP Attribute to use for the name of groups. description: LDAP Attribute to use for the name of groups.
@@ -7440,28 +7438,28 @@ OCIS_LDAP_GROUP_SCHEMA_GROUPNAME:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_ID: OCIS_LDAP_GROUP_SCHEMA_ID:
name: OCIS_LDAP_GROUP_SCHEMA_ID;USERS_LDAP_GROUP_SCHEMA_ID name: OCIS_LDAP_GROUP_SCHEMA_ID;AUTH_BASIC_LDAP_GROUP_SCHEMA_ID
defaultValue: ownclouduuid defaultValue: ownclouduuid
type: string type: string
description: LDAP Attribute to use as the unique ID for groups. This should be a description: LDAP Attribute to use as the unique id for groups. This should be a
stable globally unique ID like a UUID. stable globally unique id (e.g. a UUID).
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING:
name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;USERS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING name: OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;AUTH_BASIC_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Set this to true if the defined 'id' attribute for groups is of the description: Set this to true if the defined 'id' attribute for groups is of the
'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute
of Active Directory for the group ID's. of Active Directory for the group IDs.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_MAIL: OCIS_LDAP_GROUP_SCHEMA_MAIL:
name: OCIS_LDAP_GROUP_SCHEMA_MAIL;USERS_LDAP_GROUP_SCHEMA_MAIL name: OCIS_LDAP_GROUP_SCHEMA_MAIL;AUTH_BASIC_LDAP_GROUP_SCHEMA_MAIL
defaultValue: mail defaultValue: mail
type: string type: string
description: LDAP Attribute to use for the email address of groups (can be empty). description: LDAP Attribute to use for the email address of groups (can be empty).
@@ -7470,7 +7468,7 @@ OCIS_LDAP_GROUP_SCHEMA_MAIL:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_SCHEMA_MEMBER: OCIS_LDAP_GROUP_SCHEMA_MEMBER:
name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;USERS_LDAP_GROUP_SCHEMA_MEMBER name: OCIS_LDAP_GROUP_SCHEMA_MEMBER;AUTH_BASIC_LDAP_GROUP_SCHEMA_MEMBER
defaultValue: member defaultValue: member
type: string type: string
description: LDAP Attribute that is used for group members. description: LDAP Attribute that is used for group members.
@@ -7479,7 +7477,7 @@ OCIS_LDAP_GROUP_SCHEMA_MEMBER:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_GROUP_SCOPE: OCIS_LDAP_GROUP_SCOPE:
name: OCIS_LDAP_GROUP_SCOPE;USERS_LDAP_GROUP_SCOPE name: OCIS_LDAP_GROUP_SCOPE;AUTH_BASIC_LDAP_GROUP_SCOPE
defaultValue: sub defaultValue: sub
type: string type: string
description: LDAP search scope to use when looking up groups. Supported values are description: LDAP search scope to use when looking up groups. Supported values are
@@ -7489,7 +7487,7 @@ OCIS_LDAP_GROUP_SCOPE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_INSECURE: OCIS_LDAP_INSECURE:
name: OCIS_LDAP_INSECURE;USERS_LDAP_INSECURE name: OCIS_LDAP_INSECURE;AUTH_BASIC_LDAP_INSECURE
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Disable TLS certificate validation for the LDAP connections. Do not description: Disable TLS certificate validation for the LDAP connections. Do not
@@ -7511,7 +7509,7 @@ OCIS_LDAP_SERVER_WRITE_ENABLED:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_URI: OCIS_LDAP_URI:
name: OCIS_LDAP_URI;USERS_LDAP_URI name: OCIS_LDAP_URI;AUTH_BASIC_LDAP_URI
defaultValue: ldaps://localhost:9235 defaultValue: ldaps://localhost:9235
type: string type: string
description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://' description: URI of the LDAP Server to connect to. Supported URI schemes are 'ldaps://'
@@ -7521,7 +7519,7 @@ OCIS_LDAP_URI:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_BASE_DN: OCIS_LDAP_USER_BASE_DN:
name: OCIS_LDAP_USER_BASE_DN;USERS_LDAP_USER_BASE_DN name: OCIS_LDAP_USER_BASE_DN;AUTH_BASIC_LDAP_USER_BASE_DN
defaultValue: ou=users,o=libregraph-idm defaultValue: ou=users,o=libregraph-idm
type: string type: string
description: Search base DN for looking up LDAP users. description: Search base DN for looking up LDAP users.
@@ -7530,7 +7528,7 @@ OCIS_LDAP_USER_BASE_DN:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_ENABLED_ATTRIBUTE: OCIS_LDAP_USER_ENABLED_ATTRIBUTE:
name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;USERS_LDAP_USER_ENABLED_ATTRIBUTE name: OCIS_LDAP_USER_ENABLED_ATTRIBUTE;AUTH_BASIC_LDAP_USER_ENABLED_ATTRIBUTE
defaultValue: ownCloudUserEnabled defaultValue: ownCloudUserEnabled
type: string type: string
description: LDAP attribute to use as a flag telling if the user is enabled or disabled. description: LDAP attribute to use as a flag telling if the user is enabled or disabled.
@@ -7539,7 +7537,7 @@ OCIS_LDAP_USER_ENABLED_ATTRIBUTE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_FILTER: OCIS_LDAP_USER_FILTER:
name: OCIS_LDAP_USER_FILTER;USERS_LDAP_USER_FILTER name: OCIS_LDAP_USER_FILTER;AUTH_BASIC_LDAP_USER_FILTER
defaultValue: "" defaultValue: ""
type: string type: string
description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'. description: LDAP filter to add to the default filters for user search like '(objectclass=ownCloud)'.
@@ -7548,17 +7546,17 @@ OCIS_LDAP_USER_FILTER:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_OBJECTCLASS: OCIS_LDAP_USER_OBJECTCLASS:
name: OCIS_LDAP_USER_OBJECTCLASS;USERS_LDAP_USER_OBJECTCLASS name: OCIS_LDAP_USER_OBJECTCLASS;AUTH_BASIC_LDAP_USER_OBJECTCLASS
defaultValue: inetOrgPerson defaultValue: inetOrgPerson
type: string type: string
description: The object class to use for users in the default user search filter description: The object class to use for users in the default user search filter
like 'inetOrgPerson'. ('inetOrgPerson').
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_DISPLAYNAME: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME:
name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;USERS_LDAP_USER_SCHEMA_DISPLAYNAME name: OCIS_LDAP_USER_SCHEMA_DISPLAYNAME;AUTH_BASIC_LDAP_USER_SCHEMA_DISPLAYNAME
defaultValue: displayname defaultValue: displayname
type: string type: string
description: LDAP Attribute to use for the displayname of users. description: LDAP Attribute to use for the displayname of users.
@@ -7567,7 +7565,7 @@ 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;USERS_LDAP_USER_SCHEMA_ID name: OCIS_LDAP_USER_SCHEMA_ID;AUTH_BASIC_LDAP_USER_SCHEMA_ID
defaultValue: ownclouduuid defaultValue: ownclouduuid
type: string type: string
description: LDAP Attribute to use as the unique ID for users. This should be a description: LDAP Attribute to use as the unique ID for users. This should be a
@@ -7577,18 +7575,18 @@ OCIS_LDAP_USER_SCHEMA_ID:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING:
name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;USERS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING name: OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;AUTH_BASIC_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Set this to true if the defined 'ID' attribute for users is of the description: Set this to true if the defined 'ID' attribute for users is of the
'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute
of Active Directory for the user ID's. of Active Directory for the user IDs.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_MAIL: OCIS_LDAP_USER_SCHEMA_MAIL:
name: OCIS_LDAP_USER_SCHEMA_MAIL;USERS_LDAP_USER_SCHEMA_MAIL name: OCIS_LDAP_USER_SCHEMA_MAIL;AUTH_BASIC_LDAP_USER_SCHEMA_MAIL
defaultValue: mail defaultValue: mail
type: string type: string
description: LDAP Attribute to use for the email address of users. description: LDAP Attribute to use for the email address of users.
@@ -7607,7 +7605,7 @@ OCIS_LDAP_USER_SCHEMA_USER_TYPE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCHEMA_USERNAME: OCIS_LDAP_USER_SCHEMA_USERNAME:
name: OCIS_LDAP_USER_SCHEMA_USERNAME;USERS_LDAP_USER_SCHEMA_USERNAME name: OCIS_LDAP_USER_SCHEMA_USERNAME;AUTH_BASIC_LDAP_USER_SCHEMA_USERNAME
defaultValue: uid defaultValue: uid
type: string type: string
description: LDAP Attribute to use for username of users. description: LDAP Attribute to use for username of users.
@@ -7616,7 +7614,7 @@ OCIS_LDAP_USER_SCHEMA_USERNAME:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LDAP_USER_SCOPE: OCIS_LDAP_USER_SCOPE:
name: OCIS_LDAP_USER_SCOPE;USERS_LDAP_USER_SCOPE name: OCIS_LDAP_USER_SCOPE;AUTH_BASIC_LDAP_USER_SCOPE
defaultValue: sub defaultValue: sub
type: string type: string
description: LDAP search scope to use when looking up users. Supported values are description: LDAP search scope to use when looking up users. Supported values are
@@ -7626,7 +7624,7 @@ OCIS_LDAP_USER_SCOPE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_COLOR: OCIS_LOG_COLOR:
name: OCIS_LOG_COLOR;USERLOG_LOG_COLOR name: OCIS_LOG_COLOR;WEBDAV_LOG_COLOR
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Activates colorized log output. description: Activates colorized log output.
@@ -7635,7 +7633,7 @@ OCIS_LOG_COLOR:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_FILE: OCIS_LOG_FILE:
name: OCIS_LOG_FILE;USERLOG_LOG_FILE name: OCIS_LOG_FILE;WEBDAV_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.
@@ -7644,7 +7642,7 @@ OCIS_LOG_FILE:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_LEVEL: OCIS_LOG_LEVEL:
name: OCIS_LOG_LEVEL;USERLOG_LOG_LEVEL name: OCIS_LOG_LEVEL;WEBDAV_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'',
@@ -7654,7 +7652,7 @@ OCIS_LOG_LEVEL:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_LOG_PRETTY: OCIS_LOG_PRETTY:
name: OCIS_LOG_PRETTY;USERLOG_LOG_PRETTY name: OCIS_LOG_PRETTY;WEBDAV_LOG_PRETTY
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Activates pretty log output. description: Activates pretty log output.
@@ -7684,7 +7682,7 @@ OCIS_OIDC_CLIENT_ID:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_OIDC_ISSUER: OCIS_OIDC_ISSUER:
name: OCIS_URL;OCIS_OIDC_ISSUER;PROXY_OIDC_ISSUER name: OCIS_URL;OCIS_OIDC_ISSUER;AUTH_BEARER_OIDC_ISSUER
defaultValue: https://localhost:9200 defaultValue: https://localhost:9200
type: string type: string
description: URL of the OIDC issuer. It defaults to URL of the builtin IDP. description: URL of the OIDC issuer. It defaults to URL of the builtin IDP.
@@ -7911,12 +7909,11 @@ OCIS_SHOW_USER_EMAIL_IN_RESULTS:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_SPACES_MAX_QUOTA: OCIS_SPACES_MAX_QUOTA:
name: OCIS_SPACES_MAX_QUOTA;STORAGE_USERS_OCIS_MAX_QUOTA name: OCIS_SPACES_MAX_QUOTA;FRONTEND_MAX_QUOTA
defaultValue: "0" defaultValue: "0"
type: uint64 type: uint64
description: Set a global max quota for spaces in bytes. A value of 0 equals unlimited. description: Set the global max quota value in bytes. A value of 0 equals unlimited.
If not using the global OCIS_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA The value is provided via capabilities.
in the frontend service.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -7952,7 +7949,7 @@ OCIS_SYSTEM_USER_IDP:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_COLLECTOR: OCIS_TRACING_COLLECTOR:
name: OCIS_TRACING_COLLECTOR;USERLOG_TRACING_COLLECTOR name: OCIS_TRACING_COLLECTOR;WEBDAV_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.
@@ -7962,7 +7959,7 @@ OCIS_TRACING_COLLECTOR:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_ENABLED: OCIS_TRACING_ENABLED:
name: OCIS_TRACING_ENABLED;USERLOG_TRACING_ENABLED name: OCIS_TRACING_ENABLED;WEBDAV_TRACING_ENABLED
defaultValue: "false" defaultValue: "false"
type: bool type: bool
description: Activates tracing. description: Activates tracing.
@@ -7971,7 +7968,7 @@ OCIS_TRACING_ENABLED:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_ENDPOINT: OCIS_TRACING_ENDPOINT:
name: OCIS_TRACING_ENDPOINT;USERLOG_TRACING_ENDPOINT name: OCIS_TRACING_ENDPOINT;WEBDAV_TRACING_ENDPOINT
defaultValue: "" defaultValue: ""
type: string type: string
description: The endpoint of the tracing agent. description: The endpoint of the tracing agent.
@@ -7980,7 +7977,7 @@ OCIS_TRACING_ENDPOINT:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_TRACING_TYPE: OCIS_TRACING_TYPE:
name: OCIS_TRACING_TYPE;USERLOG_TRACING_TYPE name: OCIS_TRACING_TYPE;WEBDAV_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'.
@@ -8010,10 +8007,10 @@ OCIS_TRANSLATION_PATH:
removalVersion: "" removalVersion: ""
deprecationInfo: "" deprecationInfo: ""
OCIS_URL: OCIS_URL:
name: OCIS_URL;OCDAV_PUBLIC_URL name: OCIS_URL;OCIS_PUBLIC_URL
defaultValue: https://localhost:9200 defaultValue: https://127.0.0.1:9200
type: string type: string
description: URL where oCIS is reachable for users. description: URL, where oCIS is reachable for users.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -12455,7 +12452,7 @@ STORAGE_USERS_OCIS_LOCK_CYCLE_DURATION_FACTOR:
type: int type: int
description: When trying to lock files, ocis will multiply the cycle with this factor description: When trying to lock files, ocis will multiply the cycle with this factor
and use it as a millisecond timeout. Values of 0 or below will be ignored and and use it as a millisecond timeout. Values of 0 or below will be ignored and
the default value of 30 will be used. the default value will be used.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -12466,8 +12463,7 @@ STORAGE_USERS_OCIS_MAX_ACQUIRE_LOCK_CYCLES:
type: int type: int
description: When trying to lock files, ocis will try this amount of times to acquire description: When trying to lock files, ocis will try this amount of times to acquire
the lock before failing. After each try it will wait for an increasing amount the lock before failing. After each try it will wait for an increasing amount
of time. Values of 0 or below will be ignored and the default value of 20 will of time. Values of 0 or below will be ignored and the default value will be used.
be used.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
@@ -12478,7 +12474,7 @@ STORAGE_USERS_OCIS_MAX_CONCURRENCY:
type: int type: int
description: Maximum number of concurrent go-routines. Higher values can potentially description: Maximum number of concurrent go-routines. Higher values can potentially
get work done faster but will also cause more load on the system. Values of 0 get work done faster but will also cause more load on the system. Values of 0
or below will be ignored and the default value of 100 will be used. or below will be ignored and the default value will be used.
introductionVersion: pre5.0 introductionVersion: pre5.0
deprecationVersion: "" deprecationVersion: ""
removalVersion: "" removalVersion: ""
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: App Registry title: App Registry
date: 2024-04-04T15:08:13.220767367+02:00 date: 2024-04-08T14:03:04.981194969+02:00
weight: 20 weight: 20
geekdocRepo: https://github.com/owncloud/ocis geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/services/app-registry geekdocEditPath: edit/master/services/app-registry