treewyrm/webdirstat repository overview

⁠WebDirStat

A self-hosted, WinDirStat-style disk-usage visualizer for your NAS or server. It scans mounted directories in the background into a SQLite store and renders them as a zoomable, nested treemap in the browser — so you can see, at a glance, what's eating your space.

• Interactive treemap — a canvas-rendered squarified treemap you zoom and pan like a map; the current folder, breadcrumbs, and file list are all derived from the camera.
• Background scanning — scans run in a worker thread into a generation-versioned SQLite store, so browsing stays instant and rescans swap in atomically. Optional scheduling with weekly time-windows and staleness intervals.
• Bounded memory — the client only ever holds what's on screen; the server walks the tree with O(depth) memory, so it handles very large trees.
• Read-only by design — the scanned volume is mounted read-only; symlinks are shown but never followed (no cycles, no escaping the mount).
• Optional password gate — a shared-password login for anything past a trusted LAN.
• Single container, multi-arch (linux/amd64 + linux/arm64), non-root.

⁠Quick start

docker run -d --name webdirstat \
  -p 8080:8080 \
  -v /path/to/scan:/data:ro \
  -v /path/to/appdata/webdirstat:/db \
  -e ROOTS="Data=/data" \
  treewyrm/webdirstat:latest

Then open http://SERVER-IP:8080/⁠ and press Start to run the first scan.

⁠docker-compose

services:
  webdirstat:
    image: treewyrm/webdirstat:latest
    container_name: webdirstat
    ports:
      - "8080:8080"
    volumes:
      - /path/to/scan:/data:ro          # the share(s) you want to analyze — read-only
      - /path/to/appdata/webdirstat:/db # writable store (must NOT be the scanned share)
    environment:
      ROOTS: "Data=/data"
      PUID: "1000"                      # uid/gid that owns your /db appdata dir
      PGID: "1000"
      # PASSWORD: "changeme"            # uncomment to require login
      # TZ: "Europe/London"             # for scheduled scan windows
    restart: unless-stopped

⁠Volumes

Mount multiple shares under /data/<name> (e.g. /mnt/user/movies:/data/movies:ro) and point ROOTS at each, or add more volumes and reference them in ROOTS.

⁠Ports

⁠Environment variables

⁠Core

⁠Authentication (optional)

⁠Scanning schedule (optional)

Automatic scanning is opt-in — off unless you set SCAN_ENABLED=true or express any schedule intent (SCAN_INTERVAL / SCAN_WINDOWS). With it off, the service is manual-only (Start/Stop in the UI). Everything below can also be set per-root in the UI.

⁠Compression (optional)

⁠Notes

• Runs as non-root. Set PUID/PGID (default 1000) to match the owner of your /db appdata directory; the container adjusts the runtime user to those ids and chowns /db on start, so the store is writable without any manual chown. The read-only /data share is never touched.
• Healthcheck built in — hits /api/health, which also pings the store, so your orchestrator shows green/red honestly.
• Tags: latest, plus semver X.Y.Z and X.Y per release.

⁠Source & support

Source, issues, and full docs: https://github.com/treewyrm/webdirstat⁠ License: MIT.