commit 8a77ae8

Merge: ee0b466 4fe5703 Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com> Date: Wed Jun 29 10:41:06 2022 +0200 Merge pull request #3973 from wkloucek/config-doc-descriptions add more config doc descriptions
owncloud · Jun 29, 2022 · 5d61dcb · 5d61dcb
1 parent 225ea63
commit 5d61dcb
Show file tree

Hide file tree

Showing 77 changed files with 367 additions and 359 deletions.
diff --git a/grpc_apis/ocis/messages/search/v0/grpc.md b/grpc_apis/ocis/messages/search/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.search.v0"
 url: /grpc_apis/ocis_messages_search_v0
-date: 2022-06-29T00:11:36Z
+date: 2022-06-29T08:42:22Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/messages/settings/v0/grpc.md b/grpc_apis/ocis/messages/settings/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.settings.v0"
 url: /grpc_apis/ocis_messages_settings_v0
-date: 2022-06-29T00:11:36Z
+date: 2022-06-29T08:42:22Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/messages/store/v0/grpc.md b/grpc_apis/ocis/messages/store/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.store.v0"
 url: /grpc_apis/ocis_messages_store_v0
-date: 2022-06-29T00:11:37Z
+date: 2022-06-29T08:42:22Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/messages/thumbnails/v0/grpc.md b/grpc_apis/ocis/messages/thumbnails/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.thumbnails.v0"
 url: /grpc_apis/ocis_messages_thumbnails_v0
-date: 2022-06-29T00:11:37Z
+date: 2022-06-29T08:42:22Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/services/search/v0/grpc.md b/grpc_apis/ocis/services/search/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.search.v0"
 url: /grpc_apis/ocis_services_search_v0
-date: 2022-06-29T00:11:37Z
+date: 2022-06-29T08:42:22Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/services/settings/v0/grpc.md b/grpc_apis/ocis/services/settings/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.settings.v0"
 url: /grpc_apis/ocis_services_settings_v0
-date: 2022-06-29T00:11:37Z
+date: 2022-06-29T08:42:22Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/services/store/v0/grpc.md b/grpc_apis/ocis/services/store/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.store.v0"
 url: /grpc_apis/ocis_services_store_v0
-date: 2022-06-29T00:11:37Z
+date: 2022-06-29T08:42:22Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/grpc_apis/ocis/services/thumbnails/v0/grpc.md b/grpc_apis/ocis/services/thumbnails/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.thumbnails.v0"
 url: /grpc_apis/ocis_services_thumbnails_v0
-date: 2022-06-29T00:11:37Z
+date: 2022-06-29T08:42:22Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/services/_includes/adoc/app-provider_configvars.adoc b/services/_includes/adoc/app-provider_configvars.adoc
@@ -104,7 +104,7 @@ Enables zpages, which can be used for collecting and viewing traces in-memory.
 a| [subs=-attributes]
 127.0.0.1:9164 
 a| [subs=-attributes]
-The address of the grpc service.
+The bind address of the GRPC service.
 
 |`APP_PROVIDER_GRPC_PROTOCOL`
 | string

diff --git a/services/_includes/adoc/app-registry_configvars.adoc b/services/_includes/adoc/app-registry_configvars.adoc
@@ -104,7 +104,7 @@ Enables zpages, which can be used for collecting and viewing in-memory traces.
 a| [subs=-attributes]
 127.0.0.1:9242 
 a| [subs=-attributes]
-The address of the grpc service.
+The bind address of the GRPC service.
 
 |`APP_REGISTRY_GRPC_PROTOCOL`
 | string

diff --git a/services/_includes/adoc/auth-basic_configvars.adoc b/services/_includes/adoc/auth-basic_configvars.adoc
@@ -104,7 +104,7 @@ Enables zpages, which can be used for collecting and viewing traces in-memory.
 a| [subs=-attributes]
 127.0.0.1:9146 
 a| [subs=-attributes]
-The address of the grpc service.
+The bind address of the GRPC service.
 
 |`AUTH_BASIC_GRPC_PROTOCOL`
 | string
@@ -133,7 +133,7 @@ The CS3 gateway endpoint.
 a| [subs=-attributes]
 false 
 a| [subs=-attributes]
-Disables the encoding of the user's groupmember ships in the reva access token. To reduces token size, especially when users are members of a large number of groups.
+Disables the encoding of the user's group memberships in the reva access token. This reduces the token size, especially when users are members of a large number of groups.
 
 |`AUTH_BASIC_AUTH_PROVIDER`
 | string

diff --git a/services/_includes/adoc/auth-bearer_configvars.adoc b/services/_includes/adoc/auth-bearer_configvars.adoc
@@ -104,7 +104,7 @@ Enables zpages, which can be used for collecting and viewing in-memory traces.
 a| [subs=-attributes]
 127.0.0.1:9148 
 a| [subs=-attributes]
-The address of the grpc service.
+The bind address of the GRPC service.
 
 |`AUTH_BEARER_GRPC_PROTOCOL`
 | string
@@ -133,7 +133,7 @@ The CS3 gateway endpoint.
 a| [subs=-attributes]
 false 
 a| [subs=-attributes]
