Skip to content

About

Web-based administrative dashboard for the SMSGate ecosystem

Resources

Stars

4 stars

Watchers

0 watching

Forks

Repository files navigation

🖥️ SMSGate Web Dashboard

Contributors Forks Stars Issues License

A standalone Go HTTP server with an embedded SvelteKit single-page application: a web dashboard for managing Android devices running SMS Gateway for Android. Part of the SMSGate ecosystem.

📖 About

The dashboard proxies the SMSGate 3rd Party API: it validates credentials, keeps cookie-backed server sessions, registers webhooks per session, and pushes real-time events to the browser over Server-Sent Events. The Svelte 5 frontend is compiled to static files and embedded in the Go binary via embed.FS.

📚 Table of Contents

⭐ Features

  • Dashboard: aggregated statistics (devices online/active/total, messages sent/pending/failed), 7/14/30-day trend charts, live activity feed
  • Messages: paginated list with filters (state, device, date range), send SMS or MMS with attachments, optionally target a specific device, delivery status timeline
  • Devices: list with online/offline status, end-to-end encryption indicator (E2E vs none) with key rotation version, remove devices
  • Webhooks: create, list, and delete subscriptions for 12 event types (SMS received/sent/delivered/failed, data SMS, system ping, MMS received/downloaded, and their batch variants)
  • API tokens: generate JWT tokens with granular scope selection (15 permission levels), copy and revoke
  • Device settings: SIM selection mode, message intervals, retry policy, webhook signing key, encryption passphrase
  • Real-time: live SSE stream with toast notifications for messages, state changes, and device status
  • Observability: OpenAPI/Swagger UI at /api/v1/docs, Prometheus metrics at /metrics, health probes at /health/live, /health/ready, and /health/startup

📸 Screenshots

Dashboard Messages
Compose SMS Compose MMS
Devices Tokens
Settings Login

📦 Prerequisites

  • Go 1.26+
  • Node.js 20.19+ or 22.12+ (frontend build)
  • swag CLI (go install github.com/swaggo/swag/cmd/swag@latest) — required by go generate, which make air and make build run
  • Optional: air for live reload (go install github.com/air-verse/air@latest), golangci-lint

🚀 Quickstart

git clone https://github.com/android-sms-gateway/web-dashboard.git
cd web-dashboard
make deps
make air

Open http://localhost:3000. make air runs go generate first (installs npm dependencies, compiles and embeds the Svelte frontend), then starts the Go server with hot reload on .go changes.

For standalone frontend work, the Vite dev server proxies /api to the Go server:

cd web
npm ci
npm run dev

Vite serves the SPA at http://localhost:5173.

Configuration

Configuration is read from an optional YAML file (CONFIG_PATH), then a local .env file, then environment variables (later sources win). Nested keys use a __ separator. See .env.example for the full annotated reference.

Variable Default Description
HTTP__ADDRESS 127.0.0.1:3000 HTTP server bind address
HTTP__PROXY_HEADER X-Forwarded-For Header carrying the real client IP behind a proxy
HTTP__PROXIES [] Trusted proxy IPs (JSON array)
HTTP__OPENAPI__ENABLED true Serve Swagger UI at /api/v1/docs
HTTP__OPENAPI__PUBLIC_HOST - Override the host shown in generated OpenAPI docs (empty = use request host)
HTTP__OPENAPI__PUBLIC_PATH - Override the base path shown in generated OpenAPI docs (empty = use request path)
GATEWAY__URL https://api.sms-gate.app/3rdparty/v1 SMSGate 3rd Party API endpoint
WEBHOOKS__URL http://localhost:3000/api/webhooks/callback Base public callback URL for webhook events; the dashboard appends the gateway login to register <base>/<login> per session. Must be reachable by the gateway (a remote deployment needs a publicly reachable HTTPS URL)
CACHE__URL memory:// Trends cache backend (memory:// or redis://)
CONFIG_PATH - Path to optional YAML configuration file
DEBUG - Enable debug logging (process environment only; set by make air)

🚀 Build and Deploy

Build the production binary (OpenAPI docs + embedded frontend):

make build

Docker images (linux/amd64 and linux/arm64, Alpine-based, non-root user) are published to GitHub Container Registry:

docker run --name web-dashboard \
  -p 3000:3000 \
  -e HTTP__ADDRESS=0.0.0.0:3000 \
  -e WEBHOOKS__URL=https://your-public-url/api/webhooks/callback \
  ghcr.io/android-sms-gateway/web-dashboard:latest

📚 Documentation

🤝 Contributing

Contributions are welcome. Open an issue or pull request; follow the Contributing Guide and the repo's make fmt / make lint / make test checks.

⚖️ License

Apache-2.0. See LICENSE.

About

Web-based administrative dashboard for the SMSGate ecosystem

Resources

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages