mirror of https://github.com/EFForg/rayhunter.git synced 2026-04-27 07:59:59 -07:00

Files

Markus Unterwaditzer 29823d3e82 Update documentation and fix broken links

* Add a new configuration page and move content out from TP-Link. The
  Configuration section in TP-Link is duplicating what is already in
  config.toml.example, and given that we have recently added a lot of
  new options I don't want to maintain multiple copies.

* Lots of anchor links were broken since we moved docs from README into
  mdbook. Fix them all.

* Document that the key input feature is disabled since 0.4.0.

* Smaller cosmetic changes:

  * Make TP-Link M7350 page consistent with TP-Link M7310 page.
  * Fix indentation on some bullet points.
  * Center-align the rayhunter logo in introduction.md to calm my soul.
    It is still misaligned with the page title above itself.
  * Add "edit on github" link in mdbook settings.

2025-06-23 09:40:20 -07:00

2.2 KiB

Raw Blame History

Installing from the latest release

Make sure you've got one of Rayhunter's supported devices. These instructions have only been tested on macOS and Ubuntu 24.04. If they fail, you will need to install Rayhunter from source.

Download the latest rayhunter-vX.X.X.zip from the Rayhunter releases page
Decompress the rayhunter-vX.X.X.zip archive. Open the terminal and navigate to the folder. (Be sure to replace X.X.X with the correct version number!)
```
unzip ~/Downloads/rayhunter-vX.X.X.zip
cd ~/Downloads/rayhunter-vX.X.X
```
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.
Run the install script for your operating system:

First, enter the correct subfolder for your operating system:
- for Ubuntu on x64 arhitecture: cd installer-ubuntu-24
- for Ubuntu on ARM64 arhitecture: cd installer-ubuntu-24-aarch64
- for MacOS on Intel (old macbooks) architecture: cd installer-macos-intel
- for MacOS on ARM (M1/M2 etc.) achitecture: cd installer-macos-arm
- for Windows: cd installer-windows-x86_64
```
# On MacOS, you must first remove the quarantine bit
xattr -d com.apple.quarantine installer
```
Then run the installer:
```
./installer orbic
# or: ./installer 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 Testing Rayhunter... done
Rayhunter should now be running! You can verify this by viewing Rayhunter's web UI. You should also see a green line flash along the top of top the display on the device.

Troubleshooting

On MacOS if you encounter an error that says "No Orbic device found," it may because you have the "Allow accessories to connect" security setting set to "Ask for approval." You may need to temporarily change it to "Always" for the script to run. Make sure to change it back to a more secure setting when you're done.

./installer --help ./installer util --help

2.2 KiB Raw Blame History

Installing from the latest release

Troubleshooting

2.2 KiB

Raw Blame History