]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
doc: update unix socket
authorVictor Julien <victor@inliniac.net>
Thu, 15 Dec 2016 14:10:30 +0000 (15:10 +0100)
committerVictor Julien <victor@inliniac.net>
Thu, 16 Feb 2017 09:35:44 +0000 (10:35 +0100)
doc/userguide/unix-socket.rst

index 2a4849ddf59d3440e0ebd73969589dfb0c16616c..be7546c7dd4a72b10861cee7c51bec75e63b8f0e 100644 (file)
@@ -4,14 +4,14 @@ Interacting via Unix Socket
 Introduction
 ------------
 
-Since 1.4 version, Suricata can listen to a unix socket and accept
-commands from the user. The exchange protocol is JSON-based and the
-format of the message has been done to be generic and it is described
-in this commit message. An example script called suricatasc is
-provided in the source and installed automatically when updating
-Suricata.
+Suricata can listen to a unix socket and accept commands from the user. The
+exchange protocol is JSON-based and the format of the message has been done
+to be generic.
 
-The unix socket is disabled by default. 
+An example script called suricatasc is provided in the source and installed
+automatically when installing/updating Suricata.
+
+The unix socket is enabled by default if libjansson is available.
 
 You need to have libjansson installed:
   
@@ -19,15 +19,14 @@ You need to have libjansson installed:
 * libjansson-dev - C library for encoding, decoding and manipulating JSON data (dev)
 * python-simplejson - simple, fast, extensible JSON encoder/decoder for Python
   
-::
+Debian/Ubuntu::
   
    apt-get install libjansson4 libjansson-dev python-simplejson
 
 If libjansson is present on the system , unix socket will be compiled
-in automatically - when you use "--enable-unix-socket" in your
-configure line.
+in automatically.
 
-The creation of the socket is activated by setting enabled to yes
+The creation of the socket is managed by setting enabled to 'yes' or 'auto'
 under unix-command in Suricata YAML configuration file:
   
 ::