Skip to content

Commit 46fdd99

Browse files
author
Chao Huang
committed
docs: update all documentation for accuracy and rename
- Rename all "Kolya BR Proxy" references to "BR Enterprise Proxy" - Fix token hashing: docs incorrectly claimed PBKDF2 (actual: SHA256) - Fix timeout values in performance docs (read_timeout=3600, keep_alive=3700) - Fix cache write multiplier: add 2.0x for 1h TTL (default) - Add RBAC and Teams sections to security docs - Update testing guide with all test files - Fix deployment log examples (module name)
1 parent 4a7ad9e commit 46fdd99

22 files changed

Lines changed: 238 additions & 180 deletions

docs/api-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# API Reference
22

3-
Kolya BR Proxy exposes four API groups:
3+
BR Enterprise Proxy exposes four API groups:
44

55
| Group | Prefix | Auth | Purpose |
66
|-------|--------|------|---------|

docs/api-reference.zh.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# API 参考
22

3-
Kolya BR Proxy 提供四组 API:
3+
BR Enterprise Proxy 提供四组 API:
44

55
| 分组 | 前缀 | 认证方式 | 用途 |
66
|------|------|----------|------|

docs/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Architecture
22

3-
Comprehensive architecture documentation for Kolya BR Proxy -- an AI Gateway that provides both OpenAI-compatible and Anthropic Messages API access to AWS Bedrock models (Claude, Nova, DeepSeek, Mistral, Llama, etc.) and Google Gemini models via the native generateContent API.
3+
Comprehensive architecture documentation for BR Enterprise Proxy -- an AI Gateway that provides both OpenAI-compatible and Anthropic Messages API access to AWS Bedrock models (Claude, Nova, DeepSeek, Mistral, Llama, etc.) and Google Gemini models via the native generateContent API.
44

55
---
66

docs/architecture.zh.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 架构文档
22

3-
Kolya BR Proxy 综合架构文档 -- 一个提供 OpenAI 兼容 API 和 Anthropic Messages API 访问 AWS Bedrock 模型(Claude、Nova、DeepSeek、Mistral、Llama 等)以及通过原生 generateContent API 访问 Google Gemini 模型的 AI 网关。
3+
BR Enterprise Proxy 综合架构文档 -- 一个提供 OpenAI 兼容 API 和 Anthropic Messages API 访问 AWS Bedrock 模型(Claude、Nova、DeepSeek、Mistral、Llama 等)以及通过原生 generateContent API 访问 Google Gemini 模型的 AI 网关。
44

55
---
66

docs/deployment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Kolya BR Proxy — Deployment SOP
1+
# BR Enterprise Proxy — Deployment SOP
22

33
This document covers the full deployment and teardown lifecycle on AWS EKS.
44

@@ -374,8 +374,8 @@ When no token context is available the field shows `[-]`.
374374
Example output:
375375

376376
```
377-
2026-04-11 08:23:01,234 - kolya_br_proxy.router - INFO - [my-team-key] streaming request to us-west-2
378-
2026-04-11 08:23:05,678 - kolya_br_proxy.router - WARNING - [-] health check from unknown caller
377+
2026-04-11 08:23:01,234 - app.router - INFO - [my-team-key] streaming request to us-west-2
378+
2026-04-11 08:23:05,678 - app.router - WARNING - [-] health check from unknown caller
379379
```
380380

381381
---

docs/deployment.zh.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Kolya BR Proxy — 部署 SOP
1+
# BR Enterprise Proxy — 部署 SOP
22

33
本文档涵盖 AWS EKS 上的完整部署和销毁流程。
44

@@ -374,8 +374,8 @@ Terraform workspace(`prod` vs 其他)决定资源规格:
374374
输出示例:
375375

376376
```
377-
2026-04-11 08:23:01,234 - kolya_br_proxy.router - INFO - [my-team-key] streaming request to us-west-2
378-
2026-04-11 08:23:05,678 - kolya_br_proxy.router - WARNING - [-] health check from unknown caller
377+
2026-04-11 08:23:01,234 - app.router - INFO - [my-team-key] streaming request to us-west-2
378+
2026-04-11 08:23:05,678 - app.router - WARNING - [-] health check from unknown caller
379379
```
380380

381381
---

docs/kolya_ask.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ When conversation history approaches the context limit, Claude Code uses Haiku t
103103

104104
```
105105
INFO: Waiting for application startup.
106-
10:18:22 - Starting Kolya BR Proxy...
106+
10:18:22 - Starting BR Enterprise Proxy...
107107
- Database engine initialized, tables created/verified
108108
- Rate limiter: Redis distributed mode, global 8.33 req/s (500 RPM),
109109
burst=10, local fallback 2.78 req/s (÷3 pods)
@@ -134,7 +134,7 @@ INFO: Waiting for application startup.
134134
Update model pricing from AWS (02:00 UTC)
135135
Update Gemini model pricing from Google (02:30 UTC)
136136
- Pricing update scheduler started
137-
- Kolya BR Proxy started successfully
137+
- BR Enterprise Proxy started successfully
138138
139139
INFO: Application startup complete.
140140
INFO: Uvicorn running on http://0.0.0.0:8000

docs/kolya_ask.zh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Claude Code 会定期用 `smallFastModel` 把对话内容写入 `MEMORY.md`,
103103

104104
```
105105
INFO: 等待应用启动
106-
10:18:22 - 启动 Kolya BR Proxy...
106+
10:18:22 - 启动 BR Enterprise Proxy...
107107
- 数据库引擎初始化、表创建/验证完成
108108
- 限流器:Redis 分布式模式,全局 8.33 req/s(500 RPM),burst=10
109109
本地 fallback 2.78 req/s(÷3 pods)
@@ -132,7 +132,7 @@ INFO: 等待应用启动
132132
从 AWS 更新模型定价(02:00 UTC)
133133
从 Google 更新 Gemini 模型定价(02:30 UTC)
134134
- 定价更新调度器已启动
135-
- Kolya BR Proxy 启动成功
135+
- BR Enterprise Proxy 启动成功
136136
137137
INFO: 应用启动完成
138138
INFO: Uvicorn 运行在 http://0.0.0.0:8000

