Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fhmq/hmq

High performance mqtt broker
https://github.com/fhmq/hmq

acl bridge broker cluster go golang iot kafka mqtt performance-mqtt-broker websocket

Last synced: 5 days ago
JSON representation

High performance mqtt broker

Awesome Lists containing this project

README

        

Free and High Performance MQTT Broker
============

## About
Golang MQTT Broker, Version 3.1.1, and Compatible
for [eclipse paho client](https://github.com/eclipse?utf8=%E2%9C%93&q=mqtt&type=&language=) and mosquitto-client

## RUNNING
```bash
$ go get github.com/fhmq/hmq
$ cd $GOPATH/github.com/fhmq/hmq
$ go run main.go
```

## Usage of hmq:
~~~
Usage: hmq [options]

Broker Options:
-w, --worker Worker num to process message, perfer (client num)/10. (default 1024)
-p, --port Use port for clients (default: 1883)
--host Network host to listen on. (default "0.0.0.0")
-ws, --wsport Use port for websocket monitoring
-wsp,--wspath Use path for websocket monitoring
-c, --config Configuration file

Logging Options:
-d, --debug Enable debugging output (default false)
-D Debug enabled

Cluster Options:
-r, --router Router who maintenance cluster info
-cp, --clusterport Cluster listen port for others

Common Options:
-h, --help Show this message
~~~

### hmq.config
~~~
{
"workerNum": 4096,
"port": "1883",
"host": "0.0.0.0",
"cluster": {
"host": "0.0.0.0",
"port": "1993"
},
"router": "127.0.0.1:9888",
"wsPort": "1888",
"wsPath": "/ws",
"wsTLS": true,
"tlsPort": "8883",
"tlsHost": "0.0.0.0",
"tlsInfo": {
"verify": true,
"caFile": "tls/ca/cacert.pem",
"certFile": "tls/server/cert.pem",
"keyFile": "tls/server/key.pem"
},
"plugins": {
"auth": "authhttp",
"bridge": "kafka"
}
}
~~~

### Features and Future

* Supports QOS 0 and 1

* Cluster Support

* Containerization

* Supports retained messages

* Supports will messages

* Websocket Support

* TLS/SSL Support

* Auth Support
* Auth Connect
* Auth ACL
* Cache Support

* Kafka Bridge Support
* Action Deliver
* Regexp Deliver

* HTTP API
* Disconnect Connect (future more)

### Share SUBSCRIBE
~~~
| Prefix | Examples | Publish |
| ------------------- |-------------------------------------------|--------------------------- --|
| $share//topic | mosquitto_sub -t ‘$share//topic’ | mosquitto_pub -t ‘topic’ |
~~~

### Cluster
```bash
1, start router for hmq (https://github.com/fhmq/router.git)
$ go get github.com/fhmq/router
$ cd $GOPATH/github.com/fhmq/router
$ go run main.go
2, config router in hmq.config ("router": "127.0.0.1:9888")

```
Other Version Of Cluster Based On gRPC: [click here](https://github.com/fhmq/rhmq)

### Online/Offline Notification
```bash
topic:
$SYS/broker/connection/clients/
payload:
{"clientID":"client001","online":true/false,"timestamp":"2018-10-25T09:32:32Z"}
```

## Performance

* High throughput

* High concurrency

* Low memory and CPU

## License

* Apache License Version 2.0

## Reference

* Surgermq.(https://github.com/zentures/surgemq)

## Benchmark Tool

* https://github.com/inovex/mqtt-stresser
* https://github.com/krylovsk/mqtt-benchmark