# 安装

EMQ X 目前支持的操作系统:

  • CentOS 6
  • CentOS 7
  • CentOS 8
  • OpenSUSE tumbleweed
  • Debian 9
  • Debian 10
  • Ubuntu 16.04
  • Ubuntu 18.04
  • Ubuntu 20.04
  • macOS 10.13
  • macOS 10.14
  • macOS 10.15
  • Windows Server 2019

WARNING

产品部署建议 Linux 服务器,不推荐 Windows 服务器。

# Shell 脚本一键安装 (Linux)

curl https://repos.emqx.io/install_emqx.sh | bash
1

# 包管理器安装 (Linux)

# CentOS

  1. 安装所需要的依赖包

    $ sudo yum install -y yum-utils device-mapper-persistent-data lvm2
    
    1
  2. 使用以下命令设置稳定存储库,以 CentOS 7 为例

    $ sudo yum-config-manager --add-repo https://repos.emqx.io/emqx-ce/redhat/centos/7/emqx-ce.repo
    
    1
  3. 安装最新版本的 EMQ X Broker

    $ sudo yum install emqx
    
    1

    如果提示接受 GPG 密钥,请确认密钥符合 fc84 1ba6 3775 5ca8 487b 1e3c c0b4 0946 3e64 0d53,并接受该指纹。

  4. 安装特定版本的 EMQ X Broker

    1. 查询可用版本

      $ yum list emqx --showduplicates | sort -r
      
      emqx.x86_64                     4.0.0-1.el7                        emqx-stable
      emqx.x86_64                     3.0.1-1.el7                        emqx-stable
      emqx.x86_64                     3.0.0-1.el7                        emqx-stable
      
      1
      2
      3
      4
      5
    2. 根据第二列中的版本字符串安装特定版本,例如 4.0.0

      $ sudo yum install emqx-4.0.0
      
      1
  5. 启动 EMQ X Broker

    • 直接启动

      $ emqx start
      emqx 4.0.0 is started successfully!
      
      $ emqx_ctl status
      Node 'emqx@127.0.0.1' is started
      emqx v4.0.0 is running
      
      1
      2
      3
      4
      5
      6
    • systemctl 启动

      $ sudo systemctl start emqx
      
      1
    • service 启动

      $ sudo service emqx start
      
      1
  6. 停止 EMQ X Broker

    $ emqx stop
    ok
    
    1
    2
  7. 卸载 EMQ X Broker

    $ sudo yum remove emqx
    
    1

# Ubuntu、Debian

  1. 安装所需要的依赖包

    $ sudo apt update && sudo apt install -y \
        apt-transport-https \
        ca-certificates \
        curl \
        gnupg-agent \
        software-properties-common
    
    1
    2
    3
    4
    5
    6
  2. 添加 EMQ X 的官方 GPG 密钥

    $ curl -fsSL https://repos.emqx.io/gpg.pub | sudo apt-key add -
    
    1

    验证密钥

    $ sudo apt-key fingerprint 3E640D53
    
    pub   rsa2048 2019-04-10 [SC]
        FC84 1BA6 3775 5CA8 487B  1E3C C0B4 0946 3E64 0D53
    uid           [ unknown] emqx team <support@emqx.io>
    
    1
    2
    3
    4
    5
  3. 使用以下命令设置 stable 存储库。 如果要添加 unstable 存储库,请在以下命令中的单词 stable 之后添加单词 unstable。

    $ sudo add-apt-repository \
        "deb [arch=amd64] https://repos.emqx.io/emqx-ce/deb/ubuntu/ \
        ./$(lsb_release -cs) \
        stable"
    
    1
    2
    3
    4

    lsb_release -cs 子命令返回发行版的名称,例如 xenial。 有时,在像 Linux Mint 这样的发行版中,您可能需要将 $(lsb_release -cs) 更改为您的父发行版。 例如,如果您使用的是 Linux Mint Tessa,则可以使用 bionic。 EMQ X Broker 不对未经测试和不受支持的发行版提供任何保证。

  4. 更新 apt 包索引

    $ sudo apt update
    
    1
  5. 安装最新版本的 EMQ X Broker

    $ sudo apt install emqx
    
    1

    在启用了多个 EMQ X 仓库的情况下,如果 apt install 和 apt update 命令没有指定版本号,那么会自动安装最新版的 EMQ X Broker。这对于有稳定性需求的用户来说是一个问题。

  6. 安装特定版本的 EMQ X Broker

    1. 查询可用版本

      $ sudo apt-cache madison emqx
      
      emqx |      4.0.0 | https://repos.emqx.io/emqx-ce/deb/ubuntu bionic/stable amd64 Packages
      emqx |      3.0.1 | https://repos.emqx.io/emqx-ce/deb/ubuntu bionic/stable amd64 Packages
      emqx |      3.0.0 | https://repos.emqx.io/emqx-ce/deb/ubuntu bionic/stable amd64 Packages
      
      1
      2
      3
      4
      5
    2. 使用第二列中的版本字符串安装特定版本,例如 4.0.0

      $ sudo apt install emqx=4.0.0
      
      1
  7. 启动 EMQ X Broker

    • 直接启动

      $ emqx start
      emqx 4.0.0 is started successfully!
      
      $ emqx_ctl status
      Node 'emqx@127.0.0.1' is started
      emqx v4.0.0 is running
      
      1
      2
      3
      4
      5
      6
    • systemctl 启动

      $ sudo systemctl start emqx
      
      1
    • service 启动

      $ sudo service emqx start
      
      1
  8. 停止 EMQ X Broker

    $ emqx stop
    ok
    
    1
    2
  9. 卸载 EMQ X Broker

    $ sudo apt remove emqx
    
    1

