Prerequisites
- Docker Engine 20+ and Compose 2+, or a Kubernetes 1.24+ cluster
- PostgreSQL 14+ (Compose automatically provisions PostgreSQL 15)
NEXTAUTH_SECRETandENCRYPTION_KEYconfigured before first start- A stable HTTPS reverse proxy in production (for auth callbacks and webhook ingestion)
Generating...
Generating...
Docker Compose (Recommended Starter)
Clone the repository, copy env.example to .env, inject your generated secrets, and launch the stack:
compose
git clone https://github.com/opsknight-labs/OpsKnight.git cd OpsKnight cp env.example .env # set NEXTAUTH_SECRET and ENCRYPTION_KEY in .env docker compose up -d
Then navigate to http://localhost:3000/setup to initialize the primary administrator account.
Kubernetes (Helm Chart)
For versioned, repeatable Kubernetes deployments with Horizontal Pod Autoscaling (HPA) and Ingress TLS:
helm
helm repo add opsknight https://charts.opsknight.com helm repo update helm upgrade --install opsknight opsknight/opsknight \ --namespace opsknight \ --create-namespace
Other Supported Topologies
- · Kustomize & GitOps:Declarative base and overlay manifests designed for ArgoCD and Flux pipelines. Kustomize guide
- · Cloud & Serverless Containers:Deploy to AWS ECS / Fargate with RDS PostgreSQL, or GCP Cloud Run with Cloud SQL. Cloud deployment guide
- · Linux Systemd / Bare Metal:Run as a native Node 20 LTS daemon service behind an Nginx or Caddy TLS reverse proxy. Installation walkthrough
Hardware Sizing Matrix
Recommended capacity for OpsKnight and PostgreSQL based on monthly alert volume:
| Tier | Alert Volume | Compute | Topology |
|---|---|---|---|
| Starter / Eval | < 10k / mo | 1 vCPU · 1 GB RAM | Docker Compose ($5 VPS) |
| Team / Growth | 10k – 100k / mo | 2 vCPU · 2 GB RAM | 2x Replicas + Managed DB |
| Enterprise | 100k+ / mo | 4+ vCPU · 4–8 GB | Kubernetes (HPA) + PgBouncer |
What this is not
There is no OpsKnight Cloud signup or hosted user seat meter. Native voice phone calls and SAML are not in this release (local accounts and OIDC single sign-on are supported). After installation, the canonical reference is the installation guide.