How metakgp/naarad works
Naarad is a self-hosted ntfy service for KGP notices, with a custom institute-user signup flow. The signup page requests registration; the backend validates Heimdall identity, creates an ntfy account, grants channel access, and emails credentials. The README also documents the ntfy service’s caching, attachments, web interface, push notifications, logging, and rate limiting. Relationships for the signup flow are supported by excerpts; broader ntfy capabilities and Heimdall protection are documented in the README, while the ntfy server internals are not present in this tree.
Main entry points: main.go Registration API · Register.tsx Registration page · server.yml Ntfy notifications · index.tsx Frontend entry
Components 12
Signup interface
- Frontend entry
frontend/src/index.tsx - Signup app
frontend/src/App.tsx - Registration page
frontend/src/pages/Register.tsx - Redirect toast
frontend/src/components/RedirectToast.tsx
Signup backend
- Registration API
backend/main.go - Credential mailer
backend/mail.go
Ntfy service
- Ntfy notifications
server.yml
Other components
- KGP user
- Heimdall identity
- Ntfy account store
- Gmail delivery
- KGP subscribers
Connections 12
- KGP user → Frontend entry: opens signup
README.md - Frontend entry → Signup app: renders
frontend/src/index.tsx - Signup app → Registration page: renders
frontend/src/App.tsx - Registration page → Registration API: requests registration
frontend/src/pages/Register.tsx - Registration page → Redirect toast: shows redirect
frontend/src/pages/Register.tsx - Registration API → Heimdall identity: validates identity
backend/main.go - Registration API → Ntfy account store: checks and grants access
backend/main.go - Registration API → Ntfy notifications: creates account
backend/main.go - Registration API → Credential mailer: sends credentials
backend/main.go - Credential mailer → Gmail delivery: sends email
backend/mail.go - KGP subscribers → Ntfy notifications: receives notices
README.md - Heimdall identity → Ntfy notifications: protects access
README.md