diff --git a/services/_includes/adoc/global_configvars.adoc b/services/_includes/adoc/global_configvars.adoc index 8228cda6809..7c4edd4b8e0 100644 --- a/services/_includes/adoc/global_configvars.adoc +++ b/services/_includes/adoc/global_configvars.adoc @@ -26,7 +26,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -The default role assignments the demo users should be setup. +Flag to enable or disable the creation of the demo users. a| `LDAP_BIND_DN` @@ -131,7 +131,7 @@ a| [subs=-attributes] ++groupOfNames ++ a| [subs=-attributes] -The object class to use for groups in the default group search filter ('groupOfNames'). +The object class to use for groups in the default group search filter ('groupOfNames'). a| `LDAP_GROUP_SCHEMA_DISPLAYNAME` @@ -181,7 +181,7 @@ a| [subs=-attributes] ++ownclouduuid ++ a| [subs=-attributes] -LDAP Attribute to use as the unique id for groups. This should be a stable globally unique ID like a UUID. +LDAP Attribute to use as the unique id for groups. This should be a stable globally unique id (e.g. a UUID). a| `LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING` @@ -197,7 +197,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Set this to true if the defined 'id' attribute for groups is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute of Active Directory for the group ID's. +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. a| `LDAP_GROUP_SCHEMA_MAIL` @@ -246,7 +246,7 @@ a| [subs=-attributes] ++sub ++ a| [subs=-attributes] -LDAP search scope to use when looking up groups. Supported scopes are 'base', 'one' and 'sub'. +LDAP search scope to use when looking up groups. Supported values are 'base', 'one' and 'sub'. a| `LDAP_INSECURE` @@ -370,7 +370,7 @@ a| [subs=-attributes] ++ownclouduuid ++ a| [subs=-attributes] -LDAP Attribute to use as the unique id for users. This should be a stable globally unique id like a UUID. +LDAP Attribute to use as the unique id for users. This should be a stable globally unique ID like a UUID. a| `LDAP_USER_SCHEMA_ID_IS_OCTETSTRING` @@ -386,7 +386,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Set this to true if the defined 'id' attribute for users is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute of Active Directory for the user id's. +Set this to true if the defined 'id' attribute for users is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute of Active Directory for the user IDs. a| `LDAP_USER_SCHEMA_MAIL` @@ -440,7 +440,7 @@ a| [subs=-attributes] ++sub ++ a| [subs=-attributes] -LDAP search scope to use when looking up users. Supported scopes are 'base', 'one' and 'sub'. +LDAP search scope to use when looking up users. Supported values are 'base', 'one' and 'sub'. a| `OCIS_ADMIN_USER_ID` @@ -466,13 +466,13 @@ a| [subs=attributes+] * xref:{s-path}/storage-users.adoc[storage-users] + a| [subs=-attributes] -++[]string ++ +++string ++ a| [subs=-attributes] -++[] ++ +++ ++ a| [subs=-attributes] -Node addresses to use for the cache store. +A comma-separated list of addresses to connect to. Only valid if the above setting is set to "etcd" a| `OCIS_CACHE_STORE_SIZE` @@ -501,10 +501,10 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++memory ++ +++ ++ a| [subs=-attributes] -Store implementation for the cache. Valid values are "memory" (default), "redis", and "etcd". +The type of the cache store. Valid options are "noop", "ocmem", "etcd" and "memory" a| `OCIS_CORS_ALLOW_CREDENTIALS` @@ -1078,7 +1078,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The machine auth API key used to validate internal requests necessary to access resources from other services. +Machine auth API key used to validate internal requests necessary to access resources from other services. a| `OCIS_OIDC_ISSUER` @@ -1099,7 +1099,7 @@ a| [subs=-attributes] ++https://localhost:9200 ++ a| [subs=-attributes] -The identity provider value to set in the group IDs of the CS3 group objects for groups returned by this group provider. +URL of the OIDC issuer. It defaults to URL of the builtin IDP. a| `OCIS_SYSTEM_USER_API_KEY` @@ -1338,10 +1338,10 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++https://localhost:9200/ ++ +++https://localhost:9200 ++ a| [subs=-attributes] -Base url to navigate back from the app the containing folder in the file list. +URL of the OIDC issuer. It defaults to URL of the builtin IDP. a| `REVA_GATEWAY`