Skip to content

Commit 9def56b

Browse files
Copilotjgwill
andcommitted
Add visual reference of all supported environment variables
- Create ASCII art reference showing all supported variables - Clearly mark removed non-standard variables - Show priority order with visual indicators - Include testing examples and migration guide - Easy to read format for quick reference Co-authored-by: jgwill <23141173+jgwill@users.noreply.github.com>
1 parent f9e574c commit 9def56b

File tree

1 file changed

+104
-0
lines changed

1 file changed

+104
-0
lines changed

SUPPORTED_VARIABLES.txt

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
╔════════════════════════════════════════════════════════════════════╗
2+
║ SUPPORTED REDIS ENVIRONMENT VARIABLES ║
3+
╚════════════════════════════════════════════════════════════════════╝
4+
5+
✅ UPSTASH DIRECT
6+
┌─────────────────────────────────────────────────────────────┐
7+
│ UPSTASH_REDIS_REST_URL=https://your-instance.upstash.io │
8+
│ UPSTASH_REDIS_REST_TOKEN=your_token │
9+
└─────────────────────────────────────────────────────────────┘
10+
📍 Priority: 1 (Highest)
11+
🎯 When: Using Upstash directly
12+
13+
✅ VERCEL KV (REST API)
14+
┌─────────────────────────────────────────────────────────────┐
15+
│ KV_REST_API_URL=https://your-instance.upstash.io │
16+
│ KV_REST_API_TOKEN=your_token │
17+
└─────────────────────────────────────────────────────────────┘
18+
📍 Priority: 2
19+
🎯 When: Deploying on Vercel with KV
20+
21+
✅ VERCEL KV (CONNECTION STRING)
22+
┌─────────────────────────────────────────────────────────────┐
23+
│ KV_URL=rediss://default:password@host.upstash.io:6379 │
24+
│ OR │
25+
│ REDIS_URL=rediss://default:password@host.upstash.io:6379 │
26+
└─────────────────────────────────────────────────────────────┘
27+
📍 Priority: 3
28+
🎯 When: Using Vercel's connection string format
29+
30+
✅ TRADITIONAL REDIS
31+
┌─────────────────────────────────────────────────────────────┐
32+
│ REDIS_HOST=your-host.upstash.io │
33+
│ REDIS_PORT=6379 │
34+
│ REDIS_PASSWORD=your_password │
35+
│ REDIS_SSL=true │
36+
└─────────────────────────────────────────────────────────────┘
37+
📍 Priority: 4
38+
🎯 When: Using traditional Redis setup
39+
40+
✅ CONFIG FILES
41+
┌─────────────────────────────────────────────────────────────┐
42+
│ ./coaia.json or ~/coaia.json │
43+
│ { │
44+
│ "jtaleconf": { │
45+
│ "host": "your-host.upstash.io", │
46+
│ "port": 6379, │
47+
│ "password": "your_password", │
48+
│ "ssl": true │
49+
│ } │
50+
│ } │
51+
└─────────────────────────────────────────────────────────────┘
52+
📍 Priority: 5 (Lowest)
53+
🎯 When: Committed config without secrets
54+
55+
╔════════════════════════════════════════════════════════════════════╗
56+
║ TESTING ║
57+
╚════════════════════════════════════════════════════════════════════╝
58+
59+
▶ coaia tash TEST_KEY "test value" --verbose
60+
61+
Connecting to Redis server:
62+
Host: your-host.upstash.io
63+
Port: 6379
64+
SSL: True
65+
Password: ***word
66+
Status: Connection established successfully ✓
67+
Key: TEST_KEY was just saved to memory.
68+
69+
▶ coaia fetch TEST_KEY --verbose
70+
test value
71+
72+
╔════════════════════════════════════════════════════════════════════╗
73+
║ NOT SUPPORTED (Removed) ║
74+
╚════════════════════════════════════════════════════════════════════╝
75+
76+
❌ UPSTASH_REST_API_URL (non-standard, confusing)
77+
❌ UPSTASH_REST_API_TOKEN (non-standard, confusing)
78+
79+
These were temporarily added in a previous fix but are NOT provided by
80+
any platform (Upstash or Vercel). They have been removed to eliminate
81+
confusion.
82+
83+
╔════════════════════════════════════════════════════════════════════╗
84+
║ MIGRATION ║
85+
╚════════════════════════════════════════════════════════════════════╝
86+
87+
If you were using UPSTASH_REST_API_*, update to:
88+
89+
For Upstash Direct:
90+
UPSTASH_REDIS_REST_URL=...
91+
UPSTASH_REDIS_REST_TOKEN=...
92+
93+
For Vercel KV:
94+
KV_REST_API_URL=...
95+
KV_REST_API_TOKEN=...
96+
97+
╔════════════════════════════════════════════════════════════════════╗
98+
║ DOCUMENTATION ║
99+
╚════════════════════════════════════════════════════════════════════╝
100+
101+
📖 ENVIRONMENT_VARIABLES_REFERENCE.md - Quick reference guide
102+
📖 UPDATE_NOTES.md - Migration guide
103+
📖 CHANGES_SUMMARY.md - Summary of changes
104+
📖 REDIS_FIX_DOCUMENTATION.md - Full usage guide

0 commit comments

Comments
 (0)