DevPanel
Get Started
Documentation
Getting Started

Installation

DevPanel runs entirely in Docker. The installer pulls the images and starts the stack automatically.

Prerequisites

  • ✓Docker Engine 24+ and Docker Compose v2
  • ✓Linux (x86_64 or arm64) or Windows 10/11 with Docker Desktop
  • ✓Ports 33000, 33001, 33002 available

Install the CLI

bash
npm install -g devpanel-cli

Requires Node.js 18+. Works on Linux, macOS, and Windows.

Run the installer

bash
devpanel install

Pulls Docker images and starts all services. Auto-starts on boot via systemd (Linux/macOS) or Task Scheduler (Windows).

CLI Commands

CommandDescription
devpanel installInstall DevPanel on this machine (--dir, --port)
devpanel uninstallRemove DevPanel and all containers (--keep-data to preserve volumes)
devpanel updatePull latest images and restart services
devpanel startStart DevPanel services
devpanel stopStop DevPanel services
devpanel restartRestart DevPanel services
devpanel statusShow status of all services
devpanel logs [service]Stream logs (api, worker, web, agent, postgres, redis)
devpanel psShow running containers with CPU/memory usage
devpanel exec <service>Open a shell inside a container
devpanel backupDump the database to a SQL file (--output <file>)
devpanel restore <file>Restore the database from a SQL backup
devpanel envShow .env config, sensitive values redacted (--edit to open in $EDITOR)
devpanel resetWipe all data and restart fresh
devpanel reset-admin-passReset an admin account password
devpanel versionShow CLI and image versions

What gets installed

ServicePortPurpose
web33000React dashboard (Vite)
api33001NestJS REST API
worker—BullMQ job processor (internal only)
agent33002Fastify agent (per server)
postgres—Database (internal only)
redis—Job queue (internal only)

First-time setup

On the first visit to http://localhost:33000, you will be prompted to create an admin account.

browser
open http://localhost:33000
NextQuick Start