# OpenSUSE

  1. 下载 GPG 公钥并导入。

    $ curl -L -o /tmp/gpg.pub https://repos.emqx.io/gpg.pub
    $ sudo rpmkeys --import /tmp/gpg.pub
    
    1
    2
  2. 添加储存库地址

    $ sudo zypper ar -f -c https://repos.emqx.io/emqx-ce/redhat/opensuse/leap/stable emqx
    
    1
  3. 安装最新版本的 EMQ X Broker

    $ sudo zypper in emqx
    
    1
  4. 安装特定版本的 EMQ X Broker

    1. 查询可用版本

      $ sudo zypper pa emqx
      
      Loading repository data...
      Reading installed packages...
      S | Repository | Name | Version  | Arch
      --+------------+------+----------+-------
        | emqx       | emqx | 4.0.0-1  | x86_64
        | emqx       | emqx | 3.0.1-1  | x86_64
        | emqx       | emqx | 3.0.0-1  | x86_64
      
      1
      2
      3
      4
      5
      6
      7
      8
      9
    2. 使用 Version 安装特定版本,例如 4.0.0

      $ sudo zypper in emqx-4.0.0
      
      1
  5. 启动 EMQ X Broker

    • 直接启动

      $ emqx start
      emqx 4.0.0 is started successfully!
      
      $ emqx_ctl status
      Node 'emqx@127.0.0.1' is started
      emqx v4.0.0 is running
      
      1
      2
      3
      4
      5
      6
    • systemctl 启动

      $ sudo systemctl start emqx
      
      1
    • service 启动

      $ sudo service emqx start
      
      1
  6. 停止 EMQ X Broker

    $ emqx stop
    ok
    
    1
    2
  7. 卸载 EMQ X Broker

    $ sudo zypper rm emqx
    
    1

# 二进制包安装 (Linux)

  1. 通过 emqx.io (opens new window)Github (opens new window) 选择系统发行版,然后下载要安装的 EMQ X 版本的二进制包。

  2. 安装 EMQ X Broker,将下面的路径更改为您下载 EMQ X 软件包的路径。

    • RPM 包:

      $ sudo rpm -ivh emqx-cenots7-v4.0.0.x86_64.rpm
      
      1
    • DEB 包:

      $ sudo dpkg -i emqx-ubuntu18.04-v4.0.0_amd64.deb
      
      1
  3. 启动 EMQ X Broker

    • 直接启动

      $ emqx start
      emqx 4.0.0 is started successfully!
      $ emqx_ctl status
      Node 'emqx@127.0.0.1' is started
      emqx v4.0.0 is running
      
      1
      2
      3
      4
      5
    • systemctl 启动

      $ sudo systemctl start emqx
      
      1
    • service 启动

      $ sudo service emqx start
      
      1
  4. 停止 EMQ X Broker

    $ emqx stop
    ok
    
    1
    2
  5. 卸载 EMQ X Broker

    • DEB 包:

      $ dpkg -r emqx
      
      1

      $ dpkg -P emqx
      
      1
    • RPM 包:

      $ rpm -e emqx
      
      1

# ZIP 压缩包安装 (Linux、MaxOS、Windows)

  1. 通过 emqx.io (opens new window)Github (opens new window) 下载要安装的 EMQ X 版本的 zip 包。

  2. 解压程序包

    $ unzip emqx-ubuntu18.04-v4.0.0.zip
    
    1
  3. 启动 EMQ X Broker

    $ ./bin/emqx start
    emqx 4.0.0 is started successfully!
    
    $ ./bin/emqx_ctl status
    Node 'emqx@127.0.0.1' is started
    emqx v4.0.0 is running
    
    1
    2
    3
    4
    5
    6
  4. 停止 EMQ X Broker

    $ ./bin/emqx stop
    ok
    
    1
    2
  5. 卸载 EMQ X Broker

    直接删除 EMQ X 目录即可

