Skip to content

Commit

Permalink
Merge pull request #6021 from owncloud/mmattel-patch-2
Browse files Browse the repository at this point in the history
[docs-only] Update new-service-checklist.md
  • Loading branch information
mmattel committed Apr 6, 2023
1 parent f476bf2 commit c8243a1
Show file tree
Hide file tree
Showing 26 changed files with 64 additions and 65 deletions.
76 changes: 38 additions & 38 deletions services/_includes/adoc/global_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down Expand Up @@ -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`

Expand All @@ -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`

Expand Down Expand Up @@ -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`

Expand Down Expand Up @@ -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`

Expand Down Expand Up @@ -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'.
Expand Down Expand Up @@ -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_ASYNC_UPLOADS`

Expand Down Expand Up @@ -554,7 +554,7 @@ 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. Supported values are 'memory' (default), 'redis', and 'etcd'.

a| `OCIS_CACHE_STORE_ADDRESS`

Expand All @@ -570,7 +570,7 @@ a| [subs=-attributes]
++[] ++

a| [subs=-attributes]
A comma separated list of nodes to access the configured store. This has no effect when the 'memory' store is 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_ADDRESSES`

Expand All @@ -586,7 +586,7 @@ a| [subs=-attributes]
++[] ++

a| [subs=-attributes]
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 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| `OCIS_CACHE_STORE_NODES`

Expand All @@ -605,7 +605,7 @@ a| [subs=-attributes]
++[] ++

a| [subs=-attributes]
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.
Nodes to use for the cache store.

a| `OCIS_CACHE_STORE_SIZE`

Expand Down Expand Up @@ -634,13 +634,13 @@ a| [subs=attributes+]
* xref:{s-path}/proxy.adoc[proxy] +

a| [subs=-attributes]
++Duration ++
++int ++

a| [subs=-attributes]
++336h0m0s ++
++300 ++

a| [subs=-attributes]
Time to live for cache records in the graph. 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`

Expand All @@ -658,7 +658,7 @@ 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. Supported values are 'memory' (default), 'redis', and 'etcd'.

a| `OCIS_CORS_ALLOW_CREDENTIALS`

Expand All @@ -677,7 +677,7 @@ a| [subs=-attributes]
++bool ++

a| [subs=-attributes]
++true ++
++false ++

a| [subs=-attributes]
Allow credentials for CORS.See following chapter for more details: *Access-Control-Allow-Credentials* at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.
Expand All @@ -699,7 +699,7 @@ a| [subs=-attributes]
++[]string ++

a| [subs=-attributes]
++[Authorization Origin Content-Type Accept X-Requested-With Purge Restore] ++
++[] ++

a| [subs=-attributes]
A comma-separated 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.
Expand All @@ -721,7 +721,7 @@ a| [subs=-attributes]
++[]string ++

a| [subs=-attributes]
++[GET POST PUT PATCH DELETE OPTIONS] ++
++[] ++

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
Expand Down Expand Up @@ -999,7 +999,7 @@ a| [subs=-attributes]
++false ++

a| [subs=-attributes]
Whether to verify the server TLS certificates.
Whether the server should skip the client certificate verification during the TLS handshake.

a| `OCIS_JWT_SECRET`

Expand Down Expand Up @@ -1100,10 +1100,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| `OCIS_LDAP_GROUP_BASE_DN`

Expand Down Expand Up @@ -1201,10 +1201,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| `OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING`

Expand All @@ -1220,7 +1220,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| `OCIS_LDAP_GROUP_SCHEMA_MAIL`

Expand Down Expand Up @@ -1269,7 +1269,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| `OCIS_LDAP_INSECURE`

Expand Down Expand Up @@ -1426,7 +1426,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| `OCIS_LDAP_USER_SCHEMA_MAIL`

Expand Down Expand Up @@ -1474,7 +1474,7 @@ a| [subs=-attributes]
++string ++

a| [subs=-attributes]
++ownCloudUserType ++
++ ++

a| [subs=-attributes]
LDAP Attribute to distinguish between 'Member' and 'Guest' users. Default is 'ownCloudUserType'.
Expand Down Expand Up @@ -1732,10 +1732,10 @@ a| [subs=-attributes]
++string ++

a| [subs=-attributes]
++https://localhost:9200 ++
++ ++

a| [subs=-attributes]
The OIDC issuer URL to use.
The identity provider href for the openid-discovery relation.

a| `OCIS_PERSISTENT_STORE`

Expand All @@ -1750,7 +1750,7 @@ a| [subs=-attributes]
++memory ++

a| [subs=-attributes]
The type of the userlog store. Supported values are: 'memory', 'ocmem', 'etcd', 'redis', 'redis-sentinel', 'nats-js', 'noop'. See the text description for details.
The type of the eventhistory store. Supported values are: 'memory', 'ocmem', 'etcd', 'redis', 'redis-sentinel', 'nats-js', 'noop'. See the text description for details.

a| `OCIS_PERSISTENT_STORE_NODES`

Expand Down Expand Up @@ -1817,7 +1817,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`

