Migrate README content to the mdbook

This commit is contained in:
Will Greenberg
2025-05-12 14:55:26 -07:00
committed by Cooper Quintin
parent 98ee6dacf8
commit abc3c07201
17 changed files with 344 additions and 174 deletions

View File

@@ -0,0 +1,29 @@
# Installing from the latest release
Make sure you've got one of Rayhunter's [supported devices](./supported-devices.md). These instructions have only been tested on macOS and Ubuntu 24.04. If they fail, you will need to [install Rayhunter from source](./installing-from-source.md).
1. Download the latest `release.tar` from the [Rayhunter releases page](https://github.com/EFForg/rayhunter/releases)
2. Decompress the `release.tar` archive. Open the terminal and navigate to the folder
```bash
mkdir ~/Downloads/release
tar -xvf ~/Downloads/release.tar -C ~/Downloads/release
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.
4. Run the install script for your operating system:
```bash
./install.sh
```
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!`
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.
## Troubleshooting
* On macOS if you encounter an error that says "No Orbic device found," it may because you 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.