Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 11 additions & 3 deletions docs/CONFIGURATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading