diff --git a/doc/userguide/configuration/suricata-yaml.rst b/doc/userguide/configuration/suricata-yaml.rst index 88d266a0dc..8137ce3ab0 100644 --- a/doc/userguide/configuration/suricata-yaml.rst +++ b/doc/userguide/configuration/suricata-yaml.rst @@ -2805,6 +2805,29 @@ use of. vista: [] windows2k3: [] +Suricata as a Firewall options (experimental) +--------------------------------------------- + +It is possible to run Suricata as a firewall. +Please read :ref:`Firewall Mode Design ` before using this. +The existing yaml configuration options are listed below. If the engine is run +in firewall mode, dedicated stats counters will be added to the stats logs. + +To see the stats counters reported for the firewall, refer to :ref:`firewall mode stats`. + + firewall: + # toggle to enable firewall mode + #enabled: no + # Firewall rule file are in their own path and are not managed + # by Suricata-Update. + #rule-path: /etc/suricata/firewall/ + + # List of files with firewall rules. Order matters, files are loaded + # in order and rules are applied in that order (per state, see docs) + #rule-files: + # - firewall.rules + + Engine analysis and profiling -----------------------------