diff --git a/README.md b/README.md index b3ad96d..05775a2 100644 --- a/README.md +++ b/README.md @@ -24,9 +24,45 @@ ohne Tricks. ## Build +Voraussetzung: eine Rust-Toolchain (Rust 1.82+). Falls noch nicht vorhanden: + +```bash +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh +``` + +Release-Binary bauen: + ```bash cargo build --release -# Binary: ./target/release/iroh-forward +``` + +Das fertige Binary liegt unter `./target/release/iroh-forward`. Direkt ausführen: + +```bash +./target/release/iroh-forward --help +# oder ohne expliziten Build: +cargo run --release -- --help +``` + +Systemweit installieren (nach `~/.cargo/bin`): + +```bash +cargo install --path . +``` + +### Statisches Binary fürs Deployment (optional) + +Für ein weitgehend abhängigkeitsfreies Binary, das auf jedem Linux-Host ohne passende glibc läuft, +gegen musl bauen. Da iroh standardmäßig `ring` (C-Crypto) nutzt, wird die musl-C-Toolchain +benötigt: + +```bash +# Debian/Ubuntu: +sudo apt install musl-tools +rustup target add x86_64-unknown-linux-musl + +cargo build --release --target x86_64-unknown-linux-musl +# Binary: ./target/x86_64-unknown-linux-musl/release/iroh-forward ``` ## Nutzung