2016-06-10 20:02:49 +08:00
|
|
|
# ShadowsocksX-NG
|
|
|
|
|
|
2019-09-10 12:19:39 +08:00
|
|
|
Current version is [v1.9.2](https://github.com/shadowsocks/ShadowsocksX-NG/releases/tag/v1.9.2)
|
2016-06-14 10:53:08 +08:00
|
|
|
|
2019-09-10 12:19:39 +08:00
|
|
|
[](https://github.com/shadowsocks/ShadowsocksX-NG/actions)
|
2016-06-12 09:25:45 +08:00
|
|
|
|
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
|
|
|
|
2018-09-16 16:46:48 +08:00
|
|
|
## Why a new implementation?
|
2016-06-10 20:02:49 +08:00
|
|
|
|
2016-10-20 01:14:47 +08:00
|
|
|
It's hard to maintain the original implementation as there is too much unused code in it.
|
2019-09-09 12:42:28 +08:00
|
|
|
It also embeds the `ss-local` source code. It's crazy to maintain dependencies of `ss-local`.
|
2017-08-27 02:29:34 +08:00
|
|
|
So it's hard to update the `ss-local` version.
|
2016-06-10 20:02:49 +08:00
|
|
|
|
2017-08-27 02:29:34 +08:00
|
|
|
Now I just copied the `ss-local` from Homebrew. Run `ss-local` executable as a Launch Agent in the background.
|
2019-09-09 12:42:28 +08:00
|
|
|
So there is only some source code related to GUI left.
|
|
|
|
|
Then I have rewrited the GUI code in Swift.
|
2016-06-10 20:02:49 +08:00
|
|
|
|
2016-06-11 00:09:36 +08:00
|
|
|
## Requirements
|
|
|
|
|
|
|
|
|
|
### Running
|
|
|
|
|
|
2019-09-09 12:42:28 +08:00
|
|
|
macOS 10.12+
|
2016-06-11 00:09:36 +08:00
|
|
|
|
|
|
|
|
### Building
|
|
|
|
|
|
2019-09-09 12:42:28 +08:00
|
|
|
- Xcode 10.3+
|
2018-09-16 00:52:10 +08:00
|
|
|
- CocoaPods 1.5.3+
|
2016-06-11 00:09:36 +08:00
|
|
|
|
2016-10-15 00:33:53 +08:00
|
|
|
## Download
|
|
|
|
|
|
|
|
|
|
From [here](https://github.com/shadowsocks/ShadowsocksX-NG/releases/)
|
|
|
|
|
|
2017-02-07 15:39:43 +08:00
|
|
|
## Features
|
2016-06-14 10:53:08 +08:00
|
|
|
|
2019-09-09 12:48:44 +08:00
|
|
|
- `ss-local` from shadowsocks-libev 3.2.5.
|
2019-09-09 12:42:28 +08:00
|
|
|
- Support SIP003 plugins. Embed `kcptun`, `simple-obfs` and `v2ray-plugin`.
|
2017-08-27 02:29:34 +08:00
|
|
|
- Could update PAC by download GFW List from GitHub.
|
2018-09-16 16:46:48 +08:00
|
|
|
- Share your server profiles by qrcode or url.
|
|
|
|
|
- Import server profile urls from pasteboard.
|
|
|
|
|
- Import server profile by scan QRCode on screen.
|
|
|
|
|
- Custom rules for PAC.
|
2017-04-29 01:00:39 +08:00
|
|
|
- Support for [AEAD Ciphers](https://shadowsocks.org/en/spec/AEAD-Ciphers.html)
|
2017-01-13 01:06:06 +08:00
|
|
|
- HTTP Proxy by [privoxy](http://www.privoxy.org/)
|
2016-06-14 10:53:08 +08:00
|
|
|
|
2017-09-07 17:29:29 +10:00
|
|
|
## Difference from original ShadowsocksX
|
2016-06-14 10:53:08 +08:00
|
|
|
|
2017-09-07 17:29:29 +10:00
|
|
|
`ss-local` is run as a background service through launchd, not as an in-app process.
|
|
|
|
|
So after you quit the app, the `ss-local` might be still running.
|
2016-06-14 10:53:08 +08:00
|
|
|
|
2017-09-07 17:29:29 +10:00
|
|
|
Added a manual mode which won't configure the system proxy settings,
|
|
|
|
|
so that you could configure your apps to use the SOCKS5 proxy manually.
|
2016-06-14 10:53:08 +08:00
|
|
|
|
2017-08-27 02:29:34 +08:00
|
|
|
## Contributing
|
2017-01-16 16:54:57 +08:00
|
|
|
|
2017-08-27 02:29:34 +08:00
|
|
|
Contributions must be available on a separately named branch based on the latest version of the main branch `develop`.
|
2016-07-10 18:36:22 +08:00
|
|
|
|
|
|
|
|
ref: [GitFlow](http://nvie.com/posts/a-successful-git-branching-model/)
|
|
|
|
|
|
2016-06-12 08:30:09 +08:00
|
|
|
## License
|
2016-06-11 00:09:36 +08:00
|
|
|
|
2016-10-20 01:14:47 +08:00
|
|
|
The project is released under the terms of the GPLv3.
|
2016-06-11 00:09:36 +08:00
|
|
|
|
