mirror of
https://github.com/shadowsocks/ShadowsocksX-NG.git
synced 2026-10-29 05:33:45 +00:00
docs: refresh README features
This commit is contained in:
Qiu Yuzhou
@@ -2,17 +2,17 @@
|
||||
|
||||
English | [简体中文](README.zh.md)
|
||||
|
||||
A native Shadowsocks client for Apple Silicon Macs. Manage servers, subscriptions, and routing from the menu bar, and provide SOCKS5 and HTTP proxy endpoints for Mac apps.
|
||||
A native Shadowsocks client for Apple Silicon Macs. Manage servers, subscriptions, and routing from the menu bar. Mac apps can connect through its SOCKS5 and HTTP proxies.
|
||||
|
||||
> **Download:** Download the latest ShadowsocksX-NG2 release from [GitHub Releases](https://github.com/shadowsocks/ShadowsocksX-NG/releases). The page also hosts legacy 1.x releases.
|
||||
> Download the latest ShadowsocksX-NG2 release from [GitHub Releases](https://github.com/shadowsocks/ShadowsocksX-NG/releases). The page also hosts legacy 1.x releases.
|
||||
|
||||
## Project status
|
||||
|
||||
ShadowsocksX-NG is undergoing a major rewrite. The legacy version is no longer maintained, and ShadowsocksX-NG 2 is still in development.
|
||||
|
||||
We will close all remaining legacy issues. We will also temporarily restrict new Issues and PRs from all users until the v2 code is stable and officially released.
|
||||
We will close all remaining legacy issues and temporarily restrict new Issues and PRs until the v2 code is stable and officially released.
|
||||
|
||||
In the meantime, please use [Discussions](https://github.com/shadowsocks/ShadowsocksX-NG/discussions) for usage questions and bug reports. Thanks for your understanding and support. Feedback and suggestions are welcome there too.
|
||||
Until then, please use [Discussions](https://github.com/shadowsocks/ShadowsocksX-NG/discussions) for questions, bug reports, feedback, and suggestions. Thanks for your understanding and support.
|
||||
|
||||
## System requirements
|
||||
|
||||
@@ -23,23 +23,14 @@ This project provides a client. It does not provide servers or subscription serv
|
||||
|
||||
## Features
|
||||
|
||||
- **Manage servers and subscriptions:** Add or import Shadowsocks configurations, organize servers into groups, and mark favorites. Add HTTPS SIP-008 subscriptions and view traffic and expiry information provided by the service provider.
|
||||
- **Choose how traffic is routed:** Use global, rules, or direct mode. In rules mode, review the bundled rules, write custom rules, and choose whether destinations use the proxy or connect directly.
|
||||
- **Connect Mac apps and LAN devices:** Provide local SOCKS5 and HTTP proxies. You can enable LAN listeners and set access credentials when needed; LAN listeners are off by default.
|
||||
- **Use proxy plugins:** [v2ray-plugin](https://github.com/shadowsocks/v2ray-plugin) and [Cloak](https://github.com/cbeuw/Cloak) are included. The bundled `v2ray-plugin` also provides a [Hysteria2 transport mode](https://github.com/shadowsocks/v2ray-plugin#shadowsocks-over-hysteria2-transport) for Shadowsocks TCP traffic. Both ends must use this mode; ordinary Hysteria2 proxy nodes are not compatible. You can also configure your own plugins.
|
||||
- **Protect local configuration and export diagnostics:** The server library and listener configuration are encrypted on your Mac using age. Diagnostic reports exclude sensitive data such as passwords, plugin options, and subscription URLs.
|
||||
- **Use a familiar interface:** A native macOS menu bar app with Simplified Chinese and English interfaces. You can also launch it at login.
|
||||
|
||||
## How NG2 differs from Legacy
|
||||
|
||||
| | ShadowsocksX-NG2 | Legacy 1.x |
|
||||
| --- | --- | --- |
|
||||
| System requirements | macOS 15 or later, Apple Silicon | The legacy project documentation lists macOS 10.12 or later |
|
||||
| Routing | Global, rules, and direct modes in the app; manage bundled and custom rules | PAC, GFWList, and manual modes |
|
||||
| Installation and configuration | Separate app and configuration directory; can coexist with Legacy | The legacy app and its configuration can remain installed separately |
|
||||
| Importing legacy settings | Can import legacy server configurations | Legacy preferences, routing mode, rules, and login item are not migrated automatically |
|
||||
|
||||
NG2 is a separate new app, not an in-place upgrade. Both apps can be installed side by side, and importing server configurations does not change Legacy data. macOS system proxy settings are shared by both apps, so check which app manages them when switching clients.
|
||||
- Add or import Shadowsocks configurations, organize servers into groups, and mark favorites. Add HTTPS SIP-008 subscriptions and view traffic and expiry information provided by the service provider.
|
||||
- Use global, rules, or direct mode. In rules mode, choose a rule preset: `proxy GFW List destinations`, `connect to mainland China destinations directly`, or `proxy mainland China destinations`. Review bundled rules and manage custom rules for each preset.
|
||||
- Use SIP022 AEAD-2022 ciphers, SIP023 Shadowsocks 2022 Extensible Identity Headers, and load balancing across multiple servers through upstream `sslocal`.
|
||||
- Test server latency.
|
||||
- Connect Mac apps and LAN devices through local SOCKS5 and HTTP proxies. You can enable LAN listeners and set access credentials when needed; LAN listeners are off by default.
|
||||
- [v2ray-plugin](https://github.com/shadowsocks/v2ray-plugin) and [Cloak](https://github.com/cbeuw/Cloak) are included. The bundled `v2ray-plugin` also provides a [Hysteria2 transport mode](https://github.com/shadowsocks/v2ray-plugin#shadowsocks-over-hysteria2-transport) for Shadowsocks TCP traffic. Both ends must use this mode; ordinary Hysteria2 proxy nodes are not compatible. You can also configure your own plugins.
|
||||
- The server library and listener configuration are encrypted on your Mac using age. Diagnostic reports exclude sensitive data such as passwords, plugin options, and subscription URLs.
|
||||
- Use the menu bar app in Simplified Chinese or English, and optionally launch it at login.
|
||||
|
||||
## Project and documentation
|
||||
|
||||
|
||||
+11
-20
@@ -4,15 +4,15 @@
|
||||
|
||||
面向 Apple Silicon Mac 的原生 Shadowsocks 客户端。通过菜单栏管理服务器、订阅和代理规则，并为 Mac 应用提供 SOCKS5 与 HTTP 代理入口。
|
||||
|
||||
> **下载**：请从 [GitHub Releases](https://github.com/shadowsocks/ShadowsocksX-NG/releases) 下载最新的 ShadowsocksX-NG2 版本。发布页也会保留旧版 1.x。
|
||||
> 请从 [GitHub Releases](https://github.com/shadowsocks/ShadowsocksX-NG/releases) 下载最新的 ShadowsocksX-NG2 版本。发布页也会保留旧版 1.x。
|
||||
|
||||
## 项目状态
|
||||
|
||||
ShadowsocksX-NG 正在进行大规模重构。旧版已停止维护，ShadowsocksX-NG 2 仍在开发中。
|
||||
|
||||
我们会关闭旧版遗留的所有 Issue。v2 代码稳定并正式发布前，我们暂不接受新的 Issue 和 PR。
|
||||
我们会关闭旧版遗留的所有 Issue。v2 代码稳定并正式发布前，暂不接受新的 Issue 和 PR。
|
||||
|
||||
这段时间里，如果你有使用问题或发现 Bug，欢迎到 [Discussions](https://github.com/shadowsocks/ShadowsocksX-NG/discussions) 交流。感谢大家的理解与支持，也欢迎在那里分享反馈和建议。
|
||||
在此期间，欢迎到 [Discussions](https://github.com/shadowsocks/ShadowsocksX-NG/discussions) 提问、报告 Bug 或分享反馈和建议。感谢大家的理解与支持。
|
||||
|
||||
## 系统要求
|
||||
|
||||
@@ -23,23 +23,14 @@ ShadowsocksX-NG 正在进行大规模重构。旧版已停止维护，Shadowsock
|
||||
|
||||
## 功能
|
||||
|
||||
- **管理服务器和订阅**：手动添加或导入 Shadowsocks 配置，按分组和收藏整理服务器；添加 HTTPS SIP-008 订阅，并查看服务商提供的流量与到期信息。
|
||||
- **选择代理方式**：使用全局模式、规则模式或直连模式。规则模式支持查看内置规则、编写自定义规则，并为目标选择代理或直连。
|
||||
- **连接 Mac 应用和局域网设备**：提供本机 SOCKS5 与 HTTP 代理。需要时可开启局域网监听，并设置访问凭据；局域网监听默认关闭。
|
||||
- **使用代理插件**：内置 [v2ray-plugin](https://github.com/shadowsocks/v2ray-plugin) 和 [Cloak](https://github.com/cbeuw/Cloak)，也支持配置用户自己的插件。内嵌的 `v2ray-plugin` 还提供 [Hysteria2 传输模式](https://github.com/shadowsocks/v2ray-plugin#shadowsocks-over-hysteria2-transport)，用于传输 Shadowsocks TCP 流量；通信两端都需使用该模式，普通 Hysteria2 代理节点不兼容。
|
||||
- **保护本地配置并导出诊断**：服务器库和监听配置以 age 格式加密保存在本机。诊断报告会排除密码、插件选项和订阅地址等敏感内容。
|
||||
- **使用熟悉的界面**：原生 macOS 菜单栏应用，界面提供简体中文和英语，也可设置登录时启动。
|
||||
|
||||
## 与旧版 ShadowsocksX-NG 的差异
|
||||
|
||||
| | ShadowsocksX-NG2 | 旧版 1.x |
|
||||
| --- | --- | --- |
|
||||
| 系统要求 | macOS 15 或更新版本，Apple Silicon | 旧版项目说明标注 macOS 10.12 或更新版本 |
|
||||
| 代理规则 | 在应用内使用全局、规则和直连模式；可管理内置规则与自定义规则 | 提供 PAC、GFWList 和手动模式 |
|
||||
| 安装与配置 | 独立应用和配置目录；不会覆盖旧版 | 旧版应用与其配置仍可单独保留 |
|
||||
| 导入旧配置 | 可主动导入旧版服务器配置 | 旧版偏好、代理模式、规则和登录项不会自动迁入 |
|
||||
|
||||
NG2 是独立的新应用，不是旧版的原位升级。两者可以分别安装；导入服务器配置不会更改旧版数据。macOS 的系统代理设置由两款应用共用，切换客户端时请确认由哪一款管理系统代理。
|
||||
- 手动添加或导入 Shadowsocks 配置，按分组和收藏整理服务器；添加 HTTPS SIP-008 订阅，并查看服务商提供的流量与到期信息。
|
||||
- 使用全局模式、规则模式或直连模式。规则模式提供三种规则方案：`仅代理 GFW 列表内目标`、`中国大陆目标直连`、`中国大陆目标代理`。可查看内置规则，并为每个方案管理自定义规则。
|
||||
- 通过上游 `sslocal` 支持 SIP022 AEAD-2022 加密方法、SIP023 Shadowsocks 2022 可扩展身份标头和多服务器负载均衡。
|
||||
- 支持服务器延迟检测。
|
||||
- 通过本机 SOCKS5 与 HTTP 代理连接 Mac 应用和局域网设备。需要时可开启局域网监听，并设置访问凭据；局域网监听默认关闭。
|
||||
- 内置 [v2ray-plugin](https://github.com/shadowsocks/v2ray-plugin) 和 [Cloak](https://github.com/cbeuw/Cloak)，也支持配置用户自己的插件。内嵌的 `v2ray-plugin` 还提供 [Hysteria2 传输模式](https://github.com/shadowsocks/v2ray-plugin#shadowsocks-over-hysteria2-transport)，用于传输 Shadowsocks TCP 流量；通信两端都需使用该模式，普通 Hysteria2 代理节点不兼容。
|
||||
- 服务器库和监听配置以 age 格式加密保存在本机。诊断报告会排除密码、插件选项和订阅地址等敏感内容。
|
||||
- 菜单栏界面提供简体中文和英语，可设置登录时启动。
|
||||
|
||||
## 项目与文档
|
||||
|
||||
|
||||
Reference in New Issue
Block a user