From f8e275f0f7c014c491f9c79c6da9366f8a27fdb9 Mon Sep 17 00:00:00 2001 From: Andrew Rioux Date: Tue, 21 Oct 2025 11:03:38 -0400 Subject: [PATCH] docs: clarify download or build options --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 20eee81..22e0803 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,16 @@ The most mature implementation of Sparse would be the Sparse version 0.5 bind sh ### Quick start: -- Install the Nix package manager on a Linux system: [https://nixos.org/download/] -- Run `nix --experimental-features 'nix-command flakes' build .#sparse-05-client` -- Generate a Linux server with `result/bin/sparse-05-client generate -t linux service-name` +- Either download or build the client: + - Download from releases: + - `sudo wget https://gitea.riouxs.co/andrew.rioux/sparse/releases/download/v0.6.1/sparse-05-client -O /usr/local/bin/sparse-05-client` + - `chmod +x /usr/local/bin/sparse-05-client` + - Build: + - Install the Nix package manager on a Linux system: [https://nixos.org/download/] + - Run `nix --experimental-features 'nix-command flakes' build .#sparse-05-client` + - Copy `result/bin/sparse-05-client` to somewhere in your `$PATH` +- Generate a Linux server with `sparse-05-client generate -t linux service-name` - Copy to and run on a target system as root -- Connect to it with `result/bin/sparse-05-client connect service-name.scon SERVER_IP:54248` +- Connect to it with `sparse-05-client connect service-name.scon SERVER_IP:54248` - Set up a firewall to block all inbound connections with `iptables -P INPUT DROP`, `iptables -F INPUT`; sparse should still be able to connect and operate - Run `iptstate`, `auditbeat`, or `auditd` from another session to see that no IP or UDP traffic is being logged by the kernel