System Requirements

Hardware and Software Requirements

The Xylok Scanner may be installed directly on a machine or inside a virtual machine. Access to the Internet or the network under assessment is not required, although Internet access can be helpful during initial installation.

	Minimum	Requirements
CPU	2 cores	4 cores
Memory	2 cores	4 cores
Free disk space	10 gb	20 gb
Operating system	Ubuntu 20.04/21.10 RHEL 7/8 CentOS 7/8 Rocky Linux 8 Other OSes with BASH and container support may work but are untested
Additional Software	Docker 1+ or Podman 1 Python 2.7 or 3+ Systemd	Docker 18.06+ Python 3.6+ Systemd

Container Runtime Installation

Both Docker 1.x+ and Podman 2+ are supported by Xylok. Both serve the same role of managing the containers that run Xylok, but have different supported operating systems. The supported container manager limitation is a function of the Linux distribution–consult your OS’s documentation for more details about which container environment may work best for you.

	Docker	Podman
Supported OSes	Ubuntu Fedora RHEL/CentOS 6/7/8	Ubuntu Fedora RHEL/CentOS/Rocky Linux 8

If both Podman and Docker are installed, Xylok will default to using Docker.

Podman Install

Follow the instructions at https://podman.io/getting-started/installation.html or your particular distribution’s instructions. In addition, the ensure the following systems settings are configured correctly:

sysctl user.max_user_namespaces must be greater than 0. 10000 is a known-good value.
sysctl net.ipv4.ip_unprivileged_port_start must be 80 or less in order to allow the default ports to work. If this isn’t desired, use the --http-port and --https-port flags during installation.

Docker Install

Follow the instructions at https://docs.docker.com/engine/install/. Some distributions include Docker in their repositories—this is an option, although it will typically be an older version. If feasible for your organization, the official Docker repositories are recommended. For RHEL/CentOS, it may be required to disable CGroups V2.

In addition, the ensure the following systems settings are configured correctly:

The Docker daemon must allow users in the docker group to access it directly. Xylok will use a xylok user to access it. During installation the installer will attempt to correctly configure the group, but if you encounter permission errors accessing the Docker daemon this may be the cause.