docs: document Web Push notification setup#688
Merged
Conversation
README had no guidance that push notifications require VAPID keys, so users enabling the in-app toggle saw no notifications. Expanded the Web push notifications section in docs/CONFIGURATION.md with the full setup steps, and trimmed the README to a one-line pointer. Closes #649
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The README mentioned push notifications as a feature but gave no hint that they require VAPID keys, so users enabling the in-app notification toggle saw no notifications and no explanation (see issue thread).
Expanded the
Web push notificationssection indocs/CONFIGURATION.mdwith the full setup steps (VAPID key generation, env vars, redeploy, re-enable toggle). Trimmed the README to a one-line note that push delivery requires additional configuration, with a pointer todocs/CONFIGURATION.md.Notable detail:
WEB_PUSH_EMAILis a bare email address — the app prependsmailto:automatically (src/server/notification.ts:9).Closes #649
Checklist
CONTRIBUTING.mdin its entirety