|
| 1 | +--- |
| 2 | +AIGC: |
| 3 | + ContentProducer: Minimax Agent AI |
| 4 | + ContentPropagator: Minimax Agent AI |
| 5 | + Label: AIGC |
| 6 | + ProduceID: "00000000000000000000000000000000" |
| 7 | + PropagateID: "00000000000000000000000000000000" |
| 8 | + ReservedCode1: 304502201abae0112f7dc5a5f3df2e1ea6b96c673cbc00165027eed91ab95994c19599d3022100cb16b267fe253e8c041916b4746a72640be64d59cff9deec41263bab44d0c194 |
| 9 | + ReservedCode2: 30460221008baffb51478649b9f6be4c8ab854de3db4f4da452df3f492dd9c7d3f4c0f1f10022100d4e2d546c2e9286146f2a4506b04c3461db15d35c364444c7734ae6d7e61c49e |
| 10 | +--- |
| 11 | + |
| 12 | +# 🔑 Complete API Keys Setup Guide |
| 13 | + |
| 14 | +## 📋 Required API Keys |
| 15 | + |
| 16 | +### 1. Database & Storage (Required) |
| 17 | +- **Neon Postgres**: Database connection |
| 18 | +- **Upstash Redis**: Cache and queue management |
| 19 | + |
| 20 | +### 2. LLM Providers (Required - at least one) |
| 21 | +- **OpenRouter**: Primary LLM provider |
| 22 | +- **Cloudflare Gateway**: Secondary LLM provider |
| 23 | +- **AWS Bedrock**: Fallback LLM provider |
| 24 | + |
| 25 | +### 3. Security (Required) |
| 26 | +- **JWT Secret**: For token signing |
| 27 | +- **Encryption Key**: For data encryption |
| 28 | +- **Admin API Key**: For administrative operations |
| 29 | + |
| 30 | +## 🚀 Quick Setup Links |
| 31 | + |
| 32 | +### Primary Providers |
| 33 | +| Service | Sign Up | API Keys | Dashboard | |
| 34 | +|---------|---------|----------|-----------| |
| 35 | +| [Neon](https://neon.tech/) | [Sign Up](https://neon.tech/) | [Database](https://neon.tech/) | [Dashboard](https://neon.tech/dashboard) | |
| 36 | +| [Upstash](https://upstash.com/) | [Sign Up](https://upstash.com/) | [Redis](https://upstash.com/) | [Dashboard](https://upstash.com/dashboard) | |
| 37 | +| [OpenRouter](https://openrouter.ai/) | [Sign Up](https://openrouter.ai/) | [API Keys](https://openrouter.ai/keys) | [Dashboard](https://openrouter.ai/dashboard) | |
| 38 | + |
| 39 | +### Secondary Providers |
| 40 | +| Service | Sign Up | API Keys | Dashboard | |
| 41 | +|---------|---------|----------|-----------| |
| 42 | +| [Cloudflare](https://cloudflare.com/) | [Sign Up](https://cloudflare.com/) | [AI Gateway](https://dash.cloudflare.com/) | [Dashboard](https://dash.cloudflare.com/) | |
| 43 | +| [AWS](https://aws.amazon.com/) | [Sign Up](https://aws.amazon.com/) | [Bedrock](https://console.aws.amazon.com/bedrock/) | [Console](https://console.aws.amazon.com/) | |
| 44 | + |
| 45 | +### Integration Services |
| 46 | +| Service | Sign Up | Setup | Dashboard | |
| 47 | +|---------|---------|-------|-----------| |
| 48 | +| [Slack](https://slack.com/) | [Create App](https://api.slack.com/apps) | [OAuth](https://api.slack.com/authentication/oauth-v2) | [Dashboard](https://api.slack.com/apps) | |
| 49 | +| [GitHub](https://github.com/) | [Create App](https://github.com/settings/apps/new) | [Webhooks](https://docs.github.com/en/developers/webhooks-and-events/webhooks) | [Settings](https://github.com/settings/apps) | |
| 50 | +| [Clerk](https://clerk.com/) | [Sign Up](https://clerk.com/) | [API Keys](https://dashboard.clerk.com/) | [Dashboard](https://dashboard.clerk.com/) | |
| 51 | + |
| 52 | +## ⚡ Quick Start Commands |
| 53 | + |
| 54 | +### Generate Security Keys |
| 55 | +```bash |
| 56 | +# Generate JWT Secret |
| 57 | +JWT_SECRET=$(openssl rand -base64 32) |
| 58 | + |
| 59 | +# Generate Encryption Key |
| 60 | +ENCRYPTION_KEY=$(openssl rand -hex 16) |
| 61 | + |
| 62 | +# Generate Admin API Key |
| 63 | +ADMIN_API_KEY=$(openssl rand -base64 24) |
| 64 | + |
| 65 | +echo "JWT_SECRET=$JWT_SECRET" |
| 66 | +echo "ENCRYPTION_KEY=$ENCRYPTION_KEY" |
| 67 | +echo "ADMIN_API_KEY=$ADMIN_API_KEY" |
| 68 | +``` |
| 69 | + |
| 70 | +### Copy Template and Fill |
| 71 | +```bash |
| 72 | +# Copy environment template |
| 73 | +cp config/env.example .env |
| 74 | + |
| 75 | +# Edit with your values |
| 76 | +nano .env |
| 77 | +``` |
| 78 | + |
| 79 | +### Validate Configuration |
| 80 | +```bash |
| 81 | +# Run validation script |
| 82 | +./scripts/validate_secrets.sh |
| 83 | +``` |
| 84 | + |
| 85 | +## 📚 Detailed Guides |
| 86 | + |
| 87 | +See individual guide files for step-by-step instructions: |
| 88 | +- `OPENROUTER.md` - OpenRouter API setup |
| 89 | +- `CLOUDFLARE.md` - Cloudflare Gateway setup |
| 90 | +- `DATABASE.md` - Database configuration |
| 91 | +- `SECURITY.md` - Security key generation |
| 92 | + |
| 93 | +## ✅ Checklist |
| 94 | + |
| 95 | +Before proceeding: |
| 96 | +- [ ] Created accounts with required providers |
| 97 | +- [ ] Generated API keys for all required services |
| 98 | +- [ ] Updated .env files with real values |
| 99 | +- [ ] Ran validation script successfully |
| 100 | +- [ ] Tested database and Redis connections |
| 101 | +- [ ] Verified LLM provider access |
| 102 | + |
| 103 | +For detailed instructions, see `QUICK_START_GUIDE.md`. |
0 commit comments