Sign inSign up

anthonylau/pgboss-dashboard

By anthonylau

•Updated 3 months ago

Image
Monitoring & observability
1

1.0K

anthonylau/pgboss-dashboard repository overview

⁠pgboss-dashboard-docker

A ready-to-use Docker image for hosting the pg-boss Dashboard⁠ — a web-based UI for monitoring and managing pg-boss⁠ job queues.

The image is built on a minimal distroless⁠ base, runs as a non-root user, and supports both linux/amd64 and linux/arm64 platforms.

⁠Quick Start

docker run -d \
  -p 3000:3000 \
  -e DATABASE_URL=postgres://user:password@host:5432/mydb \
  anthonylau/pgboss-dashboard

Then open http://localhost:3000⁠ in your browser.

⁠Environment Variables

VariableDescriptionDefault
DATABASE_URLPostgreSQL connection string(s) for your pg-boss database. Supports multiple pipe-separated connections, optionally named: Production=postgres://prod/db|Staging=postgres://stage/dbpostgres://localhost/pgboss
PGBOSS_SCHEMASchema name(s) where pg-boss tables reside. For multiple databases, pipe-separate: pgboss|jobspgboss
PORTPort the dashboard listens on3000
PGBOSS_DASHBOARD_AUTH_USERNAMEBasic auth username (optional, must be set with password)—
PGBOSS_DASHBOARD_AUTH_PASSWORDBasic auth password (optional, must be set with username)—

Note: Both PGBOSS_DASHBOARD_AUTH_USERNAME and PGBOSS_DASHBOARD_AUTH_PASSWORD must be provided together. Setting only one will cause a startup error.

⁠Docker Compose

services:
  pgboss-dashboard:
    image: anthonylau/pgboss-dashboard:latest
    ports:
      - "3000:3000"
    environment:
      - DATABASE_URL=postgres://user:password@db:5432/mydb

⁠Prerequisites

  • A PostgreSQL database with pg-boss schema already set up (pg-boss v12.11+)
  • If you need to initialize the schema, run the migration first: 
    DATABASE_URL=postgres://user:password@host:5432/mydb npx -y pg-boss migrate

⁠Credits

This project packages the pg-boss Dashboard⁠ by timgit⁠ into a Docker image for easier deployment. All credit for the dashboard itself goes to the pg-boss project and its contributors.

⁠Links

Tag summary

Content type

Image

Digest

sha256:d03c4a2ea…

Size

60.7 MB

Last updated

3 months ago

docker pull anthonylau/pgboss-dashboard