Skip to content

v1.0.0

Latest

Choose a tag to compare

@github-actions github-actions released this 14 Nov 22:02
e201a29

First stable release. New to SMS Gateway? Start with the README and Getting started.

Changes since v0.5.0-beta.2

  • In-app help. Both apps have a ? in the top bar that opens the docs page for the current screen. Gateway: Settings → About has a Help card (user guide, getting started, API reference, troubleshooting, issues, source). Companion: Help and Troubleshooting on the setup screen.
  • Release builds link to the docs at their own tag (blob/v1.0.0/docs/…, from the new DOCS_REF build field). Builds without a tag link to main.
  • Docs: new settings reference, companion troubleshooting, and diagrams for access control, the tunnel, HTTPS, and companion sync.

There are no changes to the API, the database schema (still version 5) or settings. The diff is UI and docs only (#19).

Assets

File Size
sms-gateway-v1.0.0.apk 47.8 MB Gateway. Install on the phone with the SIM(s). Bundles cloudflared 2026.11.0 for arm64-v8a and armeabi-v7a
gateway-sms-companion-v1.0.0.apk 22.2 MB Companion client (Gateway SMS). Optional, for another phone
SHA256SUMS.txt SHA-256 of both APKs
  • Requirements: Android 9+ (API 28). Target SDK 35.
  • Signing: both APKs have APK Signature Scheme v2 signatures. The signer certificate's SHA-256 is 8d9c517179fc0f19b97509a57774de71cde96098d084e83c0fd0a739c2ad738e, the same as every beta. Check it with apksigner verify --print-certs <apk>.
  • Distribution: sideload only. Google Play restricts SMS permissions to default SMS apps. See Install is blocked.

API

/api/v1 is stable as of this release, and changes to it stay backwards compatible. See the API reference.

Upgrading from a beta

The APK installs over any beta. Settings, API keys, webhooks and messages are kept, and database migrations run on first start.

From v0.5.x: nothing changes.

From v0.4.x, also note (introduced in v0.5.0-beta.1):

  • Webhook retries always end. A stored "give up after 0 h" (never) becomes 72 h, and the maximum is 720 h.
  • Who can connect → Tunnel only requires the tunnel to be on with a token. An existing Tunnel-only install without a working tunnel gets a warning on the Status tab. Turning the tunnel off while in Tunnel only switches to Local network after asking you first.

From v0.3.x or earlier, also note (introduced in v0.4.0-beta.1):

  • Who can connect is new and defaults to Local network. Connections arriving over mobile data, or from non-private addresses, are refused before authentication (403 with an empty body over HTTP, or closed before the TLS handshake over HTTPS). 100.64.0.0/10 (Tailscale) needs Also allow Tailscale addresses.
  • API key scopes: send, read, events, webhooks, send:shortcode. Existing keys keep all scopes and are flagged Review this key. New keys default to send and read. A missing scope answers 403 with {"error": "…", "scope": "<name>"}.
  • Webhooks and event streams belong to the key that created them. They're paused or closed while the key is off, and deleted or closed when it's revoked.
  • Quick tunnels (trycloudflare.com) removed. A configured quick tunnel is turned off, with a notice on the Status tab. Use a token-based tunnel instead.
  • GET /health without a key returns 200 with an empty body. {"status","version"} needs a valid key. Unexpected errors return Internal error instead of the exception message.
  • App data is excluded from device-to-device transfers, in addition to cloud backups.

Full changelog: v0.5.0-beta.2...v1.0.0