Skip to content

boubli/AMUD-Dashboard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

320 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AMUD Logo

AMUD Dashboard

GitHub Release

English | Español | Português | Français | Deutsch | Italiano | Русский | 中文 | 日本語 | हिन्दी | 한국어 | العربية

Changelog · Blog · Theme Gallery · Roadmap · Docs · FAQ

What's new in v1.8.7

  • Side margins restored — centered 1440px dashboard with wallpaper visible on left/right (Mac + Windows desktop)
  • v1.8.6 — do not use (edge-to-edge regression, fixed in v1.8.7)
  • v1.8.5 — per-app metrics (keep features; layout cache was unreliable)

Full history: Changelog

Release status (2026-07-15)

Last 5 validated releases (full history: Changelog):

  • v1.8.7 (current latest recommended)
  • v1.8.4
  • v1.8.0
  • v1.7.7
  • v1.7.6
  • v1.7.5

Do not use: v1.5.5.4, v1.5.6.1, v1.6.1 (withdrawn or broken).

AMUD Dashboard UI

Unify your homelab. A fast, Rust-powered, zero-YAML dashboard with live Proxmox & Docker telemetry, container controls, and integrations for popular self-hosted services — all from the UI.

Unlike legacy dashboards (Heimdall, Homepage, Homarr) that run on heavy runtimes (PHP-FPM, Node.js) and rely on complex nested YAML configuration files, AMUD is written in compiled Rust and persisted entirely in SQLite. Combined, the server and telemetry agent idle at 30–50 MB of RAM (peak ~150 MB with a full integration grid) with sub-millisecond route execution.

Homepage & Homarr parity: AMUD ships integration cache, Homepage YAML import, Custom API widgets, LDAP, per-user boards, Plex/Jellyfin cards, and a growing long-tail catalog — see Comparison.

Architecture & Design Decisions

AMUD Dashboard is split into two native binaries:

  1. amud-server: Axum-based web server serving server-rendered HTML (templated via Alpine.js) and managing state via SQLite.
  2. amud-agent: Standalone daemon installed on the homelab host. It queries host metrics, Proxmox VE containers, and Docker runtimes, streaming raw JSON payloads back to the server via Unix Domain Sockets (UDS) or TCP.
graph TD
    User[Web Browser] -->|HTML / WebSockets| Server[amud-server]
    Server -->|SQLite WAL| DB[(amud.db)]
    Agent[amud-agent] -->|JSON over UNIX Socket| Server
    Agent -->|Direct HTTPS REST API| PVE[Proxmox VE API]
    Agent -->|Unix Domain Socket| Docker[Docker Daemon]
Loading

Technical Stack Justifications

Rust & Axum

  • No Runtime Overhead: Compiles directly to native machine code. Eliminates the JVM/V8 startup and heap overhead.
  • Concurrent Event Loop (Tokio): Telemetry streams and third-party integrations (AdGuard, Pi-hole, Plex, Home Assistant) poll concurrently on Tokio green threads. Telemetry is serialized once per poll tick and broadcasted to WebSockets using a tokio::sync::watch channel.

SQLite Persistence (rusqlite)

  • Zero YAML: Configuration is stored in an embedded SQLite database. Layouts, category tabs, and settings are configured directly via the UI, bypassing YAML syntax headaches.
  • Performance: Configured in WAL (Write-Ahead Logging) mode, enabling concurrent reads and low-latency writes without external network overhead.

Direct Telemetry Collection

  • Zero Shell Subprocesses: Legacy solutions fork system calls like pvesh or curl every few seconds to grab container stats, resulting in high CPU overhead.
  • Natively Networked: amud-agent utilizes hyper and rustls to send native HTTPS REST API calls to Proxmox VE and reads the Docker daemon directly over the UNIX socket via hyperlocal.

Telemetry Configuration

Proxmox VE Integration

Host metrics function automatically. For LXC container monitoring, the agent must be authenticated to the Proxmox VE REST API.

1. Generate API Token

