Skip to main content

Subscription Rules

One of the important modules of PeerBanHelper, it subscribes to rules from PBH-BTN/BTN-Collected-Rules by default.
When an IP from the rules connects to the downloader, PeerBanHelper will immediately block it.

tip

It is not recommended to configure this feature through the configuration file; you can directly use the visual editor in the WebUI.

rules-sub

By default, the rule subscription module updates all subscription rules every time PeerBanHelper starts or every 4 hours. You can click the gear icon to change the update frequency of the subscription rules.

If you need to check the changes in the rules or whether the update was successful, you can click the "View History" button to view the update history.

rules-sub-logs

Creating Rules​

PeerBanHelper can load an IP rule set composed of the following:

  • IP addresses (supports v4 and v6), e.g., 1.2.3.4
  • CIDR, e.g., 1.2.3.0/24
  • Single-line comments starting with # (line-end comments are not supported)

Configuration File​

  # Subscription Rules
  # Rules Subscription
  # It is recommended to configure this module on WebUI
  # Recommended configure this module on WebUI
  ip-address-blocker-rules:
    enabled: true
    # Ban duration in milliseconds, use default to follow global settings
    ban-duration: 259200000
    # Check interval
    check-interval: 14400000 # Checks every 4 hours in milliseconds; Timeunit: ms
    # Rules list
    rules:
      # Rule ID (any)
      all-in-one:
        # Enable?
        enabled: true
        # Display Name
        name: all-in-one
        # Rule file subscription address
        url: https://bcr.pbh-btn.ghorg.ghostchu-services.top/combine/all.txt