mirror of https://github.com/OISF/suricata
doc/userguide: document include files
Document how to use include files, plus add a deprecation notice on the use of multiple "include" statements.pull/8945/head
parent
a71dee5516
commit
5af73b3879
@ -0,0 +1,56 @@
|
||||
.. _includes:
|
||||
|
||||
Includes
|
||||
========
|
||||
|
||||
A Suricata configuration file (typically
|
||||
``/etc/suricata/suricata.yaml``) may include other files allowing a
|
||||
configuration file to be broken into multiple files. The *special*
|
||||
field name ``include`` is used to include one or more files.
|
||||
|
||||
The contents of the *include* file are inlined at the level of the
|
||||
``include`` statement. *Include* fields may also be included at any
|
||||
level within a mapping.
|
||||
|
||||
Including a Single File
|
||||
-----------------------
|
||||
|
||||
::
|
||||
|
||||
include: filename.yaml
|
||||
|
||||
Including Multiple Files
|
||||
------------------------
|
||||
|
||||
::
|
||||
|
||||
include:
|
||||
- filename1.yaml
|
||||
- filename2.yaml
|
||||
|
||||
Include Inside a Mapping
|
||||
------------------------
|
||||
|
||||
::
|
||||
|
||||
vars:
|
||||
address-groups:
|
||||
include: address-groups.yaml
|
||||
|
||||
where ``address-groups.yaml`` contains::
|
||||
|
||||
%YAML 1.1
|
||||
---
|
||||
HOME_NET: "[192.168.0.0/16,10.0.0.0/8,172.16.0.0/12]"
|
||||
|
||||
is the equivalent of::
|
||||
|
||||
vars:
|
||||
address-groups:
|
||||
HOME_NET: "[192.168.0.0/16,10.0.0.0/8,172.16.0.0/12]"
|
||||
|
||||
.. note:: Suricata versions less than 7 required multiple ``include``
|
||||
statements to be specified to include more than one file. While
|
||||
Suricata 7.0 still supports this it will issue a deprecation
|
||||
warning. Suricata 8.0 will not allow multiple ``include``
|
||||
statements at the same level as this is not allowed by YAML.
|
Loading…
Reference in New Issue