pager/README.md
Jonas Leder d602dd67dd
All checks were successful
ci / docs (push) Successful in 4m14s
ci / backend-docker (push) Successful in 0s
ci / build (push) Successful in 5m9s
ci / chart (push) Successful in 0s
ci / build-2 (push) Successful in 47s
ci / frontend-build (push) Successful in 48s
ci / backend-test (push) Successful in 1m17s
ci / build-1 (push) Successful in 2m29s
ci / frontend-docker (push) Successful in 0s
Point the docs link to git-pages
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-18 15:48:22 +01:00

1.6 KiB
Raw Blame History

Pager

Docs: https://jonasled.jonasled.dev/pager/

Multi-tenant Opsgenie-like alerting. Go backend (Gin, Gorm, gormigrate, Logrus via go-libs, swaggo) + React PWA with Web Push.

Run

cd frontend && pnpm install && pnpm build      # dev: pnpm dev (proxies /api to :8080)
cd ../backend && cp .env.example .env && go run . # serves API, UI (STATIC_DIR) and /swagger/index.html

Push needs HTTPS (or localhost). VAPID keys are generated once and stored in the DB unless set in env. DB: DB_DRIVER = postgres | mariadb | sqlite, with single DB_HOST/PORT/USER/PASSWORD/NAME entries.

Use

  1. Register at /register → creates tenant + owner. Owner/admins add users in Team.
  2. Team → Inbound shows the Alertmanager URL (/api/ingest/<token>/alertmanager, send_resolved: true) and the generic webhook URL.
  3. Alertmanager firing creates an alert or refreshes it (count + last refresh). resolved closes it. Changed summary/description/label priority (P1–P5) update it; annotation comment adds a comment.
  4. Alerts list shows open-since, refresh count and last refresh. Assign, ack, close, comment in UI or from the notification buttons.

Regenerate API docs after changing annotations: cd backend && swag init --parseInternal -g main.go

Docs

Docusaurus site in docs/ (cd docs && pnpm install && pnpm start). Screenshots are not committed: they are taken with Playwright (pnpm screenshots) against the real app with demo data. The Forgejo Actions pipeline does this on every run and publishes the site to git-pages on the default branch: https://jonasled.jonasled.dev/pager/