Install Surveilr Operational Truth™

Surveilr is a downloadable software package that must be installed on a local workstation or server environment. The software is not web-based and requires local installation to operate.To install Surveilr, users must first set up the required software dependencies and then download and install the primary Surveilr application package by following the provided installation instructions.

Overview

Get the latest Resource Surveillance & Integration Engine (surveilr) for Critical Systems by following these steps to complete the installation.

System Requirements

Operating System: macOS 10.15+, Ubuntu 20.04+ (Jammy), Debian 11+ (Bookworm), Windows 10+
RAM: 512 MB minimum, 2 GB recommended
Disk Space: 50 MB plus space for evidence databases
Deno Runtime: 2.x or later (required)

Installation Commands

Install surveilr via package manager:

# Ubuntu (Jammy)
wget https://github.com/surveilr/packages/releases/latest/download/surveilr_jammy.deb
sudo dpkg -i surveilr_jammy.deb

# Debian (Bookworm)
wget https://github.com/surveilr/packages/releases/latest/download/surveilr_bookworm.deb
sudo dpkg -i surveilr_bookworm.deb

Install surveilr via Homebrew:

brew tap surveilr/tap && brew install surveilr

Install surveilr via PowerShell:

# Recommended: Use installation script
irm https://raw.githubusercontent.com/surveilr/packages/refs/heads/main/scripts/install.ps1 | iex

# Alternative: Manual installation
# 1. Download from: https://github.com/surveilr/packages/releases/latest
# 2. Extract the downloaded zip file
# 3. Copy the executable (ends with .exe) to your desired directory
# 4. Add to PATH or run from the directory

Install surveilr via direct download:

Visit our GitHub Releases page to download pre-built binaries:

Windows: surveilr-windows.zip
macOS: surveilr-macos.zip
Linux: surveilr-linux.tar.gz

Download surveilr

Install surveilr via installation script:

# macOS/Linux - Install in current directory
curl -sL https://raw.githubusercontent.com/surveilr/packages/main/scripts/install.sh | bash

# Install globally
curl -sL https://raw.githubusercontent.com/surveilr/packages/main/scripts/install.sh | SURVEILR_HOME="$HOME/bin" bash

# Install in preferred path
curl -sL https://raw.githubusercontent.com/surveilr/packages/main/scripts/install.sh | SURVEILR_HOME="/path/to/directory" bash

Using Eget:

# Install eget first
curl https://zyedidia.github.io/eget.sh | sh

# Install surveilr
eget surveilr/packages --asset tar.gz

Verify Installation

Run the following commands to verify that surveilr is installed correctly:

surveilr --version                      # version information
surveilr doctor                         # dependencies that surveilr uses
surveilr --help                         # get CLI help (pay special attention to ENV var names)

Check out more commands in the CLI reference.

Upgrading surveilr

To upgrade surveilr to the latest version or a specific version:

surveilr upgrade                        # upgrades to the latest version

surveilr upgrade -v 0.13.0              # upgrades to version 0.13.0 if present

When using the command above, you will be prompted to confirm the upgrade by typing yes. However, if you are running the upgrade in a bash script, you won't be able to provide this confirmation interactively.

Use the --yes or --y flag to automatically skip the confirmation step:

surveilr upgrade --yes                  # upgrades to the latest version and skips confirmation

surveilr upgrade -v 0.13.0 --yes        # upgrades to version 0.13.0 and skips confirmation

Downgrading surveilr

To downgrade surveilr to any specific version:

surveilr upgrade -v 0.12.0              # downgrades to version 0.12.0

The downgrade command uses the same format as the upgrade command with the only difference being that a lower version number is passed.

How is this guide?

Install Surveilr Operational Truth™ - Evidence Engine

powered by Surveilr® software