Mercurial > prosody-modules

view mod_sms_free/README.markdown @ 5563:a1f8cc591b66

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Back out 22784f001b7f: Documentation change did not match code (thanks bronko)
author Kim Alvefur <zash@zash.se>
date Thu, 22 Jun 2023 22:00:51 +0200
parents a07bd12fe554
children
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
summary: XMPP to SMS gateway using the HTTP API provided by mobile.free.fr
...

Introduction
============

This module sends an SMS to your phone when you receive a message on XMPP when
your status is xa or disconnected.

Note that it doesn’t support sending SMS to anyone else than yourself, in that
it is quite different from other gateways.

Configuration
=============

In prosody.cfg.lua:

    modules_enabled = {
        "sms_free",
    }

Usage
=====

Every user who wants to use this gateway can issue an ad-hoc command to their
server, then follow the instructions and start receiving messages by SMS when
they are unavailable or xa.

Compatibility
=============

  ----- ------------------------------------
  trunk Works
  0.11  Does not work (SNI support required)
  ----- ------------------------------------