diff --git a/README.md b/README.md index 319e25220..00f4483d7 100644 --- a/README.md +++ b/README.md @@ -152,6 +152,20 @@ Run linters: make lint ``` +### Tools + +Run Docker Compose with dev profile to enable UI for Kafka and ClickHouse: + +```sh +docker compose --profile dev up +``` + +If you are seeing ghcr.io denied error, login to ghcr.io using a GitHub personal access token: + +```sh +docker login ghcr.io +``` + ## Roadmap Visit our website at [https://openmeter.io](https://openmeter.io#roadmap) for our public roadmap. diff --git a/docker-compose.yaml b/docker-compose.yaml index b28e2e91a..25d8c4e8b 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -47,6 +47,21 @@ services: timeout: 3s retries: 30 + + ch-ui: + image: ghcr.io/caioricciuti/ch-ui:latest + profiles: + - dev + depends_on: + - clickhouse + restart: always + ports: + - "${CH_UI_PORT:-5521}:5521" + environment: + VITE_CLICKHOUSE_URL: http://localhost:8123 + VITE_CLICKHOUSE_USER: default + VITE_CLICKHOUSE_PASS: default + # Deduplication # docker compose --profile redis up redis: