131 lines
6.3 KiB
Markdown
131 lines
6.3 KiB
Markdown
# EMQX
|
|
|
|
[](https://github.com/emqx/emqx/releases)
|
|
[](https://travis-ci.org/emqx/emqx)
|
|
[](https://coveralls.io/github/emqx/emqx?branch=master)
|
|
[](https://hub.docker.com/r/emqx/emqx)
|
|
[](https://slack-invite.emqx.io/)
|
|
[](https://discord.gg/xYGf3fQnES)
|
|
[](https://twitter.com/EMQTech)
|
|
[](https://www.youtube.com/channel/UC5FjR77ErAxvZENEWzQaO5Q)
|
|
|
|
|
|
|
|
English | [简体中文](./README-CN.md) | [日本語](./README-JP.md) | [русский](./README-RU.md)
|
|
|
|
EMQX is the most scalable and popular open-source MQTT broker with a high performance that connects 100M+ IoT devices in 1 cluster at 1ms latency. Move and process millions of MQTT messages per second.
|
|
|
|
The EMQX v5.0 has been verified in [test scenarios](https://www.emqx.com/en/blog/reaching-100m-mqtt-connections-with-emqx-5-0) to scale to 100 million concurrent device connections, which is a critically important milestone for IoT designers. It also comes with plenty of exciting new features and huge performance improvements, including a more powerful [rule engine](https://www.emqx.com/en/solutions/iot-rule-engine), enhanced security management, Mria database extension, and much more to enhance the scalability of IoT applications.
|
|
|
|
During the last several years, EMQX has gained popularity among IoT companies and is used by more than 20,000 global users from over 50 countries, with more than 100 million IoT device connections supported worldwide.
|
|
|
|
For more information, please visit [EMQX homepage](https://www.emqx.io/).
|
|
|
|
## Get Started
|
|
|
|
#### EMQX Cloud
|
|
|
|
The simplest way to set up EMQX is to create a managed deployment with EMQX Cloud. You can [try EMQX Cloud for free](https://www.emqx.com/en/signup?utm_source=github.com&utm_medium=referral&utm_campaign=emqx-readme-to-cloud&continue=https://cloud-intl.emqx.com/console/deployments/0?oper=new), no credit card required.
|
|
|
|
#### Run EMQX using Docker
|
|
|
|
```
|
|
docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8084:8084 -p 8883:8883 -p 18083:18083 emqx/emqx:latest
|
|
```
|
|
|
|
Next, please follow the [getting started guide](https://www.emqx.io/docs/en/v5.0/getting-started/getting-started.html#start-emqx) to tour the EMQX features.
|
|
|
|
#### Run EMQX cluster on kubernetes
|
|
|
|
For details: [EMQX Operator](https://github.com/emqx/emqx-operator/blob/main/docs/en_US/getting-started/getting-started.md).
|
|
|
|
#### More installation options
|
|
|
|
If you prefer to install and manage EMQX yourself, you can download the latest version from [www.emqx.io/downloads](https://www.emqx.io/downloads).
|
|
|
|
For more installation options, see the [EMQX installation documentation](https://www.emqx.io/docs/en/v5.0/deploy/install.html).
|
|
|
|
## Documentation
|
|
|
|
The EMQX documentation is available at [www.emqx.io/docs/en/latest/](https://www.emqx.io/docs/en/latest/).
|
|
|
|
The EMQX Enterprise documentation is available at [docs.emqx.com/en/](https://docs.emqx.com/en/).
|
|
|
|
## Contributing
|
|
|
|
Please see our [contributing.md](./CONTRIBUTING.md).
|
|
|
|
For more organised improvement proposals, you can send pull requests to [EIP](https://github.com/emqx/eip).
|
|
|
|
## Get Involved
|
|
|
|
- Follow [@EMQTech on Twitter](https://twitter.com/EMQTech).
|
|
- If you have a specific question, check out our [discussion forums](https://github.com/emqx/emqx/discussions).
|
|
- For general discussions, join us on the [official Discord](https://discord.gg/xYGf3fQnES) team.
|
|
- Keep updated on [EMQX YouTube](https://www.youtube.com/channel/UC5FjR77ErAxvZENEWzQaO5Q) by subscribing.
|
|
|
|
## Resources
|
|
|
|
- [MQTT client programming](https://www.emqx.com/en/blog/tag/mqtt-client-programming)
|
|
|
|
A series of blogs to help developers get started quickly with MQTT in PHP, Node.js, Python, Golang, and other programming languages.
|
|
|
|
- [MQTT SDKs](https://www.emqx.com/en/mqtt-client-sdk)
|
|
|
|
We have selected popular MQTT client SDKs in various programming languages and provided code examples to help you quickly understand the use of MQTT clients.
|
|
|
|
- [MQTT X](https://mqttx.app/)
|
|
|
|
An elegant cross-platform MQTT 5.0 client tool that provides desktop, command line, and web to help you develop and debug MQTT services and applications faster.
|
|
|
|
- [Internet of Vehicles](https://www.emqx.com/en/blog/category/internet-of-vehicles)
|
|
|
|
Build a reliable, efficient, and industry-specific IoV platform based on EMQ's practical experience, from theoretical knowledge such as protocol selection to practical operations like platform architecture design.
|
|
|
|
## Build From Source
|
|
|
|
The `master` branch is for the latest version 5 release, checkout branch `main-v4.3` for version 4.3 and `main-v4.4` for version 4.4.
|
|
|
|
EMQX requires OTP 22 or 23 for version 4.3, and OTP 24 for 4.4 and 5.0.
|
|
|
|
```bash
|
|
git clone https://github.com/emqx/emqx.git
|
|
cd emqx
|
|
make
|
|
_build/emqx/rel/emqx/bin/emqx console
|
|
```
|
|
|
|
For 4.2 or earlier versions, release has to be built from another repo.
|
|
|
|
```bash
|
|
git clone https://github.com/emqx/emqx-rel.git
|
|
cd emqx-rel
|
|
make
|
|
_build/emqx/rel/emqx/bin/emqx console
|
|
```
|
|
|
|
### Building on Apple silicon (M1, M2)
|
|
|
|
Homebrew on Apple silicon [changed default location of it's home directory](https://github.com/Homebrew/brew/issues/9177) from `/usr/local` to `/opt/homebrew` and as a result a few things broke in the process.
|
|
|
|
Concerning EMQX, when you install `unixodbc` package (one of the dependencies) via Homebrew, and build Erlang/OTP with [kerl](https://github.com/kerl/kerl), kerl will not be able to find `unixodbc`.
|
|
|
|
Here is how to solve it:
|
|
|
|
```bash
|
|
brew install unixodbc kerl
|
|
sudo ln -s $(realpath $(brew --prefix unixodbc)) /usr/local/odbc
|
|
export CC="/usr/bin/gcc -I$(brew --prefix unixodbc)/include"
|
|
export LDFLAGS="-L$(brew --prefix unixodbc)/lib"
|
|
kerl build 24.3
|
|
mkdir ~/.kerl/installations
|
|
kerl install 24.3 ~/.kerl/installations/24.3
|
|
. ~/.kerl/installations/24.3/activate
|
|
```
|
|
|
|
Then you can proceed with `make`.
|
|
|
|
## License
|
|
|
|
See [LICENSE](./LICENSE).
|