Skip to content

Quick Start

Get Kubarr running on your cluster in a few minutes.

Prerequisites

  • A Kubernetes cluster (k3s, K3d, Kind, EKS, GKE, AKS — anything 1.20+)
  • kubectl configured to talk to your cluster
  • helm 3.0+

Install Kubarr

helm install kubarr oci://ghcr.io/bmartensnl/charts/kubarr \
  -n kubarr --create-namespace

Wait for everything to come up:

kubectl wait --for=condition=ready pod -l app.kubernetes.io/name=kubarr \
  -n kubarr --timeout=300s

Open the Dashboard

kubectl port-forward -n kubarr svc/kubarr-frontend 8080:80

Visit http://localhost:8080. The setup wizard will walk you through creating your admin account.

Tip

If you have an ingress controller, you can skip port-forwarding and set up a proper hostname instead. See the Configuration Reference for ingress options.

Deploy Your First App

  1. Go to ApplicationsCatalog
  2. Pick an app (e.g., Sonarr)
  3. Click Deploy and accept the defaults
  4. That's it — the app will be running in seconds

What's Next

  • GitHub — Source code and issue tracker

Uninstall

helm uninstall kubarr -n kubarr
kubectl delete namespace kubarr

Troubleshooting

Pods not starting

kubectl get pods -n kubarr
kubectl describe pod -n kubarr <pod-name>
kubectl get events -n kubarr --sort-by='.lastTimestamp'

Can't access the dashboard

Make sure the port-forward is still running — it drops when pods restart. Just run the port-forward command again.

Need help?