update project description Signed-off-by: maximeblanc <maximeblanc@flexcb.fr> |
||
|---|---|---|
| LICENSE | ||
| README.md | ||
Flex Catch Bot
English
Flex Catch Bot is a lightweight, modular, open-source solution to detect, trap, and analyze web crawlers and headless bots without impacting legitimate users.
Features
- Easy integration via a JavaScript snippet (
init.js) included on your pages. - A PHP backend (
setup.phpand trap scripts) to deploy invisible honeypots and handle logging. - Automatic setup creates a dedicated trap directory with multiple files (trap pages, robots.txt, logging endpoints).
- Basic fingerprinting (IP, User-Agent, behavior) and bot interaction detection.
- Fully open source under the AGPLv3 only license.
- Framework-agnostic, suitable for PHP and static websites.
Installation
- Upload the PHP setup file (
setup.php) to your website root. - Include the JavaScript snippet (
init.js) on pages to protect. - Run the setup script once (via HTTP POST) to generate trap files and directories.
- Monitor logs and adapt configurations as needed.
License
This project is licensed under the GNU Affero General Public License version 3 only (AGPLv3 only).
If you modify and run this software as a network service, you must disclose the source code.
See LICENSE for details.
Français
Flex Catch Bot est une solution légère, modulaire et open source pour détecter, piéger et analyser les crawlers et bots headless sans impacter les utilisateurs légitimes.
Fonctionnalités
- Intégration simple via un snippet JavaScript (
init.js) à inclure sur vos pages. - Backend PHP (
setup.phpet scripts pièges) pour déployer des honeypots invisibles et gérer la journalisation. - Le script d’installation crée automatiquement un dossier piège contenant plusieurs fichiers (pages pièges, robots.txt, endpoints de logs).
- Fingerprinting basique (IP, User-Agent, comportement) et détection d’interactions bots.
- Sous licence AGPLv3 only.
- Indépendant de tout framework, compatible PHP et sites statiques.
Installation
- Déposez le fichier PHP d’installation (
setup.php) à la racine de votre site. - Intégrez le snippet JavaScript (
init.js) sur les pages à protéger. - Lancez le script d’installation une fois (via requête POST HTTP) pour générer les fichiers et dossiers pièges.
- Surveillez les logs et ajustez la configuration selon besoin.
Licence
Ce projet est sous licence GNU Affero General Public License version 3 uniquement (AGPLv3 only).
Si vous modifiez et exécutez ce logiciel en tant que service réseau, vous devez rendre le code source accessible.
Voir le fichier LICENSE pour plus de détails.
Contribution / Contact
Contributions are welcome! Fork and submit pull requests.
For commercial licensing or SaaS inquiries, contact: [maximeblanc@flexcb.fr]