iaurora 1.0.30 → 1.0.31
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.env.example +1 -1
- package/README.md +213 -105
- package/bin/aurora.exe +0 -0
- package/package.json +1 -1
package/.env.example
CHANGED
|
@@ -123,7 +123,7 @@
|
|
|
123
123
|
# =============================================================================
|
|
124
124
|
|
|
125
125
|
# External model metadata registry. Leave empty to disable upstream fetch.
|
|
126
|
-
# MODEL_LIST_URL=https://
|
|
126
|
+
# MODEL_LIST_URL=https://github.com/aurorallm/aurora/blob/main/docs-assets/assets/models.json
|
|
127
127
|
|
|
128
128
|
# Local model registry snapshot and user pricing overrides
|
|
129
129
|
# MODEL_LIST_LOCAL_PATH=data/models.local.json
|
package/README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<p align="center">
|
|
2
|
-
<img src="https://raw.githubusercontent.com/aurorallm/aurora/main/docs/assets/aurora-logo-animated.svg" width="96" height="96" alt="Aurora Logo">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/aurorallm/aurora/main/docs-assets/assets/aurora-logo-animated.svg" width="96" height="96" alt="Aurora Logo">
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
5
|
<h1 align="center">Aurora Gateway OSS — Open-Source AI Gateway | OpenAI & Anthropic Compatible API</h1>
|
|
@@ -7,28 +7,28 @@
|
|
|
7
7
|
<p align="center">
|
|
8
8
|
<a href="LICENSE"><img src="https://img.shields.io/github/license/aurorallm/aurora" alt="License" height="20"></a>
|
|
9
9
|
<a href="https://www.npmjs.com/package/iaurora"><img src="https://img.shields.io/npm/v/iaurora" alt="npm" height="20"></a>
|
|
10
|
-
<a href="https://codecov.io/gh/aurorallm/aurora"><img src="https://codecov.io/gh/aurorallm/aurora/branch/main/graph/badge.svg" alt="codecov" height="20"></a>
|
|
10
|
+
<!-- <a href="https://codecov.io/gh/aurorallm/aurora"><img src="https://codecov.io/gh/aurorallm/aurora/branch/main/graph/badge.svg" alt="codecov" height="20"></a> -->
|
|
11
11
|
<a href="https://github.com/aurorallm/aurora"><img src="https://img.shields.io/github/stars/aurorallm/aurora" alt="GitHub Stars" height="20"></a>
|
|
12
|
-
<a href="https://discord.gg/
|
|
12
|
+
<a href="https://discord.gg/AfaFBSU2km"><img src="https://dcbadge.limes.pink/api/server/https://discord.gg/AfaFBSU2km?style=flat" alt="Discord" height="20"></a>
|
|
13
13
|
<img src="https://img.shields.io/docker/pulls/aurorahq/aurora" alt="Docker Pulls" height="20">
|
|
14
|
-
<a href="https://artifacthub.io/packages/search?repo=aurora-gateway"><img src="https://artifacthub.io/badge/repository/aurora-gateway" alt="Artifact Hub" height="20"></a>
|
|
15
|
-
</p>
|
|
14
|
+
<a href="https://artifacthub.io/packages/search?repo=aurora-gateway"><img src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/aurora-gateway" alt="Artifact Hub" height="20"></a>
|
|
16
15
|
|
|
16
|
+
</p>
|
|
17
17
|
<p align="center"><b>Open-source LLM gateway (OSS edition). One API for every AI provider.</b></p>
|
|
18
18
|
|
|
19
19
|
<p align="center">Self-hosted. No vendor lock-in. 14 provider types, 30+ LLM providers supported.</p>
|
|
20
20
|
|
|
21
|
-
<a href="https://raw.githubusercontent.com/aurorallm/aurora/main/docs/assets/dashboard-overview.png">
|
|
22
|
-
<img src="https://raw.githubusercontent.com/aurorallm/aurora/main/docs/assets/dashboard-overview.png" alt="Aurora open-source AI gateway admin dashboard showing provider stats and usage metrics" width="100%">
|
|
21
|
+
<a href="https://raw.githubusercontent.com/aurorallm/aurora/main/docs-assets/assets/dashboard-overview.png">
|
|
22
|
+
<img src="https://raw.githubusercontent.com/aurorallm/aurora/main/docs-assets/assets/dashboard-overview.png" alt="Aurora open-source AI gateway admin dashboard showing provider stats and usage metrics" width="100%">
|
|
23
23
|
</a>
|
|
24
24
|
|
|
25
25
|
---
|
|
26
26
|
|
|
27
27
|
## Quick Start
|
|
28
28
|
|
|
29
|
-
Start routing AI traffic in 60 seconds
|
|
29
|
+
Start routing AI traffic in 60 seconds.
|
|
30
30
|
|
|
31
|
-
### CLI (npm)
|
|
31
|
+
### Option A — CLI (npm)
|
|
32
32
|
|
|
33
33
|
```bash
|
|
34
34
|
npm install -g iaurora
|
|
@@ -36,62 +36,226 @@ mkdir my-gateway && cd my-gateway
|
|
|
36
36
|
aurora init # creates config.yaml, .env, data/
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
Set your provider keys in `.env`:
|
|
40
40
|
|
|
41
41
|
```env
|
|
42
|
-
|
|
43
|
-
|
|
42
|
+
# ── REQUIRED ──────────────────────────────────────────────
|
|
43
|
+
AURORA_MASTER_KEY="your-secure-key"
|
|
44
|
+
|
|
45
|
+
# ── PROVIDER API KEYS (at least one) ─────────────────────
|
|
46
|
+
OPENAI_API_KEY="sk-..."
|
|
47
|
+
ANTHROPIC_API_KEY="sk-ant-..."
|
|
48
|
+
GEMINI_API_KEY="..."
|
|
49
|
+
GROQ_API_KEY="gsk_..."
|
|
50
|
+
DEEPSEEK_API_KEY="..."
|
|
51
|
+
OPENROUTER_API_KEY="..."
|
|
52
|
+
XAI_API_KEY="..."
|
|
53
|
+
ZAI_API_KEY="..."
|
|
54
|
+
MINIMAX_API_KEY="..."
|
|
55
|
+
AZURE_API_KEY="..."
|
|
56
|
+
ORACLE_API_KEY="..."
|
|
57
|
+
OLLAMA_API_KEY="..."
|
|
58
|
+
VLLM_API_KEY="..."
|
|
59
|
+
JINA_API_KEY="..."
|
|
60
|
+
|
|
61
|
+
# ── OPTIONAL FEATURE TOGGLES (set true to enable) ────────
|
|
62
|
+
LOGGING_ENABLED=true # Audit logging to storage
|
|
63
|
+
METRICS_ENABLED=true # Prometheus /metrics endpoint
|
|
64
|
+
GUARDRAILS_ENABLED=true # Content safety filters
|
|
65
|
+
TOKEN_SAVER_ENABLED=true # Output compression to cut token use
|
|
66
|
+
|
|
67
|
+
# ── PRODUCTION STORAGE ───────────────────────────────────
|
|
68
|
+
# STORAGE_TYPE=postgresql
|
|
69
|
+
# POSTGRES_URL=postgres://user:pass@localhost:5432/aurora
|
|
70
|
+
|
|
71
|
+
# ── REDIS CACHE (model cache + response cache) ──────────
|
|
72
|
+
# REDIS_URL=redis://localhost:6379
|
|
73
|
+
# RESPONSE_CACHE_SIMPLE_ENABLED=true
|
|
44
74
|
```
|
|
45
75
|
|
|
46
76
|
```bash
|
|
47
77
|
aurora
|
|
48
78
|
```
|
|
49
79
|
|
|
50
|
-
|
|
80
|
+
### Option B — inline env vars (no `.env` needed)
|
|
51
81
|
|
|
52
82
|
```bash
|
|
53
83
|
# Linux / macOS
|
|
54
|
-
AURORA_MASTER_KEY=your-secure-key
|
|
84
|
+
AURORA_MASTER_KEY=your-secure-key \
|
|
85
|
+
OPENAI_API_KEY=sk-... \
|
|
86
|
+
ANTHROPIC_API_KEY=sk-ant-... \
|
|
87
|
+
GEMINI_API_KEY=... \
|
|
88
|
+
GROQ_API_KEY=gsk_... \
|
|
89
|
+
DEEPSEEK_API_KEY=... \
|
|
90
|
+
OPENROUTER_API_KEY=... \
|
|
91
|
+
XAI_API_KEY=... \
|
|
92
|
+
ZAI_API_KEY=... \
|
|
93
|
+
MINIMAX_API_KEY=... \
|
|
94
|
+
AZURE_API_KEY=... \
|
|
95
|
+
ORACLE_API_KEY=... \
|
|
96
|
+
OLLAMA_API_KEY=... \
|
|
97
|
+
VLLM_API_KEY=... \
|
|
98
|
+
JINA_API_KEY=... \
|
|
99
|
+
LOGGING_ENABLED=true \
|
|
100
|
+
METRICS_ENABLED=true \
|
|
101
|
+
GUARDRAILS_ENABLED=true \
|
|
102
|
+
TOKEN_SAVER_ENABLED=true \
|
|
103
|
+
aurora
|
|
55
104
|
|
|
56
105
|
# Windows PowerShell
|
|
57
|
-
$env:AURORA_MASTER_KEY="your-secure-key";
|
|
106
|
+
$env:AURORA_MASTER_KEY="your-secure-key"; `
|
|
107
|
+
$env:OPENAI_API_KEY="sk-..."; `
|
|
108
|
+
$env:ANTHROPIC_API_KEY="sk-ant-..."; `
|
|
109
|
+
$env:GEMINI_API_KEY="..."; `
|
|
110
|
+
$env:GROQ_API_KEY="gsk_..."; `
|
|
111
|
+
$env:DEEPSEEK_API_KEY="..."; `
|
|
112
|
+
$env:OPENROUTER_API_KEY="..."; `
|
|
113
|
+
$env:XAI_API_KEY="..."; `
|
|
114
|
+
$env:ZAI_API_KEY="..."; `
|
|
115
|
+
$env:MINIMAX_API_KEY="..."; `
|
|
116
|
+
$env:AZURE_API_KEY="..."; `
|
|
117
|
+
$env:ORACLE_API_KEY="..."; `
|
|
118
|
+
$env:OLLAMA_API_KEY="..."; `
|
|
119
|
+
$env:VLLM_API_KEY="..."; `
|
|
120
|
+
$env:JINA_API_KEY="..."; `
|
|
121
|
+
$env:LOGGING_ENABLED="true"; `
|
|
122
|
+
$env:METRICS_ENABLED="true"; `
|
|
123
|
+
$env:GUARDRAILS_ENABLED="true"; `
|
|
124
|
+
$env:TOKEN_SAVER_ENABLED="true"; `
|
|
125
|
+
aurora
|
|
58
126
|
|
|
59
127
|
# Windows CMD
|
|
60
|
-
set AURORA_MASTER_KEY=your-secure-key
|
|
128
|
+
set AURORA_MASTER_KEY=your-secure-key ^
|
|
129
|
+
&& set OPENAI_API_KEY=sk-... ^
|
|
130
|
+
&& set ANTHROPIC_API_KEY=sk-ant-... ^
|
|
131
|
+
&& set GEMINI_API_KEY=... ^
|
|
132
|
+
&& set GROQ_API_KEY=gsk_... ^
|
|
133
|
+
&& set DEEPSEEK_API_KEY=... ^
|
|
134
|
+
&& set OPENROUTER_API_KEY=... ^
|
|
135
|
+
&& set XAI_API_KEY=... ^
|
|
136
|
+
&& set ZAI_API_KEY=... ^
|
|
137
|
+
&& set MINIMAX_API_KEY=... ^
|
|
138
|
+
&& set AZURE_API_KEY=... ^
|
|
139
|
+
&& set ORACLE_API_KEY=... ^
|
|
140
|
+
&& set OLLAMA_API_KEY=... ^
|
|
141
|
+
&& set VLLM_API_KEY=... ^
|
|
142
|
+
&& set JINA_API_KEY=... ^
|
|
143
|
+
&& set LOGGING_ENABLED=true ^
|
|
144
|
+
&& set METRICS_ENABLED=true ^
|
|
145
|
+
&& set GUARDRAILS_ENABLED=true ^
|
|
146
|
+
&& set TOKEN_SAVER_ENABLED=true ^
|
|
147
|
+
&& aurora
|
|
61
148
|
```
|
|
62
149
|
|
|
63
|
-
### Docker
|
|
150
|
+
### Option C — Docker
|
|
64
151
|
|
|
65
152
|
```bash
|
|
66
153
|
docker run -d --name aurora -p 8080:8080 \
|
|
67
154
|
-e AURORA_MASTER_KEY="your-secure-key" \
|
|
155
|
+
-e OPENAI_API_KEY="sk-..." \
|
|
156
|
+
-e ANTHROPIC_API_KEY="sk-ant-..." \
|
|
157
|
+
-e GEMINI_API_KEY="..." \
|
|
68
158
|
-e GROQ_API_KEY="gsk_..." \
|
|
159
|
+
-e DEEPSEEK_API_KEY="..." \
|
|
160
|
+
-e OPENROUTER_API_KEY="..." \
|
|
161
|
+
-e XAI_API_KEY="..." \
|
|
162
|
+
-e ZAI_API_KEY="..." \
|
|
163
|
+
-e MINIMAX_API_KEY="..." \
|
|
164
|
+
-e AZURE_API_KEY="..." \
|
|
165
|
+
-e ORACLE_API_KEY="..." \
|
|
166
|
+
-e OLLAMA_API_KEY="..." \
|
|
167
|
+
-e VLLM_API_KEY="..." \
|
|
168
|
+
-e JINA_API_KEY="..." \
|
|
169
|
+
-e LOGGING_ENABLED=true \
|
|
170
|
+
-e METRICS_ENABLED=true \
|
|
171
|
+
-e GUARDRAILS_ENABLED=true \
|
|
172
|
+
-e TOKEN_SAVER_ENABLED=true \
|
|
69
173
|
aurorahq/aurora
|
|
70
174
|
```
|
|
71
175
|
|
|
72
|
-
### Kubernetes (Helm)
|
|
176
|
+
### Option D — Kubernetes (Helm)
|
|
73
177
|
|
|
74
178
|
```bash
|
|
179
|
+
# Quick dev — Groq, no Redis, no auth
|
|
75
180
|
helm install aurora ./helm \
|
|
76
181
|
--namespace aurora --create-namespace \
|
|
182
|
+
--set image.repository=aurorahq/aurora \
|
|
183
|
+
--set image.tag=latest \
|
|
184
|
+
--set providers.groq.apiKey="gsk_your_key_here" \
|
|
185
|
+
--set providers.groq.enabled=true \
|
|
186
|
+
--set redis.enabled=false \
|
|
187
|
+
--set auth.masterKey=""
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
```bash
|
|
191
|
+
# Production — multiple providers, auth, Redis
|
|
192
|
+
helm upgrade --install aurora ./helm \
|
|
193
|
+
--namespace aurora --create-namespace \
|
|
194
|
+
--set image.repository=aurorahq/aurora \
|
|
195
|
+
--set image.tag=latest \
|
|
77
196
|
--set auth.masterKey="your-secure-key" \
|
|
197
|
+
--set providers.openai.apiKey="sk-..." \
|
|
198
|
+
--set providers.openai.enabled=true \
|
|
199
|
+
--set providers.anthropic.apiKey="sk-ant-..." \
|
|
200
|
+
--set providers.anthropic.enabled=true \
|
|
201
|
+
--set providers.gemini.apiKey="..." \
|
|
202
|
+
--set providers.gemini.enabled=true \
|
|
78
203
|
--set providers.groq.apiKey="gsk_..." \
|
|
79
204
|
--set providers.groq.enabled=true \
|
|
80
|
-
--set
|
|
205
|
+
--set providers.deepseek.apiKey="..." \
|
|
206
|
+
--set providers.deepseek.enabled=true \
|
|
207
|
+
--set providers.openrouter.apiKey="..." \
|
|
208
|
+
--set providers.openrouter.enabled=true \
|
|
209
|
+
--set providers.xai.apiKey="..." \
|
|
210
|
+
--set providers.xai.enabled=true \
|
|
211
|
+
--set providers.zai.apiKey="..." \
|
|
212
|
+
--set providers.zai.enabled=true \
|
|
213
|
+
--set providers.minimax.apiKey="..." \
|
|
214
|
+
--set providers.minimax.enabled=true \
|
|
215
|
+
--set providers.azure.apiKey="..." \
|
|
216
|
+
--set providers.azure.enabled=true \
|
|
217
|
+
--set providers.oracle.apiKey="..." \
|
|
218
|
+
--set providers.oracle.enabled=true \
|
|
219
|
+
--set providers.ollama.apiKey="..." \
|
|
220
|
+
--set providers.ollama.enabled=true \
|
|
221
|
+
--set providers.vllm.apiKey="..." \
|
|
222
|
+
--set providers.vllm.enabled=true \
|
|
223
|
+
--set logging.enabled=true \
|
|
224
|
+
--set metrics.enabled=true \
|
|
225
|
+
--set guardrails.enabled=true \
|
|
226
|
+
--set tokenSaver.enabled=true \
|
|
227
|
+
--set redis.enabled=true
|
|
81
228
|
```
|
|
82
229
|
|
|
230
|
+
**Full Helm docs:** [helm/README.md](./helm/README.md)
|
|
231
|
+
|
|
83
232
|
### Test your gateway
|
|
84
233
|
|
|
85
234
|
```bash
|
|
86
235
|
curl http://localhost:8080/v1/chat/completions \
|
|
87
236
|
-H "Content-Type: application/json" \
|
|
88
|
-
-H "Authorization: Bearer
|
|
89
|
-
-d '{"model":"groq/llama-
|
|
237
|
+
-H "Authorization: Bearer your-master-key" \
|
|
238
|
+
-d '{"model":"groq/llama-4-scout-17b-16e-instruct","messages":[{"role":"user","content":"Hello!"}]}'
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
Anthropic format with streaming enabled:
|
|
242
|
+
|
|
243
|
+
```bash
|
|
244
|
+
curl http://localhost:8080/v1/messages \
|
|
245
|
+
-H "Content-Type: application/json" \
|
|
246
|
+
-H "Authorization: Bearer your-master-key" \
|
|
247
|
+
-H "anthropic-version: 2023-06-01" \
|
|
248
|
+
-d '{
|
|
249
|
+
"model": "anthropic/claude-sonnet-5-20260630",
|
|
250
|
+
"max_tokens": 1024,
|
|
251
|
+
"stream": true,
|
|
252
|
+
"messages": [{"role": "user", "content": "Hello!"}]
|
|
253
|
+
}'
|
|
90
254
|
```
|
|
91
255
|
|
|
92
256
|
Dashboard: `http://localhost:8080/admin/dashboard`
|
|
93
257
|
|
|
94
|
-
**Setup guides:** [npm](https://www.npmjs.com/package/iaurora) · [Docker](https://hub.docker.com/r/aurorahq/aurora) · [Helm/Kubernetes](https://github.com/aurorallm/aurora/tree/main/helm) · [Source](https://github.com/aurorallm/aurora)
|
|
258
|
+
**Setup guides:** [Website](https://aurorallm.online/) · [npm](https://www.npmjs.com/package/iaurora) · [Docker](https://hub.docker.com/r/aurorahq/aurora) · [Helm/Kubernetes](https://github.com/aurorallm/aurora/tree/main/helm) · [Source](https://github.com/aurorallm/aurora)
|
|
95
259
|
|
|
96
260
|
---
|
|
97
261
|
|
|
@@ -102,8 +266,8 @@ In addition to private networking, custom security controls, and governance, **A
|
|
|
102
266
|
|
|
103
267
|
The Enterprise edition is a separate distribution with a signed license.
|
|
104
268
|
|
|
105
|
-
<a href="https://raw.githubusercontent.com/aurorallm/aurora/main/docs/assets/comparison.png">
|
|
106
|
-
<img src="https://raw.githubusercontent.com/aurorallm/aurora/main/docs/assets/comparison.png" alt="OSS vs Enterprise comparison" width="100%" style="border-radius:12px;margin:16px 0;">
|
|
269
|
+
<a href="https://raw.githubusercontent.com/aurorallm/aurora/main/docs-assets/assets/comparison.png">
|
|
270
|
+
<img src="https://raw.githubusercontent.com/aurorallm/aurora/main/docs-assets/assets/comparison.png" alt="OSS vs Enterprise comparison" width="100%" style="border-radius:12px;margin:16px 0;">
|
|
107
271
|
</a>
|
|
108
272
|
|
|
109
273
|
<div align="center">
|
|
@@ -114,57 +278,23 @@ The Enterprise edition is a separate distribution with a signed license.
|
|
|
114
278
|
|
|
115
279
|
---
|
|
116
280
|
|
|
117
|
-
## Kubernetes (Helm)
|
|
118
|
-
|
|
119
|
-
Deploy on any Kubernetes cluster with the [Helm chart](https://github.com/aurorallm/aurora/tree/main/helm).
|
|
120
|
-
|
|
121
|
-
```bash
|
|
122
|
-
# Quick dev — Groq, no Redis, no auth
|
|
123
|
-
helm install aurora ./helm \
|
|
124
|
-
--namespace aurora --create-namespace \
|
|
125
|
-
--set image.tag=1.0.25 \
|
|
126
|
-
--set providers.groq.apiKey="gsk_your_key_here" \
|
|
127
|
-
--set providers.groq.enabled=true \
|
|
128
|
-
--set redis.enabled=false \
|
|
129
|
-
--set auth.masterKey=""
|
|
130
|
-
```
|
|
131
|
-
|
|
132
|
-
```bash
|
|
133
|
-
# Production — multiple providers, auth, Redis
|
|
134
|
-
helm upgrade --install aurora ./helm \
|
|
135
|
-
--namespace aurora --create-namespace \
|
|
136
|
-
--set image.tag=1.0.25 \
|
|
137
|
-
--set auth.masterKey="your-secure-key" \
|
|
138
|
-
--set providers.openai.apiKey="sk-..." \
|
|
139
|
-
--set providers.openai.enabled=true \
|
|
140
|
-
--set providers.anthropic.apiKey="sk-ant-..." \
|
|
141
|
-
--set providers.anthropic.enabled=true \
|
|
142
|
-
--set redis.enabled=true
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
**Full Helm docs:** [helm/README.md](./helm/README.md)
|
|
146
|
-
|
|
147
|
-
---
|
|
148
|
-
|
|
149
281
|
## Providers
|
|
150
282
|
|
|
151
283
|
Providers are **auto-discovered from environment variables**. Set any provider's `_API_KEY` and restart — the provider and its default models appear automatically.
|
|
152
284
|
|
|
153
285
|
> **Security note for public docs:** The env var names listed below are documentation references. Actual secrets go into your **`.env` file** (in `.gitignore`) or your **deployment secrets manager** — never commit them.
|
|
154
286
|
|
|
155
|
-
### All supported providers
|
|
156
|
-
|
|
157
287
|
| Provider | Env var | Default base URL | Requires base URL | API key required | Default models |
|
|
158
288
|
|----------|---------|-----------------|-------------------|-----------------|----------------|
|
|
159
|
-
| OpenAI | `OPENAI_API_KEY` | `https://api.openai.com/v1` | No | Yes | `gpt-
|
|
160
|
-
| Anthropic | `ANTHROPIC_API_KEY` | `https://api.anthropic.com/v1` | No | Yes | `claude-sonnet-
|
|
161
|
-
| Google Gemini | `GEMINI_API_KEY` | `https://generativelanguage.googleapis.com/v1beta/openai` | No | Yes | `gemini-
|
|
162
|
-
| Groq | `GROQ_API_KEY` | `https://api.groq.com/openai/v1` | No | Yes | `llama-
|
|
163
|
-
| DeepSeek | `DEEPSEEK_API_KEY` | `https://api.deepseek.com` | No | Yes | `deepseek-
|
|
289
|
+
| OpenAI | `OPENAI_API_KEY` | `https://api.openai.com/v1` | No | Yes | `gpt-5.6-sol`, `gpt-5.6-luna` |
|
|
290
|
+
| Anthropic | `ANTHROPIC_API_KEY` | `https://api.anthropic.com/v1` | No | Yes | `claude-sonnet-5`, `claude-fable-5` |
|
|
291
|
+
| Google Gemini | `GEMINI_API_KEY` | `https://generativelanguage.googleapis.com/v1beta/openai` | No | Yes | `gemini-3.1-pro`, `gemini-3.5-flash` |
|
|
292
|
+
| Groq | `GROQ_API_KEY` | `https://api.groq.com/openai/v1` | No | Yes | `llama-4-scout-17b`, `llama-4-maverick-17b`, `qwen3-32b` |
|
|
293
|
+
| DeepSeek | `DEEPSEEK_API_KEY` | `https://api.deepseek.com` | No | Yes | `deepseek-v4-pro`, `deepseek-v4-flash` |
|
|
164
294
|
| OpenRouter | `OPENROUTER_API_KEY` | `https://openrouter.ai/api/v1` | No | Yes | 300+ models |
|
|
165
|
-
| xAI (Grok) | `XAI_API_KEY` | `https://api.x.ai/v1` | No | Yes | `grok-
|
|
166
|
-
| Z.ai | `ZAI_API_KEY` | `https://api.z.ai/api/paas/v4` | No | Yes | `glm-
|
|
167
|
-
| MiniMax | `MINIMAX_API_KEY` | `https://api.minimax.io/v1` | No | Yes | `minimax-
|
|
295
|
+
| xAI (Grok) | `XAI_API_KEY` | `https://api.x.ai/v1` | No | Yes | `grok-4.5`, `grok-4.3` |
|
|
296
|
+
| Z.ai | `ZAI_API_KEY` | `https://api.z.ai/api/paas/v4` | No | Yes | `glm-5.2` |
|
|
297
|
+
| MiniMax | `MINIMAX_API_KEY` | `https://api.minimax.io/v1` | No | Yes | `minimax-m3` |
|
|
168
298
|
| Azure OpenAI | `AZURE_API_KEY` | — | **Yes** | Yes | Your deployments |
|
|
169
299
|
| Oracle | `ORACLE_API_KEY` | — | **Yes** | Yes | `cohere.command-r-plus` |
|
|
170
300
|
| Ollama | `OLLAMA_API_KEY` | `http://localhost:11434/v1` | No | **No** (optional) | Any local model |
|
|
@@ -176,7 +306,7 @@ Providers are **auto-discovered from environment variables**. Set any provider's
|
|
|
176
306
|
Every provider supports `*_MODELS` to override auto-discovered models:
|
|
177
307
|
|
|
178
308
|
```env
|
|
179
|
-
OPENAI_MODELS=gpt-
|
|
309
|
+
OPENAI_MODELS=gpt-5.6-sol,gpt-5.6-terra,gpt-5.6-luna
|
|
180
310
|
```
|
|
181
311
|
|
|
182
312
|
OpenRouter extras:
|
|
@@ -238,30 +368,23 @@ Generated by `aurora init`, every section of `config.yaml` is documented inline:
|
|
|
238
368
|
| `fallback` | Provider failover rules |
|
|
239
369
|
| `resilience` | Retry + circuit breaker |
|
|
240
370
|
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
### Essential `.env` variables
|
|
244
|
-
|
|
245
|
-
Minimal set to get the gateway running:
|
|
371
|
+
### Quick config profiles
|
|
246
372
|
|
|
247
|
-
|
|
248
|
-
# ── REQUIRED ──────────────────────────────────────────────
|
|
249
|
-
AURORA_MASTER_KEY=replace-with-secure-random-key
|
|
373
|
+
Aurora ships pre-built config profiles in `configs/editions/`:
|
|
250
374
|
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
375
|
+
| Profile | File | Use case |
|
|
376
|
+
|---------|------|----------|
|
|
377
|
+
| OSS | `oss.env.example` | Minimal local — SQLite, no Redis |
|
|
378
|
+
| OSS Local Power | `oss.local-power.env.example` | SQLite + Redis exact cache |
|
|
379
|
+
| OSS Team | `oss.team.env.example` | Postgres + Redis + Qdrant — full team deployment |
|
|
254
380
|
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
STORAGE_TYPE=sqlite # sqlite (default), postgresql, mongodb
|
|
258
|
-
LOG_LEVEL=info # debug, info, warn, error
|
|
259
|
-
LOG_FORMAT=text # text or json
|
|
381
|
+
```bash
|
|
382
|
+
export AURORA_CONFIG_PATH=configs/editions/oss.team.example.yaml
|
|
260
383
|
```
|
|
261
384
|
|
|
262
|
-
### Configuring
|
|
385
|
+
### Configuring across deployment methods
|
|
263
386
|
|
|
264
|
-
Each env var
|
|
387
|
+
Each env var works in all three deploy modes:
|
|
265
388
|
|
|
266
389
|
| Variable | `.env` file | Docker `-e` flag | Helm `--set` value |
|
|
267
390
|
|----------|-------------|------------------|---------------------|
|
|
@@ -271,8 +394,6 @@ Each env var below works in all three deploy modes — here is an example:
|
|
|
271
394
|
| `STORAGE_TYPE` | `STORAGE_TYPE=postgresql` | `-e STORAGE_TYPE=postgresql` | `--set storage.type=postgresql` |
|
|
272
395
|
| `REDIS_URL` | `REDIS_URL=redis://...` | `-e REDIS_URL=redis://...` | `--set cache.redis.url=...` |
|
|
273
396
|
|
|
274
|
-
---
|
|
275
|
-
|
|
276
397
|
### Complete env var reference
|
|
277
398
|
|
|
278
399
|
All configurable environment variables, organized by subsystem:
|
|
@@ -320,7 +441,7 @@ All configurable environment variables, organized by subsystem:
|
|
|
320
441
|
|
|
321
442
|
| Env var | Default | Description |
|
|
322
443
|
|---------|---------|-------------|
|
|
323
|
-
| `MODEL_LIST_URL` | `https://
|
|
444
|
+
| `MODEL_LIST_URL` | `https://github.com/aurorallm/aurora/blob/main/docs-assets/assets/models.json` | External model metadata registry (empty = disabled) |
|
|
324
445
|
| `MODEL_LIST_LOCAL_PATH` | `data/models.local.json` | Local model registry snapshot path |
|
|
325
446
|
| `MODEL_LIST_USER_OVERRIDES_PATH` | `data/user_pricing.yaml` | User pricing override file |
|
|
326
447
|
| `MODELS_ENABLED_BY_DEFAULT` | `true` | Default enabled state for provider models |
|
|
@@ -469,22 +590,6 @@ All configurable environment variables, organized by subsystem:
|
|
|
469
590
|
|
|
470
591
|
---
|
|
471
592
|
|
|
472
|
-
### Quick config profiles
|
|
473
|
-
|
|
474
|
-
Aurora ships pre-built config profiles in `configs/editions/`:
|
|
475
|
-
|
|
476
|
-
| Profile | File | Use case |
|
|
477
|
-
|---------|------|----------|
|
|
478
|
-
| OSS | `oss.env.example` | Minimal local — SQLite, no Redis |
|
|
479
|
-
| OSS Local Power | `oss.local-power.env.example` | SQLite + Redis exact cache |
|
|
480
|
-
| OSS Team | `oss.team.env.example` | Postgres + Redis + Qdrant — full team deployment |
|
|
481
|
-
|
|
482
|
-
```bash
|
|
483
|
-
export AURORA_CONFIG_PATH=configs/editions/oss.team.example.yaml
|
|
484
|
-
```
|
|
485
|
-
|
|
486
|
-
---
|
|
487
|
-
|
|
488
593
|
## CLI Reference
|
|
489
594
|
|
|
490
595
|
The `aurora` CLI is installed via `npm install -g iaurora`.
|
|
@@ -530,14 +635,17 @@ aurora/
|
|
|
530
635
|
|
|
531
636
|
## Documentation
|
|
532
637
|
|
|
638
|
+
- [Website](https://aurorallm.online/)
|
|
533
639
|
- [CLI Reference](https://github.com/aurorallm/aurora)
|
|
534
640
|
- [Provider Configuration](https://github.com/aurorallm/aurora)
|
|
535
641
|
- [Admin Dashboard](https://github.com/aurorallm/aurora)
|
|
536
642
|
- [Docker Compose & Helm](https://github.com/aurorallm/aurora)
|
|
537
643
|
|
|
644
|
+
---
|
|
645
|
+
|
|
538
646
|
## Need Help?
|
|
539
647
|
|
|
540
|
-
[Join our Discord](https://discord.
|
|
648
|
+
[Join our Discord](https://discord.gg/AfaFBSU2km) for community support, setup help, and discussions.
|
|
541
649
|
|
|
542
650
|
---
|
|
543
651
|
|
package/bin/aurora.exe
CHANGED
|
Binary file
|
package/package.json
CHANGED