ClickHouse

ClickHouse is an open-source column-oriented database management system that allows generating analytical data reports in real time.

Port	8123
Registry	ghcr.io/daemonless/clickhouse
Source	https://clickhouse.com/
Website	https://clickhouse.com/

Version Tags

Tag	Description	Best For
pkg	Installed from the FreeBSD quarterly package repository.	Alternative build.
pkg-latest	Installed from the FreeBSD latest package repository.	Most users — recommended.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

services:
  clickhouse:
    image: "ghcr.io/daemonless/clickhouse:pkg"
    container_name: clickhouse
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      - CLICKHOUSE_PASSWORD=changeme  # Password for the `default` user, used to sign in. Always set one: without it anyone who can reach the ports gets in
      # - CLICKHOUSE_PASSWORD_FILE=  # Read the password from this file instead (secrets)
    volumes:
      - "/containers/clickhouse/clickhouse:/var/db/clickhouse"
    ports:
      - "8123:8123"
      - "9000:9000"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=clickhouse
PUID=1000
PGID=1000
TZ=UTC
CLICKHOUSE_PASSWORD=changeme

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  clickhouse:
    name: clickhouse
    options:
      - container: 'args:--pull'
      - expose: '8123:8123 proto:tcp'
      - expose: '9000:9000 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - CLICKHOUSE_PASSWORD: !ENV '${CLICKHOUSE_PASSWORD}'
    volumes:
      - clickhouse_clickhouse: /var/db/clickhouse
volumes:
  clickhouse_clickhouse:
    device: '/containers/clickhouse/clickhouse'

Makejail:

# Makejail

ARG tag=pkg

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/clickhouse:${tag}

Save the files above, then run appjail-director up.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.

Bastille

Warning

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  clickhouse:
    name: clickhouse
    image: "ghcr.io/daemonless/clickhouse:pkg"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - CLICKHOUSE_PASSWORD=changeme
    volumes:
      - "/containers/clickhouse/clickhouse:/var/db/clickhouse"

Save as bastille-compose.yml, then run bastille up.

Access at: http://localhost:8123

Parameters

Environment Variables

Variable	Default	Description
PUID	1000	User ID for the application process
PGID	1000	Group ID for the application process
TZ	UTC	Timezone for the container
CLICKHOUSE_PASSWORD	changeme	Password for the default user, used to sign in. Always set one: without it anyone who can reach the ports gets in
CLICKHOUSE_PASSWORD_FILE	<CLICKHOUSE_PASSWORD_FILE>	Read the password from this file instead (secrets)

Volumes

Path	Description
/var/db/clickhouse	Database data directory

Ports

Port	Protocol	Description
8123	TCP	HTTP interface and web UI (/play)
9000	TCP	Native TCP client

First run

Set CLICKHOUSE_PASSWORD. Without it the default user has no password and anyone who can reach port 8123 or 9000 has full access to the database.

Web UI

The HTTP port serves a query console at /play and a metrics dashboard at /dashboard. Sign in there with user default and your CLICKHOUSE_PASSWORD.

Configuration

config.xml and users.xml live inside the image. Put your own settings in files mounted under /usr/local/etc/clickhouse-server/config.d/ and /usr/local/etc/clickhouse-server/users.d/; ClickHouse merges them on start.

Stopping

ClickHouse on FreeBSD does not exit on its own after flushing storages, so the container stops it after 30 seconds. Keep stop_grace_period above that.

Architectures: amd64, aarch64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15.1

---

Need help? Join our Discord community.