User guide

An illustrated, section-by-section tour of the bunqueue dashboard. Every dashboard section has its own page in the sidebar, each with a real screenshot and a detailed, source-grounded walkthrough of what it shows, every action you can take, its states and gating, the API calls behind it, and its honest gotchas.

Screenshots were captured against a live seeded server (queues emails, image-resize, reports, notifications, benchmark, maintenance; real completed jobs, DLQ entries, cron schedules, webhooks and workers) in the default dark theme.

Two page families, by design

The Pro pages (src/pages/control/*, client lib/bq.ts) are the complete control surface and own the sidebar, they're documented below. The first-generation classic pages remain reachable at *-classic routes and are covered in the Classic pages appendix. For the full route → component → API-client table, see Pages & routes.

Home

• Overview, the landing page: connection banner, headline stat cards, per-queue health grid, and a live activity feed.

Queues

• Queues, the fleet view: every queue with per-state counts and inline pause/resume.
• Jobs Explorer, server-paginated jobs for a queue, with filters, multi-select and Promote as the only job-lifecycle mutation.
• Dead Letter Queue, cross-queue DLQ dashboard: reasons, attempt history and CSV export; every retry and purge path fails closed.
• Cron Jobs, list and create scheduled jobs (cron expression or interval).

Workflow

• Workflow Engine, a dedicated command centre with Overview, Executions, Waiting & Signals, Compensation, and Archive views.
• Job Flows, DAG exploration, all five FlowProducer create modes, dependency/result tools, and safe Flow Job methods.

Monitoring

• Metrics, rolling throughput chart, queue-depth trend, latency percentiles, per-queue counts.
• Workers, registered workers, active/stale status, and guarded stale-worker registry cleanup (it does not stop worker processes).
• Logs, the live SSE event feed with filters and search.

Control

• Server Control, start / stop / restart the bunqueue process via the local control agent, with live logs.
• Add Job, enqueue a job with payload, options, priority and delay.
• Job Inspector, a single job's full timeline, payload, result and state-gated actions.
• Queue Control, per-queue actions, live Queue SDK limits/deduplication/metrics/journal tools, and stall/DLQ configuration; DLQ retention is read-only.
• DLQ Control, read-only single-queue dead-letter triage.
• Webhooks, register, test and remove webhook endpoints.
• Diagnostics, connectivity and health checks.
• Benchmark, drive synthetic load and watch throughput.

Management

• Database, the read-only SQLite inspector: tables, schema, rows, and query runner.
• Usage, cumulative usage totals and runtime/storage facts.
• S3 Backup, live configuration, status, listing, on-demand snapshots, and guarded restore through the local control agent.
• Settings, connection target, polling interval, theme, and agent token.

Appendix

• Classic pages, the first-generation view pages, kept intact, and the 404 catch-all.