superstackinc/beacyn repository overview

Overview

Beacyn is a self-hosted monitoring and observability platform. One Docker image runs the web portal and the API. Compose also starts MySQL 8 for application data and agent telemetry.

The portal watches website and API uptime, response time, ping, and ports. It reads the live TLS certificate, tracks certificate and domain-registration expiry, and marks a monitor down when the TLS handshake fails. Infrastructure views cover servers, Docker, databases, SNMP, and syslog. Operators get incidents, status pages, audit history, maintenance windows, and scheduled portal health checks.

The image listens on port 7145 for the portal and port 5145 for the API. Optional listeners accept SNMP traps on UDP 9162 and syslog on UDP/TCP 5514. MySQL stays on the Compose network and is published on host port 3316.

docker compose --env-file .env.docker up -d

Set MYSQL_ROOT_PASSWORD before production use. VITE_API_BASE_URL is baked into the browser bundle at build time, so public deployments should rebuild the image with the URL browsers will call.