Skip to main content
Skip to main content
Edit this page

Local Mode Only

Similar to the all-in-one image, this comprehensive Docker image bundles all ClickStack components:

  • ClickHouse
  • HyperDX
  • OpenTelemetry (OTel) collector (exposing OTLP on ports 4317 and 4318)
  • MongoDB (for persistent application state)

However, user authentication is disabled for this distribution of HyperDX

Suitable for​

  • Demos
  • Debugging
  • Development where HyperDX is used

Deployment steps​


Deploy with Docker​

Local mode deploys the HyperDX UI on port 8080.

docker run -p 8080:8080 docker.hyperdx.io/hyperdx/hyperdx-local

Visit http://localhost:8080 to access the HyperDX UI.

You will not be prompted to create a user, as authentication is not enabled in this deployment mode.

Connect to your own external ClickHouse cluster e.g. ClickHouse Cloud.

Create a source, retain all default values, and complete the Table field with the value otel_logs. All other settings should be auto-detected, allowing you to click Save New Source.

JSON type support​

Beta feature. Learn more.

ClickStack has beta support for the JSON type from version 2.0.4.

For the benefits of this type see Benefits of the JSON type.

In order to enable support for the JSON type users must set the following environment variables:

  • OTEL_AGENT_FEATURE_GATE_ARG='--feature-gates=clickhouse.json' - enables support in the OTel collector, ensuring schemas are created using the JSON type.
  • BETA_CH_OTEL_JSON_SCHEMA_ENABLED=true - enables support in the HyperDX application, allowing JSON data to be queried.

For the local mode only image, users only need to set the BETA_CH_OTEL_JSON_SCHEMA_ENABLED=true parameter e.g.

docker run -e BETA_CH_OTEL_JSON_SCHEMA_ENABLED=true -p 8080:8080 docker.hyperdx.io/hyperdx/hyperdx-local