Skip to content

linksocks/linksocks.github.io

Repository files navigation

<!DOCTYPE html>
<html lang="en" dir="ltr">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <title>LinkSocks Documentation | LinkSocks</title>
    <meta name="description" content="SOCKS5 over WebSocket proxy tool">
    <meta name="generator" content="VitePress v1.6.4">
    <link rel="preload stylesheet" href="/assets/style.DF6-HpvV.css" as="style">
    <link rel="preload stylesheet" href="/vp-icons.css" as="style">
    
    <script type="module" src="/assets/app.Jr-4Po0P.js"></script>
    <link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
    <link rel="modulepreload" href="/assets/chunks/theme.BoFSCIOo.js">
    <link rel="modulepreload" href="/assets/chunks/framework.U1Gow_7P.js">
    <link rel="modulepreload" href="/assets/README.md.BitK6inf.lean.js">
    <link rel="icon" href="/favicon.ico">
    <script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
    <script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
  </head>
  <body>
    <div id="app"><div class="Layout" data-v-b91a21e9><!--[--><!--]--><!--[--><span tabindex="-1" data-v-d3906354></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-d3906354>Skip to content</a><!--]--><!----><header class="VPNav" data-v-b91a21e9 data-v-1cff14d0><div class="VPNavBar" data-v-1cff14d0 data-v-0ec8cc1b><div class="wrapper" data-v-0ec8cc1b><div class="container" data-v-0ec8cc1b><div class="title" data-v-0ec8cc1b><div class="VPNavBarTitle has-sidebar" data-v-0ec8cc1b data-v-20dad3b9><a class="title" href="/" data-v-20dad3b9><!--[--><!--]--><!--[--><img class="VPImage logo" src="/logo.png" alt data-v-22fb1f4e><!--]--><span data-v-20dad3b9>LinkSocks</span><!--[--><!--]--></a></div></div><div class="content" data-v-0ec8cc1b><div class="content-body" data-v-0ec8cc1b><!--[--><!--]--><div class="VPNavBarSearch search" data-v-0ec8cc1b><!----></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-0ec8cc1b data-v-1d4dc5e9><span id="main-nav-aria-label" class="visually-hidden" data-v-1d4dc5e9> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/guide/" tabindex="0" data-v-1d4dc5e9 data-v-abc3b867><!--[--><span data-v-abc3b867>Guide</span><!--]--></a><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://github.com/linksocks/linksocks" target="_blank" rel="noreferrer" tabindex="0" data-v-1d4dc5e9 data-v-abc3b867><!--[--><span data-v-abc3b867>GitHub</span><!--]--></a><!--]--><!--]--></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-0ec8cc1b data-v-2f2a3d73 data-v-633e8ed5><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="Change language" data-v-633e8ed5><span class="text" data-v-633e8ed5><span class="vpi-languages option-icon" data-v-633e8ed5></span><!----><span class="vpi-chevron-down text-icon" data-v-633e8ed5></span></span></button><div class="menu" data-v-633e8ed5><div class="VPMenu" data-v-633e8ed5 data-v-3606efb8><!----><!--[--><!--[--><div class="items" data-v-2f2a3d73><p class="title" data-v-2f2a3d73>English</p><!--[--><div class="VPMenuLink" data-v-2f2a3d73 data-v-ced03663><a class="VPLink link" href="/zh/README" data-v-ced03663><!--[--><span data-v-ced03663>简体中文</span><!--]--></a></div><!--]--></div><!--]--><!--]--></div></div></div><div class="VPNavBarAppearance appearance" data-v-0ec8cc1b data-v-ed6ebae1><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-ed6ebae1 data-v-831222da data-v-e1d2a8c0><span class="check" data-v-e1d2a8c0><span class="icon" data-v-e1d2a8c0><!--[--><span class="vpi-sun sun" data-v-831222da></span><span class="vpi-moon moon" data-v-831222da></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-0ec8cc1b data-v-d5dc2b01 data-v-eaa7e9e0><!--[--><a class="VPSocialLink no-icon" href="https://github.com/linksocks/linksocks" aria-label="github" target="_blank" rel="noopener" data-v-eaa7e9e0 data-v-e07d7ae4><span class="vpi-social-github"></span></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-0ec8cc1b data-v-e9ba7072 data-v-633e8ed5><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-633e8ed5><span class="vpi-more-horizontal icon" data-v-633e8ed5></span></button><div class="menu" data-v-633e8ed5><div class="VPMenu" data-v-633e8ed5 data-v-3606efb8><!----><!--[--><!--[--><div class="group translations" data-v-e9ba7072><p class="trans-title" data-v-e9ba7072>English</p><!--[--><div class="VPMenuLink" data-v-e9ba7072 data-v-ced03663><a class="VPLink link" href="/zh/README" data-v-ced03663><!--[--><span data-v-ced03663>简体中文</span><!--]--></a></div><!--]--></div><div class="group" data-v-e9ba7072><div class="item appearance" data-v-e9ba7072><p class="label" data-v-e9ba7072>Appearance</p><div class="appearance-action" data-v-e9ba7072><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-e9ba7072 data-v-831222da data-v-e1d2a8c0><span class="check" data-v-e1d2a8c0><span class="icon" data-v-e1d2a8c0><!--[--><span class="vpi-sun sun" data-v-831222da></span><span class="vpi-moon moon" data-v-831222da></span><!--]--></span></span></button></div></div></div><div class="group" data-v-e9ba7072><div class="item social-links" data-v-e9ba7072><div class="VPSocialLinks social-links-list" data-v-e9ba7072 data-v-eaa7e9e0><!--[--><a class="VPSocialLink no-icon" href="https://github.com/linksocks/linksocks" aria-label="github" target="_blank" rel="noopener" data-v-eaa7e9e0 data-v-e07d7ae4><span class="vpi-social-github"></span></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-0ec8cc1b data-v-260751ae><span class="container" data-v-260751ae><span class="top" data-v-260751ae></span><span class="middle" data-v-260751ae></span><span class="bottom" data-v-260751ae></span></span></button></div></div></div></div><div class="divider" data-v-0ec8cc1b><div class="divider-line" data-v-0ec8cc1b></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-b91a21e9 data-v-1990dd4a><div class="container" data-v-1990dd4a><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-1990dd4a><span class="vpi-align-left menu-icon" data-v-1990dd4a></span><span class="menu-text" data-v-1990dd4a>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-1990dd4a data-v-a6f90842><button data-v-a6f90842>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-b91a21e9 data-v-514c0316><div class="curtain" data-v-514c0316></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-514c0316><span class="visually-hidden" id="sidebar-aria-label" data-v-514c0316> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-c5c0ec3d><section class="VPSidebarItem level-0" data-v-c5c0ec3d data-v-ac3da736><div class="item" role="button" tabindex="0" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><h2 class="text" data-v-ac3da736>Getting Started</h2><!----></div><div class="items" data-v-ac3da736><!--[--><div class="VPSidebarItem level-1 is-link" data-v-ac3da736 data-v-ac3da736><div class="item" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><a class="VPLink link link" href="/guide/" data-v-ac3da736><!--[--><p class="text" data-v-ac3da736>Introduction</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-ac3da736 data-v-ac3da736><div class="item" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><a class="VPLink link link" href="/guide/principles" data-v-ac3da736><!--[--><p class="text" data-v-ac3da736>How It Works</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-ac3da736 data-v-ac3da736><div class="item" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><a class="VPLink link link" href="/guide/quick-start" data-v-ac3da736><!--[--><p class="text" data-v-ac3da736>Quick Start</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c5c0ec3d><section class="VPSidebarItem level-0" data-v-c5c0ec3d data-v-ac3da736><div class="item" role="button" tabindex="0" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><h2 class="text" data-v-ac3da736>Advanced Topics</h2><!----></div><div class="items" data-v-ac3da736><!--[--><div class="VPSidebarItem level-1 is-link" data-v-ac3da736 data-v-ac3da736><div class="item" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><a class="VPLink link link" href="/guide/cli-options" data-v-ac3da736><!--[--><p class="text" data-v-ac3da736>Command-line Options</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-ac3da736 data-v-ac3da736><div class="item" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><a class="VPLink link link" href="/guide/authentication" data-v-ac3da736><!--[--><p class="text" data-v-ac3da736>Authentication</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-ac3da736 data-v-ac3da736><div class="item" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><a class="VPLink link link" href="/guide/load-balancing" data-v-ac3da736><!--[--><p class="text" data-v-ac3da736>Load Balancing</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-ac3da736 data-v-ac3da736><div class="item" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><a class="VPLink link link" href="/guide/fast-open" data-v-ac3da736><!--[--><p class="text" data-v-ac3da736>Fast Open</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-ac3da736 data-v-ac3da736><div class="item" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><a class="VPLink link link" href="/guide/message-protocol" data-v-ac3da736><!--[--><p class="text" data-v-ac3da736>Message Protocol</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-ac3da736 data-v-ac3da736><div class="item" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><a class="VPLink link link" href="/guide/http-api" data-v-ac3da736><!--[--><p class="text" data-v-ac3da736>HTTP API</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c5c0ec3d><section class="VPSidebarItem level-0" data-v-c5c0ec3d data-v-ac3da736><div class="item" role="button" tabindex="0" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><h2 class="text" data-v-ac3da736>Python Library</h2><!----></div><div class="items" data-v-ac3da736><!--[--><div class="VPSidebarItem level-1 is-link" data-v-ac3da736 data-v-ac3da736><div class="item" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><a class="VPLink link link" href="/python/" data-v-ac3da736><!--[--><p class="text" data-v-ac3da736>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-ac3da736 data-v-ac3da736><div class="item" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><a class="VPLink link link" href="/python/server" data-v-ac3da736><!--[--><p class="text" data-v-ac3da736>Server Class</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-ac3da736 data-v-ac3da736><div class="item" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><a class="VPLink link link" href="/python/client" data-v-ac3da736><!--[--><p class="text" data-v-ac3da736>Client Class</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-ac3da736 data-v-ac3da736><div class="item" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><a class="VPLink link link" href="/python/utilities" data-v-ac3da736><!--[--><p class="text" data-v-ac3da736>Utilities</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c5c0ec3d><section class="VPSidebarItem level-0" data-v-c5c0ec3d data-v-ac3da736><div class="item" role="button" tabindex="0" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><h2 class="text" data-v-ac3da736>Go Library</h2><!----></div><div class="items" data-v-ac3da736><!--[--><div class="VPSidebarItem level-1 is-link" data-v-ac3da736 data-v-ac3da736><div class="item" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><a class="VPLink link link" href="/go/" data-v-ac3da736><!--[--><p class="text" data-v-ac3da736>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-ac3da736 data-v-ac3da736><div class="item" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><a class="VPLink link link" href="/go/library" data-v-ac3da736><!--[--><p class="text" data-v-ac3da736>Library Usage</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-ac3da736 data-v-ac3da736><div class="item" data-v-ac3da736><div class="indicator" data-v-ac3da736></div><a class="VPLink link link" href="/go/examples" data-v-ac3da736><!--[--><p class="text" data-v-ac3da736>Examples</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-b91a21e9 data-v-23efeb3f><div class="VPDoc has-sidebar has-aside" data-v-23efeb3f data-v-ffa27755><!--[--><!--]--><div class="container" data-v-ffa27755><div class="aside" data-v-ffa27755><div class="aside-curtain" data-v-ffa27755></div><div class="aside-container" data-v-ffa27755><div class="aside-content" data-v-ffa27755><div class="VPDocAside" data-v-ffa27755 data-v-9fabdbab><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-9fabdbab data-v-ff766cb7><div class="content" data-v-ff766cb7><div class="outline-marker" data-v-ff766cb7></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-ff766cb7>On this page</div><ul class="VPDocOutlineItem root" data-v-ff766cb7 data-v-f3e7a274><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-9fabdbab></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-ffa27755><div class="content-container" data-v-ffa27755><!--[--><!--]--><main class="main" data-v-ffa27755><div style="position:relative;" class="vp-doc _README" data-v-ffa27755><div><h1 id="linksocks-documentation" tabindex="-1">LinkSocks Documentation <a class="header-anchor" href="#linksocks-documentation" aria-label="Permalink to &quot;LinkSocks Documentation&quot;">​</a></h1><p>This directory contains the VitePress documentation for LinkSocks.</p><h2 id="development" tabindex="-1">Development <a class="header-anchor" href="#development" aria-label="Permalink to &quot;Development&quot;">​</a></h2><h3 id="prerequisites" tabindex="-1">Prerequisites <a class="header-anchor" href="#prerequisites" aria-label="Permalink to &quot;Prerequisites&quot;">​</a></h3><ul><li>Node.js 18 or later</li><li>npm or yarn</li></ul><h3 id="setup" tabindex="-1">Setup <a class="header-anchor" href="#setup" aria-label="Permalink to &quot;Setup&quot;">​</a></h3><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">cd</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> docs</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">npm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> install</span></span></code></pre></div><h3 id="development-server" tabindex="-1">Development Server <a class="header-anchor" href="#development-server" aria-label="Permalink to &quot;Development Server&quot;">​</a></h3><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">npm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> run</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> dev</span></span></code></pre></div><p>This will start the VitePress development server at <code>http://localhost:5173</code>.</p><h3 id="build" tabindex="-1">Build <a class="header-anchor" href="#build" aria-label="Permalink to &quot;Build&quot;">​</a></h3><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">npm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> run</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> build</span></span></code></pre></div><p>The built documentation will be in the <code>dist</code> directory.</p><h3 id="preview" tabindex="-1">Preview <a class="header-anchor" href="#preview" aria-label="Permalink to &quot;Preview&quot;">​</a></h3><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">npm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> run</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> preview</span></span></code></pre></div><p>Preview the built documentation locally.</p><h2 id="structure" tabindex="-1">Structure <a class="header-anchor" href="#structure" aria-label="Permalink to &quot;Structure&quot;">​</a></h2><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>docs/</span></span>
<span class="line"><span>├── .vitepress/</span></span>
<span class="line"><span>│   └── config.js          # VitePress configuration</span></span>
<span class="line"><span>├── guide/                 # User guide</span></span>
<span class="line"><span>├── api/                   # HTTP API documentation  </span></span>
<span class="line"><span>├── python/                # Python bindings documentation</span></span>
<span class="line"><span>├── go/                    # Go CLI and library documentation</span></span>
<span class="line"><span>├── index.md               # Homepage</span></span>
<span class="line"><span>└── package.json           # Dependencies</span></span></code></pre></div><h2 id="contributing" tabindex="-1">Contributing <a class="header-anchor" href="#contributing" aria-label="Permalink to &quot;Contributing&quot;">​</a></h2><p>When adding new documentation:</p><ol><li>Follow the existing structure and naming conventions</li><li>Update the sidebar navigation in <code>.vitepress/config.js</code></li><li>Use clear headings and code examples</li><li>Test locally before submitting PRs</li></ol><h2 id="deployment" tabindex="-1">Deployment <a class="header-anchor" href="#deployment" aria-label="Permalink to &quot;Deployment&quot;">​</a></h2><p>The documentation is automatically deployed to GitHub Pages when changes are pushed to the main branch.</p></div></div></main><footer class="VPDocFooter" data-v-ffa27755 data-v-8b244c14><!--[--><!--]--><div class="edit-info" data-v-8b244c14><div class="edit-link" data-v-8b244c14><a class="VPLink link vp-external-link-icon no-icon edit-link-button" href="https://github.com/linksocks/linksocks/edit/main/docs/README.md" target="_blank" rel="noreferrer" data-v-8b244c14><!--[--><span class="vpi-square-pen edit-link-icon" data-v-8b244c14></span> Edit this page on GitHub<!--]--></a></div><!----></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-8b244c14><span class="visually-hidden" id="doc-footer-aria-label" data-v-8b244c14>Pager</span><div class="pager" data-v-8b244c14><!----></div><div class="pager" data-v-8b244c14><a class="VPLink link pager-link next" href="/guide/" data-v-8b244c14><!--[--><span class="desc" data-v-8b244c14>Next page</span><span class="title" data-v-8b244c14>Introduction</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-b91a21e9 data-v-57b113e8><div class="container" data-v-57b113e8><p class="message" data-v-57b113e8>Released under the MIT License.</p><p class="copyright" data-v-57b113e8>Copyright © 2025 LinkSocks Contributors</p></div></footer><!--[--><!--]--></div></div>
    <script>window.__VP_HASH_MAP__=JSON.parse("{\"go_examples.md\":\"TtEJF6KU\",\"go_index.md\":\"D0lvg4TM\",\"go_library.md\":\"CxJFv8fF\",\"guide_authentication.md\":\"sfOpQh79\",\"guide_cli-options.md\":\"BE-WbW5B\",\"guide_fast-open.md\":\"CyRyd7ty\",\"guide_http-api.md\":\"BaZIRSQk\",\"guide_index.md\":\"DR0TnYV5\",\"guide_load-balancing.md\":\"uTnCSNqp\",\"guide_message-protocol.md\":\"DAaHkkwX\",\"guide_principles.md\":\"BPd8lUKg\",\"guide_quick-start.md\":\"CrnLTwh_\",\"index.md\":\"B8FNpHSd\",\"python_client.md\":\"DCNgeSBk\",\"python_index.md\":\"DnuNm0i8\",\"python_server.md\":\"Cf813BeS\",\"python_utilities.md\":\"BEPx7Oi5\",\"readme.md\":\"BitK6inf\",\"zh_go_examples.md\":\"BPff1orC\",\"zh_go_index.md\":\"G5GkO8LY\",\"zh_go_library.md\":\"D6IxnxJT\",\"zh_guide_authentication.md\":\"BM3ydP7c\",\"zh_guide_cli-options.md\":\"CVONc_BG\",\"zh_guide_fast-open.md\":\"fZOFVkR4\",\"zh_guide_http-api.md\":\"DXvMZS_W\",\"zh_guide_index.md\":\"MSdNvFNf\",\"zh_guide_load-balancing.md\":\"DIamyqQI\",\"zh_guide_message-protocol.md\":\"B-g2xna2\",\"zh_guide_principles.md\":\"C84b35_G\",\"zh_guide_quick-start.md\":\"k2BPAjnM\",\"zh_index.md\":\"D1XqO439\",\"zh_python_client.md\":\"Bn9zYcdS\",\"zh_python_index.md\":\"BM19temX\",\"zh_python_server.md\":\"CvqcuiJy\",\"zh_python_utilities.md\":\"eBiDd2qI\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"LinkSocks\",\"description\":\"SOCKS5 over WebSocket proxy tool\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{},\"locales\":{\"root\":{\"label\":\"English\",\"lang\":\"en\",\"title\":\"LinkSocks\",\"description\":\"SOCKS5 over WebSocket proxy tool\",\"themeConfig\":{\"logo\":\"/logo.png\",\"nav\":[{\"text\":\"Guide\",\"link\":\"/guide/\"},{\"text\":\"GitHub\",\"link\":\"https://github.com/linksocks/linksocks\"}],\"search\":{\"provider\":\"local\"},\"sidebar\":[{\"text\":\"Getting Started\",\"items\":[{\"text\":\"Introduction\",\"link\":\"/guide/\"},{\"text\":\"How It Works\",\"link\":\"/guide/principles\"},{\"text\":\"Quick Start\",\"link\":\"/guide/quick-start\"}]},{\"text\":\"Advanced Topics\",\"items\":[{\"text\":\"Command-line Options\",\"link\":\"/guide/cli-options\"},{\"text\":\"Authentication\",\"link\":\"/guide/authentication\"},{\"text\":\"Load Balancing\",\"link\":\"/guide/load-balancing\"},{\"text\":\"Fast Open\",\"link\":\"/guide/fast-open\"},{\"text\":\"Message Protocol\",\"link\":\"/guide/message-protocol\"},{\"text\":\"HTTP API\",\"link\":\"/guide/http-api\"}]},{\"text\":\"Python Library\",\"items\":[{\"text\":\"Overview\",\"link\":\"/python/\"},{\"text\":\"Server Class\",\"link\":\"/python/server\"},{\"text\":\"Client Class\",\"link\":\"/python/client\"},{\"text\":\"Utilities\",\"link\":\"/python/utilities\"}]},{\"text\":\"Go Library\",\"items\":[{\"text\":\"Overview\",\"link\":\"/go/\"},{\"text\":\"Library Usage\",\"link\":\"/go/library\"},{\"text\":\"Examples\",\"link\":\"/go/examples\"}]}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/linksocks/linksocks\"}],\"footer\":{\"message\":\"Released under the MIT License.\",\"copyright\":\"Copyright © 2025 LinkSocks Contributors\"},\"editLink\":{\"pattern\":\"https://github.com/linksocks/linksocks/edit/main/docs/:path\",\"text\":\"Edit this page on GitHub\"},\"lastUpdated\":{\"text\":\"Updated at\",\"formatOptions\":{\"dateStyle\":\"full\",\"timeStyle\":\"medium\"}}}},\"zh\":{\"label\":\"简体中文\",\"lang\":\"zh-CN\",\"title\":\"LinkSocks\",\"description\":\"基于 WebSocket 的 SOCKS5 代理工具\",\"themeConfig\":{\"logo\":\"/logo.png\",\"nav\":[{\"text\":\"指南\",\"link\":\"/zh/guide/\"},{\"text\":\"GitHub\",\"link\":\"https://github.com/linksocks/linksocks\"}],\"search\":{\"provider\":\"local\"},\"sidebar\":[{\"text\":\"快速开始\",\"items\":[{\"text\":\"介绍\",\"link\":\"/zh/guide/\"},{\"text\":\"工作原理\",\"link\":\"/zh/guide/principles\"},{\"text\":\"快速入门\",\"link\":\"/zh/guide/quick-start\"}]},{\"text\":\"进阶主题\",\"items\":[{\"text\":\"命令行选项\",\"link\":\"/zh/guide/cli-options\"},{\"text\":\"身份验证\",\"link\":\"/zh/guide/authentication\"},{\"text\":\"负载均衡\",\"link\":\"/zh/guide/load-balancing\"},{\"text\":\"快速打开\",\"link\":\"/zh/guide/fast-open\"},{\"text\":\"消息协议\",\"link\":\"/zh/guide/message-protocol\"},{\"text\":\"HTTP API\",\"link\":\"/zh/guide/http-api\"}]},{\"text\":\"Python 库\",\"items\":[{\"text\":\"概述\",\"link\":\"/zh/python/\"},{\"text\":\"Server 类\",\"link\":\"/zh/python/server\"},{\"text\":\"Client 类\",\"link\":\"/zh/python/client\"},{\"text\":\"工具函数\",\"link\":\"/zh/python/utilities\"}]},{\"text\":\"Go 库\",\"items\":[{\"text\":\"概述\",\"link\":\"/zh/go/\"},{\"text\":\"库的使用\",\"link\":\"/zh/go/library\"},{\"text\":\"示例\",\"link\":\"/zh/go/examples\"}]}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/linksocks/linksocks\"}],\"footer\":{\"message\":\"基于 MIT 许可证发布。\",\"copyright\":\"版权所有 © 2025 LinkSocks 贡献者\"},\"editLink\":{\"pattern\":\"https://github.com/linksocks/linksocks/edit/main/docs/:path\",\"text\":\"在 GitHub 上编辑此页\"},\"lastUpdated\":{\"text\":\"最后更新于\",\"formatOptions\":{\"dateStyle\":\"full\",\"timeStyle\":\"medium\"}}}}},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
    
  </body>
</html>

About

Linksocks docs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages