Complete reference for all configuration options across the Yemaya platform.
Table of Contents#
- Environment Variables
- Database Configuration
- AI Provider Configuration
- Storage Configuration
- Authentication Configuration
- Rate Limiting Configuration
- GPU Jobs Configuration
- Monitoring Configuration
- Feature Flags
Environment Variables#
Copy .env.example to .env and configure:
bash
cp .env.example .env
Required Variables#
bash
# Application
NODE_ENV=development # development | production | test
PORT=3000 # API server port
APP_URL=http://localhost:3000 # Public URL
# Database (PostgreSQL)
DATABASE_URL=postgresql://yemaya:password@localhost:5432/yemaya
# Cache (Redis)
REDIS_URL=redis://localhost:6379
# Object Storage (MinIO/S3)
MINIO_ENDPOINT=localhost
MINIO_PORT=9000
MINIO_ACCESS_KEY=minioadmin
MINIO_SECRET_KEY=minioadmin
MINIO_USE_SSL=false
MINIO_BUCKET=yemaya
AI Provider Keys#
bash
# Anthropic (Claude)
ANTHROPIC_API_KEY=sk-ant-...
# OpenAI
OPENAI_API_KEY=sk-...
OPENAI_ORG_ID=org-... # Optional
# Google (Gemini)
GOOGLE_API_KEY=...
# XAI (Grok)
XAI_API_KEY=...
# Local LLM (Ollama)
OLLAMA_BASE_URL=http://localhost:11434
3D Generation Provider Keys#
bash
# Meshy
MESHY_API_KEY=...
# Rodin (Hyper3D)
RODIN_API_KEY=...
# Tripo3D
TRIPO_API_KEY=...
# Hunyuan
HUNYUAN_APP_ID=...
HUNYUAN_SECRET_ID=...
HUNYUAN_SECRET_KEY=...
GPU Provider Keys#
bash
# RunPod
RUNPOD_API_KEY=...
RUNPOD_ENDPOINT_ID=...
# Modal
MODAL_TOKEN=...
# AWS
AWS_ACCESS_KEY_ID=...
AWS_SECRET_ACCESS_KEY=...
AWS_REGION=us-east-1
Authentication#
bash
# JWT Configuration
JWT_SECRET=your-secure-secret-key-min-32-chars
JWT_ACCESS_EXPIRES=15m # Access token expiry
JWT_REFRESH_EXPIRES=7d # Refresh token expiry
# OAuth Providers
GOOGLE_CLIENT_ID=...
GOOGLE_CLIENT_SECRET=...
GITHUB_CLIENT_ID=...
GITHUB_CLIENT_SECRET=...
DISCORD_CLIENT_ID=...
DISCORD_CLIENT_SECRET=...
Email#
bash
# SMTP Configuration
SMTP_HOST=smtp.example.com
SMTP_PORT=587
SMTP_USER=...
SMTP_PASS=...
SMTP_FROM=noreply@yemaya.io
# For development (Mailpit)
SMTP_HOST=localhost
SMTP_PORT=1025
Monitoring#
bash
# Sentry
SENTRY_DSN=https://...@sentry.io/...
# OpenTelemetry
OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
OTEL_SERVICE_NAME=yemaya-api
# Prometheus
PROMETHEUS_ENABLED=true
PROMETHEUS_PORT=9090
Database Configuration#
PostgreSQL#
typescript
// packages/database/src/config.ts
export const databaseConfig = {
// Connection pool settings
pool: {
min: 2,
max: 10,
idleTimeoutMs: 30000,
acquireTimeoutMs: 60000,
},
// Query settings
query: {
timeout: 30000, // 30 seconds
statementTimeout: 60000,
},
// Replication (for read replicas)
replication: {
enabled: false,
readReplicas: [],
},
};
Redis#
typescript
// packages/database/src/redis/config.ts
export const redisConfig = {
// Connection
host: process.env.REDIS_HOST || 'localhost',
port: parseInt(process.env.REDIS_PORT || '6379'),
password: process.env.REDIS_PASSWORD,
db: parseInt(process.env.REDIS_DB || '0'),
// Connection pool
maxRetriesPerRequest: 3,
retryDelayMs: 100,
// Cluster mode
cluster: {
enabled: false,
nodes: [],
},
// Sentinel mode
sentinel: {
enabled: false,
masterName: 'mymaster',
sentinels: [],
},
};
MinIO/S3#
typescript
// packages/database/src/storage/config.ts
export const storageConfig = {
// Provider
provider: 'minio', // 'minio' | 's3' | 'gcs' | 'azure'
// Bucket settings
defaultBucket: 'yemaya',
publicBucket: 'yemaya-public',
// Upload settings
upload: {
maxFileSize: 100 * 1024 * 1024, // 100MB
allowedMimeTypes: ['image/*', 'video/*', 'audio/*', 'model/*'],
presignedUrlExpiry: 3600, // 1 hour
},
// CDN settings
cdn: {
enabled: false,
baseUrl: 'https://cdn.yemaya.io',
},
// Lifecycle rules
lifecycle: {
tempFilesExpiry: 24, // hours
versionRetention: 30, // days
},
};
AI Provider Configuration#
Multi-Provider Routing#
typescript
// packages/ai/src/config.ts
export const aiConfig = {
// Default provider
defaultProvider: 'anthropic',
// Provider priorities (for automatic selection)
providerPriority: ['anthropic', 'openai', 'google'],
// Fallback settings
fallback: {
enabled: true,
maxRetries: 3,
retryDelay: 1000,
},
// Cost optimization
costOptimization: {
enabled: true,
maxCostPerRequest: 1.0, // USD
preferCheaperModels: false,
},
// Quality routing
qualityRouting: {
enabled: true,
routingModel: 'claude-3-haiku', // Model for routing decisions
},
};
Provider-Specific Settings#
typescript
// Anthropic
export const anthropicConfig = {
model: 'claude-3-sonnet-20240229',
maxTokens: 4096,
temperature: 0.7,
topP: 1,
timeout: 120000,
};
// OpenAI
export const openaiConfig = {
model: 'gpt-4-turbo-preview',
maxTokens: 4096,
temperature: 0.7,
organization: process.env.OPENAI_ORG_ID,
};
// Google
export const googleConfig = {
model: 'gemini-pro',
maxOutputTokens: 8192,
temperature: 0.7,
safetySettings: 'default',
};
Storage Configuration#
Asset Storage#
typescript
export const assetConfig = {
// Storage paths
paths: {
models: 'assets/models',
textures: 'assets/textures',
audio: 'assets/audio',
video: 'assets/video',
documents: 'assets/documents',
},
// Processing
processing: {
generateThumbnails: true,
thumbnailSizes: [64, 128, 256, 512],
autoOptimize: true,
},
// Versioning
versioning: {
enabled: true,
maxVersions: 10,
retentionDays: 90,
},
};
Authentication Configuration#
typescript
export const authConfig = {
// JWT settings
jwt: {
secret: process.env.JWT_SECRET,
accessTokenExpiry: '15m',
refreshTokenExpiry: '7d',
issuer: 'yemaya',
audience: 'yemaya-api',
},
// Password requirements
password: {
minLength: 8,
requireUppercase: true,
requireLowercase: true,
requireNumbers: true,
requireSymbols: false,
maxAttempts: 5,
lockoutDuration: 900, // 15 minutes
},
// Session settings
session: {
maxConcurrentSessions: 5,
sessionTimeout: 86400, // 24 hours
rememberMeDuration: 2592000, // 30 days
},
// OAuth settings
oauth: {
google: {
enabled: true,
scopes: ['email', 'profile'],
},
github: {
enabled: true,
scopes: ['user:email'],
},
discord: {
enabled: true,
scopes: ['identify', 'email'],
},
},
// Email verification
emailVerification: {
required: true,
tokenExpiry: 86400, // 24 hours
resendCooldown: 60, // 1 minute
},
};
Rate Limiting Configuration#
typescript
export const rateLimitConfig = {
// Global defaults
global: {
windowMs: 60000, // 1 minute
maxRequests: 100,
burstLimit: 20,
},
// Per-endpoint overrides
endpoints: {
'/auth/login': {
windowMs: 300000, // 5 minutes
maxRequests: 5,
blockDuration: 900000, // 15 minutes
},
'/ai/generate': {
windowMs: 60000,
maxRequests: 10,
},
'/3d/generate': {
windowMs: 60000,
maxRequests: 5,
},
},
// Tier-based limits
tiers: {
free: { requestsPerMinute: 60, burstLimit: 10 },
pro: { requestsPerMinute: 300, burstLimit: 50 },
enterprise: { requestsPerMinute: 1000, burstLimit: 200 },
},
// IP-based settings
ipBased: {
enabled: true,
trustProxy: true,
whitelist: [],
blacklist: [],
},
};
GPU Jobs Configuration#
typescript
export const gpuJobsConfig = {
// Provider settings
providers: {
'runpod-serverless': {
enabled: true,
priority: 1,
maxConcurrent: 10,
},
modal: {
enabled: true,
priority: 2,
maxConcurrent: 5,
},
'aws-ecs-spot': {
enabled: true,
priority: 3,
maxConcurrent: 20,
},
},
// Cost settings
cost: {
maxCostPerJob: 10.0, // USD
dailyBudget: 100.0, // USD
monthlyBudget: 2000.0, // USD
alertThreshold: 0.8, // 80% of budget
},
// Queue settings
queue: {
maxQueueSize: 1000,
maxRetries: 3,
retryDelay: 5000,
jobTimeout: 3600000, // 1 hour
},
// Circuit breaker
circuitBreaker: {
failureThreshold: 5,
resetTimeout: 60000, // 1 minute
halfOpenMaxRequests: 3,
},
// Dead letter queue
dlq: {
enabled: true,
retentionDays: 30,
maxEntries: 10000,
},
};
See GPU Jobs Documentation for detailed configuration.
Monitoring Configuration#
Logging#
typescript
export const loggingConfig = {
// Log level
level: process.env.LOG_LEVEL || 'info', // trace|debug|info|warn|error|fatal
// Output format
format: process.env.NODE_ENV === 'production' ? 'json' : 'pretty',
// Sensitive field redaction
redact: ['password', 'token', 'apiKey', 'secret'],
// File logging
file: {
enabled: process.env.NODE_ENV === 'production',
path: '/var/log/yemaya',
maxSize: '100m',
maxFiles: 7,
},
};
Metrics#
typescript
export const metricsConfig = {
// Prometheus
prometheus: {
enabled: true,
path: '/metrics',
defaultLabels: {
app: 'yemaya',
env: process.env.NODE_ENV,
},
},
// OpenTelemetry
openTelemetry: {
enabled: true,
serviceName: 'yemaya-api',
exporters: ['otlp', 'console'],
samplingRatio: process.env.NODE_ENV === 'production' ? 0.1 : 1.0,
},
};
Alerting#
typescript
export const alertingConfig = {
// Channels
channels: {
slack: {
enabled: true,
webhookUrl: process.env.SLACK_WEBHOOK_URL,
channel: '#alerts',
},
email: {
enabled: true,
recipients: ['ops@yemaya.io'],
},
pagerduty: {
enabled: false,
integrationKey: process.env.PAGERDUTY_KEY,
},
},
// Alert rules
rules: {
highErrorRate: {
threshold: 0.05, // 5% error rate
window: 300, // 5 minutes
severity: 'critical',
},
slowResponse: {
threshold: 5000, // 5 seconds
percentile: 95,
severity: 'warning',
},
},
};
Feature Flags#
typescript
export const featureFlags = {
// AI Features
'ai.quality-routing': true,
'ai.cost-optimization': true,
'ai.local-llm': false,
// 3D Generation
'3d.hunyuan-provider': true,
'3d.auto-rigging': true,
'3d.texture-upscaling': true,
// GPU Jobs
'gpu.circuit-breaker': true,
'gpu.ab-testing': true,
'gpu.routing-rules': true,
// Collaboration
'collab.real-time': true,
'collab.video-chat': false,
// Enterprise
'enterprise.sso': false,
'enterprise.audit-logs': true,
'enterprise.custom-branding': false,
};
Feature flags can be managed via:
- Environment variables:
FEATURE_AI_QUALITY_ROUTING=true - Admin API:
PATCH /admin/feature-flags/{flagId} - Database configuration
Configuration Files#
Package-level Configuration#
Each package can have its own configuration in <package>/src/config.ts:
typescript
// packages/my-package/src/config.ts
import { z } from 'zod';
export const ConfigSchema = z.object({
enabled: z.boolean().default(true),
maxItems: z.number().min(1).default(100),
// ... other options
});
export type Config = z.infer<typeof ConfigSchema>;
export const defaultConfig: Config = {
enabled: true,
maxItems: 100,
};
export function getConfig(): Config {
return {
...defaultConfig,
...loadFromEnv(),
};
}
Runtime Configuration Updates#
Some configurations can be updated at runtime via the Admin API:
bash
# Get current config
curl -X GET /api/v1/admin/config
# Update config
curl -X PUT /api/v1/admin/config/rate-limit \
-H "Content-Type: application/json" \
-d '{"maxRequests": 200}'