TextBee---API

TextBee---API

Docker app from grtgbln's Repository

Overview

A simple SMS gateway that allows users to send SMS messages from a web interface or from their application via a REST API. It utilizes android phones as SMS gateways.

Media gallery

Install TextBee---API on Unraid in a few clicks.

Find TextBee---API in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for TextBee---API Review the template variables and paths Click Install

Requirements


        Requires a separate MongoDB database.
    

Details

Repository
ghcr.io/vernu/textbee/api:latest
Last Updated2026-06-29
First Seen2024-12-31

Runtime arguments

Network
bridge
Privileged
false

Template configuration

API PortPorttcp

Container Port: 3005

Target
3005
Default
3005
Value
3005
MongoDB URLVariable

URL of the MongoDB database

Target
MONGO_URI
Default
mongodb://localhost:27017/textbee
Value
mongodb://localhost:27017/textbee
JWT SecretVariable

Secret key for JWT

Target
JWT_SECRET
Default
changeme
Value
changeme
Firebase - Project IDVariable

Firebase Project ID

Target
FIREBASE_PROJECT_ID
Firebase - Private Key IDVariable

Firebase Private Key ID

Target
FIREBASE_PRIVATE_KEY_ID
Firebase - Private KeyVariable

Firebase Private Key

Target
FIREBASE_PRIVATE_KEY
Firebase - Client EmailVariable

Firebase Client Email

Target
FIREBASE_CLIENT_EMAIL
Firebase - Client IDVariable

Firebase Client ID

Target
FIREBASE_CLIENT_ID
Firebase - Client C509 Cert URLVariable

Firebase Client C509 Cert URL

Target
FIREBASE_CLIENT_C509_CERT_URL
Web URLVariable

URL of the web interface. Needed for password reset links

Target
FRONTEND_URL
Default
http://localhost:3000
Value
http://localhost:3000
Email - HostVariable

Email Host

Target
MAIL_HOST
Email - PortVariable

Email Port

Target
MAIL_PORT
Email - UserVariable

Email User

Target
MAIL_USER
Email - PasswordVariable

Email Password

Target
MAIL_PASS
Email - FromVariable

Email From

Target
MAIL_FROM
Email - Reply ToVariable

Email Reply To

Target
MAIL_REPLY_TO
Internal API PortVariable

Internal API Port. Not recommended to change.

Target
PORT
Default
3005
Value
3005
JWT Expiration TimeVariable

JWT Expiration Time

Target
JWT_EXPIRATION
Default
60d
Value
60d