Common Group Parameters

These parameters are available on all group types, with one exception: subnet groups support only hidden and icon-url (see Subnet Group). The parameters for importing members (policy-path, include-all-proxies, include-other-group, and their companions) are documented on the Policy Including page.

no-alert

Optional, Boolean, default: false

Do not show the policy change notification for this group. The "Group has a new optimal option" notification is only posted by url-test and fallback groups, so this parameter has no effect on other group types — load-balance, smart, and select groups never notify.

hidden

Optional, Boolean, default: false

Do not show the group in the menu (Surge Mac) and the policy selection view (Surge iOS).

icon-url Mac 6.5.0+

Optional

Configure an icon for a policy group for display in the policy selection interface. This parameter currently needs to be edited manually in the profile.

Example:

Group = select, ProxyA, ProxyB, icon-url=https://example.com/icon.png

Testing URL and Timeout

The automatic group types test their members with an HTTP HEAD request. For each member policy, the testing URL is resolved as follows:

  1. The policy's own test-url parameter, if set.
  2. Otherwise, a global option from [General]: internet-test-url for direct-type policies, proxy-test-url for proxy policies. Both default to http://bing.com/.

The per-test timeout is resolved similarly: the policy's test-timeout parameter, then the global test-timeout option, then 5 seconds by default (10 seconds for direct-type policies).

These per-policy parameters are documented in Policy Parameters. Do not confuse the per-test test-timeout with the timeout parameter of url-test/fallback groups, which filters candidates by their measured latency.

Temporary Override

The automatic group types — url-test, fallback, load-balance, subnet, and smart — can be temporarily overridden by manually selecting a policy:

  • In Surge Mac, you can find the override option in the corresponding group in the main menu.

  • In Surge iOS, you can find the override option by long-pressing on the corresponding policy's menu in the policy group view.

While an override is active, the group always uses the selected policy and automatic testing for the group is no longer triggered by use. Overrides for groups that no longer exist are cleared when the profile reloads.

results matching ""

    No results matching ""