Skip to content

Commit 38c02f8

Browse files
committed
[docs-only] Regenerated docs
1 parent cc2dd41 commit 38c02f8

File tree

2 files changed

+53
-7
lines changed
  • docs/content/en/docs/config

2 files changed

+53
-7
lines changed

docs/content/en/docs/config/grpc/services/ocmshareprovider/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: >
99
# _struct: config_
1010

1111
{{% dir name="provider_domain" type="string" default="The same domain registered in the provider authorizer" %}}
12-
[[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/ocmshareprovider/ocmshareprovider.go#L71)
12+
[[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/ocmshareprovider/ocmshareprovider.go#L73)
1313
{{< highlight toml >}}
1414
[grpc.services.ocmshareprovider]
1515
provider_domain = "The same domain registered in the provider authorizer"

docs/content/en/docs/config/http/services/wellknown/_index.md

+52-6
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,61 @@ description: >
66
Configuration for the HelloWorld service
77
---
88

9-
{{% pageinfo %}}
10-
TODO
11-
{{% /pageinfo %}}
9+
# _struct: OcmProviderConfig_
1210

13-
{{% dir name="prefix" type="string" default=".well-known" %}}
14-
Where the HTTP service is exposed.
11+
{{% dir name="ocm_prefix" type="string" default="ocm" %}}
12+
The prefix URL where the OCM API is served. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/wellknown/ocm.go#L33)
1513
{{< highlight toml >}}
1614
[http.services.wellknown]
17-
prefix = "/"
15+
ocm_prefix = "ocm"
16+
{{< /highlight >}}
17+
{{% /dir %}}
18+
19+
{{% dir name="endpoint" type="string" default="This host's full URL. If it's not configured, it is assumed OCM is not available." %}}
20+
[[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/wellknown/ocm.go#L34)
21+
{{< highlight toml >}}
22+
[http.services.wellknown]
23+
endpoint = "This host's full URL. If it's not configured, it is assumed OCM is not available."
24+
{{< /highlight >}}
25+
{{% /dir %}}
26+
27+
{{% dir name="provider" type="string" default="reva" %}}
28+
A friendly name that defines this service. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/wellknown/ocm.go#L35)
29+
{{< highlight toml >}}
30+
[http.services.wellknown]
31+
provider = "reva"
32+
{{< /highlight >}}
33+
{{% /dir %}}
34+
35+
{{% dir name="webdav_root" type="string" default="/remote.php/dav/ocm" %}}
36+
The root URL of the WebDAV endpoint to serve OCM shares. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/wellknown/ocm.go#L36)
37+
{{< highlight toml >}}
38+
[http.services.wellknown]
39+
webdav_root = "/remote.php/dav/ocm"
40+
{{< /highlight >}}
41+
{{% /dir %}}
42+
43+
{{% dir name="webapp_root" type="string" default="/external/sciencemesh" %}}
44+
The root URL to serve Web apps via OCM. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/wellknown/ocm.go#L37)
45+
{{< highlight toml >}}
46+
[http.services.wellknown]
47+
webapp_root = "/external/sciencemesh"
48+
{{< /highlight >}}
49+
{{% /dir %}}
50+
51+
{{% dir name="enable_webapp" type="bool" default=false %}}
52+
Whether web apps are enabled in OCM shares. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/wellknown/ocm.go#L38)
53+
{{< highlight toml >}}
54+
[http.services.wellknown]
55+
enable_webapp = false
56+
{{< /highlight >}}
57+
{{% /dir %}}
58+
59+
{{% dir name="enable_datatx" type="bool" default=false %}}
60+
Whether data transfers are enabled in OCM shares. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/wellknown/ocm.go#L39)
61+
{{< highlight toml >}}
62+
[http.services.wellknown]
63+
enable_datatx = false
1864
{{< /highlight >}}
1965
{{% /dir %}}
2066

0 commit comments

Comments
 (0)