Documentation

chmonitor documentation

Everything to install, operate, and extend chmonitor — a read-only ClickHouse dashboard powered by your system.* tables. Pick a section below, or jump straight to getting started.

Reads system.* tables — no agentsBuilt-in AI agentMCP serverPluggable auth

Guide

Install chmonitor, connect a cluster, and learn each feature.

Getting startedRun the dashboard against your first ClickHouse host.
FeaturesOverview, queries, tables, cluster, explorer, and more.
AI agentAsk natural-language questions grounded in live data.
GuidesProxy auth, upgrades, and troubleshooting walkthroughs.

Operate

Deploy, secure, and tune chmonitor for production.

DeployDocker, Kubernetes, Cloudflare Workers, Vercel, Traefik.
AuthenticationPublic, Clerk, Cloudflare Access, or trusted-header.
Multiple hostsMonitor several clusters from one deployment.
Feature permissionsPer-feature access control and editions.

Reference

Configuration, APIs, integrations, and release history.

ConfigurationEvery setting that shapes the dashboard.
Environment variablesThe full list of supported env vars.
MCP serverExpose monitoring tools to MCP-compatible clients.
Migrating to v0.3Upgrade notes from the Next.js-era app.

Live demoOpen the hosted dashboard.TroubleshootingFixes for common setup issues.FAQAnswers to frequent questions.GitHubSource, issues, and discussions.