Skip to content

Commit

Permalink
Merge pull request #4676 from FlowFuse/broker-docs
Browse files Browse the repository at this point in the history
First stab at docs for broker
  • Loading branch information
knolleary authored Oct 24, 2024
2 parents 179e4d8 + 4b390a5 commit d59b3fa
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 3 deletions.
Binary file added docs/cloud/images/create-broker-client.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 28 additions & 3 deletions docs/cloud/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,9 @@ All features from the Team Level plus
- HA for Instances
- SSO
- Better Support SLA
- MQTT Broker

Includes 10 instances in the base price
Includes 10 instances and 20 MQTT Clients in the base price

### Changing Team Type

Expand Down Expand Up @@ -180,10 +181,34 @@ Node-RED inside the FlowFuse Cloud platform.

MQTT Connections to an external broker using the standard MQTT nodes will work fine as the connection is initiated by Node-RED.

FlowFuse does not provide an MQTT broker for general use by Node-RED instances. However the
Project Nodes can be used to easily pass messages between Node-RED instances running in the
FlowFuse provides an MQTT broker for general use by Enterprise Team's Node-RED instances. See the following section.

Also the Project Nodes can be used to easily pass messages between Node-RED instances running in the
platform.

#### Enterprise Team Broker

Enterprise level teams come with their own MQTT broker. You can provision clients from the broker tab in the left hand menu.

Teams can register up to 20 clients as part of their plan. The ability to purchase additional packs of clients will come in a future release.

The broker is available on `broker.flowfuse.cloud` and supports the following connection types:

- MQTT on port `1883`
- MQTT over TLS on port `8883`
- MQTT over secure WebSockets on port `443`

When creating clients you can specify a username, but it will prepended to the the Team's id e.g. `alice` will become `alice@abcd1234`.
Clients must also use the username as the MQTT Client ID in order to connect.

![Create Broker Client](./images/create-broker-client.png)

e.g.

```
mosquitto_sub -u "alice@abcd1234" -i "alice@abcd1234" -P "password" -h broker.flowfuse.cloud -t "#"
```

### IP Addresses

Outbound connections from FlowFuse will always come from the IP address `63.33.85.112`.
Expand Down

0 comments on commit d59b3fa

Please sign in to comment.