Add SIP003u UDP extension documentation#311
Open
madeye wants to merge 1 commit into
Open
Conversation
Document SIP003u, the backward-compatible UDP extension for SIP003 plugins (plugin_mode tcp_and_udp / udp_only), based on the refined proposal in shadowsocks-org#180. Adds a new SIPs sidebar entry and cross-links the SIP003 UDP restriction note. Co-Authored-By: Claude Opus 4.8 (1M context) <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.
Closes #180.
Adds a documentation page for SIP003u, the backward-compatible UDP extension for SIP003 plugins, based on the refined proposal by @zonyitoo in #180.
Changes
docs/doc/sip003u.md— new page covering:plugin_modeconfiguration (tcp_only/tcp_and_udp/udp_only)SS_LOCAL_HOST/SS_LOCAL_PORT, full-cone NAT, typical relay flow)docs/.vitepress/config.ts— new "SIP003u UDP Extension" entry in the SIPs sidebar, after SIP003.docs/doc/sip003.md— updated the "only TCP forwarded" restriction to cross-link SIP003u instead of stating there is no plan for UDP.Verification
npm run docs:buildpasses locally.🤖 Generated with Claude Code