Expand All @@ -1832,7 +1832,7 @@ a| [subs=-attributes]
++0 ++

a| [subs=-attributes]
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.
Set the global max quota value in bytes. A value of 0 equals unlimited. The value is provided via capabilities.

a| `OCIS_SYSTEM_USER_API_KEY`

Expand Down Expand Up @@ -2067,7 +2067,7 @@ a| [subs=-attributes]
++ ++

a| [subs=-attributes]
Transfer secret for signing file up- and download requests.
The storage transfer secret.

a| `OCIS_URL`

Expand Down Expand Up @@ -2095,10 +2095,10 @@ a| [subs=-attributes]
++string ++

a| [subs=-attributes]
++https://localhost:9200 ++
++ ++

a| [subs=-attributes]
The OIDC issuer URL to use.
The identity provider href for the openid-discovery relation.

a| `REVA_GATEWAY`

Expand Down Expand Up @@ -2150,7 +2150,7 @@ a| [subs=-attributes]
++ ++

a| [subs=-attributes]
Transfer secret for signing file up- and download requests.
The storage transfer secret.

a| `STORAGE_USERS_OCIS_ASYNC_UPLOADS`

Expand Down
2 changes: 1 addition & 1 deletion services/antivirus/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Antivirus Service
date: 2023-04-06T09:53:04.889570283Z
date: 2023-04-06T09:52:41.788609525Z
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/antivirus
Expand Down
2 changes: 1 addition & 1 deletion services/audit/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Audit service
date: 2023-04-06T09:53:04.88991647Z
date: 2023-04-06T09:52:41.788786106Z
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/audit
Expand Down
2 changes: 1 addition & 1 deletion services/auth-basic/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Auth-Basic Service
date: 2023-04-06T09:53:04.890142633Z
date: 2023-04-06T09:52:41.788879882Z
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/auth-basic
Expand Down
2 changes: 1 addition & 1 deletion services/auth-bearer/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Auth-Bearer Service
date: 2023-04-06T09:53:04.890361723Z
date: 2023-04-06T09:52:41.788986472Z
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/auth-bearer
Expand Down
2 changes: 1 addition & 1 deletion services/eventhistory/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Eventhistory Service
date: 2023-04-06T09:53:04.890671152Z
date: 2023-04-06T09:52:41.789069528Z
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/eventhistory
Expand Down
2 changes: 1 addition & 1 deletion services/frontend/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Frontend Service
date: 2023-04-06T09:53:04.890916481Z
date: 2023-04-06T09:52:41.789161661Z
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/frontend
Expand Down
2 changes: 1 addition & 1 deletion services/gateway/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Gateway Service
date: 2023-04-06T09:53:04.89115695Z
date: 2023-04-06T09:52:41.789303697Z
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/gateway
Expand Down
5 changes: 2 additions & 3 deletions services/graph/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Graph service
date: 2023-04-06T09:53:04.891353518Z
date: 2023-04-06T09:52:41.789425215Z
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/graph
Expand All @@ -27,8 +27,7 @@ Using the API, you can manually filter like for users. See the [Libre Graph API]

The following image gives an overview of the scenario when a client requests to list available spaces the user has access to. To do so, the client is directed with his request automatically via the proxy service to the graph service.
<!-- referencing: https://github.com/owncloud/ocis/pull/3816 ([docs-only] add client protocol overview) -->
<!-- The image source needs to be the raw source !! -->
<img src="https://raw.githubusercontent.com/owncloud/ocis/master/services/graph/images/mermaid-graph.svg" width="500" />
<img src="https://github.com/owncloud/ocis/blob/master/services/graph/images/mermaid-graph.svg" width="500" />

## Caching

Expand Down
2 changes: 1 addition & 1 deletion services/idm/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Idm
date: 2023-04-06T09:53:04.891576114Z
date: 2023-04-06T09:52:41.789511397Z
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/idm
Expand Down
2 changes: 1 addition & 1 deletion services/idp/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: IDP Service
date: 2023-04-06T09:53:04.891741164Z
date: 2023-04-06T09:52:41.789604171Z
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/idp
Expand Down
2 changes: 1 addition & 1 deletion services/invitations/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Invitations Service
date: 2023-04-06T09:53:04.891886465Z
date: 2023-04-06T09:52:41.789706002Z
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/invitations
Expand Down
Loading

0 comments on commit c8243a1

Please sign in to comment.