【emqx】 EMQX 开源项目安装与使用教程

1. 项目目录结构及介绍

EMQX 是一个高度可扩展的开源 MQTT 代理，适用于物联网（IoT）、工业物联网（IIoT）和连接车辆等场景。以下是 EMQX 项目的目录结构及其主要文件的介绍：

emqx/
├── bin/
│   ├── emqx
│   └── emqx.cmd
├── changes/
├── ci/
├── deploy/
├── dev/
├── elvis_config
├── env.sh
├── git-blame-ignore-revs
├── mix.exs
├── pkg-vsn.sh
├── rebar.config
├── rebar.config.erl
├── scripts/
├── src/
├── test/
├── tools/
├── .editorconfig
├── .formatter.exs
├── .gitattributes
├── .gitignore
├── .tool-versions
├── APL.txt
├── CONTRIBUTING.md
├── Dockerfile.ubuntu20.04.runner
├── Dockerfile.ubuntu20.04.runner.dockerignore
├── LICENSE
├── Makefile
├── NOTICE
├── PLUGIN.md
├── README-CN.md
├── README-RU.md
├── README.md
├── SECURITY.md
└── build/

主要目录和文件介绍：

• bin/: 包含 EMQX 的启动脚本，如 emqx 和 emqx.cmd。
• src/: 包含 EMQX 的核心源代码。
• test/: 包含项目的测试代码。
• scripts/: 包含用于构建和部署的脚本。
• config/: 包含项目的配置文件。
• README.md: 项目的介绍文档。
• LICENSE: 项目的开源许可证。

2. 项目启动文件介绍

EMQX 的启动文件位于 bin/ 目录下，主要包括 emqx 和 emqx.cmd。以下是启动文件的介绍：

bin/emqx

这是一个用于启动 EMQX 的 Shell 脚本。通过运行该脚本，可以启动 EMQX 服务。

./bin/emqx start

bin/emqx.cmd

这是一个用于 Windows 系统的启动脚本。通过运行该脚本，可以在 Windows 环境下启动 EMQX 服务。

bin\emqx.cmd start

3. 项目配置文件介绍

EMQX 的配置文件主要位于 etc/ 目录下。以下是主要的配置文件及其介绍：

etc/emqx.conf

这是 EMQX 的主配置文件，包含了 EMQX 的各种配置选项，如监听端口、认证方式、日志级别等。

# 示例配置
listener.tcp.external = 0.0.0.0:1883
listener.ssl.external = 8883
allow_anonymous = true

etc/acl.conf

这是访问控制列表（ACL）的配置文件，用于定义哪些客户端可以访问哪些主题。

# 示例配置
{allow, {user, "dashboard"}, subscribe, ["$SYS/#"]}.
{allow, {ipaddr, "127.0.0.1"}, pubsub, ["$SYS/#", "#"]}.

etc/plugins/*.conf

这是插件的配置文件，每个插件都有自己的配置文件，用于定义插件的行为。

# 示例配置
plugin.emqx_auth_http.auth_req = http://127.0.0.1:8080/auth

通过以上配置文件，可以灵活地调整 EMQX 的行为，以满足不同的应用需求。

---

以上是 EMQX 开源项目的安装与使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你快速上手 EMQX 项目。