Skip to content

Commit 4c7439a

Browse files
Update documentation for vapid_contact_email configuration (#430)
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
1 parent d7743b4 commit 4c7439a

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

changelog.d/430.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Updated the WebPush documentation to note that `mailto:` should not be included in the `vapid_contact_email` config file. Contributed by @Just-Insane.

docs/applications.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,8 @@ serviceWorkerRegistration.pushManager.subscribe({
279279

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

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

0 commit comments

Comments
 (0)