Skip to content
Corellix Docs

Quick Start

Quick Start

Section titled “Quick Start”

Get started with Corellix in minutes by following this guide.

Section titled “Option 1: Cloud (Recommended)”

  1. Register on Corellix

    Go to app.corellix.io and create your account.

  2. Create a Tenant

    From the Customer Portal, create a new tenant for your organization.

  3. Download the Collector

    Download the Collector from the Downloads section and install it on the management server.

  4. Configure the Collector

    Terminal window
    # Configure connection to cloud
    ./configure-collector.sh --tenant YOUR_TENANT_ID --api-key YOUR_API_KEY

  5. Deploy User Agent

    Distribute the User Agent to monitored machines via GPO or manually.

Option 2: On-Premise with Docker

Section titled “Option 2: On-Premise with Docker”
docker-compose.yml
version: '3.8'
services:
  api-gateway:
    image: corellix/api-gateway:latest
    ports:
      - "443:443"
    environment:
      - COSMOS_CONNECTION_STRING=${COSMOS_CONNECTION}


  collector:
    image: corellix/collector:latest
    ports:
      - "5050:5050"
    environment:
      - API_GATEWAY_URL=https://api-gateway

Start with:

Terminal window
docker-compose up -d

User Agent Installation

Section titled “User Agent Installation”

Windows - Interactive Wizard

Section titled “Windows - Interactive Wizard”
  1. Download the CorellixUserAgent-x.x.x.zip package
  2. Extract and run Setup.bat as administrator
  3. Follow the wizard to configure:
    • Collector URL: http://collector:5050
    • API Key (if required)

Windows - Silent Installation

Section titled “Windows - Silent Installation”
Terminal window
powershell -ExecutionPolicy Bypass -File Setup-CorellixUserAgent.ps1 `
  -Silent `
  -CollectorUrl "http://collector.domain.com:5050"

Windows - GPO with MSI

Section titled “Windows - GPO with MSI”
Terminal window
msiexec /i CorellixUserAgent-1.0.0.msi /qb ^
  COLLECTOR_HOST=collector.domain.com ^
  COLLECTOR_PORT=5050

Verify Installation

Section titled “Verify Installation”

Check service status

Section titled “Check service status”
Terminal window
# User Agent
Get-Service CorellixUserAgent


# Collector (if local)
Get-Service CorellixCollector

Verify connectivity

Section titled “Verify connectivity”
Terminal window
# Test connection to Collector
Test-NetConnection -ComputerName collector.domain.com -Port 5050

Verify data in Portal

Section titled “Verify data in Portal”
  1. Log in to the Customer Portal
  2. Go to Sessions → Active
  3. You should see active sessions within 30 seconds

Next Steps

Section titled “Next Steps”