Mirror/rayhunter
1
0
Fork 0
mirror of https://github.com/EFForg/rayhunter.git synced 2026-06-11 15:23:30 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for Rust installer

Browse Source
This commit is contained in:
Markus Unterwaditzer
2025-05-16 12:45:46 +02:00
committed by Cooper Quintin
parent d6e4f6a71d
commit ce8260b92c
4 changed files with 63 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/installing-from-release.md
+8 -3
View File
@@ -11,16 +11,21 @@ Make sure you've got one of Rayhunter's [supported devices](./supported-devices.
cd ~/Downloads/release
```
3. Turn on your device. For the Orbic, you can do this by holding the power button for 3 seconds or until the screen turns on. Plug it into your computer using a USB-C Cable.
3. Turn on your device by holding the power button on the front.
* For the Orbic, connect the device using a USB-C cable.
* For TP-Link, connect to its network using either WiFi or USB Tethering.
4. Run the install script for your operating system:
```bash
./install.sh
./install orbic
# or: ./install tplink
```
The device will restart multiple times over the next few minutes.
You will know it is done when you see terminal output that says `checking for rayhunter server...success!`
You will know it is done when you see terminal output that says `Testing rayhunter... done`
5. Rayhunter should now be running! You can verify this by [viewing Rayhunter's web UI](./using-rayhunter). You should also see a green line flash along the top of top the display on the device.
doc/installing-from-source.md
+7 -1
View File
@@ -32,7 +32,13 @@ rustup target add x86_64-apple-darwin
rustup target add x86_64-pc-windows-gnu
```
Now you can root your device and install Rayhunter by running `./tools/install-dev.sh`
Now you can root your device and install Rayhunter by running:
```sh
cargo build --bin rayhunter-daemon --target armv7-unknown-linux-musleabihf --no-default-features --features orbic
cargo run --bin installer orbic
```
### If you're on Windows or can't run the install scripts
doc/tplink-m7350.md
+39 -25
View File
@@ -1,40 +1,54 @@
# TP-Link M7350
Rayhunter is currently working on support for the TP-Link M7350. This
device supports many more frequency bands than the Orbic RC400L, meaning it
works in the EU, for example.
The TP-Link M7350 is supported by Rayhunter as of 0.2.9. It supports many more frequency bands than Orbic and therefore works in Europe.
You can get it [on
Ebay](https://www.ebay.com/sch/i.html?_nkw=tp-link+m7350&_sacat=0&_from=R40&_trksid=p4432023.m570.l1313)
on Amazon, but particularly in the EU it is often significantly cheaper
second-hand on local forums, ranging anywhere from 15 EUR to 50 EUR (used)
You can get it from:
As of 0.2.8, the official Rayhunter release contains a
"rayhunter-daemon-tplink" binary that can be manually installed onto the
device. Work on an official installer like `install.sh` is in progress.
* First check for used offers on Ebay or equivalent, sometimes it's much cheaper there.
* [Geizhals price comparison](https://geizhals.eu/?fs=tp-link+m7350)
* [Ebay](https://www.ebay.com/sch/i.html?_nkw=tp-link+m7350&_sacat=0&_from=R40&_trksid=p4432023.m570.l1313)
For information on manual installation see
[rayhunter-tplink-m7350](https://github.com/m0veax/rayhunter-tplink-m7350/)
## Installation & Usage
## Hardware versions
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 [http://192.168.0.1:8080](http://192.168.0.1:8080).
The TP-Link comes in many different *hardware versions*. You can find the
hardware version of each device under the battery or next to the barcode on the
outer packaging, for example `V3.0` or `V5.2`. Support for installation varies:
Unlike on Orbic, the installer will not enable ADB. Instead, you can do this to obtain a root shell:
* `1.0-2.0`: Not tested, probably impossible to obtain anymore (even second-hand)
* `3.0`, `3.2`, `5.0`, `5.2`, `7.0`, `8.0`: Tested, no issues.
* `9.0`: Recording might be broken, could be fixed if there is demand.
Otherwise is mostly no difference to the user, except that versions after `3.0`
have a color display.
```sh
./installer util tplink-start-telnet
telnet 192.168.0.1
```
## Display states
If your device has a color display, Rayhunter will show the same
red/green/white line at the top of the display as it does on Orbic, each color
meaning "warning"/"recording"/"paused" respectively.
meaning "warning"/"recording"/"paused" respectively. See [Using Rayhunter](./using-rayhunter.md).
If your device has a one-bit (black-and-white) display, Rayhunter will instead
show an emoji to indicate status. `!` means "warning", `:)` (smiling) means
"recording", `:` (face with no mouth) means "paused".
show an emoji to indicate status:
* `!` means "warning (potential IMSI catcher)"
* `:)` (smiling) means "recording"
* `:` (face with no mouth) means "paused"
## Hardware versions
The TP-Link comes in many different *hardware versions*. Support for installation varies:
* `1.0-2.0`: Not tested, probably impossible to obtain anymore (even second-hand)
* `3.0`, `3.2`, `5.0`, `5.2`, `7.0`, `8.0`: Tested, no issues.
* `9.0`: Recording might be broken, could be fixed if there is demand.
TP-Link versions newer than `3.0` have cyan packaging and a color display.
Version `3.0` has a one-bit display and white packaging.
You can find the exact hardware version of each device under the battery or
next to the barcode on the outer packaging, for example `V3.0` or `V5.2`.
When filing bug reports, particularly with the installer, please always
specify the exact hardware version.
## Other links
For more information on the device and instructions on how to install Rayhunter without an installer, see [rayhunter-tplink-m7350](https://github.com/m0veax/rayhunter-tplink-m7350/)
doc/using-rayhunter.md
+9 -3
View File
@@ -6,9 +6,15 @@ It also serves a web UI that provides some basic controls, such as being able to
You can access this UI in one of two ways:
1. **Connect over wifi:** Connect your phone/laptop to your device's wifi network and visit [http://192.168.1.1:8080](http://192.168.1.1:8080). (Click past your browser warning you about the connection not being secure, Rayhunter doesn't have HTTPS yet).
* On the Orbic, you can find the wifi network password by going to the Orbic's menu > 2.4 GHz WIFI Info > Enter > find the 8-character password next to the lock 🔒 icon.
2. **Connect over USB:** Connect your device to your laptop via USB. Run `adb forward tcp:8080 tcp:8080`, then visit [http://localhost:8080](http://localhost:8080).
* **Connect over wifi:** Connect your phone/laptop to your device's wifi
network and visit [http://192.168.1.1:8080](http://192.168.1.1:8080) (orbic)
or [http://192.168.0.1:8080](http://192.168.0.1:8080) (tplink).
Click past your browser warning you about the connection not being secure, Rayhunter doesn't have HTTPS yet.
On the Orbic, you can find the wifi network password by going to the Orbic's menu > 2.4 GHz WIFI Info > Enter > find the 8-character password next to the lock 🔒 icon.
* **Connect over USB (orbic):** Connect your device to your laptop via USB. Run `adb forward tcp:8080 tcp:8080`, then visit [http://localhost:8080](http://localhost:8080).
* For this you will need to install the Android Debug Bridge (ADB) on your computer, you can copy the version that was downloaded inside the `releases/platform-tools/` folder to somewhere else in your path or you can install it manually.
* You can find instructions for doing so on your platform [here](https://www.xda-developers.com/install-adb-windows-macos-linux/#how-to-set-up-adb-on-your-computer), (don't worry about instructions for installing it on a phone/device yet).
* On macOS, the easiest way to install ADB is with Homebrew: First [install Homebrew](https://brew.sh/), then run `brew install android-platform-tools`.
* **Connect over USB (tplink):** Plug in the TP-Link and use USB tethering to establish a network connection. ADB support can be enabled on the device, but the installer won't do it for you.