Getting Started with the Repository

Step 1 - Download 404

Requirements

Utilizing the eBPF module requires a Linux kernel (4.15+).

Component	Version	Install Link
Rust	1.76+	INSTALL
CMake	Latest	INSTALL
NASM	Latest	INSTALL

You may install these manually, but it is often easier to install them via brew or winget. So open the Terminal and lets get started!

Install dependencies & configure PATH

All commands can be copy pasted into your terminal for easy usage!

WindowsmacOSLinux

Install via winget

1. Click here (32-bit) to download rust-up. Open the downloaded .exe file and follow setup instructions.

   • Use the “Workload” tab to select the “Desktop Development with C++” option.
   • Help

2. Open the Command Prompt

   • Press... + r

   • Type "cmd" into the run dialogue box.

3. Download the dependencies

winget install --id Kitware.CMake -e && winget install --id NASM.NASM -e

Restart your shell after installation. Tools should be on your PATH automatically.

Install via homebrew (recommended)

1. Open the Terminal

   • Press + space
   • Search "Terminal" and press Enter

2. Ensure you have homebrew installed

   a.

   xcode-select --install 
   

   b.

   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
   

3. Download dependencies w/ homebrew:

brew install rust nasm cmake

Restart your shell after installation. Tools should be on your PATH automatically.

Install via package manager

# Debian/Ubuntu
$ sudo apt update
$ sudo apt install -y curl build-essential nasm cmake

# Arch
$ sudo pacman -S rust nasm cmake

# Fedora/RHEL
$ sudo dnf install -y rust cargo nasm cmake

# Install Rust via rustup (if not installed via package manager)
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
$ source $HOME/.cargo/env

Step 3 - Start Proxy