🚀 Quick Start Guide

📅 Updated: March 2025 ⏱ī¸ 5 min read 🔧 v2.4.0

Welcome to CyberVault. This guide will walk you through setting up enterprise-grade AI-powered security for your infrastructure in just a few minutes. By the end, you'll have threat detection, automated response, and real-time monitoring active across your environment.

Setup Progress 0% Complete
?

Prerequisites

Before you begin, ensure you have the following ready:

1

Install the CyberVault Agent

The CyberVault agent is the core component that monitors your environment. Install it via your preferred package manager:

Bash 
# Using npm (Recommended for Node.js environments)
npm install @cybervault/agent

# Or using pip for Python environments
pip install cybervault-agent
ℹī¸
Docker Support: We also provide a hardened Docker image. See our Container Guide for deployment instructions.
2

Configure the Agent

Create a configuration file cybervault.json in your project root. This defines your security posture and integration settings.

cybervault.json 
{
  "apiKey": "cv_live_YOUR_API_KEY_HERE",
  "environment": "production",
  "mode": "strict",
  "scanning": {
    "intervals": "5m",
    "targets": ["0.0.0.0/0", "cloud://aws/us-east-1"],
    "aiDetection": true
  },
  "response": {
    "autoContain": true,
    "alertChannels": ["slack", "webhook", "soc"]
  }
}
⚠ī¸
Security Warning: Never commit your API key to version control. Use environment variables: { "apiKey": "${CV_API_KEY}" }
3

Initialize & Connect to API

Initialize the agent in your application code or run the CLI to verify connectivity:

Node.js Example 
import { CyberVaultAgent } from '@cybervault/agent';

const agent = new CyberVaultAgent();

await agent.connect();

// Register middleware for express/fastify
app.use(agent.middleware());

console.log('🛡ī¸ CyberVault active. Threat protection enabled.');
CLI Verification 
# Verify installation and API connectivity
cv-agent verify

# Expected output:
# ✓ Agent version 2.4.0 detected
# ✓ API connection successful (latency: 12ms)
# ✓ AI models loaded
# ✓ Zero trust policy applied
4

Monitor the Dashboard

Once connected, your data streams to the CyberVault SOC Dashboard in real-time. Navigate to app.cybervault.io/dashboard to view:

  • Threat Feed: Live stream of detected and blocked threats
  • AI Risk Score: Dynamic assessment of your infrastructure's security posture
  • Response Actions: Log of automated containment and remediation events
  • Compliance Status: Real-time tracking against SOC 2, ISO 27001, and GDPR
🎉
You're Protected! Your environment is now secured by CyberVault's AI engine. The first scan will complete within 2 minutes.
?

Troubleshooting

❌ "Connection refused" when verifying API

Ensure your firewall allows outbound traffic to api.cybervault.io:443. If using a proxy, configure it in CV_PROXY_URL.

❌ "Invalid API Key" error

Verify your key starts with cv_live_ for production or cv_test_ for sandbox. Check for extra whitespace or typos. Regenerate keys in Settings → API Keys.

⚠ī¸ High CPU usage from agent

In strict mode, the AI engine runs intensive analysis. Reduce scan frequency in config to "intervals": "15m" or enable "economyMode": true for non-critical environments.

Q

Frequently Asked Questions

Does CyberVault support on-premise deployment?

Yes. Enterprise plans include a fully air-gapped on-premise option with local AI model hosting. Contact sales for details.

Can I integrate with existing SIEM tools?

Absolutely. We support Splunk, Datadog, Elastic, and syslog out of the box. Configure in "integrations" within your config.

How fast is the threat response?

Average detection is <10ms. Automated containment actions execute in <50ms. Human SOC escalation occurs within 2 minutes for critical alerts.

📞

Need Help?

Our Security Operations Center is available 24/7/365 to assist you.

Contact SOC Team View Status Page Open Ticket