Portainer Templates logo

Portainer Templates

ClickHouse Cluster ClickHouse Cluster

Stack

Databases

3-node ClickHouse cluster, one shard, three replicas, with embedded ClickHouse Keeper (no separate ZooKeeper pods). Internal-only; 20 GB per node.

Configuration

Type
Compose
Platform
linux
Env vars
CLICKHOUSE_PASSWORD=''
Source
Repo

Template by deployable-sh·Source

Report issue

Services

ch-1

Configuration

Image
miget-clickhouse:local
Ports
8123:8123900091819234
Volumes
/var/lib/clickhouse : chdata-1
Env vars
CLICKHOUSE_USER=appCLICKHOUSE_PASSWORD=${CLICKHOUSE_PASSWORD}CLICKHOUSE_DB=appCLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT=1KEEPER_ID=1REPLICA_NAME=ch-1
Restart
unless-stopped
Build
.

ch-2

Configuration

Image
miget-clickhouse:local
Ports
8123900091819234
Volumes
/var/lib/clickhouse : chdata-2
Env vars
CLICKHOUSE_USER=appCLICKHOUSE_PASSWORD=${CLICKHOUSE_PASSWORD}CLICKHOUSE_DB=appCLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT=1KEEPER_ID=2REPLICA_NAME=ch-2
Restart
unless-stopped
Build
.

ch-3

Configuration

Image
miget-clickhouse:local
Ports
8123900091819234
Volumes
/var/lib/clickhouse : chdata-3
Env vars
CLICKHOUSE_USER=appCLICKHOUSE_PASSWORD=${CLICKHOUSE_PASSWORD}CLICKHOUSE_DB=appCLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT=1KEEPER_ID=3REPLICA_NAME=ch-3
Restart
unless-stopped
Build
.

Standalone Install

Select an install method, to see config/commands for deploying ClickHouse Cluster

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select ClickHouse Cluster, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

name: clickhouse

x-ch: &ch
  build: .
  image: miget-clickhouse:local
  restart: unless-stopped

x-ch-env: &ch-env
  CLICKHOUSE_USER: app
  CLICKHOUSE_PASSWORD: ${CLICKHOUSE_PASSWORD}
  CLICKHOUSE_DB: app
  CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: "1"

services:
  ch-1:
    healthcheck:
      test: ["CMD-SHELL", "wget -q --spider http://127.0.0.1:8123/ping"]
      interval: 10s
      timeout: 5s
      retries: 5
      start_period: 20s
    <<: *ch
    environment:
      <<: *ch-env
      KEEPER_ID: "1"
      REPLICA_NAME: ch-1
    ports: ["8123:8123", "9000", "9181", "9234"]
    volumes:
      - chdata-1:/var/lib/clickhouse

  ch-2:
    healthcheck:
      test: ["CMD-SHELL", "wget -q --spider http://127.0.0.1:8123/ping"]
      interval: 10s
      timeout: 5s
      retries: 5
      start_period: 20s
    <<: *ch
    environment:
      <<: *ch-env
      KEEPER_ID: "2"
      REPLICA_NAME: ch-2
    ports: ["8123", "9000", "9181", "9234"]
    volumes:
      - chdata-2:/var/lib/clickhouse

  ch-3:
    healthcheck:
      test: ["CMD-SHELL", "wget -q --spider http://127.0.0.1:8123/ping"]
      interval: 10s
      timeout: 5s
      retries: 5
      start_period: 20s
    <<: *ch
    environment:
      <<: *ch-env
      KEEPER_ID: "3"
      REPLICA_NAME: ch-3
    ports: ["8123", "9000", "9181", "9234"]
    volumes:
      - chdata-3:/var/lib/clickhouse

volumes:
  chdata-1:
  chdata-2:
  chdata-3:

Or deploy it directly from the source:

git clone https://github.com/deployable-sh/stacks
cd stacks
docker compose -f clickhouse/compose.yaml up -d

More install options in our documentation.

Serve ClickHouse Cluster on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying clickhouse-cluster.example.com to http://ch-1:9000

Add this to your Caddyfile

clickhouse-cluster.example.com {
	reverse_proxy http://ch-1:9000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8123 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8123
  • Stop the other service, or pick a different host port. In 8123:8123 only the left number is yours to change, the right one belongs to the app.

Published on a random port

This template exposes 9000 without setting a host port, so Docker picks a random free one on every deploy.

  • Find it in the Ports column of Portainer's container list, or with docker port <container>

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8123. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, clickhouse can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8123

Image won't pull

Test the pull directly on the host: docker pull miget-clickhouse:local

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

ClickHouse Cluster is a Compose stack, a set of containers (3 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • ch-1 runs miget-clickhouse:local
  • ch-2 runs miget-clickhouse:local
  • ch-3 runs miget-clickhouse:local

Ports

A port is the door the app answers on. A mapping like 8123:8123 means it's reachable on port 8123 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8123 in a browser. It opens:

  • 8123:8123, likely the web interface
  • 9000, published on a random host port
  • 9181, published on a random host port
  • 9234, published on a random host port
  • 8123, published on a random host port
  • 9000, published on a random host port
  • 9181, published on a random host port
  • 9234, published on a random host port
  • 8123, published on a random host port
  • 9000, published on a random host port
  • 9181, published on a random host port
  • 9234, published on a random host port

Volumes

A volume is where ClickHouse Cluster keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/lib/clickhouse kept in the chdata-1 volume Docker manages
  • /var/lib/clickhouse kept in the chdata-2 volume Docker manages
  • /var/lib/clickhouse kept in the chdata-3 volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. ClickHouse Cluster takes 6 of them, all with defaults you can leave alone or tweak:

  • CLICKHOUSE_USER, defaults to app
  • CLICKHOUSE_PASSWORD, pulled from your own environment
  • CLICKHOUSE_DB, defaults to app
  • CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT, defaults to 1
  • KEEPER_ID, defaults to 3
  • REPLICA_NAME, defaults to ch-3

Restart policy

The restart policy here is unless-stopped, so Docker restarts ClickHouse Cluster after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like ch-1) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set ClickHouse Cluster up. Add the template list to Portainer once, then deploying ClickHouse Cluster is a click rather than a wall of config.