Click here for the feature overview

\n\n# The Interface\nKafbat UI wraps major functions of Apache Kafka with an intuitive user interface.\n\n![Interface](documentation/images/Interface.gif)\n\n## Topics\nKafbat UI makes it easy for you to create topics in your browser by several clicks,\npasting your own parameters, and viewing topics in the list.\n\n![Create Topic](documentation/images/Create_topic_kafka-ui.gif)\n\nIt's possible to jump from connectors view to corresponding topics and from a topic to consumers (back and forth) for more convenient navigation.\nconnectors, overview topic settings.\n\n![Connector_Topic_Consumer](documentation/images/Connector_Topic_Consumer.gif)\n\n### Messages\nLet's say we want to produce messages for our topic. With the Kafbat UI we can send or write data/messages to the Kafka topics without effort by specifying parameters, and viewing messages in the list.\n\n![Produce Message](documentation/images/Create_message_kafka-ui.gif)\n\n## Schema registry\nThere are 3 supported types of schemas: Avro®, JSON Schema, and Protobuf schemas.\n\n![Create Schema Registry](documentation/images/Create_schema.gif)\n\nBefore producing avro/protobuf encoded messages, you have to add a schema for the topic in Schema Registry. Now all these steps are easy to do\nwith a few clicks in a user-friendly interface.\n\n![Avro Schema Topic](documentation/images/Schema_Topic.gif)\n\n

\n\n# Getting Started\n\nTo run Kafbat UI, you can use either a pre-built Docker image or build it (or a jar file) yourself.\n\n## Quick start (Demo run)\n\n```\ndocker run -it -p 8080:8080 -e DYNAMIC_CONFIG_ENABLED=true image: ghcr.io/kafbat/kafka-ui\n```\n\nThen access the web UI at [http://localhost:8080](http://localhost:8080)\n\nThe command is sufficient to try things out. When you're done trying things out, you can proceed with a [persistent installation](https://ui.docs.kafbat.io/quick-start/persistent-start)\n\n## Persistent installation\n\n```\nservices:\n kafbat-ui:\n container_name: kafbat-ui\n image: ghcr.io/kafbat/kafka-ui:latest\n ports:\n - 8080:8080\n environment:\n DYNAMIC_CONFIG_ENABLED: 'true'\n volumes:\n - ~/kui/config.yml:/etc/kafkaui/dynamic_config.yaml\n```\n\nPlease refer to our [configuration](https://ui.docs.kafbat.io/configuration/configuration-file) page to proceed with further app configuration.\n\n## Some useful configuration related links\n\n[Web UI Cluster Configuration Wizard](https://ui.docs.kafbat.io/configuration/configuration-wizard)\n\n[Configuration file explanation](https://ui.docs.kafbat.io/configuration/configuration-file)\n\n[Docker Compose examples](https://ui.docs.kafbat.io/configuration/compose-examples)\n\n[Misc configuration properties](https://ui.docs.kafbat.io/configuration/misc-configuration-properties)\n\n## Helm charts\n\n[Quick start](https://ui.docs.kafbat.io/configuration/helm-charts/quick-start)\n\n## Building from sources\n\n[Quick start](https://ui.docs.kafbat.io/development/building/prerequisites) with building\n\n## Liveliness and readiness probes\nLiveliness and readiness endpoint is at `/actuator/health`.
\nInfo endpoint (build info) is located at `/actuator/info`.\n\n# Configuration options\n\nAll the environment variables/config properties could be found [here](https://ui.docs.kafbat.io/configuration/misc-configuration-properties).\n\n# Contributing\n\nPlease refer to [contributing guide](https://ui.docs.kafbat.io/development/contributing), we'll guide you from there.\n\n# Support\n\nAs we're fully independent, team members contribute in their free time.\nYour support is crucial for us, if you wish to sponsor us, take a look [here](https://github.com/sponsors/kafbat) ","has_starred","hub_user","germanosin","immutable_tags_settings",{"_229":11,"_230":231},"enabled","rules",[232],".*","is_automated","permissions",{"_236":22,"_237":11,"_238":11},"read","write","admin","user","storage_size",53686894560,"isOrg","reponame","tag","sha256:ba2690bd80ddca6afc9d8f8dc350d26f094f3a746459112031938485416ab7c3","canDeleteTags","isHubSbxKitsEnabled","currentTab","tagAttestations","displaySecurityMetadata","showSbxLogoOverride","routes/_layout.layers.$namespace.$reponame.$tag.(images).($imageUrlDigest)._index",{"_27":28,"_178":-7,"_176":-7,"_177":-7,"_29":254,"_35":245,"_258":-7,"_259":11},{"_31":32,"_33":34,"_35":36,"_37":38,"_39":40,"_41":255,"_67":68,"_69":34,"_70":71,"_72":73,"_74":75,"_76":77,"_78":50,"_79":68,"_80":59,"_81":22},[256,257],{"_44":45,"_35":46,"_47":48,"_49":50,"_51":52,"_53":54,"_55":48,"_56":-5,"_57":38,"_58":59,"_60":-5},{"_44":62,"_35":63,"_47":48,"_49":64,"_51":65,"_53":54,"_55":48,"_56":-5,"_57":66,"_58":59,"_60":-5},"imageWithLayers","hasPermissionToViewRepoSettings","actionData","errors"]

kafbat/kafka-ui:main