DOCSEARCHbyAlgolia
Submit Docs

karing-ruleset Documentation

repository·sing·Indexed 20 days ago

https://github.com/karingx/karing-ruleset

A collection of rule-sets including GeoIP, GeoSite, ACL4SSR, and AdGuard optimized for sing-box and the Karing client. Provides JSON and SRS fragments for ad-blocking, direct connection, and proxying, with instructions for integration into the Karing application and references for geosite category definitions and AdGuard SDNS Filter rule-sets.

Tokens
996
Snippets
2
Records
5
Agent score
21%

What's inside karing-ruleset

  1. Download sing-box/karing rule-set fragments

    sing

    Rule-set fragments (JSON and SRS files) are generated based on ACL4SSR and GeoIP/GeoSite sources. You can download them using two primary methods:

    Method 1: GitHub (Raw)

    Best for direct access to specific files. For example, to get ChinaIp.srs: https://raw.githubusercontent.com/KaringX/karing-ruleset/sing/ACL4SSR/ChinaIp.srs

    Method 2: jsDelivr CDN

    Best for reliable content delivery. For example, to get BanAD.srs: https://fastly.jsdelivr.net/gh/karingX/karing-ruleset@sing/ACL4SSR/BanAD.srs

    https://raw.githubusercontent.com/KaringX/karing-ruleset/sing/ACL4SSR/ChinaIp.srs

  2. Use rule-sets in Karing

    sing

    To use custom rule-sets (like antizapret.srs) in the Karing application, follow these steps:

    1. Add New Diversion Group:
      • Fill in the SRS URL (e.g., https://github.com/savely-krasovsky/antizapret-sing-box/releases/latest/download/antizapret.srs).
      • Save the rule-set.
    2. Apply to Diversion Rules:
      • Return to the Diversion Rules Page.
      • Select Custom Diversion Group.
      • Select the newly created Diversion Group.
      • Set the Action selection to Current Select.

    Important Note: If an SRS file is larger than 3MB, it should only be used on Windows. Using large files on Android or iOS may exceed memory limits.

    https://github.com/savely-krasovsky/antizapret-sing-box/releases/latest/download/antizapret.srs

  3. Reference: sing-box/karing rule-set fragments

    sing

    A list of available rule-set fragments and their purposes:

    FileTypeDescription
    BanAD.srsAd-blockingContains common ad keywords and ad networks.
    BanADCompany.srsAd-blockingContains ad domains from major companies.
    BanProgramAD.srsAd-blockingContains ad rules for common applications.
    BanEasyListChina.srsAd-blockingAdblockPlus China blocking domains.
    LocalAreaNetwork.srsDirect ConnectLocal addresses and router domains.
    ChinaDomain.srsDirect ConnectCommon Chinese domains and direct CDN domains.
    ChinaCompanyIp.srsDirect ConnectIP ranges for Chinese BAT companies and cloud providers.
    ChinaIp.srsDirect ConnectIPIP Chinese IP address segments.
    Download.srsDirect ConnectDomains used for downloading.
    Apple.srsRule-setAll Apple company domains.
    Microsoft.srsRule-setAll Microsoft company domains.
    OneDrive.srsRule-setOneDrive domains.
    GoogleCN.srsDirect ConnectGoogle domains that can be accessed directly in China.
    Telegram.srsProxyAll Telegram domains.
    Netflix.srsProxyAll Netflix domains.
    ProxyGFWlist.srsProxyFull GFW list.
    ProxyLite.srsProxyA streamlined proxy list containing common/polluted domains.

  4. Reference: Geosite category definitions

    sing

    Commonly used geosite identifiers and what they include:

    • geosite:category-ads: Common advertising domains.
    • geosite:category-ads-all: Common advertising domains and advertising provider domains.
    • geosite:cn: Collection of geolocation-cn and tld-cn.
    • geosite:apple: Most Apple-owned domains.
    • geosite:google: Google-owned domains.
    • geosite:microsoft: Microsoft-owned domains.
    • geosite:facebook: Facebook-owned domains.
    • geosite:twitter: Twitter-owned domains.
    • geosite:telegram: Telegram-owned domains.
    • geosite:geolocation-cn: Common mainland China site domains.
    • geosite:geolocation-!cn: Common non-mainland China site domains (includes tld-!cn).
    • geosite:tld-cn: Top-level domains managed by CNNIC (e.g., .cn, .中国).
    • geosite:tld-!cn: Non-mainland China top-level domains (e.g., .hk, .tw, .jp, .sg, .us, .ca).

  5. Reference: AdGuard SDNS Filter rule-sets

    sing

    The following rule-sets are derived from AdGuard SDNS Filter configurations:

    • AdGuardFilter: Derived from AdguardTeam/AdGuardSDNSFilter configuration. List: AdGuardFilter.list
    • PopupFilter: Derived from AdguardTeam/AdGuardSDNSFilter popup configuration. List: PopupFilter.list
    • ppfeuferFilter: Derived from ppfeufer/adguard-filter-list. List: ppfeuferFilter.list