diff --git a/services/_includes/adoc/global_configvars.adoc b/services/_includes/adoc/global_configvars.adoc index 9e951e4a988..47d11613973 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=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` @@ -163,7 +163,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 like 'groupOfNames'. a| `LDAP_GROUP_SCHEMA_DISPLAYNAME` @@ -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 like 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 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` @@ -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` @@ -385,7 +385,7 @@ a| [subs=-attributes] ++inetOrgPerson ++ a| [subs=-attributes] -The object class to use for users in the default user search filter ('inetOrgPerson'). +The object class to use for users in the default user search filter like 'inetOrgPerson'. a| `LDAP_USER_SCHEMA_DISPLAYNAME` @@ -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 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` @@ -483,7 +483,7 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ownCloudUserType ++ +++ ++ a| [subs=-attributes] LDAP Attribute to distinguish between 'Member' and 'Guest' users. Default is 'ownCloudUserType'. @@ -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` @@ -536,10 +536,10 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ ++ +++memory ++ a| [subs=-attributes] -The type of the cache store. Supported values are: 'memory', 'ocmem', 'etcd', 'redis', 'redis-sentinel', 'nats-js', 'noop'. See the text description for details. +Store implementation for the cache. Valid values are "memory" (default), "redis", and "etcd". a| `OCIS_CACHE_STORE_ADDRESS` @@ -571,7 +571,7 @@ a| [subs=-attributes] ++[] ++ a| [subs=-attributes] -A comma separated list of nodes to access the configured store. This has no effect when 'in-memory' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. +A comma-separated list of nodes to connect to. This has no effect when 'in-memory' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. a| `OCIS_CACHE_STORE_NODES` @@ -590,7 +590,7 @@ a| [subs=-attributes] ++[] ++ a| [subs=-attributes] -A comma separated list of nodes to access the configured store. This has no effect when 'in-memory' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. +Nodes to use for the cache store. a| `OCIS_CACHE_STORE_SIZE` @@ -619,13 +619,13 @@ a| [subs=attributes+] * xref:{s-path}/proxy.adoc[proxy] + a| [subs=-attributes] -++Duration ++ +++int ++ a| [subs=-attributes] -++0s ++ +++300 ++ a| [subs=-attributes] -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). +Max TTL in seconds for the gateway's stat cache. a| `OCIS_CACHE_STORE_TYPE` @@ -640,10 +640,10 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ ++ +++memory ++ a| [subs=-attributes] -The type of the cache store. Supported values are: 'memory', 'ocmem', 'etcd', 'redis', 'redis-sentinel', 'nats-js', 'noop'. See the text description for details. +Store implementation for the cache. Valid values are "memory" (default), "redis", and "etcd". a| `OCIS_CORS_ALLOW_CREDENTIALS` @@ -700,7 +700,7 @@ a| [subs=-attributes] ++[]string ++ a| [subs=-attributes] -++[GET POST PUT PATCH DELETE OPTIONS] ++ +++[GET] ++ a| [subs=-attributes] A comma-separated 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 @@ -928,7 +928,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Ignore untrusted SSL certificates when connecting to the webdav source. +Allow insecure connections to the GATEWAY service. a| `OCIS_JWT_SECRET` @@ -1183,7 +1183,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -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 for the access to resources from other services. a| `OCIS_OIDC_ISSUER` @@ -1204,7 +1204,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` @@ -1249,7 +1249,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` @@ -1264,7 +1264,7 @@ a| [subs=-attributes] ++0 ++ a| [subs=-attributes] -Set the global max quota value in bytes. A value of 0 equals unlimited. The value is provided via capabilities. +Set a global max quota for spaces in bytes. A value of 0 equals unlimited. If not using the global OCIS_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA in the frontend service. a| `OCIS_SYSTEM_USER_API_KEY` @@ -1302,7 +1302,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` @@ -1515,7 +1515,7 @@ a| [subs=-attributes] ++https://localhost:9200 ++ a| [subs=-attributes] -URL to load themes from. Will be prepended to the theme path. +URL where oCIS is reachable for users. a| `REVA_GATEWAY` diff --git a/services/antivirus/_index.md b/services/antivirus/_index.md index 366f955c399..9b81eee37ff 100644 --- a/services/antivirus/_index.md +++ b/services/antivirus/_index.md @@ -1,6 +1,6 @@ --- title: Antivirus Service -date: 2023-04-03T04:02:13.370557756Z +date: 2023-04-03T07:23:30.870241892Z 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 index a6ded3f1152..2b3e9131360 100644 --- a/services/audit/_index.md +++ b/services/audit/_index.md @@ -1,6 +1,6 @@ --- title: Audit service -date: 2023-04-03T04:02:13.370821351Z +date: 2023-04-03T07:23:30.870462185Z 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 index 5dd647add5c..3148eb7e2e2 100644 --- a/services/auth-basic/_index.md +++ b/services/auth-basic/_index.md @@ -1,6 +1,6 @@ --- title: Auth-Basic Service -date: 2023-04-03T04:02:13.371022779Z +date: 2023-04-03T07:23:30.870581579Z 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 index 4fe722a5154..d45a9e0a39a 100644 --- a/services/auth-bearer/_index.md +++ b/services/auth-bearer/_index.md @@ -1,6 +1,6 @@ --- title: Auth-Bearer Service -date: 2023-04-03T04:02:13.371174744Z +date: 2023-04-03T07:23:30.870697508Z 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 index 322f524a318..cf17a9d71e7 100644 --- a/services/eventhistory/_index.md +++ b/services/eventhistory/_index.md @@ -1,6 +1,6 @@ --- title: Eventhistory Service -date: 2023-04-03T04:02:13.371304707Z +date: 2023-04-03T07:23:30.870814588Z 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 index 5399920dedf..99a7929322b 100644 --- a/services/frontend/_index.md +++ b/services/frontend/_index.md @@ -1,6 +1,6 @@ --- title: Frontend Service -date: 2023-04-03T04:02:13.371453416Z +date: 2023-04-03T07:23:30.870948439Z 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 index 827123af3ab..c0dc6f1c7c8 100644 --- a/services/graph/_index.md +++ b/services/graph/_index.md @@ -1,6 +1,6 @@ --- title: Graph service -date: 2023-04-03T04:02:13.371590273Z +date: 2023-04-03T07:23:30.871104Z 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 index 8647a7a0d81..824fdc64545 100644 --- a/services/idm/_index.md +++ b/services/idm/_index.md @@ -1,6 +1,6 @@ --- title: Idm -date: 2023-04-03T04:02:13.371707113Z +date: 2023-04-03T07:23:30.871228113Z 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 index 360d900367c..2f117cf28d2 100644 --- a/services/idp/_index.md +++ b/services/idp/_index.md @@ -1,6 +1,6 @@ --- title: IDP Service -date: 2023-04-03T04:02:13.371815375Z +date: 2023-04-03T07:23:30.87132739Z 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 index 7a3d3f42cfb..d92280e569a 100644 --- a/services/invitations/_index.md +++ b/services/invitations/_index.md @@ -1,6 +1,6 @@ --- title: Invitations Service -date: 2023-04-03T04:02:13.371960357Z +date: 2023-04-03T07:23:30.871432888Z 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 index 532b67a0c8b..191733165dd 100644 --- a/services/nats/_index.md +++ b/services/nats/_index.md @@ -1,6 +1,6 @@ --- title: Nats Service -date: 2023-04-03T04:02:13.372117253Z +date: 2023-04-03T07:23:30.871553584Z 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 index 4190d44f51c..d7c1f69f7b8 100644 --- a/services/notifications/_index.md +++ b/services/notifications/_index.md @@ -1,6 +1,6 @@ --- title: Notification service -date: 2023-04-03T04:02:13.372280729Z +date: 2023-04-03T07:23:30.871686013Z 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 index eac85cc12d1..1351b05a33d 100644 --- a/services/policies/_index.md +++ b/services/policies/_index.md @@ -1,6 +1,6 @@ --- title: Policies Service -date: 2023-04-03T04:02:13.372656314Z +date: 2023-04-03T07:23:30.871825445Z 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 index 9467db0a909..a4c025beb13 100644 --- a/services/postprocessing/_index.md +++ b/services/postprocessing/_index.md @@ -1,6 +1,6 @@ --- title: Postprocessing Service -date: 2023-04-03T04:02:13.373004817Z +date: 2023-04-03T07:23:30.872041891Z 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 index 6759ec16497..170b23259b7 100644 --- a/services/proxy/_index.md +++ b/services/proxy/_index.md @@ -1,6 +1,6 @@ --- title: Proxy Service -date: 2023-04-03T04:02:13.373550472Z +date: 2023-04-03T07:23:30.872258267Z 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 index de5e590e3db..d207121f10d 100644 --- a/services/search/_index.md +++ b/services/search/_index.md @@ -1,6 +1,6 @@ --- title: Search Service -date: 2023-04-03T04:02:13.373770324Z +date: 2023-04-03T07:23:30.872423357Z 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 index 96dc8335763..50a9f7ec018 100644 --- a/services/storage-system/_index.md +++ b/services/storage-system/_index.md @@ -1,6 +1,6 @@ --- title: Storage-System Service -date: 2023-04-03T04:02:13.373984375Z +date: 2023-04-03T07:23:30.872605097Z 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 index ffc377fc1cf..9ed9dd4b7fa 100644 --- a/services/storage-users/_index.md +++ b/services/storage-users/_index.md @@ -1,6 +1,6 @@ --- title: Storage-Users Service -date: 2023-04-03T04:02:13.374171947Z +date: 2023-04-03T07:23:30.872730153Z 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 index 97b910ad8e6..7c26c6f6ed6 100644 --- a/services/thumbnails/_index.md +++ b/services/thumbnails/_index.md @@ -1,6 +1,6 @@ --- title: Thumbnails Service -date: 2023-04-03T04:02:13.374340313Z +date: 2023-04-03T07:23:30.872878031Z 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 index 2f8f64bcaa5..823b3c26578 100644 --- a/services/userlog/_index.md +++ b/services/userlog/_index.md @@ -1,6 +1,6 @@ --- title: Userlog Service -date: 2023-04-03T04:02:13.37450373Z +date: 2023-04-03T07:23:30.873051426Z 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 index e0521093e16..7cb16b2f907 100644 --- a/services/web/_index.md +++ b/services/web/_index.md @@ -1,6 +1,6 @@ --- title: Web Service -date: 2023-04-03T04:02:13.374663099Z +date: 2023-04-03T07:23:30.873190366Z 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 index bb894a0faa5..73f1bcc4cd5 100644 --- a/services/webdav/_index.md +++ b/services/webdav/_index.md @@ -1,6 +1,6 @@ --- title: Webdav Service -date: 2023-04-03T04:02:13.374816326Z +date: 2023-04-03T07:23:30.873323156Z 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 index 9fb44d0b1b2..01ef1294fee 100644 --- a/services/webfinger/_index.md +++ b/services/webfinger/_index.md @@ -1,6 +1,6 @@ --- title: Webfinger Service -date: 2023-04-03T04:02:13.375037872Z +date: 2023-04-03T07:23:30.873452248Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/webfinger