# 通过 Homebrew 安装 (MacOS)

  1. 添加 EMQ X 的 tap

    $ brew tap emqx/emqx
    
    1
  2. 安装 EMQ X Broker

    $ brew install emqx
    
    1
  3. 启动 EMQ X Broker

    $ emqx start
    emqx 4.0.0 is started successfully!
    
    $ emqx_ctl status
    Node 'emqx@127.0.0.1' is started
    emqx v4.0.0 is running
    
    1
    2
    3
    4
    5
    6
  4. 停止 EMQ X Broker

    $ emqx stop
    ok
    
    1
    2
  5. 卸载 EMQ X Broker

    $ brew uninstall emqx
    
    1

# 通过 Docker 运行 (包含简单的 docker-compose 集群)

# 运行单个容器

  1. 获取 docker 镜像

  2. 启动 docker 容器

    $ docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8883:8883 -p 8084:8084 -p 18083:18083 emqx/emqx:v4.0.0
    
    1

# 使用 docker-compose 创建简单的 static 集群

  1. 创建 docker-compose.yaml 文件

    version: '3'
    
    services:
      emqx1:
        image: emqx/emqx:v4.0.0
        environment:
        - "EMQX_NAME=emqx"
        - "EMQX_HOST=node1.emqx.io"
        - "EMQX_CLUSTER__DISCOVERY=static"
        - "EMQX_CLUSTER__STATIC__SEEDS=emqx@node1.emqx.io, emqx@node2.emqx.io"
        healthcheck:
          test: ["CMD", "/opt/emqx/bin/emqx_ctl", "status"]
          interval: 5s
          timeout: 25s
          retries: 5
        networks:
          emqx-bridge:
            aliases:
            - node1.emqx.io
      
      emqx2:
        image: emqx/emqx:v4.0.0
        environment:
        - "EMQX_NAME=emqx"
        - "EMQX_HOST=node2.emqx.io"
        - "EMQX_CLUSTER__DISCOVERY=static"
        - "EMQX_CLUSTER__STATIC__SEEDS=emqx@node1.emqx.io, emqx@node2.emqx.io"
        healthcheck:
          test: ["CMD", "/opt/emqx/bin/emqx_ctl", "status"]
          interval: 5s
          timeout: 25s
          retries: 5
        networks:
          emqx-bridge:
            aliases:
            - node2.emqx.io
    
    networks:
      emqx-bridge:
        driver: bridge
    
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
  2. 启动 docker-compose 集群

    $ docker-compose -p my_emqx up -d
    
    1
  3. 查看集群

    $ docker exec -it my_emqx_emqx1_1 sh -c "emqx_ctl cluster status"
    Cluster status: #{running_nodes => ['emqx@node1.emqx.io','emqx@node2.emqx.io'],
                      stopped_nodes => []}
    
    1
    2
    3

更多关于 EMQ X Docker 的信息请查看 Docker Hub (opens new window)Github (opens new window)

# 通过 Helkm 安装并集群 (K8S、K3S)

  1. 添加 helm 仓库
$ helm repo add emqx https://repos.emqx.io/charts
$ helm repo update
1
2
  1. 查询 EMQ X Broker
helm search repo emqx
NAME         CHART VERSION APP VERSION DESCRIPTION
emqx/emqx    v4.0.0        v4.0.0      A Helm chart for EMQ X
emqx/emqx-ee v4.0.0        v4.0.0      A Helm chart for EMQ X
emqx/kuiper  0.1.1         0.1.1       A lightweight IoT edge analytic software
1
2
3
4
5
  1. 启动 EMQ X 集群
$ helm install my-emqx emqx/emqx
1
  1. 查看 EMQ X 集群情况
$ kubectl get pods
NAME       READY  STATUS             RESTARTS  AGE
my-emqx-0  1/1     Running   0          56s
my-emqx-1  1/1     Running   0          40s
my-emqx-2  1/1     Running   0          21s

$ kubectl exec -it my-emqx-0 -- emqx_ctl cluster status
Cluster status: #{running_nodes =>
                      ['my-emqx@my-emqx-0.my-emqx-headless.default.svc.cluster.local',
                       'my-emqx@my-emqx-1.my-emqx-headless.default.svc.cluster.local',
                       'my-emqx@my-emqx-2.my-emqx-headless.default.svc.cluster.local'],
                  stopped_nodes => []}
1
2
3
4
5
6
7
8
9
10
11
12

# 源码编译安装

  1. 获取源码
$ git clone -b v4.0.0 https://github.com/emqx/emqx-rel.git
1
  1. 设置环境变量
$ export EMQX_DEPS_DEFAULT_VSN=v4.0.0
1
  1. 编译
$ cd emqx-rel && make
1
  1. 启动 EMQ X Broker
$ cd _build/emqx-rel/_rel/emqx

$ ./bin/emqx start
emqx 4.0.0 is started successfully!

$ ./bin/emqx_ctl status
Node 'emqx@127.0.0.1' is started
emqx v4.0.0 is running
1
2
3
4
5
6
7
8