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