devguide: add page on installing suricata from git

As part of the process of moving documentation from redmine
to "Read the Docs", this commit moves installing Suricata using git
page from redmine wiki into Suricata Developer Guide section.
It also updates the necessary steps.

Ticket: #5585

diff --git a/doc/userguide/devguide/codebase/index.rst b/doc/userguide/devguide/codebase/index.rst
index 392f367a85752030f7ca044e365c85560acf4501..f6cb95592cc71eaf780819d6b398d4ecc2e5802a 100644 (file)
--- a/doc/userguide/devguide/codebase/index.rst
+++ b/doc/userguide/devguide/codebase/index.rst
@@ -5,6 +5,7 @@ Working with the Codebase
    :maxdepth: 2
 
    contributing/index.rst
+   installation-from-git
    code-style
    fuzz-testing
    testing

diff --git a/doc/userguide/devguide/codebase/installation-from-git.rst b/doc/userguide/devguide/codebase/installation-from-git.rst
new file mode 100644 (file)
index 0000000..503ecd3
--- /dev/null
+++ b/doc/userguide/devguide/codebase/installation-from-git.rst
@@ -0,0 +1,148 @@
+Installation from GIT
+=====================
+
+Ubuntu Installation from GIT
+----------------------------
+
+This document will explain how to install and use the most recent code of
+Suricata on Ubuntu. Installing from GIT on other operating systems is
+basically the same, except that some commands are Ubuntu-specific
+(like sudo and apt-get). In case you are using another operating system,
+you should replace those commands with your OS-specific commands.
+
+Pre-installation requirements
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Before you can build Suricata for your system, run the following command
+to ensure that you have everything you need for the installation.
+
+.. code-block:: bash
+
+  sudo apt-get -y install libpcre2-dev build-essential autoconf \
+  automake libtool libpcap-dev libnet1-dev libyaml-0-2 libyaml-dev \
+  pkg-config zlib1g zlib1g-dev libcap-ng-dev libcap-ng0 make \
+  libmagic-dev libjansson-dev rustc cargo jq git-core
+
+Add ``${HOME}/.cargo/bin`` to your path:
+
+.. code-block:: bash
+
+  export PATH=$PATH:${HOME}/.cargo/bin
+  cargo install --force cbindgen
+
+Depending on the current status of your system, it may take a while to
+complete this process.
+
+**IPS**
+
+By default, Suricata works as an IDS. If you want to use it as an IDS and IPS
+program, enter:
+
+.. code-block:: bash
+
+  sudo apt-get -y install libnetfilter-queue-dev libnetfilter-queue1 \
+  libnfnetlink-dev libnfnetlink0
+
+Suricata
+~~~~~~~~
+
+First, it is convenient to create a directory for Suricata.
+Name it 'suricata' or 'oisf', for example. Open the terminal and enter:
+
+.. code-block:: bash
+
+  mkdir suricata  # mkdir oisf
+
+Followed by:
+
+.. code-block:: bash
+
+  cd suricata  # cd oisf
+
+Next, enter the following line in the terminal:
+
+.. code-block:: bash
+
+  git clone https://github.com/OISF/suricata.git
+  cd suricata
+
+Libhtp and suricata-update are not bundled. Get them by doing:
+
+.. code-block:: bash
+
+  ./scripts/bundle.sh
+
+Followed by:
+
+.. code-block:: bash
+
+  ./autogen.sh
+
+To configure, please enter:
+
+.. code-block:: bash
+
+  ./configure
+
+To compile, please enter:
+
+.. code-block:: bash
+
+  make
+
+To install Suricata, enter:
+
+.. code-block:: bash
+
+  sudo make install
+  sudo ldconfig
+
+Auto-setup
+~~~~~~~~~~
+
+You can also use the available auto-setup features of Suricata. Ex:
+
+.. code-block:: bash
+
+  ./configure && make && sudo make install-conf
+
+*make install-conf*
+would do the regular "make install" and then it would automatically
+create/setup all the necessary directories and ``suricata.yaml`` for you.
+
+.. code-block:: bash
+
+  ./configure && make && make install-rules
+
+*make install-rules*
+would do the regular "make install" and then it would automatically download
+and set-up the latest ruleset from Emerging Threats available for Suricata.
+
+.. code-block:: bash
+
+  ./configure && make && make install-full
+
+*make install-full*
+would combine everything mentioned above (install-conf and install-rules) -
+and will present you with a ready to run (configured and set-up) Suricata.
+
+Post installation
+~~~~~~~~~~~~~~~~~
+
+Please continue with :ref:`Basic setup`.
+
+In case you have already created your Suricata directory and cloned the
+repository in it, if you want to update your local repository with the
+most recent code, please run:
+
+.. code-block:: bash
+
+  cd suricata/suricata
+
+next, enter:
+
+.. code-block:: bash
+
+  git pull
+
+After that, you should run *./autogen.sh* again.

diff --git a/doc/userguide/quickstart.rst b/doc/userguide/quickstart.rst
index 883de6c07fd9f6de41310f491bddf5ce441ed5d9..b96c9fd52f274f425632e0c868d96684177b58da 100644 (file)
--- a/doc/userguide/quickstart.rst
+++ b/doc/userguide/quickstart.rst
@@ -29,6 +29,8 @@ running and with what options as well as the service state::
     sudo suricata --build-info
     sudo systemctl status suricata
 
+.. _Basic setup:
+
 Basic setup
 -----------