From ba604e8389b49c265234a0710ffae82ddcf52ac8 Mon Sep 17 00:00:00 2001 From: Rafi Date: Sat, 15 Apr 2023 13:31:29 +0800 Subject: [PATCH] docs: modify API key configuration instructions. --- docs/README.md | 2 ++ docs/guide/quick-start.md | 4 +++- docs/zh/README.md | 2 ++ docs/zh/guide/quick-start.md | 4 +++- 4 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 410a360..fb038c2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,6 +22,8 @@ This project consists of two parts, the client-side and the server-side: - Convenient tools, supporting one-click message and code block copying, as well as message editing. - Common command management, allowing users to store and edit their own common commands. - PWA, supporting installation to the desktop. +- User Token Usage Statistics. +- Supports configuring multiple API Keys. ### Server-side - The server-side has an administrative panel. diff --git a/docs/guide/quick-start.md b/docs/guide/quick-start.md index 6d848ca..2ff3a23 100644 --- a/docs/guide/quick-start.md +++ b/docs/guide/quick-start.md @@ -107,7 +107,9 @@ Access the management panel at `http(s)://your.domain:9000/admin` or `http(s):// - username: **admin** - password: **password** -Before starting a chat, you need to add an OpenAI API key. In the management panel, in the "Settings" section, there is a record named `openai_api_key`. Set the value to your API key. +~~Before starting a chat, you need to add an OpenAI API key. In the management panel, in the "Settings" section, there is a record named `openai_api_key`. Set the value to your API key.~~ + +In the latest version, a separate API Key management has been added to the admin panel, located under "Provider/Api keys". You can add multiple API Keys here, and the backend program will track the usage of each key's token and balance the usage based on token usage. **To enable this feature, you need to delete the previous "openai_api_key" setting.** Now you can access the client at `http(s)://your.domain` or `http://123.123.123.123` to start chatting. diff --git a/docs/zh/README.md b/docs/zh/README.md index 695193f..03e6b8d 100644 --- a/docs/zh/README.md +++ b/docs/zh/README.md @@ -21,6 +21,8 @@ ChatGPT UI 是一个非官方的 ChatGPT Web 客户端。它支持多用户， - 便捷的工具，支持一键复制消息和代码块，以及重新编辑消息等。 - 常用指令管理，用户可存储和编辑自己的常用指令。 - PWA，支持安装到桌面。 +- 用户 Token 使用量统计 +- 支持配置多个 API Key ### 服务端 - 服务端拥有一个管理面板 diff --git a/docs/zh/guide/quick-start.md b/docs/zh/guide/quick-start.md index b269e91..a916b12 100644 --- a/docs/zh/guide/quick-start.md +++ b/docs/zh/guide/quick-start.md @@ -107,7 +107,9 @@ docker-compose up --pull always -d 默认密码: **password** -在可以开始聊天之前，您需要添加一个 OpenAI 的 API 密钥。在管理面板的设置模型中，有一个名称为 `openai_api_key` 的记录，将值设置为您的 API 密钥。 +~~在可以开始聊天之前，您需要添加一个 OpenAI 的 API 密钥。在管理面板的设置模型中，有一个名称为 `openai_api_key` 的记录，将值设置为您的 API 密钥。~~ + +在最新版本中，管理面板增加了一个独立的 API Key 的管理，位于管理面板的 `Provider/ Api keys`。你可以在这里添加多个 API Key，后端程序会统计每个 Key 的 token 使用量，并根据 token 使用量来平衡使用 Key。**想要这个功能生效，需要删除之前的`openai_api_key`设置** 现在可以访问客户端地址 `http(s)://your.domain` 或 IP `http://123.123.123.123` 开始聊天。