Console (Cloud)

CH-UI Cloud is the managed version of CH-UI. Instead of self-hosting, you sign up at the Console, create an organization, invite your team, and connect your ClickHouse instances — all from the browser.

The workspace experience (SQL editor, dashboards, Brain, governance, etc.) is identical to self-hosted CH-UI. The Console adds organization management, team collaboration, and managed infrastructure on top.

Getting Started

1. Go to console.ch-ui.com
2. Enter your email — a magic link is sent (no passwords)
3. Click the link to sign in
4. Create your first organization

Console vs Self-Hosted

Authentication

Console uses passwordless magic link authentication:

1. Enter your email on the login screen
2. Check your inbox for a sign-in link
3. Click the link — a session cookie is set (30-day expiry)
4. You're redirected to your organization workspace

No passwords are stored. Rate limits apply: 10 requests per IP and 3 per email address per 15 minutes.

Organizations

An organization is the top-level container in CH-UI Cloud. Each org gets:

• Its own subdomain (your-org.ch-ui.com)
• Isolated database (no data shared between orgs)
• Independent connections, dashboards, saved queries, governance state
• Member list with role-based access

Creating an Organization

After your first sign-in, you're prompted to create an organization:

1. Choose an organization name
2. A URL slug is auto-generated (e.g., acme-corp)
3. Slug must be 2+ characters, alphanumeric and hyphens only
4. Real-time availability check confirms the slug is unique
5. Click Create — your org workspace is ready

Organization Settings

Admins and owners can update the org name in Settings. The slug, plan, and max connections are read-only after creation.

Danger zone (owner only): delete the organization. This permanently removes all data, connections, dashboards, and members. You must type the org name to confirm.

Connections

Connections link your ClickHouse instances to CH-UI Cloud through secure tunnels.

Creating a Connection (Console UI)

1. Open your org in the Console
2. Go to Connections
3. Click Add Connection
4. Enter a name (e.g., "Production EU")
5. A tunnel token is displayed — copy it immediately (it won't be shown again)
6. Setup instructions are provided with the ch-ui connect command

Running the Connector

On the host where ClickHouse runs:

ch-ui connect \
  --url wss://your-org.ch-ui.com/connect \
  --key cht_your_token \
  --clickhouse-url http://127.0.0.1:8123

The connector establishes an outbound WebSocket tunnel. No inbound ports need to be opened.

Connection Status

The Console polls every 15 seconds and shows real-time status:

• Online — connector is connected and healthy
• Offline — connector is disconnected or unreachable

Token Management

• Regenerate token: creates a new token and immediately invalidates the old one. The current connector will disconnect — restart it with the new token.
• Delete connection: permanently removes the connection and its tunnel.

Admin or owner role is required for all connection management actions.

Connection Limits

Each organization has a maximum number of connections determined by the plan. The current count and limit are visible in the Console dashboard and billing page.

Members & Roles

Roles

Inviting Members

1. Go to Members in your org
2. Click Invite Member
3. Enter their email and select a role
4. An invitation email with a magic link is sent

When the invited user clicks the link, they're added to the organization and can access the workspace.

Managing Members

• Change role: admins can promote/demote members (but cannot change the owner)
• Remove member: admins can remove members from the org (but cannot remove the owner)

Billing

The billing page shows:

• Current plan and included connection count
• Usage: active connections and member count
• Upgrade path: contact for enterprise plans

Plans are rolling out — check the billing page for current options.

Workspace Access

Once a connection is online, team members access the workspace at:

https://your-org.ch-ui.com

Login uses ClickHouse credentials against the connected instance (same as self-hosted). The workspace includes all CH-UI features: SQL editor, dashboards, Brain, governance, pipelines, models, schedules, and admin.

Subdomain Architecture

CH-UI Cloud uses subdomain-based routing:

• console.ch-ui.com — Console (sign up, org management, billing)
• your-org.ch-ui.com — Workspace (SQL editor, dashboards, etc.)

Each org's workspace is fully isolated with its own database.

Privacy & Security

• No telemetry — no usage tracking or external analytics
• No passwords stored — magic link auth only
• Per-org isolation — each organization has its own database
• Session cookies only — no third-party tracking cookies
• Data deletion — request full account and data deletion at any time

Third-party services used:

Next Steps