textbelt-docker

KO | EN

gitlite — search

#react #ai #typescript #machine-learning #deep-learning #linux #nodejs #java #pytorch #security #mcp #ios #openai #open-source

textbelt-docker

(★ 17)

Build a docker image and docker-compose to use textbelt API

textbelt-docker Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Textbelt-Docker
A Node Alpine based docker to easily get [textbelt](https://github.com/typpo/textbelt) running and send outgoing SMS messages through email-to-SMS gateways.

## INSTALLATION
### Run
```
docker run --name=textbelt \
-p 9090:9090 \
-e HOST=imap.gmail.com \
-e MAIL_PORT=587 \
-e MAIL_USER=username@email.com \
-e MAIL_PASS=emailpassword \
-e FROM_ADDRESS=username@email.com \
-e REALNAME=yourname \
-e MAIL_DEBUG=false \
-e SECURE_CONNECTION=true \
--restart unless-stopped \
hexeth/textbelt-docker
```

### Compose
```
version: '3'

services:
  textbelt:
    image: hexeth/textbelt-docker
    container_name: textbelt
    restart: unless-stopped
    ports:
      - "9090:9090"
    environment:
      - HOST=smtp.host.com
      - MAIL_PORT=587
      - MAIL_USER=youremailaccount
      - MAIL_PASS=youremailpassword
      - FROM_ADDRESS=youremailaddress
      - REALNAME=your name
      - MAIL_DEBUG=true
      - SECURE_CONNECTION=true
```

## ENV VARIABLES
* `HOST` **= smtp.host.com** *#your smtp domain address: default is smtp.gmail.com*
* `MAIL_PORT` **= 587** *#your smtp port: default is 587*
* `MAIL_USER` **= youremailaccount** *#your email account name including domain*
* `MAIL_PASS` **= youremailpassword** *#your email account password*
* `FROM_ADDRESS` **= your@email.address** *#your from email address: myemail@domain.com*
* `REALNAME` **= your name** *#your name that appears in from email*
* `MAIL_DEBUG` **= false** *#debug mailing: default false*
* `SECURE_CONNECTION` **= true** *#if ssl is required: default is true*

## USAGE

* When container starts you will see `listening on port 9090` in docker logs
* To send text messages, run the following command `curl -X POST http://127.0.0.1:9090/text --data-urlencode number='18001337' --data-urlencode carrier='att' --data-urlencode 'message=Hello world'`
* To text Canada or International numbers (based on supported carriers listed below), replace `/text` with `/canada` or `/intl`.
* If you do not include carrier in your POST, the app will cycle through all available carriers based on your endpoint (e.g. /text will cycle through all US carriers). If you are using gmail or a similar public email app you will receive a failure response due your high SMTP frequency. You'll also likely receive a bunch of bounceback messages to your email inbox. Despite receiving a failure, the message will likely still go through.
* Successful messages will return a success response.
* Messages that fail to send will return a failure. Unfortunately, the failure reasons are not very descriptive. It is probably your mail settings. If you are using gmail and have two-factor authentication turned on you will need to create an [app password](https://support.google.com/accounts/answer/185833?hl=en).
* Received messages will display to the intended recipient based on how each carrier supports email-to-SMS.

## SUPPORTED CARRIERS
* Supported U.S. carriers: Alltel, Ameritech, AT&T Wireless, Boost, CellularOne, Cingular, Edge Wireless, Nex-Tech Wireless, Project Fi, Sprint PCS, Telus Mobility, T-Mobile, Metro PCS, Nextel, O2, Orange, Qwest, Rogers Wireless, Ting, US Cellular, Verizon, Virgin Mobile.

* Supported U.S. and Canadian carriers (/canada): 3 River Wireless, ACS Wireless, AT&T, Alltel, BPL Mobile, Bell Canada, Bell Mobility, Bell Mobility (Canada), Blue Sky Frog, Bluegrass Cellular, Boost Mobile, Carolina West Wireless, Cellular One, Cellular South, Centennial Wireless, CenturyTel, Cingular (Now AT&T), Clearnet, Comcast, Corr Wireless Communications, Dobson, Edge Wireless, Fido, Golden Telecom, Helio, Houston Cellular, Idea Cellular, Illinois Valley Cellular, Inland Cellular Telephone, MCI, MTS, Metro PCS, Metrocall, Metrocall 2-way, Microcell, Midwest Wireless, Mobilcomm, Nextel, OnlineBeep, PCS One, President's Choice, Public Service Cellular, Qwest, Republic Wireless, Rogers AT&T Wireless, Rogers Canada, Satellink, Solo Mobile, Southwestern Bell, Sprint, Sumcom, Surewest Communicaitons, T-Mobile, Telus, Tracfone, Triton, US Cellular, US West, Unicel, Verizon, Virgin Mobile, Virgin Mobile Canada, West Central Wireless, Western Wireless

* Supported international carriers (/intl): Chennai RPG Cellular, Chennai Skycell / Airtel, Comviq, DT T-Mobile, Delhi Aritel, Delhi Hutch, Dutchtone / Orange-NL, EMT, Escotel, German T-Mobile, Goa BPLMobil, Golden Telecom, Gujarat Celforce, JSM Tele-Page, Kerala Escotel, Kolkata Airtel, Kyivstar, LMT, Lauttamus Communication, Maharashtra BPL Mobile, Maharashtra Idea Cellular, Manitoba Telecom Systems, Meteor, MiWorld, Mobileone, Mobilfone, Mobility Bermuda, Mobistar Belgium, Mobitel Tanzania, Mobtel Srbija, Movistar, Mumbai BPL Mobile, Netcom, Ntelos, O2, O2 (M-mail), One Connect Austria, OnlineBeep, Optus Mobile, Orange, Orange Mumbai, Orange NL / Dutchtone, Oskar, P&T Luxembourg, Personal Communication, Pondicherry BPL Mobile, Primtel, SCS-900, SFR France, Safaricom, Satelindo GSM, Simple Freedom, Smart Telecom, Southern LINC, Sunrise Mobile, Surewest Communications, Swisscom, Telcel Mexico, T-Mobile Austria, T-Mobile Germany, T-Mobile UK, TIM, TSR Wireless, Tamil Nadu BPL Mobile, Tele2 Latvia, Telefonica Movistar, Telenor, Teletouch, Telia Denmark, UMC, Uraltel, Uttar Pradesh Escotel, Vessotel, Vodafone Italy, Vodafone Japan, Vodafone UK, Wyndtell

textbelt-docker

textbelt-docker Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

textbelt-docker

textbelt-docker Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README