mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-26 22:19:46 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

add cli section and trunk fmt

Browse source
This commit is contained in:
rcarteraz 2024-11-01 09:14:29 -07:00
parent e6bd977495
commit 8c20f801ab
2 changed files with 35 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/configuration/radio/channels.mdx
View file

@ -69,9 +69,9 @@ The Channel Settings options are: Name, PSK, Downlink Enabled, and Uplink Enable
A short identifier for the channel. _(< 12 bytes)_ A short identifier for the channel. _(< 12 bytes)_
| Reserved Name | Purpose | | Reserved Name | Purpose |
| :------------: | :----------------------------------------------------------------------------------------------------------------------------: | | :------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| `""` (default) | If left empty on the Primary channel, this designates the `default` channel. | | `""` (default) | If left empty on the Primary channel, this designates the `default` channel. |
| `admin` | On Secondary channels, the name `admin` (case sensitive) designates the `admin` channel used to administer nodes over the mesh. Note that this is a Legacy feature, see [Remote Admin](docs/configuration/remote-admin.mdx) for details. | | `admin` | On Secondary channels, the name `admin` (case sensitive) designates the `admin` channel used to administer nodes over the mesh. Note that this is a Legacy feature, see [Remote Admin](docs/configuration/remote-admin.mdx) for details. |
:::note :::note

49
docs/configuration/remote-admin.mdx
View file

@ -13,14 +13,12 @@ import TabItem from "@theme/TabItem";
This is an advanced feature intended for experienced users. It’s possible (if not done carefully) to apply settings to a remote node that could cause it to disconnect from the mesh. Network admins are advised to use a test node to trial settings before applying changes to a remote node to prevent this. This is an advanced feature intended for experienced users. It’s possible (if not done carefully) to apply settings to a remote node that could cause it to disconnect from the mesh. Network admins are advised to use a test node to trial settings before applying changes to a remote node to prevent this.
::: :::
This feature allows secure remote administration of Meshtastic nodes over the mesh network. This feature allows secure remote administration of Meshtastic nodes over the mesh network.
By default, nodes will only respond to administrative commands via the local USB, Bluetooth, or TCP interfaces. This basic security measure prevents unauthorized access and defines how standard administration and settings changes are managed. The only difference with remote administration is that commands are sent securely as Admin Messages over the mesh. By default, nodes will only respond to administrative commands via the local USB, Bluetooth, or TCP interfaces. This basic security measure prevents unauthorized access and defines how standard administration and settings changes are managed. The only difference with remote administration is that commands are sent securely as Admin Messages over the mesh.
## Prerequisites ## Prerequisites
For firmware versions 2.5 and later, remote administration is achieved by storing the public key of the local node in one of the Admin Key fields within the remote node’s Security Config. Each remote node can store up to three unique Admin Keys, providing flexibility for managing nodes across the network. For firmware versions 2.5 and later, remote administration is achieved by storing the public key of the local node in one of the Admin Key fields within the remote node’s Security Config. Each remote node can store up to three unique Admin Keys, providing flexibility for managing nodes across the network.
For firmware versions 2.4.x and earlier, this is achieved by creating a secondary channel named `admin` with a shared PSK. In this setup, messages exchanged on this channel are encrypted only with the channel’s PSK, allowing any node in the channel to administer others. For firmware versions 2.4.x and earlier, this is achieved by creating a secondary channel named `admin` with a shared PSK. In this setup, messages exchanged on this channel are encrypted only with the channel’s PSK, allowing any node in the channel to administer others.
@ -31,7 +29,6 @@ This `admin` channel method is still supported in firmware versions 2.5 and late
Remote Admin is complemented by setting [Managed Mode](/docs/configuration/radio/security/#managed-mode) on the remote node, which restricts radio configurations on that node. It is not necessary to set Managed Mode for Remote Admin to function. Remote Admin is complemented by setting [Managed Mode](/docs/configuration/radio/security/#managed-mode) on the remote node, which restricts radio configurations on that node. It is not necessary to set Managed Mode for Remote Admin to function.
::: :::
## Remote Admin Config Client Availability ## Remote Admin Config Client Availability
<Tabs <Tabs
@ -47,7 +44,6 @@ values={[
#### Android #### Android
#### Setting up Remote Admin Using the PKC Method #### Setting up Remote Admin Using the PKC Method
1. Connect to the local node that will be administering the remote node. 1. Connect to the local node that will be administering the remote node.
@ -105,28 +101,47 @@ Legacy admin is enabled using the Legacy Admin channel option in [Security Confi
#### CLI #### CLI
:::info
For Linux/Mac, enclose the `--nodeid` value in single quotes: `--dest '!28979058'`; for Windows, no quotes are needed: `--dest !28979058`.
:::
#### Setting up Remote Admin Using the PKC Method #### Setting up Remote Admin Using the PKC Method
1. Connect to the local node that will be administering the remote node. 1. Connect via USB to the node that will be administering the remote node.
2. Use `meshtastic --get security.public_key` to get the public key. 2. Retrieve its Public Key by running:
3. Copy the public key to use for configuring the remote node. ```bash
4. Connect to the node that will be the remotely administered node. meshtastic --get security.public_key
5. ??? ```
6. Up to 3 Admin Keys may be supplied, one per field, allowing up to 3 controlling nodes. 3. Copy the public key to use when configuring the remote node.
4. Connect to the remote node via USB.
5. Set the Admin Key on the remote node by running:
```bash
meshtastic --set security.admin_key "PASTEPUBLICKEYHERE"
```
6. You may add up to 3 Admin Keys, enabling control from up to 3 different nodes.
#### Carrying out Remote Admin tasks #### Setting up Remote Admin Using the Legacy Method
Commands are issued using the `--dest` argument along with the `'!nodeid'` to specify the remote node. For example, `--dest '!28979058'`. To use the legacy method, set up an Admin channel as a secondary channel with the name `admin` by following the instructions in the [Channels](/docs/configuration/radio/channels/) section.
Enable Legacy Admin in the [Security Config](/docs/configuration/radio/security/#admin-channel-enabled) by running the following CLI command:
```bash
meshtastic --set security.admin_channel_enabled
```
#### Carrying Out Remote Admin Tasks
Remote admin commands are issued using the `--dest` argument with the `!nodeid` of the target node. For example:
```bash
meshtastic --dest '!28979058'
```
:::info
For Linux/Mac, enclose the `nodeid` value in single quotes: `--dest '!28979058'`. For Windows, quotes are not required: `--dest !28979058`.
:::
</TabItem> </TabItem>
<TabItem value="web"> <TabItem value="web">
#### Web #### Web
</TabItem> </TabItem>
</Tabs> </Tabs>