Merge pull request #5700 from owncloud/invitations

Invitations service
owncloud · Mar 29, 2023 · 4201111 · 4201111
1 parent 2cf32f0
commit 4201111
Show file tree

Hide file tree

Showing 24 changed files with 49 additions and 49 deletions.
diff --git 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=libregraph,ou=sysusers,o=libregraph-idm ++
+++uid=reva,ou=sysusers,o=libregraph-idm ++
 
 a| [subs=-attributes]
 LDAP DN to use for simple bind authentication with the target LDAP server.
@@ -109,10 +109,10 @@ a| [subs=-attributes]
 ++string ++
 
 a| [subs=-attributes]
-++attribute ++
+++none ++
 
 a| [subs=-attributes]
-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 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'.
+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.
 
 a| `LDAP_GROUP_BASE_DN`
 
@@ -210,10 +210,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 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`
 
@@ -229,7 +229,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`
 
@@ -278,7 +278,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`
 
@@ -349,7 +349,7 @@ a| [subs=-attributes]
 ++ownCloudUserEnabled ++
 
 a| [subs=-attributes]
-LDAP Attribute to use as a flag telling if the user is enabled or disabled.
+LDAP attribute to use as a flag telling if the user is enabled or disabled.
 
 a| `LDAP_USER_FILTER`
 
@@ -416,10 +416,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`
 
@@ -435,7 +435,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`
 
@@ -504,7 +504,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`
 
@@ -520,7 +520,7 @@ a| [subs=-attributes]
 ++ ++
 
 a| [subs=-attributes]
-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.
+ID of the user who collects all necessary information for deletion.
 
 a| `OCIS_CACHE_STORE`
 
@@ -536,10 +536,10 @@ a| [subs=-attributes]
 ++string ++
 
 a| [subs=-attributes]
-++memory ++
+++ ++
 
 a| [subs=-attributes]
-The type of the userinfo cache store. Supported values are: 'memory', 'ocmem', 'etcd', 'redis', 'redis-sentinel', 'nats-js', 'noop'. See the text description for details.
+The type of the cache store. Supported values are: 'memory', 'ocmem', 'etcd', 'redis', 'redis-sentinel', 'nats-js', 'noop'. See the text description for details.
 
 a| `OCIS_CACHE_STORE_ADDRESS`
 
@@ -606,7 +606,7 @@ a| [subs=-attributes]
 ++0 ++
 
 a| [subs=-attributes]
-The maximum quantity of items in the user info cache. Only applies when store type 'ocmem' is configured. Defaults to 512.
+The maximum quantity of items in the store. Only applies when store type 'ocmem' is configured. Defaults to 512.
 
 a| `OCIS_CACHE_STORE_TTL`
 
@@ -622,10 +622,10 @@ a| [subs=-attributes]
 ++Duration ++
 
 a| [subs=-attributes]
-++10s ++
+++0s ++
 
 a| [subs=-attributes]
-Default time to live for user info in the user info cache. Only applied when access tokens has no expiration. The duration can be set as number followed by a unit identifier like s, m or h. Defaults to '10s' (10 seconds).
+Time to live for events in the store. The duration can be set as number followed by a unit identifier like s, m or h. Defaults to '336h' (2 weeks).
 
 a| `OCIS_CACHE_STORE_TYPE`
 
@@ -640,10 +640,10 @@ a| [subs=-attributes]
 ++string ++
 
 a| [subs=-attributes]
-++memory ++
+++ ++
 
 a| [subs=-attributes]
-The type of the userinfo cache store. Supported values are: 'memory', 'ocmem', 'etcd', 'redis', 'redis-sentinel', 'nats-js', 'noop'. See the text description for details.
+The type of the cache store. Supported values are: 'memory', 'ocmem', 'etcd', 'redis', 'redis-sentinel', 'nats-js', 'noop'. See the text description for details.
 
 a| `OCIS_CORS_ALLOW_CREDENTIALS`
 
@@ -928,7 +928,7 @@ a| [subs=-attributes]
 ++false ++
 
 a| [subs=-attributes]
-Whether the NATS server should skip the client certificate verification during the TLS handshake.
+Whether to verify the server TLS certificates.
 
 a| `OCIS_JWT_SECRET`
 
@@ -964,7 +964,7 @@ a| [subs=-attributes]
 ++ ++
 
 a| [subs=-attributes]
-The secret to mint and validate JWT tokens.
+The secret to mint and validate jwt tokens.
 
 a| `OCIS_LOG_COLOR`
 
@@ -1203,7 +1203,7 @@ a| [subs=-attributes]
 ++https://localhost:9200 ++
 
 a| [subs=-attributes]
-URL of the OIDC issuer. It defaults to URL of the builtin IDP.
+The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider.
 
 a| `OCIS_PERSISTENT_STORE`
 
@@ -1248,7 +1248,7 @@ a| [subs=-attributes]
 ++false ++
 
 a| [subs=-attributes]
-Set this to true if you want to enforce passwords on Uploader, Editor or Contributor shares. If not using the global OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD, you must define the FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD in the frontend service.
+Set this to true if you want to enforce passwords on Uploader, Editor or Contributor shares.
 
 a| `OCIS_SPACES_MAX_QUOTA`
 
