From 75bc8c88d3bef5ad3126f41ebe38409c62b2ca90 Mon Sep 17 00:00:00 2001 From: krokosik Date: Sun, 21 Jun 2026 16:51:25 +0200 Subject: [PATCH] docs: document Web Push notification setup 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 --- README.md | 2 +- docs/CONFIGURATION.md | 14 +++++++++++--- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fa2fdf05..8e82ce58 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ Create expenses with categories, currencies, dates, and receipt attachments. Spl ### 2) Application info -SplitPro is a PWA and that is the recommended way to use the app. It supports push notifications for new expenses and updates. +SplitPro is a PWA and that is the recommended way to use the app. It supports push notifications for new expenses and updates, but push delivery requires additional configuration. See [docs/CONFIGURATION.md](docs/CONFIGURATION.md). ### 3) Groups diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md index 65b6f29e..5fc723d6 100644 --- a/docs/CONFIGURATION.md +++ b/docs/CONFIGURATION.md @@ -94,9 +94,17 @@ Used for magic-link login and invites. ### Web push notifications -- `WEB_PUSH_PRIVATE_KEY` -- `WEB_PUSH_PUBLIC_KEY` -- `WEB_PUSH_EMAIL` +Push notifications are disabled until VAPID keys are configured. Without them, the in-app notification toggle has no effect. + +To enable push notifications: + +1. Generate a VAPID keypair, either with `npx web-push generate-vapid-keys --json` or the online tool at https://vapidkeys.com +2. Set these env vars in `.env`: + - `WEB_PUSH_PUBLIC_KEY` — generated public key + - `WEB_PUSH_PRIVATE_KEY` — generated private key + - `WEB_PUSH_EMAIL` — contact email as a bare address (e.g. `you@example.com`); the app prepends `mailto:` automatically +3. Redeploy or restart your container. +4. If you previously toggled notifications off in the PWA or system settings, re-enable them after redeploying. ### Feedback email