An API for converting your surge configuration.
You can simply insert, replace, or delete some config in your surge profile. All you need to do is writing a modifier config file and update your managed URL.
SS modifier is written in pure Swift (using vapor).
Feel free to open pull request or leave any issues.
Just clone this repo and open Package.swift in server folder (using Xcode).
Get https://ss.kaelzs.com/surge/convert
urls(String or [String], required): Your surge modifier urls.
name(String, optional, default tosurge.conf): The response file name.
preview(Bool, optional, default to false): if set to true, the response content type will be set totext/plain.
managed(Bool, optional, default to true): If set to false, the surge config will not be managed by URL.
interval(Bool, optional, default to 3600): the update interval of managed config.
strict(Bool, optional, default to false): weather needs a strict update when managed config outdated.
There are two kinds of group modifier, replace or modify, you can declare the type in any surge group, the default type is replace, you can specify the type using #!type $TYPE.
The replacing modifier will replace the entire group of the current profile, while the modifying modifier will just do some modification to the group of the current profile.
You can also specify the name of the modifier using #!name $NAME
Supported Options:
-
#!basedOnResources: to indicate that the modifier is based on the resource and the modifier will be ignored if the resource fails to load. -
#!requiredModifiers $NAMEA, $NAMEB: to indicate that the modifier is based on the specific modifier and the modifier will be ignored if any of the modifiers is ignored.
[General]
#!type replace
#!name general0
#!basedOnResources
[Replica]
#!type modify
#!requiredModifiers general0The plain line is only supported in replacing modifier, you can just write the config as in the surge config. The plain line will be ignored when written in a basic modifier.
[General]
#!type replace
# > General
http-listen = 0.0.0.0:8888
socks5-listen = 0.0.0.0:8889
external-controller-access = [email protected]:6170
internet-test-url = http://www.qualcomm.cn/generate_204
proxy-test-url = http://www.qualcomm.cn/generate_204The modifier line declares how to modify the group of the current profile. You can declare the modifier line by adding #!insert or #!append before any plain line, it will insert or append the line to the group of the current profile.
[Rule]
#!type modify
#!insert # > Tool
#!insert # >> Zeplin
#!insert DOMAIN-SUFFIX,zeplin.io,Proxy
[Proxy]
#!type modify
#!append My-Custom-SS = snell, example.com, 12345, psk = 1234, obfs = tlsYou can add some remote resource to the modifier, it will replace the line by the same group of the remote profile.
[URL Rewrite]
#!type replace
#!insert $from('https://raw.githubusercontent.com/rixCloud-Inc/rixCloud_Surge-Data/master/surge3_rules')
# > the modifier will find the same group (URL Rewrite) of the remote resource (or just using the
# > whole remote resource), and insert them to the start of the current group (URL Rewrite). The modifier
# > will find the same group (URL Rewrite) of the remote resource and insert them to the start of
# > current group (URL Rewrite).
[MITM]
#!type replace
$from('https://raw.githubusercontent.com/lhie1/Rules/master/Surge/Surge%203/MitM.conf')There are three kinds of update modifier, insert, append, and replace.
[Proxy Group]
#!type replace
Proxy = select, Direct
[Proxy Group]
#!type modify
#!update-insert-1 Proxy = HK
# > the modifier will insert the `HK` to the second property of the Proxy, and will
# > output to Proxy = select, HK, Direct
#!update-insert-0 A = B, Cwill insertB, Cto the first property ofA.
#!update-append-0 A = B, Cwill appendB, Cto the last property ofA.
#!update-replace A = B, Cwill replace the original properties ofAtoA = B, C.
You can use the code $group('Name', operator, 'operand') to filter the keys of the modifier group with a specific name. You can use #!name XXX to specify the name of the group.
containsfilter the keys whose name contains the operand.
matchesfilter the keys whose name (regex) matches the operand.
prefixfilter the keys whose name has operand prefix.
suffixfilter the keys whose name has operand suffix.
[Proxy]
#!type modify
#!name ProxyList
#!insert $from('https://proxy.list/from/some/conf/')
[Proxy Group]
#!type modify
#!append Daily = url-test, $group('ProxyList', contains, 'Daily'), url = http://www.qualcomm.cn/generate_204, interval = 300, tolerance = 100, timeout = 5