Quick Start
instructions on the installation of `surveilr`
Tip
- System Requirements: While
surveilrcan run on low-performing systems, we recommend at least a dual-core processor, 2GB of RAM, and 8GB of available disk space for optimal performance.
How to install Resource Surveillance & Integration Engine (surveilr) for Critical Systems
Start using surveilr Resource Surveillance by following the quick guide below:
π¦ Package Managers (Recommended)
-
Ubuntu/Debian:
# 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 -
macOS (Homebrew):
$ brew tap surveilr/tap && brew install surveilr -
Windows:
# Recommended: Use installation script $ irm https://raw.githubusercontent.com/surveilr/packages/refs/heads/main/scripts/install.ps1 | iex
π Alternative Installation Methods
-
macOS and Linux Scripts:
# install in current path $ 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 -
Direct Download:
Visit GitHub Releases to download pre-built binaries for your operating system.
Still Got Questions ?
Check out our FAQ
How is this guide?
Last updated on
What is Resource Surveillance?
Introduction to Surveilr, a resource-surveillance CLI tool.
Install Surveilr Operational Truthβ’ - Evidence Engine
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.