From f715b0ae6b4ad512936007372e56b7ab2c76b006 Mon Sep 17 00:00:00 2001 From: Jason Ish Date: Mon, 17 Jul 2017 15:07:27 -0600 Subject: [PATCH] doc: add pid-file section to suricata.yaml doc Redmine issue: https://redmine.openinfosecfoundation.org/issues/2104 --- doc/userguide/configuration/suricata-yaml.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/userguide/configuration/suricata-yaml.rst b/doc/userguide/configuration/suricata-yaml.rst index 1b5e9cce58..265952e62d 100644 --- a/doc/userguide/configuration/suricata-yaml.rst +++ b/doc/userguide/configuration/suricata-yaml.rst @@ -66,6 +66,24 @@ It is possible to set the user and group to run Suricata as: group: suri +PID File +-------- + +This option sets the name of the PID file when Suricata is run in +daemon mode. This file records the Suricata process ID. + +:: + + pid-file: /var/run/suricata.pid + +.. note:: This configuration file option only sets the PID file when + running in daemon mode. To force creation of a PID file when + not running in daemon mode, use the :option:`--pidfile` + command line option. + + Also, if running more than one Suricata process, each + process will need to specify a different pid-file location. + .. _suricata-yaml-action-order: Action-order