Configuring the User-Custom Packages repository¶
Note
This is an optional step. You only need it to deploy Suricata packages that you built yourself. To use the official Suricata packages, skip it: the Cluster Setup Wizard offers them.
Advanced Suricata users sometimes need their own build of Suricata: one with a feature enabled, or a bug fix, that the packages from OISF or from the operating system’s repositories don’t have yet.
IDSTower deploys such a package to the hosts of a cluster from its User-Custom Packages repository, a folder on the IDSTower server. The User-Custom repository holds Suricata packages only; Filebeat comes from the official repository or from the Built-In repository.
Build your Suricata package as a “.deb” or “.rpm” file. These blog posts walk through a complete build:
Building a Custom Suricata DEB Package, for Debian and Ubuntu.
Building a Custom Suricata RPM Package, for Rocky Linux, AlmaLinux and RHEL 9 and 10.
Give the package a version that the host’s package manager ranks above the distribution’s own Suricata, or a later upgrade on the host replaces your build:
Debian, Ubuntu, Kali and Raspberry Pi OS: give it an epoch, for example version
1:8.0.7-1. The distributions’ Suricata packages have one (Ubuntu 24.04 ships1:7.0.3), and apt ranks any version with an epoch above every version without one.RHEL family: keep the official package’s epoch (OISF’s builds have
Epoch: 1), and give it a release that sorts above the official build of the same version, for example1.el9.custom1rather than1.el9. Rebuilding OISF’s source RPM, as the blog post does, gives you both.
A host can also have a repository that carries Suricata, and that repository’s next release would replace your build on an upgrade:
Debian family: hold the package with
sudo apt-mark hold suricata. Ubuntu hosts first deployed from the official repository have such a repository: OISF’s PPA, which IDSTower adds there. IDSTower’s upgrades from the User-Custom repository still install, but they clear the hold, so set it again after an upgrade. Release it withsudo apt-mark unhold suricatabefore you remove the host or its Suricata from IDSTower, or move the host to another repository: IDSTower doesn’t override a hold, so a removal would leave the package installed.RHEL family: exclude
suricatafrom that repository, such as OISF’s Copr, as the RPM blog post shows.
On the IDSTower server, create the folder for the package and copy the package into it. The folder’s path names the Suricata version, the target host’s OS Code and the host’s architecture:
/opt/idstower/custom/Suricata/packages/<version>/<OS Code>/<architecture>/
For example, for Suricata 8.0.7 on Rocky Linux 9 hosts:
$ sudo mkdir -p /opt/idstower/custom/Suricata/packages/8.0.7/Rocky9/x86_64 $ sudo cp suricata-8.0.7-1.el9.custom1.x86_64.rpm /opt/idstower/custom/Suricata/packages/8.0.7/Rocky9/x86_64/ $ sudo chown -R idstower:idstower /opt/idstower/custom
IDSTower runs as the
idstoweruser, which must be able to read the folders and the packages.The version is the full version that your Suricata build reports, such as
8.0.7(not8.0). The wizard lists the version from this folder’s name, and after the installation IDSTower checks that each host’s Suricata reports that version.The OS Code is
{{ ansible_distribution }}{{ ansible_distribution_major_version }}, as Ansible reports it on the target host. Each host looks only in the folder for its own OS Code, so create a folder for each operating system you deploy the package to:Target host
OS Code
Rocky Linux 8, 9, 10
Rocky8,Rocky9,Rocky10AlmaLinux 8, 9, 10
AlmaLinux8,AlmaLinux9,AlmaLinux10Oracle Linux 8, 9, 10
OracleLinux8,OracleLinux9,OracleLinux10RHEL 8, 9, 10
RedHat8,RedHat9,RedHat10CentOS Stream 9, 10
CentOS9,CentOS10Debian 12 (bookworm), 13 (trixie)
Debian12,Debian13Raspberry Pi OS 64-bit
Debian13(Trixie based),Debian12(Bookworm based)Ubuntu 22.04, 24.04, 25.04, 26.04
Ubuntu22,Ubuntu24,Ubuntu25,Ubuntu26Kali Linux (rolling)
Kali2026. Kali’s major version is the calendar year, so useKali2027from the 2027.x releases onwards.If you are not sure of a host’s OS Code, start the wizard anyway: when a host’s folder is missing, the error message gives the exact path that host looks in.
The architecture is the one the target host reports:
x86_64on a 64-bit Intel/AMD host andaarch64on a 64-bit Arm host such as a Raspberry Pi or an AWS Graviton instance. A host only ever looks in the folder for its own OS Code and its own architecture, so the same OS Code can hold packages for both: a Raspberry Pi OS 64-bit host looks in.../Debian13/aarch64/while an Intel Debian 13 host looks in.../Debian13/x86_64/.
Put the package’s dependencies in the same folder: every package it needs that the target hosts don’t have yet. IDSTower copies the whole folder to each host and installs everything in it, so the hosts need no package repository to install Suricata. Don’t count on the host downloading a missing dependency during the deployment. IDSTower does install a few helper packages of its own, such as
rsyncandcron, from each host’s repositories; see Target Host Requirements.To collect the dependencies, use a machine set up like your hosts, with the same release and without Suricata, and download what your package needs:
Debian family:
sudo apt-get install --download-only ./<package>.deb. Runsudo apt-get cleanfirst; the files land in/var/cache/apt/archives/.RHEL family:
sudo dnf install --downloadonly --downloaddir=<folder> ./<package>.rpm, with EPEL enabled on that machine even if your hosts don’t have it: Suricata needs packages from it, such ashiredis.
The blog posts above show both.
The folder must hold exactly one file whose name starts with
suricataand ends in “.deb” or “.rpm”: your Suricata package. Leave out any other package whose name starts withsuricata, such as thesuricata-debuginfoandsuricata-debugsourcepackages of an RPM build. With none, or more than one, IDSTower stops before it installs anything, with an error that the installation packages were not found.For Docker installations only: mount the packages directory into the container with a
-voption on yourdocker runcommand, as in this example:docker run \ -p 80:80 \ -p 443:443 \ -e EncryptionKey=<Encryption Key> \ -e Hosting__URL=http://idstower.company.local \ -e Database__Host=<database host> \ -e Database__Name=<database name> \ -e Database__Username=<database username> \ -e Database__Password=<database password> \ -v /host/path/to/custom/Suricata/packages:/opt/idstower/custom/Suricata/packages/ \ idstower/idstower:latest
The container’s
idstoweruser isn’t a user of the Docker host, so skip thechownfrom step 2 and make the host folder readable by everyone instead:sudo chmod -R a+rX /host/path/to/custom/Suricata/packages.Your build now shows up in the Cluster Setup Wizard’s “IDS Software to Install” menu, as
Suricata - 8.0.7 - User-Custom packages Repository - (no Internet required).
Note
If your version doesn’t show up in the “IDS Software to Install” menu, check that:
the version folder, named with the full version such as
8.0.7, sits directly under/opt/idstower/custom/Suricata/packages/, with your package in its OS Code and architecture folders;the package’s file name starts with
suricata;the
idstoweruser can read the folders and the package.