From cd37b24237517209ac97e87edf24feebc2398665 Mon Sep 17 00:00:00 2001 From: Jason Ish Date: Wed, 30 Nov 2022 09:29:48 -0600 Subject: [PATCH] doc: now bundled with all versions of Suricata Also recommend its best installed as bundled with Suricata. --- doc/quickstart.rst | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/doc/quickstart.rst b/doc/quickstart.rst index 0f17a7b..012b4e3 100644 --- a/doc/quickstart.rst +++ b/doc/quickstart.rst @@ -4,20 +4,23 @@ Quick Start Install Suricata Update ======================= -.. note:: If you have already installed Suricata 4.1 or newer you - likely already have Suricata-Update installed. Please check - if the ``suricata-update`` command is available to you - before installing. +Suricata-Update is bundled with all supported versions of Suricata and +should be installed when Suricata is installed. Please check if +``suricata-update`` is already installed before proceeding with these +installation directions, for example, the following command will tell +you the version:: + + suricata-update -V + +You should only need to install Suricata-Update manually if it is +required independently of a Suricata install. Suricata-Update is a tool written in Python and best installed with the ``pip`` tool for installing Python packages. Pip can install ``suricata-update`` globally making it available to all users or it can install ``suricata-update`` into your home -directory for use by your user. - -.. note:: At some point ``suricata-update`` should be bundled with - Suricata avoid the need for a separate installation. +directory. To install ``suricata-update`` globally:: @@ -27,6 +30,12 @@ or to install it to your own directory:: pip install --user --upgrade suricata-update +Pip can also be used to install the latest development version of +Suricata-Update:: + + pip install --user --upgrade \ + https://github.com/oisf/suricata-update/archive/master.zip + .. note:: When installing to your home directory the ``suricata-update`` program will be installed to $HOME/.local/bin, so make sure this directory is in your -- 2.47.3