System Requirements

This page lists what a server needs before you install UTMStack v12: the operating system, the hardware the installer checks, sizing, network access, and the changes the installer makes to the server. For a step-by-step checklist, see Prepare the Server; for cloud servers, see Install on AWS, Azure or Google Cloud.

Use a dedicated server

Install UTMStack v12 on a server, physical or virtual, that runs nothing else. The installer changes system settings, installs Docker and nginx, and takes over ports 80 and 443. During installation and after every update it also deletes all Docker images that no running container uses, including images that belong to other applications on the same server.

Operating system

The installer accepts these Linux distributions:

DistributionNotes
UbuntuInstalled with apt.
DebianInstalled with apt.
Red Hat Enterprise LinuxInstalled with dnf.

The installer checks the name of the distribution only, not its release. Any other name stops the installer with the message your Linux distribution (...) is not supported. Red Hat compatible distributions that report their own name, such as Rocky Linux, AlmaLinux, CentOS or Oracle Linux, are refused.

The installer is built for 64-bit x86 servers (x86-64, also called AMD64). Use a current, supported release of your distribution.

The installer must run as the root user.

Minimum hardware checked by the installer

The installer stops if the server is below these limits:

ResourceMinimumWhat happens below it
CPU2 logical coresyour system does not have the minimum required CPU cores: 2
Memory13,360 MB in totalinsufficient memory, with the amount available and the amount required
Free disk space on /About 30 GByour system does not have the minimum required free disk space: 30 GB

These are the limits below which the installer refuses to run, not sizing for production. The installer reserves 1,000 MB of memory for the operating system and gives every service its minimum share of the rest. Memory above the minimums is shared out by priority, with the largest share going to the event processor and ClickHouse. See Installer Reference for the service limits.

Sizing

How much CPU, memory and disk you need depends on how many logs you collect and how long you keep them on the server. Sizing and Capacity Planning explains how the installer shares memory between the services, how much each service gets on 16, 32, 64 and 128 GB servers, and how to estimate disk space from your own log volume.

In short:

  • Memory. Above the installer's minimum, almost all extra memory goes to ClickHouse (log storage) and the event processor (parsing and correlation). The installer uses up to about 134,000 MB; memory beyond that is not given to any service.

  • CPU. There are no CPU limits. The event processor and ClickHouse use all cores.

  • Disk. Logs and alerts are kept for 730 days by default, and ingestion statistics for 1,095 days. Size the disk for the period you need, or change the periods in Configure > Settings > Data Retention after installation, where you can also move older data to cold storage (an S3-compatible bucket, Azure Blob Storage or an NFS share). See Data Retention and Cold Storage.

After you go live, watch CPU, memory and disk use, and add resources when needed. When you add memory, run utmstack_installer --recalculate-memory so the services can use it. See Installer Reference.

Storage

  • Use SSD storage for the UTMStack data folder.

  • UTMStack keeps its data under /utmstack. To put it on a separate disk, mount that disk at /utmstack before you install. Prepare the Server shows how.

  • The operating system disk (/) also needs space: the installer checks free space there, and Docker keeps its images and the PostgreSQL database volume under /var/lib/docker by default.

Network access

The server needs internet access during installation and afterwards, unless you use an air-gapped installation (see Install UTMStack).

  • At the start, the installer tests internet access by connecting over HTTPS to 8.8.8.8, 1.1.1.1 and google.com, with a 3-second limit. If all three fail, it switches to air-gapped mode.

  • During installation it must also reach the UTMStack update server, cm.utmstack.com. If it cannot reach it for about a minute, it prints No Internet connection detected. Installation will continue offline.

  • It downloads packages from your distribution's mirrors and from download.docker.com, and container images from ghcr.io and Docker Hub.

For the full list of inbound and outbound ports, see Network Ports and Firewall.

Other network needs:

  • IPv4. The installer turns IPv6 off on the whole server. Make sure you can reach the server over IPv4, including for SSH.

  • Address range 10.21.199.0/24. The installer creates a network interface vlan10 with the address 10.21.199.3/24. Make sure this range is not used on your network.

  • DNS name. Give the server a DNS name if you want a trusted SSL certificate. On a multi-tenant licence, each tenant needs its own DNS name that points to the server.

  • Fixed IP address. The installer sets up Docker Swarm with the server's main IP address. Use a static address or a DHCP reservation.

  • Time synchronisation. Keep the server's clock synchronised with NTP or Chrony. Correct time matters for correlating events, for the time stamps of alerts and for authenticator-app sign-in codes.

What the installer changes on the server

ChangeDetails
Kernel settingsAppends to /etc/sysctl.conf: vm.max_map_count=262144, IPv6 off (net.ipv6.conf.all.disable_ipv6=1, net.ipv6.conf.default.disable_ipv6=1), and TCP keepalive settings (net.ipv4.tcp_keepalive_time=600, net.ipv4.tcp_keepalive_intvl=60, net.ipv4.tcp_keepalive_probes=3).
Kernel moduleLoads 8021q and adds it to /etc/modules.
Network interfaceCreates vlan10 (VLAN ID 10, address 10.21.199.3/24) on the main network card: /etc/netplan/99-vlan.yaml on Ubuntu, /etc/network/interfaces.d/vlan10 on Debian, /etc/sysconfig/network-scripts/ifcfg-vlan10 on Red Hat. On Ubuntu it installs the vlan package; on Debian vlan and ifupdown. On Red Hat it runs a full dnf update -y.
Red Hat onlySets SELinux to permissive (now and in /etc/selinux/config) and stops and disables firewalld.
DockerInstalls Docker CE from download.docker.com and starts Docker Swarm, using the server's main IP address.
nginxInstalls nginx from your distribution and writes its configuration: /etc/nginx/sites-available/default on Ubuntu and Debian, /etc/nginx/nginx.conf on Red Hat. It also writes a maintenance page, /etc/nginx/html/custom_502.html.
CockpitInstalls Cockpit, a web console for server management, on port 9090. On Red Hat Enterprise Linux it may have to be started with systemctl enable --now cockpit.socket.
FilesCreates /root/utmstack.yml and the /utmstack folder, and installs the update service. See Installer Reference.

The installer rewrites the nginx configuration file on every update. Do not add your own settings to it: they will be lost.