Skip to content

Commit

Permalink
Recompiled docs (#4006)
Browse files Browse the repository at this point in the history
  • Loading branch information
glpatcern authored Jun 23, 2023
1 parent f900433 commit 1c131b0
Show file tree
Hide file tree
Showing 10 changed files with 207 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: >
# _struct: config_

{{% dir name="provider_domain" type="string" default="The same domain registered in the provider authorizer" %}}
[[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/ocmshareprovider/ocmshareprovider.go#L63)
[[Ref]](https://github.com/cs3org/reva/tree/master/internal/grpc/services/ocmshareprovider/ocmshareprovider.go#L64)
{{< highlight toml >}}
[grpc.services.ocmshareprovider]
provider_domain = "The same domain registered in the provider authorizer"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,18 @@ description: >
# _struct: Config_

{{% dir name="insecure" type="bool" default=false %}}
Whether to skip certificate checks when sending requests. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/owncloud/ocdav/ocdav.go#L103)
Whether to skip certificate checks when sending requests. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/owncloud/ocdav/ocdav.go#L104)
{{< highlight toml >}}
[http.services.owncloud.ocdav]
insecure = false
{{< /highlight >}}
{{% /dir %}}

{{% dir name="notifications" type="map[string]interface{}" default=Settingsg for the Notification Helper %}}
[[Ref]](https://github.com/cs3org/reva/tree/master/internal/http/services/owncloud/ocdav/ocdav.go#L115)
{{< highlight toml >}}
[http.services.owncloud.ocdav]
notifications = Settingsg for the Notification Helper
{{< /highlight >}}
{{% /dir %}}

22 changes: 11 additions & 11 deletions docs/content/en/docs/config/packages/app/provider/wopi/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,87 +9,87 @@ description: >
# _struct: config_

{{% dir name="mime_types" type="[]string" default=nil %}}
Inherited from the appprovider. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L78)
Inherited from the appprovider. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L79)
{{< highlight toml >}}
[app.provider.wopi]
mime_types = nil
{{< /highlight >}}
{{% /dir %}}

{{% dir name="iop_secret" type="string" default="" %}}
The IOP secret used to connect to the wopiserver. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L79)
The IOP secret used to connect to the wopiserver. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L80)
{{< highlight toml >}}
[app.provider.wopi]
iop_secret = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="wopi_url" type="string" default="" %}}
The wopiserver's URL. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L80)
The wopiserver's URL. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L81)
{{< highlight toml >}}
[app.provider.wopi]
wopi_url = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="app_name" type="string" default="" %}}
The App user-friendly name. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L81)
The App user-friendly name. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L82)
{{< highlight toml >}}
[app.provider.wopi]
app_name = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="app_icon_uri" type="string" default="" %}}
A URI to a static asset which represents the app icon. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L82)
A URI to a static asset which represents the app icon. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L83)
{{< highlight toml >}}
[app.provider.wopi]
app_icon_uri = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="folder_base_url" type="string" default="" %}}
The base URL to generate links to navigate back to the containing folder. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L83)
The base URL to generate links to navigate back to the containing folder. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L84)
{{< highlight toml >}}
[app.provider.wopi]
folder_base_url = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="app_url" type="string" default="" %}}
The App URL. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L84)
The App URL. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L85)
{{< highlight toml >}}
[app.provider.wopi]
app_url = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="app_int_url" type="string" default="" %}}
The internal app URL in case of dockerized deployments. Defaults to AppURL [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L85)
The internal app URL in case of dockerized deployments. Defaults to AppURL [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L86)
{{< highlight toml >}}
[app.provider.wopi]
app_int_url = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="app_api_key" type="string" default="" %}}
The API key used by the app, if applicable. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L86)
The API key used by the app, if applicable. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L87)
{{< highlight toml >}}
[app.provider.wopi]
app_api_key = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="jwt_secret" type="string" default="" %}}
The JWT secret to be used to retrieve the token TTL. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L87)
The JWT secret to be used to retrieve the token TTL. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L88)
{{< highlight toml >}}
[app.provider.wopi]
jwt_secret = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="app_desktop_only" type="bool" default=false %}}
Specifies if the app can be opened only on desktop. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L88)
Specifies if the app can be opened only on desktop. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/app/provider/wopi/wopi.go#L89)
{{< highlight toml >}}
[app.provider.wopi]
app_desktop_only = false
Expand Down
7 changes: 7 additions & 0 deletions docs/content/en/docs/config/packages/notification/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "notification"
linkTitle: "notification"
weight: 10
description: >
Configuration for the notification service
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "handler"
linkTitle: "handler"
weight: 10
description: >
Configuration for the handler service
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: "emailhandler"
linkTitle: "emailhandler"
weight: 10
description: >
Configuration for the emailhandler service
---

# _struct: config_

