From 22259dbbcc6acb3439ee3220c083a6a457b8b8a2 Mon Sep 17 00:00:00 2001 From: recanman <29310982+recanman@users.noreply.github.com> Date: Thu, 21 May 2026 22:31:52 +0000 Subject: [PATCH] improve installation docs consistency (#1051) Co-authored-by: Markus Unterwaditzer --- doc/installing-from-release.md | 16 +++++----------- doc/moxee.md | 23 ++++++++++++++++------- doc/orbic.md | 34 ++++++++++++++++++++++++++++++++-- doc/tplink-m7350.md | 11 +++++++++-- 4 files changed, 62 insertions(+), 22 deletions(-) diff --git a/doc/installing-from-release.md b/doc/installing-from-release.md index 143a23e..e278a0b 100644 --- a/doc/installing-from-release.md +++ b/doc/installing-from-release.md @@ -41,27 +41,21 @@ Make sure you've got one of Rayhunter's [supported devices](./supported-devices. ```bash # For Orbic: ./installer orbic --admin-password 'mypassword' + # Note: the arguments --admin-username 'myusername' and --admin-ip 'mydeviceip' # may be required if different from the default. - # Or install over USB if you want ADB and a root shell (not recommended for most users) - ./installer orbic-usb - # For TP-Link: ./installer tplink ``` - * On Verizon Orbic, the password is the one used to login to the device's admin menu, and the default is the WiFi password. - * ***Note:*** If you have changed the device username, password, or IP address from their default values, these must be provided as arguments to the installer command above. - * On Kajeet/Smartspot devices, the default password is `$m@rt$p0tc0nf!g` - * On Moxee-brand devices, check under the battery for the password. - * You can reset the password by pressing the button under the back case until the unit restarts. - - TP-Link does not require an `--admin-password` parameter. + * On Verizon Orbic, the default password is the WiFi password. You can reset the password by pressing the button under the back case until the unit restarts. + * ***Note:*** If you have changed the device username, password, or IP address from their default values, these must be provided as arguments to the installer command above. + * TP-Link does not require an `--admin-password` parameter. For other devices, check `./installer --help` or the respective page in the sidebar under "Supported - Devices." + Devices" for the installation command. 7. The installer will eventually tell you it's done, and the device will reboot. diff --git a/doc/moxee.md b/doc/moxee.md index 5eea851..a1d9719 100644 --- a/doc/moxee.md +++ b/doc/moxee.md @@ -27,21 +27,30 @@ According to [FCC ID 2APQU-K779HSDL](https://fcc.report/FCC-ID/2APQU-K779HSDL), | 66 | 1700/2100 MHz (E-AWS) | | 71 | 600 MHz | -## Installation +## Installing -Connect to the hotspot's network using WiFi or USB tethering and run: +To get started, follow the [release installation guide](./installing-from-release.md). Then run the installer with the following command: -```sh +```bash ./installer moxee --admin-password 'mypassword' + +# Note: the arguments --admin-username 'myusername' and --admin-ip 'mydeviceip' +# may be required if different from the default. ``` -The password (in place of `mypassword`) is under the battery. +* The password is the one used to log in to the device's admin menu. You can reset the password by pressing the button under the back case until the unit restarts. + * ***Note:*** If you have changed the device username, password, or IP address from their default values, these must be provided as arguments to the installer command above. +* On Moxee-brand devices, check under the battery for the password. +* `./installer moxee` is almost the same as `./installer orbic`, it just comes with slightly better defaults that will give you more space for recordings. -`./installer moxee` is almost the same as `./installer orbic`, it just comes -with slightly better defaults that will give you more space for recordings. +The Rayhunter UI will be available at . + ## Obtaining a shell -```sh +After running the installer, there will not be a root shell and ADB will not be +enabled. Instead, you can use: + +```bash ./installer util orbic-shell ``` diff --git a/doc/orbic.md b/doc/orbic.md index 0eb45ee..b9b368b 100644 --- a/doc/orbic.md +++ b/doc/orbic.md @@ -42,11 +42,41 @@ The orbic's installation routine underwent many different changes: It's possible that many tutorials out there still refer to some of the old installation routines. +## Installing + +To get started, follow the [release installation guide](./installing-from-release.md). Then run the installer with the following command: + + +```bash +# For Orbic: +./installer orbic --admin-password 'mypassword' + +# For Kajeet/Smartspot: +./installer orbic --admin-password '$m@rt$p0tc0nf!g' + +# Note: the arguments --admin-username 'myusername' and --admin-ip 'mydeviceip' +# may be required if different from the default. + +# Or install over USB if you want ADB and a root shell (not recommended for most users) +./installer orbic-usb +``` + +* The password is the one used to log in to the device's admin menu. You can reset the password by pressing the button under the back case until the unit restarts. + * ***Note:*** If you have changed the device username, password, or IP address from their default values, these must be provided as arguments to the installer command above. +* On Verizon Orbic, the default password is the WiFi password. +* On Kajeet/Smartspot devices, the default password is `$m@rt$p0tc0nf!g` + +The Rayhunter UI will be available at . + ## Obtaining a shell -After running the installer, there will not be a rootshell and ADB will not be -enabled. Instead you can use `./installer util orbic-shell`. +After running the installer, there will not be a root shell and ADB will not be +enabled. Instead, you can use: + +```bash +./installer util orbic-shell +``` If you are using an installer prior to 0.7.0 or `orbic-usb` explicitly, you can obtain a root shell by running `adb shell` or `./installer util shell`. Then, diff --git a/doc/tplink-m7350.md b/doc/tplink-m7350.md index e002a42..45e7a19 100644 --- a/doc/tplink-m7350.md +++ b/doc/tplink-m7350.md @@ -38,10 +38,17 @@ You can get your TP-Link M7350 from: * [Ebay](https://www.ebay.com/sch/i.html?_nkw=tp-link+m7350&_sacat=0&_from=R40&_trksid=p4432023.m570.l1313). * Can also be found sold as the 'Vodafone Pocket Wifi 5' in Australia -## Installation & Usage +## Installing -Follow the [release installation guide](./installing-from-release.md). Substitute `./installer orbic` for `./installer tplink` in other documentation. The Rayhunter UI will be available at . +To get started, follow the [release installation guide](./installing-from-release.md). Then run the installer with the following command: +```bash +./installer tplink +``` + +The Rayhunter UI will be available at . + + ## Obtaining a shell You can obtain a root shell with the following command: