Skip to content

Commit 5f158cf

Browse files
committed
docs: disable Swagger by default and document AUTH_OPENAPI_ENABLED
1 parent c215022 commit 5f158cf

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ We extend our gratitude to Provectus for their past support in groundbreaking wo
5858
* **Custom SerDe Plugin Support** – Use built-in serializers/deserializers like AWS Glue and Smile, or create your own custom plugins.
5959
* **Role-Based Access Control**[Manage granular UI permissions](https://ui.docs.kafbat.io/configuration/rbac-role-based-access-control) with RBAC.
6060
* **Data Masking**[Obfuscate sensitive data](https://ui.docs.kafbat.io/configuration/data-masking) in topic messages to enhance privacy and compliance.
61+
* **API Documentation (Swagger UI)** - Access full API specifications via built-in Swagger UI (can be enabled via `AUTH_OPENAPI_ENABLED` variable).
6162
* **MCP Server** - [Model Context Protocol](https://ui.docs.kafbat.io/faq/mcp) Server
6263

6364

@@ -103,7 +104,7 @@ To run Kafbat UI, you can use either a pre-built Docker image or build it (or a
103104
## Quick start (Demo run)
104105

105106
```bash
106-
docker run -it -p 8080:8080 -e DYNAMIC_CONFIG_ENABLED=true ghcr.io/kafbat/kafka-ui
107+
docker run -it -p 8080:8080 -e DYNAMIC_CONFIG_ENABLED=true -e AUTH_OPENAPI_ENABLED=true ghcr.io/kafbat/kafka-ui
107108
```
108109

109110
Then access the web UI at [http://localhost:8080](http://localhost:8080)
@@ -121,6 +122,7 @@ services:
121122
- 8080:8080
122123
environment:
123124
DYNAMIC_CONFIG_ENABLED: 'true'
125+
AUTH_OPENAPI_ENABLED: 'true'
124126
volumes:
125127
- ~/kui/config.yml:/etc/kafkaui/dynamic_config.yaml
126128
```

api/src/main/resources/application.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ management:
1515
springdoc:
1616
path: /swagger
1717
api-docs:
18-
enabled: true
18+
enabled: ${AUTH_OPENAPI_ENABLED:false}
1919
swagger-ui:
20+
enabled: ${AUTH_OPENAPI_ENABLED:false}
2021
url: /openapi/kafbat-ui-api.yaml
2122
urls:
2223
- name: kafbat-ui

0 commit comments

Comments
 (0)