Skip to content

Commit

Permalink
commit 15f7c00
Browse files Browse the repository at this point in the history
Merge: ffb1365 9c120d0
Author: Jörn Friedrich Dreyer <[email protected]>
Date:   Thu May 5 11:45:55 2022 +0000

    Merge pull request #3695 from owncloud/notifications-config

    update notifications docs
  • Loading branch information
butonic committed May 5, 2022
1 parent b802a32 commit 2455c37
Show file tree
Hide file tree
Showing 14 changed files with 21 additions and 20 deletions.
8 changes: 4 additions & 4 deletions extensions/_includes/adoc/notifications_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@ NOTIFICATIONS_LOG_FILE`
|
| `NOTIFICATIONS_SMTP_SENDER`
| string
| god@example.com
| noreply@example.com
|
| `NOTIFICATIONS_SMTP_PASSWORD`
| string
| godisdead
|
|
| `NOTIFICATIONS_EVENTS_ENDPOINT`
| string
Expand All @@ -74,12 +74,12 @@ NOTIFICATIONS_LOG_FILE`
NOTIFICATIONS_REVA_GATEWAY`
| string
| 127.0.0.1:9142
|
| CS3 gateway used to look up user metadata
| `OCIS_MACHINE_AUTH_API_KEY +
NOTIFICATIONS_MACHINE_AUTH_API_KEY`
| string
|
|
| Machine auth API key used to impersonate users when looking up their email
|===

Since Version: `+` added, `-` deprecated
4 changes: 2 additions & 2 deletions extensions/_includes/notifications-config-example.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ notifications:
SMTP:
smtp_host: 127.0.0.1
smtp_port: "1025"
smtp_sender: god@example.com
smtp_password: godisdead
smtp_sender: noreply@example.com
smtp_password: ""
events:
endpoint: 127.0.0.1:9233
cluster: ocis-cluster
Expand Down
8 changes: 4 additions & 4 deletions extensions/_includes/notifications_configvars.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@
| NOTIFICATIONS_DEBUG_ZPAGES | bool | false | |
| NOTIFICATIONS_SMTP_HOST | string | 127.0.0.1 | |
| NOTIFICATIONS_SMTP_PORT | string | 1025 | |
| NOTIFICATIONS_SMTP_SENDER | string | god@example.com | |
| NOTIFICATIONS_SMTP_PASSWORD | string | godisdead | |
| NOTIFICATIONS_SMTP_SENDER | string | noreply@example.com | |
| NOTIFICATIONS_SMTP_PASSWORD | string | | |
| NOTIFICATIONS_EVENTS_ENDPOINT | string | 127.0.0.1:9233 | |
| NOTIFICATIONS_EVENTS_CLUSTER | string | ocis-cluster | |
| NOTIFICATIONS_EVENTS_GROUP | string | notifications | |
| REVA_GATEWAY<br/>NOTIFICATIONS_REVA_GATEWAY | string | 127.0.0.1:9142 | |
| OCIS_MACHINE_AUTH_API_KEY<br/>NOTIFICATIONS_MACHINE_AUTH_API_KEY | string | | |
| REVA_GATEWAY<br/>NOTIFICATIONS_REVA_GATEWAY | string | 127.0.0.1:9142 | CS3 gateway used to look up user metadata|
| OCIS_MACHINE_AUTH_API_KEY<br/>NOTIFICATIONS_MACHINE_AUTH_API_KEY | string | | Machine auth API key used to impersonate users when looking up their email|
1 change: 1 addition & 0 deletions extensions/notifications/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion grpc_apis/ocis/messages/accounts/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.messages.accounts.v0"
url: /grpc_apis/ocis_messages_accounts_v0
date: 2022-05-05T09:51:28Z
date: 2022-05-05T11:47:01Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion grpc_apis/ocis/messages/search/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.messages.search.v0"
url: /grpc_apis/ocis_messages_search_v0
date: 2022-05-05T09:51:28Z
date: 2022-05-05T11:47:01Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion grpc_apis/ocis/messages/settings/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.messages.settings.v0"
url: /grpc_apis/ocis_messages_settings_v0
date: 2022-05-05T09:51:28Z
date: 2022-05-05T11:47:01Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion grpc_apis/ocis/messages/store/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.messages.store.v0"
url: /grpc_apis/ocis_messages_store_v0
date: 2022-05-05T09:51:28Z
date: 2022-05-05T11:47:01Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion grpc_apis/ocis/messages/thumbnails/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.messages.thumbnails.v0"
url: /grpc_apis/ocis_messages_thumbnails_v0
date: 2022-05-05T09:51:28Z
date: 2022-05-05T11:47:01Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion grpc_apis/ocis/services/accounts/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.services.accounts.v0"
url: /grpc_apis/ocis_services_accounts_v0
date: 2022-05-05T09:51:28Z
date: 2022-05-05T11:47:01Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion grpc_apis/ocis/services/search/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.services.search.v0"
url: /grpc_apis/ocis_services_search_v0
date: 2022-05-05T09:51:28Z
date: 2022-05-05T11:47:01Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion grpc_apis/ocis/services/settings/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.services.settings.v0"
url: /grpc_apis/ocis_services_settings_v0
date: 2022-05-05T09:51:28Z
date: 2022-05-05T11:47:01Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion grpc_apis/ocis/services/store/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.services.store.v0"
url: /grpc_apis/ocis_services_store_v0
date: 2022-05-05T09:51:28Z
date: 2022-05-05T11:47:01Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down
2 changes: 1 addition & 1 deletion grpc_apis/ocis/services/thumbnails/v0/grpc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ocis.services.thumbnails.v0"
url: /grpc_apis/ocis_services_thumbnails_v0
date: 2022-05-05T09:51:28Z
date: 2022-05-05T11:47:01Z
weight: 50
geekdocRepo: https://github.com/owncloud/ocis
---
Expand Down

0 comments on commit 2455c37

Please sign in to comment.