From 54b5497121eb1f2cd902a15d970dedb20139cd16 Mon Sep 17 00:00:00 2001 From: Tomas Dvorak Date: Tue, 22 Sep 2026 13:10:29 +0200 Subject: [PATCH] docs: v2.0.0 changelog, configuration for auth/boards, announcement refresh MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - CHANGELOG 2.0.0 entry covering all Phase 5 waves - configuration.md: transports, per-monitor alert rules, auth, boards, appearance/language, PWA - announcement.md: updated for shipped features and opt-in auth - AGENTS.md: "no auth" line was stale - ROADMAP: tick shipped M1–M3 planning checkboxes Authored By: TDvorak Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com> --- AGENTS.md | 3 ++- CHANGELOG.md | 28 +++++++++++++++++++++++++++- ROADMAP.md | 32 ++++++++++++++++---------------- docs/announcement.md | 21 +++++++++++++-------- docs/configuration.md | 37 +++++++++++++++++++++++++++++++------ 5 files changed, 89 insertions(+), 32 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 2904e03..2485a6c 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,7 +1,8 @@ # Dash Self-hosted homelab dashboard. Single Go binary serving an embedded React UI. -No auth, no YAML. See `ROADMAP.md` (canonical) and `docs/specs/` for design. +Optional auth (off by default), no YAML. See `ROADMAP.md` (canonical) and +`docs/specs/` for design. ## Layout diff --git a/CHANGELOG.md b/CHANGELOG.md index 609579c..2650723 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,31 @@ All notable changes to Dash. Format follows ## [Unreleased] +## [2.0.0] — 2026-09-22 + +### Added + +- Opt-in local auth: first-user setup, bcrypt passwords, SQLite sessions, + rotating 7-day HttpOnly cookie, login rate limit, sign-out/disable in + settings. Off by default; status pages, badges, metrics, push, and agent + ingest stay public +- Multiple boards: named boards with slugs, header switcher, `/b/:slug` + routes, per-board sections, board-aware export +- Full i18n: every UI string via typed `t()` keys with interpolation; + English + Czech locales, language select in settings +- Uptime bar strip + latency chart on monitor detail +- iframe embed widget and generic JSON-path widget (backend fetcher) +- Custom accent color, wallpaper URL, and custom CSS in settings +- PWA: manifest, icons, minimal service worker +- Alert transports: webhook, Slack, Discord, Telegram, Gotify, ntfy, SMTP + (stdlib `net/smtp`); transport picker + test button in settings +- Per-monitor alert rules: consecutive-failure threshold, latency warn, mute; + per-domain cert-days threshold and mute +- Per-container CPU/memory in `dash-agent` (Docker stats when socket present); + optional SMART, ZFS, and GPU collectors (exec-or-sysfs, skipped when absent) +- Subdomain discovery via Certificate Transparency + DNS, daily sweep, + subdomains section on domain detail + ## [0.7.0] — 2026-09-21 ### Added @@ -77,7 +102,8 @@ All notable changes to Dash. Format follows - Single Go binary serving the embedded React UI; SQLite via goose migrations; Docker image on distroless -[Unreleased]: https://github.com/Dvorinka/Dash/compare/v0.7.0...HEAD +[Unreleased]: https://github.com/Dvorinka/Dash/compare/v2.0.0...HEAD +[2.0.0]: https://github.com/Dvorinka/Dash/compare/v0.7.0...v2.0.0 [0.7.0]: https://github.com/Dvorinka/Dash/compare/v0.6.0...v0.7.0 [0.6.0]: https://github.com/Dvorinka/Dash/compare/v0.5.0...v0.6.0 [0.5.0]: https://github.com/Dvorinka/Dash/compare/v0.4.0...v0.5.0 diff --git a/ROADMAP.md b/ROADMAP.md index 0aed93c..763d178 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -149,27 +149,27 @@ becomes the summary layer over the monitoring pages. Uptime checking: the backbone everything else hangs off. -- [ ] Schema: `monitors` (name, type, url/hostname/port, method, keyword, json_query, expected_value, interval_s, timeout_s, retries, active, status, tags, notes), `heartbeats` (monitor_id, status, ping_ms, msg, cert_expiry, checked_at — 30-day retention prune) -- [ ] In-process scheduler: due-monitor sweep, bounded worker pool, heartbeat write, status transitions -- [ ] Checkers: `http`/`https`, `tcp`, `ping` (unprivileged ICMP datagram via `x/net/icmp` — distroless has no ping binary), `dns`, `keyword`, `json-query`, `push` (caller-generated ingest URL) -- [ ] API: `/api/monitors` CRUD, `/:id/heartbeats?range=`, pause/resume, check-now -- [ ] Monitors page (status, uptime 24h/30d, ping, interval) + detail (response chart, heartbeat log) -- [ ] Board widget type `monitor` bound to a monitor id -- [ ] ServiceDialog checkbox: create matching http monitor from a service URL -- [ ] The fork's ~30 exotic monitor types were TCP stubs — not ported. Real types only. +- [x] Schema: `monitors` (name, type, url/hostname/port, method, keyword, json_query, expected_value, interval_s, timeout_s, retries, active, status, tags, notes), `heartbeats` (monitor_id, status, ping_ms, msg, cert_expiry, checked_at — 30-day retention prune) +- [x] In-process scheduler: due-monitor sweep, bounded worker pool, heartbeat write, status transitions +- [x] Checkers: `http`/`https`, `tcp`, `ping` (unprivileged ICMP datagram via `x/net/icmp` — distroless has no ping binary), `dns`, `keyword`, `json-query`, `push` (caller-generated ingest URL) +- [x] API: `/api/monitors` CRUD, `/:id/heartbeats?range=`, pause/resume, check-now +- [x] Monitors page (status, uptime 24h/30d, ping, interval) + detail (response chart, heartbeat log) +- [x] Board widget type `monitor` bound to a monitor id +- [x] ServiceDialog checkbox: create matching http monitor from a service URL +- [x] The fork's ~30 exotic monitor types were TCP stubs — not ported. Real types only. ### Phase M2 — Domains → v0.5.0 Domain-locker-grade domain intelligence. -- [ ] Schema: `domains` (core columns + `extra` JSON for the long tail), `domain_history` (domain_id, change_type, field, old, new, at) -- [ ] Lookup pipeline ported from fork `hub/domains/whois/lookup.go`, trimmed: RDAP over HTTPS → native WHOIS TCP:43 + parser; SSL chain via `crypto/tls`; DNS (NS/MX/TXT/A/AAAA) via `net.Resolver`; host geo via ip-api; provider detection via fork `detect/providers.go`; favicon -- [ ] Daily scheduler + manual refresh; field diffs recorded to `domain_history` -- [ ] Alerts: `alert_rules` + `notifications` tables; dispatchers — generic webhook (JSON POST), SMTP via `net/smtp`, Discord/Slack presets. Triggers: domain expiry ≤ N days, SSL expiry ≤ N days, monitor down/recovered (M1), system offline (M3) -- [ ] Domains page + detail (expiry countdown, registrar, SSL, DNS, subdomains) -- [ ] Board widget `domain` (expiry countdown) -- [ ] Subdomain discovery: port `subdomain_discovery.go`, opt-in per domain -- [ ] Not ported (v1): whoisxml API, EURid web scraping, SEO/robots parsing, valuation estimates — demand only +- [x] Schema: `domains` (core columns + `extra` JSON for the long tail), `domain_history` (domain_id, change_type, field, old, new, at) +- [x] Lookup pipeline ported from fork `hub/domains/whois/lookup.go`, trimmed: RDAP over HTTPS → native WHOIS TCP:43 + parser; SSL chain via `crypto/tls`; DNS (NS/MX/TXT/A/AAAA) via `net.Resolver`; host geo via ip-api; provider detection via fork `detect/providers.go`; favicon +- [x] Daily scheduler + manual refresh; field diffs recorded to `domain_history` +- [x] Alerts: `alert_rules` + `notifications` tables; dispatchers — generic webhook (JSON POST), SMTP via `net/smtp`, Discord/Slack presets. Triggers: domain expiry ≤ N days, SSL expiry ≤ N days, monitor down/recovered (M1), system offline (M3) +- [x] Domains page + detail (expiry countdown, registrar, SSL, DNS, subdomains) +- [x] Board widget `domain` (expiry countdown) +- [x] Subdomain discovery: port `subdomain_discovery.go`, opt-in per domain +- [x] Not ported (v1): whoisxml API, EURid web scraping, SEO/robots parsing, valuation estimates — demand only ### Phase M3 — Systems → v0.6.0 diff --git a/docs/announcement.md b/docs/announcement.md index 00289d8..1836462 100644 --- a/docs/announcement.md +++ b/docs/announcement.md @@ -1,11 +1,11 @@ -# v1.0.0 launch post — draft +# v2.0.0 launch post — draft For r/selfhosted, HN Show, and similar. Edit freely before posting. --- **Title:** Dash — a self-hosted homelab dashboard with monitoring built in. -Single Go binary, no YAML, no auth. +Single Go binary, no YAML, optional auth. **Body:** @@ -19,13 +19,17 @@ What it does: upload. Imports your existing Homepage (`services.yml`), Homarr, or Dashy config in one click. - **Monitors** — HTTP/TCP/ping/DNS/keyword/JSON-path checks plus push monitors - for cron jobs. Webhook alerts (Slack/Discord/ntfy). Uptime history. + for cron jobs. Uptime graphs, per-monitor alert rules, and notifications via + webhook, Slack, Discord, Telegram, Gotify, ntfy, or SMTP. - **Domains** — WHOIS/RDAP, DNS, TLS certificate expiry, provider detection. Inspired by Domain Locker, minus the paid APIs. -- **Systems** — a ~4 MB static agent pushes CPU/mem/disk/net/temps/Docker - container states. Inspired by Beszel, push-JSON instead of SSH. +- **Systems** — a ~4 MB static agent pushes CPU/mem/disk/net/temps, per- + container stats, and SMART/ZFS/GPU when present. Inspired by Beszel, + push-JSON instead of SSH. - **Ops** — incidents, maintenance windows, public status pages, SVG badges, Prometheus `/api/metrics`. +- **Extras** — multiple boards, iframe/JSON-path widgets, CT-log subdomain + discovery, EN/CZ locales, installable PWA, custom CSS/wallpaper. Deployment is one container: @@ -33,8 +37,9 @@ Deployment is one container: docker run -d -v ./data:/data -p 3000:3000 ghcr.io/dvorinka/dash:latest ``` -SQLite inside, no database to babysit, no accounts. Deliberately no auth — -it expects a trusted LAN or your own proxy in front. +SQLite inside, no database to babysit. Auth is opt-in: local +username/password with bcrypt + session cookies, off by default; public +status pages stay open either way. Stack: Go + Gin + SQLite (single static binary serving an embedded React UI). MIT licensed. @@ -53,5 +58,5 @@ Show HN: Dash – self-hosted homelab dashboard with monitoring, one Go binary Dash combines a service board, uptime monitors, domain/SSL watching, system metrics via a tiny push agent, and public status pages. Single container or -single binary, SQLite storage, no YAML, no auth (LAN-trust model). MIT. +single binary, SQLite storage, no YAML. Optional local auth. MIT. https://github.com/Dvorinka/Dash diff --git a/docs/configuration.md b/docs/configuration.md index 9031516..5ffd25e 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -21,12 +21,16 @@ snapshot; `/api/import/csv` bulk-loads monitors and domains from CSV. ## Notifications -**Settings → Notifications** holds one generic webhook URL -(`notify_webhook`). On monitor up/down transitions and domain events, Dash -POSTs a JSON payload with `event`, `name`, `text`, `content`, `message`, and -`at` fields — shaped so Slack, Discord, and ntfy all render it sensibly. -**Test** sends a `test` event. Delivery is async and non-fatal; failures are -logged. +**Settings → Notifications** configures any number of transports — generic +webhook, Slack, Discord, Telegram, Gotify, ntfy, and SMTP — each stored as a +`notify_` settings object. Monitor up/down transitions and domain +events fan out to every configured transport; the payload carries `event`, +`name`, `text`, `content`, `message`, and `at` fields. **Test** sends a `test` +event. Delivery is async and non-fatal; failures are logged. + +Per-monitor alert rules (consecutive failures before down, latency-warn ms, +mute) live on each monitor; domains get a cert-days threshold and mute. +Maintenance windows still take precedence. ## Monitors @@ -47,6 +51,27 @@ Bearer-token push ingest at `POST /api/systems/ingest`. A system is marked offline when no sample arrives within a few intervals. Stats are pruned during the hourly sweep. +## Auth + +Off by default — existing installs see no gate. **Settings → Authentication → +Enable** flips to a first-user setup screen (username/email + password, +bcrypt). Sessions are SQLite-backed 7-day HttpOnly cookies with rotation; +login is rate-limited per IP. Disable only works from an authenticated +session. Public status pages, badges, `/api/metrics`, `/api/push/*`, and +agent ingest stay open under auth. + +## Boards + +The header switcher manages multiple boards — each gets a slug and a +`/b/:slug` route with its own sections/items. Monitors, domains, systems, and +status pages stay global. Exports carry all boards. + +## Appearance & language + +Theme (dark/light), accent color, wallpaper URL, and custom CSS in Settings; +the language picker switches the UI between English and Czech. A PWA manifest +and service worker make the app installable. + ## Operations - **Incidents** — open/ack/resolve/close, with per-incident update timeline.