From: Daniel Olatunji Date: Wed, 11 Oct 2023 21:42:47 +0000 (+0000) Subject: doc: be consistent with the use of "sudo" X-Git-Tag: suricata-7.0.3~106 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0e5fdbb8fb919e06988cdae8737214d304287d36;p=thirdparty%2Fsuricata.git doc: be consistent with the use of "sudo" Issue: #5720 --- diff --git a/doc/userguide/install.rst b/doc/userguide/install.rst index ad7a9e4474..5c28aef020 100644 --- a/doc/userguide/install.rst +++ b/doc/userguide/install.rst @@ -90,18 +90,20 @@ Rust support:: Ubuntu/Debian """"""""""""" +.. note:: The following instructions require ``sudo`` to be installed. + Minimal:: # Installed Rust and cargo as indicated above - apt-get install build-essential git libjansson-dev libpcap-dev \ + sudo apt-get install build-essential git libjansson-dev libpcap-dev \ libpcre2-dev libtool libyaml-dev make pkg-config zlib1g-dev # On most distros installing cbindgen with package manager should be enough - apt-get install cbindgen # alternative: cargo install --force cbindgen + sudo apt-get install cbindgen # alternative: cargo install --force cbindgen Recommended:: # Installed Rust and cargo as indicated above - apt-get install autoconf automake build-essential ccache clang curl git \ + sudo apt-get install autoconf automake build-essential ccache clang curl git \ gosu jq libbpf-dev libcap-ng0 libcap-ng-dev libelf-dev \ libevent-dev libgeoip-dev libhiredis-dev libjansson-dev \ liblua5.1-dev libmagic-dev libnet1-dev libpcap-dev \ @@ -112,39 +114,41 @@ Recommended:: Extra for iptables/nftables IPS integration:: - apt-get install libnetfilter-queue-dev libnetfilter-queue1 \ + sudo apt-get install libnetfilter-queue-dev libnetfilter-queue1 \ libnetfilter-log-dev libnetfilter-log1 \ libnfnetlink-dev libnfnetlink0 CentOS, AlmaLinux, RockyLinux, Fedora, etc """""""""""""""""""""""""""""""""""""""""" +.. note:: The following instructions require ``sudo`` to be installed. + To install all minimal dependencies, it is required to enable extra package repository in most distros. You can enable it possibly by one of the following ways:: - dnf -y update - dnf -y install dnf-plugins-core + sudo dnf -y update + sudo dnf -y install dnf-plugins-core # AlmaLinux 8 - dnf config-manager --set-enabled powertools + sudo dnf config-manager --set-enabled powertools # AlmaLinux 9 - dnf config-manager --set-enable crb + sudo dnf config-manager --set-enable crb # Oracle Linux 8 - dnf config-manager --set-enable ol8_codeready_builder + sudo dnf config-manager --set-enable ol8_codeready_builder # Oracle Linux 9 - dnf config-manager --set-enable ol9_codeready_builder + sudo dnf config-manager --set-enable ol9_codeready_builder Minimal:: # Installed Rust and cargo as indicated above - dnf install -y gcc gcc-c++ git jansson-devel libpcap-devel libtool \ + sudo dnf install -y gcc gcc-c++ git jansson-devel libpcap-devel libtool \ libyaml-devel make pcre2-devel which zlib-devel cargo install --force cbindgen Recommended:: # Installed Rust and cargo as indicated above - dnf install -y autoconf automake diffutils file-devel gcc gcc-c++ git \ + sudo dnf install -y autoconf automake diffutils file-devel gcc gcc-c++ git \ jansson-devel jq libcap-ng-devel libevent-devel \ libmaxminddb-devel libnet-devel libnetfilter_queue-devel \ libnfnetlink-devel libpcap-devel libtool libyaml-devel \ @@ -202,6 +206,8 @@ Ubuntu from Personal Package Archives (PPA) For Ubuntu, OISF maintains a 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 @@ -236,6 +242,8 @@ To remove Suricata from your system:: 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:: @@ -256,6 +264,8 @@ Suricata will then always be the latest release, stable or 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``:: @@ -281,6 +291,8 @@ repository, the same procedures as above apply, just using another PPA, Debian ^^^^^^ +.. note:: The following instructions require ``sudo`` to be installed. + In Debian 9 (stretch) and later do:: sudo apt-get install suricata @@ -314,29 +326,31 @@ Installing From Package Repositories CentOS, RHEL, AlmaLinux, RockyLinux, etc Version 8+ ''''''''''''''''''''''''''''''''''''''''''''''''''' +.. note:: The following instructions require ``sudo`` to be installed. + .. code-block:: none - dnf install epel-release dnf-plugins-core - dnf copr enable @oisf/suricata-7.0 - dnf install suricata + 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 - yum install epel-release yum-plugin-copr - yum copr enable @oisf/suricata-7.0 - yum install suricata + sudo yum install epel-release yum-plugin-copr + sudo yum copr enable @oisf/suricata-7.0 + sudo yum install suricata Fedora '''''' .. code-block:: none - dnf install dnf-plugins-core - dnf copr enable @oisf/suricata-7.0 - dnf install suricata + sudo dnf install dnf-plugins-core + sudo dnf copr enable @oisf/suricata-7.0 + sudo dnf install suricata Additional Notes for RPM Installations """""""""""""""""""""""""""""""""""""" @@ -357,21 +371,23 @@ 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:: - systemctl start suricata + sudo systemctl start suricata To stop Suricata:: - systemctl stop suricata + sudo systemctl stop suricata To have Suricata start on-boot:: - systemctl enable suricata + sudo systemctl enable suricata To reload rules:: - systemctl reload suricata + sudo systemctl reload suricata .. _install-advanced: