NanoMQ

https://nanomq.io/docs
Admin
NanoMQ is an ultra-lightweight and blazing-fast MQTT broker designed for IoT edge devices with...
Tokens:2,620
Snippets:25
Trust Score:3.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Run NanoMQ with Docker

Source: https://nanomq.io

Quickly start NanoMQ using Docker. Ensure Docker is installed and running on your system.

```bash
docker run -d --name nanomq emqx/nanomq:latest
```

--------------------------------

### Start NanoMQ Docker Container

Source: https://nanomq.io/docs/latest/quick-start/quick-start.html

Run NanoMQ using Docker, mounting the local configuration file. Ensure to replace `/path/to/your/nanomq.conf` with the actual path.

```bash
docker run -d -p 1883:1883 \
           -v /path/to/your/nanomq.conf:/etc/nanomq.conf \
           --name nanomq emqx/nanomq:latest

```

--------------------------------

### Run NanoMQ using Docker

Source: https://nanomq.io/docs/latest/quick-start/quick-start.html

Starts a NanoMQ broker instance in detached mode using Docker, exposing standard MQTT ports.

```bash
docker run -d --name nanomq -p 1883:1883 -p 8083:8083 -p 8883:8883 emqx/nanomq:latest
```

--------------------------------

### NanoMQ MQTT Client CLI Usage

Source: https://nanomq.io

Interact with the NanoMQ broker using its command-line interface. Examples cover publishing messages, subscribing to topics, and establishing connections.

```bash
# Publish
nanomq_cli pub --url <url> -t <topic> -m <message> [--help]

# Subscribe
nanomq_cli sub --url <url> -t <topic> [--help]

# Connect
nanomq_cli conn --url <url> [--help]
```

--------------------------------

### Build NanoMQ from Source

Source: https://nanomq.io

Compile NanoMQ from its source code. This involves cloning the repository, initializing submodules, and using CMake for the build process.

```bash
git clone https://github.com/nanomq/nanomq.git
cd nanomq ; git submodule update --init --recursive
mkdir build && cd build ; cmake .. ; make
```

--------------------------------

### Create NanoMQ Bridge Configuration

Source: https://nanomq.io/docs/latest/quick-start/quick-start.html

Define bridge settings in a nanomq.conf file. This includes server address, protocol version, keepalive interval, authentication, and topic forwarding/subscription rules.

```bash
bridges.mqtt.emqx1 {
	# # Bridge address: host:port . 
	# #
	# # Value: String
	# # Example: mqtt-tcp://127.0.0.1:1883
	# #          tls+mqtt-tcp://127.0.0.1:8883
	# #          mqtt-quic://54.75.171.11:14567
	server = "mqtt-tcp://broker.emqx.io:1883"
	# # Protocol version of the bridge.
	# #
	# # Value: Enum
	# # - 5: mqttv5
	# # - 4: mqttv311
	# # - 3: mqttv31
	proto_ver = 4
	# # The ClientId of a remote bridge.
	# # Default random string.
	# #
	# # Value: String
	# clientid="bridge_client"
	# # Ping: interval of a downward bridge.
	# #
	# # Value: Duration
	# # Default: 10 seconds
	keepalive = 60s
	# # The Clean start flag of a remote bridge.
	# #
	# # Value: boolean
	# # Default: false
	# #
	# # NOTE: Some IoT platforms require clean_start
	# #       must be set to 'true'
	clean_start = false
	# # The username for a remote bridge.
	# #
	# # Value: String
	username = username
	# # The password for a remote bridge.
	# #
	# # Value: String
	password = passwd
	# # Topics that need to be forward to IoTHUB
	# #
	# # Value: String
	# # Example: topic1/#,topic2/#
	forwards = [
		{
			remote_topic = "fwd/topic1"
			local_topic = "topic1"
			qos = 1
		},
		{
			remote_topic = "fwd/topic2"
			local_topic = "topic2"
			qos = 2
		}
	]

	subscription = [
		{
			# # Need to subscribe to remote broker topics
			# #
			# # Value: String
			remote_topic = "cmd/topic1"
			local_topic = "topic3"
			# # Need to subscribe to remote topics QoS.
			# # Please set QoS for each subscription topic
			# # otherwise topic is invalid, NanoMQ won't sub to any topic
			# # Value: Number
			qos = 1
		},
		{
			remote_topic = "cmd/topic2"
			local_topic = "topic4"
			qos = 2
		}
	]
	# # max_parallel_processes
	# # Handle a specified maximum number of outstanding requests
	# #
	# # Value: 1-infinity
	max_parallel_processes = 2
	# # max send queue length
	# # Handle a specified maximum number of message send queue length
	# #
	# # Value: 1-infinity
	max_send_queue_len = 32
	# # max receive queue length
	# # Handle a specified maximum number of message receive queue length
	# #
	# # Value: 1-infinity
	max_recv_queue_len = 128
}

```

--------------------------------

### Pull NanoMQ Docker Image

Source: https://nanomq.io/docs/latest/quick-start/quick-start.html

Pulls the latest NanoMQ Docker image from Docker Hub.

```bash
docker pull emqx/nanomq:latest
```

--------------------------------

### NanoMQ Client Online Event Message

Source: https://nanomq.io/docs/latest/quick-start/quick-start.html

Subscribe to the system topic to receive client online event messages. This message contains details about the connected client.

```bash
Topic: $SYS/brokers/connected
Message: {"username":"hello", "ts":1691225605933,"proto_name":"MQTT","keepalive":60,"return_code":"0","proto_ver":4,"client_id":"nanomq-8a2a5c2e","clean_start":1, "IPv4":"127.0.0.1"}

```

--------------------------------

### NanoMQ Merged Client Status Event Message (Online)

Source: https://nanomq.io/docs/latest/quick-start/quick-start.html

For versions 0.24.1 and later, client online events are published to a merged topic. This message provides client status and connection details.

```bash
Topic: $SYS/brokers/client_status/${clientid}
Message: {"status":"online", "username":"hello", "ts":1691225605933,"proto_name":"MQTT","keepalive":60,"return_code":"0","proto_ver":4,"client_id":"nanomq-8a2a5c2e","clean_start":1, "IPv4":"127.0.0.1"}

```

--------------------------------

### NanoMQ Client Offline Event Message

Source: https://nanomq.io/docs/latest/quick-start/quick-start.html

Subscribe to the system topic to receive client offline event messages. This message includes the reason code for disconnection.

```bash
Topic: $SYS/brokers/disconnected
Message: {"username":"hello","ts":1691225608391,"reason_code":"8b","client_id":"nanomq-8a2a5c2e","IPv4":"127.0.0.1"}

```

--------------------------------

### NanoMQ Merged Client Status Event Message (Offline)

Source: https://nanomq.io/docs/latest/quick-start/quick-start.html

For versions 0.24.1 and later, client offline events are published to a merged topic. This message indicates the client has disconnected.

```bash
Topic: $SYS/brokers/client_status/${clientid}
Message: {"status":"offline", "username":"hello","ts":1691225608391,"reason_code":"8b","client_id":"nanomq-8a2a5c2e","IPv4":"127.0.0.1"}

```
Tokens:
Raw