-
Notifications
You must be signed in to change notification settings - Fork 113
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
207 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
--- |
7 changes: 7 additions & 0 deletions
7
docs/content/en/docs/config/packages/notification/handler/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
--- |
50 changes: 50 additions & 0 deletions
50
docs/content/en/docs/config/packages/notification/handler/emailhandler/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 %}} | ||
|
42 changes: 42 additions & 0 deletions
42
docs/content/en/docs/config/packages/notification/notificationhelper/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 %}} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
--- |
66 changes: 66 additions & 0 deletions
66
docs/content/en/docs/config/serverless/services/notifications/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 %}} | ||
|