INDEX / DOCUMENTATION

Documentation

Everything you need to parse access logs, cluster the IPs into CIDR ranges, and - if that is why you are here - turn the result into a ban list. New here? Start with the Introduction, then run your first analysis with the Quick Start.

Getting Started

Learn how to install and use flokbn for IP clustering and blacklist generation

Introduction
Installation
Quick Start

Guides

Walkthrough guides for static analysis, live protection, the Docker test and demo stacks, and IP clustering

Static Analysis
Complex Static Analysis
Live Protection
Docker Test & Demo Stacks

Reference

Authoritative reference for CLI flags, TOML configuration, log formats, clustering, filtering, and output formats

CLI Flags
Config File
Log Formats
Clustering
Filtering
Output Formats

Architecture

Deep dive into flokbn internals, performance optimization, and scaling

Internals
Performance

Contributing

Get started contributing to the flokbn open-source project

Developer Guide
Documentation

Docs