Getting Started with VigilPrism

Get up and running with security auditing in 5 minutes.

Overview

VigilPrism consists of two main components:

  • Server — Central management with web dashboard and REST API
  • Agent — Lightweight daemon deployed to endpoints for scanning
1

Start the Server

Linux

# Extract the package
tar -xzf vigilprism-server-0.71.0-linux-x64.tar.gz
cd vigilprism

# Run the installer (creates systemd service)
sudo ./install.sh

# Or start manually
./vigilprism-server

Windows

# Extract the ZIP archive
# Run as Administrator:
install.bat

# Or start manually (Admin required)
vigilprism-server.exe

The server starts on http://localhost:8000 by default.

2

Login to Dashboard

  1. 1.Open your browser to http://localhost:8000
  2. 2.Login with default credentials:
Username:admin
Password:admin

Important: Change the admin password immediately after first login.

2.5

Activate License (Paid Plans)

The Community Edition (up to 3 agents) requires no license. For paid plans, you'll need to activate your license using your Installation ID.

Find Your Installation ID

Each VigilPrism server generates a unique Installation ID on first run. Find it in the dashboard:

  1. 1.Go to Settings → License
  2. 2.Copy your Installation ID (format: inst_xxxxxxxx)

Example Installation ID:

inst_a1b2c3d4e5f6g7h8

Activate Your License

  1. 1.When purchasing, enter your Installation ID at checkout
  2. 2.Receive your license key via email
  3. 3.Go to Settings → License → Enter License Key
  4. 4.Paste your license key and click Activate
Air-Gapped Environments: License validation is 100% offline. No internet connection required after activation—perfect for isolated networks.
3

Deploy an Agent

Choose the deployment method that works best for you:

RECOMMENDED

Option A: Agent Package Builder

The easiest way to deploy agents. The dashboard generates pre-configured installer packages with embedded credentials.

  1. 1.Go to Settings → Agent Builder
  2. 2.Select the target platform (Linux or Windows)
  3. 3.Click Build Package
  4. 4.Download the generated ZIP file
  5. 5.Copy to target system and run the install script:

Linux

unzip vigilprism-agent-*.zip
cd vigilprism-agent
sudo ./install.sh

Windows

# Extract ZIP, then run as Admin:
install.bat

Benefits: No manual configuration required. Server URL and enrollment token are embedded in the package. The agent registers automatically on first run.

Option B: Manual Deployment

For advanced users or automated deployments (Ansible, Puppet, etc.).

Step 1: Create an enrollment token in the dashboard

Settings → Enrollment Tokens → Create Token

Step 2: Copy the agent binary and create configuration

Linux: /etc/vigilprism/agent.yaml

server_url: http://your-server:8000
enrollment_token: enr_xxxxxxxxxxxxxxxxx

Windows: C:\ProgramData\VigilPrism\agent.yaml

server_url: http://your-server:8000
enrollment_token: enr_xxxxxxxxxxxxxxxxx

Step 3: Start the agent (requires root/admin)

sudo vigilprism-agent --installvigilprism-agent.exe --install
4

Run Your First Audit

Once the agent connects, you can run audits from the dashboard:

  1. 1.Go to Systems → select your agent
  2. 2.Click Run Audit
  3. 3.Wait for the scan to complete (30-60 seconds)
  4. 4.View results in the Security Checks tab

What You'll See

  • • Security Score: Overall score from 0-100
  • • Security Checks: Individual pass/fail results
  • • Compliance: Map to NIST, ISO, SOC 2, HIPAA
  • • Remediation: Step-by-step fix instructions

What's Next?

Installation Guide

Detailed setup for production deployments

Agent Deployment

Fleet-wide agent rollout with Ansible

Security Audits

Understanding checks and scores

Compliance Frameworks

Map to NIST, ISO, SOC 2, HIPAA