docker-sms-over-xmpp's Introduction

What is sms-over-xmpp

sms-over-xmpp is an XMPP component (XEP-0114) that acts as a gateway between an XMPP network and the SMS network. It allows you to send and receive SMS messages as if they were XMPP messages, using your favorite XMPP client.

You send an XMPP message and your friend receives an SMS. When she responds by SMS, you receive an XMPP message.

For more information, please see: https://github.com/mndrix/sms-over-xmpp

How to use this image

$ docker run \
-e XMPP_HOST=127.0.0.1 \
-e XMPP_PORT=5347 \
-e XMPP_NAME=sms.example.com \
-e XMPP_SECRET="shared secret from your XMPP server config" \
-e TWILIO_ACCOUNT_SID="AC..." \
-e TWILIO_KEY_SID="SK..." \
-e TWILIO_KEY_SECRET="..." \
-e USERS='[{"username":"[email protected]","number":"+13075551212"}]' \
-p 9677:9677 \
--name my-sms-gateway \
-d \
justmoon/sms-over-xmpp

Environment variables

`XMPP_HOST`

IP or hostname of your XMPP server.

`XMPP_PORT`

Port where sms-over-xmpp should connect to your XMPP server. Optional, default: 5437.

`XMPP_NAME`

XMPP domain used by the server. E.g. sms.example.com.

`XMPP_SECRET`

Shared secret from your XMPP server config.

`TWILIO_ACCOUNT_SID`
`TWILIO_KEY_SID`
`TWILIO_KEY_SECRET`

Your Twilio API credentials.

`USERS`

Use this to map XMPP usernames to E.164 phone numbers. JSON format, e.g.

[
  {
    "username": "[email protected]",
    "number": "+13075551212"
  }
]

docker-sms-over-xmpp's People

Contributors

Stargazers

Watchers

docker-sms-over-xmpp's Issues

New import path, security fix

Hi there,

I wanted to give you a heads up that mndrix has transferred ownership of sms-over-xmpp to me. Accordingly, the import path is now github.com/AGWA/sms-over-xmpp.

Also, I just fixed a security vulnerability that allowed attackers to spoof SMSes if your XMPP server allows untrusted users to send messages to your sms-over-xmpp component. I therefore recommend upgrading.

Recommend Projects