From 124fbedf2a10caa37578cdf03e5e503d40476c23 Mon Sep 17 00:00:00 2001 From: Shroominic Date: Wed, 3 Sep 2025 13:49:14 +0100 Subject: [PATCH] update core config docs --- docs/getting-started/configuration.md | 9 +++------ docs/user-guide/using-api.md | 18 +++++++++--------- 2 files changed, 12 insertions(+), 15 deletions(-) diff --git a/docs/getting-started/configuration.md b/docs/getting-started/configuration.md index fbae2047..904553b7 100644 --- a/docs/getting-started/configuration.md +++ b/docs/getting-started/configuration.md @@ -10,8 +10,6 @@ Routstr Core is configured through environment variables. This guide covers all |----------|-------------|---------|----------| | `UPSTREAM_BASE_URL` | Base URL of the OpenAI-compatible API to proxy | - | ✅ | | `UPSTREAM_API_KEY` | API key for the upstream service | - | ❌ | -| `CHAT_COMPLETIONS_API_VERSION` | Append `api-version` to `/chat/completions` (Azure OpenAI) | - | ❌ | -| `DATABASE_URL` | SQLite database connection string | `sqlite+aiosqlite:///keys.db` | ❌ | | `ADMIN_PASSWORD` | Password for admin dashboard access | - | ⚠️ | ### Node Information @@ -56,13 +54,12 @@ Routstr Core is configured through environment variables. This guide covers all | `LOG_LEVEL` | Logging level (DEBUG, INFO, WARNING, ERROR) | `INFO` | ❌ | | `ENABLE_CONSOLE_LOGGING` | Enable console log output | `true` | ❌ | -### Model Management +### Other | Variable | Description | Default | Required | |----------|-------------|---------|----------| -| `MODELS_PATH` | Path to custom models.json file | `models.json` | ❌ | -| `BASE_URL` | Base URL for fetching model info | `https://openrouter.ai/api/v1` | ❌ | -| `SOURCE` | Filter models by source provider | - | ❌ | +| `CHAT_COMPLETIONS_API_VERSION` | Append `api-version` to `/chat/completions` (Azure OpenAI) | - | ❌ | +| `DATABASE_URL` | SQLite database connection string | `sqlite+aiosqlite:///keys.db` | ❌ | ## Configuration Examples diff --git a/docs/user-guide/using-api.md b/docs/user-guide/using-api.md index c980de78..5ad32509 100644 --- a/docs/user-guide/using-api.md +++ b/docs/user-guide/using-api.md @@ -10,15 +10,6 @@ Routstr maintains full compatibility with the OpenAI API, meaning: - Only the base URL and API key need to change - All parameters and responses match OpenAI's format -### Azure OpenAI compatibility - -To use Azure OpenAI through Routstr with minimal changes: - -- Set `UPSTREAM_BASE_URL` to your Azure deployments URL, for example: `https://.openai.azure.com/openai/deployments/` -- Set `CHAT_COMPLETIONS_API_VERSION=2024-05-01-preview` - -When this env var is set, Routstr automatically appends `api-version=2024-05-01-preview` to all upstream `/chat/completions` requests. - ## Basic Setup ### Python @@ -325,6 +316,15 @@ client = OpenAI( ) ``` +### Azure OpenAI compatibility + +To use Azure OpenAI through Routstr with minimal changes: + +- Set `UPSTREAM_BASE_URL` to your Azure deployments URL, for example: `https://.openai.azure.com/openai/deployments/` +- Set `CHAT_COMPLETIONS_API_VERSION=2024-05-01-preview` + +When this env var is set, Routstr automatically appends `api-version=2024-05-01-preview` to all upstream `/chat/completions` requests. + ### Async Operations For high-performance applications: