1
1
shadowsocks
2
2
===========
3
3
4
- Current version: 1.4.0 [ ![ Build Status] ( https://travis-ci.org/clowwindy/shadowsocks.png?branch=master )] ( https://travis-ci.org/clowwindy/shadowsocks )
4
+ Current version: 1.4.0 [ ![ Build Status] [ 1 ]] [ 0 ]
5
5
6
6
shadowsocks is a lightweight tunnel proxy which can help you get through firewalls.
7
7
8
8
Both TCP CONNECT and UDP ASSOCIATE are implemented.
9
9
10
- [ 中文说明] ( https://github.com/clowwindy/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E )
10
+ [ 中文说明] [ 3 ]
11
11
12
12
Usage
13
13
-----------
@@ -34,13 +34,15 @@ Create a file named `config.json`, with the following content.
34
34
35
35
Explanation of the fields:
36
36
37
- server your server IP (IPv4/IPv6), notice that your server will listen to this IP
38
- server_port server port
39
- local_port local port
40
- password a password used to encrypt transfer
41
- timeout in seconds
42
- method encryption method, "bf-cfb", "aes-256-cfb", "des-cfb", "rc4", etc. Default is table, which is not secure. "aes-256-cfb" is recommended
43
- fast_open use TCP_FASTOPEN, true/false
37
+ | Name | Explanation |
38
+ | ----------- | ----------------------------------------------- |
39
+ | server | the your server listens |
40
+ | server_port | server port |
41
+ | local_port | local port |
42
+ | password | password used for encryption |
43
+ | timeout | in seconds |
44
+ | method | encryption method, "aes-256-cfb" is recommended |
45
+ | fast_open | use [ TCP_FASTOPEN] [ 2 ] , true / false |
44
46
45
47
` cd ` into the directory of ` config.json ` . Run ` ssserver ` on your server. To run it in the background, run
46
48
` nohup ssserver > log & ` .
@@ -88,7 +90,7 @@ List of all encryption methods:
88
90
- seed-cfb
89
91
- table
90
92
91
- ** If you want to use encryption method other than "table", please install [ M2Crypto] ( http://chandlerproject.org/Projects/MeTooCrypto ) .**
93
+ ** If you want to use encryption method other than "table", please install [ M2Crypto] [ 4 ] .**
92
94
93
95
Ubuntu:
94
96
@@ -113,19 +115,22 @@ Or:
113
115
$ sudo apt-get install libevent-dev python-pip
114
116
$ sudo pip install gevent
115
117
116
- If both of your server and client are deployed on Linux 3.7+, you can turn on
117
- fast_open for lower latency.
118
-
119
- echo 3 > /proc/sys/net/ipv4/tcp_fastopen
120
-
121
118
License
122
119
-------
123
120
MIT
124
121
125
122
Bugs and Issues
126
123
----------------
127
- Please visit [ issue tracker] ( https://github.com/clowwindy/shadowsocks/issues?state=open )
124
+ Please visit [ issue tracker] [ 5 ]
128
125
129
126
Mailing list: http://groups.google.com/group/shadowsocks
130
127
131
- Also see [ troubleshooting] ( https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting )
128
+ Also see [ troubleshooting] [ 6 ]
129
+
130
+ [ 0 ] : https://travis-ci.org/clowwindy/shadowsocks
131
+ [ 1 ] : https://travis-ci.org/clowwindy/shadowsocks.png?branch=master
132
+ [ 2 ] : https://github.com/clowwindy/shadowsocks/wiki/TCP-Fast-Open
133
+ [ 3 ] : https://github.com/clowwindy/shadowsocks/wiki/Shadowsocks-%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E
134
+ [ 4 ] : http://chandlerproject.org/Projects/MeTooCrypto
135
+ [ 5 ] : https://github.com/clowwindy/shadowsocks/issues?state=open
136
+ [ 6 ] : https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting
0 commit comments