Skip to content

Rule Set

Since sing-box 1.8.0

Structure

{
  "type": "",
  "tag": "",
  "format": "",

  ... // Typed Fields
}

Local Structure

{
  "type": "local",

  ...

  "path": ""
}

Remote Structure

Remote rule-set will be cached if experimental.cache_file.enabled.

{
  "type": "remote",

  ...,

  "url": "",
  "download_detour": "",
  "update_interval": ""
}

Fields

type

Required

Type of Rule Set, local or remote.

tag

Required

Tag of Rule Set.

format

Required

Format of Rule Set, source or binary.

Local Fields

path

Required

File path of Rule Set.

Remote Fields

url

Required

Download URL of Rule Set.

download_detour

Tag of the outbound to download rule-set.

Default outbound will be used if empty.

update_interval

Update interval of Rule Set.

1d will be used if empty.