In the Proxmox VE Web UI:

  1. Navigate to Datacenter → Permissions → API Tokens.
  2. Click Add. Select User (e.g., root@pam) and Token ID (e.g., amud).
  3. Uncheck Privilege Separation so the token inherits the user's VM/System audit permissions.
  4. Copy the returned Secret key.

2. Pass Token to Agent

Set the environment variable on the host running the agent:

PVE_API_TOKEN=PVEAPIToken=root@pam!amud=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Deployment

Docker Compose

For containerized hosts on x86_64/amd64 (combines server and agent communicating over a shared volume for the Unix socket).

ARM64 hosts: Docker images are amd64-only. Use native install or update-amud.sh with release *-arm64 binaries instead.

version: '3.8'

services:
  app:
    image: tradmss/amud-dashboard:latest
    container_name: amud_app
    restart: always
    ports:
      - "8000:8000"
    environment:
      - PORT=8000
      - BIND_ADDR=0.0.0.0
      - DB_PATH=/app/data/amud.db
      - PUID=99
      - PGID=100
      - AMUD_SOCKET_MODE=666
      - AMUD_SOCKET_PATH=/var/run/amud/amud.sock
      - AMUD_AGENT_SECRET=change-me-to-a-long-random-string # MUST match the agent secret below
    cap_drop:
      - ALL
    security_opt:
      - no-new-privileges:true
    volumes:
      - ./data:/app/data
      - amud_run:/var/run/amud

  agent:
    image: tradmss/amud-dashboard:latest
    container_name: amud_agent
    entrypoint: ["/app/amud-agent"]
    restart: always
    environment:
      - AMUD_SOCKET_PATH=/var/run/amud/amud.sock
      - AMUD_AGENT_SECRET=change-me-to-a-long-random-string # MUST match the app secret above
      - AMUD_DOCKER=1 # Auto-enabled when docker.sock is mounted; set 0 to disable
    cap_drop:
      - ALL
    security_opt:
      - no-new-privileges:true
    volumes:
      - amud_run:/var/run/amud
      - /var/run/docker.sock:/var/run/docker.sock:ro

volumes:
  amud_run:
    name: amud_run

Unraid (Community Applications)

Official templates: AMUD Dashboard + AMUD Agent (two containers, shared socket path).

  1. Install both from the Apps tab after templates are published.
  2. Use the same AMUD_AGENT_SECRET on both containers.
  3. Full guide: Unraid installation docs

First-boot permission error? If the dashboard log shows .amud-secrets-key: Permission denied, update to v1.7.2+ and recreate the container, or see troubleshooting and appdata permissions.

Template XML lives in templates/ with ca_profile.xml for Community Applications submission.

Proxmox LXC Autopilot Script

For native installation within a Proxmox VE LXC container (running outside Docker), execute this on your Proxmox VE host:

curl -sSL https://github.com/boubli/AMUD-Dashboard/releases/latest/download/setup-amud.sh | bash

Production Resource Footprint

Dimension Heimdall (Legacy PHP) AMUD Dashboard (Rust)
Engine PHP 8+ / Laravel Rust / Axum / Tokio
Execution Overhead High (Interpreted PHP-FPM) Zero (Native Machine Code)
Asset Delivery Disk reads per request Embedded in binary via include_str!
Idle RAM Footprint ~150MB 30–50 MB (peak ~150 MB)
Startup / Boot Time ~2 - 5 seconds Sub-millisecond

For developers

Before you push Rust changes, run the same checks as GitHub CI:

# Windows
.\scripts\ci-check.ps1
# Linux / macOS / Git Bash
./scripts/ci-check.sh

Optional: install a pre-push hook with ./scripts/install-git-hooks.sh so cargo fmt failures never reach CI again.


Support & Donation

Bugs and feature requests: GitHub Issues (preferred — tracked per release)
Questions and chat: GitHub Discussions
Docs / troubleshooting: boubli.github.io/AMUD-Dashboard/docs

About

Unify your homelab. A fast, Rust-powered, zero-YAML dashboard with live Proxmox & Docker telemetry, container controls, and integrations for popular self-hosted services - all from the UI.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

12 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors