Files
BanForge/docs/config.md
d3m0k1d 4e80b5148d
All checks were successful
CD - BanForge Release / release (push) Successful in 3m23s
docs: add new docs
2026-01-20 21:14:07 +03:00

1.4 KiB

Configs

config.toml

Main configuration file for BanForge.

Example:

[firewall]
  name = "nftables"
  config = "/etc/nftables.conf"

[[service]]
  name = "nginx"
  logging = "file"
  log_path = "/home/d3m0k1d/test.log"
  enabled = true

[[service]]
  name = "nginx"
  logging = "journald"
  log_path = "nginx"
  enabled = false

Description The [firewall] section defines firewall parameters. The banforge init command automatically detects your installed firewall (nftables, iptables, ufw, firewalld). For firewalls that require a configuration file, specify the path in the config parameter.

The service section is configured manually. Currently, only nginx is supported. To add a service, create a service block and specify the log_path to the nginx log file you want to monitor. logging require in format "file" or "journald" if you use journald logging, log_path require in format "service_name"

rules.toml

Rules configuration file for BanForge.

If you wanna configure rules by cli command see here

Example:

[[rule]]
  name = "304 http"
  service = "nginx"
  path = ""
  status = "304"
  method = ""
  ban_time = "1m"

Description The rule section require name and one of the following parameters: service, path, status, method. To add a rule, create a rule block and specify the parameters. ban_time require in format "1m", "1h", "1d", "1M", "1y"