Files
rocketmq-dashboard/README.md
2020-07-29 10:11:02 +08:00

79 lines
2.3 KiB
Markdown

## RocketMQ-Console-NG [![Coverage Status](https://coveralls.io/repos/github/rocketmq/rocketmq-console-ng/badge.svg?branch=master)](https://coveralls.io/github/rocketmq/rocketmq-console-ng?branch=master)
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
## How To Install
### With Docker
* get docker image
```
mvn clean package -Dmaven.test.skip=true docker:build
```
or
```
docker pull apacherocketmq/rocketmq-console-ng
```
> currently the newest available docker image is apacherocketmq/rocketmq-console-ng:2.0.0
* run it (change namesvrAddr and port yourself)
```
docker run -e "JAVA_OPTS=-Drocketmq.namesrv.addr=127.0.0.1:9876 -Dcom.rocketmq.sendMessageWithVIPChannel=false" -p 8080:8080 -t apacherocketmq/rocketmq-console-ng
```
or
```
docker run -e "JAVA_OPTS=-Drocketmq.namesrv.addr=127.0.0.1:9876 -Dcom.rocketmq.sendMessageWithVIPChannel=false" -p 8080:8080 -t apacherocketmq/rocketmq-console-ng:2.0.0
```
### Without Docker
require java 1.8+
```
mvn spring-boot:run
```
or
```
mvn clean package -Dmaven.test.skip=true
java -jar target/rocketmq-console-ng-2.0.0.jar
```
#### Tips
* if you download package slow,you can change maven's mirror(maven's settings.xml)
```
<mirrors>
<mirror>
<id>alimaven</id>
<name>aliyun maven</name>
<url>http://maven.aliyun.com/nexus/content/groups/public/</url>
<mirrorOf>central</mirrorOf>
</mirror>
</mirrors>
```
* if you use the rocketmq < 3.5.8,please add -Dcom.rocketmq.sendMessageWithVIPChannel=false when you start rocketmq-console-ng(or you can change it in ops page)
* change the rocketmq.config.namesrvAddr in resource/application.properties.(or you can change it in ops page)
## UserGuide
[English](https://github.com/apache/incubator-rocketmq-externals/blob/master/rocketmq-console/doc/1_0_0/UserGuide_EN.md)
[中文](https://github.com/apache/incubator-rocketmq-externals/blob/master/rocketmq-console/doc/1_0_0/UserGuide_CN.md)
## Contact
* Issue / Pull Request
* You can join us and make a contribute for rocketmq-console.
[RocketMQ Contact](http://rocketmq.apache.org/about/contact/)
#### Mailing Lists
DEV dev@rocketmq.incubator.apache.org
USERS users@rocketmq.incubator.apache.org