EMQX Documentation

Welcome to the repo for EMQX documentation. This is the source for https://docs.emqx.io/en/broker/latest/.

EMQX is a fully open-source, highly scalable, highly available distributed MQTT messaging broker for IoT, M2M, and Mobile applications that can handle tens of millions of concurrent clients.

For more information about EMQX, please access EMQ website.

Contributing

If you find EMQX documentation issues, please create an Issue to let us know or directly create a Pull request to help fix or update it. Our docs are completely open-source, and we sincerely appreciate contributions from our community!

See EMQX Documentation Contributing Guide to become a contributor!

Preview

# for community
./preview.sh ce 8080

# for enterprise
./preview.sh ee 8080

Now, open http://localhost:8080/docs/en/latest/ or http://localhost:8080/en/enterprise/latest/, if dir.yaml has been updated, you can re-run the above command to update the docs.

Release a New Version

Both community and enterprise edition documents are managed in the same repo and same release-Major.Minor branch.

Opensource and Enterprise may have different content so they may release at different pace.

Cut a new release for community edition

NEW_TAG="$(./cut-release.sh ce)"
git push origin "${NEW_TAG}"

Cut a New Release for Enterprise Edition

NEW_TAG="$(./cut-release.sh ee)"
git push origin "${NEW_TAG}"

Opensource

You can reach the EMQ community and developers via the following channels.