Skip to content

Commit

Permalink
Update docs for #28
Browse files Browse the repository at this point in the history
  • Loading branch information
@madeye
madeye committed Feb 24, 2017
1 parent fe84657 commit 08efb61
Show file tree
Hide file tree
Showing 12 changed files with 34 additions and 19 deletions.
2 changes: 1 addition & 1 deletion en/about/contributors.html
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><title>Shadowsocks - Contributors</title><meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1"><meta name="description" content=""><meta name="author" content=""><link rel="stylesheet" href="/assets/css/app.css"><!--[if lt IE 9]><script src="/assets/js/html5.js"></script><![endif]--><link rel="shortcut icon" href="/assets/img/favicon/favicon.ico"><link rel="apple-touch-icon" href="/assets/img/favicon/apple-touch-icon.png"><link rel="apple-touch-icon" sizes="72x72" href="/assets/img/favicon/apple-touch-icon-72x72.png"><link rel="apple-touch-icon" sizes="114x114" href="/assets/img/favicon/apple-touch-icon-114x114.png"></head><body><div id="wrap" class="boxed"><header><div class="container clearfix"><div class="four columns"><div class="logo"><a href="/en/index.html">shadowsocks</a></div></div><div class="twelve columns"><nav id="menu" class="navigation"><ul id="nav"><li><a href="javascript:void" class="">download</a><ul><li><a href="/en/download/clients.html">Clients</a></li><li><a href="/en/download/servers.html">Servers</a></li></ul></li><li><a href="javascript:void" class="">config</a><ul><li><a href="/en/config/quick-guide.html">Quick Guide</a></li><li><a href="/en/config/advanced.html">Advanced</a></li></ul></li><li><a href="javascript:void" class="">spec</a><ul><li><a href="/en/spec/AEAD-Ciphers.html">AEAD Ciphers</a></li><li><a href="/en/spec/Protocol.html">Protocol</a></li><li><a href="/en/spec/Stream-Ciphers.html">Stream Ciphers</a></li></ul></li><li><a href="javascript:void" class="active">about</a><ul><li><a href="/en/about/contributors.html">Contributors</a></li></ul></li><li><a href="javascript:void">en</a><ul><li><a href="/en/index.html">en</a></li></ul></li></ul></nav></div><div class="sixteen columns"><hr></div></div></header><div class="container clearfix"><div class="sixteen columns"><h1 class="page-title">Contributors<a href="https://github.com/madeye/shadowsocks-org/edit/master/docs/about/01-contributors.md" data-tooltip="Edit this page on GitHub" class="edit"><i class="icon-edit"></i></a><span class="line"></span></h1></div><div class="page-columns"><div id="markdown" class="sixteen columns bottom"><h2>Core Contributors</h2><p><a href="https://github.com/clowwindy">@clowwindy</a></p><p>The creator of shadowsocks and the maintainer of shadowsocks-python/nodejs/gui/iOS.</p><p><a href="https://github.com/cyfdecyf">@cyfdecyf</a></p><p>The maintainer of shadowsocks-go and <a href="https://github.com/cyfdecyf/cow">cow</a>.</p><p><a href="https://github.com/madeye">@madeye</a></p><p>The maintainer of shadowsocks-libev/android and this project site.</p><p><a href="https://github.com/linusyang">@linusyang</a></p><p>The maintainer of shadowsocks-libev and <a href="https://github.com/linusyang/MobileShadowSocks">MobileShadowSocks</a>.</p><p><a href="https://github.com/aa65535">@aa65535</a></p><p>The maintainer of <a href="https://github.com/shadowsocks/openwrt-shadowsocks">openwrt-shadowsocks</a>.</p><p><a href="https://github.com/librehat">@librehat</a></p><p>The maintainer of shadowsocks-qt5 and libQtShadowsocks</p><h2>Other Contributors</h2><p><a href="https://github.com/ohdarling">@ohdarling</a></p><p>The maintainer of <a href="https://github.com/ohdarling/GoAgentX">GoAgentX</a>.</p><p><a href="https://github.com/fqrouter">@fqrouter</a></p><p>The maintainer of <a href="https://github.com/fqrouter/fqrouter">fqrouter</a>.</p></div></div></div><div class="push"></div></div><footer><div class="container"><div class="sisteen columns"><span class="copyright"><a href="https://github.com/shadowsocks">Projects of Shadowsocks</a>&nbsp;are distributed under different licenses, including &nbsp;<a href="https://github.com/shadowsocks/shadowsocks/blob/master/LICENSE">APL 2.0,</a>&nbsp;<a href="https://github.com/shadowsocks/shadowsocks-libev/blob/master/LICENSE">GPLv3</a>&nbsp; and &nbsp;<a href="https://github.com/shadowsocks/libQtShadowsocks/blob/master/LICENSE">LGPLv3</a>. Theme by <a href="http://karma-runner.github.io">Karma</a>.</span></div></div></footer></body><script src="/assets/js/app.js"></script><script src="/assets/js/analytics.js"></script></html>
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><title>Shadowsocks - Contributors</title><meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1"><meta name="description" content=""><meta name="author" content=""><link rel="stylesheet" href="/assets/css/app.css"><!--[if lt IE 9]><script src="/assets/js/html5.js"></script><![endif]--><link rel="shortcut icon" href="/assets/img/favicon/favicon.ico"><link rel="apple-touch-icon" href="/assets/img/favicon/apple-touch-icon.png"><link rel="apple-touch-icon" sizes="72x72" href="/assets/img/favicon/apple-touch-icon-72x72.png"><link rel="apple-touch-icon" sizes="114x114" href="/assets/img/favicon/apple-touch-icon-114x114.png"></head><body><div id="wrap" class="boxed"><header><div class="container clearfix"><div class="four columns"><div class="logo"><a href="/en/index.html">shadowsocks</a></div></div><div class="twelve columns"><nav id="menu" class="navigation"><ul id="nav"><li><a href="javascript:void" class="">download</a><ul><li><a href="/en/download/clients.html">Clients</a></li><li><a href="/en/download/servers.html">Servers</a></li></ul></li><li><a href="javascript:void" class="">config</a><ul><li><a href="/en/config/quick-guide.html">Quick Guide</a></li><li><a href="/en/config/advanced.html">Advanced</a></li></ul></li><li><a href="javascript:void" class="">spec</a><ul><li><a href="/en/spec/AEAD-Ciphers.html">AEAD Ciphers</a></li><li><a href="/en/spec/Plugin.html">Plugin</a></li><li><a href="/en/spec/Protocol.html">Protocol</a></li><li><a href="/en/spec/Stream-Ciphers.html">Stream Ciphers</a></li></ul></li><li><a href="javascript:void" class="active">about</a><ul><li><a href="/en/about/contributors.html">Contributors</a></li></ul></li><li><a href="javascript:void">en</a><ul><li><a href="/en/index.html">en</a></li></ul></li></ul></nav></div><div class="sixteen columns"><hr></div></div></header><div class="container clearfix"><div class="sixteen columns"><h1 class="page-title">Contributors<a href="https://github.com/madeye/shadowsocks-org/edit/master/docs/about/01-contributors.md" data-tooltip="Edit this page on GitHub" class="edit"><i class="icon-edit"></i></a><span class="line"></span></h1></div><div class="page-columns"><div id="markdown" class="sixteen columns bottom"><h2>Core Contributors</h2><p><a href="https://github.com/clowwindy">@clowwindy</a></p><p>The creator of shadowsocks and the maintainer of shadowsocks-python/nodejs/gui/iOS.</p><p><a href="https://github.com/cyfdecyf">@cyfdecyf</a></p><p>The maintainer of shadowsocks-go and <a href="https://github.com/cyfdecyf/cow">cow</a>.</p><p><a href="https://github.com/madeye">@madeye</a></p><p>The maintainer of shadowsocks-libev/android and this project site.</p><p><a href="https://github.com/linusyang">@linusyang</a></p><p>The maintainer of shadowsocks-libev and <a href="https://github.com/linusyang/MobileShadowSocks">MobileShadowSocks</a>.</p><p><a href="https://github.com/aa65535">@aa65535</a></p><p>The maintainer of <a href="https://github.com/shadowsocks/openwrt-shadowsocks">openwrt-shadowsocks</a>.</p><p><a href="https://github.com/librehat">@librehat</a></p><p>The maintainer of shadowsocks-qt5 and libQtShadowsocks</p><h2>Other Contributors</h2><p><a href="https://github.com/ohdarling">@ohdarling</a></p><p>The maintainer of <a href="https://github.com/ohdarling/GoAgentX">GoAgentX</a>.</p><p><a href="https://github.com/fqrouter">@fqrouter</a></p><p>The maintainer of <a href="https://github.com/fqrouter/fqrouter">fqrouter</a>.</p></div></div></div><div class="push"></div></div><footer><div class="container"><div class="sisteen columns"><span class="copyright"><a href="https://github.com/shadowsocks">Projects of Shadowsocks</a>&nbsp;are distributed under different licenses, including &nbsp;<a href="https://github.com/shadowsocks/shadowsocks/blob/master/LICENSE">APL 2.0,</a>&nbsp;<a href="https://github.com/shadowsocks/shadowsocks-libev/blob/master/LICENSE">GPLv3</a>&nbsp; and &nbsp;<a href="https://github.com/shadowsocks/libQtShadowsocks/blob/master/LICENSE">LGPLv3</a>. Theme by <a href="http://karma-runner.github.io">Karma</a>.</span></div></div></footer></body><script src="/assets/js/app.js"></script><script src="/assets/js/analytics.js"></script></html>
2 changes: 1 addition & 1 deletion en/config/advanced.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><title>Shadowsocks - Advanced</title><meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1"><meta name="description" content=""><meta name="author" content=""><link rel="stylesheet" href="/assets/css/app.css"><!--[if lt IE 9]><script src="/assets/js/html5.js"></script><![endif]--><link rel="shortcut icon" href="/assets/img/favicon/favicon.ico"><link rel="apple-touch-icon" href="/assets/img/favicon/apple-touch-icon.png"><link rel="apple-touch-icon" sizes="72x72" href="/assets/img/favicon/apple-touch-icon-72x72.png"><link rel="apple-touch-icon" sizes="114x114" href="/assets/img/favicon/apple-touch-icon-114x114.png"></head><body><div id="wrap" class="boxed"><header><div class="container clearfix"><div class="four columns"><div class="logo"><a href="/en/index.html">shadowsocks</a></div></div><div class="twelve columns"><nav id="menu" class="navigation"><ul id="nav"><li><a href="javascript:void" class="">download</a><ul><li><a href="/en/download/clients.html">Clients</a></li><li><a href="/en/download/servers.html">Servers</a></li></ul></li><li><a href="javascript:void" class="active">config</a><ul><li><a href="/en/config/quick-guide.html">Quick Guide</a></li><li><a href="/en/config/advanced.html">Advanced</a></li></ul></li><li><a href="javascript:void" class="">spec</a><ul><li><a href="/en/spec/AEAD-Ciphers.html">AEAD Ciphers</a></li><li><a href="/en/spec/Protocol.html">Protocol</a></li><li><a href="/en/spec/Stream-Ciphers.html">Stream Ciphers</a></li></ul></li><li><a href="javascript:void" class="">about</a><ul><li><a href="/en/about/contributors.html">Contributors</a></li></ul></li><li><a href="javascript:void">en</a><ul><li><a href="/en/index.html">en</a></li></ul></li></ul></nav></div><div class="sixteen columns"><hr></div></div></header><div class="container clearfix"><div class="sixteen columns"><h1 class="page-title">Advanced<a href="https://github.com/madeye/shadowsocks-org/edit/master/docs/config/02-advanced.md" data-tooltip="Edit this page on GitHub" class="edit"><i class="icon-edit"></i></a><span class="line"></span></h1></div><div class="page-columns"><div id="markdown" class="sixteen columns bottom"><h2>Optimize the shadowsocks server on Linux</h2><p>First of all, upgrade your Linux kernel to 3.5 or later.</p><h3>Step 1, increase the maximum number of open file descriptors</h3><p>To handle thousands of concurrent TCP connections, we should increase the limit of file descriptors opened.</p><p>Edit the <code>limits.conf</code></p><pre><code class="language-bash">vi /etc/security/limits.conf</code></pre><p>Add these two lines</p><pre><code><span class="hljs-bullet">* </span>soft nofile 51200
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><title>Shadowsocks - Advanced</title><meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1"><meta name="description" content=""><meta name="author" content=""><link rel="stylesheet" href="/assets/css/app.css"><!--[if lt IE 9]><script src="/assets/js/html5.js"></script><![endif]--><link rel="shortcut icon" href="/assets/img/favicon/favicon.ico"><link rel="apple-touch-icon" href="/assets/img/favicon/apple-touch-icon.png"><link rel="apple-touch-icon" sizes="72x72" href="/assets/img/favicon/apple-touch-icon-72x72.png"><link rel="apple-touch-icon" sizes="114x114" href="/assets/img/favicon/apple-touch-icon-114x114.png"></head><body><div id="wrap" class="boxed"><header><div class="container clearfix"><div class="four columns"><div class="logo"><a href="/en/index.html">shadowsocks</a></div></div><div class="twelve columns"><nav id="menu" class="navigation"><ul id="nav"><li><a href="javascript:void" class="">download</a><ul><li><a href="/en/download/clients.html">Clients</a></li><li><a href="/en/download/servers.html">Servers</a></li></ul></li><li><a href="javascript:void" class="active">config</a><ul><li><a href="/en/config/quick-guide.html">Quick Guide</a></li><li><a href="/en/config/advanced.html">Advanced</a></li></ul></li><li><a href="javascript:void" class="">spec</a><ul><li><a href="/en/spec/AEAD-Ciphers.html">AEAD Ciphers</a></li><li><a href="/en/spec/Plugin.html">Plugin</a></li><li><a href="/en/spec/Protocol.html">Protocol</a></li><li><a href="/en/spec/Stream-Ciphers.html">Stream Ciphers</a></li></ul></li><li><a href="javascript:void" class="">about</a><ul><li><a href="/en/about/contributors.html">Contributors</a></li></ul></li><li><a href="javascript:void">en</a><ul><li><a href="/en/index.html">en</a></li></ul></li></ul></nav></div><div class="sixteen columns"><hr></div></div></header><div class="container clearfix"><div class="sixteen columns"><h1 class="page-title">Advanced<a href="https://github.com/madeye/shadowsocks-org/edit/master/docs/config/02-advanced.md" data-tooltip="Edit this page on GitHub" class="edit"><i class="icon-edit"></i></a><span class="line"></span></h1></div><div class="page-columns"><div id="markdown" class="sixteen columns bottom"><h2>Optimize the shadowsocks server on Linux</h2><p>First of all, upgrade your Linux kernel to 3.5 or later.</p><h3>Step 1, increase the maximum number of open file descriptors</h3><p>To handle thousands of concurrent TCP connections, we should increase the limit of file descriptors opened.</p><p>Edit the <code>limits.conf</code></p><pre><code class="language-bash">vi /etc/security/limits.conf</code></pre><p>Add these two lines</p><pre><code><span class="hljs-bullet">* </span>soft nofile 51200
<span class="hljs-bullet">* </span>hard nofile 51200</code></pre><p>Then, before you start the shadowsocks server, set the ulimit first</p><pre><code class="language-bash"><span class="hljs-built_in">ulimit</span> -n 51200</code></pre><h3>Step 2, Tune the kernel parameters</h3><p>The priciples of tuning parameters for shadowsocks are</p><ol><li>Reuse ports and conections as soon as possible.</li><li>Enlarge the queues and buffers as large as possible.</li><li>Choose the TCP congestion algorithm for large latency and high throughput.</li></ol><p>Here is an example <code>/etc/sysctl.conf</code> of our production servers:</p><pre><code>fs<span class="hljs-selector-class">.file-max</span> = <span class="hljs-number">51200</span>

