mirror of
https://github.com/meshtastic/meshtastic.git
synced 2025-02-21 03:25:51 -08:00
add footnote to mentions of scanning QR code
This commit is contained in:
rcarteraz
parent
d0624d1f90
commit
90bcf4543d
|
|
@ -8,6 +8,7 @@ description: "Find answers to your Meshtastic questions: from getting started, d
|
|||
|
||||
import { FaqAccordion } from "/src/components/FaqAccordion";
|
||||
import { FaqStructuredData } from "/src/components/FaqStructuredData";
|
||||
import QRCode from "@site/docs/blocks/_qr-code.mdx";
|
||||
|
||||
export const Faq = {
|
||||
general: [
|
||||
|
|
@ -234,7 +235,9 @@ Amateur radio regulations differ significantly across countries, with many prohi
|
|||
|
||||
<FaqAccordion rows={Faq.apple} />
|
||||
|
||||
## Channels
|
||||
## Channels[^1]
|
||||
|
||||
[^1]: <QRCode />
|
||||
|
||||
<FaqAccordion rows={Faq.channels} />
|
||||
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ sidebar_position: 2
|
|||
description: "Explore community insights and expert opinions on Meshtastic's encryption, including AES256 implementation, security tips, and potential vulnerabilities."
|
||||
---
|
||||
|
||||
import QRCode from "@site/docs/blocks/_qr-code.mdx";
|
||||
|
||||
This page compiles community feedback and expert reviews on Meshtastic's encryption approach. We value these insights and aim to improve our encryption implementation where feasible. Explore key details, practical tips, and understand the strengths and potential limitations of Meshtastic's AES256 encryption.
|
||||
|
||||
## Comments
|
||||
|
|
@ -16,7 +18,10 @@ Based on comments from reviewers (see below), here are some tips for using these
|
|||
|
||||
- It is likely that the AES256 security is implemented 'correctly' and an observer will not be able to decode your messages.
|
||||
- **Warning:** If an attacker is able to get one of the radios in their possession, they could either a) extract the channel key from that device, or b) use that radio to listen to new communications.
|
||||
- **Warning:** If an attacker is able to get the "Channel QR code/URL" that you share with others, that attacker could then be able to read any messages sent on the channel (either tomorrow or in the past - if they kept a raw copy of those broadcast packets).
|
||||
- **Warning:** If an attacker is able to get the "Channel QR[^1] code/URL" that you share with others, that attacker could then be able to read any messages sent on the channel (either tomorrow or in the past - if they kept a raw copy of those broadcast packets).
|
||||
|
||||
[^1]:
|
||||
<QRCode />
|
||||
|
||||
The current implementation provides optional confidentiality to members of a configured network:
|
||||
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@ description: "Maximize your Meshtastic device's potential with detailed radio se
|
|||
---
|
||||
|
||||
import { FrequencyCalculator } from "/src/components/tools/FrequencyCalculator";
|
||||
import QRCode from "@site/docs/blocks/_qr-code.mdx";
|
||||
|
||||
:::info
|
||||
Meshtastic is **not** LoRaWAN, Helium or TTN (TheThingsNetwork). Meshtastic uses the full spectrum frequency range designated to LoRa technology per region. This allows for several hundred possible frequency channels in the US region alone.
|
||||
|
|
@ -101,7 +102,10 @@ The link budget used by these calculations assumes a transmit power of 22dBm and
|
|||
|
||||
Custom settings can be applied by using [supported software](/docs/software).
|
||||
|
||||
After applying the settings, you will need to restart the device. After your device is restarted, it will generate a new crypto key and you will need to share the newly generated QR Code or URL to all your other devices.
|
||||
After applying the settings, you will need to restart the device. After your device is restarted, it will generate a new crypto key and you will need to share the newly generated QR[^2] Code or URL to all your other devices.
|
||||
|
||||
[^2]:
|
||||
<QRCode />
|
||||
|
||||
Some example settings:
|
||||
|
||||
|
|
|
|||
|
|
@ -9,6 +9,7 @@ import Tabs from "@theme/Tabs";
|
|||
import TabItem from "@theme/TabItem";
|
||||
import { Icon } from "@iconify/react";
|
||||
import PositionPrecisionBits from "@site/docs/blocks/_position-precision-bits.mdx";
|
||||
import QRCode from "@site/docs/blocks/_qr-code.mdx";
|
||||
|
||||
The Channels config options are: Index, Roles, and Settings. Channel config uses an admin message sending a `Channel` protobuf which also consists of a `ChannelSettings` or `ModuleSettings` protobuf.
|
||||
|
||||
|
|
@ -176,10 +177,13 @@ Channel Config options are available on Android.
|
|||
|
||||
The Radio Configuration tab can be used for common tasks:
|
||||
|
||||
1. View your current channel configuration QR code and URL.
|
||||
1. View your current channel configuration QR code and URL.[^1]
|
||||
2. Quickly create or modify your primary channel.
|
||||
3. Select a modem preset for all your channels i.e. `Long Range / Fast`.
|
||||
|
||||
[^1]:
|
||||
<QRCode />
|
||||
|
||||
See [Android App Usage](/docs/software/android/usage#setup-a-channel) for more further instruction on setting up your primary channel.
|
||||
|
||||
[](/img/android/android-channel-edit.webp)
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ sidebar_label: Tips
|
|||
sidebar_position: 4
|
||||
---
|
||||
|
||||
import QRCode from "@site/docs/blocks/_qr-code.mdx";
|
||||
|
||||
## Roles
|
||||
|
||||
It is strongly recommended to keep your [ROLE](/docs/configuration/radio/device#roles) set to `CLIENT`. Only change this if you have a specific, well-understood reason to do so.
|
||||
|
|
@ -62,7 +64,9 @@ Alternatively, if you wish to only share your location with trusted parties, you
|
|||
| :-: | :----: | :----: | :-: | :-: | :-: | :-: | :-: | :-: | :-: | :----: | :-: | :----: | :----: | :----: | :----: | :----: | :-----: |
|
||||
| 20 | 4 | 1 | 36 | 20 | 20 | 12 | 16 | 2 | 4 | 4 | 16 | 6 | 2 | 4 | 16 | 4 | 6 |
|
||||
|
||||
To quickly test this configuration, find and scan your region's QR from [this repository](https://github.com/meshtastic/meshtastic/tree/master/static/img/configuration/qr-private-primary-example/). Remember to generate a new PSK for your private channel before sharing with your trusted nodes.
|
||||
To quickly test this configuration, find and scan your region's QR[^1] from [this repository](https://github.com/meshtastic/meshtastic/tree/master/static/img/configuration/qr-private-primary-example/). Remember to generate a new PSK for your private channel before sharing with your trusted nodes.
|
||||
|
||||
[^1]: <QRCode />
|
||||
|
||||
## Rebroadcast "Public" Traffic
|
||||
|
||||
|
|
|
|||
|
|
@ -9,6 +9,7 @@ import PositionPrecision from "@site/docs/blocks/_position-precision.mdx";
|
|||
import Link from "@docusaurus/Link";
|
||||
import ThemedImage from "@theme/ThemedImage";
|
||||
import useBaseUrl from "@docusaurus/useBaseUrl";
|
||||
import QRCode from "@site/docs/blocks/_qr-code.mdx";
|
||||
|
||||
## Introduction
|
||||
|
||||
|
|
@ -113,10 +114,13 @@ The app will generate a new QR code on the screen. This encodes the channel deta
|
|||
|
||||
### Join a channel
|
||||
|
||||
1. If another user shares a QR code, you will be able to scan it directly with your camera using the `Scan` button.
|
||||
1. If another user shares a QR code, you will be able to scan it directly with your camera using the `Scan` button.[^1]
|
||||
|
||||
[](/img/android/android-open-with.webp)
|
||||
|
||||
[^1]:
|
||||
<QRCode />
|
||||
|
||||
2. If the channel is shared from a file or link using the `Share` button, you can click on the file or link and you need to choose "Open with Meshtastic".
|
||||
|
||||
:::info If a QR or URL opens a webpage instead of the APP or "Open with Meshtastic" is not an option:
|
||||
|
|
@ -135,7 +139,7 @@ Accept this, and the app will change to this new channel. You will lose any curr
|
|||
Setting the same Name and Options directly doesn't work as there are other radio settings (like the unique pre-shared key) encoded in the QR code or link.
|
||||
:::
|
||||
|
||||
You can test changing channels with the QR code shown below.
|
||||
You can test changing channels with the QR code shown below.[^1]
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ sidebar_label: Python CLI
|
|||
sidebar_position: 4
|
||||
---
|
||||
|
||||
import QRCode from "@site/docs/blocks/_qr-code.mdx";
|
||||
|
||||
The python pip package installs a "meshtastic" command line executable, which displays packets sent over the network as JSON and lets you see serial debugging information from the meshtastic devices. This command is not run inside of python, you run it from your operating system shell prompt directly. If when you type "meshtastic" it doesn't find the command and you are using Windows: Check that the python "scripts" directory is in your path.
|
||||
|
||||
## Connection Arguments
|
||||
|
|
@ -147,7 +149,7 @@ Prints a node list in a pretty, formatted table.
|
|||
meshtastic --nodes
|
||||
```
|
||||
|
||||
### --qr
|
||||
### --qr[^1]
|
||||
|
||||
Displays the URL and QR code that corresponds to the current primary channel.
|
||||
|
||||
|
|
@ -155,6 +157,9 @@ Displays the URL and QR code that corresponds to the current primary channel.
|
|||
meshtastic --qr
|
||||
```
|
||||
|
||||
[^1]:
|
||||
<QRCode />
|
||||
|
||||
### --qr-all
|
||||
|
||||
Displays the URL and QR code that corresponds to all configured channels on the node.
|
||||
|
|
@ -345,7 +350,7 @@ meshtastic --set-ham KI1345
|
|||
|
||||
### --dest DEST
|
||||
|
||||
The destination node id for any sent commands, if not passed to a command another way. Used for [Remote Node Administration](/docs/configuration/remote-admin).
|
||||
The destination node id for any sent commands, if not passed to a command another way. Used for [Remote Node Administration](/docs/configuration/remote-admin).
|
||||
|
||||
On many shells, exclamation points trigger special behavior unless enclosed in single quotes.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue