Skip to main content
Version: v2 (current)

On-prem quick start

TL;DR. On-prem PanDev Metrics is the same product as Cloud — same UI, same integrations. The differences: it runs on your servers (Docker or Kubernetes), it is single-tenant (one organisation per install), and there is no Google sign-in (email + password and LDAP / AD only). Plan ~1–2 hours from a clean VM to first metrics. PostgreSQL ships inside the distribution (version 16; 17 is supported for an external database), so the prerequisites are just a host that meets the sizing and Docker Engine ≥ 20.10 or Kubernetes ≥ 1.28.

Before you begin​

You need two things ready before the first docker compose up:

  1. A host that meets the minimum sizing.
  2. DNS / TLS for the host, if you want HTTPS in front (optional but recommended).

PostgreSQL ships with the distribution and is created automatically on first start — you don't provision a database yourself unless you deliberately point the stack at an external one.

Hardware and software​

PanDev Metrics runs on a single Linux host by default (x86_64 or arm64), PostgreSQL included. A Small install (up to ~50 engineers) fits comfortably in roughly 8 cores / 20 GB / 100 GB SSD on one host; from Medium up, move PostgreSQL to its own host. See System requirements for the full sizing tiers, the CPU-instruction baseline, and supported OS versions.

ComponentMinimumRecommended
PostgreSQL16 (bundled)16 or 17
Docker Engine20.1024+
Docker Composev2.0v2.20+
Kubernetes1.281.28+

Network ports​

PortWhat
8090Workspace UI (browser)
8080Backend API
9090Spring Actuator — health, internal only

Outgoing traffic from the on-prem install is minimal but cannot be turned off — air-gapped installs are not supported.

Installation steps​

1. Verify system requirements​

Check disk, RAM, OS, and network access against the full requirements page.

2. Review the architecture​

Skim the architecture page so you know what services are about to come up and how they talk to each other.

3. Install with Docker or Kubernetes​

PanDev Metrics ships both ways:

  • Docker Compose — recommended for small / mid-size installs and proofs of concept. Walk the installation guide.
  • Kubernetes — for teams that already run a cluster. Use the Helm chart referenced in the same installation guide.

Upgrades on either path are a one-line image-tag bump. There is no in-place migration tool to be afraid of.

4. Activate the license and first login​

Follow Licensing and first login to activate your key and create the initial admin account. This is the only out-of-band step in the whole on-prem flow.

5. Connect users​

Pick one of two paths:

SAML and OIDC are not supported.

6. Install IDE plugins on the team's machines​

Follow the IDE plugin overview. Point the plugin Server URL at your on-prem host (e.g. https://metrics.acme.corp) instead of metrics-cloud.pandev.io.

Verify​

You have a working on-prem install when all of the following are true:

  • docker compose ps shows all three containers Up (PostgreSQL Up (healthy))
  • You can sign in to the workspace UI at http://<host>:8090 as the initial admin
  • At least one user can sign in (LDAP-linked or manually created)
  • At least one Git provider in Settings → Integrations shows a green status
  • One IDE plugin pointing at your host shows up under Organization → Employees

Backups​

Back up the PostgreSQL database — that is the only stateful component. pg_dump of the application database is sufficient to recover the install on another host. RPO/RTO targets are up to you; PanDev Metrics imposes nothing.

FAQ​

Can I run on-prem without internet access?​

Air-gapped installs are not supported. PanDev Metrics needs minimal outbound HTTPS — license validation plus your configured Git and task-tracker integrations — and that cannot be disabled.

Does on-prem support multi-tenant?​

No. On-prem is single-tenant by design — one organisation per install. If you need multiple separate organisations on one set of servers, talk to support about a different architecture.

What's the upgrade story?​

Replace the image tag in docker-compose.yml (or in the Helm values), pull, and restart. No data migration tools are required for normal upgrades; database migrations are run automatically by the backend on start-up.

Do I need TLS?​

Not strictly. PanDev Metrics serves plain HTTP by default (workspace UI on 8090, backend API on 8080). For production we recommend terminating TLS at your own reverse proxy (nginx, Traefik, an ingress controller). The plugin can also be configured to skip SSL validation for self-signed certificates.

Next steps​