highweb/yii2-ip-ratelimiter

Allow guest clients to be rate limited, using their IP as the identifier.

, _(*1)

yii2-ip-ratelimiter

Allow guest clients to be rate limited, using their IP as the identifier., _(*2)

Installation

The preferred way to install this extension is through composer., _(*3)

Either run, _(*4)

php composer.phar require highweb/yii2-ip-ratelimiter "^1.0"

or add, _(*5)

"highweb/yii2-ip-ratelimiter": "^1.0"

to the require section of your composer.json file., _(*6)

Usage

Modify the behavior method of the controller you want to rate limit, _(*7)

public function behaviors()
{
    return [
        'rateLimiter' => [
            // Use class
            'class' => \highweb\ratelimiter\RateLimiter::className(),

            // The maximum number of allowed requests
            'rateLimit' => 100,

            // The time period for the rates to apply to
            'timePeriod' => 600,

            // Separate rate limiting for guests and authenticated users
            // Defaults to true
            // - false: use one set of rates, whether you are authenticated or not
            // - true: use separate ratesfor guests and authenticated users
            'separateRates' => false,

            // Whether to return HTTP headers containing the current rate limiting information
            'enableRateLimitHeaders' => false,
        ]
    ];
}

Forked from ethercreative/yii2-ip-ratelimiter., _(*8)