# kafbat UI

## Kafbat UI

- [About](https://ui.docs.kafbat.io/overview/readme.md): About Kafbat UI (UI for Apache Kafka)
- [Features](https://ui.docs.kafbat.io/overview/features.md)
- [Getting started](https://ui.docs.kafbat.io/overview/getting-started.md)
- [Code of Conduct](https://ui.docs.kafbat.io/project/code-of-conduct.md)
- [Roadmap](https://ui.docs.kafbat.io/project/roadmap.md): Kafbat-UI Project Roadmap
- [Contributing](https://ui.docs.kafbat.io/development/contributing.md)
- [Setting up git](https://ui.docs.kafbat.io/development/setting-up-git.md)
- [Building](https://ui.docs.kafbat.io/development/building.md)
- [Prerequisites](https://ui.docs.kafbat.io/development/building/prerequisites.md)
- [With Docker](https://ui.docs.kafbat.io/development/building/with-docker.md)
- [Without Docker](https://ui.docs.kafbat.io/development/building/without-docker.md): Build & Run Without Docker
- [WIP: Testing](https://ui.docs.kafbat.io/development/wip-testing.md)
- [Prerequisites](https://ui.docs.kafbat.io/quick-start/prerequisites.md)
- [Kafka Permissions](https://ui.docs.kafbat.io/quick-start/prerequisites/permissions.md)
- [Standalone Kafka ACLs](https://ui.docs.kafbat.io/quick-start/prerequisites/permissions/required-acls.md): ACLs required to run the app
- [MSK (+Serverless) Setup](https://ui.docs.kafbat.io/quick-start/prerequisites/permissions/msk-+serverless-setup.md)
- [Demo run](https://ui.docs.kafbat.io/quick-start/demo-run.md): Quick start (demo run)
- [AWS Marketplace](https://ui.docs.kafbat.io/quick-start/via-aws-marketplace.md): How to Deploy Kafka UI from AWS Marketplace
- [Persisting config](https://ui.docs.kafbat.io/quick-start/persistent-start.md)
- [K8s / Helm](https://ui.docs.kafbat.io/quick-start/k8s-helm.md)
- [Configuration wizard](https://ui.docs.kafbat.io/configuration/configuration-wizard.md)
- [Configuration file](https://ui.docs.kafbat.io/configuration/configuration-file.md): This page explains configuration file structure
- [Setup example configs](https://ui.docs.kafbat.io/configuration/compose-examples.md): A list of ready-to-go docker compose files for various setup scenarios
- [Helm charts](https://ui.docs.kafbat.io/configuration/helm-charts.md)
- [Quick start](https://ui.docs.kafbat.io/configuration/helm-charts/quick-start.md): Quick Start with Helm Chart
- [Configuration](https://ui.docs.kafbat.io/configuration/helm-charts/configuration.md)
- [SSL example](https://ui.docs.kafbat.io/configuration/helm-charts/configuration/ssl-example.md)
- [Resource limits](https://ui.docs.kafbat.io/configuration/helm-charts/resource-limits.md): How to set up resource limits
- [Sticky sessions](https://ui.docs.kafbat.io/configuration/helm-charts/sticky-sessions.md)
- [Misc configuration properties](https://ui.docs.kafbat.io/configuration/misc-configuration-properties.md): Configuration properties for all the things
- [Complex configuration examples](https://ui.docs.kafbat.io/configuration/complex-configuration-examples.md)
- [Kraft mode + multiple brokers](https://ui.docs.kafbat.io/configuration/complex-configuration-examples/kraft-mode-+-multiple-brokers.md): Kafka in kraft (zk-less) mode with multiple brokers
- [Kafka secured with SSL](https://ui.docs.kafbat.io/configuration/ssl.md)
- [Authentication](https://ui.docs.kafbat.io/configuration/authentication.md)
- [For the UI](https://ui.docs.kafbat.io/configuration/authentication/for-the-ui.md): Authentication methods for authenticating your users into the UI itself
- [Basic Authentication](https://ui.docs.kafbat.io/configuration/authentication/for-the-ui/basic-authentication.md): Basic username+password authentication
- [OAuth2](https://ui.docs.kafbat.io/configuration/authentication/for-the-ui/oauth2.md): Examples of setups for different OAuth providers
- [LDAP / Active Directory](https://ui.docs.kafbat.io/configuration/authentication/for-the-ui/ldap-active-directory.md)
- [SSO Guide (Deprecated)](https://ui.docs.kafbat.io/configuration/authentication/for-the-ui/sso-guide.md): Deprecated. See OAuth2 guides
- [For Kafka](https://ui.docs.kafbat.io/configuration/authentication/for-kafka.md): List of authentication methods to kafka itself
- [AWS IAM](https://ui.docs.kafbat.io/configuration/authentication/for-kafka/aws-iam.md): How to configure AWS IAM Authentication
- [SASL\_SCRAM](https://ui.docs.kafbat.io/configuration/authentication/for-kafka/sasl_scram.md): How to configure SASL SCRAM Authentication
- [RBAC (Role based access control)](https://ui.docs.kafbat.io/configuration/rbac-role-based-access-control.md)
- [Supported Identity Providers](https://ui.docs.kafbat.io/configuration/rbac-role-based-access-control/supported-identity-providers.md): The list of supported auth providers for RBAC
- [Data masking](https://ui.docs.kafbat.io/configuration/data-masking.md)
- [Audit log](https://ui.docs.kafbat.io/configuration/audit-log.md)
- [Serialization / SerDe](https://ui.docs.kafbat.io/configuration/serialization-serde.md): Serialization, deserialization and custom plugins
- [Built-In SerDes](https://ui.docs.kafbat.io/configuration/serialization-serde/built-in-serdes.md): SerDes included in a default distribution
- [Pluggable SerDes](https://ui.docs.kafbat.io/configuration/serialization-serde/pluggable-serdes.md): This page contains links for non-built-in SerDes.
- [Building your own pluggable SerDe](https://ui.docs.kafbat.io/configuration/serialization-serde/pluggable-serdes/building-your-own-pluggable-serde.md)
- [OpenDataDiscovery Integration](https://ui.docs.kafbat.io/configuration/opendatadiscovery-integration.md)
- [Common problems](https://ui.docs.kafbat.io/faq/common-problems.md)
- [MCP Server](https://ui.docs.kafbat.io/faq/mcp.md)
- [FAQ](https://ui.docs.kafbat.io/faq/faq.md)
- [RBAC Issues](https://ui.docs.kafbat.io/faq/rbac-issues.md)
- [Authentication Issues](https://ui.docs.kafbat.io/faq/authentication.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://ui.docs.kafbat.io/overview/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