net<span class="hljs-selector-class">.core</span><span class="hljs-selector-class">.rmem_max</span> = <span class="hljs-number">67108864</span>
Expand Down
2 changes: 1 addition & 1 deletion en/config/quick-guide.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><title>Shadowsocks - Quick Guide</title><meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1"><meta name="description" content=""><meta name="author" content=""><link rel="stylesheet" href="/assets/css/app.css"><!--[if lt IE 9]><script src="/assets/js/html5.js"></script><![endif]--><link rel="shortcut icon" href="/assets/img/favicon/favicon.ico"><link rel="apple-touch-icon" href="/assets/img/favicon/apple-touch-icon.png"><link rel="apple-touch-icon" sizes="72x72" href="/assets/img/favicon/apple-touch-icon-72x72.png"><link rel="apple-touch-icon" sizes="114x114" href="/assets/img/favicon/apple-touch-icon-114x114.png"></head><body><div id="wrap" class="boxed"><header><div class="container clearfix"><div class="four columns"><div class="logo"><a href="/en/index.html">shadowsocks</a></div></div><div class="twelve columns"><nav id="menu" class="navigation"><ul id="nav"><li><a href="javascript:void" class="">download</a><ul><li><a href="/en/download/clients.html">Clients</a></li><li><a href="/en/download/servers.html">Servers</a></li></ul></li><li><a href="javascript:void" class="active">config</a><ul><li><a href="/en/config/quick-guide.html">Quick Guide</a></li><li><a href="/en/config/advanced.html">Advanced</a></li></ul></li><li><a href="javascript:void" class="">spec</a><ul><li><a href="/en/spec/AEAD-Ciphers.html">AEAD Ciphers</a></li><li><a href="/en/spec/Protocol.html">Protocol</a></li><li><a href="/en/spec/Stream-Ciphers.html">Stream Ciphers</a></li></ul></li><li><a href="javascript:void" class="">about</a><ul><li><a href="/en/about/contributors.html">Contributors</a></li></ul></li><li><a href="javascript:void">en</a><ul><li><a href="/en/index.html">en</a></li></ul></li></ul></nav></div><div class="sixteen columns"><hr></div></div></header><div class="container clearfix"><div class="sixteen columns"><h1 class="page-title">Quick Guide<a href="https://github.com/madeye/shadowsocks-org/edit/master/docs/config/01-quick-guide.md" data-tooltip="Edit this page on GitHub" class="edit"><i class="icon-edit"></i></a><span class="line"></span></h1></div><div class="page-columns"><div id="markdown" class="sixteen columns bottom"><h2>Config File</h2><p>Shadowsocks accepts <a href="http://www.json.org/">JSON</a> format configs like this:</p><pre><code class="language-json">{
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><title>Shadowsocks - Quick Guide</title><meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1"><meta name="description" content=""><meta name="author" content=""><link rel="stylesheet" href="/assets/css/app.css"><!--[if lt IE 9]><script src="/assets/js/html5.js"></script><![endif]--><link rel="shortcut icon" href="/assets/img/favicon/favicon.ico"><link rel="apple-touch-icon" href="/assets/img/favicon/apple-touch-icon.png"><link rel="apple-touch-icon" sizes="72x72" href="/assets/img/favicon/apple-touch-icon-72x72.png"><link rel="apple-touch-icon" sizes="114x114" href="/assets/img/favicon/apple-touch-icon-114x114.png"></head><body><div id="wrap" class="boxed"><header><div class="container clearfix"><div class="four columns"><div class="logo"><a href="/en/index.html">shadowsocks</a></div></div><div class="twelve columns"><nav id="menu" class="navigation"><ul id="nav"><li><a href="javascript:void" class="">download</a><ul><li><a href="/en/download/clients.html">Clients</a></li><li><a href="/en/download/servers.html">Servers</a></li></ul></li><li><a href="javascript:void" class="active">config</a><ul><li><a href="/en/config/quick-guide.html">Quick Guide</a></li><li><a href="/en/config/advanced.html">Advanced</a></li></ul></li><li><a href="javascript:void" class="">spec</a><ul><li><a href="/en/spec/AEAD-Ciphers.html">AEAD Ciphers</a></li><li><a href="/en/spec/Plugin.html">Plugin</a></li><li><a href="/en/spec/Protocol.html">Protocol</a></li><li><a href="/en/spec/Stream-Ciphers.html">Stream Ciphers</a></li></ul></li><li><a href="javascript:void" class="">about</a><ul><li><a href="/en/about/contributors.html">Contributors</a></li></ul></li><li><a href="javascript:void">en</a><ul><li><a href="/en/index.html">en</a></li></ul></li></ul></nav></div><div class="sixteen columns"><hr></div></div></header><div class="container clearfix"><div class="sixteen columns"><h1 class="page-title">Quick Guide<a href="https://github.com/madeye/shadowsocks-org/edit/master/docs/config/01-quick-guide.md" data-tooltip="Edit this page on GitHub" class="edit"><i class="icon-edit"></i></a><span class="line"></span></h1></div><div class="page-columns"><div id="markdown" class="sixteen columns bottom"><h2>Config File</h2><p>Shadowsocks accepts <a href="http://www.json.org/">JSON</a> format configs like this:</p><pre><code class="language-json">{
<span class="hljs-attr">"server"</span>:<span class="hljs-string">"my_server_ip"</span>,
<span class="hljs-attr">"server_port"</span>:<span class="hljs-number">8388</span>,
<span class="hljs-attr">"local_port"</span>:<span class="hljs-number">1080</span>,
Expand Down
Loading

0 comments on commit 08efb61

Please sign in to comment.