https://github.com/keslerm/kirby-block-ai

Simple Kirby plugin that blocks AI crawlers by UserAgent
https://github.com/keslerm/kirby-block-ai

Last synced: about 1 month ago
JSON representation

Simple Kirby plugin that blocks AI crawlers by UserAgent

• Host: GitHub
• URL: https://github.com/keslerm/kirby-block-ai
• Owner: keslerm
• License: mit
• Created: 2024-06-24T14:35:02.000Z (6 months ago)
• Default Branch: master
• Last Pushed: 2024-10-24T20:09:12.000Z (about 2 months ago)
• Last Synced: 2024-10-26T07:14:26.609Z (about 2 months ago)
• Language: PHP
• Homepage:
• Size: 8.79 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Block AI: Block known AI crawlers and bots

This is a very simple plugin to block known AI crawlers from accessing content on your site. It will return a 402 Payment 

Required status code to any that it finds.

The agent list comes from the [ai.robots.txt](https://github.com/ai-robots-txt/ai.robots.txt) repository.

## Installation

### Download

Download and copy this repository to `/site/plugins/kirby-block-ai`.

### Git submodule

```

git submodule add https://github.com/keslerm/kirby-block-ai.git site/plugins/kirby-block-ai

```

### Composer

```

composer require keslerm/kirby-block-ai

```

## Setup

Works out of the box but you can customize it to configure specific response codes and text:

```

return [

    'keslerm.block-ai.response_code' => 403,

    'keslerm.block-ai.response_text' => "Go away"

]

```

## Options

* response_code - Change the HTTP response code

* response_text - Change the response text

* agents - A list of user agents to block.

## License

MIT

## Credits

- [keslerm](https://github.com/keslerm)