Summary
The README's "Prerequisites" section only mentions kernel 6.11 and ig v0.46.0. There are no instructions for setting up a full development environment.
What's Needed
Add a comprehensive dev setup section (either in README.md or a separate docs/development.md):
Prerequisites
- Go version (from go.mod)
- Linux kernel 6.11+ with BPF LSM enabled (
CONFIG_BPF_LSM=y)
- clang/LLVM for BPF compilation
ig CLI installation- Docker (for container-based testing)
Kernel Setup
- How to check if BPF LSM is enabled:
cat /sys/kernel/security/lsm
- How to enable it (
lsm=bpf boot parameter)
- VM options for development (e.g., Vagrant, Lima, cloud VMs)
Build & Run
- Step-by-step build:
make build-gadgets → make build-app
- Why
sudo is needed (BPF requires CAP_SYS_ADMIN)
- How to run in audit vs enforce mode
- How to test with Docker containers
Troubleshooting
- Common errors and their solutions
- Kernel version compatibility notes
Summary
The README's "Prerequisites" section only mentions kernel 6.11 and ig v0.46.0. There are no instructions for setting up a full development environment.
What's Needed
Add a comprehensive dev setup section (either in README.md or a separate
docs/development.md):Prerequisites
CONFIG_BPF_LSM=y)igCLI installationKernel Setup
cat /sys/kernel/security/lsmlsm=bpfboot parameter)Build & Run
make build-gadgets→make build-appsudois needed (BPF requires CAP_SYS_ADMIN)Troubleshooting