Skip to content

Commit df6874e

Browse files
committed
📚 docs
1 parent 5d4cd2e commit df6874e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ Converts E-Mails from your services to ntfy push notifications!
66

77
- oidc-push hosts an SMTP server and a webserver
88
- On the web interface, a user can login via OIDC
9-
- They can generate a secure random string which will be used as a ntfy topic. Additionally, there is some guidance on how ntfy can be installed and used so people unfamiliar with ntfy can use this themselves.
10-
- When the SMTP server receives an E-Mail, the recipient E-Mail is matched against registered users.
11-
- When a match is found and the user has registered a ntfy topic, the email will be forwarded to that ntfy topic, which in turn allows any device of the user to get that message as a push notification.
12-
> By ensuring any service that sends out E-Mail notifications and oidc-push use the same OIDC provider, you can automatically map E-Mails to push notifications.
9+
- They can generate a secure random string which will be used as a ntfy topic. Additionally, there is some guidance on how ntfy can be installed and used so people unfamiliar with ntfy can use this themselves
10+
- When the SMTP server receives an E-Mail, the recipient E-Mail is matched against registered users
11+
- When a match is found and the user has registered a ntfy topic, the email will be forwarded to that ntfy topic, which in turn allows any device of the user to get that message as a push notification
12+
> By ensuring any service that sends out E-Mail notifications and oidc-push use the same OIDC provider, you can automatically map E-Mails to push notifications
1313
1414
What a logged in user sees:
1515
![Screenshot of the web app](./screenshots/1.png?raw=true 'Screenshot of the web app')

0 commit comments

Comments
 (0)