Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ischanx committed Nov 25, 2024
1 parent 2623a92 commit 468ecf7
Show file tree
Hide file tree
Showing 3 changed files with 201 additions and 3 deletions.
67 changes: 66 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ If you do not want users to input their own API key, set this value to 1.

> Default: Empty
If you do not want users to use GPT-4, set this value to 1.
If you don't want users to use GPT-4, set this value to 1. This will hide all GPT-4 related models from the model list.

### `ENABLE_BALANCE_QUERY` (optional)

Expand Down Expand Up @@ -374,6 +374,71 @@ Stability API key.

Customize Stability API url.

### `CLOUDFLARE_ACCOUNT_ID` (optional)

Cloudflare Account ID.

### `CLOUDFLARE_KV_NAMESPACE_ID` (optional)

Cloudflare KV Namespace ID.

### `CLOUDFLARE_KV_API_KEY` (optional)

Cloudflare KV API Key.

### `CLOUDFLARE_KV_TTL` (optional)

Cloudflare KV cache expiration time.

### `GTM_ID` (optional)

Google Tag Manager ID.

### `GA_ID` (optional)

Google Analytics ID. Will use default value if not set.

### `TENCENT_SECRET_ID` (optional)

Tencent Cloud Secret ID.

### `TENCENT_SECRET_KEY` (optional)

Tencent Cloud Secret Key.

### `TENCENT_URL` (optional)

Tencent Cloud API URL.

### `MOONSHOT_URL` (optional)

Moonshot API URL.

### `MOONSHOT_API_KEY` (optional)

Moonshot API Key.

### `XAI_URL` (optional)

XAI API URL.

### `XAI_API_KEY` (optional)

XAI API Key.

### `PROXY_URL` (optional)

> Example: `http://127.0.0.1:7890`
Proxy server URL. Supports HTTP and SOCKS proxies.

If your proxy server requires authentication, you can use the following format:
```bash
http://username:[email protected]:7890
```

Note: This configuration only works when deploying with Docker.

## Requirements

NodeJS >= 18, Docker >= 20
Expand Down
68 changes: 67 additions & 1 deletion README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,9 @@ ChatGLM Api Url.

### `DISABLE_GPT4` (可选)

如果你不想让用户使用 GPT-4,将此环境变量设置为 1 即可。
> 默认值:空
如果你不想让用户使用 GPT-4,将此环境变量设置为 1 即可。这将从模型列表中隐藏所有 GPT-4 相关的模型。

### `ENABLE_BALANCE_QUERY` (可选)

Expand Down Expand Up @@ -247,6 +249,70 @@ Stability API密钥

自定义的Stability API请求地址

### `CLOUDFLARE_ACCOUNT_ID` (可选)

Cloudflare 账户 ID。

### `CLOUDFLARE_KV_NAMESPACE_ID` (可选)

Cloudflare KV 命名空间 ID。

### `CLOUDFLARE_KV_API_KEY` (可选)

Cloudflare KV API 密钥。

### `CLOUDFLARE_KV_TTL` (可选)

Cloudflare KV 缓存过期时间。

### `GTM_ID` (可选)

Google Tag Manager ID。

### `GA_ID` (可选)

Google Analytics ID。如果不设置则使用默认值。

### `TENCENT_SECRET_ID` (可选)

腾讯云 Secret ID。

### `TENCENT_SECRET_KEY` (可选)

腾讯云 Secret Key。

### `TENCENT_URL` (可选)

腾讯云 API 地址。

### `MOONSHOT_URL` (可选)

Moonshot API 地址。

### `MOONSHOT_API_KEY` (可选)

Moonshot API 密钥。

### `XAI_URL` (可选)

XAI API 地址。

### `XAI_API_KEY` (可选)

XAI API 密钥。

### `PROXY_URL` (可选)

> 示例:`http://127.0.0.1:7890`
代理服务器地址。支持 HTTP 和 SOCKS 代理。

如果代理服务器需要认证,可以使用以下格式:
```bash
http://username:[email protected]:7890
```

注意:此配置仅在使用 Docker 部署时有效。

## 开发

Expand Down
69 changes: 68 additions & 1 deletion README_JA.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,9 @@ ByteDance API の URL。

### `DISABLE_GPT4` (オプション)

ユーザーが GPT-4 を使用できないようにしたい場合は、この環境変数を 1 に設定します。
> デフォルト:空
ユーザーが GPT-4 を使用できないようにしたい場合は、この環境変数を 1 に設定します。これにより、モデルリストから GPT-4 関連のすべてのモデルが非表示になります。

### `ENABLE_BALANCE_QUERY` (オプション)

Expand Down Expand Up @@ -221,6 +223,71 @@ ByteDance モードでは、`modelName@bytedance=deploymentName` 形式でモデ

『設定』の『ユーザー入力前処理』の初期設定に使用するテンプレートをカスタマイズします。

### `CLOUDFLARE_ACCOUNT_ID` (オプション)

Cloudflare アカウント ID。

### `CLOUDFLARE_KV_NAMESPACE_ID` (オプション)

Cloudflare KV ネームスペース ID。

### `CLOUDFLARE_KV_API_KEY` (オプション)

Cloudflare KV API キー。

### `CLOUDFLARE_KV_TTL` (オプション)

Cloudflare KV キャッシュの有効期限。

### `GTM_ID` (オプション)

Google Tag Manager ID。

### `GA_ID` (オプション)

Google Analytics ID。設定されていない場合はデフォルト値を使用します。

### `TENCENT_SECRET_ID` (オプション)

Tencent Cloud Secret ID。

### `TENCENT_SECRET_KEY` (オプション)

Tencent Cloud Secret Key。

### `TENCENT_URL` (オプション)

Tencent Cloud API の URL。

### `MOONSHOT_URL` (オプション)

Moonshot API の URL。

### `MOONSHOT_API_KEY` (オプション)

Moonshot API キー。

### `XAI_URL` (オプション)

XAI API の URL。

### `XAI_API_KEY` (オプション)

XAI API キー。

### `PROXY_URL` (オプション)

> 例:`http://127.0.0.1:7890`
プロキシサーバーの URL。HTTP および SOCKS プロキシをサポートしています。

プロキシサーバーで認証が必要な場合は、以下の形式を使用できます:
```bash
http://username:[email protected]:7890
```

注意:この設定は Docker でデプロイする場合のみ有効です。


## 開発

Expand Down

0 comments on commit 468ecf7

Please sign in to comment.