docs/oauth-setup.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OAuth Setup Guide
22

3-
Kolya BR Proxy uses OAuth exclusively for authentication (no local username/password). Two OAuth providers are supported:
3+
BR Enterprise Proxy uses OAuth exclusively for authentication (no local username/password). Two OAuth providers are supported:
44

55
- **AWS Cognito** (default/recommended) -- AWS-managed user pool authentication
66
- **Microsoft Entra ID** (Azure AD) -- personal and enterprise Microsoft accounts
@@ -21,7 +21,7 @@ Cognito is the default provider selected during deployment via `deploy-all.sh`.
2121
1. Under your User Pool, go to **App integration** > **App client** > **Create app client**.
2222
2. Select **Confidential client** (server-side).
2323
3. Set:
24-
- **App client name**: `Kolya BR Proxy`
24+
- **App client name**: `BR Enterprise Proxy`
2525
- **Generate client secret**: Yes
2626
- **Allowed callback URLs**: `http://localhost:3000/auth/cognito/callback`
2727
- For production, add `https://<your-domain>/auth/cognito/callback`
@@ -131,7 +131,7 @@ Frontend Backend Cognito
131131

132132
1. Go to [Azure Portal > App registrations](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/RegisteredApps) and click **New registration**.
133133
2. Fill in:
134-
- **Name**: `Kolya BR Proxy`
134+
- **Name**: `BR Enterprise Proxy`
135135
- **Supported account types**: "Accounts in any organizational directory and personal Microsoft accounts" (multi-tenant)
136136
- **Redirect URI**: Platform `Web`, URI `http://localhost:3000/auth/microsoft/callback`
137137
- For production, add `https://<your-domain>/auth/microsoft/callback`
@@ -143,7 +143,7 @@ Frontend Backend Cognito
143143
### Step 2: Create Client Secret
144144

145145
1. Go to **Certificates & secrets** > **New client secret**.
146-
2. Set description (e.g. `Kolya BR Proxy Secret`) and expiry (up to 24 months).
146+
2. Set description (e.g. `BR Enterprise Proxy Secret`) and expiry (up to 24 months).
147147
3. Click **Add** and immediately copy the **Value** (shown only once).
148148

149149
### Step 3: Configure API Permissions

docs/oauth-setup.zh.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OAuth 配置指南
22

3-
Kolya BR Proxy 仅使用 OAuth 进行认证(不支持本地用户名/密码)。支持两种 OAuth 提供商:
3+
BR Enterprise Proxy 仅使用 OAuth 进行认证(不支持本地用户名/密码)。支持两种 OAuth 提供商:
44

55
- **AWS Cognito**(默认/推荐)-- AWS 托管的用户池认证
66
- **Microsoft Entra ID**(Azure AD)-- 个人和企业 Microsoft 账户
@@ -21,7 +21,7 @@ Cognito 是通过 `deploy-all.sh` 部署时默认选择的认证提供商。两
2121
1. 在用户池下,进入 **应用集成** > **应用客户端** > **创建应用客户端**
2222
2. 选择 **机密客户端**(服务端)。
2323
3. 设置:
24-
- **应用客户端名称**`Kolya BR Proxy`
24+
- **应用客户端名称**`BR Enterprise Proxy`
2525
- **生成客户端密钥**:是
2626
- **允许的回调 URL**`http://localhost:3000/auth/cognito/callback`
2727
- 生产环境添加 `https://<your-domain>/auth/cognito/callback`
@@ -131,7 +131,7 @@ aws cognito-idp admin-set-user-password \
131131

132132
1. 访问 [Azure 门户 > 应用注册](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/RegisteredApps),点击 **新注册**
133133
2. 填写以下信息:
134-
- **名称**`Kolya BR Proxy`
134+
- **名称**`BR Enterprise Proxy`
135135
- **支持的帐户类型**:「任何组织目录中的帐户和个人 Microsoft 帐户」(多租户)
136136
- **重定向 URI**:平台选 `Web`,URI 为 `http://localhost:3000/auth/microsoft/callback`
137137
- 生产环境另外添加 `https://<your-domain>/auth/microsoft/callback`
@@ -143,7 +143,7 @@ aws cognito-idp admin-set-user-password \
143143
### 步骤二:创建客户端密钥
144144

145145
1. 进入 **证书和密码** > **新客户端密码**
146-
2. 设置说明(如 `Kolya BR Proxy Secret`)和有效期(最长 24 个月)。
146+
2. 设置说明(如 `BR Enterprise Proxy Secret`)和有效期(最长 24 个月)。
147147
3. 点击 **添加**,并立即复制 ****(仅显示一次)。
148148

149149
### 步骤三:配置 API 权限

0 commit comments

Comments
 (0)