docs: clarify EMQX broker dependency and dependent features#7759
Open
dimitrieh wants to merge 5 commits into
Open
docs: clarify EMQX broker dependency and dependent features#7759dimitrieh wants to merge 5 commits into
dimitrieh wants to merge 5 commits into
Conversation
The docs still described Mosquitto as the platform broker and did not say which features depend on EMQX specifically. Consolidate the duplicated broker configuration sections, describe EMQX as the shipped broker with Mosquitto as legacy, explain what the Team Broker is and why it requires EMQX, state the self-hosted prerequisites for FlowFuse Expert, and add the Kubernetes Mosquitto to EMQX upgrade note.
hardillb
reviewed
Jul 6, 2026
hardillb
reviewed
Jul 6, 2026
hardillb
reviewed
Jul 6, 2026
Restore the fuller broker.url/broker.public_url descriptions, correct the Kubernetes upgrade note (chart v2.78.0 shipped with 2.31.2 and the migration to EMQX is not optional), remove the broker implementation detail from the user-facing Team Broker page, fix the Helm default wording (the broker is not enabled automatically on Kubernetes), and use consistent anchored links.
Restore the original MQTT Broker configuration section and its option descriptions in place, and remove the newer duplicated section instead, so the existing configuration reference stays where it was.
Keep the user-facing Team Broker page to what users need, shorten the Expert self-hosted note to the requirement itself, and drop internal EMQX capability details from the configuration reference.
dimitrieh
commented
Jul 6, 2026
| This is a single shared MQTT broker, but each team has their own separate topic space and the ability to provision credentials for clients. | ||
| This is a single shared MQTT broker, but each team has their own separate topic space and the ability to provision credentials for clients. It removes the need to install and manage a broker of your own. | ||
|
|
||
| If your company already operates its own MQTT broker, that broker can also be connected to FlowFuse as an external broker to browse its topic hierarchy alongside the Team Broker. |
Contributor
Author
There was a problem hiding this comment.
might be unnecessary 🤔
Contributor
Author
There was a problem hiding this comment.
Suggested change
| If your company already operates its own MQTT broker, that broker can also be connected to FlowFuse as an external broker to browse its topic hierarchy alongside the Team Broker. |
hardillb
reviewed
Jul 7, 2026
Comment on lines
-123
to
-127
| Option | Description | ||
| --------------|------------ | ||
| `broker.url` | The url for the platform to access the broker. For example: `mqtt://localhost:4800`. | ||
| `broker.public_url` | The url used by devices to connect to the broker, if different to `broker.url`. For example, this may require devices to use WebSockets instead: `ws://localhost:4881`. | ||
|
|
Contributor
There was a problem hiding this comment.
These configuration options are still valid. why have you removed them?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The docs still described Mosquitto as the broker the platform depends on, and nowhere stated which features require EMQX specifically. This had to be reconstructed from code and engineering input when the question came up (internal context: https://flowfuse.slack.com/archives/C032Q63FGG1/p1783356313652189).
docs/install/configuration.md: the page contained the "MQTT Broker configuration" section twice; the duplicate is removed and the original section (options table unchanged) now describes EMQX as the shipped broker, Mosquitto as legacy for installations that manage their own broker, which features need a broker at all vs EMQX specifically, and that a customer-supplied replacement broker is not supported.docs/user/teambroker.md: the intro now notes that the Team Broker removes the need to run your own broker and that an existing company broker can be connected as an external broker.docs/user/expert/index.md: adds the self-hosted prerequisite note (Enterprise license, EMQX-based broker with the Team Broker capability enabled).docs/upgrade/README.md: adds a 2.31.2 upgrade note for the Kubernetes broker switch to EMQX (Helm chart v2.78.0, automatic and mandatory migration, EMQX Operator required before upgrading).docs/install/kubernetes/README.md: corrects the EMQX Operator prerequisite (needed whenever the broker is enabled, not only for Team Broker).