How louislam/uptime-kuma works
Uptime Kuma is a self-hosted monitoring application. An operator configures monitors in the reactive UI; the server runs monitor checks, records heartbeat and uptime history, and exposes status and metrics, with notifications available for alerts. Other documented capabilities include authentication, multiple status pages, certificate information, and proxy support. The graph focuses on these product paths. Some server wiring and monitor implementations were not excerpted, so uncertain runtime links are omitted; README-backed capabilities remain represented without implying unshown call sequences.
Main entry points: monitor.js Monitor execution · database.js Database · api-router.js API routes · better-auth.ts Authentication
Components 22
User experience
- Web interface
src/App.vue - Socket client
src/mixins/socket.js - API routes
server/routers/api-router.js - Status routes
server/routers/status-page-router.js
Monitoring runtime
- Server runtime
server/server.js - Monitor registry
server/uptime-kuma-server.js - Monitor execution
server/model/monitor.js - Monitor types
server/monitor-types - Check conditions
server/monitor-conditions
Persistence and reporting
- Heartbeat history
server/model/heartbeat.js - Uptime statistics
server/uptime-calculator.js - Database
server/database.js - Status pages
server/model/status_page.js - Prometheus metrics
server/prometheus.js
Identity and configuration
- Authentication
server/better-auth.ts - Auth routes
server/routers/better-auth-router.ts - Settings
server/settings.js
External integrations
- Notification dispatch
server/notification.js - Notification providers
server/notification-providers
Other components
- Operator
- Monitored services
- Notification services
Connections 23
- Operator → Web interface: configures
README.md - Web interface → Socket client: uses
src/App.vue - Socket client → Authentication: authenticates
- Operator → API routes: manages monitors
- API routes → Monitor execution: routes to
server/routers/api-router.js - Server runtime → Monitor registry: initializes
server/server.js - Monitor registry → Monitor types: registers
server/uptime-kuma-server.js - Monitor execution → Monitor types: executes checks
- Monitor execution → Monitored services: checks
README.md - Monitor execution → Heartbeat history: records
server/model/monitor.js - Monitor execution → Uptime statistics: updates
server/model/monitor.js - Uptime statistics → Database: reads and writes
server/uptime-calculator.js - Monitor execution → Notification dispatch: alerts through
server/model/monitor.js - Notification dispatch → Notification providers: dispatches
- Notification providers → Notification services: sends alerts
README.md - API routes → Prometheus metrics: exposes
server/routers/api-router.js - Operator → Status routes: views pages
README.md - Status routes → Status pages: reads
server/routers/status-page-router.js - Auth routes → Authentication: delegates
server/routers/better-auth-router.ts - Authentication → Database: uses
server/better-auth.ts - Monitor execution → Database: persists monitor data
- Check conditions → Monitor execution: evaluates checks
- Settings → Database: reads and writes
server/settings.js