deps: docs: tidy (#1311)

cs3org · Nov 10, 2020 · 18dfdf4 · 18dfdf4
1 parent fdfeb2c
commit 18dfdf4
Show file tree

Hide file tree

Showing 7 changed files with 135 additions and 21 deletions.
diff --git a/docs/content/en/docs/config/grpc/services/appprovider/_index.md b/docs/content/en/docs/config/grpc/services/appprovider/_index.md
@@ -9,23 +9,23 @@ description: >
 # _struct: config_
 
 {{% dir name="iopsecret" type="string" default="" %}}
-The iopsecret used to connect to the wopiserver. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/appprovider/appprovider.go#L58)
+The iopsecret used to connect to the wopiserver. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/appprovider/appprovider.go#L59)
 {{< highlight toml >}}
 [grpc.services.appprovider]
 iopsecret = ""
 {{< /highlight >}}
 {{% /dir %}}
 
 {{% dir name="wopiurl" type="string" default="" %}}
-The wopiserver's URL. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/appprovider/appprovider.go#L59)
+The wopiserver's URL. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/appprovider/appprovider.go#L60)
 {{< highlight toml >}}
 [grpc.services.appprovider]
 wopiurl = ""
 {{< /highlight >}}
 {{% /dir %}}
 
 {{% dir name="wopibridgeurl" type="string" default="" %}}
-The wopibridge's URL. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/appprovider/appprovider.go#L60)
+The wopibridge's URL. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/appprovider/appprovider.go#L61)
 {{< highlight toml >}}
 [grpc.services.appprovider]
 wopibridgeurl = ""

diff --git a/docs/content/en/docs/config/grpc/services/storageprovider/_index.md b/docs/content/en/docs/config/grpc/services/storageprovider/_index.md
@@ -67,24 +67,16 @@ expose_data_server = false
 {{< /highlight >}}
 {{% /dir %}}
 
-{{% dir name="disable_tus" type="bool" default=false %}}
-Whether to disable TUS uploads. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L60)
-{{< highlight toml >}}
-[grpc.services.storageprovider]
-disable_tus = false
-{{< /highlight >}}
-{{% /dir %}}
-
 {{% dir name="available_checksums" type="map[string]uint32" default=nil %}}
-List of available checksums. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L61)
+List of available checksums. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L60)
 {{< highlight toml >}}
 [grpc.services.storageprovider]
 available_checksums = nil
 {{< /highlight >}}
 {{% /dir %}}
 
 {{% dir name="mimetypes" type="map[string]string" default=nil %}}
-List of supported mime types and corresponding file extensions. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L62)
+List of supported mime types and corresponding file extensions. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/storageprovider/storageprovider.go#L61)
 {{< highlight toml >}}
 [grpc.services.storageprovider]
 mimetypes = nil

diff --git a/docs/content/en/docs/config/http/services/dataprovider/_index.md b/docs/content/en/docs/config/http/services/dataprovider/_index.md
@@ -35,11 +35,3 @@ user_layout = "{{.Username}}"
 {{< /highlight >}}
 {{% /dir %}}
 
-{{% dir name="disable_tus" type="bool" default=false %}}
-Whether to disable TUS uploads. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/dataprovider/dataprovider.go#L44)
-{{< highlight toml >}}
-[http.services.dataprovider]
-disable_tus = false
-{{< /highlight >}}
-{{% /dir %}}
-
diff --git a/docs/content/en/docs/config/packages/cbox/_index.md b/docs/content/en/docs/config/packages/cbox/_index.md
@@ -0,0 +1,7 @@
+---
+title: "cbox"
+linkTitle: "cbox"
+weight: 10
+description: >
+  Configuration for the cbox service
+---
diff --git a/docs/content/en/docs/config/packages/cbox/user/_index.md b/docs/content/en/docs/config/packages/cbox/user/_index.md
@@ -0,0 +1,7 @@
+---
+title: "user"
+linkTitle: "user"
+weight: 10
+description: >
+  Configuration for the user service
+---
diff --git a/docs/content/en/docs/config/packages/cbox/user/rest/_index.md b/docs/content/en/docs/config/packages/cbox/user/rest/_index.md
@@ -0,0 +1,74 @@
+---
+title: "rest"
+linkTitle: "rest"
+weight: 10
+description: >
+  Configuration for the rest service
+---
+
+# _struct: config_
+
+{{% dir name="redis_address" type="string" default="localhost:6379" %}}
+The address at which the redis server is running [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/cbox/user/rest/rest.go#L69)
+{{< highlight toml >}}
+[cbox.user.rest]
+redis_address = "localhost:6379"
+{{< /highlight >}}
+{{% /dir %}}
+
+{{% dir name="user_groups_cache_expiration" type="int" default=5 %}}
+The time in minutes for which the groups to which a user belongs would be cached [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/cbox/user/rest/rest.go#L75)
+{{< highlight toml >}}
+[cbox.user.rest]
+user_groups_cache_expiration = 5
+{{< /highlight >}}
+{{% /dir %}}
+
+{{% dir name="id_provider" type="string" default="http://cernbox.cern.ch" %}}
+The OIDC Provider [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/cbox/user/rest/rest.go#L77)
+{{< highlight toml >}}
+[cbox.user.rest]
+id_provider = "http://cernbox.cern.ch"
+{{< /highlight >}}
+{{% /dir %}}
+
+{{% dir name="api_base_url" type="string" default="https://authorization-service-api-dev.web.cern.ch/api/v1.0" %}}
+Base API Endpoint [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/cbox/user/rest/rest.go#L79)
+{{< highlight toml >}}
+[cbox.user.rest]
+api_base_url = "https://authorization-service-api-dev.web.cern.ch/api/v1.0"
+{{< /highlight >}}
+{{% /dir %}}
+
+{{% dir name="client_id" type="string" default="-" %}}
+Client ID needed to authenticate [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/cbox/user/rest/rest.go#L81)
+{{< highlight toml >}}
+[cbox.user.rest]
+client_id = "-"
+{{< /highlight >}}
+{{% /dir %}}
+
+{{% dir name="client_secret" type="string" default="-" %}}
+Client Secret [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/cbox/user/rest/rest.go#L83)
+{{< highlight toml >}}
+[cbox.user.rest]
+client_secret = "-"
+{{< /highlight >}}
+{{% /dir %}}
+
+{{% dir name="oidc_token_endpoint" type="string" default="https://keycloak-dev.cern.ch/auth/realms/cern/api-access/token" %}}
+Endpoint to generate token to access the API [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/cbox/user/rest/rest.go#L86)
+{{< highlight toml >}}
+[cbox.user.rest]
+oidc_token_endpoint = "https://keycloak-dev.cern.ch/auth/realms/cern/api-access/token"
+{{< /highlight >}}
+{{% /dir %}}
+
+{{% dir name="target_api" type="string" default="authorization-service-api" %}}
+The target application for which token needs to be generated [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/cbox/user/rest/rest.go#L88)
+{{< highlight toml >}}
+[cbox.user.rest]
+target_api = "authorization-service-api"
+{{< /highlight >}}
+{{% /dir %}}
+