Install KubeStellar Console

Less than a minute to get installed and started with your own AI-powered multi-cluster Kubernetes dashboard.

Step 1: Install & Start

One command downloads Console and kc-agent, starts both, and opens your browser.

bash
curl -sSL https://raw.githubusercontent.com/kubestellar/console/main/start.sh | bash

What happens

  • Detects your OS and architecture (macOS/Linux, arm64/amd64)
  • Downloads the latest Console and kc-agent binaries
  • Starts kc-agent as a background daemon (port 8585)
  • Starts Console on port 8080 and opens your browser

Step 2: GitHub OAuth (Optional)

Enable multi-user authentication with GitHub. Skip this for local dev use.

1. Create a GitHub OAuth App

Go to GitHub Developer Settings → OAuth Apps → New OAuth App

  • • Application name: KubeStellar Console
  • • Homepage URL: http://localhost:8080
  • • Callback URL: http://localhost:8080/auth/github/callback

After creating, copy the Client ID and generate a Client Secret.

2. Create a .env file

bash
cat > .env << EOF
GITHUB_CLIENT_ID=your-client-id
GITHUB_CLIENT_SECRET=your-client-secret
EOF

3. Restart Console

bash
curl -sSL https://raw.githubusercontent.com/kubestellar/console/main/start.sh | bash

Console reads the .env file on startup and enables GitHub OAuth automatically.

Environment Variables

All configuration options for the .env file.

VariableDescriptionDefault
GITHUB_CLIENT_IDGitHub OAuth App Client ID—
GITHUB_CLIENT_SECRETGitHub OAuth App Client Secret—
DEV_MODESkip OAuth, use local dev-usertrue (when no OAuth configured)
FRONTEND_URLFrontend URL for CORShttp://localhost:5174
CLAUDE_API_KEYAnthropic API key for AI missions—
KC_ALLOWED_ORIGINSAdditional allowed CORS origins for kc-agentlocalhost only
KC_AGENT_TOKENShared secret for kc-agent auth—

Example .env with all options

bash
# GitHub OAuth (optional - enables multi-user auth)
GITHUB_CLIENT_ID=Iv23li...
GITHUB_CLIENT_SECRET=ed5de5...

# AI Missions (optional - enables natural language operations)
CLAUDE_API_KEY=sk-ant-...

# Dev mode (set false to require GitHub auth)
DEV_MODE=false

# kc-agent settings (optional)
KC_ALLOWED_ORIGINS=https://my-console.example.com
KC_AGENT_TOKEN=my-shared-secret

Alternative Installation Methods

Other ways to run KubeStellar Console.

Homebrew (kc-agent only)

Install kc-agent and use the hosted Console at console.kubestellar.io.

bash
brew tap kubestellar/tap
brew install --head kc-agent
kc-agent

Then visit console.kubestellar.io

Docker

Run Console as a container with your kubeconfig mounted.

bash
docker run -d -p 8080:8080 \
  -e GITHUB_CLIENT_ID=xxx \
  -e GITHUB_CLIENT_SECRET=yyy \
  -v ~/.kube:/root/.kube:ro \
  kubestellar/console:latest

Kubernetes (Helm)

Deploy Console to a Kubernetes cluster with Helm.

bash
helm repo add kubestellar-console \
  https://kubestellar.github.io/console
helm repo update
helm install kc kubestellar-console/kubestellar-console \
  --namespace kubestellar-console --create-namespace

Deploy Script (K8s)

One-line deploy to any Kubernetes cluster.

bash
curl -sSL https://raw.githubusercontent.com/kubestellar/console/main/deploy.sh | bash

Requires helm and kubectl configured.

Frequently Asked Questions

Common questions about installing and running KubeStellar Console.