Mercurial > prosody-modules
comparison mod_web_push/README.markdown @ 3612:2cee9fcb318b
Initial version of mod_web_push. WARNING: Do not use.
| author | Maxime “pep” Buquet <pep@bouah.net> |
|---|---|
| date | Sat, 08 Jun 2019 23:06:44 +0200 |
| parents | |
| children | a5da9172362a |
comparison
equal
deleted
inserted
replaced
| 3611:235d986ac20f | 3612:2cee9fcb318b |
|---|---|
| 1 --- | |
| 2 labels: | |
| 3 - 'Stage-Alpha' | |
| 4 summary: 'XEP-XXXX: Web Push' | |
| 5 --- | |
| 6 | |
| 7 Introduction | |
| 8 ============ | |
| 9 | |
| 10 ::: {.alert .alert-danger} | |
| 11 **This module is terribly untested and will only work with Firefox as it's | |
| 12 missing payload encryption. Other vendors require it all the time. Public and | |
| 13 private keys are also statically set in it.** | |
| 14 ::: | |
| 15 | |
| 16 This is an implementation of the server bits of [XEP-XXXX: Web Push]. | |
| 17 It allows clients to register a "push server" which is notified about new | |
| 18 messages while the user is offline, disconnected or the session is hibernated | |
| 19 by [mod_smacks]. | |
| 20 | |
| 21 Push servers are provided by browser vendors. | |
| 22 | |
| 23 This module is heavily based on [mod_cloud_notify]. | |
| 24 | |
| 25 Configuration | |
| 26 ============= | |
| 27 | |
| 28 Option Default Description | |
| 29 ------------------------------------ ----------------- ------------------------------------------------------------------------------------------------------------------- | |
| 30 `push_notification_important_body` `New Message!` The body text to use when the stanza is important (see above), no message body is sent if this is empty | |
| 31 `push_max_devices` `5` The number of allowed devices per user (the oldest devices are automatically removed if this threshold is reached) | |
| 32 | |
| 33 There are privacy implications for enabling these options because | |
| 34 plaintext content and metadata will be shared with centralized servers | |
| 35 (the pubsub node) run by arbitrary app developers. | |
| 36 | |
| 37 Installation | |
| 38 ============ | |
| 39 | |
| 40 Same as any other module. | |
| 41 | |
| 42 Configuration | |
| 43 ============= | |
| 44 | |
| 45 Configured in-band by supporting clients. |