2016-06-10 20:02:49 +08:00
|
|
|
# ShadowsocksX-NG
|
|
|
|
|
|
2016-10-02 01:19:17 +08:00
|
|
|
Current version is 1.3
|
2016-06-14 10:53:08 +08:00
|
|
|
|
2016-06-12 09:25:45 +08:00
|
|
|
[](https://travis-ci.org/qiuyuzhou/ShadowsocksX-NG)
|
|
|
|
|
|
2016-06-12 08:30:09 +08:00
|
|
|
Next Generation of [ShadowsocksX](https://github.com/shadowsocks/shadowsocks-iOS)
|
2016-06-10 20:02:49 +08:00
|
|
|
|
2016-07-10 18:36:22 +08:00
|
|
|
## Why?
|
2016-06-10 20:02:49 +08:00
|
|
|
|
2016-08-13 11:21:02 +08:00
|
|
|
It's hard to maintain the original implement. There are too many unused code in it.
|
|
|
|
|
It also embed ss-local source. It's crazy to maintain depandences of ss-local.
|
2016-06-10 20:02:49 +08:00
|
|
|
So it's hard to update ss-local version.
|
|
|
|
|
|
|
|
|
|
Now I just copy the ss-local from home brew. Run ss-local executable as a Launch Agent in background.
|
2016-08-13 11:21:02 +08:00
|
|
|
Serve pac js file as a file url. So there are only some souce code related to GUI left.
|
|
|
|
|
Then I rewrite the GUI code by swift.
|
2016-06-10 20:02:49 +08:00
|
|
|
|
2016-06-11 00:09:36 +08:00
|
|
|
## Requirements
|
|
|
|
|
|
|
|
|
|
### Running
|
|
|
|
|
|
|
|
|
|
- Mac OS X 10.10 +
|
|
|
|
|
|
|
|
|
|
### Building
|
|
|
|
|
|
|
|
|
|
- XCode 7.3+
|
2016-06-12 08:30:09 +08:00
|
|
|
- cocoapod 1.0.1+
|
2016-06-11 00:09:36 +08:00
|
|
|
|
2016-06-14 10:53:08 +08:00
|
|
|
## Fetures
|
|
|
|
|
|
|
|
|
|
- Use ss-local from shadowsocks-libev 2.4.6
|
|
|
|
|
- Update PAC by download GFW List from github.
|
|
|
|
|
- Show QRCode for current server profile.
|
|
|
|
|
- Scan QRCode from screen.
|
|
|
|
|
- Auto launch at login.
|
|
|
|
|
- User rules for PAC.
|
|
|
|
|
- Support OTA
|
|
|
|
|
- An advance preferences panel to configure:
|
|
|
|
|
- Local socks5 listen address.
|
|
|
|
|
- Local socks5 listen port.
|
|
|
|
|
- Local socks5 timeout.
|
|
|
|
|
- If enable UDP relay.
|
|
|
|
|
- GFW List url.
|
2016-07-10 18:36:22 +08:00
|
|
|
- Manual spesify network service profiles which would be configure the proxy.
|
|
|
|
|
- Could reorder shadowsocks profiles by drag & drop in servers preferences panel.
|
2016-06-14 10:53:08 +08:00
|
|
|
|
2016-07-10 18:36:22 +08:00
|
|
|
## Different from orignal ShadowsocksX
|
2016-06-14 10:53:08 +08:00
|
|
|
|
|
|
|
|
Run ss-local as backgroud service through launchd, not in app process.
|
|
|
|
|
So after you quit the app, the ss-local maybe is still running.
|
|
|
|
|
|
|
|
|
|
Add a manual mode which won't configure the system proxy settings.
|
|
|
|
|
Then you could configure your apps to use socks5 proxy manual.
|
|
|
|
|
|
2016-07-10 18:36:22 +08:00
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
Contributions must be available on a separately named branch based on the latest version of the main branch develop.
|
|
|
|
|
|
|
|
|
|
ref: [GitFlow](http://nvie.com/posts/a-successful-git-branching-model/)
|
|
|
|
|
|
2016-06-10 20:02:49 +08:00
|
|
|
## TODO List
|
|
|
|
|
|
2016-07-10 18:36:22 +08:00
|
|
|
- [ ] Embed the http proxy server [privoxy](http://www.privoxy.org/).
|
2016-06-11 00:09:36 +08:00
|
|
|
|
2016-06-12 08:30:09 +08:00
|
|
|
## License
|
2016-06-11 00:09:36 +08:00
|
|
|
|
2016-06-12 08:34:36 +08:00
|
|
|
The project is released under the terms of GPLv3.
|
2016-06-11 00:09:36 +08:00
|
|
|
|
