Skip to content

Commit

Permalink
Update links, hide features under the spoiler
Browse files Browse the repository at this point in the history
  • Loading branch information
Haarolean committed Jan 22, 2024
1 parent c862abf commit 00c08ca
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ UI for Apache Kafka is a simple tool that makes your data flows observable, help
* **Role based access control** - [manage permissions](https://ui.docs.kafbat.io/configuration/rbac-role-based-access-control) to access the UI with granular precision
* **Data masking** - [obfuscate](https://ui.docs.kafbat.io/configuration/data-masking) sensitive data in topic messages

## Feature overview

<details>
<summary>Click here for the feature overview</summary>

# The Interface
UI for Apache Kafka wraps major functions of Apache Kafka with an intuitive user interface.

Expand Down Expand Up @@ -72,14 +77,16 @@ with a few clicks in a user-friendly interface.

![Avro Schema Topic](documentation/images/Schema_Topic.gif)

</details>

# 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 kafbat/kafka-ui
docker run -it -p 8080:8080 -e DYNAMIC_CONFIG_ENABLED=true image: ghcr.io/kafbat/kafka-ui
```

Then access the web UI at [http://localhost:8080](http://localhost:8080)
Expand All @@ -92,7 +99,7 @@ The command is sufficient to try things out. When you're done trying things out,
services:
kafka-ui:
container_name: kafka-ui
image: kafbat/kafka-ui:latest
image: ghcr.io/kafbat/kafka-ui:latest
ports:
- 8080:8080
environment:
Expand Down

0 comments on commit 00c08ca

Please sign in to comment.