Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
94ffa9e930 | ||
|
|
491c0a9c7c | ||
|
|
1d51c5c887 | ||
|
|
2c84a4c9c2 | ||
|
|
6ab3054d9a | ||
|
|
7549658fbb | ||
|
|
d980e68577 | ||
|
|
5a33218235 | ||
|
|
39e0eaf256 | ||
|
|
9c3afb31af | ||
|
|
cbfdb92be4 | ||
|
|
8c87680078 | ||
|
|
e14fbc9205 | ||
|
|
813cad613e | ||
|
|
ffb70ecddf | ||
|
|
aa657419ca | ||
|
|
4308169608 |
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2026 Sebastian Krüger
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -1,20 +1,25 @@
|
||||
# PulseNode
|
||||
|
||||
A self-hosted infrastructure dashboard: system stats, Docker containers,
|
||||
databases, and HTTP/Traefik health, configured entirely through a YAML file
|
||||
and pushed to the browser live over WebSockets. No database of its own -
|
||||
`config.yml` is the source of truth, metrics are ephemeral.
|
||||
databases, HTTP checks, and combined docker+API service widgets, configured
|
||||
entirely through a YAML file and pushed to the browser live over WebSockets.
|
||||
No database of its own - `config.yml` is the source of truth, metrics are
|
||||
ephemeral.
|
||||
|
||||
## Features
|
||||
|
||||
- **YAML-configured** widgets and layout, hot-reloaded - edit `config.yml`
|
||||
and connected browsers update without a page refresh
|
||||
- **Secrets via `.env`**, interpolated into `config.yml` at load time
|
||||
(`${VAR}` / `${VAR:-default}`), never sent to the browser
|
||||
(`${VAR}` / `${VAR:-default}`). Widget fields named `apiToken`/`apiKey`/
|
||||
`password` are stripped before the config ever reaches the browser
|
||||
(`lib/config/public.ts`) - collectors run server-side and use the real
|
||||
values, the client never sees them
|
||||
- **Live updates over WebSocket** - each widget subscribes to its own topic;
|
||||
the server only serializes results for widgets someone is actually viewing
|
||||
- **Widget types**: Docker containers, Postgres/Redis instances, system
|
||||
resources, HTTP health checks, Traefik router status, bookmarks, search
|
||||
resources, HTTP health checks, combined docker+API service widgets
|
||||
(Gitea, Coolify, Immich, n8n, Umami, Headscale, Traefik), bookmarks, search
|
||||
- **Optional label-based auto-discovery** - containers carrying
|
||||
`traefik.enable=true` can be turned into dashboard widgets automatically;
|
||||
manual `config.yml` entries always take precedence
|
||||
@@ -54,8 +59,8 @@ settings:
|
||||
|
||||
theme:
|
||||
mode: dark # dark | light | auto
|
||||
variables:
|
||||
--pn-accent: "#38bdf8"
|
||||
# variables: # override any --pn-* token from app/globals.css
|
||||
# --pn-accent: "#ff6b6b"
|
||||
# customCssPath: custom.css # relative to config/, served at /api/theme/custom-css
|
||||
|
||||
discovery:
|
||||
@@ -64,13 +69,20 @@ discovery:
|
||||
network: falcon_network # only include containers on this docker network
|
||||
|
||||
groups:
|
||||
- name: Core Infra
|
||||
- name: Infra
|
||||
widgets:
|
||||
- type: docker
|
||||
- type: system
|
||||
interval: 5s
|
||||
|
||||
- name: Services
|
||||
widgets:
|
||||
- type: service
|
||||
service: traefik
|
||||
name: Traefik
|
||||
containerName: traefik
|
||||
icon: traefik
|
||||
href: https://traefik.example.com
|
||||
interval: 10s
|
||||
interval: 15s
|
||||
```
|
||||
|
||||
Config errors are **non-destructive**: if `config.yml` fails validation
|
||||
@@ -87,16 +99,40 @@ reload; never exposed to the client. See `config/.env.example`.
|
||||
|
||||
| `type` | Required fields | Notes |
|
||||
|------------|-------------------------------------|-------|
|
||||
| `bookmark` | `name`, `href` | Static link card. Optional `description`. |
|
||||
| `bookmark` | `name`, `href` | Static link card. Optional `description`, `icon` (see below). |
|
||||
| `search` | - | Client-side search box. Optional `engines` (`duckduckgo`/`google`/`bing`, default `[duckduckgo]`), `defaultEngine`. |
|
||||
| `docker` | `name`, `containerName` | Status, uptime, CPU/mem, restart count via `dockerode`. Optional `href`, `showStats` (default `true`), `interval` (default `5s`). |
|
||||
| `docker` | `name`, `containerName` | Status, uptime, CPU/mem, restart count via `dockerode`. Optional `href`, `icon` (see below), `showStats` (default `true`), `interval` (default `5s`). |
|
||||
| `database` | `name`, `containerName`, `engine` | Thin skin over the same Docker collector - `engine` is `postgres` or `redis`, used for icon/label only. `interval` default `10s`. |
|
||||
| `system` | - | Host CPU/mem/disk/network via `systeminformation`. Optional `name` (default `System`), `interval` (default `5s`). |
|
||||
| `http` | `name`, `url` | HTTP health check with latency and consecutive-failure tracking. Optional `method` (default `GET`), `timeout` (default `5s`), `interval` (default `30s`), `expect.status` (default `200`). |
|
||||
| `traefik` | `apiUrl` | Router/entrypoint/middleware status from Traefik's own API (`--api.dashboard=true` must be enabled). Optional `name` (default `Traefik`), `interval` (default `15s`). |
|
||||
| `service` | `name`, `containerName`, `service` | Docker health/CPU/mem (same collector as `docker`) merged with a stat pulled from the service's own API. `service` picks the variant (see below) and its extra fields. A failed API call surfaces as a non-fatal `statError` on the card without hiding docker health. Optional `href`, `icon`, `showStats` (default `true`), `interval` (default `15s`). |
|
||||
|
||||
`interval`/`timeout` values are duration strings: `500ms`, `5s`, `1m`, `1h`.
|
||||
|
||||
#### `service` variants
|
||||
|
||||
Each `service` widget calls its target container directly by name on the
|
||||
docker network (`http://<containerName>:<port>`), not through Traefik/TLS -
|
||||
no `apiUrl` field needed.
|
||||
|
||||
| `service` | Extra fields | Stat shown |
|
||||
|-------------|--------------------------------------------|------------|
|
||||
| `gitea` | `username` (default `Valknar`), `apiToken` | Repository count |
|
||||
| `coolify` | `apiToken` | Project count, resource count |
|
||||
| `immich` | `apiKey` | Photo count, video count |
|
||||
| `n8n` | `apiKey` | Workflow count |
|
||||
| `umami` | `username`, `password`, `websiteId` | Active visitors (login-and-cache, self-hosted has no static API key) |
|
||||
| `headscale` | `apiToken` | User count, node count |
|
||||
| `traefik` | - | HTTP router count (needs `--api.insecure=true` or a dashboard entrypoint reachable on the docker network) |
|
||||
|
||||
`icon` on `docker`/`bookmark` widgets is a key into `lib/brand-icons.ts` (currently
|
||||
`traefik`, `coolify`, `gitea`, `docker`, `immich`, `n8n`, `passbolt`, `umami`,
|
||||
`postgresql`, `redis`, `headscale`), rendered monochrome so it doesn't compete
|
||||
with the accent color. `database` widgets pick their icon automatically from
|
||||
`engine`. Regenerate/extend the icon set with `python3 scripts/extract-brand-icons.py`
|
||||
after adding an entry to that script's `ICONS` map (path data comes from the
|
||||
CC0-licensed `simple-icons` package, bundled at build time - no runtime CDN calls).
|
||||
|
||||
### Auto-discovery
|
||||
|
||||
With `discovery.docker.enabled: true`, PulseNode scans running containers
|
||||
@@ -139,8 +175,10 @@ server.ts custom server: http + WebSocket (/ws) + collector schedul
|
||||
app/ Next.js App Router pages and API routes
|
||||
components/widgets/ one folder per widget type (Widget.tsx + shared Skeleton/StatusDot)
|
||||
components/layout/ Dashboard shell, theme toggle, brand mark
|
||||
lib/config/ schema (zod), loader (parse/interpolate/watch), effective (+ discovery merge)
|
||||
lib/collectors/ docker, system, http, traefik collectors + the scheduler
|
||||
lib/config/ schema (zod), loader (parse/interpolate/watch), effective (+ discovery merge),
|
||||
public.ts (strips secrets before the config reaches the browser)
|
||||
lib/collectors/ docker, system, http collectors, service.ts (docker+API merge) with
|
||||
one collector per service under services/, + the scheduler
|
||||
lib/discovery/ traefik-label auto-discovery
|
||||
lib/ws/ WebSocket server (topics) and the browser-side subscription hooks
|
||||
```
|
||||
@@ -154,3 +192,7 @@ lib/ws/ WebSocket server (topics) and the browser-side subscripti
|
||||
runs in - for true host-level stats rather than the container's own view,
|
||||
mount `/proc` and `/sys` from the host and run with `pid: host` (not
|
||||
configured by default).
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE)
|
||||
|
||||
+17
-5
@@ -7,8 +7,8 @@
|
||||
--pn-fg: #f2f4f5;
|
||||
--pn-fg-muted: color-mix(in srgb, var(--pn-fg) 55%, transparent);
|
||||
--pn-border: color-mix(in srgb, var(--pn-fg) 14%, transparent);
|
||||
--pn-accent: #5ee08c;
|
||||
--pn-status-up: #5ee08c;
|
||||
--pn-accent: #39ff88;
|
||||
--pn-status-up: #39ff88;
|
||||
--pn-status-down: #ff5f6d;
|
||||
--pn-status-degraded: #ffb84c;
|
||||
--pn-shadow-sm: 0 0 0 1px var(--pn-border);
|
||||
@@ -133,8 +133,22 @@ body {
|
||||
animation: pulse-glow 2s ease-in-out infinite;
|
||||
}
|
||||
|
||||
@keyframes pulse-glow-down {
|
||||
0%,
|
||||
100% {
|
||||
box-shadow: 0 0 0 0 color-mix(in srgb, var(--pn-status-down) 55%, transparent);
|
||||
}
|
||||
50% {
|
||||
box-shadow: 0 0 0 4px color-mix(in srgb, var(--pn-status-down) 0%, transparent);
|
||||
}
|
||||
}
|
||||
.status-pulse-down {
|
||||
animation: pulse-glow-down 2s ease-in-out infinite;
|
||||
}
|
||||
|
||||
@media (prefers-reduced-motion: reduce) {
|
||||
.status-pulse,
|
||||
.status-pulse-down,
|
||||
.pn-toast,
|
||||
.pn-spin-in {
|
||||
animation: none;
|
||||
@@ -144,6 +158,7 @@ body {
|
||||
.pn-bento {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(12, 1fr);
|
||||
grid-auto-flow: dense;
|
||||
}
|
||||
|
||||
@media (max-width: 860px) {
|
||||
@@ -154,7 +169,4 @@ body {
|
||||
grid-column: 1 / -1 !important;
|
||||
grid-row: auto !important;
|
||||
}
|
||||
.pn-live-label {
|
||||
display: none !important;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,55 @@
|
||||
import Link from "next/link";
|
||||
import type { Metadata } from "next";
|
||||
|
||||
export const metadata: Metadata = {
|
||||
title: "Not Found",
|
||||
description: "No pulse on this route.",
|
||||
};
|
||||
|
||||
export default function NotFound() {
|
||||
return (
|
||||
<main className="flex min-h-screen flex-col items-center justify-center gap-8 px-6 text-center">
|
||||
<svg
|
||||
width="320"
|
||||
height="64"
|
||||
viewBox="0 0 320 64"
|
||||
fill="none"
|
||||
aria-hidden="true"
|
||||
className="w-full max-w-[320px]"
|
||||
>
|
||||
<polyline
|
||||
points="0,32 30,32 40,10 50,54 60,24 72,32 140,32"
|
||||
fill="none"
|
||||
stroke="var(--pn-accent)"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
/>
|
||||
<line
|
||||
x1="140"
|
||||
y1="32"
|
||||
x2="300"
|
||||
y2="32"
|
||||
stroke="var(--pn-status-down)"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
opacity="0.55"
|
||||
/>
|
||||
<circle cx="300" cy="32" r="4" fill="var(--pn-status-down)" className="status-pulse-down" />
|
||||
</svg>
|
||||
|
||||
<div className="flex flex-col gap-3">
|
||||
<p className="font-display text-7xl font-semibold tracking-tight text-fg">404</p>
|
||||
<p className="text-base font-medium text-fg">No pulse on this route.</p>
|
||||
<p className="text-sm text-fg-muted">Nothing here is being monitored.</p>
|
||||
</div>
|
||||
|
||||
<Link
|
||||
href="/"
|
||||
className="rounded-md border border-border px-4 py-2 text-sm font-medium text-fg transition-colors hover:border-accent hover:text-accent"
|
||||
>
|
||||
Back to dashboard
|
||||
</Link>
|
||||
</main>
|
||||
);
|
||||
}
|
||||
+2
-1
@@ -1,5 +1,6 @@
|
||||
import { ConfigError } from "@/lib/config/loader";
|
||||
import { effectiveConfigStore } from "@/lib/config/effective";
|
||||
import { toPublicConfig } from "@/lib/config/public";
|
||||
import { Dashboard } from "@/components/layout/Dashboard";
|
||||
|
||||
export const dynamic = "force-dynamic";
|
||||
@@ -20,5 +21,5 @@ export default function Home() {
|
||||
);
|
||||
}
|
||||
|
||||
return <Dashboard config={config} />;
|
||||
return <Dashboard config={toPublicConfig(config)} />;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
import { GlobeSimple } from "@phosphor-icons/react/ssr";
|
||||
import { BRAND_ICON_PATHS } from "@/lib/brand-icons";
|
||||
|
||||
// Generic (non-brand) icons that don't belong in BRAND_ICON_PATHS - for
|
||||
// widgets that link to something with no single logo of its own.
|
||||
const GENERIC_ICONS = {
|
||||
globe: GlobeSimple,
|
||||
};
|
||||
|
||||
export function BrandIcon({ slug, size = 18 }: { slug?: string; size?: number }) {
|
||||
if (!slug) return null;
|
||||
|
||||
const GenericIcon = GENERIC_ICONS[slug as keyof typeof GENERIC_ICONS];
|
||||
if (GenericIcon) {
|
||||
return <GenericIcon size={size} className="shrink-0 text-fg-muted" aria-hidden />;
|
||||
}
|
||||
|
||||
const path = BRAND_ICON_PATHS[slug];
|
||||
if (!path) return null;
|
||||
|
||||
return (
|
||||
<svg width={size} height={size} viewBox="0 0 24 24" fill="currentColor" className="shrink-0 text-fg-muted" aria-hidden>
|
||||
<path d={path} />
|
||||
</svg>
|
||||
);
|
||||
}
|
||||
@@ -1,10 +1,42 @@
|
||||
import { ArrowUpRight } from "@phosphor-icons/react/ssr";
|
||||
import type { Widget } from "@/lib/config/schema";
|
||||
import { PN_CARD_CLASS } from "@/components/widgets/WidgetCard";
|
||||
import { BrandIcon } from "@/components/widgets/BrandIcon";
|
||||
|
||||
type BookmarkWidget = Extract<Widget, { type: "bookmark" }>;
|
||||
|
||||
export function BookmarkWidget({ widget }: { widget: BookmarkWidget }) {
|
||||
if (widget.links && widget.links.length > 0) {
|
||||
return (
|
||||
<div className={PN_CARD_CLASS} style={{ gridColumn: "span 4", gridRow: "span 2" }}>
|
||||
<div className="flex items-center gap-2">
|
||||
<BrandIcon slug={widget.icon} />
|
||||
<span className="min-w-0 flex-1 truncate text-[15px] font-medium text-fg">{widget.name}</span>
|
||||
</div>
|
||||
{widget.description && <span className="text-xs text-fg-muted">{widget.description}</span>}
|
||||
<div className="-mx-1 flex min-h-0 flex-1 flex-col divide-y divide-border overflow-y-auto">
|
||||
{widget.links.map((link) => (
|
||||
<a
|
||||
key={link.href}
|
||||
href={link.href}
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
className="group flex items-center gap-2 px-1 py-1.5 text-sm text-fg-muted no-underline hover:text-accent"
|
||||
>
|
||||
<BrandIcon slug={link.icon} size={14} />
|
||||
<span className="min-w-0 flex-1 truncate">{link.name}</span>
|
||||
<ArrowUpRight
|
||||
size={13}
|
||||
className="shrink-0 text-accent opacity-0 group-hover:opacity-100"
|
||||
aria-hidden
|
||||
/>
|
||||
</a>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
return (
|
||||
<a
|
||||
href={widget.href}
|
||||
@@ -14,8 +46,9 @@ export function BookmarkWidget({ widget }: { widget: BookmarkWidget }) {
|
||||
style={{ gridColumn: "span 3" }}
|
||||
>
|
||||
<div className="flex items-center gap-2">
|
||||
<span className="flex-1 text-[15px] font-medium text-fg">{widget.name}</span>
|
||||
<ArrowUpRight size={16} className="text-accent" aria-hidden />
|
||||
<BrandIcon slug={widget.icon} />
|
||||
<span className="min-w-0 flex-1 truncate text-[15px] font-medium text-fg">{widget.name}</span>
|
||||
<ArrowUpRight size={16} className="shrink-0 text-accent" aria-hidden />
|
||||
</div>
|
||||
{widget.description && <span className="text-xs text-fg-muted">{widget.description}</span>}
|
||||
</a>
|
||||
|
||||
@@ -4,6 +4,7 @@ import type { Widget } from "@/lib/config/schema";
|
||||
import { useWidgetSubscription } from "@/lib/ws/client";
|
||||
import { StatusDot } from "@/components/widgets/StatusDot";
|
||||
import { WidgetCard } from "@/components/widgets/WidgetCard";
|
||||
import { BrandIcon } from "@/components/widgets/BrandIcon";
|
||||
import { formatUptime } from "@/lib/format";
|
||||
|
||||
type DatabaseWidget = Extract<Widget, { type: "database" }>;
|
||||
@@ -13,6 +14,11 @@ const ENGINE_LABEL: Record<DatabaseWidget["engine"], string> = {
|
||||
redis: "Redis",
|
||||
};
|
||||
|
||||
const ENGINE_ICON: Record<DatabaseWidget["engine"], string> = {
|
||||
postgres: "postgresql",
|
||||
redis: "redis",
|
||||
};
|
||||
|
||||
export function DatabaseWidget({ widget, widgetId }: { widget: DatabaseWidget; widgetId: string }) {
|
||||
const result = useWidgetSubscription(widgetId);
|
||||
const data = result?.type === "database" ? result.data : null;
|
||||
@@ -21,7 +27,10 @@ export function DatabaseWidget({ widget, widgetId }: { widget: DatabaseWidget; w
|
||||
return (
|
||||
<WidgetCard span={4}>
|
||||
<div className="flex items-center justify-between gap-2">
|
||||
<span className="text-[15px] font-medium text-fg">{widget.name}</span>
|
||||
<div className="flex min-w-0 items-center gap-2">
|
||||
<BrandIcon slug={ENGINE_ICON[widget.engine]} />
|
||||
<span className="truncate text-[15px] font-medium text-fg">{widget.name}</span>
|
||||
</div>
|
||||
<StatusDot status={data?.status} health={data?.health} />
|
||||
</div>
|
||||
<span className="text-[11px] text-fg-muted">{ENGINE_LABEL[widget.engine]}</span>
|
||||
|
||||
@@ -6,6 +6,7 @@ import { StatusDot } from "@/components/widgets/StatusDot";
|
||||
import { SkeletonLines } from "@/components/widgets/Skeleton";
|
||||
import { WidgetCard } from "@/components/widgets/WidgetCard";
|
||||
import { MetricBar } from "@/components/widgets/MetricBar";
|
||||
import { BrandIcon } from "@/components/widgets/BrandIcon";
|
||||
import { formatBytes, formatUptime } from "@/lib/format";
|
||||
|
||||
type DockerWidget = Extract<Widget, { type: "docker" }>;
|
||||
@@ -19,18 +20,21 @@ export function DockerWidget({ widget, widgetId }: { widget: DockerWidget; widge
|
||||
return (
|
||||
<WidgetCard span={4}>
|
||||
<div className="flex items-center justify-between gap-2">
|
||||
{widget.href ? (
|
||||
<a
|
||||
href={widget.href}
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
className="text-[15px] font-medium text-fg hover:text-accent"
|
||||
>
|
||||
{widget.name}
|
||||
</a>
|
||||
) : (
|
||||
<span className="text-[15px] font-medium text-fg">{widget.name}</span>
|
||||
)}
|
||||
<div className="flex min-w-0 items-center gap-2">
|
||||
<BrandIcon slug={widget.icon} />
|
||||
{widget.href ? (
|
||||
<a
|
||||
href={widget.href}
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
className="truncate text-[15px] font-medium text-fg hover:text-accent"
|
||||
>
|
||||
{widget.name}
|
||||
</a>
|
||||
) : (
|
||||
<span className="truncate text-[15px] font-medium text-fg">{widget.name}</span>
|
||||
)}
|
||||
</div>
|
||||
<StatusDot status={data?.status} health={data?.health} />
|
||||
</div>
|
||||
{errorMessage && <span className="text-xs text-status-down">{errorMessage}</span>}
|
||||
|
||||
@@ -6,7 +6,7 @@ import { DockerWidget } from "./docker/Widget";
|
||||
import { DatabaseWidget } from "./database/Widget";
|
||||
import { SystemWidget } from "./system/Widget";
|
||||
import { HttpWidget } from "./http/Widget";
|
||||
import { TraefikWidget } from "./traefik/Widget";
|
||||
import { ServiceWidget } from "./service/Widget";
|
||||
|
||||
type WidgetComponent<T extends Widget["type"]> = ComponentType<{
|
||||
widget: Extract<Widget, { type: T }>;
|
||||
@@ -20,5 +20,5 @@ export const widgetRegistry: { [K in Widget["type"]]: WidgetComponent<K> } = {
|
||||
database: DatabaseWidget,
|
||||
system: SystemWidget,
|
||||
http: HttpWidget,
|
||||
traefik: TraefikWidget,
|
||||
service: ServiceWidget,
|
||||
};
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
"use client";
|
||||
|
||||
import type { Widget } from "@/lib/config/schema";
|
||||
import { useWidgetSubscription } from "@/lib/ws/client";
|
||||
import { StatusDot } from "@/components/widgets/StatusDot";
|
||||
import { StatusTag } from "@/components/widgets/StatusTag";
|
||||
import { SkeletonLines } from "@/components/widgets/Skeleton";
|
||||
import { WidgetCard } from "@/components/widgets/WidgetCard";
|
||||
import { MetricBar } from "@/components/widgets/MetricBar";
|
||||
import { BrandIcon } from "@/components/widgets/BrandIcon";
|
||||
import { formatBytes, formatUptime } from "@/lib/format";
|
||||
|
||||
type ServiceWidget = Extract<Widget, { type: "service" }>;
|
||||
|
||||
export function ServiceWidget({ widget, widgetId }: { widget: ServiceWidget; widgetId: string }) {
|
||||
const result = useWidgetSubscription(widgetId);
|
||||
const data = result?.type === "service" ? result.data : null;
|
||||
const errorMessage = result?.type === "error" ? result.message : null;
|
||||
const memPercent =
|
||||
data?.docker.memUsageBytes != null && data.docker.memLimitBytes
|
||||
? (data.docker.memUsageBytes / data.docker.memLimitBytes) * 100
|
||||
: null;
|
||||
|
||||
return (
|
||||
<WidgetCard span={4}>
|
||||
<div className="flex items-center justify-between gap-2">
|
||||
<div className="flex min-w-0 items-center gap-2">
|
||||
<BrandIcon slug={widget.icon} />
|
||||
{widget.href ? (
|
||||
<a
|
||||
href={widget.href}
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
className="truncate text-[15px] font-medium text-fg hover:text-accent"
|
||||
>
|
||||
{widget.name}
|
||||
</a>
|
||||
) : (
|
||||
<span className="truncate text-[15px] font-medium text-fg">{widget.name}</span>
|
||||
)}
|
||||
</div>
|
||||
<StatusDot status={data?.docker.status} health={data?.docker.health} />
|
||||
</div>
|
||||
{errorMessage && <span className="text-xs text-status-down">{errorMessage}</span>}
|
||||
{!result && !errorMessage && <SkeletonLines count={3} />}
|
||||
{data && (
|
||||
<>
|
||||
{data.stats.length > 0 && (
|
||||
<div className="flex items-start gap-4">
|
||||
{data.stats.map((stat, index) => (
|
||||
<div
|
||||
key={stat.label}
|
||||
className={`flex flex-col gap-0.5 ${index > 0 ? "border-l border-border pl-4" : ""}`}
|
||||
>
|
||||
<span className="font-mono text-2xl leading-none font-semibold tabular-nums text-accent">
|
||||
{stat.value}
|
||||
</span>
|
||||
<span className="text-[10px] tracking-wide text-fg-muted uppercase">{stat.label}</span>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
{data.statError && <StatusTag tone="degraded">{data.statError}</StatusTag>}
|
||||
{widget.showStats && data.docker.cpuPercent !== null && memPercent !== null && (
|
||||
<div className="mt-0.5 flex gap-4">
|
||||
<MetricBar label="CPU" percent={data.docker.cpuPercent} detail={`${data.docker.cpuPercent.toFixed(1)}%`} />
|
||||
<MetricBar label="MEM" percent={memPercent} detail={`${memPercent.toFixed(0)}%`} />
|
||||
</div>
|
||||
)}
|
||||
<div className="flex items-center gap-3 text-[11px] text-fg-muted">
|
||||
{data.docker.uptimeSeconds !== null && <span>up {formatUptime(data.docker.uptimeSeconds)}</span>}
|
||||
{widget.showStats && data.docker.memUsageBytes !== null && memPercent === null && (
|
||||
<span className="font-mono tabular-nums">{formatBytes(data.docker.memUsageBytes)}</span>
|
||||
)}
|
||||
{data.docker.restartCount > 0 && <span>{data.docker.restartCount} restarts</span>}
|
||||
</div>
|
||||
</>
|
||||
)}
|
||||
</WidgetCard>
|
||||
);
|
||||
}
|
||||
@@ -19,7 +19,7 @@ export function SystemWidget({ widget, widgetId }: { widget: SystemWidget; widge
|
||||
const errorMessage = result?.type === "error" ? result.message : null;
|
||||
|
||||
return (
|
||||
<WidgetCard span={5} rowSpan={2}>
|
||||
<WidgetCard span={4} rowSpan={2}>
|
||||
<div className="text-[10px] tracking-[0.1em] text-accent uppercase">System</div>
|
||||
<span className="text-[15px] font-medium text-fg">{widget.name}</span>
|
||||
{errorMessage && <span className="text-xs text-status-down">{errorMessage}</span>}
|
||||
|
||||
@@ -1,53 +0,0 @@
|
||||
"use client";
|
||||
|
||||
import { Lock } from "@phosphor-icons/react/ssr";
|
||||
import type { Widget } from "@/lib/config/schema";
|
||||
import { useWidgetSubscription } from "@/lib/ws/client";
|
||||
import { SkeletonLines } from "@/components/widgets/Skeleton";
|
||||
import { WidgetCard } from "@/components/widgets/WidgetCard";
|
||||
|
||||
type TraefikWidget = Extract<Widget, { type: "traefik" }>;
|
||||
|
||||
export function TraefikWidget({ widget, widgetId }: { widget: TraefikWidget; widgetId: string }) {
|
||||
const result = useWidgetSubscription(widgetId);
|
||||
const data = result?.type === "traefik" ? result.data : null;
|
||||
const errorMessage = result?.type === "error" ? result.message : null;
|
||||
|
||||
return (
|
||||
<WidgetCard span={4}>
|
||||
<div className="flex items-center justify-between">
|
||||
<span className="text-[15px] font-medium text-fg">{widget.name}</span>
|
||||
{data && (
|
||||
<span className="font-mono text-[11px] tabular-nums text-fg-muted">
|
||||
{data.entrypoints.map((ep) => ep.address).join(" · ") || `${data.entrypoints.length} entrypoints`}
|
||||
</span>
|
||||
)}
|
||||
</div>
|
||||
{errorMessage && <span className="text-xs text-status-down">{errorMessage}</span>}
|
||||
{!result && !errorMessage && <SkeletonLines count={3} />}
|
||||
{data && (
|
||||
<div className="flex flex-col">
|
||||
{data.routers.map((router) => (
|
||||
<div key={router.name} className="flex items-center justify-between gap-2 border-t border-border py-1.5 text-[13px] first:border-t-0">
|
||||
<span className="truncate text-fg" title={router.rule}>
|
||||
{router.name.replace(/@.*$/, "")}
|
||||
</span>
|
||||
<span className="flex items-center gap-1.5 text-[11px] text-fg-muted">
|
||||
{router.tls && <Lock size={11} aria-label="TLS enabled" />}
|
||||
<span
|
||||
className={`flex items-center gap-1.5 ${router.status === "enabled" ? "text-status-up" : "text-status-down"}`}
|
||||
>
|
||||
<span className="h-1.5 w-1.5 rounded-full bg-current" />
|
||||
{router.status}
|
||||
</span>
|
||||
</span>
|
||||
</div>
|
||||
))}
|
||||
<span className="pt-2 text-[11px] text-fg-muted">
|
||||
<span className="font-mono tabular-nums">{data.middlewaresCount}</span> middlewares
|
||||
</span>
|
||||
</div>
|
||||
)}
|
||||
</WidgetCard>
|
||||
);
|
||||
}
|
||||
+10
-2
@@ -3,8 +3,6 @@ settings:
|
||||
|
||||
theme:
|
||||
mode: dark
|
||||
variables:
|
||||
--pn-accent: "#38bdf8"
|
||||
|
||||
# Manual widgets below always take precedence over an auto-discovered one for
|
||||
# the same container - this is on as a safety net for anything added to
|
||||
@@ -21,6 +19,7 @@ groups:
|
||||
- type: docker
|
||||
name: Traefik
|
||||
containerName: traefik
|
||||
icon: traefik
|
||||
interval: 10s
|
||||
# No href: the dashboard is disabled (--api.dashboard=false).
|
||||
# Swap for a `traefik` widget (router/entrypoint/middleware view)
|
||||
@@ -29,6 +28,7 @@ groups:
|
||||
- type: docker
|
||||
name: Coolify
|
||||
containerName: coolify
|
||||
icon: coolify
|
||||
href: https://${TRAEFIK_HOST_COOLIFY}
|
||||
interval: 10s
|
||||
|
||||
@@ -37,12 +37,14 @@ groups:
|
||||
- type: docker
|
||||
name: Gitea
|
||||
containerName: gitea
|
||||
icon: gitea
|
||||
href: https://${TRAEFIK_HOST_GITEA}
|
||||
interval: 10s
|
||||
|
||||
- type: docker
|
||||
name: Gitea Runner
|
||||
containerName: gitea_runner
|
||||
icon: gitea
|
||||
showStats: true
|
||||
interval: 15s
|
||||
|
||||
@@ -57,35 +59,41 @@ groups:
|
||||
- type: docker
|
||||
name: Immich
|
||||
containerName: immich
|
||||
icon: immich
|
||||
href: https://${TRAEFIK_HOST_IMMICH}
|
||||
interval: 10s
|
||||
|
||||
- type: docker
|
||||
name: Immich ML
|
||||
containerName: immich_ml
|
||||
icon: immich
|
||||
interval: 15s
|
||||
|
||||
- type: docker
|
||||
name: n8n
|
||||
containerName: n8n
|
||||
icon: n8n
|
||||
href: https://${TRAEFIK_HOST_N8N}
|
||||
interval: 10s
|
||||
|
||||
- type: docker
|
||||
name: Passbolt
|
||||
containerName: passbolt
|
||||
icon: passbolt
|
||||
href: https://${TRAEFIK_HOST_PASSBOLT}
|
||||
interval: 10s
|
||||
|
||||
- type: docker
|
||||
name: Umami
|
||||
containerName: umami
|
||||
icon: umami
|
||||
href: https://${TRAEFIK_HOST_UMAMI}
|
||||
interval: 10s
|
||||
|
||||
- type: docker
|
||||
name: Headscale
|
||||
containerName: headscale
|
||||
icon: headscale
|
||||
href: https://${TRAEFIK_HOST_HEADSCALE}
|
||||
interval: 10s
|
||||
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -1,11 +1,14 @@
|
||||
import Docker from "dockerode";
|
||||
import type { ContainerStats } from "dockerode";
|
||||
import pLimit from "p-limit";
|
||||
import type { DockerContainerResult } from "@/lib/types/widget-result";
|
||||
|
||||
const docker = new Docker({
|
||||
socketPath: process.env.DOCKER_SOCKET_PATH ?? "/var/run/docker.sock",
|
||||
});
|
||||
|
||||
export const dockerLimit = pLimit(4);
|
||||
|
||||
function calcCpuPercent(stats: ContainerStats): number | null {
|
||||
const cpuDelta = stats.cpu_stats.cpu_usage.total_usage - stats.precpu_stats.cpu_usage.total_usage;
|
||||
const systemDelta = stats.cpu_stats.system_cpu_usage - stats.precpu_stats.system_cpu_usage;
|
||||
|
||||
@@ -2,13 +2,12 @@ import pLimit from "p-limit";
|
||||
import type { Config, Widget } from "@/lib/config/schema";
|
||||
import { flattenWidgets } from "@/lib/config/widgets";
|
||||
import { parseDuration } from "@/lib/config/duration";
|
||||
import { collectDockerContainer } from "./docker";
|
||||
import { collectDockerContainer, dockerLimit } from "./docker";
|
||||
import { collectSystem } from "./system";
|
||||
import { collectHttp } from "./http";
|
||||
import { collectTraefik } from "./traefik";
|
||||
import { collectService } from "./service";
|
||||
import type { WidgetResult } from "@/lib/types/widget-result";
|
||||
|
||||
const dockerLimit = pLimit(4);
|
||||
const httpLimit = pLimit(8);
|
||||
|
||||
type ResultListener = (widgetId: string, result: WidgetResult) => void;
|
||||
@@ -20,7 +19,7 @@ interface Job {
|
||||
consecutiveFailures: number;
|
||||
}
|
||||
|
||||
const COLLECTOR_TYPES = new Set<Widget["type"]>(["docker", "database", "system", "http", "traefik"]);
|
||||
const COLLECTOR_TYPES = new Set<Widget["type"]>(["docker", "database", "system", "http", "service"]);
|
||||
|
||||
function isCollectorWidget(widget: Widget): boolean {
|
||||
return COLLECTOR_TYPES.has(widget.type);
|
||||
@@ -32,7 +31,7 @@ function getIntervalMs(widget: Widget): number {
|
||||
widget.type === "database" ||
|
||||
widget.type === "system" ||
|
||||
widget.type === "http" ||
|
||||
widget.type === "traefik"
|
||||
widget.type === "service"
|
||||
) {
|
||||
return parseDuration(widget.interval);
|
||||
}
|
||||
@@ -52,8 +51,8 @@ function sameTarget(a: Widget, b: Widget): boolean {
|
||||
if (a.type === "http" && b.type === "http") {
|
||||
return a.url === b.url && a.method === b.method && a.expect.status === b.expect.status;
|
||||
}
|
||||
if (a.type === "traefik" && b.type === "traefik") {
|
||||
return a.apiUrl === b.apiUrl;
|
||||
if (a.type === "service" && b.type === "service") {
|
||||
return a.containerName === b.containerName && a.service === b.service && a.showStats === b.showStats;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
@@ -77,9 +76,9 @@ async function collect(widget: Widget): Promise<WidgetResult> {
|
||||
);
|
||||
return { type: "http", data: { ...data, consecutiveFailures: 0 } };
|
||||
}
|
||||
if (widget.type === "traefik") {
|
||||
const data = await collectTraefik(widget.apiUrl);
|
||||
return { type: "traefik", data };
|
||||
if (widget.type === "service") {
|
||||
const data = await collectService(widget);
|
||||
return { type: "service", data };
|
||||
}
|
||||
throw new Error(`No collector for widget type "${widget.type}"`);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
import type { ServiceWidget } from "@/lib/config/schema";
|
||||
import type { ServiceStat, ServiceWidgetResult } from "@/lib/types/service-result";
|
||||
import { collectDockerContainer, dockerLimit } from "./docker";
|
||||
import { collectGitea } from "./services/gitea";
|
||||
import { collectCoolify } from "./services/coolify";
|
||||
import { collectImmich } from "./services/immich";
|
||||
import { collectN8n } from "./services/n8n";
|
||||
import { collectUmami } from "./services/umami";
|
||||
import { collectHeadscale } from "./services/headscale";
|
||||
import { collectTraefikStat } from "./services/traefik";
|
||||
|
||||
function collectServiceStat(widget: ServiceWidget): Promise<{ stats: ServiceStat[] }> {
|
||||
switch (widget.service) {
|
||||
case "gitea":
|
||||
return collectGitea(widget);
|
||||
case "coolify":
|
||||
return collectCoolify(widget);
|
||||
case "immich":
|
||||
return collectImmich(widget);
|
||||
case "n8n":
|
||||
return collectN8n(widget);
|
||||
case "umami":
|
||||
return collectUmami(widget);
|
||||
case "headscale":
|
||||
return collectHeadscale(widget);
|
||||
case "traefik":
|
||||
return collectTraefikStat(widget);
|
||||
}
|
||||
}
|
||||
|
||||
export async function collectService(widget: ServiceWidget): Promise<ServiceWidgetResult> {
|
||||
const dockerPromise = dockerLimit(() => collectDockerContainer(widget.containerName, widget.showStats));
|
||||
|
||||
// A failed service-API call (bad token, service down) must not take out the
|
||||
// docker health readout too - the two are independent failure modes and
|
||||
// merging them into one card should not let one mask the other.
|
||||
const statPromise = collectServiceStat(widget).catch((err) => ({
|
||||
stats: [] as ServiceStat[],
|
||||
statError: (err as Error).message,
|
||||
}));
|
||||
|
||||
const [docker, statResult] = await Promise.all([dockerPromise, statPromise]);
|
||||
return { docker, ...statResult };
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
import type { ServiceWidget } from "@/lib/config/schema";
|
||||
|
||||
const SERVICE_PORTS: Record<ServiceWidget["service"], number> = {
|
||||
gitea: 3000,
|
||||
coolify: 8080,
|
||||
immich: 2283,
|
||||
n8n: 5678,
|
||||
umami: 3000,
|
||||
headscale: 8080,
|
||||
traefik: 8080,
|
||||
};
|
||||
|
||||
export function serviceBaseUrl(widget: ServiceWidget): string {
|
||||
return `http://${widget.containerName}:${SERVICE_PORTS[widget.service]}`;
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
import type { CoolifyServiceWidget } from "@/lib/config/schema";
|
||||
import type { ServiceStat } from "@/lib/types/service-result";
|
||||
import { serviceBaseUrl } from "./base-url";
|
||||
|
||||
async function fetchCoolify<T>(base: string, path: string, apiToken: string): Promise<T> {
|
||||
const response = await fetch(`${base}${path}`, {
|
||||
headers: { Authorization: `Bearer ${apiToken}` },
|
||||
signal: AbortSignal.timeout(5_000),
|
||||
});
|
||||
if (!response.ok) {
|
||||
throw new Error(`Coolify API returned ${response.status}`);
|
||||
}
|
||||
return (await response.json()) as T;
|
||||
}
|
||||
|
||||
export async function collectCoolify(widget: CoolifyServiceWidget): Promise<{ stats: ServiceStat[] }> {
|
||||
const base = serviceBaseUrl(widget);
|
||||
const [projects, resources] = await Promise.all([
|
||||
fetchCoolify<unknown[]>(base, "/api/v1/projects", widget.apiToken),
|
||||
fetchCoolify<unknown[]>(base, "/api/v1/resources", widget.apiToken),
|
||||
]);
|
||||
|
||||
return {
|
||||
stats: [
|
||||
{ label: "Projects", value: String(projects.length) },
|
||||
{ label: "Resources", value: String(resources.length) },
|
||||
],
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
import type { GiteaServiceWidget } from "@/lib/config/schema";
|
||||
import type { ServiceStat } from "@/lib/types/service-result";
|
||||
import { serviceBaseUrl } from "./base-url";
|
||||
|
||||
export async function collectGitea(widget: GiteaServiceWidget): Promise<{ stats: ServiceStat[] }> {
|
||||
const base = serviceBaseUrl(widget);
|
||||
const response = await fetch(`${base}/api/v1/users/${widget.username}/repos?limit=1`, {
|
||||
headers: { Authorization: `token ${widget.apiToken}` },
|
||||
signal: AbortSignal.timeout(5_000),
|
||||
});
|
||||
if (!response.ok) {
|
||||
throw new Error(`Gitea API returned ${response.status}`);
|
||||
}
|
||||
const count = response.headers.get("X-Total-Count") ?? "0";
|
||||
return { stats: [{ label: "Repos", value: count }] };
|
||||
}
|
||||
@@ -0,0 +1,30 @@
|
||||
import type { HeadscaleServiceWidget } from "@/lib/config/schema";
|
||||
import type { ServiceStat } from "@/lib/types/service-result";
|
||||
import { serviceBaseUrl } from "./base-url";
|
||||
|
||||
async function fetchList(url: string, apiToken: string, label: string, key: "users" | "nodes"): Promise<unknown[]> {
|
||||
const response = await fetch(url, {
|
||||
headers: { Authorization: `Bearer ${apiToken}` },
|
||||
signal: AbortSignal.timeout(5_000),
|
||||
});
|
||||
if (!response.ok) {
|
||||
throw new Error(`Headscale ${label} API returned ${response.status}`);
|
||||
}
|
||||
const body = (await response.json()) as Record<string, unknown[]>;
|
||||
return body[key] ?? [];
|
||||
}
|
||||
|
||||
export async function collectHeadscale(widget: HeadscaleServiceWidget): Promise<{ stats: ServiceStat[] }> {
|
||||
const base = serviceBaseUrl(widget);
|
||||
const [users, nodes] = await Promise.all([
|
||||
fetchList(`${base}/api/v1/user`, widget.apiToken, "user", "users"),
|
||||
fetchList(`${base}/api/v1/node`, widget.apiToken, "node", "nodes"),
|
||||
]);
|
||||
|
||||
return {
|
||||
stats: [
|
||||
{ label: "Users", value: String(users.length) },
|
||||
{ label: "Nodes", value: String(nodes.length) },
|
||||
],
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
import type { ImmichServiceWidget } from "@/lib/config/schema";
|
||||
import type { ServiceStat } from "@/lib/types/service-result";
|
||||
import { serviceBaseUrl } from "./base-url";
|
||||
|
||||
interface ImmichStatistics {
|
||||
photos: number;
|
||||
videos: number;
|
||||
}
|
||||
|
||||
export async function collectImmich(widget: ImmichServiceWidget): Promise<{ stats: ServiceStat[] }> {
|
||||
const base = serviceBaseUrl(widget);
|
||||
const response = await fetch(`${base}/api/server/statistics`, {
|
||||
headers: { "x-api-key": widget.apiKey },
|
||||
signal: AbortSignal.timeout(5_000),
|
||||
});
|
||||
if (!response.ok) {
|
||||
throw new Error(`Immich API returned ${response.status}`);
|
||||
}
|
||||
const stats = (await response.json()) as ImmichStatistics;
|
||||
return {
|
||||
stats: [
|
||||
{ label: "Photos", value: String(stats.photos) },
|
||||
{ label: "Videos", value: String(stats.videos) },
|
||||
],
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
import type { N8nServiceWidget } from "@/lib/config/schema";
|
||||
import type { ServiceStat } from "@/lib/types/service-result";
|
||||
import { serviceBaseUrl } from "./base-url";
|
||||
|
||||
interface N8nWorkflowsPage {
|
||||
data: unknown[];
|
||||
}
|
||||
|
||||
export async function collectN8n(widget: N8nServiceWidget): Promise<{ stats: ServiceStat[] }> {
|
||||
const base = serviceBaseUrl(widget);
|
||||
const response = await fetch(`${base}/api/v1/workflows?limit=250`, {
|
||||
headers: { "X-N8N-API-KEY": widget.apiKey },
|
||||
signal: AbortSignal.timeout(5_000),
|
||||
});
|
||||
if (!response.ok) {
|
||||
throw new Error(`n8n API returned ${response.status}`);
|
||||
}
|
||||
const page = (await response.json()) as N8nWorkflowsPage;
|
||||
return { stats: [{ label: "Workflows", value: String(page.data.length) }] };
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
import type { TraefikServiceWidget } from "@/lib/config/schema";
|
||||
import type { ServiceStat } from "@/lib/types/service-result";
|
||||
import { serviceBaseUrl } from "./base-url";
|
||||
|
||||
interface RawRouter {
|
||||
status: string;
|
||||
}
|
||||
|
||||
export async function collectTraefikStat(widget: TraefikServiceWidget): Promise<{ stats: ServiceStat[] }> {
|
||||
const base = serviceBaseUrl(widget);
|
||||
const response = await fetch(`${base}/api/http/routers`, { signal: AbortSignal.timeout(5_000) });
|
||||
if (!response.ok) {
|
||||
throw new Error(`Traefik API returned ${response.status}`);
|
||||
}
|
||||
const routers = (await response.json()) as RawRouter[];
|
||||
return { stats: [{ label: "Routes", value: String(routers.length) }] };
|
||||
}
|
||||
@@ -0,0 +1,48 @@
|
||||
import type { UmamiServiceWidget } from "@/lib/config/schema";
|
||||
import type { ServiceStat } from "@/lib/types/service-result";
|
||||
import { serviceBaseUrl } from "./base-url";
|
||||
|
||||
// Self-hosted Umami has no static API-key header (that's Cloud-only) - it needs
|
||||
// a username/password login exchanged for a Bearer token. Cache the token per
|
||||
// container and only re-login when a request comes back 401, since the docs
|
||||
// don't document a fixed token lifetime to pre-emptively refresh against.
|
||||
const tokenCache = new Map<string, string>();
|
||||
|
||||
async function login(widget: UmamiServiceWidget, base: string): Promise<string> {
|
||||
const response = await fetch(`${base}/api/auth/login`, {
|
||||
method: "POST",
|
||||
headers: { "Content-Type": "application/json" },
|
||||
body: JSON.stringify({ username: widget.username, password: widget.password }),
|
||||
signal: AbortSignal.timeout(5_000),
|
||||
});
|
||||
if (!response.ok) {
|
||||
throw new Error(`Umami login returned ${response.status}`);
|
||||
}
|
||||
const body = (await response.json()) as { token: string };
|
||||
tokenCache.set(widget.containerName, body.token);
|
||||
return body.token;
|
||||
}
|
||||
|
||||
export async function collectUmami(widget: UmamiServiceWidget): Promise<{ stats: ServiceStat[] }> {
|
||||
const base = serviceBaseUrl(widget);
|
||||
let token = tokenCache.get(widget.containerName) ?? (await login(widget, base));
|
||||
|
||||
let response = await fetch(`${base}/api/websites/${widget.websiteId}/active`, {
|
||||
headers: { Authorization: `Bearer ${token}` },
|
||||
signal: AbortSignal.timeout(5_000),
|
||||
});
|
||||
|
||||
if (response.status === 401) {
|
||||
token = await login(widget, base);
|
||||
response = await fetch(`${base}/api/websites/${widget.websiteId}/active`, {
|
||||
headers: { Authorization: `Bearer ${token}` },
|
||||
signal: AbortSignal.timeout(5_000),
|
||||
});
|
||||
}
|
||||
|
||||
if (!response.ok) {
|
||||
throw new Error(`Umami API returned ${response.status}`);
|
||||
}
|
||||
const body = (await response.json()) as { visitors: number };
|
||||
return { stats: [{ label: "Active", value: String(body.visitors) }] };
|
||||
}
|
||||
@@ -1,48 +0,0 @@
|
||||
import type { TraefikResult } from "@/lib/types/traefik-result";
|
||||
|
||||
interface RawRouter {
|
||||
name: string;
|
||||
rule: string;
|
||||
service: string;
|
||||
status: string;
|
||||
tls?: unknown;
|
||||
entryPoints?: string[];
|
||||
}
|
||||
|
||||
interface RawEntrypoint {
|
||||
name: string;
|
||||
address: string;
|
||||
}
|
||||
|
||||
async function fetchJson<T>(url: string): Promise<T | null> {
|
||||
const response = await fetch(url, { signal: AbortSignal.timeout(5_000) });
|
||||
if (!response.ok) return null;
|
||||
return (await response.json()) as T;
|
||||
}
|
||||
|
||||
export async function collectTraefik(apiUrl: string): Promise<TraefikResult> {
|
||||
const base = apiUrl.replace(/\/$/, "");
|
||||
|
||||
const [routers, entrypoints, middlewares] = await Promise.all([
|
||||
fetchJson<RawRouter[]>(`${base}/http/routers`),
|
||||
fetchJson<RawEntrypoint[]>(`${base}/entrypoints`),
|
||||
fetchJson<unknown[]>(`${base}/http/middlewares`),
|
||||
]);
|
||||
|
||||
if (routers === null) {
|
||||
throw new Error(`Traefik API at ${base}/http/routers is unreachable or returned an error`);
|
||||
}
|
||||
|
||||
return {
|
||||
routers: routers.map((router) => ({
|
||||
name: router.name,
|
||||
rule: router.rule,
|
||||
service: router.service,
|
||||
status: router.status,
|
||||
tls: Boolean(router.tls),
|
||||
entryPoints: router.entryPoints ?? [],
|
||||
})),
|
||||
entrypoints: (entrypoints ?? []).map((ep) => ({ name: ep.name, address: ep.address })),
|
||||
middlewaresCount: middlewares?.length ?? 0,
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
import type { Config, Widget } from "./schema";
|
||||
|
||||
const SECRET_WIDGET_FIELDS = ["apiToken", "apiKey", "password"] as const;
|
||||
|
||||
export function toPublicConfig(config: Config): Config {
|
||||
return {
|
||||
...config,
|
||||
groups: config.groups.map((group) => ({
|
||||
...group,
|
||||
widgets: group.widgets.map(redactWidget),
|
||||
})),
|
||||
};
|
||||
}
|
||||
|
||||
function redactWidget(widget: Widget): Widget {
|
||||
const clone: Record<string, unknown> = { ...widget };
|
||||
for (const key of SECRET_WIDGET_FIELDS) delete clone[key];
|
||||
return clone as Widget;
|
||||
}
|
||||
+80
-6
@@ -6,11 +6,19 @@ const durationSchema = z
|
||||
.string()
|
||||
.regex(/^\d+(ms|s|m|h)$/, 'Expected a duration like "500ms", "5s", "1m", or "1h"');
|
||||
|
||||
export const bookmarkLinkSchema = z.object({
|
||||
name: z.string(),
|
||||
href: z.string().url(),
|
||||
icon: z.string().optional(),
|
||||
});
|
||||
|
||||
export const bookmarkWidgetSchema = z.object({
|
||||
type: z.literal("bookmark"),
|
||||
name: z.string(),
|
||||
href: z.string().url(),
|
||||
href: z.string().url().optional(),
|
||||
description: z.string().optional(),
|
||||
icon: z.string().optional(),
|
||||
links: z.array(bookmarkLinkSchema).optional(),
|
||||
});
|
||||
|
||||
export const searchWidgetSchema = z.object({
|
||||
@@ -26,6 +34,7 @@ export const dockerWidgetSchema = z.object({
|
||||
href: z.string().url().optional(),
|
||||
showStats: z.boolean().default(true),
|
||||
interval: durationSchema.default("5s"),
|
||||
icon: z.string().optional(),
|
||||
});
|
||||
|
||||
export const databaseWidgetSchema = z.object({
|
||||
@@ -56,13 +65,70 @@ export const httpWidgetSchema = z.object({
|
||||
.default({ status: 200 }),
|
||||
});
|
||||
|
||||
export const traefikWidgetSchema = z.object({
|
||||
type: z.literal("traefik"),
|
||||
name: z.string().default("Traefik"),
|
||||
apiUrl: z.string().url(),
|
||||
const serviceCommonFields = {
|
||||
type: z.literal("service") as z.ZodLiteral<"service">,
|
||||
name: z.string(),
|
||||
containerName: z.string(),
|
||||
href: z.string().url().optional(),
|
||||
showStats: z.boolean().default(true),
|
||||
interval: durationSchema.default("15s"),
|
||||
icon: z.string().optional(),
|
||||
};
|
||||
|
||||
export const giteaServiceWidgetSchema = z.object({
|
||||
...serviceCommonFields,
|
||||
service: z.literal("gitea"),
|
||||
username: z.string().default("Valknar"),
|
||||
apiToken: z.string(),
|
||||
});
|
||||
|
||||
export const coolifyServiceWidgetSchema = z.object({
|
||||
...serviceCommonFields,
|
||||
service: z.literal("coolify"),
|
||||
apiToken: z.string(),
|
||||
});
|
||||
|
||||
export const immichServiceWidgetSchema = z.object({
|
||||
...serviceCommonFields,
|
||||
service: z.literal("immich"),
|
||||
apiKey: z.string(),
|
||||
});
|
||||
|
||||
export const n8nServiceWidgetSchema = z.object({
|
||||
...serviceCommonFields,
|
||||
service: z.literal("n8n"),
|
||||
apiKey: z.string(),
|
||||
});
|
||||
|
||||
export const umamiServiceWidgetSchema = z.object({
|
||||
...serviceCommonFields,
|
||||
service: z.literal("umami"),
|
||||
username: z.string(),
|
||||
password: z.string(),
|
||||
websiteId: z.string(),
|
||||
});
|
||||
|
||||
export const headscaleServiceWidgetSchema = z.object({
|
||||
...serviceCommonFields,
|
||||
service: z.literal("headscale"),
|
||||
apiToken: z.string(),
|
||||
});
|
||||
|
||||
export const traefikServiceWidgetSchema = z.object({
|
||||
...serviceCommonFields,
|
||||
service: z.literal("traefik"),
|
||||
});
|
||||
|
||||
export const serviceWidgetSchema = z.discriminatedUnion("service", [
|
||||
giteaServiceWidgetSchema,
|
||||
coolifyServiceWidgetSchema,
|
||||
immichServiceWidgetSchema,
|
||||
n8nServiceWidgetSchema,
|
||||
umamiServiceWidgetSchema,
|
||||
headscaleServiceWidgetSchema,
|
||||
traefikServiceWidgetSchema,
|
||||
]);
|
||||
|
||||
export const widgetSchema = z.discriminatedUnion("type", [
|
||||
bookmarkWidgetSchema,
|
||||
searchWidgetSchema,
|
||||
@@ -70,7 +136,7 @@ export const widgetSchema = z.discriminatedUnion("type", [
|
||||
databaseWidgetSchema,
|
||||
systemWidgetSchema,
|
||||
httpWidgetSchema,
|
||||
traefikWidgetSchema,
|
||||
serviceWidgetSchema,
|
||||
]);
|
||||
|
||||
export const groupSchema = z.object({
|
||||
@@ -124,3 +190,11 @@ export type Config = z.infer<typeof configSchema>;
|
||||
export type Widget = z.infer<typeof widgetSchema>;
|
||||
export type Group = z.infer<typeof groupSchema>;
|
||||
export type SearchEngine = z.infer<typeof searchEngineSchema>;
|
||||
export type ServiceWidget = z.infer<typeof serviceWidgetSchema>;
|
||||
export type GiteaServiceWidget = z.infer<typeof giteaServiceWidgetSchema>;
|
||||
export type CoolifyServiceWidget = z.infer<typeof coolifyServiceWidgetSchema>;
|
||||
export type ImmichServiceWidget = z.infer<typeof immichServiceWidgetSchema>;
|
||||
export type N8nServiceWidget = z.infer<typeof n8nServiceWidgetSchema>;
|
||||
export type UmamiServiceWidget = z.infer<typeof umamiServiceWidgetSchema>;
|
||||
export type HeadscaleServiceWidget = z.infer<typeof headscaleServiceWidgetSchema>;
|
||||
export type TraefikServiceWidget = z.infer<typeof traefikServiceWidgetSchema>;
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
import type { DockerContainerResult } from "./widget-result";
|
||||
|
||||
export interface ServiceStat {
|
||||
label: string;
|
||||
value: string;
|
||||
}
|
||||
|
||||
export interface ServiceWidgetResult {
|
||||
docker: DockerContainerResult;
|
||||
stats: ServiceStat[];
|
||||
statError?: string;
|
||||
}
|
||||
@@ -1,19 +0,0 @@
|
||||
export interface TraefikRouterInfo {
|
||||
name: string;
|
||||
rule: string;
|
||||
service: string;
|
||||
status: string;
|
||||
tls: boolean;
|
||||
entryPoints: string[];
|
||||
}
|
||||
|
||||
export interface TraefikEntrypointInfo {
|
||||
name: string;
|
||||
address: string;
|
||||
}
|
||||
|
||||
export interface TraefikResult {
|
||||
routers: TraefikRouterInfo[];
|
||||
entrypoints: TraefikEntrypointInfo[];
|
||||
middlewaresCount: number;
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
import type { SystemResult } from "./system-result";
|
||||
import type { HttpCheckResult } from "./http-result";
|
||||
import type { TraefikResult } from "./traefik-result";
|
||||
import type { ServiceWidgetResult } from "./service-result";
|
||||
|
||||
export interface DockerContainerResult {
|
||||
status: "running" | "exited" | "restarting" | "paused" | "dead" | "created" | "unknown";
|
||||
@@ -19,5 +19,5 @@ export type WidgetResult =
|
||||
| { type: "database"; data: DockerContainerResult }
|
||||
| { type: "system"; data: SystemResult }
|
||||
| { type: "http"; data: HttpCheckResult }
|
||||
| { type: "traefik"; data: TraefikResult }
|
||||
| { type: "service"; data: ServiceWidgetResult }
|
||||
| { type: "error"; message: string };
|
||||
|
||||
+8
-2
@@ -3,6 +3,7 @@ import { WebSocket, WebSocketServer } from "ws";
|
||||
import { collectorScheduler } from "@/lib/collectors/scheduler";
|
||||
import { configStore, type ConfigError } from "@/lib/config/loader";
|
||||
import { effectiveConfigStore } from "@/lib/config/effective";
|
||||
import { toPublicConfig } from "@/lib/config/public";
|
||||
import type { Config } from "@/lib/config/schema";
|
||||
import type { WidgetResult } from "@/lib/types/widget-result";
|
||||
|
||||
@@ -49,7 +50,7 @@ export function attachWebSocketServer(httpServer: HttpServer): WebSocketServer {
|
||||
|
||||
try {
|
||||
const config = effectiveConfigStore.get();
|
||||
send(socket, { topic: "config", type: "config:update", ts: Date.now(), data: config });
|
||||
send(socket, { topic: "config", type: "config:update", ts: Date.now(), data: toPublicConfig(config) });
|
||||
} catch {
|
||||
// no valid config loaded yet; client keeps its SSR-seeded config until one arrives
|
||||
}
|
||||
@@ -80,7 +81,12 @@ export function attachWebSocketServer(httpServer: HttpServer): WebSocketServer {
|
||||
});
|
||||
|
||||
effectiveConfigStore.onUpdate((config) => {
|
||||
const envelope: Envelope = { topic: "config", type: "config:update", ts: Date.now(), data: config };
|
||||
const envelope: Envelope = {
|
||||
topic: "config",
|
||||
type: "config:update",
|
||||
ts: Date.now(),
|
||||
data: toPublicConfig(config),
|
||||
};
|
||||
for (const socket of allSockets) send(socket, envelope);
|
||||
});
|
||||
|
||||
|
||||
+2
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "pulsenode",
|
||||
"version": "0.2.0",
|
||||
"version": "0.4.7",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"dev": "tsx watch server.ts",
|
||||
@@ -17,6 +17,7 @@
|
||||
"p-limit": "^7.3.1",
|
||||
"react": "19.2.8",
|
||||
"react-dom": "19.2.8",
|
||||
"simple-icons": "^16.28.0",
|
||||
"systeminformation": "^5.33.1",
|
||||
"tsx": "^4.23.12",
|
||||
"ws": "^8.21.3",
|
||||
|
||||
Generated
+9
@@ -32,6 +32,9 @@ importers:
|
||||
react-dom:
|
||||
specifier: 19.2.8
|
||||
version: 19.2.8(react@19.2.8)
|
||||
simple-icons:
|
||||
specifier: ^16.28.0
|
||||
version: 16.28.0
|
||||
systeminformation:
|
||||
specifier: ^5.33.1
|
||||
version: 5.33.1
|
||||
@@ -2213,6 +2216,10 @@ packages:
|
||||
resolution: {integrity: sha512-6x6dK6zJdpTzF4sQeNYxwtvBzf6Eg4GtlesS94HOvTudUeyK2WXAaIfmDgsyslYrRBeFIlsi54AYsFGUuhmvrQ==}
|
||||
engines: {node: '>= 0.4'}
|
||||
|
||||
simple-icons@16.28.0:
|
||||
resolution: {integrity: sha512-sQPR5AtK/ijRjou7zw7mlLp08oB6FH7i0lOy5XJ2zp9mJs/yejgiOn7KvQoe2q4YJIx6VmgUSW5AOefebPt5kg==}
|
||||
engines: {node: '>=0.12.18'}
|
||||
|
||||
source-map-js@1.2.1:
|
||||
resolution: {integrity: sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==}
|
||||
engines: {node: '>=0.10.0'}
|
||||
@@ -4716,6 +4723,8 @@ snapshots:
|
||||
side-channel-map: 1.0.1
|
||||
side-channel-weakmap: 1.0.2
|
||||
|
||||
simple-icons@16.28.0: {}
|
||||
|
||||
source-map-js@1.2.1: {}
|
||||
|
||||
split-ca@1.0.1: {}
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Regenerates lib/brand-icons.ts from the `simple-icons` package.
|
||||
|
||||
Run from the repo root after `pnpm add simple-icons` has installed it:
|
||||
|
||||
python3 scripts/extract-brand-icons.py
|
||||
|
||||
Add a new service by adding a "our key" -> "simple-icons slug" entry below.
|
||||
Slugs are the filenames under node_modules/simple-icons/icons/ (without the
|
||||
.svg extension).
|
||||
"""
|
||||
|
||||
import json
|
||||
import re
|
||||
from pathlib import Path
|
||||
|
||||
ICONS = {
|
||||
"traefik": "traefikproxy",
|
||||
"coolify": "coolify",
|
||||
"gitea": "gitea",
|
||||
"docker": "docker",
|
||||
"immich": "immich",
|
||||
"n8n": "n8n",
|
||||
"passbolt": "passbolt",
|
||||
"umami": "umami",
|
||||
"postgresql": "postgresql",
|
||||
"redis": "redis",
|
||||
"headscale": "tailscale",
|
||||
"coder": "coder",
|
||||
}
|
||||
|
||||
ROOT = Path(__file__).resolve().parent.parent
|
||||
ICONS_DIR = ROOT / "node_modules" / "simple-icons" / "icons"
|
||||
OUT_PATH = ROOT / "lib" / "brand-icons.ts"
|
||||
|
||||
HEADER = """// Path data extracted from the `simple-icons` package (CC0) at build time -
|
||||
// see scripts/extract-brand-icons.py. Rendered monochrome (currentColor) to
|
||||
// stay consistent with the single-accent design rather than a dozen
|
||||
// competing brand colors; the shape alone is enough to be recognizable.
|
||||
export const BRAND_ICON_PATHS: Record<string, string> = {
|
||||
"""
|
||||
|
||||
|
||||
def main() -> None:
|
||||
lines = [HEADER]
|
||||
for key, slug in ICONS.items():
|
||||
svg = (ICONS_DIR / f"{slug}.svg").read_text()
|
||||
d_matches = re.findall(r'<path d="([^"]+)"', svg)
|
||||
combined = " ".join(d_matches)
|
||||
lines.append(f" {json.dumps(key)}: {json.dumps(combined)},\n")
|
||||
lines.append("};\n")
|
||||
OUT_PATH.write_text("".join(lines))
|
||||
print(f"Wrote {OUT_PATH} ({len(ICONS)} icons)")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Reference in New Issue
Block a user