A LITTLE CONTEXT GOES A LONG WAY
Get to know
your monitor.
From your first check to the engine behind it.
The guides live alongside the code, in the open.
New here? Start with one monitor.
Run the container, create an account, and get your first result.
THE FIELD GUIDE
Pick up where you are.
These links open the product’s documentation on GitHub at the v0.1.0-rc7 tag, so they describe the build you can download.
Using SubGlance
Your first monitor, check types, push jobs, authentication, incident confirmation and reminders.
Read guideNotification channels
The settings each of the eight channel types needs, delivery state, SMS limits, and webhook bodies for Teams, Matrix, Pushover, Signal, WhatsApp, Home Assistant and more.
Read guideConfiguration files
Export and import monitors, channels, routing rules, maintenance windows and status pages as YAML, or convert an Uptime Kuma database.
Read guideInstallation
Docker, Compose, verifying the signed image and binaries, and building the complete application from source.
Read guideOperations
Configuration, worker sizing, retention, metrics, the watchdog, and safe backup and restore.
Read guideArchitecture
The engine, state transitions, notifications, SQLite storage and the embedded frontend.
Read guideDesign system
The thinking behind status signals, heartbeat bars, quiet surfaces, accessibility and both themes.
Read guideKeyboard commands
The command menu, monitor search and actions, navigation and themes, without reaching for the mouse.
Read guideDemo data
Create a fictional estate with monitor history and incidents for local evaluation and development.
Read guideA FIRST-CLASS INTERFACE
Your scripts get
the same capabilities.
REST API v1 supports browser sessions and bearer tokens. Viewer, editor and admin roles control access. The dashboard uses these same endpoints.
Open the OpenAPI 3.1 specificationA few useful starting points
- GET /api/v1/monitors
- Monitors with their current state.
- POST /api/v1/monitors/{id}/check
- Run a check now to verify a fix.
- POST /api/v1/incidents/{id}/ack
- Stop reminders without claiming recovery.
- GET /api/v1/stream
- Live results and state changes over SSE.
curl -H "Authorization: Bearer $SUBGLANCE_TOKEN" \
http://localhost:8080/api/v1/monitorsCreate an API token using an existing editor or admin session. Its plaintext is shown only once. Set SUBGLANCE_TOKEN in your shell before running this example. Authentication guide
OPEN SOURCE, ALL THE WAY DOWN
Read it. Run it. Help shape it.
Found something that could be better? Contributions go through pull requests against develop. Read the contribution guide first; contributors sign a CLA.
SubGlance is licensed under AGPL-3.0.