potelo/laravel-block-bots

There is no license information available for the latest version (1.6.1) of this package.

Block bots and high traffic offenders using Redis

1.6.1 2023-09-21 21:50 UTC

README

Latest Version on Packagist Software License Total Downloads

Introduction

Laravel Block bots is a pacakge that block bad crawlers, people trying to scrape your website or high-usage users, but lets good and important crawlers such as GoogleBot and Bing pass-thu.

Features

  • ULTRA fast, less than 1ms increase in each request.
  • Verify Crawlers using reverse DNS
  • Highly configurable
  • Redirect users to a page when they got blocked
  • Allow Logged users to always bypass blocks

Install

Via Composer

composer require potelo/laravel-block-bots

Requirement

Before Laravel 5.5

In Laravel 5.4. you'll manually need to register the \Potelo\LaravelBlockBots\BlockBots::class service provider in config/app.php.

Config

To adjust the library, you can publish the config file to your project using:

php artisan vendor:publish --provider="Potelo\LaravelBlockBots\BlockBotsServiceProvider"

Configure variables in your .env file:

BLOCK_BOTS_ENABLED=true // Enables block bots
BLOCK_BOTS_MODE=production // options: `production` (like a charm), `never` (bypass every route), `always` (blocks every routes)
BLOCK_BOTS_USE_DEFAULT_ALLOWED_BOTS=true // if you want to use our preseted whitelist
BLOCK_BOTS_WHITELIST_KEY=block_bot:whitelist // key for whitelist in Redis
BLOCK_BOTS_FAKE_BOTS_KEY=block_bot:fake_bots // key for fake bots in Redis
BLOCK_BOTS_PENDING_BOTS_KEY=block_bot:pending_bots // key for pending bots in Redis
BLOCK_BOTS_LOG_ENABLED=true // Enables log

Usage

It's simple. Go to Kernel.php and add to the $routeMiddleware block as :

protected $routeMiddleware = [
        ...
        'block' => \Potelo\LaravelBlockBots\Middleware\BlockBots::class,
    ];

Than you can put in the desired groups. For exemple, lets set to the Wrb group:


 protected $middlewareGroups = [
        'web' => [
            ...
            \App\Http\Middleware\VerifyCsrfToken::class,
            'block:100,daily', // 100 requests per day.
        ],

Where:

  • 100: is the number of pages an IP can access every day
  • daily: is the time period. Options: hourly,daily, weekly, monthly, annually

Change log

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Credits

License

The MIT License (MIT). Please see License File for more information.