Quickstart — BYOI Deploy

Get the RedQueen Iron Curtain Gateway running in your environment in under 60 seconds.

Prerequisites

Before you begin, ensure you have:

  • Docker 24.0+ or Kubernetes 1.28+
  • Node.js 22+ (for the CLI)
  • An object storage bucket (S3, GCS, Azure Blob, or MinIO)
  • 4 CPU cores / 8GB RAM minimum

Step 1: Install the RedQueen CLI

bash 
npm install -g @redqueen/cli
redqueen --version

Step 2: Clone the Repository

bash 
git clone https://github.com/0x307/RedQueen.git
cd redqueen

Step 3: Configure Your Environment

Copy the example environment file and fill in your values:

bash 
cp .env.example .env
.env 
# Deployment mode
REDQUEEN_MODE=byoi

# Object storage (choose one)
STORAGE_BACKEND=s3
STORAGE_BUCKET=your-bronze-bucket
AWS_REGION=us-east-1

# Optional: Blockchain audit trail
CIPHER_SCRIBE_ENABLED=false

Step 4: Deploy the Agents

bash 
# Docker Compose (recommended for development)
docker compose up -d

# Or Kubernetes
kubectl apply -f k8s/

Step 5: Verify Ingestion

Send a test payload to verify the pipeline is working:

bash 
redqueen test --payload '{"name": "Alice", "email": "alice@example.com", "amount": 99.99}'

Expected output:

✓ Intake Warden: accepted (stream_uuid: 018f4e2a-...)
✓ Helix Serializer: normalized (format: json, rows: 1)
✓ Agent Smith Prime: PASS (risk_score: 0)
✓ Sentinel Tag: classified (PII: email)
✓ The Cloak: tokenized (1 field)
✓ Ledger Guard: hashed (merkle_root: sha256:...)
✓ Phantom Speculator: schema detected
✓ T-Virus Officer: PASS (0 quarantined)
✓ Bronze Scribe: written (1 row → bronze/test_table/)
Pipeline complete in 847ms

Step 6: Monitor the Dashboard

bash 
redqueen dashboard
# Opens http://localhost:3000

Step 7: Next Steps

Edit this page on GitHub