annotate mod_sms_free/README.markdown @ 5139:449e4ca4de32

mod_unified_push: Remove dependency on trunk util.jwt (0.12 compat) This should allow the module to work on 0.12, while preserving expiry checking (which was not built in to 0.12's util.jwt).
author Matthew Wild <mwild1@gmail.com>
date Tue, 10 Jan 2023 16:34:21 +0000
parents a07bd12fe554
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3695
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
1 ---
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
2 labels:
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
3 - 'Stage-Alpha'
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
4 summary: XMPP to SMS gateway using the HTTP API provided by mobile.free.fr
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
5 ...
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
6
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
7 Introduction
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
8 ============
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
9
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
10 This module sends an SMS to your phone when you receive a message on XMPP when
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
11 your status is xa or disconnected.
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
12
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
13 Note that it doesn’t support sending SMS to anyone else than yourself, in that
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
14 it is quite different from other gateways.
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
15
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
16 Configuration
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
17 =============
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
18
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
19 In prosody.cfg.lua:
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
20
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
21 modules_enabled = {
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
22 "sms_free",
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
23 }
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
24
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
25 Usage
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
26 =====
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
27
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
28 Every user who wants to use this gateway can issue an ad-hoc command to their
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
29 server, then follow the instructions and start receiving messages by SMS when
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
30 they are unavailable or xa.
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
31
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
32 Compatibility
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
33 =============
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
34
3697
a07bd12fe554 mod_sms_free: Mention that 0.11 will not work due to the absence of SNI support.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3695
diff changeset
35 ----- ------------------------------------
3695
5a70dd2349a7 mod_sms_free: New module!
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff changeset
36 trunk Works
3697
a07bd12fe554 mod_sms_free: Mention that 0.11 will not work due to the absence of SNI support.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3695
diff changeset
37 0.11 Does not work (SNI support required)
a07bd12fe554 mod_sms_free: Mention that 0.11 will not work due to the absence of SNI support.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 3695
diff changeset
38 ----- ------------------------------------