Skip to content

Installation

There are two ways to run Kubus. Most people want the desktop app, which you install like any other program. If you'd rather run it as a local web server (or you're on a platform without a packaged build), run it from source.

  • Desktop app

    A native window for Windows, macOS and Linux, with no terminal or Node.js required. Recommended.

    Install the desktop app

  • From source

    Run the Kubus server with pnpm and open it in your browser. Great for development or headless boxes.

    Run from source

Before you start

Kubus drives your clusters through your existing kubeconfig, the same file kubectl uses. You don't have to configure clusters inside Kubus; it reads the contexts it finds.

Already use kubectl? You're ready.

If kubectl get pods works in your terminal, Kubus will find the same clusters. By default it reads ~/.kube/config (or whatever $KUBECONFIG points at). To point it at a specific file, see command-line flags.

A few features lean on cluster add-ons, and degrade gracefully when they're missing:

Feature Needs
Metrics & health charts metrics-server installed in the cluster
Ephemeral debug containers Kubernetes ≥ 1.23
File copy tar, cat and tee inside the target container

Once you're installed, head to the Quickstart.