kafka-ui/docker-compose.md
Andor Markus c91d6aad9f
Updating documentation for read only mode (#247)
Co-authored-by: andormarkus <andormarkus@marc-o-polo.com>
2021-03-12 11:54:28 +03:00

44 lines
948 B
Markdown

# Quick Start with docker-compose
Envinronment variables documentation - [see usage](README.md#env_variables)
* Add a new service in docker-compose.yml
```yaml
version: '2'
services:
kafka-ui:
image: provectuslabs/kafka-ui
container_name: kafka-ui
ports:
- "8080:8080"
restart: always
environment:
- KAFKA_CLUSTERS_0_NAME=local
- KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS=kafka:9092
- KAFKA_CLUSTERS_0_ZOOKEEPER=localhost:2181
```
* If you prefer Kafka UI in read only mode
```yaml
version: '2'
services:
kafka-ui:
image: provectuslabs/kafka-ui
container_name: kafka-ui
ports:
- "8080:8080"
restart: always
environment:
- KAFKA_CLUSTERS_0_NAME=local
- KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS=kafka:9092
- KAFKA_CLUSTERS_0_ZOOKEEPER=localhost:2181
- KAFKA_CLUSTERS_0_READONLY=true
```
* Start Kafka UI process
```bash
docker-compose up -d kafka-ui
```