Routing & DNS

Introduction #

FoXray uses local configuration + Xray Json to generate the final configuration file. This move is mainly to enable users to focus on Routing and DNS when writing Xray Json, without paying attention to the implementation of FoXray.

Difference #

FoXray only supports a subset of Xray’s configurations.

Compared with the original Xray configuration, FoXray has the following limitations.

DNS #

servers only supports ServerObject .
Do Not support FakeDNS .
hosts only supports the form of "domain": ["address1","address2"] .
tag is fixed to dnsQuery . Even if you specify tag as something else, it will be fixed to dnsQuery when generating the config file.

Routing #

routing doest Not support custom domainMatcher.
routing doest Not support balancers.
RuleObject doest Not support custom domainMatcher.
RuleObject doest Not support user, attrs, balancerTag.

On and Off #

The basis for FoXray to determine whether to enable Routing or DNS is: whether the Xray Json contains routing or dns field.

If you only want to use Routing, only configure the routing field.

If you only want to use DNS, only configure the dns field.

Note:

If you enable DNS, even if you disable Routing, FoXray will generate two rules to handle DNS queries.
If you disable DNS, FoXray will use 8.8.8.8 as the default DNS.

Rule dataset #

When creating new routing and DNS configurations, geosite and geoip are included by default. If you use other data sets, you need to associate other rule data sets with the configuration yourself, otherwise the verification will not pass.

You can customize a local name for the rule dataset, which only takes effect within the current routing and DNS configuration.

When deleting a rule data set, all routing and DNS configurations associated with the rule dataset will be deleted by default.

Note: According to experience, when the number of rules included in the routing and DNS configuration reaches tens of thousands, the VPN will most likely fail to start on iOS. FoXray has counted the number of rules under each category in the rule dataset for you, and you can calculate the total number of rules used in the configuration by yourself.

Sniffing #

Starting from version 2.6, FoXray supports custom sniffing.

Notice:

FoXray only parses the sniffing configuration of the first inbound.

{
  "inbounds" : [
    {
      "sniffing" : {
        "destOverride" : [
          "http",
          "tls",
          "quic"
        ],
        "domainsExcluded" : [
          "courier.push.apple.com"
        ],
        "enabled" : true
      }
    }
  ]
}

Full configuration #

{
    "dns": {
        "hosts": {
          "baidu.com": ["127.0.0.1"],
          "dns.google": ["8.8.8.8", "8.8.4.4"]
        },
        "servers": [
            {
                "address": "1.2.3.4",
                "port": 53,
                "domains": [
                    "domain:xray.com",
                    "geosite:cn"
                ],
                "expectIPs": [
                    "geoip:cn"
                ],
                "skipFallback": false
            },
            {
                "address": "localhost"
            }
        ],
        "queryStrategy": "UseIP",
        "disableCache": false,
        "disableFallback": false,
        "disableFallbackIfMatch": false,
        "tag": "dnsQuery"
    },
    "inbounds" : [
      {
        "sniffing" : {
          "destOverride" : [
            "http",
            "tls",
            "quic"
          ],
          "domainsExcluded" : [
            "courier.push.apple.com"
          ],
          "enabled" : true
        }
      }
    ],
    "routing": {
        "domainStrategy": "AsIs",
        "rules": [
            {
                "type": "field",
                "domain": [
                    "baidu.com",
                    "qq.com",
                    "geosite:cn"
                ],
                "ip": [
                    "0.0.0.0/8",
                    "10.0.0.0/8",
                    "fc00::/7",
                    "fe80::/10",
                    "geoip:cn"
                ],
                "port": "53,443,1000-2000",
                "sourcePort": "53,443,1000-2000",
                "network": "tcp",
                "source": [
                    "10.0.0.1",
                    "geoip:cn"
                ],
                "inboundTag": [
                    "tag-vmess"
                ],
                "protocol": [
                    "http",
                    "tls",
                    "bittorrent"
                ],
                "outboundTag": "direct"
            }
        ]
    }
}

Note: When FoXray parses the configuration, it will automatically download the associated geo data in the configuration. If the download fails, the configuration will fail the verification.

