Skip to content

Commit 9319602

Browse files
committed
UPDATE README
1 parent 8e95c5e commit 9319602

File tree

2 files changed

+3
-31
lines changed

2 files changed

+3
-31
lines changed

README.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -466,6 +466,7 @@ An S3-compatible object storage service can host configuration and authenticatio
466466

467467
| Variable | Required | Default | Description |
468468
|--------------------------|----------|--------------------------------|--------------------------------------------------------------------------------------------------------------------------|
469+
| `MANAGEMENT_PASSWORD` | Yes | | Password for the management web UI (required when remote management is enabled). |
469470
| `OBJECTSTORE_ENDPOINT` | Yes | | Object storage endpoint. Include `http://` or `https://` to force the protocol (omitted scheme → HTTPS). |
470471
| `OBJECTSTORE_BUCKET` | Yes | | Bucket that stores `config/config.yaml` and `auths/*.json`. |
471472
| `OBJECTSTORE_ACCESS_KEY` | Yes | | Access key ID for the object storage account. |
@@ -531,21 +532,6 @@ And you can always use Gemini CLI with `CODE_ASSIST_ENDPOINT` set to `http://127
531532

532533
The `auth-dir` parameter specifies where authentication tokens are stored. When you run the login command, the application will create JSON files in this directory containing the authentication tokens for your Google accounts. Multiple accounts can be used for load balancing.
533534

534-
### Request Authentication Providers
535-
536-
Configure inbound authentication through the `auth.providers` section. The built-in `config-api-key` provider works with inline keys:
537-
538-
```
539-
auth:
540-
providers:
541-
- name: default
542-
type: config-api-key
543-
api-keys:
544-
- your-api-key-1
545-
```
546-
547-
Clients should send requests with an `Authorization: Bearer your-api-key-1` header (or `X-Goog-Api-Key`, `X-Api-Key`, or `?key=` as before). The legacy top-level `api-keys` array is still accepted and automatically synced to the default provider for backwards compatibility.
548-
549535
### Official Generative Language API
550536

551537
The `generative-language-api-key` parameter allows you to define a list of API keys that can be used to authenticate requests to the official Generative Language API.

README_CN.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,7 @@ openai-compatibility:
438438

439439
| 变量 | 必需 | 默认值 | 描述 |
440440
|-------------------------|----|--------|----------------------------------------------------|
441-
| `MANAGEMENT_PASSWORD` | 是 | | 控制面板密码 |
441+
| `MANAGEMENT_PASSWORD` | 是 | | 管理面板密码 |
442442
| `GITSTORE_GIT_URL` | 是 | | 要使用的 Git 仓库的 HTTPS URL。 |
443443
| `GITSTORE_LOCAL_PATH` | 否 | 当前工作目录 | 将克隆 Git 仓库的本地路径。在 Docker 内部,此路径默认为 `/CLIProxyAPI`。 |
444444
| `GITSTORE_GIT_USERNAME` | 否 | | 用于 Git 身份验证的用户名。 |
@@ -479,6 +479,7 @@ openai-compatibility:
479479

480480
| 变量 | 是否必填 | 默认值 | 说明 |
481481
|--------------------------|----------|--------------------|--------------------------------------------------------------------------------------------------------------------------|
482+
| `MANAGEMENT_PASSWORD` | 是 | | 管理面板密码(启用远程管理时必需)。 |
482483
| `OBJECTSTORE_ENDPOINT` | 是 | | 对象存储访问端点。可带 `http://` 或 `https://` 前缀指定协议(省略则默认 HTTPS)。 |
483484
| `OBJECTSTORE_BUCKET` | 是 | | 用于存放 `config/config.yaml` 与 `auths/*.json` 的 Bucket 名称。 |
484485
| `OBJECTSTORE_ACCESS_KEY` | 是 | | 对象存储账号的访问密钥 ID。 |
@@ -539,21 +540,6 @@ openai-compatibility:
539540

540541
`auth-dir` 参数指定身份验证令牌的存储位置。当您运行登录命令时,应用程序将在此目录中创建包含 Google 账户身份验证令牌的 JSON 文件。多个账户可用于轮询。
541542

542-
### 请求鉴权提供方
543-
544-
通过 `auth.providers` 配置接入请求鉴权。内置的 `config-api-key` 提供方支持内联密钥:
545-
546-
```
547-
auth:
548-
providers:
549-
- name: default
550-
type: config-api-key
551-
api-keys:
552-
- your-api-key-1
553-
```
554-
555-
调用时可在 `Authorization` 标头中携带密钥(或继续使用 `X-Goog-Api-Key`、`X-Api-Key`、查询参数 `key`)。为了兼容旧版本,顶层的 `api-keys` 字段仍然可用,并会自动同步到默认的 `config-api-key` 提供方。
556-
557543
### 官方生成式语言 API
558544

559545
`generative-language-api-key` 参数允许您定义可用于验证对官方 AIStudio Gemini API 请求的 API 密钥列表。

0 commit comments

Comments
 (0)