Skip to content

Update README with CMake build docs and ss-setup/ss-nat usage#3026

Merged
madeye merged 1 commit intomasterfrom
docs/update-readme-ss-setup-ss-nat
Feb 11, 2026
Merged

Update README with CMake build docs and ss-setup/ss-nat usage#3026
madeye merged 1 commit intomasterfrom
docs/update-readme-ss-setup-ss-nat

Conversation

@madeye
Copy link
Copy Markdown
Contributor

@madeye madeye commented Feb 11, 2026

Summary

  • Modernize build instructions to focus on CMake as the sole build system, with a CMake options table and per-distro dependency install commands
  • Remove outdated Debian jessie/stretch backports and autotools (autogen.sh) references
  • Add comprehensive documentation for ss-setup (interactive TUI for server/client config generation, systemd service management, plugin installation)
  • Add comprehensive documentation for ss-nat (iptables NAT helper for transparent proxying with ss-redir), covering all flags with practical examples
  • Rename the existing manual iptables section to "Transparent proxy (manual iptables)" and add a note pointing to ss-nat as the simpler alternative

Test plan

  • Verify all markdown renders correctly on GitHub (tables, code blocks, anchor links)
  • Confirm build instructions match current CMake-based workflow
  • Confirm ss-setup and ss-nat examples match actual script behavior

🤖 Generated with Claude Code

Modernize build instructions to focus on CMake (the sole build system),
remove outdated autotools/backports references, and add documentation
for the ss-setup interactive TUI tool and the ss-nat transparent proxy
helper script with practical usage examples.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@madeye madeye merged commit 5c47b80 into master Feb 11, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant