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

Installation and Setup

System Requirements

  • Supported Platforms: X86-based Windows, Mac, or Linux -- We do have ARM support deployed as an early release, and it can run on platforms like the Raspberry Pi.
  • Capability: Must be able to run Docker containers and have a network connection to the segment you wish to monitor.

For more detailed requirements, refer to the Docker documentation and check the section on WSL 2 backend and x86_64 architecture.

Ridgeback Install Process (the basics)

Follow these clear steps to install Ridgeback:

  1. Install Docker Desktop (Windows users only: Also install the Npcap network driver)

  2. Download Ridgeback's install.html Save it to your Downloads folder.

  3. Open install.html Follow the instructions in the file.

    • Check off the first two boxes since you’ve already installed Docker and NPCAP.
    • Copy/paste your license name and key into the provided boxes.
    • Enter your email address to register and log in on the Ridgeback website.
    • Input your network information (IP, MAC, Gateway) for the Rcore.

  4. Download Ridgeback Files After filling in the details, click the button to download customized Ridgeback files. (Allow multiple file downloads if prompted by your browser.)

  5. Run the Installation Script Execute the install-ridgeback file from your Downloads folder. This creates the Docker containers and sets up the run-active and run-passive scripts.

  6. Launch Ridgeback Double-click the Ridgeback icon on your desktop to start the Rcore and connect to the local Ridgeback control server. Next Steps

    • Register your user account on the Ridgeback website and log in.
    • Ensure the Rcore continues running properly.

Ridgeback is now successfully installed!

Restarting Ridgeback After a Reboot

  1. Ensure Docker is running with the Ridgeback containers.
  2. Start the Rcore by double-clicking the Ridgeback icon on your desktop.

More Details: Ridgeback Installation Overview

Ridgeback uses Docker to run its control and analytics tools. To install Ridgeback, you need Docker Desktop installed on a machine in each store where Ridgeback will monitor network traffic.

The only component outside of Docker is the Rcore binary—a small program (less than 1 MB) that interacts directly with the network adapter. The Rcore monitors and protects all devices (computers, cameras, tools, etc.) on a network segment by detecting and preventing malicious traffic.

Typically, Rcore runs on the same machine that hosts Docker and the Ridgeback containers. However, in cases where the Ridgeback control suite can't directly access the desired network segment, Rcore can run on a different machine in that segment. The machine running Rcore must be able to communicate to the machine running Docker, using TCP/IP on port 19444, though they don't have to be on the same network.

Simplist Setup: The simplest setup is when Rcore and Docker run on the same machine.

System Requirements

  • Windows 10/11 or Windows Server 2022 (or newer)
  • Docker Desktop installed from Docker's official site. Use the WSL version of Docker, though this can run on a hypervisor as well.

Prerequisites for Rcore (Windows Machines)

  • Npcap network driver: Download from Npcap.
  • vcruntime140.dll: Download from Microsoft, though it is usually pre-installed on most systems.

If everything is installed on the same machine, the process is straightforward. Ridgeback provides a script that checks prerequisites and configures Rcore as part of the Docker installation.

Installation Process

  1. Download install.html to the Downloads folder of the machine where Docker is installed.

  2. Open install.html in a web browser (Edge, Firefox, Chrome).

  3. Enter license details: Paste your license name, license key, and email accounts for the Ridgeback control suite.

  4. Download customized install files to your Downloads folder by clicking the provided button.

  5. Run install-ridgeback.cmd from the Downloads folder. The install-ridgeback.cmd performs the following:

    • Creates a Ridgeback folder at C:\Program Files\Ridgeback\ (or backs up existing contents).
    • Moves the necessary configuration files (e.g., docker-compose.yml and .env) to the Ridgeback folder.
    • Starts Docker if it isn't running.
    • Checks for npcap.dll and prompts you to download it if missing.
    • Logs into the Ridgeback Docker repository and downloads the Ridgeback images.
    • Creates Ridgeback and Database containers and initializes the database.
    • Downloads the rcore-win.exe file.
    • Moves the run-active.cmd and run-passive.cmd scripts to the Ridgeback folder.
    • Creates a desktop shortcut to launch the Rcore and open the Ridgeback control server.
    • Registers your user in the local control server.
    • Cleans up the Downloads folder.

Additional Configuration (if using Ethernet)

If your network uses Ethernet instead of Wi-Fi, the run-active and run-passive scripts will need to be customized to work with the Ethernet adapter instead of the Wi-Fi adapter.

Helper Utility

The rcore-config.html utility, part of the Ridgeback control suite, helps you set up scripts with all possible Rcore parameters. This will be covered during installation.