mirror of https://github.com/jochenvg/mqtt2ws.git synced 2024-05-03 09:15:01 +08:00

Bridge MQTT over TCP to MQTT over WebSocket

Go to file

jochenvg f8c77e2bf9 Pushing to Docker Hub		2022-01-08 19:44:44 +00:00
.github/workflows	Pushing to Docker Hub	2022-01-08 19:44:44 +00:00
Dockerfile	Adding Dockerfile	2022-01-08 18:45:56 +00:00
go.mod	Initial commit	2021-10-02 18:46:53 +01:00
go.sum	Adding go.sum	2021-10-02 18:58:41 +01:00
LICENSE.txt	Renaming LICENSE.txt	2021-10-02 19:58:27 +01:00
main.go	renaming paho import	2021-10-03 02:32:08 +01:00
README.md	Updating README	2021-10-03 11:03:46 +01:00

README.md

mqtt2ws - Transparently proxy MQTT to MQTT-over-Websocket

This is a simple MQTT to MQTT-over-Websocket proxy written in go which preserves MQTT packet alignment with websocket frames.

Mqtt2ws will listten on a configurable TCP port for MQTT messages. When a client connects a Websocket connection is established to a configurable remote server. The MQTT messages from the TCP socket are then bridged to the Websocket connection in both directions.

Background

MQTT is a light-weight publish/subscribe protocol frequently used for communication with IoT devices. It can be transported over TCP, over TLS or over WebSocket. The MQTT payload is identical regardless of the the protocol used to transport it.

TCP is a stream based protocol, meaning that as far the MQTT protocol using it is concerned, it is a continuous stream of bytes. Websocket however is a message based a message/frame based protocol.

The MQTT-over-WebSocket spec does not require alignment of MQTT messages with WebSocket frames, and WebSocket frames can contain more than one MQTT message or partial messages. It appears however that not all MQTT server implementations, including Mosquitto when used with the "protocol websockets" directive adhere to this permissive soec, and connections fail when not aligned.

Many MQTT-over-WebSocket client inplementaations ensure alignment of MQTT messages witg WebSocket frames, including the Eclipse Paho client libraries.

Mqtt2ws uses the Eclipse Paho library to read MQTT messages from the TCP session and send them over the WebSocket so alignment is preserved.

Getting Started

To get a local copy up and running follow these simple steps.

Installation

Using go get

Install go
Go get module
```
go get github.com/jochenvg/mqtt2ws
```

Download release

Alternatively, you can download a binary for your operation system on the releases page.

Usage

Operation is controller by two flags:

Usage of ./mqtt2ws:
  -listen string
    	listen tcp socket (default ":1883")
  -url string
    	websocket url (default "ws://broker.hivemq.com:8000/mqtt")

License

Distributed under the Apache 2.0 License. See LICENSE for more information.