-Skip storing all groups of a user in the jwt token.
+Disables the encoding of the user's group memberships in the reva access token. This reduces the token size, especially when users are members of a large number of groups.
 
 |`OCIS_URL` +
 `OCIS_OIDC_ISSUER` +

diff --git a/services/_includes/adoc/auth-machine_configvars.adoc b/services/_includes/adoc/auth-machine_configvars.adoc
@@ -104,7 +104,7 @@ Enables zpages, which can be used for collecting and viewing in-memory traces.
 a| [subs=-attributes]
 127.0.0.1:9166 
 a| [subs=-attributes]
-The address of the grpc service.
+The bind address of the GRPC service.
 
 |`AUTH_MACHINE_GRPC_PROTOCOL`
 | string
@@ -133,7 +133,7 @@ The CS3 gateway endpoint.
 a| [subs=-attributes]
 false 
 a| [subs=-attributes]
-Skip storing all groups of a user in the jwt token.
+Disables the encoding of the user's group memberships in the reva access token. This reduces the token size, especially when users are members of a large number of groups.
 
 |`OCIS_MACHINE_AUTH_API_KEY` +
 `AUTH_MACHINE_API_KEY`

diff --git a/services/_includes/adoc/frontend_configvars.adoc b/services/_includes/adoc/frontend_configvars.adoc
@@ -104,7 +104,7 @@ Enables zpages, which can be used for collecting and viewing in-memory traces.
 a| [subs=-attributes]
 127.0.0.1:9140 
 a| [subs=-attributes]
-The address of the http service.
+The bind address of the HTTP service.
 
 |`FRONTEND_HTTP_PROTOCOL`
 | string
@@ -125,7 +125,7 @@ The Path prefix where the frontend can be accessed (defaults to /).
 a| [subs=-attributes]
 
 a| [subs=-attributes]
-
+Transfer secret for signing file up- and download requests.
 
 |`OCIS_JWT_SECRET` +
 `FRONTEND_JWT_SECRET`
@@ -148,14 +148,14 @@ The CS3 gateway endpoint.
 a| [subs=-attributes]
 
 a| [subs=-attributes]
-Machine auth API key used for accessing the 'auth-machine' service.
+Machine auth API key used for accessing the 'auth-machine' service to impersonate users.
 
 |`FRONTEND_SKIP_USER_GROUPS_IN_TOKEN`
 | bool
 a| [subs=-attributes]
 false 
 a| [subs=-attributes]
-Disables the encoding of the user's group memberships in the reva access token. This reduces token size, especially when users are members of a large number of groups.
+Disables the loading of user's group memberships from the reva access token.
 
 |`FRONTEND_ENABLE_FAVORITES`
 | bool

diff --git a/services/_includes/adoc/gateway_configvars.adoc b/services/_includes/adoc/gateway_configvars.adoc
@@ -104,7 +104,7 @@ Enables zpages, which can be used for collecting and viewing in-memory traces.
 a| [subs=-attributes]
 127.0.0.1:9142 
 a| [subs=-attributes]
-The address of the grpc service.
+The bind address of the GRPC service.
 
 |`GATEWAY_GRPC_PROTOCOL`
 | string
@@ -133,35 +133,28 @@ The CS3 gateway endpoint.
 a| [subs=-attributes]
 false 
 a| [subs=-attributes]
-Disables the encoding of the user's groupmember ships in the reva access token. To reduces token size, especially when users are members of a large number of groups.
+Disables the loading of user's group memberships from the reva access token.
 
 |`GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT`
 | bool
 a| [subs=-attributes]
 true 
 a| [subs=-attributes]
-Commit shares to storage grants (default: true).
-
-|`GATEWAY_COMMIT_SHARE_TO_STORAGE_REF`
-| bool
-a| [subs=-attributes]
-true 
-a| [subs=-attributes]
-Commit shares to storage (default: true)
+Commit shares to storage grants. This grants access to shared resources for the share receiver directly on the storage.
 
 |`GATEWAY_SHARE_FOLDER_NAME`
 | string
 a| [subs=-attributes]
 Shares 
 a| [subs=-attributes]
-Name of the gateway share folder
+Name of the share folder in users' home space.
 
 |`GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN`
 | bool
 a| [subs=-attributes]
 true 
 a| [subs=-attributes]
-Disable creation of the homespace on login
+Disable creation of the home space on login.
 
 |`STORAGE_TRANSFER_SECRET`
 | string
@@ -182,7 +175,7 @@ Expiry for the gateway tokens
 a| [subs=-attributes]
 0 
 a| [subs=-attributes]
-Max TTL for the gatways ETAG cache.
+Max TTL in seconds for the gateway's ETAG cache.
 
 |`OCIS_URL` +
 `GATEWAY_FRONTEND_PUBLIC_URL`

diff --git a/services/_includes/adoc/graph-explorer_configvars.adoc b/services/_includes/adoc/graph-explorer_configvars.adoc
@@ -104,14 +104,14 @@ Enables zpages, which can be used for collecting and viewing in-memory traces.
 a| [subs=-attributes]
 127.0.0.1:9135 
 a| [subs=-attributes]
