Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Surge 官方手册的汉化
来自官方的汉化文档会直接搬过来并做说明，自己翻译的不做说明。
除了官方手册，之后还会放一些其他关于 Surge 的教程用来补充官方手册中没有提及或者说的不清楚的地方。可以联系我投放你写的教程，但请保证提供的页面中没有商业推广内容。因为本项目是个自发的非盈利开源项目，也不希望别人拿翻译后的内容进行商业行为。
转载和演绎都是可以的，前者请备注当前页面的地址，后者视改动幅度，可以不标注地址。
有三种根据域名判断的规则
DOMAIN
DOMAIN,www.apple.com,Proxy
规则会匹配与请求完全相同的地址
DOMAIN-SUFFIX
DOMAIN-SUFFIX,apple.com,Proxy
规则会匹配与请求与主域名相同的地址
DOMAIN-KEYWORD
DOMAIN-KEYWORD,google,Proxy
规则会匹配包含相应关键字的域名
DOMAIN-SET
为支持快速在千万级域名列表文件中搜索而设计。文件中的每一行都是一个域名，如果某一行以.开头，则匹配所有子域名和域名本身。这可用于广告过滤。
也支持在文件中使用 IPv4 和 IPv6 地址，但不支持 CIDR 的形式。
本项目开源在 ，如果对文章内容有疑问，请发 Issue（不解答技术问题）。如果内容有错误和不恰当，也可以 Fork 后修改。
比如，'' 匹配 '', '' 和 '' 本身，但不会匹配 ''
除了 "apple" 会匹配 ""，"app" 同样也会匹配到
Surge 是一个网络开发和代理工具。他是为开发者打造的工具，所以使用时需要具备一定的专业知识。
以下四种是 Surge 的核心工作流。
接管：接管设备发起的网络连接。Surge 支持代理服务器和虚拟网卡两种接管模式。
处理：可以修改已经接管的网络请求和响应。包括 URL 重定向、本地文件映射、使用 JavaScript 自定义修改等多种方法。
转发：可以将已接管的网络请求转发到其他代理服务器。这可以是全局转发，也可以通过灵活的规则系统来确定出站策略。
拦截：可以拦截并保存网络请求和响应的数据，也可以通过 MITM 解密 HTTPS 流量。
高性能、稳定、高效率：Surge 可以在耗费极少资源并且保持高稳定性的前提下轻松处理网络数据。
规则灵活：你可以编写基于域名、IP CIDR、GeoIP 等的规则。代理支持以下协议：HTTP、HTTPS、SOCKS5、SOCKS5-TLS、Shadowsocks。
HTTPS 解密: 通过中间人攻击解密 HTTPS 流量。可以帮助你生成可被系统信任的用于调试 CA 证书以达到解密功能。
本地 DNS 映射：Surge 支持本地自定义的 DNS 映射。所包含的多个功能，包括通配符、别名和自定义 DNS 服务器，可以满足各种需求。
策略组：你可以把多个代理放进一个策略组里，以便在编写规则时，能够一次性使用这一系列的代理。有多种策略组可选，包括 URL Test （会对策略组内每个代理进行连接测试，自动选择最快的）、SSID（根据当前的 SSID 选择连接的代理）以及手动选择代理的策略组。
HTTP 重写：可以使用自定义规则将 HTTP/HTTPS 请求重写为另一个 URL，或者阻止这些请求。
远程请求查看器：通过 USB 或者网络，可以远程查看另一个运行 Surge 设备上的请求查看器。
完整的 IPv6 支持：所有的功能都可以在 IPv6 的环境下正常工作。
增强模式：Surge 会设置一个虚拟网络去接管所有的网络请求，尤其是那些对 Web 代理支持不好的软件。
计费网络模式：当你使用移动热点等计费网络时，通过打开计费网络模式，可以控制应用或进程是否可以使用网络。
网关模式：Surge Mac 可以当做三层网关去处理同网络下其他设备的网络请求。（简单来说就可以当做一个路由器？）
所有的功能都可以在蜂窝数据网络下正常工作。
即便有些 App 可能不遵循系统代理设置，仍然可以捕获所有的 HTTP、HTTPS、TCP 流量，并根据高度可定制化的规则转发给 HTTP、HTTPS、SOCKS5、Shadowsocks 代理。
可以覆盖系统的 DNS 设置，并通过并发查询提高解析性能。
通过 Wi-Fi 或 USB 连接时，将 Surge Dashboard 连接到 Surge iOS，监测和分析iOS设备上的网络请求。也可以在通过 USB 连接时检查蜂窝网络请求。
我们已经发布了官方指南帮你理解 Surge。
Surge 可以根据自定义规则，决定将请求转发给代理服务器，还是直接发送给原始服务器。
规则按照配置文件里的顺序，按照从头到尾的顺序进行匹配。换句话说，第一条规则的优先级最高。
每一条规则由三部分组成：规则类型、匹配的流量（FINAL 规则没有这一项）以及所采取的策略。即：TYPR,VALUE,POLICY。比如：DOMAIN-SUFFIX,apple.com,DIRECT IP-CIDR,192.168.0.0/16,ProxyA。
Surge 支持 6 中不同种类的规则：DOMAIN、DOMAIN-SUFFIX、DOMAIN-KEYWORD、GEOIP、IP-CIDR 和 FINAL。对于所采取的策略，可以是一个代理服务器，也可以是一个策略组，或者是内置的DIRECT和REJECT。不管使用什么样的规则、写了多少条规则，都必须要以一个FINAL规则结束，作为对所写规则以外情况的判断。
例子：
英文版本：
简体中文版本：
DOMAIN、DOMAIN-SUFFIX 和 DOMAIN-KEYWORD 是。 而 IP-CIDR 和 GEOIP 则是。
有两个根据 IP 匹配的规则。如果请求的主机名是一个域名，那么根据 IP 的规则将触发 DNS 查询。如果 DNS 查询失败，Surge 会停止规则测试并报错。
规则会匹配规则范围内请求的 IP 地址
规则会匹配规则范围内请求的 IPv6 地址
规则会匹配相应国家和地区的 IP 地址
当 GEOIP 或者 IP-CIDR 规则被触发，Surge 会发送一个解析请求去检查主机名是否为一个域名。你可以加上 “no-resolve” 以跳过这个过程。
请注意: 如果本地 DNS 服务器无法解析某些域名，请确保在这个规则前没有基于 IP 的规则会匹配到这个域名。否则，由于 DNS 解析错误，规则测试将失败。你可以用“no-resolve”来解决这个问题。
规则会匹配相应端口的出站请求。
规则会匹配相应来源 IP 的入站请求。
规则会匹配相应端口的入站请求。 在 Surge 监听多个端口时会有用。
规则会匹配与协议参数相符合的请求。可选值：HTTP，HTTPS，TCP，UDP，DOH。
如果 SSID / BSSID / 路由器IP地址 匹配，则规则匹配。支持通配符模式。
使用一段 JavaScript 脚本判断是否匹配。
如果与当前网络使用的无线通信技术匹配，则规则匹配。可选值：GPRS, Edge, WCDMA, HSDPA, HSUPA, CDMA1x, CDMAEVDORev0, CDMAEVDORevA, CDMAEVDORevB, eHRPD, HRPD, LTE, NRNSA, NR
如果与当前网络所使用的运营商匹配，则规则匹配。可选值为 MCC-MNC 风格代码。
更多代码，请参考。
根据自定义规则，Surge 可以将一个请求转发给另一个代理服务器，或者直接发送到原始目标服务器上，即”直连“。Surge 会根据规则的”策略“部分决定如何处理请求。
有三种策略：代理、策略组、内置策略
一个代理类型的策略，会将当前规则匹配到的请求发送到指定的代理服务器。Surge 支持以下几种协议的代理：HTTP、HTTPS、SOCKS5、SOCKS5-TLS。
配置文件中，[Prosy] 这一部分定义代理类型的策略（即代理服务器列表）。你可以填写多个代理服务器，这样就可以让不同的规则使用不同的服务器代理策略。
例子：
Surge 支持标准的的几个代理协议。
HTTP Proxy：ProxyHTTP = http, 1.2.3.4, 443, username, password
HTTPS Proxy (HTTP Proxy via TLS)：ProxyHTTPS = https, 1.2.3.4, 443, username, password
SOCKS5：ProxySOCKS5 = socks5, 1.2.3.4, 443, username, password
SOCKS5 via TLS：ProxySOCKS5TLS = socks5-tls, 1.2.3.4, 443, username, password
Surge 也支持几个非标准的代理协议。
Snell：ProxySnell = snell, 1.2.3.4, 8000, psk=password
Shadowsocks：ProxySS = ss, 1.2.3.4, 8000, encrypt-method=chacha20-ietf-poly1305, password=abcd1234
VMess：ProxyVMess = vmess, 1.2.3.4, 8000, username=0233d11c-15a4-47d3-ade3-48ffca0ce119
Trojan：ProxyTrojan = trojan, 192.168.20.6, 443, password=password1
interface：可选（默认值： N/A）。
让该代理强制使用某个网络接口（只在 macOS 中有效）。请确保指定的网络接口到目的地址有正确的路由表。
allow-other-interface：可选（默认值：false）。
除此之外，你还可以在 interface 基础上增加 allow-other-interface 参数。这样当指定的网络接口不可用时，会使用默认的网络接口，不然则会导致错误。
tfo
mptcp
no-error-alert
skip-cert-verify：可选项，"true" 或 "false" （默认值为 "false"）。
如果该选项设置为 true，Surge 则不会验证服务器的证书是否有效。
sni （默认值：hostname）
你可以在 TLS 握手时自定义 Server Name Indication（SNI）。通过添加 sni=off 可以关闭 SNI。 默认情况下，Surge 像大多数浏览器一样，会发送域名作为 SNI。
always-use-connect
obfs
obfs-host
obfs-uri
psk
version
udp-relay
ws
ws-path
ws-headers
encrypt-method
Surge 支持基于 TLS 代理的客户端证书验证。
Surge 由几个组件构成
这是 Surge 最核心的部分，由于使用 Objective-C 编写，并对 macOS 和 iOS 分别进行了优化，所以可以高效且稳定地作为 HTTP/SOCKS5 代理服务器处理所有请求。
有些应用不遵从系统代理设置（比如邮件），因为他们需要使用原生 TCP socket。Surge VIF 可以处理这些流量。
在 iOS 种，这项功能是默认被开启的；而在 macOS 中，可以通过打开 增强模式 使用该功能。
以下是 Surge iOS 版的结构：
Surge Dashboard（在新版被译为“请求查看器”）是一个用于查看请求和 DNS 缓存的图形化界面。当开启远程访问时（设置 - 通用 - 远程 Dashboard），可以通过其他设备查看该设备的 Dashboard 信息。
其中 Snell 是由我们开发的一个轻量化的加密代理协议。你可以在这里查看服务端的代码 。
为了支持高级特性，Surge 使用自己的自定义 DNS 服务器。所以可能跟你在系统里设置的效果不太一样。
默认情况下，Surge 会使用系统设置里的 DNS 服务器。你可以通过 dns-server 这个选项来覆盖系统设置。
Surge 通过并发查询提高性能，会使用返回结果最快的服务器，这类似于 dnsmasq 命令的 --all-servers 选项。Surge iOS 版和 macOS 版的 Dashboard 会显示返回结果最快的那个服务器地址。如果 Surge 在 2 秒内没有收到任何响应，它将再次查询所有预设的 DNS 服务器。重试 4 次后如果还没有结果，Surge 将放弃查询并报告 DNS 错误。 某些域名可能具有性能较差的权限域名服务器，导致上游 DNS 服务器由于服务器端超时或其他连接问题返回空结果。如果所有上游 DNS 服务器确实都返回空的 DNS 查询结果，或者某些服务器返回空的结果，但其他服务器在 2 秒内没有响应，那 Surge 也将返回 DNS 查询结果为空的错误。 当 IPv6 可用并启用时，Surge DNS 客户端将向上游 DNS 服务器同时发送 A 和 AAAA 查询。将使用返回的第一个 A 或 AAAA 查询结果。
Surge 通过并发查询提高性能，会使用返回结果最快的服务器，这类似于 dnsmasq 命令的 --all-servers 选项。Surge iOS 版和 macOS 版的 Dashboard 会显示返回结果最快的那个服务器地址。如果 Surge 在 2 秒内没有收到任何响应，它将再次查询所有预设的 DNS 服务器。重试 4 次后如果还没有结果，Surge 将放弃查询并报告 DNS 错误。 某些域名可能具有性能较差的权限域名服务器，导致上游 DNS 服务器由于服务器端超时或其他连接问题返回空结果。如果所有上游 DNS 服务器确实都返回空的 DNS 查询结果，或者某些服务器返回空的结果，但其他服务器在 2 秒内没有响应，那 Surge 也将返回 DNS 查询结果为空的错误。 当 IPv6 可用并启用时，Surge DNS 客户端将向上游 DNS 服务器同时发送 A 和 AAAA 查询。将使用返回的第一个 A 或 AAAA 查询结果。
Surge 支持本地自定义 DNS 映射。这跟你编辑系统的 /etc/hosts 文件是一样的，但功能更强大。
你可以像下面这样使用像 * 这样的通配符匹配整个域名。但这个 * 能匹配一整个不被 . 分隔的字符串，所以使用时请注意。例如，*google.com 可以匹配 google.com、foo.google.com 和 bargoogle.com。而 *.google.com 则不能匹配 google.com。
这类似于 CNAME 类型的解析。
你可以给一个或多个域名指定想要的 DNS 服务器。
由于 Surge 有自己的 DNS 客户端实现方式，所以一些主机名可能无法解析。您可以使用 server:system 让系统解析。
默认情况下 .local 的域名都是由系统自己解析的。
上面说的几个使用方法可以组合使用。
你可以使用这些选项去覆盖系统的 DNS 设置。
可以用 system 来代表系统本身的 DNS 设置（其中，与后面重复的 DNS 服务器将被忽略）。
证书生成器会帮你生成一份受系统信任的用于开发的 CA 证书。这个在 macOS 和 iOS 版都能操作。生成的证书只会被保存在本地和系统的钥匙串。新生成的证书对应的 key 通过 OpenSSL 随机生成。
你也可以用既存的 CA 证书，需要以 PKCS#12（.p12）格式导出并随附密码，然后就像下面这样导入。需要注意的是，系统不接受 ca-passphrase 为空的证书，所以这一项必须要填。密码可以用 base64 命令加密成一个 base64 类型的字符串。
打开 MitM 解密后，Surge 默认不会解密所有流量，只会解密被声明的流量。
可以使用像 *、? 这样的通配符。
使用 - 排除域名。
默认情况下，只会解密 443 端口的请求。
添加 :port 来解密其他端口的 HTTPS 流量。
添加 suffix :0 来解密所有端口的 HTTPS 流量。
Example:
-*.apple.com: 排除所有通过 443 端口发送给 *.apple.com 的请求。
www.google.com: 解密通过 443 端口的 www.google.com 的 HTTPS 流量。
www.google.com:8080: 解密通过 8080 端口的 www.google.com 的 HTTPS 流量。
www.google.com:0: 解密所有端口的 www.google.com 的 HTTPS 流量。
*:0: 解密所有的 HTTPS 流量。
如果有多条，可以像下面这样写：
hostname = -*.apple.com, -*.icloud.com, *
某些程序有着严格的安全策略，不会认可自己生成的证书。此时，使用解密的话可能会导致一些问题。
默认情况下，MitM 只会解密通过 Surge HTTP 代理的流量。如果使用 tcp-connection 选项，Surge 则会通过使用 VIF（增强模式）对原始 TCP 流量进行解密。但这样你仍然需要在 hostname 列表中声明解密的域名。
MitM 时不验证证书。
Surge 通过中间人攻击（MitM）解密 HTTPS 流量。你可以参考维基百科的这篇文章获取关于 MitM 的更多信息：。
Surge 可以通过两种方式来重写请求的 URL，或者根据 URL 拒绝特定的请求。
例子：
一条重写规则由 3 部分组成：正则表达式、替换的内容和类型。
Surge 能重写请求头的域名，指向一个新的地址发送请求。发送请求的客户端不会发现这个操作。
例子：
不能使用 HTTPS Scheme 重定向。而且也不能重定向 HTTPS 请求。
Surge 会直接返回一个 302 重定向的响应。如果启用了 MitM，并将域名添加到了解密列表，那么这个方法可以使用 HTTPS。
拒绝符合正则表达式的请求。这种就不用写替换的内容了。如果启用了 MitM，并将域名添加到了解密列表，那么这个方法可以使用 HTTPS。
从 Surge macOS 3.0 版本、Surge iOS 3.4 版本之后，你可以通过 URL 或者文件导入一个规则集，这个规则集里可以包含很多条规则。 而 Surge 本身则提供两个内置的规则集，包含了已经写好的预置规则。
这个规则集包含了绝大多数来自 macOS 和 iOS 系统本身所发送的请求。但 App Store、iTunes 和其他虽然是苹果推出，但却是内容提供为主的 App 所发送的请求不包含在内。
这些规则在今后的版本中可能会发生变化，请留意软件中相关说明。
包括了 'local' 后缀和私有 IP 地址。注意：这个规则集会触发 DNS 查询。
可以通过 URL 或者本地文件的形式导入外置规则集。规则集的内容是一行一条规则，但不写对应的策略。
例子：
一个策略组可以包含多个策略，然后这个策略组本身可以被当成一个策略来使用，并且也可以被嵌套。
有以下几种类型的策略组：select、url-test 和 ssid。配置文件中，在 [Proxy Group] 下定义策略组。
可以在用户界面选择使用策略组里的某个策略。
在 iOS 版中，你可以在系统的 Today 页面中的小组件控制第一个 select 类型的策略组。而在 macOS 版中，可以通过点击状态栏中的 Surge 图标来手动切换 select 类型的策略组。
这个策略组会测试到包含的所有策略的延迟，自动选择最低的策略。
Surge 会发送一个 HTTP 头请求到目的地址。这个测试只关心是否收到了应答数据，即便返回的是一个 HTTP 错误 的数据。
超过这个时间，就不会再进行测试了，除非重新或者正在使用这个策略组。
每次重新测试时，只有当延迟最低的策略比上一次测试的延迟最低的策略快 100ms 时，才会使用新的策略。
当测速策略组中的某个策略超过该时间没有应答，则会放弃该策略。
与上面提到的自动测试的策略组原理相同，只不过 Fallback 按照从前到后的顺序选择可用策略，而不是选择延迟最低的策略。
Surge 会发送一个 HTTP 头请求到目的地址。这个测试只关心是否收到了应答数据，即便返回的是一个 HTTP 错误 的数据。
超过这个时间，就不会再进行测试了，除非重新或者正在使用这个策略组。
当测速策略组中的某个策略超过该时间没有应答，则会放弃该策略，使用后面一个策略。
根据当前的 Wi-Fi 名称选择相应的策略。
如果当前 Wi-Fi 名称不在该策略组里，则使用 default 指定的策略。
指定在蜂窝数据下使用的策略。如果不指定，则使用 default 所指定的策略。T
这个功能在 macOS 3.0 版以及 iOS 3.4 版和之后提供。策略组中包含的策略，可以通过链接或者文件的方式远程引用。
这个文件包含了一系列的策略，格式如下：
如果是远程引用，可以设定更新的时间间隔。
使用正则表达式在引用的节点中筛选出需要的。
用于修改 HTTP 返回体，该类型下第二参数为匹配 URL 的正则表达式，被匹配到的请求会被执行脚本。
传入参数为 $request 和 $response，字段为
$request.url<String>：请求的 URL
$request.method<String>：请求的 HTTP 方法
$response.status<Number>: 响应的 HTTP 状态码
$response.headers<Object>: 响应的 HTTP Headers
$response.body<String>: 响应的 HTTP Body，以 UTF-8 解码后的字符串，仅当 requires-body=true 时有效
应执行 $done 返回一个对象，可选包含三个字段：
body<String>：使用该 body 覆盖原来的响应 body，仅当 requires-body=true 时有效
headers<Object>：使用该 headers 词典完全覆盖原来的 headers，注意部分 HTTP 特殊字段不可被修改，如 Content-Length
status<Number>：覆盖原来的 HTTP 状态码
使用 $done(); 表示终止该请求；使用 $done({}); 表示不对该请求进行修改。
一个简单样例
注意样例使用了 JS ES6 语法。
脚本需要 Surge iOS 4 或 Surge Mac 3.3.0 以上版本
使用 JavaScript 随心所欲的拓展 Surge 功能。
每一行都有两个组成部分：脚本名称、参数。常见的参数：
type：脚本的类型，可选值：http-request, http-response, cron, event, dns, rule.
script-path：脚本的路径，可以是相对路径、绝对路径或者 URL。
script-update-interval：当脚本路径为 URL 时的自动更新频率，单位为秒。
debug：开启 debug 模式，如果是一个本地脚本，那么每次执行脚本时，都会从本地存储重新加载脚本，方便调试。
control-api：允许脚本内使用 $surge 变量，控制 Surge。
timeout：脚本的最长运行时间，默认为 10s。
http-request/http-response 类型脚本的可用参数：
pattern：匹配URL的正则。
requires-body：表示该脚本需要对 body 进行处理，默认为 false。如果只需要修改 URL 或者 Headers 请不要开启该选项，将大幅节约资源。
max-size：表示该脚本最大允许处理的 body 大小，若超过则放弃处理，默认值为 131072 （128KB）。
由于进行脚本修改会需要 Surge 先将 response body 完全下载后再进行处理，如果遇到了较大的数据将导致内存占用量暴增，Surge iOS 受系统内存限制在该情况下极易被直接终止。所以请务必仔细配置 URL 匹配规则，仅对需要的 URL 进行处理。
当返回的数据长度超过 max-size 设定值后，Surge 将放弃对该请求执行脚本并回退到 passthrough 模式。
所有脚本允许异步操作，使用 $done(value<Object>) 方法表示完成并返回相应结果。即使是不要求返回结果的脚本类型也应当在完成任务后调用 $done() 退出，否则脚本会因为超时而产生警告。
JS Script 的执行效率极高，不必担心因使用脚本而带来性能问题（Body 修改类除外，会影响整体逻辑），在我们的测试环境下，一个简单脚本的完整执行仅耗时 0.2ms。
console.log(message<String>) 输出到 Surge 日志
setTimeout(function[, delay]) 与浏览器的 setTimeout 方法一致
$httpClient.post(URL<String> or options<Object>, callback<Function>) 发起一个 HTTP POST 请求。第一个参数可以是一个 URL 或参数表，参数表为。
当使用参数表时，url 参数必选，其余选填，header 字段存在会覆盖默认的所有 Header。body 可以是 string 或 object。当为 object 时，将自动进行 JSON 编码，并设置 'Content-Type' 为 'application/json'。
callback 定义为callback(error<String>, response<Object>, data<String>)
error 为 Null 表示请求成功，response 包含 status 和 headers 两个字段。
其余类似的方法有：$httpClient.get，$httpClient.put，$httpClient.delete，$httpClient.head，$httpClient.options，$httpClient.patch。
$notification.post(title<String>, subtitle<String>, body<String>) 向通知中心发送通知，Surge iOS 上需开启通知总开关
$utils.geoip(ip<String>) 进行 GeoIP 查询，返回结果为 ISO 3166 的国家编码
$surge.setSelectGroupPolicy(groupName<String>, policyName<String>) 修改 select 策略组的当前选项，返回 bool 值表示是否成功
$surge.selectGroupDetails() 获得当前 select 策略组的信息，包含组名称，子策略，和当前选择的策略
$surge.setOutboundMode(mode<String>) 修改 Surge 的出站模式，返回 bool 值表示是否成功，取值可为 "direct", "global-proxy", "rule"
$surge.setHTTPCaptureEnabled(enabled<Boolean>) 控制 Surge 截获 HTTP 功能的开启
$surge.setCellularModeEnabled(enabled<Boolean>) 控制 Surge 计费网络模式的开启
$surge.setRewriteEnabled(enabled<Boolean>) 控制 Surge 重写功能的开启
$surge.setEnhancedModeEnabled(enabled<Boolean>) 控制 Surge 增强模式的开启 （仅 Surge Mac 可用）
$network 当前网络状态的总览，包含 IP 和 SSID 等信息
$script.name<String> 当前执行的脚本的文件名
$script.startTime<Date> 当前执行的脚本的开始时间
$persistentStore.write(data<String>, [key<String>]) 持久化保存数据，返回 bool 值表示是否成功，仅支持传入 string
$persistentStore.read([key<String>]) 读取保存的持久化数据，返回 string 或 Null 不传入 key 时，同一个 script-path 的脚本共享一个存储池。可传入一个固定的 key 以在多个脚本间共享数据。
用于修改 HTTP 请求体，该类型下第二参数为匹配 URL 的正则表达式，被匹配到的请求会被执行脚本。
传入参数为 $request，字段为：
$request.url<String>：请求的 URL
$request.body<String>：请求的 Body，以 UTF-8 解码后的字符串，仅当 requires-body = true 时有效
$request.method<String>：请求的 HTTP 方法
$request.headers<Object>：请求的 Headers
应执行 $done() 返回一个对象，可选包含字段：
url<String>：使用该 URL 覆盖原请求的 URL，注意使用脚本修改 URL 时不会像 URL Rewrite 那样自动调整 Header 的 Host 字段，如果需要调整需要手动返回新的 headers 字段
headers<Object>：使用该 headers 词典完全覆盖原来的 headers，注意部分 HTTP 特殊字段不可被修改，如 Content-Length
body<String>：使用该 body 覆盖原来的请求 body，仅当 requires-body = true 时有效。
response<Object>：如果返回了该字段，则表示 Surge 会直接返回 HTTP 响应，而不进行真实的网络操作。可包含三个字段：
status<Number>: 响应的 HTTP 状态码。（可选，默认为：200）
headers<Object>: 响应的 HTTP Headers。（可选）
body<String>: 响应的 HTTP Body，将以 UTF-8 编码后返回。（可选）
使用 $done(); 表示终止该请求，使用 $done({}); 表示不对该请求进行修改。
当前版本的一些限制：
当请求使用 chunked encoding 上传 body 时，不可以进行 body 修改。
当 Expect: 100-continue 存在时，不可以进行 body 修改。
一个简单样例
注意样例使用了 JS ES6 语法。
在发生特定事件时执行脚本，该类型下第二参数为事件名称，目前只有 network-changed 一个事件。
脚本任务执行完毕后请调用 $done() 退出
一个简单样例
使用脚本进行规则判定，该类型下第二参数为规则名。
然后在 [Rule] 中加入规则：
脚本返回一个词典，字段 matched<Boolean> 表示是否匹配该规则。
传入参数有：
$request.hostname<String>
$request.destPort<Number>
$request.processPath<String>
$request.userAgent<String>
$request.url<String>
$request.sourceIP<String>
$request.listenPort<Number>
$request.dnsResult<Object>
默认情况下，SCRIPT 规则不会触发 DNS 解析，如果需要进行 DNS 解析，可使用 requires-resolve 修饰规则
DNS 结果将出现在 $request.dnsResult 字段。
一个简单样例：
启用完整的IPv6支持
可选值为 verbose info notify 和 warning。不建议在日常使用中开启 verbose，因为这会消耗过多的资源使系统变慢。
在 iOS 平台，这个选项中的域名和IP段将由 Surge TUN 处理，而不是 Surge Proxy。
在 macOS 平台，这个选项仅在“设置为系统代理”开启时生效，用于解决某些应用的兼容问题。 指定某个域名。例如，apple.com
指定网站的所有域名，在域名前添加星号。例如，*apple.com
指定某个域的特定部分。例如，store.appple.com 通过 IP 地址指定某个主机或网络，输入 IP 地址或地址范围。例如，192.168.2.* 192.168.2.0/24
注意: 如果设置了IP地址或地址范围，仅在使用该地址连接主机时绕过代理，连接到解析后的地址时无法生效。
如果 Wi-Fi 不是主接口，则使用SSID组的默认策略。
助手代理接口设置。
当 Surge VIF 处理 DNS 问题时，这个选项要求 Surge 返回一个真实的 IP 地址，而不是一个假的 IP 地址（Fake-IP）。
DNS 请求包将被转发到上游的 DNS 服务器。
默认情况下，Surge 只对发送至 Surge DNS地址(198.18.0.2)的 DNS 查询返回 Fake-IP 地址。发送到标准 DNS 的查询将被转发。
有些设备或软件始终使用硬编码的 DNS 服务器。例如，谷歌的一款音箱总是使用 8.8.8.8）。你可以使用这个选项来劫持查询以获得一个 Fake-IP 地址。
你可以使用 hijack-dns = *:53 来劫持所有 DNS 请求。
让 Surge 将 TCP 连接视为 HTTP 请求。Surge 的 HTTP 引擎将处理这些请求，并且所有的高级功能都可以使用，如捕获、重写和脚本。
通配符支持 * 和 ?。
使用前缀 - 排除域名。
默认情况下，只有去往 80 端口的请求会被解码。
使用后缀 :port 启用指定端口
使用后缀 :0 启用所有端口。
例如：
-*.apple.com: 排除所有去往 *.apple.com 的 80 端口。
www.google.com: 强制 HTTP 引擎处理通往 www.google.com 的 80 端口的请求。
www.google.com:8080: 强制 HTTP 引擎处理通往 www.google.com 的 8080 端口的请求。
www.google.com:0: 强制 HTTP 引擎处理通往 www.google.com 所有端口的请求。
*:0: 强制 HTTP 引擎处理通往所有主机的所有端口请求。
Surge VIF 只能处理 TCP 和 UDP 协议。使用此选项可以绕过特定的 IP 范围，允许所有流量通过。
注意：此选项只适用于 Surge VIF。由 Surge 代理服务器处理的请求不受影响。结合
skip-proxy和tun-excluded-routes来确保特定的 HTTP 流量绕过 Surge。 这个选项可能会导致系统错误 ENOMEM（无法分配内存）。这似乎是 iOS 系统的一个 Bug。如果可能的话，请不要使用这个选项。
在默认情况下，Surge VIF 声明自己为默认路由。但是，由于 Wi-Fi 接口的路由较小，有些流量可能不会通过 Surge VIF 接口。使用此选项可以添加一个较小的路由。
在指定时间执行 cron 脚本。cronexp 应该是一个 cron 表达式，它是一个由五个或六个子表达式（字段）组成的字符串，描述了计划的各个细节。
译者按：Surge 兼容五位和六位的表示方法。
一些 cron 表达式的样例如下：
at 2am daily: 0 2 * * *
at 5 AM and 5 PM daily: 0 5,17 * * *
on every minutes: * * * * *
on every Sunday at 5 PM: 0 17 * * sun
every 10 minutes: */10 * * * *
只有一个传入参数： $cronexp。
脚本任务执行完毕后请调用 $done() 退出。
一个简单样例：
仅 Surge Mac 2.1.0 以上版本支持此功能
有些应用可能不会遵循系统代理设置，使用增强模式可以处理让 Surge 处理所有应用。
Surge 会安装一个虚拟网卡并设置为默认路由。所有的 DNS 响应会返回 198.18.0.0/15 地址段的一个虚拟 IP 地址。
Surge 虚拟网卡只能处理 TCP，UDP 和 ICMP 流量，仅在必要时开启此功能。
ICMP 流量不能被代理，Surge 虚拟网卡将直接返回响应结果。
仅 Surge iOS 支持此功能
您可以通过一下配置，指定 Surge iOS 在 Wi-Fi SSID 下暂时挂起。
使用脚本去执行 DNS 解析操作，该类型下第二参数为脚本名。
之后需要在 [Host] 中对相应域名进行配置。
传入参数为 $domain，当前查询的域名。
返回结果可为下列中的任意一个：
当返回 address<String> 时，直接使用该 IP 地址为结果，必须是一个有效的 IPv4 或者 IPv6 地址的字符串表示。
当返回 addresses<Array> 时，使用多个IP地址作为结果。
当返回 server<String> 时，表示应交给特定的 DNS 服务器进行查询。
当返回 servesr<Array> 时，表示指定多个上游 DNS 服务器进行查询。
当返回 address<String> 或者 addresses<Array> 时，可以额外返回 TTL 字段，将本次的结果记入 DNS 缓存避免重复查询，单位为秒。
以下样例使用了 DNSPod 的公开 HTTP DNS API，通过脚本扩展的方式让 Surge 可以随意支持各种协议的 DNS 查询
从 3.1.0 开始，你可以将 Surge macOS 版本身作为一个 Snell 代理服务器。在配置文件中加入如下字段：
Snell 是由我们团队开发的一个新的加密代理协议。你可以在这里找到服务端的代码：
Surge iOS 支持 4 种操作和 1 种参数。
操作：
surge:///start
启动当前选中的配置文件。
surge:///stop
停止当前会话。
surge:///toggle
启动或停止当前选中的配置文件。
surge:///install-config?url=x
从某个 URL 安装配置文件。该 URL 需先通过百分号编码处理。
参数：
autoclose=true
操作完成时自动关闭 Surge。（不能与 install-config 一同使用）
样例：surge:///toggle?autoclose=true
Surge 从 3.4 版本开始支持 x-callback-url 规范。URL 的 scheme 为 surge，可用的操作有 start、stop 和 toggle。
如果配置了 DNS-over-HTTPS，传统的 DNS 仅用于测试连接性和解析 DOH 地址里面的域名。
你可以指定多个 DNS-over-HTTPS 服务器（不推荐）。
像下面这样设置即可：
你可以指定多个 DoH 服务器（并不建议），甚至和普通 DNS 服务器地址放在一起。但由于 DoH 返回结果一般比普通 DNS 慢，所以反而会在并发查询中被丢弃。
对于 DoH 格式，有两种形式：JSON 和 DNS wireformat (RFC1035)。
你需要确定你的 DoH 服务支持哪一种形式。
Surge iOS 4.1 和以下的版本 / Surge Mac 3.4.1 和以下的版本： 只支持 JSON 形式的文件。
Surge iOS 4.2 和以上的版本 / Surge Mac 3.5.0 和以上的版本： Surge 默认使用 DNS wireformat，你也可以继续使用 JSON 文件。
如果你想通过代理使用 DoH，你可以打开 doh-follow-outbound-mode。
所有的 DoH 会走出站模式的设置，然后再编辑规则，让 DoH 的域名走代理。
或者，使用 PROTOCOL,DOH 规则去匹配所有的 DoH 连接。
由于内容过多，而且很多就是老信息，所以随缘更新，可能只会翻译后来更新的内容
Module（模块）是一系列设置的集合，可用于覆盖当前配置的部分设定，有非常多的使用场景：
微调不可编辑的配置的设定，如托管配置和企业配置。
快捷的在不同工作环境中切换，比如临时开启对所有域名的 MitM 并调整过滤器。
使用他人编写的模块以完成某些特定任务，比如，你的同事可以编写一个模块将应用的 API 请求重定向至测试服务器。
如果你在多个设备间使用了同一份配置，有可能需要根据设备的使用场景进行微调。模块的开启状态是保存于当前设备的，可以用于在不同设备间的差异性修改。
模块相当于给当前配置打补丁，其优先级要高于配置本身的设置。
有三种模块：
内置模块：Surge 会预置一些模块，随着 Surge 自身更新。
本地模块：放置在配置文件目录中的 .sgmodule 文件。
安装的模块：从某个 URL 安装的模块。
你可以同时开启多个模块，模块的开启状态保存于当前设备，不会进行同步。切换配置也不影响模块的开启状态。
模块的内容和标准配置基本一致，目前支持调整以下段：
General, Replica, MITM
直接覆盖原始值：key = value
在原始值的末尾进行追加：key = %APPEND% value
在原始值的开始进行插入：key = %INSERT% value
你只能在 MITM 段中操作 hostname 字段。
Rule, Script, URL Rewrite, Header Rewrite, Host
新加入的定义将会追加在原始内容的顶部。
模块中的规则只可以使用 DIRECT、REJECT、REJECT-TINYGIF 三个内置策略。
元数据
你可以在模块文件里添加元数据：
（可选）你还可以限制模块的使用平台（可取值为 ios 和 mac）：
💡本页文档来自，并对照手册对部分内容进行了修正
仅Surge iOS 4.4.0 和 Surge Mac 4.0.0 以上版本支持通过 HTTP API 控制 Surge。
API key 必须填写在所有请求的 'X-Key' 的 Header 中。
当前版本仅支持未经 TLS 加密的 HTTP 请求。Surge 仅适用 GET 和 POST 方法。
对于 GET 请求，应适用 URL 发送参数。
对于 POST 请求，应使用 JSON Body 发送参数。
Surge 总会返回 JSON Body 格式的响应。
GET /v1/features/mitm
POST /v1/features/mitm
GET /v1/features/capture
POST /v1/features/capture
GET /v1/features/rewrite
POST /v1/features/rewrite
GET /v1/features/scripting
POST /v1/features/scripting
GET /v1/features/system_proxy （仅 Surge Mac 可用）
POST /v1/features/system_proxy （仅 Surge Mac 可用）
GET /v1/features/enhanced_mode （仅 Surge Mac 可用）
POST /v1/features/enhanced_mode （仅 Surge Mac 可用）
使用 GET 方法获取开关的状态。
GET 方法响应示例:
适用 POST 请求调整开关状态。
POST 方法请求示例:
GET /v1/outbound
POST /v1/outbound
适用 GET 请求 请求获取状态，适用 POST 请求修改。
GET 方法响应示例:
适用 POST 请求调整开关状态。
POST 方法请求示例:
模式的值可能为：direct, proxy, rule
GET /v1/outbound/global
POST /v1/outbound/global
获取或更改全局出站模式的默认策略。
GET 方法响应示例:
适用 POST 请求调整开关状态。
POST 方法请求示例:
GET /v1/policies
获取所有策略组。
GET /v1/policies/detail?policy_name=ProxyNameHere
获取代理的详细信息。
POST /v1/policies/test
对策略组进行测速。
请求示例：
GET /v1/policy_groups
列出所有的策略组和他们的选项。
GET /v1/policy_groups/test_results
获取 url-test/fallback/load-balance 组的测速结果。
GET /v1/policy_groups/select?group_name=GroupNameHere
获取 select 组的选项。
请求示例：
POST /v1/policy_groups/select
改变 select 策略组的选项。
请求示例：
POST /v1/policy_groups/test
立即测试一个策略组。
请求示例：
响应示例：
GET /v1/requests/recent
获取最近请求。
GET /v1/requests/active
获取所有活动中的请求。
POST /v1/requests/kill
杀死一个请求。
请求示例：
GET /v1/profiles/current?sensitive=0
获取当前配置文件的内容。 如果"sensitive"为假，则所有密码字段都将被屏蔽。
POST /v1/profiles/reload
立即重新载入配置文件。
POST /v1/profiles/switch （仅 Surge Mac 可用）
请求示例：
切换到另一个配置。
GET /v1/profiles （仅 Surge Mac 4.0.6 及以上版本可用）
获取可用的配置文件名。
POST /v1/profiles/check （仅 Surge Mac 4.0.6 及以上版本可用）
请求示例：
检查配置。如果配置文件无效返回错误，否则 "error" 字段为空。
POST /v1/dns/flush
刷新 DNS 缓存。
GET /v1/dns
获取当前 DNS 缓存内容。
POST /v1/test/dns_delay
测试 DNS 延时。
GET /v1/modules
获取可用和激活的模块。
响应示例：
POST /v1/modules
启动或关闭模块
请求示例：
GET /v1/scripting
获取脚本列表。
POST /v1/scripting/evaluate
适用 Mock 环境执行脚本。
请求示例：
POST /v1/scripting/cron/evaluate
立即执行一个定时脚本。
请求示例：
GET /v1/devices
获取当前激活和保存的设备列表。
GET /v1/devices/icon?id={iconID}
获取设备的图标。你可以从 "device.dhcpDevice.icon" 中获取图标 ID。
POST /v1/devices
改变设备的属性。physicalAddress 字段是必须的，可以从name、address、shouldHandledBySurge 中调整一个或多个属性。
请求示例：
POST /v1/stop
停止 Surge。若在 Surge iOS 上开启了 Always On 则会重启。
GET /v1/events
获取事件中心的内容。
GET /v1/rules
获取规则列表。
GET /v1/traffic
获取流量信息。
POST /v1/log/level
修改当前会话的日志等级。
请求示例：
你现在可以通过 UI 界面配置脚本了。
添加了关于配置文件的 HTTP API，包括 GET /profiles 和 POST /profiles/check。
添加了关于设备管理的 HTTP API，包括 GET /devices、POST /devices 和 GET /devices/icon。
HTTP API、代理服务、外部控制器（external controller）现在都支持监听 IPv6 地址了（UI 界面尚无，需要手动在配置文件里配置）。
你可以用 http-api-tls=true 来为 HTTP API 启用 TLS（HTTPS-API）。
外部资源在 Surge 启动时就会更新，并且当应用一个配置文件时会自动下载其中引用的外部资源。
新的规则类型：SUBNET，可以用通配符匹配 SSID、BSSID 和 路由IP地址。
当处理大量请求的时候，Dashboard 性能有显著提升。
In this release, we completely refactored the policy group functionality, bringing the following changes:
The url-test/fallback/load-balance policy group can no longer be configured with a specific testing URL but with a global testing URL or a policy-configured testing URL. The policy's test results can be used directly in all policy group decisions, eliminating the need to retest each policy group individually.
All types of policy groups support mixed nesting. The only requirement is that no circular references can be used.
When a group policy is used as a sub-policy of the url-test/fallback/load-balance group.
The latency of the select/url-test/fallback/ssid group is the latency of the selected policy.
The latency of the load-balance group is the average of the latencies of all available policies.
The timeout parameter of a policy group marks policies with latency exceeding this parameter as unavailable when making decisions for the group. But the maximum time taken to test the policy group is controlled by the global test-timeout parameter. (Default is 5s)
When testing a group due to decision making, all sub-policies that the group may use are tested, including sub-policies of the sub-policy group.
You may use no-alert=true parameter to suppress notifications for particular groups.
You can receive the notifications on iOS devices. Enable this option first and then configure it on Surge iOS. The two device must use a same iCloud account.
Bug fixes.
Bug fixes.
You may override the testing URL of a policy for network diagnostics and activity cards.
The GeoIP database can be updated automatically in the background.
Bug fixes.
You may now customize the GeoIP database updating URL.
tun-excluded-routes and tun-included-routes are now available for Surge Mac.
Bug fixes.
You may configure the proxy chain with the UI now.
Fixed some visual inconsistency under reducing transparency mode.
Bug fixes.
The first version of 4.0.0.
Bug fixes
Bug fixes
You may switch among the main views with shortcut keys.
Bug fixes.
New parameter: policy-regex-filter. If the parameter is configured, only matched policy line will be used.
Provides more details for the TLS handshake error.
Increases the file description limitation alert threshold.
[General]
use-local-host-item-for-proxy = true
If use-local-host-item-for-proxy is true, Surge sends the proxy request with the IP address defined in the [Host] section, instead of the original domain.
load-balance group now supports connectivity testing before being used. Add 'url' parameter to enable it.
Parameters 'timeout', 'interval' and 'evaluate-before-use' are also available.
Surge will send an ICMP port unreachable message if UDP forwarding fails.
Eliminate unnecessary local DNS lookup while forwarding UDP traffic to a proxy server.
Fixed a bug that connecting to Surge iOS via USB is not working in Surge Dashboard.
Surge Mac supports SSID suspend now. The system proxy and enhanced mode will be temporarily suspended under specified SSIDs.
The name of WiFi can be an SSID, a BSSID, or a gateway IP address.
No UI configuration in the current version.
REJECT-DROP policy is now effective to proxy connections. The connections matched with a REJECT-DROP policy will be closed in 60-120s later without any data returned.
You may now select and view sub-policy for policy groups while using the global proxy mode.
DOMAIN-SET is just like RULE-SET. But it is designed a large number of rules and highly efficient.
Unlike RULE-SET, you can only write hostnames (domain or IP address) in it. One hostname per line.
You may use "." prefix to include all sub-domains.
SRC-IP rule now supports IP-CIDR for both IPv4 and IPv6.
From this version, if DNS-over-HTTPS is configured, the traditional DNS will only be used to test the connectivity and resolve the domain in the DOH URL.
The DNS over HTTPS now has a separate parameter: doh-server. The DOH servers in 'dns-server' will be moved to the new parameter after saving.
The legacy DNS is always required now.
DOH can be matched with rule 'PROTOCOL,DOH' now.
Added a new parameter 'doh-follow-outbound-mode'. In the previous version, the DOH client follows the system proxy settings. From this version, all DOH requests will use DIRECT policy by default. If 'doh-follow-outbound-mode' is set, the DOH requests will follow the outbound mode settings regardless of the system proxy settings.
We are refactoring the HTTP client for DOH and scripting. Please feedback if you encounter any issue.
Added a simple view to test the script. You may find it in the Window menu.
Fixed a crash in Dashboard while using search.
Bug fixes.
You may not configure DOH with UI in this version temporarily.
You may enable modules in the menu now.
You may view the detail of a module by double clicking.
Supports pattern filter for Dashboard requests.
Added a new rule type: PROTOCOL. The possible values are HTTP, HTTPS, SOCKS, SNELL, TCP, UDP.
You may now use UI to add and edit load-balance group.
DNS over HTTP (DoH) now uses DNS wireformat by default. You may configure doh-format=json in [General] to continue using JSON format.
TCP connection setup optimizations.
Bug fixes.
Supports a new proxy protocol: Trojan.
Remote Dashboard now upgraded to Remote Controller. You may use Surge iOS to select policy group, toggle HTTP capture/MitM, and switch outbound mode remotely.
The comment lines in the text config won't lost after editing with UI.
You may open the new connection window of Dashboard by holding the Option key while clicking the Dashboard item in the main menu.
Fixed a bug that Surge may not be able to process DNS answer packets which is longer than 512 bytes.
Fixed a bug which causes TFO failed.
You may use a profile which stores in a subdirectory of the profile directory.
Added Traditional Chinese localizations.
Fixed a bug that the menu might be unresponsive.
Fixed crashs on macOS 10.11.
Supports MITM on non-standard port for TCP mode.
Proxy editing view now supports VMess protocol and all misc options.
A new option 'persistent' has been added to the load-balance group. (aka PCC, per connection classifier) When 'persistent=true' is set, a same hostname will always get the same policy.
Bug fixes.
Supports VMess proxy protocol.
vmess-proxy= vmess, example.com, 443, username = 12345678-abcd-1234-1234-47ffca0ce229, ws=true, tls=true, ws-path=/v2, ws-headers=X-Header-1:value|X-Header-2:value
All proxy options for TLS proxy are available.
Web-socket and TLS options would degrade performance. Only enable when necessary.
Surge only supports chacha20-poly1305 encryption algorithm. Please make sure the server supports it. We have no plan to implement other ciphers.
Added support for TLS 1.3. Append 'tls13=true' to the proxy line to enable it. (Requires macOS 10.14 or above)
Supports to use 'X-Surge-Policy' to force policy for HTTP/HTTPS requests.
SSID group now supports to use the IP address of default router as an identifier.
New policy group type: load-balance, which will use a random sub-policy for every request.
IN-PORT and DEST-PORT rule now supports port range expression: DEST-PORT,8000-8999,DIRECT
Provides compatibility for Surge iOS 4.
Surge Mac software package is now notarized by Apple.
A new standalone view to manage all external resources.
Fixed a bug that Handoff doesn't work between Surge iOS and Dashboard.
Fixed a bug that 'Update All Remote Resources' may not work.
Scripting
You can now use a script to modify the response headers and status code.
Dashboard
USB module has been refactored to improve stability. Also, you may choose the device from multiple USB devices now.
MitM
HTTP and MitM engine has been refactored. Please report if you encounter any issues.
You can now use URL-REGEX rule for MitM connections.
You may use prefix '-' to exclude domains for MitM. Example:
MitM hostname list now supports port number. By default only the connections to port 443 will be decrypted. Use suffix :port to enable MitM for other ports. Use suffix :0 to enable MitM for all ports on the hostname.
URL rewrite type 'header' is now available for MitM connections. You may also use it to rewrite a plain HTTP request to an HTTPS request.
Misc
You can now enable/disable a rule.
Added a small indicator in the menu icon for Metered Network Mode.</lo>
Added main switches for rewrite and scripting.
Supports TCP SACKs for Surge VIF.
New general option: force-http-engine-hosts. You can force Surge to treat a raw TCP connection as an HTTP connection, to enable high-level functions such as URL-REGEX rules, rewrite and scripting. This option uses the same format as [MITM] hostname option.
New option for url-test/fallback group: evaluate-before-use. By default, the requests before a connection evaluation will use the first policy in the list and trigger the evaluate. Enable the option to delay the requests until the evaluation completed.
Bug fixes.
Added more feature to the main menu.
Dashboard now supports to export all requests to an archive file for opening later or sharing.
A new option to automatically reload if the profile was modified externally/remotely.
Fixed a compatibility issue with some FTP clients.
Added a new option to disable automatically notification dismissing.
The update notification is now shown as a banner instead of an alert window.
Bug fixes.
Optimizations for no network error handling.
Reduces CPU usage on idle.
Fixed a bug while enabling MitM with a new certificate.
Fixed crashes on macOS 10.11.
CPU usage optimizations (50% reduced for high throughout).
Enabled Hardened Runtime to get enhanced security protections in macOS Mojave.
Add more notes for rule evaluating stage.
WeChat.app may flood ping when network is unstable, which causes a high CPU usage of Surge. We added a mechanism to limit ICMP throughput in this version.
Bug fixes
Supports new iCloud container for Surge iOS migration.
The MitM feature is now compatible with Android system. Please regenerate an new CA certificate before using with Android.
Fixed some UI issues in Dashboard.
Fixed a bug that MitM may refuse to enable after modifying settings.
Fixed a bug that br decompress may fail.
Fixed a bug that the menu item may use a wrong color if the accent color of system isn't blue.
Fixed the JSON viewer color issue in the Dark Mode.
Minor bug fixes.
Allows import the profile from a URL.
Fixed an issue that the HTTP capture button may show wrong state in Dashboard.
Fixed an issue that Dashboard doesn't show User-Agent as the process name while connecting to iOS device.
Fixed an issue that the bandwidth of processes may be inaccurate.
Fixed an issue that the DEST-PORT rule may not be parsed.
Fixed an issue that ruleset can't be used with logical type rule.
Fixed an issue that TFO option will not be saved.
Fixed an issue that UDP relay option shows wrong state.
Fixed some i18n issues.
Fixed crashs on macOS 10.11.
Save proxy declarations with legacy style (custom) if the proxy is written in legacy style in the text file.
Other minor bug fixes.
Fixed a compatibility issue with 304 response.
Fixed a Dashboard crash.
Fixed a compatibility issue with 304 response.
Fixed an issue that Dashboard may not use the correct encoding to decode text body.
Bug fixes.
Bug fixes.
Surge will automatically track system proxy settings now. When Surge is no longer the default proxy, the status icon will turn grey and a notification will raise.
Fixed a compatibility issue with Docker.
Fixed an issue that the UDP mode with AEAD ciphers doesn't work.
Bug fixes.
Performance improvements.
Fixed an issue that UDP traffics are not included in the real-time speed.
Supports hardware acceleration for AES-GCM encryption.
Supports NAT64 in a pure IPv6 network. (Previous versions already supported DNS64)
Supports using Surge Mac as a gateway.
A new setup guide view.
A new config panel for traffic capture options.
Fixed an issue which Dashboard may disconnect unexpectedly under huge pressure.
The status bar icon will be red while traffic capture is enabled.
Improved TUN interface performance.
Enabling TCP Fast Open in macOS 10.14.
You may use Dashboard to view UDP conversations.
Dashboard now can save multiple remote machine profiles.
Improved the JSON viewer in Dashboard.
Added an UI switch for the dns-failed option in FINAL rule.
Bug fixes.
You may toggle the hidden state of columns in Dashboard now.
Supports to export selected rows to csv file.
Added a connection duration column in Dashboard.
Supports obfs-uri parameter.
Improved the benchmark view.
Fixed a serious bug in the SOCKS5 proxy implementation.
Bug fixes.
The MitM enabling switch has been moved to the main menu and isolated from profile.
Bug fixes.
Added Outbound Mode options: Direct Outbound, Global Proxy and By Rule.
Added options for all policy to specify outgoing interface: 'interface' and 'allow-other-interface'.
Added all_proxy environment variable for 'Copy Shell Export Command'
Refined MitM.
Concurrently setup connection to host with Round-robin DNS to boost performance.
Bug fixes.
Supports xchacha20-ietf-poly1305.
Bug fixes.
HTTP request header and response header can be extracted from TCP connection now. (SOCKS5 and TUN)
Enhanced mode can handle all connections now, even for connections initialized with IP address directly.
Surge TUN now supports forwarding ICMP packets.
From this version, the minimum system version requirement was raised to macOS 10.11. If you are still using macOS 10.10, please use version 2.4.5.
Bug fixes.
Improved performance for high concurrency.
TCP fast open has been disabled temporarily since there is a serious problem in macOS/iOS kernel.
Dashboard will display decoded URL query now.
Supports obfs=tls for shadowsocks protocol.
Refined the proxy edit panel.
Added Simplified Chinese language.
Supports obfs=tls for shadowsocks protocol.
Refined the proxy edit panel.
Added Simplified Chinese language.
Fixed an issue that enhanced mode may not be closed properly when switching to a profile without dns-server.
Fixed an issue that managed profile updating and license info are unavailable while enhanced mode enabled.
When the necessary port is used by another process, the error alert will show which process is using the port.
Fixed an issue that map local items can't be edited with UI.
Fixed an issue that system proxy settings may not be reset properly.
Auto URL test group will execute a retest immediately after the selected policy has failed.
Bug fixes.
Supports enterprise license and profile management.
Fixed a bug that some fields are unavailable in the configuration panel in some cases.
Fixed a bug that the FINAL rule can't be edited.
Fixed a bug that you may not be able to use custom storage path for profiles.
The interface related options are no longer controlled by profile. Sorry for the repetitive changes.
You may use $1, $2 to use the matched string in the value while using header rewrite.
Added an option for HTTP/HTTPS proxy: always-use-connect. When it is true, Surge will use CONNECT method for plain HTTP requests.
Added a option to control whether show proxy error notification.
Fixed a problem that Dashboard show data doesn't exist error.
Added a wizard to install CA’s root certificate for iOS simulator.
Connectivity quality is now an option. (Not show by default)
Line comments in [Rule] section in profile file is now presented in UI.
You may add proxy rule with Dashboard by right-clicking the request or process.
Dashboard will always open a new window for local machine, instead of asking. You may use "File" menu to connect to a remote machine.
Completely redesign the configure interface. You may configure every function with UI now.
Proxy benchmark is now moved to main application from Dashboard.
You may switch profile with command line now: surge-cli switch-profile profilename.
Notifications presented by Surge will be removed from Notification Center automatically.
The interval of attempts to refresh managed config changes to one hour from one minute. (After config expired)
Supports new encryption methods for shadowsocks-libev 3.0.
Optimized Dashboard performance.
Supports TCP Fast Open for shadowsocks proxy. You need add "tfo=true" flag in [Proxy] section to enable the feature. You may use benchmark to confirm TFO is working.
You can sort benchmark results now.
You may choose to reload config after managed config updated.
Fixed a bug when using SOCKS5 without authorization.
You may use Dashboard to benchmark proxies now.
Fixed "Too many open files" error by raising limit to 2048.
Fixed a bug in SOCKS5 with authorization.
Fixed a bug that managed config may refresh continuously.
Map local function is now available.
Adds notifications when proxy encounters errors.
Network changed notification will show service name instead of BSD name now.
Fixed a bug that Dashboard may show the incorrect state of body dump.
Changes for HTTPS and SOCK5-TLS proxy:
Option 'skip-common-name-verify' is deprecated.
Add a new option 'skip-cert-verify' to skip certificate verify completely.
Add a new option 'sni' to customize SNI field while handshaking. You may use 'sni=off' to disable SNI.
New rule type: PROCESS-NAME, USER-AGENT and URL-REGEX.
You can use simple wildcard matching (? and *) for PROCESS-NAME rule, local DNS mapping and MitM hosts.
Dashboard supports display POST form data in a table view.
You may let Surge reload config by sending SIGHUP. You can use command 'killall -HUP Surge' or 'surge-cli reload'.
Managed configuration is supported now.
Add a new option 'skip-server-cert-verify' for MitM.
Fixed a bug that helper may crash on macOS 10.10.
Add a option to remove Surge helper for troubleshooting.
Bug fixes.
Fixed a bug that helper may crash on macOS 10.10.
Add a option to remove Surge helper for troubleshooting.
Bug fixes.
New option: Collapse policy group items in menu
Fixed a bug that enhanced mode DNS settings may not be reverted.
Hold option key to click 'Copy Shell Export Command' to get a command with primary interface IP instead of 127.0.0.1.
Bug fixes.
New feature: Enhanced Mode
Some applications may not obey the system proxy settings. Using enhanced mode can make all applications handled by Surge.
New rule type: IP-CIDR6
Example: IP-CIDR6,2005::/16,DIRECT,no-resolve
The /etc/hosts file will be reloaded automatically if it has changes.
Dashboard supports to use ⌘ + 1,2,3,4 to switch panel.
Dashboard Supports handoff with Surge iOS.
Fixed a bug that Dashboard may show incorrect process name.
Bug fixes.
Supported SNI while performing MitM.
The original certificate will be resigned and used while performing MitM, instead of generating a new certificate.
Rule test cache will be flushed after network switching now.
Added a option 'Grey icon if set as system proxy is disabled'.
Bug fixes and performance improvements.
Surge talks to HTTP proxies with a plain HTTP method for non-HTTPS requests now, instead of CONNECT.
Improved compatibility with some HTTP server.
Improved compatibility with some DNS server.
Dashborad: The height of the detail panel will not change now while switching pages.
A notification will show when proxy client access from other machine.
Used SF Mono as monospaced font for header and body data display.
Supported TCP half-open mechanism.
Add a new option 'exclude-simple-hostnames' in the gereral section.
Dashborad: Selected row will not be lost while the filter or sort column changed.
Dashborad: Fixes some issues in the active panel.
Bug fixes.
New feature: Show connectivity quality in menu.
Surge will send a DNS question to all DNS servers concurrently to test physical network connectivity while opening the menu.
Fixes a problem that Surge may freeze while opening the menu.
Fixes a problem that if a policy group contains duplicate policies, Surge may crash.
Dashboard will no longer display process icon in remote mode.
Fixes a bug: "Set as System Proxy" option does not work properly if only SOCKS service is enabled.
Fixes a bug: Dashboard can't add a rule with no-resolve option on and comment not empty.
Minor bug fixes.
Bug fixes
你现在可以把配置文件中的部分段落用单独的一个文件写。详情参考：
All URL resources now support URLs with a username and password (e.g. ), including managed profile, external resources, and importing profile form URL.
New feature: Module, which can override the current profile with a set of settings. Highly flexible for diverse purposes. See the post in the community for more information: .
Snell protocol now upgrade to version 2, supporting to reuse TCP connections to improve performance.
Supports to use OpenSSL as TLS provider. See the post in the community for more information: .
The scripting has been rewritten totally. The old scripts are not compatible with this version. See
Supports DNS over HTTPS. More information in community:
New major feature: scripting. You may use JavaScript to modify the response as you wish. See the manual for more information:
Supports a new proxy protocol: Snell. ()
Surge Mac can work as a Snell proxy server now. See for more information.
Added a new option 'hijack-dns' to hijack DNS queries to other DNS servers with fake IP addresses. See manual for more information: .
New Features: External Proxy Provider. See for more information.
Surge now allows expired DNS answers for performance reasons. See 'Optimistic DNS' section in for more information.
Supports UDP relay for shadowsocks protocol. A brief introduction in Chinese: .
Supports client-side SSL/TLS certificate validation for HTTPS and SOCKS5-TLS proxy. A config example is here: (DO NOT support editing with UI in this version.)
Added a patch mechanism for adjusting settings for managed config. See manual for more information:
New feature: Header rewrite. See manual for more information: .