Home › Documentation › Installation

Installation

Applies to GNULTE v16.13 · last updated 2026-10-15

Requirements

ComponentRequired for
Linuxrunning the toolkit. The code is portable where it can be (platform-specific files sit behind *_linux.go build tags and GOOS=darwin go vet stays clean), but Linux is the supported platform.
Go 1.21+building. There are no third-party modules; the standard library is enough.
iproute2 (tc)shaping (gnulte). This is the kernel interface and stays a dependency by design.
iptablesforwarding rules during a shaping run; restored on exit.
iputils (ping)optional fallback: non-root tools fall back to the system ping when raw sockets are unavailable. Not required since v16.7 for the engine.
root (sudo)shaping, ARP spoofing, injection and packet capture. Scanning, inventory and gnulte-doctor work unprivileged.

No arping, arp-scan, tcpdump or traceroute(8) is needed anywhere — those shell-outs were replaced by in-process code in the Unplugged increments (v16.6–v16.10).

Build and install

git clone https://github.com/notmicrosoft2000-cmd/gnulte-go.git
cd gnulte-go
./build.sh          # builds all eight binaries, runs go vet + go test ./...
sudo ./install.sh   # installs to /usr/local/bin + safety docs

build.sh refuses to hand you binaries that fail go vet or go test ./.... install.sh copies the binaries to /usr/local/bin together with the safety documents, and reads the version from the freshly built binaries — aborting if they disagree — so an installed copy can never silently drift behind the source tree.

Updating

git pull
sudo ./install.sh

Uninstalling

sudo ./uninstall.sh            # remove the binaries and safety docs
sudo ./uninstall.sh --purge    # also remove ~/.config/gnulte-go and the reports

Where things live

PathContents
~/.config/gnulte-go/config.jsonsaved defaults from the settings editor (--settings)
~/.config/gnulte-go/devices.jsonthe shared device store every tool reads and writes
~/.config/gnulte-go/acceptance.jsonthe authorised-use acceptance record
~/.config/gnulte-go/profiles.jsonuser-saved impairment profiles
~/.config/gnulte-go/watch-history.jsonlthe LAN-watch up/down timeline (v16.13+)
~/GNULTE Reports/HTML reports written after each run

State is per-user and nothing is written outside your home directory and /usr/local/bin.

First run

Run the pre-flight check before anything else:

gnulte-doctor

It reports PASS/WARN/FAIL for privileges, tc/iptables, ip_forward, the netem/netfilter modules, the default route and interface, duplicate IPs and the safety record — with fix-it hints. If anything fails, see troubleshooting.