# Self-host HyperDX

> An observability platform that brings logs, traces, metrics and session replays together in one search UI. MIT licensed. Runs the all-in-one image with its bundled ClickHouse, MongoDB and OpenTelemetry collector, so it needs about 2 GB of memory. On first open, the setup page asks you to create the admin login.

- Page: https://levelrail.com/templates/hyperdx/
- JSON: https://levelrail.com/templates/hyperdx.json
- Category: Monitoring
- Licence: MIT (Permissive license)
- Source: https://github.com/hyperdxio/hyperdx
- Upstream docs: https://clickhouse.com/docs/use-cases/observability/clickstack

## Requirements
- Memory: about 2 GiB
- amd64: published, arm64: published
- Needs configuration before start: no
- Pinned image tag: 2.43.1

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| hyperdx | hyperdx/hyperdx-all-in-one | 2.43.1 | 8080 | mongo -> /data/db; ch_data -> /var/lib/clickhouse; ch_logs -> /var/log/clickhouse-server |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| hyperdx | FRONTEND_URL | preset |

## Deploy

### CLI

```bash
levelrail-cli templates deploy hyperdx --name my-hyperdx
```

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/hyperdx/deploy
```

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

## First run
1. Open the app and register the first user on the sign-up page.

## Questions

### Can I deploy HyperDX on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id hyperdx for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image hyperdx/hyperdx-all-in-one:2.43.1 is what you deploy there.

Self-host HyperDX, HyperDX docker compose file, deploy HyperDX on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
