FireFlo SMS/SMPP Gateway

The fastest way to a running FireFlo. For a real deployment go to Install in one command instead — this leaves out the service account, the systemd unit, log retention and TLS.

What you need

Docker.
A working directory with conf, data and logs subdirectories.
The configuration files in conf. Copy the shipped conf.example directory and replace every REPLACE_WITH_* value.

fireflo-runtime/
  conf/
    credentials.yml
    smsg.properties
    routingTable.conf
    rates.conf
  data/
  logs/

Start it

docker run -d --name fireflo \
  -e QUARKUS_LOG_FILE_ENABLE=true \
  -e QUARKUS_LOG_CONSOLE_ENABLE=false \
  -e QUARKUS_LOG_FILE_PATH=/work/logs/smsg.log \
  -e QUARKUS_LOG_FILE_SMPPCLIENT_PATH=/work/logs/smppclient.log \
  -e QUARKUS_LOG_FILE_SMPPSERVER_PATH=/work/logs/smppserver.log \
  -e QUARKUS_HTTP_ACCESS_LOG_DIRECTORY=/work/logs \
  -p 8080:8080 \
  -p 127.0.0.1:9000:9000 \
  -p 27777:27777 \
  -v ./conf:/work/conf \
  -v ./data:/work/data \
  -v ./logs:/work/logs \
  edgeservers/fireflo:latest

edgeservers/fireflo:latest-native is the native build of the same thing.

Note 9000 is published to loopback only. It carries bind state, queue depths and vendor names, and the two tokens are the only thing in front of it.

Check it started

The container is up

docker ps

Running, not restarting.

The HTTP API answers

curl -s http://localhost:8080/ping

If it did not start, read smsg.log first

tail -50 logs/smsg.log

A gateway with no routing table does not start at all, and says so by naming an internal structure — no default routing table in new targets! — rather than the missing configuration. That message means your routingTable.conf is empty, missing, or failed to parse.

Send something through it

curl -s -u 'your-login:your-password' \
  -X POST http://localhost:8080/secure/send \
  -H 'Content-Type: application/json' \
  -d '{"to":"61400000000","content":"hello from FireFlo"}'

A 200 with a message id means it was accepted, charged and queued — not that it was delivered. Delivery is a separate answer that arrives as a receipt. See Send one message.

What this quickstart does not give you

Missing	Why it matters	Where
A database	No prepaid credit, no expiry sweep, no panel editing	Database
The control panel	No screens, no statements, no customer portal	Installing the panel
Log retention	`httpapi.log` grows forever	Logging
A real vendor	Nothing leaves the building	Vendors
TLS	Everything is plaintext	Install by hand

Concepts

The words the rest of this site uses — read before the install pages.

Install properly

Service account, systemd, database, firewall, smoke test.

Start here

The control panel

Install and run

Connections

Routing

Customers and approvals

Billing

Operations

Troubleshooting

Migrating

Project

Quickstart

What you need

Start it

Check it started

Send something through it

What this quickstart does not give you

Next

Concepts

Install properly

​What you need

​Start it

​Check it started

​Send something through it

​What this quickstart does not give you

​Next

Concepts

Install properly

What you need

Start it

Check it started

Send something through it

What this quickstart does not give you

Next