doc/installing-from-release.md
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.
For the TP-Link only, insert a FAT-formatted SD card. This will be used to store all recordings.
Download the latest rayhunter-vX.X.X-PLATFORM.zip from the Rayhunter releases page for your platform:
linux-x64linux-aarch64linux-armv7macos-intelmacos-armwindows-x86_64Decompress the rayhunter-vX.X.X-PLATFORM.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-PLATFORM.zip
cd ~/Downloads/rayhunter-vX.X.X-PLATFORM
On Windows you can decompress using the file browser, then navigate to the
folder that contains installer.exe, hold Shift, Right-Click inside the
folder, then click "Open in PowerShell".
Connect to your device.
First turn on your device by holding the power button on the front.
Then connect to the device using either WiFi or USB tethering.
You know you are in the right network when you can access http://192.168.1.1 (Orbic) or http://192.168.0.1 (TP-Link) and see the hardware's own admin menu.
On MacOS only, you have to run xattr -d com.apple.quarantine installer to allow execution of
the binary.
Run the installer.
# 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
$m@rt$p0tc0nf!gTP-Link does not require an --admin-password parameter.
For other devices, check ./installer --help or the
respective page in the sidebar under "Supported
Devices."
The installer will eventually tell you it's done, and the device will reboot.
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.
If you are having trouble installing Rayhunter and you're connecting to your device over USB, try using a different USB cable to connect the device to your computer. If you are using a USB hub, try using a different one or directly connecting the device to a USB port on your computer. A faulty USB connection can cause the Rayhunter installer to fail.
You can test your device by enabling the test heuristic. This will be very noisy and fire an alert every time you see a new tower. Be sure to turn it off when you are done testing.
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