loyalsoldier/geoip

The loyalsoldier/geoip project automatically generates various GeoIP data file formats every Thursday. It also provides a CLI tool for users to customize their own GeoIP files.

Supported formats include:

• V2Ray dat format (geoip.dat)
• MaxMind mmdb format (Country.mmdb, including GeoIP2-Country.mmdb and GeoLite2-Country.mmdb)
• sing-box SRS format
• mihomo MRS format
• Clash ruleset files
• Surge ruleset files
• Nginx allow/deny lists

Enter the download URLs directly into the Shadowrocket settings. Use GEOIP rules in your [Rule] section.

[Rule]
GEOIP,PRIVATE,DIRECT
GEOIP,FACEBOOK,PROXY
GEOIP,CN,DIRECT

To build your own GeoIP files on your local machine, you need to install Golang and Git, clone the repository, configure your config.json according to the configuration.md documentation, and run the conversion tool.

Prerequisites:

• Golang
• Git

Steps:

1. Clone the repository: git clone https://github.com/Loyalsoldier/geoip.git
2. Navigate to the root directory: cd geoip
3. Modify config.json based on the project's configuration guide.
4. Execute the conversion command.

git clone https://github.com/Loyalsoldier/geoip.git
cd geoip
go run ./ convert -c ./config.json

To use these GeoIP files in Surge, add RULE-SET entries to your [Rule] section. You can point directly to the jsDelivr CDN URLs for automatic updates.

Example configuration for rejecting US traffic, directing China traffic, and proxying Telegram traffic:

[Rule]
RULE-SET,https://cdn.jsdelivr.net/gh/Loyalsoldier/geoip@release/surge/us.txt,REJECT
RULE-SET,https://cdn.jsdelivr.net/gh/Loyalsoldier/geoip@release/surge/cn.txt,DIRECT
RULE-SET,https://cdn.jsdelivr.net/gh/Loyalsoldier/geoip@release/surge/telegram.txt,PROXY,no-resolve

In mihomo, set geodata-mode to false and provide the URLs for your mmdb and asn files under the geox-url key.

geodata-mode: false
geox-url:
  mmdb: "https://cdn.jsdelivr.net/gh/Loyalsoldier/geoip@release/Country.mmdb"
  asn: "https://cdn.jsdelivr.net/gh/Loyalsoldier/geoip@release/GeoLite2-ASN.mmdb"

In sing-box, define rule_set entries with type: "remote" and format: "binary" to use the provided .srs files. Then, reference these tags in your route.rules configuration.

"route": {
  "rules": [
    {
      "rule_set": "geoip-cn",
      "outbound": "direct"
    },
    {
      "rule_set": "geoip-us",
      "outbound": "block"
    }
  ],
  "rule_set": [
    {
      "tag": "geoip-cn",
      "type": "remote",
      "format": "binary",
      "url": "https://cdn.jsdelivr.net/gh/Loyalsoldier/geoip@release/srs/cn.srs"
    },
    {
      "tag": "geoip-us",
      "type": "remote",
      "format": "binary",
      "url": "https://cdn.jsdelivr.net/gh/Loyalsoldier/geoip@release/srs/us.srs"
    }
  ]
}

Enter the download URLs directly into the Quantumult X settings. Use GEOIP rules in your [filter_local] section.

[filter_local]
GEOIP,PRIVATE,DIRECT
GEOIP,FACEBOOK,PROXY
GEOIP,CN,DIRECT

You can install the geoip CLI tool directly using go install.

go install -v github.com/Loyalsoldier/geoip@latest

You can use the provided GeoIP rulesets in Clash Premium or mihomo by defining rule-providers with type: http and behavior: ipcidr. This allows the client to automatically fetch and update the IP CIDR lists.

Note: The format should be set to yaml for these rulesets.

rule-providers:
  cn-cidr:
    type: http
    behavior: ipcidr
    format: yaml
    url: "https://cdn.jsdelivr.net/gh/Loyalsoldier/geoip@release/clash/ipcidr/cn.txt"
    path: ./ruleset/ipcidr/cn.yaml
    interval: 86400

telegram-cidr:
    type: http
    behavior: ipcidr
    format: yaml
    url: "https://cdn.jsdelivr.net/gh/Loyalsoldier/geoip@release/clash/ipcidr/telegram.txt"
    path: ./ruleset/ipcidr/telegram.yaml
    interval: 86400

rules:
  - RULE-SET,cn-cidr,DIRECT
  - RULE-SET,telegram-cidr,PROXY,no-resolve

Enter the download URLs directly into the Surge settings. Use GEOIP rules in your [Rule] section.

[Rule]
GEOIP,PRIVATE,policy,no-resolve
GEOIP,FACEBOOK,policy
GEOIP,CN,policy,no-resolve

The project uses a JSON configuration file to define data transformation pipelines. The configuration must contain two primary arrays: input and output. Each array contains one or more configuration objects specifying the format for that stage of the pipeline.

Example structure:

{
  "input":  [],
  "output": []
}