andrew.rioux/sparse
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

docs: clarify download or build options
Some checks failed
Build sparse 0.5 without FreeBSD support / build-and-upload (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Andrew Rioux 2025-10-21 11:03:38 -04:00
parent 7f209d95ce
commit f8e275f0f7
Signed by: andrew.rioux
GPG Key ID: 9B8BAC47C17ABB94
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -19,10 +19,16 @@ The most mature implementation of Sparse would be the Sparse version 0.5 bind sh
### Quick start: ### Quick start:
- 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/] - Install the Nix package manager on a Linux system: [https://nixos.org/download/]
- Run `nix --experimental-features 'nix-command flakes' build .#sparse-05-client` - 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` - 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 - 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 - 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 - Run `iptstate`, `auditbeat`, or `auditd` from another session to see that no IP or UDP traffic is being logged by the kernel