diff --git a/docs/rpt-mgmt.md b/docs/rpt-mgmt.md new file mode 100644 index 0000000..8960d72 --- /dev/null +++ b/docs/rpt-mgmt.md @@ -0,0 +1,59 @@ +# How to Manage Your Repeater + +This guide explains how to manage a MeshCore repeater device directly from the mc-webui interface using Direct Messages. + +--- + +## 1. Add Your Repeater to Contacts + +- Wait for your repeater's first `advert` +- Click on the Contacts icon + + New repeater notification + +- Go to `Pending contacts` panel + + Pending contacts + +- Search for your repeater on the list and approve it + + Approve repeater + +- Reset your search filter (it is recommended to leave CLI selected only) and return to the main chat view + + Return to home + +--- + +## 2. Login to Your Repeater and Initialize Conversation + +- Open the `meshcli Console` + + Console + +- Enter the `login ` command +- Type the `msg "Hello"` command (you can use any message text) + + Login + +- Return to the main chat view + +--- + +## 3. Send Commands to Your Repeater + +- From the main chat view, click on the DM icon + + DM notification + +- Find your repeater's name on the list + + Open DM chat + +- Start sending commands to your repeater as if it were a regular DM conversation + + Repeater commands + +For full commands reference, see [Repeater & Room Server CLI Reference](https://github.com/meshcore-dev/MeshCore/wiki/Repeater-&-Room-Server-CLI-Reference). + +**Note:** Not all commands may work at the moment. diff --git a/docs/user-guide.md b/docs/user-guide.md index cba8a6e..3f72b8e 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -396,6 +396,7 @@ To get the full PWA experience with app badge counters: ## Getting Help - **Full README:** [README.md](../README.md) +- **Repeater Management:** [rpt-mgmt.md](rpt-mgmt.md) - **Troubleshooting:** [troubleshooting.md](troubleshooting.md) - **Architecture:** [architecture.md](architecture.md) - **MeshCore docs:** https://meshcore.org diff --git a/images/RPT-Mgmt-01-new-rpt-notification.png b/images/RPT-Mgmt-01-new-rpt-notification.png new file mode 100644 index 0000000..d11fb18 Binary files /dev/null and b/images/RPT-Mgmt-01-new-rpt-notification.png differ diff --git a/images/RPT-Mgmt-02-new-rpt-pending.png b/images/RPT-Mgmt-02-new-rpt-pending.png new file mode 100644 index 0000000..c64852e Binary files /dev/null and b/images/RPT-Mgmt-02-new-rpt-pending.png differ diff --git a/images/RPT-Mgmt-03-new-rpt-approve.png b/images/RPT-Mgmt-03-new-rpt-approve.png new file mode 100644 index 0000000..b0fc20d Binary files /dev/null and b/images/RPT-Mgmt-03-new-rpt-approve.png differ diff --git a/images/RPT-Mgmt-04-back-to-home.png b/images/RPT-Mgmt-04-back-to-home.png new file mode 100644 index 0000000..f7d20ef Binary files /dev/null and b/images/RPT-Mgmt-04-back-to-home.png differ diff --git a/images/RPT-Mgmt-05-open-console.png b/images/RPT-Mgmt-05-open-console.png new file mode 100644 index 0000000..8c24831 Binary files /dev/null and b/images/RPT-Mgmt-05-open-console.png differ diff --git a/images/RPT-Mgmt-06-login-and-msg.png b/images/RPT-Mgmt-06-login-and-msg.png new file mode 100644 index 0000000..673df1c Binary files /dev/null and b/images/RPT-Mgmt-06-login-and-msg.png differ diff --git a/images/RPT-Mgmt-07-dm-notification.png b/images/RPT-Mgmt-07-dm-notification.png new file mode 100644 index 0000000..8eb6fbb Binary files /dev/null and b/images/RPT-Mgmt-07-dm-notification.png differ diff --git a/images/RPT-Mgmt-08-dm-open.png b/images/RPT-Mgmt-08-dm-open.png new file mode 100644 index 0000000..f40829c Binary files /dev/null and b/images/RPT-Mgmt-08-dm-open.png differ diff --git a/images/RPT-Mgmt-09-rpt-commands.png b/images/RPT-Mgmt-09-rpt-commands.png new file mode 100644 index 0000000..0adda3c Binary files /dev/null and b/images/RPT-Mgmt-09-rpt-commands.png differ