NanoMQ 项目安装与使用教程

NanoMQ 项目安装与使用教程

1. 项目目录结构及介绍

NanoMQ 项目的目录结构如下：

nanomq/
├── cmake/
├── deploy/
│   └── docker/
├── docs/
├── etc/
├── extern/
├── nanomq/
├── nanomq_cli/
├── nng/
├── clang-format
├── codecov.yml
├── gitignore
├── gitmodules
├── grcov.yml
├── CHANGELOG.md
├── CMakeLists.txt
├── CONTRIBUTING.md
├── CodeGuidance.md
├── Docker-introduction
├── LICENSE.txt
├── README.md
├── libatomic-1.dll
├── libwinpthread-1.dll
├── package.mk
└── wix-patch.xml

目录介绍

• cmake/: 包含 CMake 构建脚本和配置文件。
• deploy/docker/: 包含 Docker 部署相关的文件。
• docs/: 包含项目的文档文件。
• etc/: 包含项目的配置文件。
• extern/: 包含外部依赖库的文件。
• nanomq/: 包含 NanoMQ 核心代码。
• nanomq_cli/: 包含 NanoMQ 的命令行工具代码。
• nng/: 包含 NNG (nanomsg-next-generation) 库的代码。
• clang-format: 代码格式化配置文件。
• codecov.yml: 代码覆盖率配置文件。
• gitignore: Git 忽略文件配置。
• gitmodules: Git 子模块配置文件。
• grcov.yml: 代码覆盖率工具配置文件。
• CHANGELOG.md: 项目变更日志。
• CMakeLists.txt: CMake 主构建文件。
• CONTRIBUTING.md: 贡献指南。
• CodeGuidance.md: 代码指导文档。
• Docker-introduction: Docker 介绍文档。
• LICENSE.txt: 项目许可证。
• README.md: 项目自述文件。
• libatomic-1.dll: Windows 平台下的库文件。
• libwinpthread-1.dll: Windows 平台下的库文件。
• package.mk: 打包配置文件。
• wix-patch.xml: WiX 工具的补丁配置文件。

2. 项目启动文件介绍

NanoMQ 的启动文件主要是 nanomq/nanomq 目录下的可执行文件。启动 NanoMQ 的方式有多种，以下是常见的启动方式：

使用 Docker 启动

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

直接启动

nanomq start

使用配置文件启动

nanomq start --conf <config_file>

3. 项目的配置文件介绍

NanoMQ 的配置文件通常位于 etc/ 目录下。主要的配置文件是 nanomq.conf，该文件包含了 NanoMQ 的各种配置选项，例如 MQTT 端口、日志级别、消息持久化等。

配置文件示例

# MQTT 端口配置
mqtt.port = 1883

# 日志级别配置
log.level = info

# 消息持久化配置
persistence.enabled = true
persistence.path = /var/lib/nanomq

配置文件选项

• mqtt.port: 配置 MQTT 服务监听的端口。
• log.level: 配置日志输出的级别，可选值为 debug, info, warn, error。
• persistence.enabled: 是否启用消息持久化。
• persistence.path: 消息持久化的存储路径。

通过修改配置文件，可以灵活地调整 NanoMQ 的行为，以适应不同的应用场景。