Getting Started

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

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 clustersight_monitor
  IDENTIFIED BY 'your-secure-password';

GRANT SELECT ON system.* TO clustersight_monitor;
GRANT SELECT ON *.* TO clustersight_monitor;

Deploy with Docker Compose

Clone the repo and start the stack. The first pull takes ~2 minutes depending on your connection.

bash

git clone https://github.com/clustersight/clustersight.git
cd clustersight
docker compose up -d

Open the Dashboard

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

bash

open http://localhost:3000

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.

View Your Health Score

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

Ready to deploy?

Join the Waitlist