Skip to main content

Installation Guide

This guide covers all installation methods for AuroraSOC, from a simple Docker-based setup to a full production deployment.

The simplest way to run AuroraSOC with all services:

# Clone the repository
git clone https://github.com/your-org/AuroraSOC.git
cd AuroraSOC

# Start the full stack
docker compose up -d

# Check service health
docker compose ps

This starts all services including agents, database, event bus, dashboard, monitoring, and LLM inference.

Production Docker Setup​

For production, configure environment variables:

# Create production .env file
cat > .env << 'EOF'
# Database
PG_PASSWORD=your-secure-password-here

# Security
JWT_SECRET_KEY=$(openssl rand -hex 32)
API_SERVICE_KEY=$(openssl rand -hex 32)

# Grafana
GRAFANA_PASSWORD=your-grafana-password

# Vault
VAULT_TOKEN=your-vault-token

# Environment
ENVIRONMENT=production
LOG_LEVEL=WARNING
DEBUG=false
EOF

# Deploy with production config
docker compose --env-file .env up -d

Method 2: Local Development Setup​

For active development with hot-reload:

Step 1: Infrastructure Services​

# Start only infrastructure (no app services)
docker compose -f docker-compose.dev.yml up -d

Step 2: Python Backend​

# Create virtual environment
python3.12 -m venv .venv
source .venv/bin/activate

# Install with dev extras
pip install -e ".[dev]"

# Run migrations
alembic upgrade head

# Start API with hot-reload
uvicorn aurorasoc.api.main:app --host 0.0.0.0 --port 8000 --reload

Step 3: Dashboard​

cd dashboard
npm install
npm run dev

Step 4: LLM Backend (Optional)​

# Install Ollama (https://ollama.com)
curl -fsSL https://ollama.com/install.sh | sh

# Pull recommended models
ollama pull granite4:8b         # Default agent model
ollama pull granite4:dense      # Orchestrator model

Method 3: Building from Source​

Build the Rust Core Engine​

cd rust_core
cargo build --release
# Binary at: target/release/aurora-core

Build Docker Images​

# Build all images
make docker-build

# Or build individually
docker build -f Dockerfile.python -t aurorasoc/api:latest .
docker build -f Dockerfile.rust -t aurorasoc/rust-core:latest ./rust_core
docker build -f Dockerfile.dashboard -t aurorasoc/dashboard:latest .

Build Firmware (Advanced)​

See the Firmware Guide for building embedded firmware for STM32, nRF52840, and ESP32-S3 devices.

Verifying the Installation​

After installation, verify each component:

# API health check
curl http://localhost:8000/api/v1/health

# Dashboard
open http://localhost:3000

# PostgreSQL
docker compose exec postgres pg_isready -U aurorasoc

# Redis
docker compose exec redis redis-cli ping

# NATS
curl http://localhost:8222/healthz

# Qdrant
curl http://localhost:6333/readyz
Troubleshooting

If the API starts but database operations fail, AuroraSOC automatically falls back to in-memory demo data. Check docker compose logs postgres for database connectivity issues.

Updating AuroraSOC​

# Pull latest changes
git pull origin main

# Update Python dependencies
pip install -e ".[dev]"

# Run any new migrations
alembic upgrade head

# Rebuild Docker images (if using Docker)
docker compose build
docker compose up -d