docs: user guide, config reference, testing/benchmarking, example.config - #46
Merged
Conversation
Bring the user-facing docs up to date with the merged data plane (#1), control plane (#2: multi-peer + self-cert addresses, rendezvous/NAT/relay, mesh discovery), and anti-DPI 3a (obf_psk obfuscation). - example.config: a complete, annotated starter config covering every key (core, multi-peer, rendezvous, mesh, obf_psk). Verified it parses. - docs/user-guide.md (new): build + walkthroughs — two-node tunnel, addresses, multi-peer, rendezvous/NAT traversal, the offline yip-ca mesh workflow, enabling anti-DPI obfuscation (with the security model), I/O driver choice. - docs/testing-and-benchmarking.md (new): unit tests, the netns integration suite (both drivers), the nDPI undetectability oracle, and the benchmark harness (micro-benchmarks + netem yip-vs-WireGuard/OpenVPN/n2n) with commands. - docs/configuration.md: rewritten as the complete config/CLI/env reference (was stale — missing rendezvous/mesh/obf keys, wrong on [peer] endpoint being optional). - README: status, architecture table, and roadmap updated (#2 + #3a done); links to the new docs + example.config. Config format stays the current key=value/[peer] form; a first-class TOML config is noted as a planned milestone. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brings the user-facing docs up to date with everything merged so far — data plane (#1), full control plane (#2), and anti-DPI 3a (
obf_psk) — and adds the walkthroughs + example config that were missing.What's here
example.config— a complete, annotated starter config covering every key (core, multi-peer[peer]blocks,rendezvous, the five mesh keys,obf_psk). Verified it parses.docs/user-guide.md(new) — build + step-by-step walkthroughs: a two-node tunnel, self-certifying addresses (yipd --addr), multiple peers, rendezvous + NAT traversal, the offlineyip-camesh workflow (genkey → sign-cert → sign-roots), enabling anti-DPI obfuscation with the security model spelled out, and choosing the I/O driver.docs/testing-and-benchmarking.md(new) — how to run unit tests, the netns integration suite (bothpollandio_uringdrivers, exact commands), the nDPI undetectability oracle, and the benchmark harness (micro-benchmarks +tc netemyip-vs-WireGuard/OpenVPN/n2n) with what to expect.docs/configuration.md— rewritten as the complete config/CLI/env reference. The old version was stale (norendezvous/mesh/obf_pskkeys; incorrectly said a[peer]endpointwas required).Config format note
Docs describe the current line-based
key=value+[peer]format thatyipdactually parses today. A first-class TOML config is called out as a planned milestone (per the decision to ship a working example now and do TOML deliberately later).Every config key, CLI flag, command, test name, and benchmark was verified against the source, not inferred.
🤖 Generated with Claude Code