Skip to content
This repository has been archived by the owner on Jul 9, 2021. It is now read-only.

Config documentation

Kamil Monicz edited this page Oct 29, 2019 · 3 revisions
  • CloudflareEmail
    Your cloudlfare account email address

  • CloudflareApiKey
    Your cloudlfare account global API key
    Tutorial - how to find it

  • CloudflareUnderAttackMode
    Enable Cloudflare's Under Attack Mode when massive attack is detected

  • CloudflareModeDefault
    Default security level (switch to it after Under Attack Mode expires) (to use only with CloudflareUnderAttackMode)

  • CloudflareManageZones
    List of zones/websites where Under Attack Mode should be enabled (to use only with CloudflareUnderAttackMode)
    Tutorial - how to find it

Example configuration:

"CloudflareManageZones": [
  "12345678901234567890123456789012",
  "67175678901234567890123456784824",
  "85295678901234567890123456783270" // <-- last one doesn't have a ','
],
  • BlockNote
    Comment to set in Cloudflare block rule and Nginx block .conf file

  • WatcherTargetFile
    Full path to Nginx error.log file

  • WatcherCheckSleep
    Check for error.log file changes every X milliseconds (2 seconds = 2000)

  • AbuseExpirationTime
    Time after which abuse counter resets to zero (value in seconds, 5 minutes = 300)

  • BlockExpirationTime
    Time after which IP is removed from the blacklist (value in seconds, 3 hours = 10800)

  • BlocksToUnderAttack
    Amount of blocks required in single tick to enable Under Attack Mode (1 tick = WatcherCheckSleep milliseconds) (to use only with CloudflareUnderAttackMode)

  • UnderAttackExpirationTicks
    Ticks after which Under Attack Mode is disabled (1 tick = WatcherCheckSleep milliseconds) (to use only with CloudflareUnderAttackMode)

  • AbusesToBlock
    How many abuses are required to add IP to the blacklist

  • AbusesToBlockUnderAttack
    How many abuses are required to add IP to the blacklist while Under Attack Mode is enabled (to use only with CloudflareUnderAttackMode)

  • NginxBlockSnippetFile
    Full path where Nginx block .conf file will be created

Clone this wiki locally