Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
A quick and simple guide to get started with VerneMQ
VerneMQ is a high-performance, distributed MQTT message broker. It scales horizontally and vertically on commodity hardware to support a high number of concurrent publishers and consumers while maintaining low latency and fault tolerance. To use it, all you need to do is install the VerneMQ package.
Choose your OS and follow the instructions:
It is also possible to run VerneMQ using our Docker image:
If you built VerneMQ from sources, you can add the /bin
directory of your VerneMQ release to PATH
. For example, if you compiled VerneMQ in the /home/vernemq
directory, then add the binary directory (/home/vernemq/_build/default/rel/vernemq/bin
) to your PATH, so that VerneMQ commands can be used in the same manner as with a packaged installation.
To start a VerneMQ broker, use the vernemq start command in your Shell:
A successful start will return no output. If there is a problem starting the broker, an error message is printed to STDERR
.
To run VerneMQ with an attached interactive Erlang console:
A VerneMQ broker is typically started in console mode for debugging or troubleshooting purposes. Note that if you start VerneMQ in this manner, it is running as a foreground process that will exit when the console is closed.
You can close the console by issuing this command at the Erlang prompt:
Once your broker has started, you can initially check that it is running with the vernemq ping command:
The command will respond with pong
if the broker is running or Node <NodeName> not responding to pings
in case it’s not.
As you may have noticed, VerneMQ will warn you at startup when your system’s open files limit (ulimit -n
) is too low. You’re advised to increase the OS default open files limit when running VerneMQ. Read more about why and how in the Open Files Limit documentation.
To use the VerneMQ pre-built packages and Docker images you have to accept the VerneMQ EULA. Make sure to read and understand the EULA before accepting it.
Accepting the EULA for OS packages can be done by either changing the accept_eula
line in the vernemq.conf
file from no
to yes
or accepting the EULA the first time starting VerneMQ. In general, the installation of VerneMQ OS packages is now a 3 step process:
If you install the package with tools like dpkg
(example: sudo dpkg -i vernemq-1.10.0.xenial.x86_64.deb
), VerneMQ will install but will fail to start due to the missing EULA acceptance.
Accept the EULA by running sudo vernemq chkconfig
or by adding the following line to your vernemq.conf file
: accept_eula = yes
.
Start/restart VerneMQ with: sudo systemctl restart vernemq.
For Docker images the EULA can be accepted by setting the environment variableDOCKER_VERNEMQ_ACCEPT_EULA=yes
, for Docker Swarm add DOCKER_VERNEMQ_ACCEPT_EULA: yes
to the environment.
For the Helm chart the EULA for the Docker images can be accepted by extending the additionalEnv
section with:
additionalEnv:
- name: DOCKER_VERNEMQ_ACCEPT_EULA
value: "yes"
and similarly for the VerneMQ Operator, to accept the EULA for the Docker images, the env
can be extended with:
env:
- name: DOCKER_VERNEMQ_ACCEPT_EULA
value: "yes"
VerneMQ can be installed on CentOS-based systems using the binary package we provide.
Once you have downloaded the binary package, execute the following command to install VerneMQ:
or:
To use the provided binary packages the VerneMQ EULA must be accepted. See Accepting the VerneMQ EULA for more information.
Once you've installed VerneMQ, start it on your node:
You can verify that VerneMQ is successfully installed by running:
If VerneMQ has been installed successfully vernemq
is returned.
Now that you've installed VerneMQ, check out How to configure VerneMQ.