Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emqx/emqx-rel
Release Project for EMQX Broker prior to 4.3. Newer releases are built here: https://github.com/emqx/emqx
https://github.com/emqx/emqx-rel
mqtt mqtt-broker
Last synced: about 2 months ago
JSON representation
Release Project for EMQX Broker prior to 4.3. Newer releases are built here: https://github.com/emqx/emqx
- Host: GitHub
- URL: https://github.com/emqx/emqx-rel
- Owner: emqx
- License: apache-2.0
- Created: 2016-07-21T09:45:21.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-12-27T07:33:39.000Z (12 months ago)
- Last Synced: 2024-08-01T18:40:42.543Z (5 months ago)
- Topics: mqtt, mqtt-broker
- Language: Shell
- Homepage: https://www.emqx.com
- Size: 8.66 MB
- Stars: 190
- Watchers: 42
- Forks: 221
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# emqx-rel
The Release Project for EMQX Broker.
NOTICE: Requires Erlang/OTP 21.3 .. 22 to build since EMQX 3.2
EMQX no longer uses this repository since version 4.3. Use https://github.com/emqx/emqx/ instead.
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.
## rebar3
This project has rebar3 (compiled from OTP 21.3) included.
## Build on Linux/Unix/Mac
```shell
$ git clone https://github.com/emqx/emqx-rel.git emqx-rel
$ cd emqx-rel
$ git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
$ make
$ ./_build/emqx/rel/emqx/bin/emqx console
```
## Build rpm or deb package on Linux
```shell
$ git clone https://github.com/emqx/emqx-rel.git emqx-rel
$ cd emqx-rel
$ git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
$ make emqx-pkg
$ ls _packages/emqx
```
## Build docker image
```shell
$ git clone https://github.com/emqx/emqx-rel.git emqx-rel
$ cd emqx-rel
$ git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
$ TARGET=emqx/emqx make docker
```
## Build on Windows
```powershell
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.
```erlang
{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
```bash
make ct
```
# License
Apache License Version 2.0
# Author
EMQX Team.