]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
doc/install: use our recommended header order
authorJason Ish <jason.ish@oisf.net>
Fri, 20 Jun 2025 15:12:17 +0000 (09:12 -0600)
committerVictor Julien <victor@inliniac.net>
Sat, 21 Jun 2025 19:32:52 +0000 (21:32 +0200)
doc/userguide/install/debian.rst
doc/userguide/install/other.rst
doc/userguide/install/rpm.rst
doc/userguide/install/ubuntu.rst

index 018fec47c62fa97404f68da3b9ee80a1013b7200..424fad79a21ef9613a0ea7d65905227019414de9 100644 (file)
@@ -1,7 +1,7 @@
 .. _install-binary-debian:
 
 Debian Package Installation
-===========================
+###########################
 
 Suricata is available in the official Debian repositories for Debian 9
 (stretch) and later versions.
@@ -26,6 +26,6 @@ For Debian 10 (buster), for instance, run the following as ``root``::
     apt-get install suricata -t buster-backports
 
 After Installation
-------------------
+******************
 
 After installing you can proceed to the :ref:`Basic setup`.
index 3a33c767bebbf81cb2c57057f8b6dd5053d18b5d..0e9f8eea947789dfa0019d37ed73584e1bbf166d 100644 (file)
@@ -1,7 +1,7 @@
 .. _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
@@ -9,7 +9,7 @@ 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
@@ -21,6 +21,6 @@ helpers to compile and build Suricata packages.
     yay -S suricata
 
 After Installation
-------------------
+******************
 
 After installing you can proceed to the :ref:`Basic setup`.
index b6fd8a9b5ed53b138d2f2ea78dd34243b424718f..1ff1b0b1345be7ffa42af89d6f55877b0bbd0402 100644 (file)
@@ -1,7 +1,7 @@
 .. _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.
@@ -12,13 +12,13 @@ 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.
 
 Enterprise Linux and Rebuilds
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+=============================
 
 .. code-block:: none
 
@@ -27,7 +27,7 @@ Enterprise Linux and Rebuilds
    sudo dnf install suricata
 
 Fedora
-^^^^^^
+======
 
 .. code-block:: none
 
@@ -36,7 +36,7 @@ Fedora
     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
@@ -50,7 +50,7 @@ Additional Notes for RPM Installations
   - ``/var/lib/suricata``: State directory rules, datasets.
 
 Starting Suricata On-Boot
-^^^^^^^^^^^^^^^^^^^^^^^^^
+=========================
 
 The Suricata RPMs are configured to run from Systemd.
 
@@ -73,6 +73,6 @@ To reload rules::
   sudo systemctl reload suricata
 
 After Installation
-------------------
+******************
 
 After installing you can proceed to the :ref:`Basic setup`.
index b71809cf303531b9a39066738d2bf26570856428..3b757b9f5ac3c8957892cfc0a8f8bd281a2e919b 100644 (file)
@@ -1,7 +1,7 @@
 .. _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.
@@ -23,7 +23,7 @@ After installing you can proceed to the :ref:`Basic setup`.
 `OISF launchpad: suricata-stable <https://launchpad.net/~oisf/+archive/suricata-stable>`_.
 
 Upgrading
-^^^^^^^^^
+*********
 
 To upgrade::
 
@@ -31,14 +31,14 @@ To upgrade::
     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.
 
@@ -60,7 +60,7 @@ 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.
 
@@ -87,6 +87,6 @@ repository, the same procedures as above apply, just using another PPA,
 `OISF launchpad: suricata-daily <https://launchpad.net/~oisf/+archive/suricata-daily>`_.
 
 After Installation
-------------------
+******************
 
 After installing you can proceed to the :ref:`Basic setup`.