Install EMQX on macOS

This page guides you on installing and starting EMQX on macOS with a zip file.

Supported versions:

• macOS 13 (Homebrew package only)
• macOS 12

Install EMQX with Homebrew

Homebrew is a free and open-source software package management system that simplifies the installation of software on macOS.

1. If you don't already have Homebrew installed on your Mac, you can install it by running the following command in the Terminal:

   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

2. Install EMQX:

   brew install emqx

Install EMQX from Zip Package

1. Download emqx package for your OS and architecture. Here is the direct link to the zip package for a Mac computer with macOS 12 (Monterey) and Apple Silicon:

   wget https://www.emqx.com/en/downloads/broker/5.6.1/emqx-5.6.1-macos12-arm64.zip

2. Extract files from the package:

   mkdir -p emqx && unzip emqx-5.6.1-macos12-arm64.zip -d emqx && cd emqx

Start and Stop EMQX

EMQX can be started in daemon mode, foreground mode, or interactive mode. Note that only one instance of EMQX can be running at any time with default configuration.

If you install EMQX with Homebrew, use emqx command as specified below. If you install EMQX from a zip package, use bin/emqx instead (assuming you are in the directory where you extract emqx files).

# start as daemon
emqx start

# start in foreground
emqx foreground

# start in interactive mode, with Erlang shell
emqx console

After a successful start, EMQX will output this message (if it is started in the foreground or interactive mode):

EMQX 5.6.1 is running now!

You may also see some warning messages which are intended for operators of the production environment and can be ignored if EMQX is used in the local environment for tests, experiments, or client development:

ERROR: DB Backend is RLOG, but an incompatible OTP version has been detected. Falling back to using Mnesia DB backend.
WARNING: ulimit -n is 256; 1024 is the recommended minimum.
WARNING: Default (insecure) Erlang cookie is in use.
WARNING: Configure node.cookie in /opt/homebrew/Cellar/emqx/5.6.1/etc/emqx.conf or override from environment variable EMQX_NODE__COOKIE
WARNING: NOTE: Use the same cookie for all nodes in the cluster.

You can check the status of EMQX with this command:

emqx ctl status

Start your web browser and enter http://localhost:18083/ (localhost can be substituted with your IP address) in the address bar to access the EMQX Dashboard, from where you can connect to your clients or check the running status.

The default user name and password are admin & public. You will be prompted to change the default password once logged in.

To stop EMQX:

• Use emqx stop or bin/emqx stop if it is started in daemon mode.
• Press Ctrl+C if it is started in foreground mode.
• Press Ctrl+C twice if it is started in interactive mode.