Skip to main content

Quick Start Guide

Get your first CastellanAI agent running in under 5 minutes.

Coming Soon

CastellanAI is currently in final development. This guide shows what to expect when we launch. Join our waitlist to get early access!

Two Interfaces

CastellanAI has two web interfaces: the Customer Portal for account and agent management, and the Security Dashboard for monitoring threats. See Introduction for details.

Prerequisites​

Before you begin, ensure you have:

  • A CastellanAI account (Join the waitlist to be notified at launch)
  • An endpoint running Windows 10+, Ubuntu 20.04+, or macOS 12+
  • Administrator/root access on the endpoint

Step 1: Log in to Customer Portal​

  1. Navigate to https://castellanai.com/portal
  2. Enter your email and password
  3. Click Sign In

Portal Login The Customer Portal login page.

Step 2: Download the Agent​

  1. In the Customer Portal, click Install Agent in the Quick Actions section
  2. Select your platform from the options below

Download Agent The Download Agent dialog showing platform options for Windows, Linux, and macOS.

PlatformInstaller Type
Windows.exe installer
Linux.deb or .rpm package
macOS.pkg installer

Step 3: Install the Agent​

Windows Installation​

# Run the installer as Administrator
.\CastellanAgent-Setup.exe
Elevated Privileges Required

Right-click the installer and select "Run as Administrator" to ensure proper installation.

Step 4: Configure the Agent​

During installation, you'll be prompted to enter:

FieldDescriptionWhere to Find
Customer IDYour unique identifierPortal → Settings
Hub URLThe Worker API endpointProvided during signup
Copy from Portal

Both values can be copied directly from the Customer Portal's agent installation dialog to avoid typos.

Step 5: Verify Connection in Customer Portal​

  1. Return to the Customer Portal at castellanai.com/portal
  2. Click Agents in the navigation
  3. Your new agent should appear with status Connected

Agent Connected The Customer Portal's Agents page showing your newly installed agent with green "Connected" status.

StatusIndicatorMeaning
Connected🟢 GreenAgent is online and sending events
Disconnected🔴 RedNo connection in last 5 minutes

Step 6: Open Security Dashboard​

  1. In the Customer Portal, click Open Security Dashboard in Quick Actions
  2. You'll be redirected to your Security Dashboard
  3. Navigate to Security Events to see events from your endpoint

Security Events The Security Dashboard showing real-time security events from your monitored endpoints.

Unique Dashboard URL

The Security Dashboard has its own URL unique to your account. You can bookmark it for direct access, or always access it via the Customer Portal.

Troubleshooting​

❌ Agent doesn't appear in the Portal

If your agent doesn't appear after installation:

  1. Check the agent service is running:
Get-Service CastellanAgent
  1. Verify network connectivity to the Worker API
  2. Review agent logs:
PlatformLog Location
Windows%LOCALAPPDATA%\CastellanAgent\logs
Linux/var/log/castellan-agent
macOS~/Library/Logs/CastellanAgent
🔌 Connection issues

Ensure your firewall allows outbound connections:

ProtocolPortDestination
HTTPS443api.castellanai.com
WSS443api.castellanai.com
🔑 Invalid Customer ID or Hub URL
  1. Log in to the Customer Portal
  2. Navigate to Settings → Agent Configuration
  3. Copy the correct values
  4. Reconfigure the agent with the correct credentials

What's Next?​

Need Help?

Contact support@castellanai.com for assistance.