From 3cb9bcbcf3ad330dde84c85c31aad63975160e2f Mon Sep 17 00:00:00 2001 From: d3m0k1d Date: Wed, 14 Jan 2026 15:32:26 +0300 Subject: [PATCH] docs(README.md): update docs for first realease version --- README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6d77258..7cb8273 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # BanForge -Log-based IPS system written in Go for Linux based system. +Log-based IPS system written in Go for Linux-based system. # Table of contents 1. [Overview](#overview) @@ -12,24 +12,38 @@ Log-based IPS system written in Go for Linux based system. # Overview BanForge is a simple IPS for replacement fail2ban in Linux system. The project is currently in its early stages of development. -All release are available on my self-hosted [Gitea](https://gitea.d3m0k1d.ru/d3m0k1d/BanForge) because Github have limit for Actions. +All release are available on my self-hosted [Gitea](https://gitea.d3m0k1d.ru/d3m0k1d/BanForge) because Github has limits for Actions. If you have any questions or suggestions, create issue on [Github](https://github.com/d3m0k1d/BanForge/issues). ## Roadmap -- [ ] Real-time Nginx log monitoring +- [x] Real-time Nginx log monitoring - [ ] Add support for other service - [ ] Add support for user service with regular expressions - [ ] TUI interface # Requirements -- Go 1.21+ +- Go 1.25+ - ufw/iptables/nftables/firewalld # Installation -currently no binary file if you wanna build the project yourself, you can use [Makefile](https://github.com/d3m0k1d/BanForge/blob/master/Makefile) +Search for a release on the [Gitea](https://gitea.d3m0k1d.ru/d3m0k1d/BanForge/releases) releases page and download it. Then create or copy a systemd unit file. +Or clone the repo and use the Makefile. +``` +git clone https://gitea.d3m0k1d.ru/d3m0k1d/BanForge.git +cd BanForge +sudo make build-daemon +cd bin +``` # Usage +```bash +banforge init # Create config files and database +banforge daemon # Start BanForge daemon (use systemd or another init system to create a service) +``` +You can edit the config file with examples in +- `/etc/banforge/config.toml` main config file +- `/etc/banforge/rules.toml` ban rules # License The project is licensed under the [GPL-3.0](https://github.com/d3m0k1d/BanForge/blob/master/LICENSE)