mirror of https://github.com/OISF/suricata
doc/userguide: break out package installation
Break out RPM, Debian, and Ubuntu package installation into their own pages. Also break out other distributions like "Arch" into an "Other" section with a note about how those packages are not supported by the OISF. Ticket: #6252 Ticket: #6069pull/13518/head
Jason Ish
5 months ago
committed by
Victor Julien
parent
1de19ee94c
commit
8ed506659d
@ -0,0 +1,31 @@
|
||||
.. _install-binary-debian:
|
||||
|
||||
Debian Package Installation
|
||||
===========================
|
||||
|
||||
Suricata is available in the official Debian repositories for Debian 9
|
||||
(stretch) and later versions.
|
||||
|
||||
.. note:: The following instructions require ``sudo`` to be installed.
|
||||
|
||||
In Debian 9 (stretch) and later do::
|
||||
|
||||
sudo apt-get install suricata
|
||||
|
||||
In the "stable" version of Debian, Suricata is usually not available in the
|
||||
latest version. A more recent version is often available from Debian backports,
|
||||
if it can be built there.
|
||||
|
||||
To use backports, the backports repository for the current stable
|
||||
distribution needs to be added to the system-wide sources list.
|
||||
For Debian 10 (buster), for instance, run the following as ``root``::
|
||||
|
||||
echo "deb http://http.debian.net/debian buster-backports main" > \
|
||||
/etc/apt/sources.list.d/backports.list
|
||||
apt-get update
|
||||
apt-get install suricata -t buster-backports
|
||||
|
||||
After Installation
|
||||
------------------
|
||||
|
||||
After installing you can proceed to the :ref:`Basic setup`.
|
||||
@ -0,0 +1,26 @@
|
||||
.. _install-binary-other:
|
||||
|
||||
Other Package Installations
|
||||
===========================
|
||||
|
||||
Suricata can be found in the package managers for many other operating
|
||||
systems and distributions, but it is important to note that these are
|
||||
not created or supported by the OISF and the Suricata development
|
||||
team.
|
||||
|
||||
Arch Based
|
||||
----------
|
||||
|
||||
The ArchLinux AUR contains Suricata and suricata-nfqueue packages,
|
||||
with commonly used configurations for compilation (may also be edited
|
||||
to your liking). You may use makepkg, yay (sample below), or other AUR
|
||||
helpers to compile and build Suricata packages.
|
||||
|
||||
::
|
||||
|
||||
yay -S suricata
|
||||
|
||||
After Installation
|
||||
------------------
|
||||
|
||||
After installing you can proceed to the :ref:`Basic setup`.
|
||||
@ -0,0 +1,84 @@
|
||||
.. _install-binary-rpm:
|
||||
|
||||
RPM Installation
|
||||
================
|
||||
|
||||
Using the Fedora COPR system, the OISF provides Suricata packages for
|
||||
Fedora, Red Hat Enterprise Linux, and Enterprise Linux rebuilds.
|
||||
|
||||
The benefit of using the OISF maintained COPR package repositories is
|
||||
that the OISF maintains packages for all non-EOL Suricata versions for
|
||||
each distribution version. For example, the OISF maintains Suricata 7
|
||||
and Suricata 8 packages for RHEL 9 and 10.
|
||||
|
||||
Installing From Package Repositories
|
||||
------------------------------------
|
||||
|
||||
.. note:: Instructions in the following sections require ``sudo`` to
|
||||
be installed.
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
sudo dnf install epel-release dnf-plugins-core
|
||||
sudo dnf copr enable @oisf/suricata-7.0
|
||||
sudo dnf install suricata
|
||||
|
||||
CentOS 7
|
||||
^^^^^^^^
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
sudo yum install epel-release yum-plugin-copr
|
||||
sudo yum copr enable @oisf/suricata-7.0
|
||||
sudo yum install suricata
|
||||
|
||||
Fedora
|
||||
^^^^^^
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
sudo dnf install dnf-plugins-core
|
||||
sudo dnf copr enable @oisf/suricata-7.0
|
||||
sudo dnf install suricata
|
||||
|
||||
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.
|
||||
|
||||
.. note:: The following instructions require ``sudo`` to be installed.
|
||||
|
||||
To start Suricata::
|
||||
|
||||
sudo systemctl start suricata
|
||||
|
||||
To stop Suricata::
|
||||
|
||||
sudo systemctl stop suricata
|
||||
|
||||
To have Suricata start on-boot::
|
||||
|
||||
sudo systemctl enable suricata
|
||||
|
||||
To reload rules::
|
||||
|
||||
sudo systemctl reload suricata
|
||||
|
||||
After Installation
|
||||
------------------
|
||||
|
||||
After installing you can proceed to the :ref:`Basic setup`.
|
||||
@ -0,0 +1,92 @@
|
||||
.. _install-binary-ubuntu:
|
||||
|
||||
Ubuntu Package Installation
|
||||
===========================
|
||||
|
||||
For Ubuntu, the OISF maintains a Personal Package Archive (PPA)
|
||||
``suricata-stable`` that always contains the latest stable release.
|
||||
|
||||
.. note:: The following instructions require ``sudo`` to be installed.
|
||||
|
||||
Setup to install the latest stable Suricata::
|
||||
|
||||
sudo apt-get install software-properties-common
|
||||
sudo add-apt-repository ppa:oisf/suricata-stable
|
||||
sudo apt-get update
|
||||
|
||||
Then, you can install the latest stable with::
|
||||
|
||||
sudo apt-get install suricata
|
||||
|
||||
After installing you can proceed to the :ref:`Basic setup`.
|
||||
|
||||
`OISF launchpad: suricata-stable <https://launchpad.net/~oisf/+archive/suricata-stable>`_.
|
||||
|
||||
Upgrading
|
||||
^^^^^^^^^
|
||||
|
||||
To upgrade::
|
||||
|
||||
sudo apt-get update
|
||||
sudo apt-get upgrade suricata
|
||||
|
||||
Remove
|
||||
^^^^^^
|
||||
|
||||
To remove Suricata from your system::
|
||||
|
||||
sudo apt-get remove suricata
|
||||
|
||||
Getting Debug or Pre-release Versions
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. note:: The following instructions require ``sudo`` to be installed.
|
||||
|
||||
If you want Suricata with built-in (enabled) debugging, you can install the
|
||||
debug package::
|
||||
|
||||
sudo apt-get install suricata-dbg
|
||||
|
||||
If you would like to help test the Release Candidate (RC) packages, the same procedures
|
||||
apply, just using another PPA: ``suricata-beta``::
|
||||
|
||||
sudo add-apt-repository ppa:oisf/suricata-beta
|
||||
sudo apt-get update
|
||||
sudo apt-get upgrade
|
||||
|
||||
You can use both the suricata-stable and suricata-beta repositories together.
|
||||
Suricata will then always be the latest release, stable or beta.
|
||||
|
||||
`OISF launchpad: suricata-beta <https://launchpad.net/~oisf/+archive/suricata-beta>`_.
|
||||
|
||||
Daily Releases
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
.. note:: The following instructions require ``sudo`` to be installed.
|
||||
|
||||
If you would like to help test the daily build packages from our latest git(dev)
|
||||
repository, the same procedures as above apply, just using another PPA,
|
||||
``suricata-daily``::
|
||||
|
||||
sudo add-apt-repository ppa:oisf/suricata-daily-allarch
|
||||
sudo apt-get update
|
||||
sudo apt-get upgrade
|
||||
|
||||
.. note::
|
||||
|
||||
Please have in mind that this is packaged from our latest development git master
|
||||
and is therefore potentially unstable.
|
||||
|
||||
We do our best to make others aware of continuing development and items
|
||||
within the engine that are not yet complete or optimal. With this in mind,
|
||||
please refer to `Suricata's issue tracker on Redmine
|
||||
<http://redmine.openinfosecfoundation.org/projects/suricata/issues>`_
|
||||
for an up-to-date list of what we are working on, planned roadmap,
|
||||
and to report issues.
|
||||
|
||||
`OISF launchpad: suricata-daily <https://launchpad.net/~oisf/+archive/suricata-daily>`_.
|
||||
|
||||
After Installation
|
||||
------------------
|
||||
|
||||
After installing you can proceed to the :ref:`Basic setup`.
|
||||
Loading…
Reference in New Issue