jangocheng / emqx-rel

The Release Project for EMQ X Broker

emqx-rel

The Release Project for EMQ X Broker.

NOTICE: Requires Erlang/OTP 21.3 to build since EMQ X 3.2

There are 4 target profiles for building emqx-rel: emqx, emqx-pkg, emqx-edge,and emqx-edge-pkg. The default target profile is emqx. User can build specified target release by execute command make ${target-release} in emqx_rel.

Install Erlang/OTP-R21.3 and rebar3

Read the section below and install rebar3

https://www.rebar3.org/docs/getting-started#section-installing-from-source

Build on Linux/Unix/Mac

git clone -b v4.0.0 https://github.com/emqx/emqx-rel.git emqx-rel
cd emqx-rel && make
./_build/emqx/rel/emqx/bin/emqx console

Build rpm or deb package on Linux

git clone -b v4.0.0 https://github.com/emqx/emqx-rel.git emqx-rel
cd emqx-rel && make emqx-pkg
ls _packages/emqx

Build docker image

git clone -b v4.0.0 https://github.com/emqx/emqx-rel.git emqx-rel
cd emqx-rel && make emqx-docker-build

Build on Windows

git clone -b v4.0.0 https://github.com/emqx/emqx-rel.git emqx-rel
cd emqx-rel
make
cd _build\emqx\rel\emqx
bin\emqx console

Build with elixir plugins

Modify the rebar.config.

{elixir_deps,
   [ {plugin_name, {git, "url_of_plugin", {tag, "tag_of_plugin"}}}
   , ....
   ....
   ]
}

......
......

{elixir_relx_apps,
    [ app_name1
    , app_name2]}.

Due to the limit of the rebar3_elixir_compile, users have to specify all the dependencies of the the elixir plugin in rebar.config in emqx-rel.

Start with epmd

For now, emqx starts without epmd by default. If you want to run emqx with epmd, you should set the environment variable $WITH_EPMD with any value you want, for example, execute export $WITH_EPMD=true in your shell, then run emqx, epmd will start soon afterwards.

Test

make ct

License

Apache License Version 2.0

Author

EMQ X Team.