The shared format of routing and DNS is xray://base64RoutingDNS .

Subscriptions support routing and DNS configuration. Subscriptions shall be provided in text form and formatted as follows.

xray://base64RoutingDNS
xray://base64RoutingDNS

Manually written #

How does FoXray convert routing and DNS configuration to Xary Json? #

FoXray uses an extension field ext to hold the name and rule dataset.

All conversion relations are as follows:

name

{
  "ext" : {
    "name" : "share"
  }
}

Default Outbound

{
  "outbounds" : [
    {
      "tag" : "proxy"
    }
  ]
}

ipQuery Outbound

{
  "routing" : {
    "rules" : [
      {
        "inboundTag" : [
          "dnsQuery"
        ],
        "outboundTag" : "proxy",
        "type" : "field"
      }
    ]
  }
}

nonIPQuery

{
  "outbounds" : [
    {
      "protocol" : "dns",
      "settings" : {
        "nonIPQuery" : "skip",
      }
    }
  ]
}

nonIpQuery Outbound

{
  "outbounds" : [
    {
      "protocol" : "dns",
      "streamSettings" : {
        "sockopt" : {
          "dialerProxy" : "proxy"
        }
      }
    }
  ]
}

nonIPQuery DNS

{
  "outbounds" : [
    {
      "protocol" : "dns",
      "settings" : {
        "address" : "8.8.8.8"
      }
    }
  ]
}

Rule Dataset

{
  "ext" : {
    "dat" : [
      {
        "name" : "geoip",
        "type" : "ip",
        "url" : "https://github.com/v2fly/geoip/releases/latest/download/geoip.dat"
      },
      {
        "name" : "geosite",
        "type" : "domain",
        "url" : "https://github.com/v2fly/domain-list-community/releases/latest/download/dlc.dat"
      }
    ]
  }
}

When FoXray parses the shared link, it will be set according to the above corresponding relationship.

Writing #

The first two rules in routing must be of the following form.

{
  "routing" : {
    "rules" : [
      {
        "inboundTag" : [
          "dnsQuery"
        ],
        "outboundTag" : "proxy",
        "type" : "field"
      },
      {
        "outboundTag" : "dnsOut",
        "port" : "53",
        "type" : "field"
      }
    ]
  }
}

Among them, the outboundTag of the first rule represents the ipQuery Outbound. These two rules will be removed when parsing.

Note: In FoXray, you don’t need to write these two rules, the program will automatically generate them.

about ext

ext stores the configuration name and associated geo data. Among them, name is a required field. If it is omitted, the configuration will fail the verification.

dat stores the geo data associated with the configuration.

Example #

{
  "dns" : {
    "servers" : [
      {
        "address" : "8.8.8.8"
      }
    ]
  },
  "ext" : {
    "dat" : [
      {
        "name" : "geoip",
        "type" : "ip",
        "url" : "https://github.com/v2fly/geoip/releases/latest/download/geoip.dat"
      },
      {
        "name" : "geosite",
        "type" : "domain",
        "url" : "https://github.com/v2fly/domain-list-community/releases/latest/download/dlc.dat"
      }
    ],
    "name" : "share"
  },
  "outbounds" : [
    {
      "tag" : "proxy"
    },
    {
      "protocol" : "dns",
      "settings" : {
        "address" : "8.8.8.8",
        "nonIPQuery" : "skip",
        "userLevel" : 0
      },
      "streamSettings" : {
        "sockopt" : {
          "dialerProxy" : "proxy"
        }
      },
      "tag" : "dnsOut"
    }
  ],
  "routing" : {
    "rules" : [
      {
        "inboundTag" : [
          "dnsQuery"
        ],
        "outboundTag" : "proxy",
        "type" : "field"
      },
      {
        "outboundTag" : "dnsOut",
        "port" : "53",
        "type" : "field"
      },
      {
        "domain" : [
          "geosite:private",
          "geosite:bing",
          "geosite:cn"
        ],
        "outboundTag" : "direct",
        "type" : "field"
      },
      {
        "ip" : [
          "geoip:private"
        ],
        "outboundTag" : "direct",
        "type" : "field"
      }
    ]
  }
}