import express from 'express';import { Agenda } from 'agenda';import { MongoBackend } from '@agendajs/mongo-backend';import { createExpressMiddleware } from 'agendash';const app = express();const agenda = new Agenda({ backend: new MongoBackend({ address: 'mongodb://localhost:27017/agenda' })});// Mount agendash at /dashapp.use('/dash', createExpressMiddleware(agenda));app.listen(3000, () => { console.
Fastify
import Fastify from 'fastify';import { Agenda } from 'agenda';import { MongoBackend } from '@agendajs/mongo-backend';import { createFastifyPlugin } from 'agendash';const fastify = Fastify();const agenda = new Agenda({ backend: new MongoBackend({ address: 'mongodb://localhost:27017/agenda' })});// Register agendash at /dashfastify.register(createFastifyPlugin(agenda), { prefix: '/dash' });fastify.listen({ port: 3000 }, () => { console.
Koa
import Koa from 'koa';import { Agenda } from 'agenda';import { MongoBackend } from '@agendajs/mongo-backend';import { createKoaMiddleware } from 'agendash';const app = new Koa();const agenda = new Agenda({ backend: new MongoBackend({ address: 'mongodb://localhost:27017/agenda' })});// Mount agendash at /dashconst { router, middleware } = createKoaMiddleware(agenda, '/dash');app.use(middleware);app.use(router.routes());
Hapi
import Hapi from '@hapi/hapi';import { Agenda } from 'agenda';import { MongoBackend } from '@agendajs/mongo-backend';import { createHapiPlugin } from 'agendash';const agenda = new Agenda({ backend: new MongoBackend({ address: 'mongodb://localhost:27017/agenda' })});const server = Hapi.server({ port: 3000 });await server.register({ plugin: createHapiPlugin(agenda), options: { basePath: '/dash' }});await
Security
Important: The Agendash dashboard provides full access to view, create, requeue, and delete jobs. You should always protect it with authentication before deploying to production.
Example with basic auth (Express):
import basicAuth from 'express-basic-auth';// Protect the dashboard with basic authapp.use('/dash', basicAuth({ users: { 'admin': 'secure-password' }, challenge: true}));// Then mount agendashapp.use('/dash', expressMiddleware(agenda));
For production environments, consider using:
Session-based authentication with your existing auth system
OAuth/SSO integration
IP-based access control (e.g., only accessible from internal network)
A reverse proxy with authentication (e.g., nginx with auth_basic)
Never expose the dashboard to the public internet without authentication.
Features
Job Overview: View all jobs organized by name with status counts
Job States: See jobs by state (scheduled, queued, running, completed, failed, repeating)
Agenda Status: Live view of running/queued/locked jobs and configuration
Filtering: Filter jobs by name, state, or search within job data
Job Management: Create, requeue, and delete jobs
Bulk Operations: Multi-select jobs for bulk requeue or delete
Job Details: View job data, timestamps, and failure information
Auto-refresh: Dashboard refreshes automatically with countdown indicator
Mobile Responsive: Works on desktop and mobile devices
Development
To run agendash in development mode with hot reloading: