/generate-geoip-geosite

Generates GeoIP, Geosite and Rule-Set files (used by Sing-Box to configure routes) from lists of IP addresses and domains.

Primary LanguageGo

GeoIP, Geosite and Rule-Set generator for Sing-Box

Generates GeoIP, Geosite and Rule-Set files (used by Sing-Box to configure routes) from lists of IP addresses and domains.

Program Features

  • List Grouping into Categories: Enables the grouping of lists into categories for more refined configuration of routes in Sing-Box.

  • Downloading Up-to-date Lists: Supports the capability to download up-to-date lists from publicly available sources.

  • Various Downloadable List Formats Support: The program can handle lists in formats such as csv, json, list, and others.

  • Exclusion of Unnecessary Domains and IP Addresses: It provides the option to use exclusion lists to eliminate redundant domains and IP addresses.

  • Rule-Set Generation: The program is capable of generating new Rule-Sets in both .json and .srs formats, replacing GeoSite and GeoIP in Sing-Box starting from version v1.8.0-alpha.

How To Use

generate-geoip-geosite -i /path/to/input -o /path/to/output

To use, you need to specify the path to the directory containing your lists of domains and IP addresses ("-i ./path/to/input/directory") and the path to the directory where the generated files will be saved ("-o ./path/to/output/directory").

In the directory specified by "-i ./path/to/input/directory", files of the following format should be present: "{include/exclude}-{ip/domain}-{category_name}.{lst/rgx}". During the generation process, these files will be processed as follows:

  • {include/exclude}. IP addresses and domains in a file with "include" in the name will be included in the final file during generation. IP addresses and domains in a file with "exclude" in the name will be excluded from the final file during generation. In other words, all matches of IP addresses and domains in "include" files and "exclude" files of the same category will not be included in the final file.
  • {ip/domain} in the name indicates that the file contains IP addresses or domains, respectively.
  • {category_name} is any category name. A category allows combining multiple domains or IP addresses into one list, which appears in the final GeoIP and Geosite files. In the case of Rule-set, each category will create one Rule-set. The same category name can be given for IP addresses and domains, resulting in two different categories (for IP and for domains).
  • {lst/rgx} is the file extension, indicating the format of the entries in the file: a regular string or a regular expression. Currently, it makes sense to use it for excluding domains.

To always have up-to-date GeoIP, Geosite, and Rule-set files, functionality for downloading files and subsequent parsing into {include/exclude}-{ip/domain}-{category_name}.{lst/rgx} format files has been added to the program. The list of files to download is specified in the source file. To specify the path to the source file, add the -s ./path/to/source.json flag. Below are ready-made source files for downloading up-to-date lists of IP addresses and domains useful for users in Russia.

Source File Examples

The project contains example source files:

  • sourceAdAway.json

    • Downloads lists of domains provided by AdAway, then categorizes each list.
    • Use: generate-geoip-geosite -s sourceAdAway.json -i ./adaway -o ./adaway

  • sourceAntifilter.json

    • Downloads lists of IP addresses and domains provided by Antifilter, then categorizes each list.
    • Use: generate-geoip-geosite -s sourceAntifilter.json -i ./antifilter -o ./antifilter

  • sourceRublacklist.json

    • Downloads lists of IP addresses and domains provided by Roskomsvoboda, then categorizes each list.
    • Use: generate-geoip-geosite -s sourceRublacklist.json -i ./rublacklist -o ./rublacklist

  • sourceAntizapret.json

    • Downloads lists of IP addresses and domains provided by zapret-info/z-i. Unnecessary domains are then excluded using regular expressions from the file antizapret\exclude-domain-antizapret.rgx (Slightly modified exclude-regexp-dist.awk). The result is a list of IP addresses and domains roughly corresponding to the Antizapret lists.
    • Use: generate-geoip-geosite -s sourceAntizapret.json -i ./antizapret -o ./antizapret

  • sourceTorrents.json

    • Downloads lists domains provided by github.com/SM443, then categorizes each list.
    • Use: generate-geoip-geosite -s sourceTorrents.json -i ./torrents -o ./torrents

Source File Description

The source file (source.json) is intended to provide the program with URLs containing files that include domains and IP addresses, along with parsing information for each file. The JSON file is structured as an array with a "Source" object, defined by the following fields:

  1. url (string, mandatory)

  2. category (string, mandatory)

    • Description: The name of the category associated with the source. Used in Sing-Box routes.
    • Example: "antizapret"

  3. contentType (string, optional)

    • Description: The type of content in the source file. Must match one of the predefined content types.
    • Options:
      • "DefaultList": Ordinary list with either IP addresses or domains.
      • "CsvDumpAntizapret": CSV file from Antizapret containing domains and IP addresses.
      • "JsonRublacklistDPI": JSON file from Rublacklist with domains blocked via DPI.
      • "JsonListDomains": JSON file with a list of domains.
      • "JsonListIPs": JSON file with a list of IP addresses.
    • Example: "CsvDumpAntizapret"
    • Default Value: "DefaultList"

  4. isExclude (bool, optional)

    • Description: If set to true, the data from this source will be included; otherwise, it will be excluded.
    • Default Value: false

Build

Given that the Go Language compiler (version 1.11 or greater is required) is installed, you can build it with:

go get github.com/Dunamis4tw/generate-geoip-geosite
cd $GOPATH/src/github.com/Dunamis4tw/generate-geoip-geosite
go build .

Flags

  • -i, --inputDir string: Set the path to the input directory for listing files ({include/exclude}-{ip/domain}-{category_name}.{lst/rgx}).
  • -o, --outputDir string: Set the path to the output directory for GeoIP, Geosite, Rule-set files (.db, rule-set.json, rule-set.srs).
  • -s, --sources string: Set the path to the sources.json file containing an array of URLs for download.
  • --gen-geoip: Generate GeoIP file.
  • --gen-geosite: Generate Geosite file.
  • --gen-rule-set-json: Generate Rule-Set JSON files.
  • --gen-rule-set-srs: Generate Rule-Set SRS files.
  • -h, --help: Help.

Note: If none of the four flags (--gen-geoip, --gen-geosite, --gen-rule-set-json, --gen-rule-set-srs) are specified, all four types of final files will be generated. If at least one flag is specified, only the files corresponding to the specified flags will be generated.