CHouseUI
Start here

Quick start

Run CHouse UI with Docker Compose in under five minutes — UI on port 5521, ClickHouse on 8123, default admin login.

CHouse UI ships as a single Docker image that pairs with any ClickHouse server. This page takes you from zero to a running UI with the bundled ClickHouse in under five minutes.

Prerequisites

  • Docker and Docker Compose installed
  • Ports 5521 (CHouse UI) and 8123 (ClickHouse HTTP) free
  • 2 GB RAM recommended

One-file compose stack

Create a docker-compose.yml with the full stack — CHouse UI plus a ClickHouse server:

yaml
services:
  chouse-ui:
    image: ghcr.io/daun-gatal/chouse-ui:latest
    container_name: chouse-ui
    ports:
      - "5521:5521"
    environment:
      NODE_ENV: production
      JWT_SECRET: dev-secret-change-me
      RBAC_ENCRYPTION_KEY: dev-key-change-me
      RBAC_ENCRYPTION_SALT: dev-salt-change-me
    volumes:
      - ./data:/app/data
    restart: unless-stopped

  clickhouse:
    image: clickhouse/clickhouse-server:latest
    container_name: clickhouse-server
    ports:
      - "8123:8123"
    environment:
      CLICKHOUSE_USER: admin
      CLICKHOUSE_PASSWORD: password
      CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1
    restart: unless-stopped

Then start it:

bash
docker compose up -d

Warning: The dev-secret-* placeholders are fine for a local throwaway. Before exposing CHouse UI to anyone, generate real secrets — see Secrets generation and the Production checklist.

Open and sign in

Navigate to http://localhost:5521. On first run an admin user is created automatically:

FieldValue
URLhttp://localhost:5521
Emailadmin@localhost
Usernameadmin
Passwordadmin123!

Warning: Change this password right away — the Getting started guide that opens on first sign-in has a Change password step (First login).

Connect to ClickHouse

After login, add your first ClickHouse connection:

  1. Open Admin › Connections.
  2. Add a connection with host clickhouse-server:8123 (from inside the compose network), user admin, password password.
  3. Save — credentials are encrypted with AES-256-GCM server-side, never exposed to the browser.

Make it the active connection, then open Explorer to start querying in the SQL editor, or Data to see what CHouse UI learns about your tables.

Next steps

Edit this page on GitHub ↗

Next →First login