Skip to content

API_KEYS_GUIDE.md

Latest commit

 

History

History
103 lines (81 loc) · 3.87 KB

API_KEYS_GUIDE.md

File metadata and controls

103 lines (81 loc) · 3.87 KB
AIGC
ContentProducer ContentPropagator Label ProduceID PropagateID ReservedCode1 ReservedCode2
Minimax Agent AI
Minimax Agent AI
AIGC
00000000000000000000000000000000
00000000000000000000000000000000
304502201abae0112f7dc5a5f3df2e1ea6b96c673cbc00165027eed91ab95994c19599d3022100cb16b267fe253e8c041916b4746a72640be64d59cff9deec41263bab44d0c194
30460221008baffb51478649b9f6be4c8ab854de3db4f4da452df3f492dd9c7d3f4c0f1f10022100d4e2d546c2e9286146f2a4506b04c3461db15d35c364444c7734ae6d7e61c49e

🔑 Complete API Keys Setup Guide

📋 Required API Keys

1. Database & Storage (Required)

  • Neon Postgres: Database connection
  • Upstash Redis: Cache and queue management

2. LLM Providers (Required - at least one)

  • OpenRouter: Primary LLM provider
  • Cloudflare Gateway: Secondary LLM provider
  • AWS Bedrock: Fallback LLM provider

3. Security (Required)

  • JWT Secret: For token signing
  • Encryption Key: For data encryption
  • Admin API Key: For administrative operations

🚀 Quick Setup Links

Primary Providers

Service Sign Up API Keys Dashboard
Neon Sign Up Database Dashboard
Upstash Sign Up Redis Dashboard
OpenRouter Sign Up API Keys Dashboard

Secondary Providers

Service Sign Up API Keys Dashboard
Cloudflare Sign Up AI Gateway Dashboard
AWS Sign Up Bedrock Console

Integration Services

Service Sign Up Setup Dashboard
Slack Create App OAuth Dashboard
GitHub Create App Webhooks Settings
Clerk Sign Up API Keys Dashboard

⚡ Quick Start Commands

Generate Security Keys

# Generate JWT Secret
JWT_SECRET=$(openssl rand -base64 32)

# Generate Encryption Key
ENCRYPTION_KEY=$(openssl rand -hex 16)

# Generate Admin API Key
ADMIN_API_KEY=$(openssl rand -base64 24)

echo "JWT_SECRET=$JWT_SECRET"
echo "ENCRYPTION_KEY=$ENCRYPTION_KEY"
echo "ADMIN_API_KEY=$ADMIN_API_KEY"

Copy Template and Fill

# Copy environment template
cp config/env.example .env

# Edit with your values
nano .env

Validate Configuration

# Run validation script
./scripts/validate_secrets.sh

📚 Detailed Guides

See individual guide files for step-by-step instructions:

  • OPENROUTER.md - OpenRouter API setup
  • CLOUDFLARE.md - Cloudflare Gateway setup
  • DATABASE.md - Database configuration
  • SECURITY.md - Security key generation

✅ Checklist

Before proceeding:

  • Created accounts with required providers
  • Generated API keys for all required services
  • Updated .env files with real values
  • Ran validation script successfully
  • Tested database and Redis connections
  • Verified LLM provider access

For detailed instructions, see QUICK_START_GUIDE.md.