coliving/laravel-block-bots

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

Block bots and high traffic offenders using Redis. This is forked from Potelo/laravel-block-bots to make it support Laravel 10

v1.0.0 2023-07-17 07:32 UTC

Requires

• php: ^7.1 || ^8.0 || ^8.1
• ext-json: *
• guzzlehttp/guzzle: ^7.5.0
• laravel/framework: ^5.5|^6.0|^7.0|^8.0|^9.0|^10.0
• predis/predis: ^1.1

Requires (Dev)

• orchestra/testbench: ^7.0
• phpunit/phpunit: ^9.5

Unknown License

• Dzung Nguyen

README

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. (This is forked from Potelo/laravel-block-bots to make it support Laravel 10.)

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 coliving/laravel-block-bots

Requirement

• This package rely on heavly on Redis. To use it, make sure that Redis is configured and ready. (see Laravel Redis Configuration)

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

• Potelo

License

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