Heroku support

.devcontainer.json

@@ -0,0 +1,12 @@
+{
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "mkhl.direnv"
+      ]
+    }
+  },
+  "image": "ghcr.io/cachix/devenv:latest",
+  "overrideCommand": false,
+  "updateContentCommand": "devenv ci"
+}

.envrc

@@ -0,0 +1,3 @@
+source_url "https://raw.githubusercontent.com/cachix/devenv/d1f7b48e35e6dee421cfd0f51481d17f77586997/direnvrc" "sha256-YBzqskFZxmNb3kYVoKD9ZixoPXJh1C9ZvTLGFRkauZ0="
+
+use devenv

.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: 'Test'
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  tests:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: cachix/install-nix-action@v26
+    - uses: cachix/cachix-action@v14
+      with:
+        name: devenv
+    - name: Install devenv.sh
+      run: nix profile install --accept-flake-config tarball+https://install.devenv.sh/latest
+
+    - name: Build the devenv shell and run any pre-commit hooks
+      run: devenv ci
+
+    - name: Run a single command in the devenv shell
+      run: devenv shell bun run test.js

.gitignore

@@ -0,0 +1,72 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next
+
+# Devenv
+.devenv*
+devenv.local.nix
+
+# direnv
+.direnv
+
+# pre-commit
+.pre-commit-config.yaml
+

.prettierignore

@@ -0,0 +1,3 @@
+*.yml
+*.yaml
+.devcontainer.json

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "bracketSpacing": false,
+  "singleQuote": true
+}

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2014-2018 Zhao Xiaohong
+Copyright (c) 2012-2014 clowwindy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+OR OTHER DEALINGS IN THE SOFTWARE.

Procfile

@@ -0,0 +1 @@
+web: npm start

README.md

@@ -1,53 +1,76 @@
-shadowsocks-dotcloud
-===========
+# shadowsocks-heroku
 
-[![Build Status](https://travis-ci.org/clowwindy/shadowsocks-dotcloud.png)](https://travis-ci.org/clowwindy/shadowsocks-dotcloud)
+shadowsocks-heroku is a lightweight tunnel proxy which can help you get through firewalls. It is a port of [shadowsocks](https://github.com/clowwindy/shadowsocks), but through a different protocol.
 
-shadowsocks-dotcloud is a lightweight tunnel proxy which can help you get through
- firewalls. It is a port of [shadowsocks](https://github.com/clowwindy/shadowsocks), but
- through a different protocol.
+shadowsocks-heroku uses WebSocket instead of raw sockets, so it can be deployed on [Heroku](https://www.heroku.com/).
 
-shadowsocks-dotcloud uses WebSockets instead of raw sockets,
- so it can be deployed on [dotcloud](https://www.dotcloud.com/).
+Notice that the protocol is INCOMPATIBLE with shadowsocks.
 
-Notice that the protocol is INCOMPATIBLE with the origin shadowsocks.
+## Heroku
 
-usage
------------
+### Usage
 
-Sign up for [dotcloud](https://www.dotcloud.com/).
+```
+$ heroku create
+Creating still-tor-8707... done, stack is cedar-14
+http://still-tor-8707.herokuapp.com/ | [email protected]:still-tor-8707.git
+```
 
-Install [dotcloud CLI](https://docs.dotcloud.com/0.9/firststeps/install/).
+Push the code to Heroku.
 
-Put the code somewhere, for example shadowsocks-dotcloud/. Edit `shadowsocks/config.json`, change the following values:
+```
+$ git push heroku master
+…
+-----> Compressing... done, 5.1MB
+-----> Launching... done, v3
+       http://still-tor-8707.herokuapp.com/ deployed to Heroku
 
-    server          your server hostname, for example, shadowsocks-YOURUSERNAME.dotcloud.com
-    local_port      local port
-    password        a password used to encrypt transfer
-    timeout         in seconds
-    method          encryption method, null by default, or use "rc4"
+To [email protected]:still-tor-8707.git
+ * [new branch]      master -> master
+```
 
-Upload the code. You can choose your own app name other than `shadowsocks`. You'll see your hostname at the end.
+Set a few configs:
 
-    $ dotcloud create shadowsocks
-    Created application "shadowsocks" using the flavor "sandbox"
-    ...
-    $ dotcloud push --application shadowsocks shadowsocks-dotcloud/
-    # upload shadowsocks-dotcloud/ ssh://[email protected]:443/shadowsocks
-    ...
-    Deployment finished. Your application is available at the following URLs
-    www: http://shadowsocks-YOURUSERNAME.dotcloud.com/
+```
+$ heroku config:set METHOD=aes-128-cfb KEY=foobar
+Setting config vars and restarting still-tor-8707... done, v11
+KEY:    foobar
+METHOD: aes-128-cfb
+```
 
-Open terminal, cd into shadowsocks, run `node local.js`.
+Install project dependencies with `npm install`:
 
-Change proxy settings of your browser into
+```
+$ npm install
+…
+```
 
-    SOCKS5 127.0.0.1:local_port
+Then run:
 
+```
+$ node local.js -s still-tor-8707.herokuapp.com -l 1080 -m aes-128-cfb -k foobar -r 80
+server listening at { address: '127.0.0.1', family: 'IPv4', port: 1080 }
+```
 
-troubleshooting
-----------------
+Change proxy settings of your browser into:
+
+```
+SOCKS5 127.0.0.1:1080
+```
+
+### Troubleshooting
 
 If there is something wrong, you can check the logs by:
 
-    $ dotcloud logs www --application shadowsocks
+```
+$ heroku logs -t --app still-tor-8707
+```
+
+## Supported Ciphers
+
+- aes-128-cfb
+- aes-192-cfb
+- aes-256-cfb
+- camellia-128-cfb
+- camellia-192-cfb
+- camellia-256-cfb

config.json

@@ -0,0 +1,10 @@
+{
+  "server": "127.0.0.1",
+  "local_address": "127.0.0.1",
+  "scheme": "ws",
+  "local_port": 1080,
+  "remote_port": 8080,
+  "password": "`try*(^^$some^$%^complex>:<>?~password/",
+  "timeout": 600,
+  "method": "aes-128-cfb"
+}