Optral Documentation
Configuration

Configuration

Environment variables and deployment settings for Optral.

Control Plane Configuration

The Control Plane is the central backend service. Configure it via environment variables or command-line flags.

Core Settings

DATABASE_URL
Required

PostgreSQL connection string for the Control Plane database.

postgres://user:password@host:5432/optral?sslmode=require
HTTP_ADDR
Optional

Address for the HTTP API server. Default: :8080

GRPC_ADDR
Optional

Address for the gRPC tunnel server (agent connections). Default: :50051

SESSION_SECRET
Required

Secret key for encrypting session tokens. Generate with:

openssl rand -base64 32
JWT_SECRET
Required

Secret key for signing JWT tokens used in API authentication.

AI Analysis

AI Provider Configuration

Configure one or more AI providers for root cause analysis.

OpenAI

OPENAI_API_KEYYour OpenAI API key

Anthropic Claude

ANTHROPIC_API_KEYYour Anthropic API key

AWS Bedrock

AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
AWS_REGION

Email Notifications

Email Service

Configure an email provider for notifications, password resets, and team invites.

Resend (Recommended)

RESEND_API_KEYYour Resend API key

Sign up at resend.com

SendGrid (Alternative)

SENDGRID_API_KEYYour SendGrid API key
EMAIL_FROM
Optional

The sender address for notification emails.

Optral <notifications@optral.ai>

Billing (Stripe)

Stripe Integration

Configure Stripe for subscription billing and payment processing.

STRIPE_API_KEY
Optional

Stripe secret API key for billing operations.

STRIPE_WEBHOOK_SECRET
Optional

Webhook signing secret for verifying Stripe events.

Price IDs

STRIPE_PRICE_PRO
STRIPE_PRICE_TEAM
STRIPE_PRICE_ENTERPRISE

Dashboard Configuration

Dashboard Settings

The Dashboard is a thin UI client that connects to the Control Plane API.

CONTROL_PLANE_URL
Required

URL of the Control Plane API.

http://optral-control-plane:8080
NEXT_PUBLIC_APP_URL
Required

Public URL of the Dashboard (used for redirects and email links).

https://app.optral.ai
NEXTAUTH_SECRET
Required

Secret key for NextAuth session encryption.

Kubernetes Deployment

Helm Chart

Deploy Optral to Kubernetes using our official Helm chart.

# Add the Optral Helm repository
helm repo add optral https://charts.optral.ai
helm repo update

# Install Optral
helm install optral optral/optral \
  --namespace optral \
  --create-namespace \
  -f values.yaml

The Helm chart includes:

  • Control Plane deployment with HPA
  • Dashboard deployment
  • PostgreSQL (optional, can use external)
  • Ingress configuration
  • External Secrets integration for Vault
  • Network policies
View Helm chart documentation →

Example Configuration

Control Plane Environment

# Database
DATABASE_URL="postgres://optral:password@localhost:5432/optral"

# Server
HTTP_ADDR=":8080"
GRPC_ADDR=":50051"

# Security
SESSION_SECRET="your-session-secret"
JWT_SECRET="your-jwt-secret"

# AI Providers
OPENAI_API_KEY="sk-..."
ANTHROPIC_API_KEY="sk-ant-..."

# Email
RESEND_API_KEY="re_..."
EMAIL_FROM="Optral <notifications@optral.ai>"

# Billing
STRIPE_API_KEY="sk_live_..."
STRIPE_WEBHOOK_SECRET="whsec_..."
STRIPE_PRICE_PRO="price_..."
STRIPE_PRICE_TEAM="price_..."

Dashboard Environment

# Control Plane API
CONTROL_PLANE_URL="http://optral-control-plane:8080"

# Public URL
NEXT_PUBLIC_APP_URL="https://app.optral.ai"

# Session
NEXTAUTH_SECRET="your-nextauth-secret"