diff --git a/README.md b/README.md index 88a4dab..9e7e4bf 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,6 @@ A utility designed to analyze UFW logs and report IP addresses blocked by the firewall to the [AbuseIPDB](https://www.abuseipdb.com) database. To prevent excessive reporting of the same IP address within a short period, the tool uses a temporary cache file to track previously reported IP addresses. -This project was originally written in [Bash](https://github.com/sefinek/UFW-AbuseIPDB-Reporter/tree/bash) but has been rewritten in [Node.js](https://nodejs.org). All my integration tools are now written in Node, hence this change. -If you were using the old version, please [uninstall it](https://github.com/sefinek/UFW-AbuseIPDB-Reporter/tree/main?tab=readme-ov-file#%EF%B8%8F-uninstall-the-deprecated-version-if-you-have-it) as it will no longer be supported. - ⭐ If you like this repository or find it useful, I'd greatly appreciate it if you could give it a star. Many thanks! Also, check this out: [sefinek/Cloudflare-WAF-To-AbuseIPDB](https://github.com/sefinek/Cloudflare-WAF-To-AbuseIPDB) @@ -23,12 +20,14 @@ Also, check this out: [sefinek/Cloudflare-WAF-To-AbuseIPDB](https://github.com/s ## ✅ Features 1. **Easy Configuration** – The [`config.js`](config.default.js) file allows for quick and simple customization. 2. **Simple Installer** – Enables fast and seamless integration deployment. -3. **Self-IP Protection (IPv4 & IPv6)** – The script will never report an IP address belonging to you or your server, even if you use a dynamic IP. -4. **Discord Webhooks Integration**: - - Important notifications. - - Alerts for script errors. - - Daily summaries of reported IP addresses. -5. **Automatic Updates** – The script regularly fetches and applies the latest updates. If you want, you can [disable it](https://github.com/sefinek/UFW-AbuseIPDB-Reporter/blob/main/config.default.js#L13), of course. +3. **Self-IP Protection (IPv4 & IPv6)** – The script will never report IP addresses belonging to you or your server, even if you're using a dynamic IP address. +4. **Bulk Reporting Support** – If the script encounters a rate limit, it will start buffering collected IPs and send a bulk report. +5. **Local IP Filtering** – Local IP addresses will never be reported. +6. **Discord Webhooks Integration**: + - Critical notifications + - Script error alerts + - Daily summaries of reported IPs +7. **Automatic Updates** – The script regularly fetches and applies the latest updates. You can [disable this](https://github.com/sefinek/UFW-AbuseIPDB-Reporter/blob/main/config.default.js#L13) if you prefer. ## 📥 Installation (Ubuntu & Debian) @@ -79,15 +78,6 @@ pm2 save ``` -## 🗑️ Uninstall the [deprecated](https://github.com/sefinek/UFW-AbuseIPDB-Reporter/tree/bash) version if you have it -```bash -sudo systemctl stop abuseipdb-ufw.service && sudo systemctl disable abuseipdb-ufw.service -sudo rm /etc/systemd/system/abuseipdb-ufw.service -sudo systemctl daemon-reload -sudo rm -r /usr/local/bin/UFW-AbuseIPDB-Reporter -``` - - ## 🖥️ Usage After a successful installation, the script will run continuously in the background, monitoring UFW logs and automatically reporting IP addresses.