Merge pull request #3695 from owncloud/notifications-config

update notifications docs
owncloud · May 5, 2022 · 15f7c00 · 15f7c00
2 parents ffb1365 + 9c120d0
commit 15f7c00
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git 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
@@ -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
@@ -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",