From 276e94cc45b291b5281a1ba91361264663d86fed Mon Sep 17 00:00:00 2001 From: Martin Date: Sat, 11 Feb 2023 00:07:08 +0000 Subject: [PATCH] commit b68914b5217f8a53192fb343f9718db787c58c80 Merge: cd804685b 9ddbe9168 Author: Martin Date: Fri Feb 10 13:50:31 2023 +0100 Merge pull request #5549 from kobergj/BackportEnvDescImprovement --- .../_includes/adoc/global_configvars.adoc | 40 +++++++++---------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/services/_includes/adoc/global_configvars.adoc b/services/_includes/adoc/global_configvars.adoc index 96ffadc9e80..4b78f5bbbc9 100644 --- a/services/_includes/adoc/global_configvars.adoc +++ b/services/_includes/adoc/global_configvars.adoc @@ -41,7 +41,7 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++uid=reva,ou=sysusers,o=libregraph-idm ++ +++uid=libregraph,ou=sysusers,o=libregraph-idm ++ a| [subs=-attributes] LDAP DN to use for simple bind authentication with the target LDAP server. @@ -178,10 +178,10 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ownclouduuid ++ +++owncloudUUID ++ a| [subs=-attributes] -LDAP Attribute to use as the unique id for groups. This should be a stable globally unique id (e.g. a UUID). +LDAP Attribute to use as the unique id for groups. This should be a stable globally unique ID like 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 IDs. +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. 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 values are 'base', 'one' and 'sub'. +LDAP search scope to use when looking up groups. Supported scopes are 'base', 'one' and 'sub'. a| `LDAP_INSECURE` @@ -367,10 +367,10 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ownclouduuid ++ +++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 IDs. +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. 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 values are 'base', 'one' and 'sub'. +LDAP search scope to use when looking up users. Supported scopes 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` @@ -850,7 +850,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Allow insecure connections to the GATEWAY service. +Allow insecure connections to the OIDC issuer. a| `OCIS_JWT_SECRET` @@ -1071,7 +1071,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -Machine auth API key used to validate internal requests necessary for the access to resources from other services. +Machine auth API key used to validate internal requests necessary to access resources from other services. a| `OCIS_OIDC_ISSUER` @@ -1092,7 +1092,7 @@ a| [subs=-attributes] ++https://localhost:9200 ++ a| [subs=-attributes] -The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. +URL of the OIDC issuer. It defaults to URL of the builtin IDP. a| `OCIS_SYSTEM_USER_API_KEY` @@ -1130,7 +1130,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format. +ID of the oCIS storage-system system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format. a| `OCIS_SYSTEM_USER_IDP` @@ -1334,7 +1334,7 @@ a| [subs=-attributes] ++https://localhost:9200 ++ a| [subs=-attributes] -URL where oCIS is reachable for users. +URL of the OIDC issuer. It defaults to URL of the builtin IDP. a| `REVA_GATEWAY` @@ -1385,5 +1385,5 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -The storage transfer secret. +Transfer secret for signing file up- and download requests. |===