Aethyr Research
Documentation

Deployment Guide

Deploy Aethyr in the environment that best fits your requirements. Choose from local, hybrid, or cloud deployment options.

Deployment Options

Local Mode

Full air-gapped deployment. Data never leaves your infrastructure.

  • Maximum security
  • Complete data control
  • Works offline

Hybrid Mode

Local data with optional cloud inference. Best of both worlds.

  • Local data storage
  • Cloud model access
  • Flexible scaling

Cloud Mode

Fully managed cloud deployment. Minimal setup required.

  • Quick setup
  • Auto-scaling
  • Managed updates

Docker Deployment

The recommended way to deploy Aethyr is using Docker Compose. This provides consistent environments across development and production.

Prerequisites

  • Docker 20.10+ and Docker Compose 2.0+
  • 8GB RAM minimum (16GB recommended for local models)
  • 20GB available disk space
docker-compose.yml
version: '3.8'

services:
  aethyr:
    image: aethyr/console:latest
    ports:
      - "3000:3000"
    env_file:
      - .env.production    # secrets live here, never in the compose file
    depends_on:
      - db
      - cache
    volumes:
      - ./data:/app/data

  db:
    image: postgres:16
    env_file:
      - .env.db
    volumes:
      - db_data:/var/lib/postgresql/data

  cache:
    image: redis:7-alpine
    volumes:
      - cache_data:/data

volumes:
  db_data:
  cache_data:
Terminal
# Start the stack
docker compose up -d

# Check logs
docker compose logs -f aethyr

# Stop services
docker compose down

Environment Configuration

Configure Aethyr using environment variables. Copy the sample file and customize for your environment.

.env.production
# Core connection strings (keep all credentials in a secrets manager)
DATABASE_URL=<database-connection-string>
CACHE_URL=<cache-connection-string>

# Application secret (generate a strong random value; never commit)
APP_SECRET=<generate-with-openssl-rand>
APP_URL=https://your-instance.com

# Model provider credentials — set only the providers you use
ANTHROPIC_API_KEY=<your-api-key>

# Deployment mode, local/air-gapped inference, and additional provider
# and knowledge-store settings are configured with your team during onboarding.

Security Best Practice

Never commit .env files to version control. Use secrets management for production deployments.

Production Checklist

  • Enable HTTPS

    Configure SSL/TLS certificates. Use Let's Encrypt for free certificates.

  • Configure Backups

    Set up automated database backups and test restoration procedures.

  • Set Resource Limits

    Configure memory and CPU limits in Docker Compose or your Cloud Run service.

  • Enable Logging

    Configure centralized logging for monitoring and debugging.

  • Set Up Monitoring

    Configure health checks and alerting for system availability.

PreviousSecurityNextConfiguration