-The HTTP service address.
+The bind address of the HTTP service.
 
 |`GRAPH_EXPLORER_HTTP_ROOT`
 | string
 a| [subs=-attributes]
 /graph-explorer 
 a| [subs=-attributes]
-The HTTP service root path.
+Subdirectory that serves as the root for this HTTP service.
 
 |`GRAPH_EXPLORER_CLIENT_ID`
 | string

diff --git a/services/_includes/adoc/graph_configvars.adoc b/services/_includes/adoc/graph_configvars.adoc
@@ -104,14 +104,14 @@ Enables zpages, which can be used for collecting and viewing in-memory traces.
 a| [subs=-attributes]
 127.0.0.1:9120 
 a| [subs=-attributes]
-
+The bind address of the HTTP service.
 
 |`GRAPH_HTTP_ROOT`
 | string
 a| [subs=-attributes]
 /graph 
 a| [subs=-attributes]
-
+Subdirectory that serves as the root for this HTTP service.
 
 |`REVA_GATEWAY`
 | string

diff --git a/services/_includes/adoc/groups_configvars.adoc b/services/_includes/adoc/groups_configvars.adoc
@@ -104,7 +104,7 @@ Enables zpages, which can be used for collecting and viewing in-memory traces.
 a| [subs=-attributes]
 127.0.0.1:9160 
 a| [subs=-attributes]
-The address of the grpc service.
+The bind address of the GRPC service.
 
 |`GROUPS_GRPC_PROTOCOL`
 | string
@@ -133,7 +133,7 @@ The CS3 gateway endpoint.
 a| [subs=-attributes]
 false 
 a| [subs=-attributes]
-Disables the encoding of the user's groupmember ships in the reva access token. To reduces token size, especially when users are members of a large number of groups.
+Disables the loading of user's group memberships from the reva access token.
 
 |`LDAP_URI` +
 `GROUPS_LDAP_URI`

diff --git a/services/_includes/adoc/idp_configvars.adoc b/services/_includes/adoc/idp_configvars.adoc
@@ -111,14 +111,14 @@ Enables zpages, which can be used for collecting and viewing in-memory traces.
 a| [subs=-attributes]
 127.0.0.1:9130 
 a| [subs=-attributes]
-
+The bind address of the HTTP service.
 
 |`IDP_HTTP_ROOT`
 | string
 a| [subs=-attributes]
 / 
 a| [subs=-attributes]
-
+Subdirectory that serves as the root for this HTTP service.
 
 |`IDP_TRANSPORT_TLS_CERT`
 | string
@@ -161,7 +161,7 @@ Machine auth API key used for accessing the 'auth-machine' service to impersonat
 a| [subs=-attributes]
 
 a| [subs=-attributes]
-Defines the path for the IDP assets.
+Serve IDP assets from a path on the filesystem instead of the builtin assets.
 
 |`OCIS_URL` +
 `OCIS_OIDC_ISSUER` +

diff --git a/services/_includes/adoc/ocdav_configvars.adoc b/services/_includes/adoc/ocdav_configvars.adoc
@@ -104,7 +104,7 @@ Enables zpages, which can be used for collecting and viewing in-memory traces.
 a| [subs=-attributes]
 127.0.0.1:0 
 a| [subs=-attributes]
-The address of the http service.
+The bind address of the HTTP service.
 
 |`OCDAV_HTTP_PROTOCOL`
 | string
@@ -140,7 +140,7 @@ The CS3 gateway endpoint.
 a| [subs=-attributes]
 false 
 a| [subs=-attributes]
-Disables the encoding of the user's group memberships in the reva access token. This reduces token size, especially when users are members of a large number of groups.
+Disables the loading of user's group memberships from the reva access token.
 
 |`OCDAV_WEBDAV_NAMESPACE`
 | string
@@ -169,7 +169,7 @@ The human readable path for the share jail. Relative to a users personal space r
 a| [subs=-attributes]
 \https://localhost:9200 
 a| [subs=-attributes]
-
+URL, where oCIS is reachable for users.
 
 |`OCIS_INSECURE` +
 `OCDAV_INSECURE`
@@ -184,7 +184,7 @@ a| [subs=-attributes]
 a| [subs=-attributes]
 84300 
 a| [subs=-attributes]
-
+Request timeout in seconds for requests from the oCDAV service to the gateway service.
 |===
 
 Since Version: `+` added, `-` deprecated
diff --git a/services/_includes/adoc/ocs_configvars.adoc b/services/_includes/adoc/ocs_configvars.adoc
@@ -104,14 +104,14 @@ Enables zpages, which can be used for collecting and viewing in-memory traces.
 a| [subs=-attributes]
 127.0.0.1:9110 
 a| [subs=-attributes]
-
+The bind address of the HTTP service.
 
 |`OCS_HTTP_ROOT`
 | string
 a| [subs=-attributes]
 /ocs 
 a| [subs=-attributes]
-
+Subdirectory that serves as the root for this HTTP service.
 
 |`OCIS_JWT_SECRET` +
 `OCS_JWT_SECRET`