https://github.com/imyelo/shadowkeeper
a better sslocal base on itself and wrapped by nodejs
https://github.com/imyelo/shadowkeeper
nodejs shadowkeeper shadowsocks
Last synced: about 2 months ago
JSON representation
a better sslocal base on itself and wrapped by nodejs
- Host: GitHub
- URL: https://github.com/imyelo/shadowkeeper
- Owner: imyelo
- Created: 2016-08-05T12:32:56.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-11-20T09:15:15.000Z (over 8 years ago)
- Last Synced: 2025-01-29T03:50:51.798Z (over 1 year ago)
- Topics: nodejs, shadowkeeper, shadowsocks
- Language: JavaScript
- Homepage:
- Size: 11.7 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ShadowKeeper
> a better **sslocal** base on itself and wrapped by nodejs
## Installation
1. [Install shadowsocks](https://github.com/shadowsocks/shadowsocks/blob/master/README.md#install)
```
apt-get install python-pip
pip install shadowsocks
```
2. Install shadowkeeper from npm
```
npm install shadowkeeper -g
```
## Usage
```bash
$ shadowkeeper ./gui-config.json
Options
--ping Ping servers
--help
```
### Launch
1. Create/Download your *gui-config.json* of [Shadowsocks for Windows](https://github.com/shadowsocks/shadowsocks-windows)
2. Launch ShadowKeeper with your *gui-config.json*
```
shadowkeeper ./gui-config.json
```
*The path can be omitted if it's same next time.*
3. Select your server config and local-port
4. Done
### Ping
1. Create/Download your *gui-config.json*
2. Ping servers with your *gui-config.json*
```
shadowkeeper ./gui-config.json --ping
```
*The path can be omitted if it's same next time.*
## License
The MIT License