@@ -1511,10 +1511,10 @@ a| [subs=-attributes]
 ++string ++
 
 a| [subs=-attributes]
-++https://localhost:9200 ++
+++https://127.0.0.1:9200 ++
 
 a| [subs=-attributes]
-URL of the OIDC issuer. It defaults to URL of the builtin IDP.
+URL, where oCIS is reachable for users.
 
 a| `REVA_GATEWAY`
 

diff --git a/services/antivirus/_index.md b/services/antivirus/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Antivirus Service
-date: 2023-03-28T13:28:45.955838239Z
+date: 2023-03-29T03:57:46.166382322Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/antivirus

diff --git a/services/audit/_index.md b/services/audit/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Audit service
-date: 2023-03-28T13:28:45.956115818Z
+date: 2023-03-29T03:57:46.166674894Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/audit

diff --git a/services/auth-basic/_index.md b/services/auth-basic/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Auth-Basic Service
-date: 2023-03-28T13:28:45.95630414Z
+date: 2023-03-29T03:57:46.166817713Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/auth-basic

diff --git a/services/auth-bearer/_index.md b/services/auth-bearer/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Auth-Bearer Service
-date: 2023-03-28T13:28:45.956492973Z
+date: 2023-03-29T03:57:46.167061212Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/auth-bearer

diff --git a/services/eventhistory/_index.md b/services/eventhistory/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Eventhistory Service
-date: 2023-03-28T13:28:45.956673271Z
+date: 2023-03-29T03:57:46.167343244Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/eventhistory

diff --git a/services/frontend/_index.md b/services/frontend/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Frontend Service
-date: 2023-03-28T13:28:45.956909583Z
+date: 2023-03-29T03:57:46.167471445Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/frontend

diff --git a/services/graph/_index.md b/services/graph/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Graph service
-date: 2023-03-28T13:28:45.957107935Z
+date: 2023-03-29T03:57:46.167594317Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/graph

diff --git a/services/idm/_index.md b/services/idm/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Idm
-date: 2023-03-28T13:28:45.957312889Z
+date: 2023-03-29T03:57:46.167703543Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/idm

diff --git a/services/idp/_index.md b/services/idp/_index.md
@@ -1,6 +1,6 @@
 ---
 title: IDP Service
-date: 2023-03-28T13:28:45.957462408Z
+date: 2023-03-29T03:57:46.167824431Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/idp

diff --git a/services/invitations/_index.md b/services/invitations/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Invitations Service
-date: 2023-03-28T13:28:45.957626886Z
+date: 2023-03-29T03:57:46.168038755Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/invitations

diff --git a/services/nats/_index.md b/services/nats/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Nats Service
-date: 2023-03-28T13:28:45.957956693Z
+date: 2023-03-29T03:57:46.168174201Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/nats

diff --git a/services/notifications/_index.md b/services/notifications/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Notification service
-date: 2023-03-28T13:28:45.9580937Z
+date: 2023-03-29T03:57:46.168421087Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/notifications

diff --git a/services/policies/_index.md b/services/policies/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Policies Service
-date: 2023-03-28T13:28:45.958242548Z
+date: 2023-03-29T03:57:46.168640711Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/policies

diff --git a/services/postprocessing/_index.md b/services/postprocessing/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Postprocessing Service
-date: 2023-03-28T13:28:45.958497606Z
+date: 2023-03-29T03:57:46.168818104Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/postprocessing

diff --git a/services/proxy/_index.md b/services/proxy/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Proxy Service
-date: 2023-03-28T13:28:45.95874544Z
+date: 2023-03-29T03:57:46.168983406Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/proxy

diff --git a/services/search/_index.md b/services/search/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Search Service
-date: 2023-03-28T13:28:45.959106626Z
+date: 2023-03-29T03:57:46.169227337Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/search

diff --git a/services/storage-system/_index.md b/services/storage-system/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Storage-System Service
-date: 2023-03-28T13:28:45.959330986Z
+date: 2023-03-29T03:57:46.169431011Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/storage-system

diff --git a/services/storage-users/_index.md b/services/storage-users/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Storage-Users Service
-date: 2023-03-28T13:28:45.959569322Z
+date: 2023-03-29T03:57:46.169611781Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/storage-users

diff --git a/services/thumbnails/_index.md b/services/thumbnails/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Thumbnails Service
-date: 2023-03-28T13:28:45.959744859Z
+date: 2023-03-29T03:57:46.169869217Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/thumbnails

diff --git a/services/userlog/_index.md b/services/userlog/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Userlog Service
-date: 2023-03-28T13:28:45.959923514Z
+date: 2023-03-29T03:57:46.170059165Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/userlog

diff --git a/services/web/_index.md b/services/web/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Web Service
-date: 2023-03-28T13:28:45.960095126Z
+date: 2023-03-29T03:57:46.170286734Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/web

diff --git a/services/webdav/_index.md b/services/webdav/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Webdav Service
-date: 2023-03-28T13:28:45.960318804Z
+date: 2023-03-29T03:57:46.170600184Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/webdav

diff --git a/services/webfinger/_index.md b/services/webfinger/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Webfinger Service
-date: 2023-03-28T13:28:45.960571067Z
+date: 2023-03-29T03:57:46.170792167Z
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/services/webfinger