mirror of
https://github.com/Dvorinka/Dash.git
synced 2026-10-28 07:41:27 +00:00
docs: OSS readiness — README hero, one-line installer, stale doc fixes
Restructure README to the standard OSS layout (logo, badges, screenshots grid, architecture, quick start). Add install.sh for curl|sh installs with a named-volume fallback for Docker Desktop file-sharing limits, and scripts/setup.sh for clone-based setup. Correct SECURITY.md (no longer pre-1.0) and CONTRIBUTING.md (auth shipped in 2.0.0). Authored By: TDvorak <[email protected]> Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
This commit is contained in:
Tomas DvorakandDevin committed
1 parent
54b5497121
commit
afa0c931b9
7 files changed
+225
-61
No files matched your search
@@ -1,53 +1,106 @@
|
||||
# Dash
|
||||
<p align="center">
|
||||
<img src="./dash.svg" alt="Dash" width="120">
|
||||
</p>
|
||||
|
||||
A self-hosted homelab dashboard. CasaOS-grade ease of use, Vercel-grade design.
|
||||
Single container, UI-managed, no YAML. Optional auth.
|
||||
<h1 align="center">Dash</h1>
|
||||
|
||||
|
||||
<p align="center">
|
||||
Self-hosted homelab dashboard.<br>
|
||||
Service boards, uptime monitors, domain watch, and system metrics in one container.
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="#quick-start">Quick Start</a> ·
|
||||
<a href="docs/installation.md">Documentation</a> ·
|
||||
<a href="https://github.com/Dvorinka/Dash/releases">Releases</a> ·
|
||||
<a href="CONTRIBUTING.md">Contributing</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/Dvorinka/Dash/actions/workflows/ci.yml"><img src="https://github.com/Dvorinka/Dash/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
|
||||
<a href="https://github.com/Dvorinka/Dash/releases"><img src="https://img.shields.io/github/v/release/Dvorinka/Dash" alt="Release"></a>
|
||||
<a href="LICENSE"><img src="https://img.shields.io/github/license/Dvorinka/Dash" alt="License"></a>
|
||||
</p>
|
||||
|
||||
## What is Dash?
|
||||
|
||||
Dash is a self-hosted homelab dashboard: service boards with drag-and-drop,
|
||||
uptime monitors, domain intelligence, push-based system metrics, incidents,
|
||||
and public status pages — one static Go binary serving an embedded React UI.
|
||||
No YAML, no external database; auth is optional and off by default.
|
||||
|
||||
## Screenshots
|
||||
|
||||
| Board | Monitors | Systems |
|
||||
|:-:|:-:|:-:|
|
||||
|  |  |  |
|
||||
|
||||
<details>
|
||||
<summary>More screenshots</summary>
|
||||
|
||||
| Domains | Status page |
|
||||
|:-:|:-:|
|
||||
|  |  |
|
||||
|
||||
</details>
|
||||
|
||||
## Features
|
||||
|
||||
- **Service board** — multiple boards, sections, drag-and-drop, multi-URL
|
||||
services, icon upload, four renderers (Bento, Cards, Index, Console),
|
||||
dark/light themes, custom accent/wallpaper/CSS
|
||||
- **Uptime monitors** — HTTP, TCP, ping, DNS, keyword, JSON-path, and push
|
||||
checks on a schedule, heartbeat history, uptime graphs, per-monitor alert
|
||||
rules
|
||||
- **Domain watch** — WHOIS/RDAP, DNS records, TLS certificate expiry,
|
||||
registrar and provider detection, CT-log subdomain discovery
|
||||
- **System monitoring** — lightweight `dash-agent` pushes CPU, memory, disk,
|
||||
network, load, temperatures, per-container stats, and SMART/ZFS/GPU when
|
||||
available
|
||||
- **Incidents & status pages** — manual and automatic incidents, maintenance
|
||||
windows, public `/status/:slug` pages, SVG badges
|
||||
- **Alerts** — webhook, Slack, Discord, Telegram, Gotify, ntfy, and SMTP
|
||||
transports
|
||||
- **Observability** — Prometheus `/api/metrics`, JSON export, CSV bulk import,
|
||||
importers for Homepage, Homarr, and Dashy configs
|
||||
- **Optional auth** — local username/password with bcrypt + session cookies,
|
||||
off by default; public status pages stay open either way
|
||||
- **i18n + PWA** — English and Czech UI, installable manifest/service worker
|
||||
- **Service boards** — multiple boards, sections, drag-and-drop, multi-URL services, icon upload, four renderers (Bento, Cards, Index, Console), dark/light themes, custom accent/wallpaper/CSS.
|
||||
- **Uptime monitors** — HTTP, TCP, ping, DNS, keyword, JSON-path, and push checks on a schedule; heartbeat history, uptime graphs, per-monitor alert rules.
|
||||
- **Domain watch** — WHOIS/RDAP, DNS records, TLS certificate expiry, registrar and provider detection, CT-log subdomain discovery.
|
||||
- **System monitoring** — lightweight `dash-agent` pushes CPU, memory, disk, network, load, temperatures, per-container stats, and SMART/ZFS/GPU when available.
|
||||
- **Incidents & status pages** — automatic incidents on monitor down, maintenance windows, public `/status/:slug` pages, SVG badges.
|
||||
- **Alerts** — webhook, Slack, Discord, Telegram, Gotify, ntfy, and SMTP transports.
|
||||
- **Observability** — Prometheus `/api/metrics`, JSON export, CSV bulk import, importers for Homepage, Homarr, and Dashy configs.
|
||||
- **Optional auth** — local username/password, bcrypt + SQLite sessions, off by default; public status pages stay open either way.
|
||||
- **i18n + PWA** — English and Czech UI, installable manifest/service worker.
|
||||
|
||||
## Run
|
||||
## Architecture
|
||||
|
||||
```
|
||||
Browser ──▶ dash (single static Go binary)
|
||||
├── Embedded React UI (embed.FS)
|
||||
├── REST API (Gin) ──▶ SQLite
|
||||
└── Schedulers ──▶ monitors, domain refresh, alerts, retention
|
||||
│
|
||||
▼ outbound
|
||||
HTTP/TCP/ICMP/DNS, WHOIS/RDAP, TLS, SMTP
|
||||
|
||||
dash-agent (one binary per host) ──push JSON──▶ POST /api/systems/ingest
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
Prerequisites: Docker.
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/Dvorinka/Dash/main/install.sh | sh
|
||||
```
|
||||
|
||||
Installs into `./dash` and starts the stack on port 3000. Or from a clone:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/Dvorinka/Dash.git && cd Dash
|
||||
./scripts/setup.sh # builds the image and starts the stack
|
||||
```
|
||||
|
||||
Or plain `docker run`, no script needed:
|
||||
|
||||
```sh
|
||||
docker run -d -v ./data:/data -p 3000:3000 ghcr.io/dvorinka/dash:latest
|
||||
```
|
||||
|
||||
or with compose:
|
||||
Then open `http://localhost:3000` — everything is configured from the UI.
|
||||
For the system agent, binary installs, reverse proxies, and upgrades see
|
||||
[docs/installation.md](docs/installation.md).
|
||||
|
||||
```yaml
|
||||
services:
|
||||
dash:
|
||||
image: ghcr.io/dvorinka/dash:latest
|
||||
ports:
|
||||
- "3000:3000"
|
||||
volumes:
|
||||
- ./data:/data
|
||||
restart: unless-stopped
|
||||
```
|
||||
## Configuration
|
||||
|
||||
Then open http://localhost:3000. Everything is configured from the UI.
|
||||
Dash is configured from the UI; the server reads three environment
|
||||
variables (`DASH_PORT`, `DASH_DATA_DIR`, `DASH_DEV`). All state lives in one
|
||||
directory — a SQLite database plus uploaded icons. See
|
||||
[docs/configuration.md](docs/configuration.md).
|
||||
|
||||
## System agent
|
||||
|
||||
@@ -57,22 +110,16 @@ Monitor a Linux host: create a system in the UI, copy the token, then:
|
||||
dash-agent -url http://dash:3000 -token <token>
|
||||
```
|
||||
|
||||
One static binary, no dependencies. See
|
||||
[docs/installation.md](docs/installation.md) for systemd and Docker setups.
|
||||
One static binary, no dependencies. systemd unit and container image covered
|
||||
in [docs/installation.md](docs/installation.md#dash-agent-system-monitoring).
|
||||
|
||||
## Screenshots
|
||||
## Documentation
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
|  |  |
|
||||
|  |  |
|
||||
|
||||
## Docs
|
||||
|
||||
- [Installation](docs/installation.md)
|
||||
- [Configuration](docs/configuration.md)
|
||||
- [Widget development](docs/widgets.md)
|
||||
- [Roadmap](ROADMAP.md) · [Changelog](CHANGELOG.md) · [Contributing](CONTRIBUTING.md)
|
||||
- [docs/installation.md](docs/installation.md) — Docker, binary, agent, reverse proxy, upgrades
|
||||
- [docs/configuration.md](docs/configuration.md) — env vars, notifications, auth, boards, operations
|
||||
- [docs/widgets.md](docs/widgets.md) — widget development guide
|
||||
- `openapi.yaml` — API contract (generated TS client in `packages/api-client`)
|
||||
- [ROADMAP.md](ROADMAP.md) — design decisions and release history
|
||||
|
||||
## Develop
|
||||
|
||||
@@ -80,21 +127,21 @@ Requires Go 1.24+ and Node 20+.
|
||||
|
||||
```sh
|
||||
npm install # workspaces: frontend + api-client
|
||||
npm run generate # regenerate TS client from openapi.yaml
|
||||
npm run dev # vite dev on :5173, proxies /api to :8080
|
||||
```
|
||||
|
||||
In another shell:
|
||||
|
||||
```sh
|
||||
cd apps/backend
|
||||
DASH_DEV=1 go run ./cmd/dash # API on :8080 (DASH_DEV skips embedded UI)
|
||||
```
|
||||
|
||||
## Stack
|
||||
## Contributing
|
||||
|
||||
Go + Gin + SQLite (single static binary, embeds the frontend) · React 18 +
|
||||
Vite + TS strict + Tailwind + shadcn/ui + dnd-kit · OpenAPI-generated client.
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) for the development workflow.
|
||||
|
||||
## Security
|
||||
|
||||
See [SECURITY.md](SECURITY.md) for reporting vulnerabilities.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in new issue
Block a user