Documentation Hub

Everest Documentation

Installation guides, integration documentation, API reference, and operational guides for all Everest deployment scenarios.

All Guides

Browse documentation

Select a guide below or download the corresponding PDF for offline reference.

Start here

Getting Started

Introduction to Everest, architecture overview, system requirements, and quick-start checklist for new deployments.

Open
Ubuntu 22.04 · 24.04

Linux Installation

Complete Ubuntu 22.04 and 24.04 installation guide for the Everest agent and FUSE driver packages.

Open
Coming Soon

Windows Installation

Installation guide for the Everest agent and minifilter driver on Windows 11 and Windows Server 2022.

Open

Agent Configuration

Full reference for everest.conf configuration file — lifecycle thresholds, drive paths, upload scheduling, and service options.

Open

Cloud Storage Setup

Overview of cloud storage configuration for both AWS S3 and Wasabi, including bucket setup, IAM policy requirements, and region selection.

Open

AWS S3 Setup

Step-by-step guide for configuring an AWS S3 bucket, IAM user, access key, and permissions policy for Everest cloud archival.

Open

Wasabi Setup

Guide for configuring a Wasabi cloud storage bucket and access credentials for use as the Everest cloud archival provider.

Open
VMS Guide

Nx Witness Integration

Integration guide for deploying Everest with Nx Witness / Network Optix VMS — storage path configuration, lifecycle setup, and playback validation.

Open

Disaster Recovery

Step-by-step site recovery workflow using Everest cloud backups — restoring video files, metadata database, and encrypted configuration.

Open

Troubleshooting

Common issues, diagnostic commands, log file locations, FUSE mount verification, and cloud connectivity diagnostic procedures.

Open
REST API

API Reference

Complete REST API reference with endpoint specifications, authentication, request/response schemas, and code examples for integration.

Open

Release Notes

Version history, change log, breaking changes, and upgrade instructions for each Everest release.

Open
Quick Reference

Common installation steps

Linux Quick Install — Ubuntu 22.04 / 24.04

# Install prerequisites

sudo apt update && sudo apt install -y fuse3

 

# Install FUSE driver

sudo dpkg -i everest-fuse-driver-ubuntu-22.04-x64.deb

 

# Install Everest Agent

sudo dpkg -i everest-agent-ubuntu-22.04-x64.deb

 

# Enable and start services

sudo systemctl enable everest-agent

sudo systemctl start everest-agent

 

# Verify status

sudo systemctl status everest-agent

everest.conf — Key Configuration Keys

# Storage path (Nx Witness storage folder)

NxWitnessStoragePath=/mnt/vms/storage

 

# Cloud provider: s3 | wasabi

CloudProvider=wasabi

CloudEndpoint=s3.wasabisys.com

CloudBucket=my-everest-archive

 

# Lifecycle thresholds

L1ThresholdDays=7

L2ThresholdDays=30

L3ThresholdDays=90

 

# Scheduled upload time (24h format)

UploadScheduleTime=02:00

MaxConcurrentUploads=4

Documentation Downloads

Download guides as PDF

All documentation is available as PDF for offline use and team distribution.

RecommendedAvailable
PDF

Linux Installation Guide

Complete installation, configuration, and post-install validation guide for the Everest agent and FUSE driver on Ubuntu Linux.

Platform

Linux

Version

v1.0

OS

Ubuntu 22.04 / 24.04

Arch

All

SHA256

e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6…

Available
PDF

Windows Installation Guide

Installation, driver signing, and configuration guide for the Everest agent on Windows platforms.

Platform

Windows

Version

v1.0

OS

Windows 11 / Server 2022

Arch

All

SHA256

f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1…

RecommendedAvailable
PDF

Nx Witness Integration Guide

Step-by-step guide for integrating Everest with Nx Witness / Network Optix VMS. Covers storage path configuration, lifecycle setup, and playback validation.

Platform

Linux / Windows

Version

v1.0

OS

Ubuntu 22.04+ / Windows

Arch

All

SHA256

a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2…

Available
PDF

Production Deployment Guide

Production readiness checklist, load testing procedures, replication validation, and operational guidelines for enterprise deployments.

Platform

Linux / Windows

Version

v1.0

OS

Ubuntu 22.04+ / Windows

Arch

All

SHA256

b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3…

Available
PDF

API Reference

Complete REST API reference with endpoint specifications, authentication, request/response schemas, and integration code examples.

Platform

All Platforms

Version

v1.0

OS

Platform-agnostic

Arch

All

SHA256

c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4…

Available
PDF

Everest User Guide

Administrator guide covering dashboard navigation, configuration management, file lifecycle operations, monitoring, alerts, and troubleshooting.

Platform

All Platforms

Version

v1.0

OS

Platform-agnostic

Arch

All

SHA256

d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5…

Need help?

Get hands-on deployment support

Contact the Everest team for integration assistance, deployment walkthroughs, and technical consultation.