mirror of
https://github.com/EFForg/rayhunter.git
synced 2026-04-26 07:29:59 -07:00
c0b1d4608a
Use uppercase Rayhunter throughout docs when refering to the project and software. Does not change pathnames.
52 lines
3.1 KiB
Markdown
52 lines
3.1 KiB
Markdown
# Installing from source
|
|
|
|
Building Rayhunter from source, either for development or because the install script doesn't work on your system, involves a number of external dependencies. Unless you need to do this, we recommend you use our [compiled builds](https://github.com/EFForg/rayhunter/releases).
|
|
|
|
* Install [nodejs/npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm), which is required to build Rayhunter's web UI
|
|
* Make sure to build the site with `cd bin/web && npm install && npm run build` before building Rayhunter. If you're working directly on the frontend, `npm run dev` will allow you to test a local frontend with hot-reloading (use `http://localhost:5173` instead of `http://localhost:8080`).
|
|
* Install ADB on your computer using the instructions above, and make sure it's in your terminal's PATH
|
|
* You can verify if ADB is in your PATH by running `which adb` in a terminal. If it prints the filepath to where ADB is installed, you're set! Otherwise, try following one of these guides:
|
|
* [linux](https://askubuntu.com/questions/652936/adding-android-sdk-platform-tools-to-path-downloaded-from-umake)
|
|
* [macOS](https://www.repeato.app/setting-up-adb-on-macos-a-step-by-step-guide/)
|
|
* [Windows](https://medium.com/@yadav-ajay/a-step-by-step-guide-to-setting-up-adb-path-on-windows-0b833faebf18)
|
|
* Install `curl` on your computer to run the install scripts. It is not needed to build binaries.
|
|
|
|
### Install Rust targets
|
|
|
|
[Install Rust the usual way](https://www.rust-lang.org/tools/install). Then,
|
|
|
|
- install the cross-compilation target for the device Rayhunter will run on:
|
|
```sh
|
|
rustup target add armv7-unknown-linux-musleabihf
|
|
```
|
|
|
|
- install the statically compiled target for your host machine to build the binary installer `serial`.
|
|
```sh
|
|
# check which toolchain you have installed by default with
|
|
rustup show
|
|
# now install the correct variant for your host platform, one of:
|
|
rustup target add x86_64-unknown-linux-musl
|
|
rustup target add aarch64-unknown-linux-musl
|
|
rustup target add aarch64-apple-darwin
|
|
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:
|
|
|
|
```sh
|
|
cargo build --bin rayhunter-daemon --target armv7-unknown-linux-musleabihf --profile firmware --no-default-features --features orbic
|
|
|
|
cargo build --bin rootshell --target armv7-unknown-linux-musleabihf --profile firmware
|
|
|
|
cargo run --bin installer orbic
|
|
```
|
|
|
|
### If you're on Windows or can't run the install scripts
|
|
|
|
* Root your device on Windows using the instructions here: <https://xdaforums.com/t/resetting-verizon-orbic-speed-rc400l-firmware-flash-kajeet.4334899/#post-87855183>
|
|
* Build the web UI using `cd bin/web && npm install && npm run build`
|
|
* Push the scripts in `scripts/` to `/etc/init.d` on device and make a directory called `/data/rayhunter` using `adb shell` (and sshell for your root shell if you followed the steps above)
|
|
* You also need to copy `config.toml.example` to `/data/rayhunter/config.toml`
|
|
* Then run `./make.sh`, which will build the binary, push it over adb, and restart the device. Once it's restarted, Rayhunter should be running!
|