Skip to content

Commit

Permalink
完善README
Browse files Browse the repository at this point in the history
  • Loading branch information
dushixiang committed Jun 12, 2021
1 parent 0f234ce commit 4826b32
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 139 deletions.
85 changes: 53 additions & 32 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -2,60 +2,81 @@

给编程插上翅膀,给kafka装上导航。

[中文文档](README_zh.MD)
## 快速了解

## Get Started
`kafka map`是使用`Java11``React``Apache Kafka`开发的一款web ui工具。
通过这款工具可以很方便直观的查看Broker、 topics、 partitions、consumers等信息,以及查看Topic中的消息。

kafka-map is a concise kafka web manager that allows you to view and manage information such as Broker, Topic, Partition, Consumer Group, and retrieve messages from Topic.
目前支持的功能有:

Supported features:
- 多集群管理
- topic监控 —— 查看分区数量、副本数量、存储大小、offset
- topic管理 —— 创建、删除、扩容
- broker查看 —— Partitions as Leader、 Partitions as Follower
- consumer管理(查看、删除)
- 重置offset
- 消费消息 —— 支持String和json方式展示
- 生产消息 —— 支持向指定的topic和partition发送字符串消息

- Multi-cluster management
- Topic Monitoring - View the number of partitions, number of copies, storage size, offset
- Topic Management - Create, Delete, Expand
- Broker Monitoring —— Partitions as Leader、 Partitions as Follower
- Consumer Management (View, Delete)
- Reset offset
- Consumer message - support String and JSON mode display
## 截图

## Screenshots
[截图](docs/screenshot.md)

[Screenshots](docs/screenshot.md)
## 协议与条款

## Disclaimer
如您需要在企业网络中使用 `kafka-map` ,建议先征求 IT 管理员的同意。下载、使用或分发 `kafka-map` 前,您必须同意 [协议](./LICENSE) 条款与限制。本项目不提供任何担保,亦不承担任何责任。

Developers wishing to use `kafka-map` within a corporate network are advised to seek approval from their administrators or management before using the tool. By downloading, using, or distributing `kafka-map`, you agree to the [LICENSE](LICENSE) terms & conditions. No warranty or liability is provided.
## 依赖环境

## Dependencies
- Java11 或更高版本
- Apache Kafka 1.1.0 或更高版本

- Java8 or higher version
- Apache Kafka 1.1.0 or higher version
## docker方式安装

环境变量

## Quick installation
| 参数 | 含义 |
|---|---|
| DEFAULT_USERNAME | 初始登录账号 |
| DEFAULT_PASSWORD | 初始登录密码 |

Download
```shell
docker run -d \
-p 8080:8080 \
-v /opt/kafka-map/data:/usr/local/kafka-map/data \
-e DEFAULT_USERNAME=admin
-e DEFAULT_PASSWORD=admin
--name kafka-map \
--restart always dushixiang/kafka-map:latest
```

## 快速安装

下载
```shell
wget https://github.com/dushixiang/kafka-map/releases/latest/download/kafka-map.tgz
```

Decompression
解压
```shell
tar -zxvf kafka-map.tgz -C /usr/local/
```

### Front run
### 前台运行
```shell
# kafka-map folder
# kafka-map文件夹
cd /usr/local/kafka-map
# run
# 根据需求自行修改配置
vi application.yml
# 启动
java -jar kafka-map.jar
```

### System service is running
### 系统服务方式运行

Create a `kafka-map.service` at `/etc/systemd/system/` and write the following
`/etc/systemd/system/` 下创建 `kafka-map.service` 并写入以下内容

> 根据自身实际情况修改 WorkingDirectory 和 ExecStart下面的程序所在目录及java
```shell
[Unit]
Description=kafka map service
Expand All @@ -70,7 +91,7 @@ Restart=on-failure
WantedBy=multi-user.target
```

Heavy Duty System Services && Settings Boot Launch && Startup Service && View Status
重载系统服务&&设置开机启动&&启动服务&&查看状态

```shell
systemctl daemon-reload
Expand All @@ -79,19 +100,19 @@ systemctl start kafka-map
systemctl status kafka-map
```

### How to use
### 使用

Next, use the browser to open the `8080` port you can access.
接下来使用浏览器打开服务器的 `8080` 端口即可访问。

## FAQ

<details>
<summary>What should I do if I don't want to use the 8080 port?</summary>
<summary>不想使用8080端口怎么办?</summary>

Add the port on the launch command to modify the port to `1234`
在启动命令上增加 `--server.port=1234` 即可修改端口为 `1234`

```shell
# example
# 示例
java -jar kafka-map.jar --server.port=1234
```
</details>
106 changes: 0 additions & 106 deletions README_zh.MD

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import java.util.Map;

/**
Expand Down

0 comments on commit 4826b32

Please sign in to comment.