Skip to main content
Django + Huey . Self-hosted . Open source

Django Huey Dashboard

Run Huey inside a Django app and you have working background jobs. Run Huey with z4j and you also have a dashboard, persistent history, the task controls this adapter can execute safely, scheduler integration, RBAC with invitations, and a tamper-evident audit log. z4j is one container or one Python process; the agent is one pip extra in your existing Django venv.

Huey is the simplest of the bunch: small surface, no result backend by default, file-backed scheduler optional. Django + Huey + z4j gives you a dashboard for a stack that traditionally has none, safe submit, replacement-input retry, and pending-only revoke controls, plus an audit log for operator actions. Revoke prevents pending work from starting; it does not interrupt running work.

install

Install z4j alongside Django + Huey

1. Install the brain

bash
pip install z4j && z4j serve

First boot prints a setup URL to stderr. Open it, create the first admin, and mint a token + HMAC secret for this agent.

2. Add the agent to your Django venv

bash
pip install z4j-django[huey]

3. Wire it into Django

python
# settings.py
INSTALLED_APPS += ["z4j_django"]

Z4J = {
    "brain_url":   env("Z4J_BRAIN_URL"),
    "token":       env("Z4J_TOKEN"),
    "hmac_secret": env("Z4J_HMAC_SECRET"),
    "project_id":  env("Z4J_PROJECT_ID"),
    "agent_name":  env("Z4J_AGENT_NAME", default=None),
}
# That's it. No CELERY_APP, no Z4J_DEV_MODE, no dev_mode kwarg.
# Auto-detect checks the documented candidate layouts. Add CELERY_APP when
# none of those candidates resolves your application.

What you get

  • Persistent Huey task history in Postgres or SQLite
  • Adapter-advertised controls: submit_task, retry_task (complete replacement inputs), cancel_task (pending revoke only)
  • Scheduler integration via huey periodic; available controls depend on that scheduler adapter
  • RBAC with invitations and password reset
  • HMAC-chained tamper-evident audit log
  • Notifications: email, Slack, Telegram, webhook
License

z4j-django and z4j-huey are Apache 2.0. Importing them into your Django app does not affect your application's licensing. z4j is AGPL-3.0-or-later, isolated in its own process.

Huey actions exposed

What the dashboard can actually do

Native actions

  • submit_task
  • retry_task (complete replacement inputs)
  • cancel_task (pending revoke only)

Event capture

huey.signals decorator, installed via adapter.connect_signals().

Reconciliation

Huey result store (peek_data). Returns pending/success/unknown.

other Django stacks

Django with a different engine

Huey on other frameworks

Same engine, different framework

Start using Django Huey Dashboard

Self-hosted, open source, no SaaS, no telemetry. z4j runs anywhere Python or Docker runs.