Skip to content
44 changes: 44 additions & 0 deletions docs/analyzer/data-collection-access.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# MQTT Data Collection & Access

!!! warning "Treat Public channel traffic as public"
Comment thread
n30nex marked this conversation as resolved.
Outdated
MeshCore Canada observers operate on the default MeshCore Canada network settings and Public channel. The default MeshCore encryption system and Public channel are for shared public mesh traffic, not private distribution to a closed group. Traffic sent on the Public channel should be treated as public. Do not transmit names, locations, notes, or other personal information over radio or MQTT unless you are comfortable with that information being stored and shown publicly.
Comment thread
n30nex marked this conversation as resolved.
Outdated

## What We Collect

MeshCore Canada collects packet data from nodes that are on the MeshCore Canada network and are seen by an observer.

Observers listen for all traffic they can hear on the default MeshCore Canada frequencies and settings. If a packet is heard by an observer and the observer path is configured to publish packet data, it can be sent to the MeshCore Canada MQTT brokers.

## User Control

Users can opt in or opt out of telemetry and location data uploading in their MeshCore clients where those settings are available.
Comment thread
n30nex marked this conversation as resolved.
Outdated

It is each user's responsibility to choose how much personal information to share from their radios over MQTT. If telemetry, location, or identifying profile information is enabled on a client, that data may be published, stored, and displayed by public viewer sites.

## Where Data Goes

| Step | What happens |
|------|--------------|
| Radio traffic | Nodes transmit on the MeshCore Canada default frequencies and Public channel. |
Comment thread
n30nex marked this conversation as resolved.
Outdated
| Observer capture | MeshCore Canada observers listen to all traffic they can hear on those defaults. |
| MQTT publish | Observer paths publish packet data to MeshCore Canada MQTT infrastructure. |
| Storage and display | Data is stored on MeshCore Canada infrastructure and may be displayed by Beacon and other public websites operated by MeshCore Canada operators. |
Comment thread
n30nex marked this conversation as resolved.
Outdated

## MQTT Subscription Access

Direct MQTT subscription access is not handed out to everyone. It is limited to local mesh administrators and people approved by MeshCore Canada administration.

Even when direct broker subscription access is limited, the data can still be viewable by everyone through Beacon and other public websites that consume the MQTT feed using the MQTT subscription role.

## Infrastructure Administrators

The MeshCore Canada infrastructure administrators control the MQTT brokers and related infrastructure.

| Administrator | Profile |
|---------------|---------|
| Mr. Alderson | [github.com/MrAlders0n](https://github.com/MrAlders0n) |
| Ded | [github.com/446564](https://github.com/446564) |
| n30nex | [github.com/n30nex](https://github.com/n30nex) |
| Kranic | [forum.meshcore.ca/u/djkranic](https://forum.meshcore.ca/u/djkranic) |

Questions about privacy, MQTT access, or the MeshCore Canada project should be directed to these administrators.
8 changes: 8 additions & 0 deletions docs/analyzer/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,14 @@ MeshCore observers capture mesh traffic and publish packet telemetry to MQTT bro

[:octicons-arrow-right-24: Broker Details](broker-reference.md)

- :material-eye:{ .lg .middle } **Data Collection & Access**

---

Learn what observer data is collected, where it is stored, and who administers MQTT access.

[:octicons-arrow-right-24: Data Collection & Access](data-collection-access.md)

- :material-airplane:{ .lg .middle } **IATA Codes**

---
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Whether you're brand new to mesh networking or looking to deploy repeaters acros

We are a group of Canadian meshes across the country from British Columbia, Alberta, Ontario, and Quebec (hopefully more soon) that are working together to bring services and standards across Canada for all MeshCore users. We host MQTT servers and a packet analyzer at this site for all Canadians to use.

The servers and services are currently managed by **MrAlders0n**, **Ded**, and **n30nex**.
The servers and services are currently managed by [**Mr. Alderson**](https://github.com/MrAlders0n), [**Ded**](https://github.com/446564), [**n30nex**](https://github.com/n30nex), and [**Kranic**](https://forum.meshcore.ca/u/djkranic).

The documentation on this site is open to all to contribute to and is backed by markdown files in GitHub at [MeshCore-ca/MeshCore-Canada](https://github.com/MeshCore-ca/MeshCore-Canada).

Expand Down
2 changes: 2 additions & 0 deletions docs/resources/links.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ This page collects common MeshCore, MeshCore Canada, and supporting radio resour
| Resource | Link |
|----------|------|
| MeshCore Canada site | <https://meshcore.ca/> |
| MeshCore Canada forum | <https://forum.meshcore.ca/> |
| Live CoreScope tools | <https://live.meshcore.ca/> |
| MeshCore Canada GitHub | <https://github.com/MeshCore-ca/MeshCore-Canada> |
| Add or update a community | [Contributing](../contributing.md) |
Expand All @@ -29,6 +30,7 @@ This page collects common MeshCore, MeshCore Canada, and supporting radio resour
| Resource | Link |
|----------|------|
| Observer setup overview | [Analyzer & MQTT](../analyzer/intro.md) |
| MQTT data collection and access | [Data Collection & Access](../analyzer/data-collection-access.md) |
| Direct MQTT firmware | [MQTT Firmware](../analyzer/builds/mqtt-firmware.md) |
| MCtoMQTT host bridge | [MCtoMQTT](../analyzer/builds/mctomqtt.md) |
| Home Assistant integration setup | [MeshCore-HA](../analyzer/builds/meshcore-ha.md) |
Expand Down
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ nav:
- Welcome: index.md
- Analyzer & MQTT:
- Overview: analyzer/intro.md
- Data Collection & Access: analyzer/data-collection-access.md
- Check Your Observer: analyzer/verify.md
- Troubleshooting: analyzer/troubleshooting.md
- Broker Reference: analyzer/broker-reference.md
Expand Down Expand Up @@ -91,4 +92,5 @@ nav:
- Getting Started: resources/getting-started.md
- Useful Links: resources/links.md
- Glossary: resources/glossary.md
- Forum: https://forum.meshcore.ca/
- Contributing: contributing.md