doc: add simple install guide

diff --git a/doc/userguide/Makefile.am b/doc/userguide/Makefile.am
index ab89a2bd319f28db2bb93c4a5dee86d5e2552aa2..56c375db8f6ee8134dfa3d4de17f3051856ad775 100644 (file)
--- a/doc/userguide/Makefile.am
+++ b/doc/userguide/Makefile.am
@@ -1,6 +1,7 @@
 EXTRA_DIST = \
        conf.py \
        index.rst \
+       install.rst \
        acknowledgements.rst \
        oinkmaster.rst \
        command-line-options.rst \

diff --git a/doc/userguide/index.rst b/doc/userguide/index.rst
index 6654f8da0bbf47acfe1c53d5f0bc3e481e759cbb..85b792f154f049f11f7790e14a8a7dc5a0a80dc7 100644 (file)
--- a/doc/userguide/index.rst
+++ b/doc/userguide/index.rst
@@ -6,6 +6,7 @@ Suricata User Guide
    :titlesonly:
 
    what-is-suricata
+   install.rst
    command-line-options
    rules/index.rst
    oinkmaster

diff --git a/doc/userguide/install.rst b/doc/userguide/install.rst
new file mode 100644 (file)
index 0000000..5049c69
--- /dev/null
+++ b/doc/userguide/install.rst
@@ -0,0 +1,133 @@
+Installation
+============
+
+Before Suricata can be used it has to be installed. Suricata can be installed
+on various distributions using binary packages: :ref:`install-binary-packages`.
+
+For people familiar with compiling their own software, the Source method is
+recommended.
+
+Advanced users can check the advanced guides, see :ref:`install-advanced`.
+
+Source
+------
+
+Installing from the source distribution files gives the most control over the Suricata installation.
+
+Basic steps::
+
+    tar xzvf suricata-3.2beta1.tar.gz
+    cd suricata-3.2beta1
+    ./configure
+    make
+    make install
+
+This will install Suricata into ``/usr/local/bin/``, use the default
+configuration in ``/usr/local/etc/suricata/`` and will output to
+``/usr/local/var/log/suricata``
+
+
+Common configure options
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. option:: --disable-gccmarch-native
+
+    Do not optimize the binary for the hardware it is built on. Add this 
+    flag if the binary is meant to be portable or if Suricata is to be used in a VM.
+
+.. option:: --prefix=/usr/
+
+    Installs the Suricata binary into /usr/bin/. Default ``/usr/local/``
+
+.. option:: --sysconfdir=/etc
+
+    Installs the Suricata configuration files into /etc/suricata/. Default ``/usr/local/etc/``
+
+.. option:: --localstatedir=/var
+
+    Setups Suricata for logging into /var/log/suricata/. Default ``/usr/local/var/log/suricata``
+
+.. option:: --enable-lua
+
+    Enables Lua support for detection and output.
+
+.. option:: --enable-geopip
+
+    Enables GeoIP support for detection.
+
+
+Dependencies
+^^^^^^^^^^^^
+
+For Suricata's compilation you'll need the following libraries and their development headers installed:
+
+  libpcap, libpcre, libmagic, zlib, libyaml
+
+The following tools are required:
+
+  make gcc (or clang) pkg-config
+
+Ubuntu/Debian
+"""""""""""""
+
+::
+
+    sudo apt-get install libpcre3 libpcre3-dbg libpcre3-dev build-essential libpcap-dev   \
+                         libnet1-dev libyaml-0-2 libyaml-dev pkg-config zlib1g zlib1g-dev \
+                         libcap-ng-dev libcap-ng0 make libmagic-dev libjansson-dev
+
+
+.. _install-binary-packages:
+
+Binary packages
+---------------
+
+Ubuntu
+^^^^^^
+
+For Ubuntu, the OISF maintains a PPA ``suricata-stable`` that is always contains the latest stable release.
+
+To use it::
+
+    sudo add-apt-repository ppa:oisf/suricata-stable
+    sudo apt-get update
+    sudo sudo apt-get install suricata
+
+Debian
+^^^^^^
+
+In Debian Jessie Suricata is out of date, but an updated version is in Debian Backports.
+
+As root do::
+
+    echo "deb http://http.debian.net/debian jessie-backports main" > \
+        /etc/apt/sources.list.d/backports.list
+    apt-get update
+    apt-get install suricata -t jessie-backports
+
+Fedora
+^^^^^^
+
+::
+
+    dnf install suricata
+
+RHEL/CentOS
+^^^^^^^^^^^
+
+For RedHat Enterprise Linux 7 and CentOS 7 the EPEL repository can be used.
+
+::
+
+    yum install epel-release
+    yum install suricata
+
+
+.. _install-advanced:
+
+Advanced Installation
+---------------------
+
+Various installation guides for installing from GIT and for other operating systems are maintained at:
+https://redmine.openinfosecfoundation.org/projects/suricata/wiki/Suricata_Installation
+