From b0c329da04d7fb4ca288b88e03fe86ebc484750a Mon Sep 17 00:00:00 2001 From: Jason Ish Date: Mon, 13 Mar 2023 16:47:14 -0600 Subject: [PATCH] doc/userguide: provide more RPM doc - Address the various RPM distributions - User info - Systemd info Related issue: #5884 --- doc/userguide/install.rst | 77 +++++++++++++++++++++++++++++++++------ 1 file changed, 65 insertions(+), 12 deletions(-) diff --git a/doc/userguide/install.rst b/doc/userguide/install.rst index e240908e73..6549d3aa36 100644 --- a/doc/userguide/install.rst +++ b/doc/userguide/install.rst @@ -150,27 +150,80 @@ For Debian 10 (buster), for instance, run the following as ``root``:: apt-get update apt-get install suricata -t buster-backports -Fedora -^^^^^^ +CentOS, AlmaLinux, RockyLinux, Fedora, etc +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +RPMs are provided for the latest release of *Enterprise Linux*. This +includes CentOS Linux and rebuilds such as AlmaLinux and RockyLinux. +Additionally, RPMs are provided for the latest supported versions of Fedora. + +RPMs specifically for CentOS Stream are not provided, however the RPMs for their +related version may work fine. + +Installing From Package Repositories +"""""""""""""""""""""""""""""""""""" + +CentOS, RHEL, AlmaLinux, RockyLinux, etc Version 8+ +''''''''''''''''''''''''''''''''''''''''''''''''''' -The following is an example of installing Suricata 6.0 on Fedora. If you wish to install 5.0 instead, change the version in *@oisf/suricata-6.0*. +.. code-block:: none -:: + dnf install epel-release dnf-plugins-core + dnf copr enable @oisf/suricata-7.0 + dnf install suricata + +CentOS 7 +'''''''' + +.. code-block:: none + + yum install epel-release yum-plugin-copr + yum copr enable @oisf/suricata-7.0 + yum install suricata + +Fedora +'''''' + +.. code-block:: none dnf install dnf-plugins-core - dnf copr enable @oisf/suricata-6.0 + dnf copr enable @oisf/suricata-7.0 dnf install suricata -RHEL/CentOS 8 and 7 -^^^^^^^^^^^^^^^^^^^ +Additional Notes for RPM Installations +"""""""""""""""""""""""""""""""""""""" + +- Suricata is pre-configured to run as the ``suricata`` user. +- Command line parameters such as providing the interface names can be + configured in ``/etc/sysconfig/suricata``. +- Users can run ``suricata-update`` without being root provided they + are added to the ``suricata`` group. +- Directories: + + - ``/etc/suricata``: Configuration directory + - ``/var/log/suricata``: Log directory + - ``/var/lib/suricata``: State directory rules, datasets. + +Starting Suricata On-Boot +''''''''''''''''''''''''' + +The Suricata RPMs are configured to run from Systemd. + +To start Suricata:: + + systemctl start suricata + +To stop Suricata:: + + systemctl stop suricata + +To have Suricata start on-boot:: -The following is an example of installing Suricata 6.0 on CentOS. If you wish to install 5.0 instead, change the version in *@oisf/suricata-6.0*. + systemctl enable suricata -:: +To reload rules:: - yum install epel-release yum-plugin-copr - yum copr enable @oisf/suricata-6.0 - yum install suricata + systemctl reload suricata .. _install-advanced: -- 2.47.2