shadowsocks 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75e7362c5a7e492c1a72ce66fe087442c2196867
-  data.tar.gz: 0f9abb4370f9185c79ec822f62cce07b17bb43c8
+  metadata.gz: 8f8f39128d624bf5685bbaeb8c14064a65138c85
+  data.tar.gz: 4213b2dab798ad6f171b433e2aa65720cbec65cb
 SHA512:
-  metadata.gz: 0fb909540f9566f272e19db7eb289abd03106d94c6cf4862dd4af63aab55a047730c087024b74982959868acf4a41bc0cf98fbba89612e9f54624288da0c8dde
-  data.tar.gz: 5083e49dd9fed51a947b94ad0e4868f55237a6fb4d7d3a9aa2b3497e5ec69a4999fb4442fbb4ef67a0014cdcb5ac50c7e29a499f6f11f2f50bbe6795e85fcb97
+  metadata.gz: 0ca6c7ae4445e8ee40e7fbd911264feef6be241c43d5f349cd8c24b33abd1e92e5aa41ee5e2d134f6e2e56105182902b23746cbc865479864f3a827bc970eca4
+  data.tar.gz: 9a0d34d608289ea5587f4368d1e8dd3d991812eb763397ebfb12b7e4121c1fb56d9d9aa1e83d1b853f22d81f26591f29598c460684928ad26a4a59f81d95ca26

data/README.md

@@ -1,20 +1,66 @@
 shadowsocks-ruby
 ================
 
-a Ruby EventMachine port of shadowsocks-nodejs (not stable yet). use shadowsocks-nodejs instead
+Current version: 0.2
 
-install
+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).
 
-``` ruby
-gem install eventmachine
-gem install ffi
-rake
-```
+Usage
+-----------
 
-server side
+First, make sure you have Ruby 2.0.
 
-``` ruby
-nohup ruby server.rb > log &
-```
+    $ ruby -v
+    ruby 2.0.0p247
 
-then enjoy!
+Install Shadowsocks.
+
+    gem install shadowsocks
+
+Create a file named `config.json`, with the following content.
+
+    {
+        "server":"my_server_ip",
+        "server_port":8388,
+        "local_port":1080,
+        "password":"barfoo!",
+        "timeout":600
+    }
+
+Explanation of the fields:
+
+    server          your server IP (IPv4/IPv6), notice that your server will listen to this IP
+    server_port     server port
+    local_port      local port
+    password        a password used to encrypt transfer
+    timeout         in seconds
+    
+`cd` into the directory of `config.json`. Run `ss-server` on your server. To run it in the background, run
+`nohup ss-server -c ./config.json > log &`.
+
+On your client machine, `cd` into the directory of `config.json` also, run `ss-local -c config.json`.
+
+Change the proxy settings in your browser to
+
+    protocol: socks5
+    hostname: 127.0.0.1
+    port:     your local_port
+
+It's recommended to use shadowsocks with AutoProxy or Proxy SwitchySharp.
+
+Command line args
+------------------
+
+You can use args to override settings from `config.json`.
+
+    ss-local -s server_name -p server_port -l local_port -k password
+    ss-server -p server_port -k password
+    ss-server -c /etc/shadowsocks/config.json
+
+License
+-------
+MIT
+
+Bugs and Issues
+----------------
+Please visit [issue tracker](https://github.com/Sen/shadowsocks-ruby/issues?state=open)

data/config.json

@@ -2,6 +2,6 @@
     "server":"127.0.0.1",
     "server_port":8388,
     "local_port":1080,
-    "password":"foobar!",
+    "password":"barfoo!",
     "timeout":600
 }

data/lib/shadowsocks/config.rb

@@ -12,7 +12,7 @@ module Shadowsocks
     end
 
     def read_config
-      @config_path = File.expand_path('../..', File.dirname(__FILE__)) + '/config.json' unless @config_file
+      @config_path = File.expand_path('../..', File.dirname(__FILE__)) + '/config.json' unless @config_path
       cfg_file = File.open @config_path
       json = JSON.parse cfg_file.read
       cfg_file.close

data/lib/shadowsocks/version.rb

@@ -1,3 +1,3 @@
 module Shadowsocks
-  VERSION = '0.1'
+  VERSION = '0.2'
 end

data/shadowsocks.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
   s.version       = Shadowsocks::VERSION
   s.date          = '2013-09-26'
   s.summary       = "ruby version of shadowsocks"
-  s.description   = "Fuck GFW"
+  s.description   = "shadowsocks-ruby is a lightweight tunnel proxy which can help you get through firewalls."
   s.authors       = ["Sen"]
   s.email         = 'sen9ob@gmail.com'
   s.files         = `git ls-files`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shadowsocks
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Sen
@@ -94,7 +94,8 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Fuck GFW
+description: shadowsocks-ruby is a lightweight tunnel proxy which can help you get
+  through firewalls.
 email: sen9ob@gmail.com
 executables:
 - ss-local