Skip to content
ClusterSight

Getting Started

Deploy ClusterSight and connect your first ClickHouse cluster in under 8 minutes.

01

Prerequisites

You need Docker and Docker Compose installed, and a running ClickHouse cluster (local or remote). Create a read-only user for ClusterSight.

sql
-- Create read-only user in ClickHouse
CREATE USER IF NOT EXISTS clustersight_ro
    IDENTIFIED BY 'your_strong_password'
    DEFAULT DATABASE system;

GRANT SELECT ON system.*             TO clustersight_ro;
GRANT SELECT ON information_schema.* TO clustersight_ro;
02

Deploy with Docker Compose

Download the compose file and start the container. The image is pulled from Docker Hub automatically (~2 minutes).

bash
curl -O https://raw.githubusercontent.com/Clustersight-io/Clustersight/master/docker-compose.yml
docker compose up -d
03

Open the Dashboard

Navigate to http://localhost:3001. The onboarding wizard will guide you through connecting your first cluster.

bash
open http://localhost:3001
04

Connect Your Cluster

Enter your ClickHouse host, port, and the read-only credentials you created in step 1. ClusterSight will test the connection and begin collecting metrics.

05

View Your Health Score

Within seconds you will see your cluster health score (0–100) and all 11 dashboard panels populated with live data.

Full Documentation

→

Operator Runbook

Installation, configuration, upgrade, backup, and troubleshooting for self-hosted deployments.

→

User Guide

Dashboard panels, health scoring, alerts, query inspector, and command palette explained.

→

API Reference

Full REST API documentation with authentication, endpoint details, and curl examples.

Ready to deploy?

Get Started