From 1c131b0758507b9d008b8a74cc6b45a9e177508d Mon Sep 17 00:00:00 2001
From: Giuseppe Lo Presti <giuseppe.lopresti@cern.ch>
Date: Fri, 23 Jun 2023 10:32:58 +0200
Subject: [PATCH] Recompiled docs (#4006)

---
 .../grpc/services/ocmshareprovider/_index.md  |  2 +-
 .../http/services/owncloud/ocdav/_index.md    | 10 ++-
 .../packages/app/provider/wopi/_index.md      | 22 +++----
 .../config/packages/notification/_index.md    |  7 ++
 .../packages/notification/handler/_index.md   |  7 ++
 .../handler/emailhandler/_index.md            | 50 ++++++++++++++
 .../notification/notificationhelper/_index.md | 42 ++++++++++++
 .../en/docs/config/serverless/_index.md       |  7 ++
 .../docs/config/serverless/services/_index.md |  7 ++
 .../services/notifications/_index.md          | 66 +++++++++++++++++++
 10 files changed, 207 insertions(+), 13 deletions(-)
 create mode 100644 docs/content/en/docs/config/packages/notification/_index.md
 create mode 100644 docs/content/en/docs/config/packages/notification/handler/_index.md
 create mode 100644 docs/content/en/docs/config/packages/notification/handler/emailhandler/_index.md
 create mode 100644 docs/content/en/docs/config/packages/notification/notificationhelper/_index.md
 create mode 100644 docs/content/en/docs/config/serverless/_index.md
 create mode 100644 docs/content/en/docs/config/serverless/services/_index.md
 create mode 100644 docs/content/en/docs/config/serverless/services/notifications/_index.md

diff --git a/docs/content/en/docs/config/grpc/services/ocmshareprovider/_index.md b/docs/content/en/docs/config/grpc/services/ocmshareprovider/_index.md
index 950d60597a..3de755abf5 100644
--- a/docs/content/en/docs/config/grpc/services/ocmshareprovider/_index.md
+++ b/docs/content/en/docs/config/grpc/services/ocmshareprovider/_index.md
@@ -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"
diff --git a/docs/content/en/docs/config/http/services/owncloud/ocdav/_index.md b/docs/content/en/docs/config/http/services/owncloud/ocdav/_index.md
index edeb84444c..e269611bb1 100644
--- a/docs/content/en/docs/config/http/services/owncloud/ocdav/_index.md
+++ b/docs/content/en/docs/config/http/services/owncloud/ocdav/_index.md
@@ -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 %}}
+
diff --git a/docs/content/en/docs/config/packages/app/provider/wopi/_index.md b/docs/content/en/docs/config/packages/app/provider/wopi/_index.md
index 6f190be387..d581c7c008 100644
--- a/docs/content/en/docs/config/packages/app/provider/wopi/_index.md
+++ b/docs/content/en/docs/config/packages/app/provider/wopi/_index.md
@@ -9,7 +9,7 @@ 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
@@ -17,7 +17,7 @@ mime_types = nil
 {{% /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 = ""
@@ -25,7 +25,7 @@ iop_secret = ""
 {{% /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 = ""
@@ -33,7 +33,7 @@ wopi_url = ""
 {{% /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 = ""
@@ -41,7 +41,7 @@ app_name = ""
 {{% /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 = ""
@@ -49,7 +49,7 @@ app_icon_uri = ""
 {{% /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 = ""
@@ -57,7 +57,7 @@ folder_base_url = ""
 {{% /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 = ""
@@ -65,7 +65,7 @@ app_url = ""
 {{% /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 = ""
@@ -73,7 +73,7 @@ app_int_url = ""
 {{% /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 = ""
@@ -81,7 +81,7 @@ app_api_key = ""
 {{% /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 = ""
@@ -89,7 +89,7 @@ jwt_secret = ""
 {{% /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
diff --git a/docs/content/en/docs/config/packages/notification/_index.md b/docs/content/en/docs/config/packages/notification/_index.md
new file mode 100644
index 0000000000..9e81b10b98
--- /dev/null
+++ b/docs/content/en/docs/config/packages/notification/_index.md
@@ -0,0 +1,7 @@
+---
+title: "notification"
+linkTitle: "notification"
+weight: 10
+description: >
+  Configuration for the notification service
+---
\ No newline at end of file
diff --git a/docs/content/en/docs/config/packages/notification/handler/_index.md b/docs/content/en/docs/config/packages/notification/handler/_index.md
new file mode 100644
index 0000000000..1daf47e92e
--- /dev/null
+++ b/docs/content/en/docs/config/packages/notification/handler/_index.md
@@ -0,0 +1,7 @@
+---
+title: "handler"
+linkTitle: "handler"
+weight: 10
+description: >
+  Configuration for the handler service
+---
\ No newline at end of file
diff --git a/docs/content/en/docs/config/packages/notification/handler/emailhandler/_index.md b/docs/content/en/docs/config/packages/notification/handler/emailhandler/_index.md
new file mode 100644
index 0000000000..fa5c7ca72e
--- /dev/null
+++ b/docs/content/en/docs/config/packages/notification/handler/emailhandler/_index.md
@@ -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 %}}
+
diff --git a/docs/content/en/docs/config/packages/notification/notificationhelper/_index.md b/docs/content/en/docs/config/packages/notification/notificationhelper/_index.md
new file mode 100644
index 0000000000..45101d615d
--- /dev/null
+++ b/docs/content/en/docs/config/packages/notification/notificationhelper/_index.md
@@ -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 %}}
+
diff --git a/docs/content/en/docs/config/serverless/_index.md b/docs/content/en/docs/config/serverless/_index.md
new file mode 100644
index 0000000000..697072afb8
--- /dev/null
+++ b/docs/content/en/docs/config/serverless/_index.md
@@ -0,0 +1,7 @@
+---
+title: "serverless"
+linkTitle: "serverless"
+weight: 10
+description: >
+  Configuration for the serverless service
+---
\ No newline at end of file
diff --git a/docs/content/en/docs/config/serverless/services/_index.md b/docs/content/en/docs/config/serverless/services/_index.md
new file mode 100644
index 0000000000..01e9c803b9
--- /dev/null
+++ b/docs/content/en/docs/config/serverless/services/_index.md
@@ -0,0 +1,7 @@
+---
+title: "services"
+linkTitle: "services"
+weight: 10
+description: >
+  Configuration for the services service
+---
\ No newline at end of file
diff --git a/docs/content/en/docs/config/serverless/services/notifications/_index.md b/docs/content/en/docs/config/serverless/services/notifications/_index.md
new file mode 100644
index 0000000000..f4478eb33e
--- /dev/null
+++ b/docs/content/en/docs/config/serverless/services/notifications/_index.md
@@ -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 %}}
+