shadowsocks 0.1 → 0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 75e7362c5a7e492c1a72ce66fe087442c2196867
4
- data.tar.gz: 0f9abb4370f9185c79ec822f62cce07b17bb43c8
3
+ metadata.gz: 8f8f39128d624bf5685bbaeb8c14064a65138c85
4
+ data.tar.gz: 4213b2dab798ad6f171b433e2aa65720cbec65cb
5
5
  SHA512:
6
- metadata.gz: 0fb909540f9566f272e19db7eb289abd03106d94c6cf4862dd4af63aab55a047730c087024b74982959868acf4a41bc0cf98fbba89612e9f54624288da0c8dde
7
- data.tar.gz: 5083e49dd9fed51a947b94ad0e4868f55237a6fb4d7d3a9aa2b3497e5ec69a4999fb4442fbb4ef67a0014cdcb5ac50c7e29a499f6f11f2f50bbe6795e85fcb97
6
+ metadata.gz: 0ca6c7ae4445e8ee40e7fbd911264feef6be241c43d5f349cd8c24b33abd1e92e5aa41ee5e2d134f6e2e56105182902b23746cbc865479864f3a827bc970eca4
7
+ data.tar.gz: 9a0d34d608289ea5587f4368d1e8dd3d991812eb763397ebfb12b7e4121c1fb56d9d9aa1e83d1b853f22d81f26591f29598c460684928ad26a4a59f81d95ca26
data/README.md CHANGED
@@ -1,20 +1,66 @@
1
1
  shadowsocks-ruby
2
2
  ================
3
3
 
4
- a Ruby EventMachine port of shadowsocks-nodejs (not stable yet). use shadowsocks-nodejs instead
4
+ Current version: 0.2
5
5
 
6
- install
6
+ shadowsocks-ruby is a lightweight tunnel proxy which can help you get through firewalls. It is a port of [shadowsocks](https://github.com/clowwindy/shadowsocks).
7
7
 
8
- ``` ruby
9
- gem install eventmachine
10
- gem install ffi
11
- rake
12
- ```
8
+ Usage
9
+ -----------
13
10
 
14
- server side
11
+ First, make sure you have Ruby 2.0.
15
12
 
16
- ``` ruby
17
- nohup ruby server.rb > log &
18
- ```
13
+ $ ruby -v
14
+ ruby 2.0.0p247
19
15
 
20
- then enjoy!
16
+ Install Shadowsocks.
17
+
18
+ gem install shadowsocks
19
+
20
+ Create a file named `config.json`, with the following content.
21
+
22
+ {
23
+ "server":"my_server_ip",
24
+ "server_port":8388,
25
+ "local_port":1080,
26
+ "password":"barfoo!",
27
+ "timeout":600
28
+ }
29
+
30
+ Explanation of the fields:
31
+
32
+ server your server IP (IPv4/IPv6), notice that your server will listen to this IP
33
+ server_port server port
34
+ local_port local port
35
+ password a password used to encrypt transfer
36
+ timeout in seconds
37
+
38
+ `cd` into the directory of `config.json`. Run `ss-server` on your server. To run it in the background, run
39
+ `nohup ss-server -c ./config.json > log &`.
40
+
41
+ On your client machine, `cd` into the directory of `config.json` also, run `ss-local -c config.json`.
42
+
43
+ Change the proxy settings in your browser to
44
+
45
+ protocol: socks5
46
+ hostname: 127.0.0.1
47
+ port: your local_port
48
+
49
+ It's recommended to use shadowsocks with AutoProxy or Proxy SwitchySharp.
50
+
51
+ Command line args
52
+ ------------------
53
+
54
+ You can use args to override settings from `config.json`.
55
+
56
+ ss-local -s server_name -p server_port -l local_port -k password
57
+ ss-server -p server_port -k password
58
+ ss-server -c /etc/shadowsocks/config.json
59
+
60
+ License
61
+ -------
62
+ MIT
63
+
64
+ Bugs and Issues
65
+ ----------------
66
+ Please visit [issue tracker](https://github.com/Sen/shadowsocks-ruby/issues?state=open)
data/config.json CHANGED
@@ -2,6 +2,6 @@
2
2
  "server":"127.0.0.1",
3
3
  "server_port":8388,
4
4
  "local_port":1080,
5
- "password":"foobar!",
5
+ "password":"barfoo!",
6
6
  "timeout":600
7
7
  }
@@ -12,7 +12,7 @@ module Shadowsocks
12
12
  end
13
13
 
14
14
  def read_config
15
- @config_path = File.expand_path('../..', File.dirname(__FILE__)) + '/config.json' unless @config_file
15
+ @config_path = File.expand_path('../..', File.dirname(__FILE__)) + '/config.json' unless @config_path
16
16
  cfg_file = File.open @config_path
17
17
  json = JSON.parse cfg_file.read
18
18
  cfg_file.close
@@ -1,3 +1,3 @@
1
1
  module Shadowsocks
2
- VERSION = '0.1'
2
+ VERSION = '0.2'
3
3
  end
data/shadowsocks.gemspec CHANGED
@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
5
5
  s.version = Shadowsocks::VERSION
6
6
  s.date = '2013-09-26'
7
7
  s.summary = "ruby version of shadowsocks"
8
- s.description = "Fuck GFW"
8
+ s.description = "shadowsocks-ruby is a lightweight tunnel proxy which can help you get through firewalls."
9
9
  s.authors = ["Sen"]
10
10
  s.email = 'sen9ob@gmail.com'
11
11
  s.files = `git ls-files`.split("\n")
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: shadowsocks
3
3
  version: !ruby/object:Gem::Version
4
- version: '0.1'
4
+ version: '0.2'
5
5
  platform: ruby
6
6
  authors:
7
7
  - Sen
@@ -94,7 +94,8 @@ dependencies:
94
94
  - - '>='
95
95
  - !ruby/object:Gem::Version
96
96
  version: '0'
97
- description: Fuck GFW
97
+ description: shadowsocks-ruby is a lightweight tunnel proxy which can help you get
98
+ through firewalls.
98
99
  email: sen9ob@gmail.com
99
100
  executables:
100
101
  - ss-local