Docs / Installation

đŸ“Ļ Agent Installation & Setup

Deploy the CyberVault agent on your endpoints to enable real-time threat detection and compliance monitoring.

â„šī¸
Preparation: This guide assumes you have administrative access to the target systems. Installation typically takes less than 2 minutes per endpoint.

Prerequisites

Ensure your environment meets the following requirements before proceeding.

Platform Minimum Version Architecture Network Access
Linux (Debian/Ubuntu) 20.04 LTS x86_64, ARM64 TCP/443 to SOC
Linux (RHEL/CentOS) 8.0 x86_64, ARM64 TCP/443 to SOC
Windows 10 / Server 2019 x64, ARM64 TCP/443 to SOC
macOS 12.0 (Monterey) x86_64, ARM64 TCP/443 to SOC
âš ī¸
Root/Sudo Access Required: The CyberVault agent requires elevated privileges to monitor kernel-level events and enforce security policies. Ensure you have sudo access or Administrator rights.

Installation Methods

Select your operating system to view the appropriate installation instructions.

Quick Install (Recommended)

For automated installation on supported Linux distributions:

bash
curl -fsSL https://install.cybervault.ai | sudo bash -s -- --edition=enterprise

Package Manager Installation

For manual control over package updates:

Debian / Ubuntu

bash
# Add the CyberVault repository
wget -qO - https://repos.cybervault.ai/gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/cybervault-archive-keyring.gpg

echo "deb [signed-by=/usr/share/keyrings/cybervault-archive-keyring.gpg] https://repos.cybervault.ai/apt stable main" | sudo tee /etc/apt/sources.list.d/cybervault.list

# Install the agent
sudo apt update
sudo apt install cybervault-agent

RHEL / CentOS / Rocky

bash
# Add the CyberVault repository
sudo yum-config-manager --add-repo https://repos.cybervault.ai/yum/cybervault.repo

# Install the agent
sudo yum install cybervault-agent

PowerShell Installation

Run the following commands in PowerShell as Administrator:

powershell
# Download the installer
Invoke-WebRequest -Uri https://install.cybervault.ai/windows/latest.msi -OutFile cybervault-agent.msi

# Install with silent flags
msiexec /i cybervault-agent.msi /quiet /norestart LICENSE_KEY="YOUR_LICENSE_KEY"

Chocolatey Package

If you use Chocolatey as your package manager:

powershell
choco install cybervault-agent --version 2.4.1

Homebrew Installation

The easiest way to install on macOS is via Homebrew:

zsh
brew tap cybervault/agent
brew install cybervault-agent

Manual PKG Installation

bash
curl -O https://install.cybervault.ai/macos/latest.pkg
sudo installer -pkg latest.pkg -target /

Initial Configuration

After installation, configure the agent with your license key and connect it to your SOC endpoint.

Set License Key

bash
sudo cybervault config set --license-key "YOUR_LICENSE_KEY"

# Verify license
cybervault license status

Configure SOC Endpoint

By default, the agent connects to us-east-1.soc.cybervault.ai. To use a custom or on-premise endpoint:

bash
sudo cybervault config set --soc-endpoint "https://soc.yourcompany.internal:8443"

# Optional: Specify tenant ID for multi-tenant setups
cybervault config set --tenant-id "YOUR_TENANT_ID"
âš ī¸
Secure Communication: Ensure port 443 is open outbound to the SOC endpoint. If using a proxy, configure it via cybervault config set --proxy "http://proxy:port".

Verification & Health Check

Confirm the agent is running and communicating with the CyberVault SOC.

Terminal Output
$ sudo cybervault status

đŸ›Ąī¸ CyberVault Agent v2.4.1
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Status:        ✅ Active
License:       Enterprise (Valid until 2026-01-01)
SOC Endpoint:  us-east-1.soc.cybervault.ai
Connection:    🔗 Connected (12ms latency)
Kernel Module: ✅ Loaded
Monitoring:    4,281 processes tracked
Threats:       0 detected
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

$ sudo cybervault health

✅ All systems operational
   â€ĸ Kernel integrity: Verified
   â€ĸ Agent service: Running
   â€ĸ Data pipeline: Flowing
   â€ĸ Policy engine: Active
✅
Installation Successful: Your endpoint is now protected and reporting to the CyberVault SOC. Monitor the dashboard for initial baselining events.

Troubleshooting

Common Issues

Viewing Logs

Access detailed agent logs for debugging:

bash
# View last 50 lines
sudo cybervault logs --tail 50

# Stream live logs
sudo cybervault logs --follow

# Export logs for support
cybervault support export --destination /tmp/cyber-dump.tar.gz

Next Steps

After successful installation: