-
Notifications
You must be signed in to change notification settings - Fork 6
[codex] Add MQTT data and admin access docs #36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
713ed6f
Add MQTT data access docs
n30nex 4c0a7fa
Update MQTT data collection access documentation
n30nex 26b2c66
Clarify MQTT collection privacy wording
n30nex c528b22
Add forum link to MQTT access documentation
n30nex 7fe7e93
Revise warnings on MeshCore RF traffic privacy
n30nex 6888b90
Revise MeshCore RF traffic warning and user responsibility
n30nex ead54b0
Fix typo in data collection access documentation
n30nex 3a817b7
Remove user control section from data collection access
n30nex fb69084
Document MQTT read access tools
n30nex 48dfcd4
Revise MQTT read access section in documentation
n30nex File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| 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" | ||
| 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. | ||
|
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. | ||
|
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. | | ||
|
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. | | ||
|
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. | ||
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
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
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.