From 9c120d0758bb6232375005eafe0f7e2c4220d732 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Friedrich=20Dreyer?= Date: Thu, 5 May 2022 11:00:07 +0000 Subject: [PATCH] update notifications docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jörn Friedrich Dreyer --- docs/extensions/notifications/_index.md | 1 + extensions/notifications/pkg/config/config.go | 4 ++-- .../notifications/pkg/config/defaults/defaultconfig.go | 7 +++---- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/extensions/notifications/_index.md b/docs/extensions/notifications/_index.md index c0ad0f7a5..0cc731856 100644 --- a/docs/extensions/notifications/_index.md +++ b/docs/extensions/notifications/_index.md @@ -10,6 +10,7 @@ geekdocCollapseSection: true ## Abstract +The notifications extension is responsible for making users aware of changes. It listens on the event bus, filters relevant events, looks up the recipients email address and then queues an email with an external MTA. ## Table of Contents diff --git a/extensions/notifications/pkg/config/config.go b/extensions/notifications/pkg/config/config.go index 9b1e0c89f..d5964983c 100644 --- a/extensions/notifications/pkg/config/config.go +++ b/extensions/notifications/pkg/config/config.go @@ -25,8 +25,8 @@ type Notifications struct { *shared.Commons `yaml:"-"` SMTP SMTP `yaml:"SMTP"` Events Events `yaml:"events"` - RevaGateway string `yaml:"reva_gateway" env:"REVA_GATEWAY;NOTIFICATIONS_REVA_GATEWAY"` - MachineAuthAPIKey string `yaml:"machine_auth_api_key" env:"OCIS_MACHINE_AUTH_API_KEY;NOTIFICATIONS_MACHINE_AUTH_API_KEY"` + RevaGateway string `yaml:"reva_gateway" env:"REVA_GATEWAY;NOTIFICATIONS_REVA_GATEWAY" desc:"CS3 gateway used to look up user metadata"` + MachineAuthAPIKey string `yaml:"machine_auth_api_key" env:"OCIS_MACHINE_AUTH_API_KEY;NOTIFICATIONS_MACHINE_AUTH_API_KEY" desc:"Machine auth API key used to impersonate users when looking up their email"` } // SMTP combines the smtp configuration options. diff --git a/extensions/notifications/pkg/config/defaults/defaultconfig.go b/extensions/notifications/pkg/config/defaults/defaultconfig.go index 5530b8e38..2234e3843 100644 --- a/extensions/notifications/pkg/config/defaults/defaultconfig.go +++ b/extensions/notifications/pkg/config/defaults/defaultconfig.go @@ -21,10 +21,9 @@ func DefaultConfig() *config.Config { }, Notifications: config.Notifications{ SMTP: config.SMTP{ - Host: "127.0.0.1", - Port: "1025", - Sender: "god@example.com", - Password: "godisdead", + Host: "127.0.0.1", + Port: "1025", + Sender: "noreply@example.com", }, Events: config.Events{ Endpoint: "127.0.0.1:9233",