https://github.com/flomesh-io/pipy-mqtt-proxy
A lightweight, highly configurable MQTT proxy built on Pipy for efficient MQTT traffic handling, enabling secure and scalable IoT communication. Optimized for low latency and high throughput, the Pipy MQTT Proxy enhances MQTT protocol routing and load balancing with easy deployment and management.
https://github.com/flomesh-io/pipy-mqtt-proxy
loadbalancing mqtt proxy routing throttle
Last synced: about 1 month ago
JSON representation
A lightweight, highly configurable MQTT proxy built on Pipy for efficient MQTT traffic handling, enabling secure and scalable IoT communication. Optimized for low latency and high throughput, the Pipy MQTT Proxy enhances MQTT protocol routing and load balancing with easy deployment and management.
- Host: GitHub
- URL: https://github.com/flomesh-io/pipy-mqtt-proxy
- Owner: flomesh-io
- Created: 2024-04-17T11:42:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-06T00:51:26.000Z (12 months ago)
- Last Synced: 2025-04-16T20:59:50.227Z (about 1 month ago)
- Topics: loadbalancing, mqtt, proxy, routing, throttle
- Language: JavaScript
- Homepage:
- Size: 46.9 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pipy MQTT Proxy
## Intro
This is a demonstration of Pipy working as a MQTT Proxy, providing features:
- Loadbalancing
- HealthCheck
- Message tagging
- Logging
- Metrics
- Tracing
- Rate limit
- Client identifier black/white list
- Authentication base on username and password
Beyond these, it also provides flexible extension with [PipyJS](https://flomesh.io/pipy/docs/en/reference/pjs).
## Quickstart
First, download the Pipy binary from [here](https://flomesh.io/pipy/download).
Then run the command:
```shell
pipy main.js
```
It will start a proxy listening on `1884` and forward the request to broker which may running on `localhost:1883`.
## Configuration
The configuration of proxy locates at [config.yaml](./config.yaml).
- `listen`: the port proxy will listen on,
- `listenTLS`
- `port`: the TLS port proxy will listen on. Disable TSL by commentting.
- `cert`: cert file location
- `key`: key file location
- `brokers`: the list of upstream MQTT brokers,
- `addr`: broker address
- `capicity`: the connection capicity of broker
- `healthCheck`: configuration of health check
- `enabled`: if enable health check or not
- `interval`: the health check interval
- `failureThreshold`: health check failutre threshold from failure
- `successThreshold`: health check success threshold from failure
- `backoffRate`: the backoff rate for failure broker checking
- `limits`: rate limit configuration which can limit connection rate and message publising rate,
- `conn`
- `rate`: connciton limit
- `fastFail`: reject connection if reach limit, or it will hold the connect request for next statistics window
- `tracing`: proxy will generate a traceid and embed it header with name as value of `key`,
- `tags`: the tags list you prefer to embed in message header. It accepts key-value pair.
- `ids`: the client id white and black list,
- `creds`: username and password configured as key-value pair.
- `plugins`: the feature list proxy provides. You can customize its features by commenting or uncommenting.
But please keep the `balancer` in the end.
```yaml
listen: 1884
listenTLS:
port: 11884
cert: ./secret/server-cert.pem
key: ./secret/server-key.pem
brokers:
- addr: 127.0.0.1:1883
capicity: 50
healthCheck:
enabled: true
interval: 2 #seconds
failureThreshold: 3
successThreshold: 3
backoffRate: 2
limits:
conn:
rate: 20
blockInput: true
fastFail: true
pub:
rate: 20
blockInput: true
tracing:
key: traceid
tags:
proxy: pipy
ids:
allow:
- client-1
- client-2
deny:
- client-3
creds:
username: flomesh
password: pipy
plugins:
- tag
- tracing
- logger
- metrics
# - identify
# - credential
- throttle
- balancer
```
## Appendix
The cert and key files in [./secret](./secret) are generated with script below.
```shell
#ca
openssl genrsa 2048 > ca-key.pem
openssl req -new -x509 -nodes -days 365000 \
-key ca-key.pem \
-out ca-cert.pem \
-subj '/CN=nip.io'
#sever
openssl genrsa -out server-key.pem 2048
openssl req -new -key server-key.pem -out server.csr -subj '/CN=broker.nip.io'
openssl x509 -req -in server.csr -CA ca-cert.pem -CAkey ca-key.pem -CAcreateserial -out server-cert.pem -days 365
#client
openssl genrsa -out client-key.pem 2048
openssl req -new -key client-key.pem -out client.csr -subj '/CN=client.nip.io'
openssl x509 -req -in client.csr -CA ca-cert.pem -CAkey ca-key.pem -CAcreateserial -out client-cert.pem -days 365
```