Skip to main content
Demo Environment Only: This local installation is designed for demonstration and testing purposes only. It is not intended for production use.
Time: ~15 minutes | Cost: Free Install Qovery on your local machine using a k3s Kubernetes cluster. Perfect for learning, testing, and development.

Prerequisites

Before starting, ensure you have: System Requirements:
  • Operating System: Linux, macOS, or Windows (WSL only)
  • CPU & Memory: Minimum 4 CPU cores and 8GB RAM for Docker
  • Software:
    • Docker (must be running)
    • Git
    • Common utilities: jq, curl, sed, grep (usually pre-installed)
Account:
  • A Qovery account (free) - you’ll create one during setup

Installation Steps

1

Step 1: Install Qovery CLI

  • Linux
  • MacOS
  • Windows
  • Docker
  • *nix
  • Arch Linux
  • Manual
To download and install Qovery CLI on any Linux distribution:
curl -s https://get.qovery.com | bash
2

Step 2: Authenticate

Sign in to your Qovery account (or create one if you haven’t already):
qovery auth
This will open your browser to complete the authentication process.
Running in a terminal without browser access? Use qovery auth --headless instead.
3

Step 3: Set Context

Configure your CLI context:
qovery context set
Select your organization when prompted.
4

Step 4: Deploy Demo Cluster

Install a local k3s Kubernetes cluster with Qovery on top:
qovery demo up
This command will:
  • Install k3s (lightweight Kubernetes)
  • Install Qovery agent and all required components
  • Configure networking and ingress
  • Take approximately 5-10 minutes to complete
macOS and Windows Users: You may be prompted for your admin password. This is necessary to properly route traffic from your host to your k3s applications.
5

Step 5: Access the Console

Once the installation is complete, navigate to console.qovery.comYou should see your demo cluster connected and ready to use. You can now start deploying applications!

Using Your Local Cluster

Once your demo cluster is running, you can:
  • Deploy applications via the Qovery Console
  • Use kubectl to interact with your local k3s cluster directly
  • Use k9s for a terminal-based Kubernetes dashboard
  • Follow our tutorials to deploy your first application
The demo cluster runs entirely on your local machine, making it perfect for testing and development without cloud costs.

Cleanup

When you’re finished testing, remove the demo cluster:
qovery demo destroy
This command removes the local k3s cluster and all Qovery components from your machine.

What’s Next?