Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

System Requirements

Ridgeback deploys in three parts:

  1. The first part of deployment is a MySQL-compatible database. The database can be a standalone installation or the database can be run in a container if long-term data retention is not a requirement. The database gives you the ability to look back in time and perform forensics.

  2. The second part of deployment is a collection of containers. The containers run various Ridgeback services. The containers make Ridgeback a portable and highly extensible solution.

  3. The third part of deployment is one Rcore per network segment that you wish to protect with Ridgeback. An Rcore is a small executable that handles reading data from and writing data to a network segment. The Rcore allows Ridgeback to work in most environments, including environments with significant operational technology (OT) and environments with significant personal devices, such as cell phones and tablets.

System Requirements for a Database

Ridgeback requires a MySQL-compatible database. A standard Ridgeback installation provides the option of loading a MariaDB database into a container for short-term data storage. The database-in-a-container option is not suitable when long-term data retention is a requirement.

Some other (external) database options are listed below.

  • MySQL Standard Edition:
    https://www.mysql.com/products/standard/
  • MySQL Enterprise Edition:
    https://www.mysql.com/products/enterprise/
  • MariaDB:
    https://mariadb.com/kb/en/getting-installing-and-upgrading-mariadb/
  • Azure Database for MySQL:
    https://azure.microsoft.com/en-us/products/mysql/
  • Amazon RDS for MySQL:
    https://aws.amazon.com/rds/mysql/
  • MySQL (version 5.7 for Windows, macOS, Linux, and Solaris):
    https://dev.mysql.com/doc/mysql-installation-excerpt/5.7/en/

The database will accumulate data about your IT infrastructure. You should implement backup and data pruning procedures according to the data retention policies at your organization.

System Requirements for Container Services

Ridgeback services run as containers. Before installing the Ridgeback services, you need to have a computer set up to run containers. Some options for a container runtime are listed below.

  • Docker Desktop on Windows:
    https://docs.docker.com/desktop/install/windows-install/
  • Docker Desktop on Mac:
    https://docs.docker.com/desktop/install/mac-install/
  • Docker Desktop on Linux:
    https://docs.docker.com/desktop/install/linux-install/
  • Linux Containers (LXC):
    https://linuxcontainers.org/lxc/getting-started/
  • Mirantis Container Runtime:
    https://www.mirantis.com/blog/getting-started-with-mirantis-container-runtime-on-windows-server/

The images for the Ridgeback services are less than 3.5GB in size (combined) and use Linux on the inside. (This is why Docker on Windows needs WSL installed.)

The containers will generate application logs. You should configure your container runtime environment to retain and purge logs according to the log retention policies at your organization.

The computer hosting the containers should have an IP route to the Ridgeback license server, which is license.ridgebacknet.com.

System Requirements for an Rcore Computer

Ridgeback uses a single Rcore per network segment. An Rcore is a small executable that handles reading data from and writing data to a network segment. The minimum system requirements for an Rcore version 3.x are listed below.

Windows Requirements (for an Rcore)

  • Windows 11 64-bit: Home or Pro version 21H2 or higher, or Enterprise or Education version 21H2 or higher.
  • Windows 10 64-bit: Home or Pro 21H1 (build 19043) or higher, or Enterprise or Education 20H2 (build 19042) or higher.
  • A 64-bit processor with at least 2 cores.
  • At least 4GB system memory.
  • The latest version of the Npcap driver must be installed prior to installing the Rcore.
    https://npcap.com/#download

Mac Requirements (for an Rcore)

  • macOS version 14.6 (Sonoma) or higher.
  • Intel or ARM (M1, M2, M3, M4) CPU.
  • At least 4GB system memory.

Linux Requirements (for an Rcore)

  • Debian, Ubuntu, or other free distribution. (Ridgeback does not support CentOS.)
  • Intel or ARM CPU. (Ridgeback should work on a Raspberry Pi 4 or 5.)
  • At least 4GB system memory.

Every computer running an Rcore needs an IP route to the computer hosting the Ridgeback services. An Rcore will only operate if the computer that hosts it is turned on, awake, and connected to the network.