Skip to content

Update documentation for vapid_contact_email configuration #430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anoadragon453 merged 3 commits into from
Mar 2, 2026
Merged

Update documentation for vapid_contact_email configuration #430

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
61283f7
Update documentation for vapid_contact_email configuration
Just-Insane Feb 25, 2026
96d5d3c
Update docs/applications.md
Just-Insane Feb 27, 2026
9a6d095
Update WebPush documentation regarding vapid_contact_email
Just-Insane Feb 27, 2026
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
1 change: 1 addition & 0 deletions changelog.d/430.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Updated the WebPush documentation to note that `mailto:` should not be included in the `vapid_contact_email` config file. Contributed by @Just-Insane.
3 changes: 2 additions & 1 deletion docs/applications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,8 @@ serviceWorkerRegistration.pushManager.subscribe({

You also need to set an e-mail address in `vapid_contact_email` in the config file,
where the push gateway operator can reach you in case they need to notify you
about your usage of their API.
about your usage of their API. Note that only an email address is supported at this time,
as Sygnal will prepend `mailto:` to the email address provided in the config.

Since for webpush, the push gateway endpoint is variable and comes from the browser
through the push data, you may not want to have your sygnal instance connect to any
Expand Down