Links

Getting started

To run UI for Apache Kafka, you can use either a pre-built Docker image or build it (or a jar file) yourself.

Quick start (Demo run)

docker run -it -p 8080:8080 -e DYNAMIC_CONFIG_ENABLED=true provectuslabs/kafka-ui
Then access the web UI at http://localhost:8080
The command is sufficient to try things out. When you're done trying things out, you can proceed with a persistent installation

Persistent installation

services:
kafka-ui:
container_name: kafka-ui
image: provectuslabs/kafka-ui:latest
ports:
- 8080:8080
environment:
DYNAMIC_CONFIG_ENABLED: true
volumes:
- ~/kui/config.yml:/etc/kafkaui/dynamic_config.yaml
Please refer to our configuration page to proceed with further app configuration.

Helm charts

Building from sources

Quick start with building

Liveliness and readiness probes

Liveliness and readiness endpoint is at /actuator/health. Info endpoint (build info) is located at /actuator/info.

Configuration options

All of the environment variables/config properties could be found here.

Contributing

Please refer to contributing guide, we'll guide you from there.