{{% dir name="smtp_server" type="string" default="" %}}
The hostname and port of the SMTP server. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/notification/handler/emailhandler/emailhandler.go#L44)
{{< highlight toml >}}
[notification.handler.emailhandler]
smtp_server = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="sender_login" type="string" default="" %}}
The email to be used to send mails. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/notification/handler/emailhandler/emailhandler.go#L45)
{{< highlight toml >}}
[notification.handler.emailhandler]
sender_login = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="sender_password" type="string" default="" %}}
The sender's password. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/notification/handler/emailhandler/emailhandler.go#L46)
{{< highlight toml >}}
[notification.handler.emailhandler]
sender_password = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="disable_auth" type="bool" default=false %}}
Whether to disable SMTP auth. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/notification/handler/emailhandler/emailhandler.go#L47)
{{< highlight toml >}}
[notification.handler.emailhandler]
disable_auth = false
{{< /highlight >}}
{{% /dir %}}

{{% dir name="default_sender" type="string" default="no-reply@cernbox.cern.ch" %}}
Default sender when not specified in the trigger. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/notification/handler/emailhandler/emailhandler.go#L48)
{{< highlight toml >}}
[notification.handler.emailhandler]
default_sender = "no-reply@cernbox.cern.ch"
{{< /highlight >}}
{{% /dir %}}

Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: "notificationhelper"
linkTitle: "notificationhelper"
weight: 10
description: >
Configuration for the notificationhelper service
---

# _struct: Config_

{{% dir name="nats_address" type="string" default="" %}}
The NATS server address. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/notification/notificationhelper/notificationhelper.go#L47)
{{< highlight toml >}}
[notification.notificationhelper]
nats_address = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="nats_token" type="string" default="" %}}
The token to authenticate against the NATS server [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/notification/notificationhelper/notificationhelper.go#L48)
{{< highlight toml >}}
[notification.notificationhelper]
nats_token = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="nats_stream" type="string" default="reva-notifications" %}}
The notifications NATS stream. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/notification/notificationhelper/notificationhelper.go#L49)
{{< highlight toml >}}
[notification.notificationhelper]
nats_stream = "reva-notifications"
{{< /highlight >}}
{{% /dir %}}

{{% dir name="templates" type="map[string]interface{}" default= %}}
Notification templates for the service. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/notification/notificationhelper/notificationhelper.go#L50)
{{< highlight toml >}}
[notification.notificationhelper]
templates =
{{< /highlight >}}
{{% /dir %}}

7 changes: 7 additions & 0 deletions docs/content/en/docs/config/serverless/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "serverless"
linkTitle: "serverless"
weight: 10
description: >
Configuration for the serverless service
---
7 changes: 7 additions & 0 deletions docs/content/en/docs/config/serverless/services/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "services"
linkTitle: "services"
weight: 10
description: >
Configuration for the services service
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
title: "notifications"
linkTitle: "notifications"
weight: 10
description: >
Configuration for the notifications service
---

# _struct: config_

{{% dir name="nats_address" type="string" default="" %}}
The NATS server address. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/serverless/services/notifications/notifications.go#L46)
{{< highlight toml >}}
[serverless.services.notifications]
nats_address = ""
{{< /highlight >}}
{{% /dir %}}

{{% dir name="nats_token" type="string" default="The token to authenticate against the NATS server" %}}
[[Ref]](https://github.com/cs3org/reva/tree/master/internal/serverless/services/notifications/notifications.go#L47)
{{< highlight toml >}}
[serverless.services.notifications]
nats_token = "The token to authenticate against the NATS server"
{{< /highlight >}}
{{% /dir %}}

{{% dir name="nats_prefix" type="string" default="reva-notifications" %}}
The notifications NATS stream. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/serverless/services/notifications/notifications.go#L48)
{{< highlight toml >}}
[serverless.services.notifications]
nats_prefix = "reva-notifications"
{{< /highlight >}}
{{% /dir %}}

{{% dir name="handlers" type="map[string]interface{}" default= %}}
Settings for the different notification handlers. [[Ref]](https://github.com/cs3org/reva/tree/master/internal/serverless/services/notifications/notifications.go#L49)
{{< highlight toml >}}
[serverless.services.notifications]
handlers =
{{< /highlight >}}
{{% /dir %}}

{{% dir name="grouping_interval" type="int" default=60 %}}
Time in seconds to group incoming notification triggers [[Ref]](https://github.com/cs3org/reva/tree/master/internal/serverless/services/notifications/notifications.go#L50)
{{< highlight toml >}}
[serverless.services.notifications]
grouping_interval = 60
{{< /highlight >}}
{{% /dir %}}

{{% dir name="grouping_max_size" type="int" default=100 %}}
Maximum number of notifications to group [[Ref]](https://github.com/cs3org/reva/tree/master/internal/serverless/services/notifications/notifications.go#L51)
{{< highlight toml >}}
[serverless.services.notifications]
grouping_max_size = 100
{{< /highlight >}}
{{% /dir %}}

{{% dir name="storage_driver" type="string" default="mysql" %}}
The driver used to store notifications [[Ref]](https://github.com/cs3org/reva/tree/master/internal/serverless/services/notifications/notifications.go#L52)
{{< highlight toml >}}
[serverless.services.notifications]
storage_driver = "mysql"
{{< /highlight >}}
{{% /dir %}}

0 comments on commit 1c131b0

Please sign in to comment.