From fda2eb1fb5d9b3239731ee63960a546235a6758f Mon Sep 17 00:00:00 2001 From: JI4JUN Date: Mon, 7 Jul 2025 18:18:46 +0800 Subject: [PATCH] docs: update README --- README.md | 46 +++++++++++++++++++++++----------------------- README_CN.md | 23 ++++++++++++++++------- README_JA.md | 33 +++++++++++++++------------------ 3 files changed, 54 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index aaf212d45..ec01ed92b 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,13 @@ icon - -

NextChat

English / [简体中文](./README_CN.md) ChatGPTNextWeb%2FChatGPT-Next-Web | Trendshift - -✨ Light and Fast AI Assistant,with Claude, DeepSeek, GPT4 & Gemini Pro support. +✨ Light and Fast AI Assistant,with Claude, DeepSeek, GPT4 & Gemini Pro support. [![Saas][Saas-image]][saas-url] [![Web][Web-image]][web-url] @@ -21,8 +18,7 @@ English / [简体中文](./README_CN.md) [![MacOS][MacOS-image]][download-url] [![Linux][Linux-image]][download-url] -[NextChatAI](https://nextchat.club?utm_source=readme) / [iOS APP](https://apps.apple.com/us/app/nextchat-ai/id6743085599) / [Web App Demo](https://app.nextchat.club) / [Desktop App](https://github.com/Yidadaa/ChatGPT-Next-Web/releases) / [Enterprise Edition](#enterprise-edition) - +[NextChatAI](https://nextchat.club?utm_source=readme) / [iOS APP](https://apps.apple.com/us/app/nextchat-ai/id6743085599) / [Web App Demo](https://app.nextchat.club) / [Desktop App](https://github.com/Yidadaa/ChatGPT-Next-Web/releases) / [Enterprise Edition](#enterprise-edition) [saas-url]: https://nextchat.club?utm_source=readme [saas-image]: https://img.shields.io/badge/NextChat-Saas-green?logo=microsoftedge @@ -33,38 +29,38 @@ English / [简体中文](./README_CN.md) [MacOS-image]: https://img.shields.io/badge/-MacOS-black?logo=apple [Linux-image]: https://img.shields.io/badge/-Linux-333?logo=ubuntu -[Deploy on Zeabur](https://zeabur.com/templates/ZBUEFA) [Deploy on Vercel](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FChatGPTNextWeb%2FChatGPT-Next-Web&env=OPENAI_API_KEY&env=CODE&project-name=nextchat&repository-name=NextChat) [Open in Gitpod](https://gitpod.io/#https://github.com/ChatGPTNextWeb/NextChat) - +[Deploy on Zeabur](https://zeabur.com/templates/ZBUEFA) [Deploy on Vercel](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FChatGPTNextWeb%2FChatGPT-Next-Web&env=OPENAI_API_KEY&env=CODE&project-name=nextchat&repository-name=NextChat) [Open in Gitpod](https://gitpod.io/#https://github.com/ChatGPTNextWeb/NextChat) [](https://monica.im/?utm=nxcrp) ## ❤️ Sponsor AI API + icon [302.AI](https://302.ai/) is a pay-as-you-go AI application platform that offers the most comprehensive AI APIs and online applications available. - ## 🥳 Cheer for NextChat iOS Version Online! + > [👉 Click Here to Install Now](https://apps.apple.com/us/app/nextchat-ai/id6743085599) > [❤️ Source Code Coming Soon](https://github.com/ChatGPTNextWeb/NextChat-iOS) ![Github iOS Image](https://github.com/user-attachments/assets/e0aa334f-4c13-4dc9-8310-e3b09fa4b9f3) - -## 🫣 NextChat Support MCP ! +## 🫣 NextChat Support MCP ! + > Before build, please set env ENABLE_MCP=true - ## Enterprise Edition Meeting Your Company's Privatization and Customization Deployment Requirements: + - **Brand Customization**: Tailored VI/UI to seamlessly align with your corporate brand image. - **Resource Integration**: Unified configuration and management of dozens of AI resources by company administrators, ready for use by team members. - **Permission Control**: Clearly defined member permissions, resource permissions, and knowledge base permissions, all controlled via a corporate-grade Admin Panel. @@ -81,7 +77,6 @@ For enterprise inquiries, please contact: **business@nextchat.dev** ![More](./docs/images/more.png) - ## Features - **Deploy for free with one-click** on Vercel in under 1 minute @@ -117,10 +112,11 @@ For enterprise inquiries, please contact: **business@nextchat.dev** - [ ] local knowledge base ## What's New + - 🚀 v2.15.8 Now supports Realtime Chat [#5672](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web/issues/5672) - 🚀 v2.15.4 The Application supports using Tauri fetch LLM API, MORE SECURITY! [#5379](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web/issues/5379) - 🚀 v2.15.0 Now supports Plugins! Read this: [NextChat-Awesome-Plugins](https://github.com/ChatGPTNextWeb/NextChat-Awesome-Plugins) -- 🚀 v2.14.0 Now supports Artifacts & SD +- 🚀 v2.14.0 Now supports Artifacts & SD - 🚀 v2.10.1 support Google Gemini Pro model. - 🚀 v2.9.11 you can use azure endpoint now. - 🚀 v2.8 now we have a client that runs across all platforms! @@ -320,10 +316,12 @@ To control custom models, use `+` to add a custom model, use `-` to hide a model User `-all` to disable all default models, `+all` to enable all default models. For Azure: use `modelName@Azure=deploymentName` to customize model name and deployment name. + > Example: `+gpt-3.5-turbo@Azure=gpt35` will show option `gpt35(Azure)` in model list. > If you only can use Azure model, `-all,+gpt-3.5-turbo@Azure=gpt35` will `gpt35(Azure)` the only option in model list. For ByteDance: use `modelName@bytedance=deploymentName` to customize model name and deployment name. + > Example: `+Doubao-lite-4k@bytedance=ep-xxxxx-xxx` will show option `Doubao-lite-4k(ByteDance)` in model list. ### `DEFAULT_MODEL` （optional） @@ -340,8 +338,9 @@ Add additional models to have vision capabilities, beyond the default pattern ma ### `WHITE_WEBDAV_ENDPOINTS` (optional) You can use this option if you want to increase the number of webdav service addresses you are allowed to access, as required by the format： -- Each address must be a complete endpoint -> `https://xxxx/yyy` + +- Each address must be a complete endpoint + > `https://xxxx/yyy` - Multiple addresses are connected by ', ' ### `DEFAULT_INPUT_TEMPLATE` (optional) @@ -356,7 +355,6 @@ Stability API key. Customize Stability API url. - ### `ENABLE_MCP` (optional) Enable MCP（Model Context Protocol）Feature @@ -369,13 +367,20 @@ SiliconFlow API Key. SiliconFlow API URL. +### `AI302_API_KEY` (optional) + +302.AI Api Key. + +### `AI302_URL` (optional) + +302.AI Api URL. + ## Requirements NodeJS >= 18, Docker >= 20 ## Development - [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web) Before starting development, you must create a new `.env.local` file at project root, and place your api key into it: @@ -399,7 +404,6 @@ yarn dev ## Deployment - ### Docker (Recommended) ```shell @@ -457,8 +461,6 @@ bash <(curl -s https://raw.githubusercontent.com/Yidadaa/ChatGPT-Next-Web/main/s - [How to use Vercel (No English)](./docs/vercel-cn.md) - [User Manual (Only Chinese, WIP)](./docs/user-manual-cn.md) - - ## Translation If you want to add a new translation, read this [document](./docs/translation.md). @@ -469,8 +471,6 @@ If you want to add a new translation, read this [document](./docs/translation.md ## Special Thanks - - ### Contributors diff --git a/README_CN.md b/README_CN.md index 4908aac0c..f4c441ad0 100644 --- a/README_CN.md +++ b/README_CN.md @@ -4,28 +4,28 @@ icon -

NextChat

一键免费部署你的私人 ChatGPT 网页应用，支持 Claude, GPT4 & Gemini Pro 模型。 [NextChatAI](https://nextchat.club?utm_source=readme) / [企业版](#%E4%BC%81%E4%B8%9A%E7%89%88) / [演示 Demo](https://chat-gpt-next-web.vercel.app/) / [反馈 Issues](https://github.com/Yidadaa/ChatGPT-Next-Web/issues) / [加入 Discord](https://discord.gg/zrhvHCr79N) -[Deploy on Zeabur](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FChatGPTNextWeb%2FChatGPT-Next-Web&env=OPENAI_API_KEY&env=CODE&project-name=nextchat&repository-name=NextChat) [Deploy on Zeabur](https://zeabur.com/templates/ZBUEFA) [Open in Gitpod](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web) +[Deploy on Zeabur](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FChatGPTNextWeb%2FChatGPT-Next-Web&env=OPENAI_API_KEY&env=CODE&project-name=nextchat&repository-name=NextChat) [Deploy on Zeabur](https://zeabur.com/templates/ZBUEFA) [Open in Gitpod](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web) ## Sponsor AI API + icon [302.AI](https://302.ai/) 是一个按需付费的AI应用平台，提供市面上最全的AI API和AI在线应用。 - ## 企业版 满足您公司私有化部署和定制需求 + - **品牌定制**：企业量身定制 VI/UI，与企业品牌形象无缝契合 - **资源集成**：由企业管理人员统一配置和管理数十种 AI 资源，团队成员开箱即用 - **权限管理**：成员权限、资源权限、知识库权限层级分明，企业级 Admin Panel 统一控制 @@ -38,7 +38,6 @@ - ## 开始使用 1. 准备好你的 [OpenAI API Key](https://platform.openai.com/account/api-keys); @@ -210,7 +209,6 @@ DeepSeek Api Key. DeepSeek Api Url. - ### `HIDE_USER_API_KEY` （可选） 如果你不想让用户自行填入 API Key，将此环境变量设置为 1 即可。 @@ -230,8 +228,9 @@ DeepSeek Api Url. ### `WHITE_WEBDAV_ENDPOINTS` (可选) 如果你想增加允许访问的webdav服务地址，可以使用该选项，格式要求： + - 每一个地址必须是一个完整的 endpoint -> `https://xxxx/xxx` + > `https://xxxx/xxx` - 多个地址以`,`相连 ### `CUSTOM_MODELS` （可选） @@ -242,12 +241,13 @@ DeepSeek Api Url. 用来控制模型列表，使用 `+` 增加一个模型，使用 `-` 来隐藏一个模型，使用 `模型名=展示名` 来自定义模型的展示名，用英文逗号隔开。 在Azure的模式下，支持使用`modelName@Azure=deploymentName`的方式配置模型名称和部署名称(deploy-name) + > 示例：`+gpt-3.5-turbo@Azure=gpt35`这个配置会在模型列表显示一个`gpt35(Azure)`的选项。 > 如果你只能使用Azure模式，那么设置 `-all,+gpt-3.5-turbo@Azure=gpt35` 则可以让对话的默认使用 `gpt35(Azure)` 在ByteDance的模式下，支持使用`modelName@bytedance=deploymentName`的方式配置模型名称和部署名称(deploy-name) -> 示例: `+Doubao-lite-4k@bytedance=ep-xxxxx-xxx`这个配置会在模型列表显示一个`Doubao-lite-4k(ByteDance)`的选项 +> 示例: `+Doubao-lite-4k@bytedance=ep-xxxxx-xxx`这个配置会在模型列表显示一个`Doubao-lite-4k(ByteDance)`的选项 ### `DEFAULT_MODEL` （可选） @@ -284,6 +284,14 @@ SiliconFlow API Key. SiliconFlow API URL. +### `AI302_API_KEY` (optional) + +302.AI API Key. + +### `AI302_URL` (optional) + +302.AI API URL. + ## 开发 点击下方按钮，开始二次开发： @@ -308,6 +316,7 @@ BASE_URL=https://b.nextweb.fun/api/proxy ## 部署 ### 宝塔面板部署 + > [简体中文 > 如何通过宝塔一键部署](./docs/bt-cn.md) ### 容器部署 （推荐） diff --git a/README_JA.md b/README_JA.md index 40de7d42b..917cc1262 100644 --- a/README_JA.md +++ b/README_JA.md @@ -1,29 +1,28 @@
プレビュー -

NextChat

ワンクリックで無料であなた専用の ChatGPT ウェブアプリをデプロイ。GPT3、GPT4 & Gemini Pro モデルをサポート。 [NextChatAI](https://nextchat.club?utm_source=readme) / [企業版](#企業版) / [デモ](https://chat-gpt-next-web.vercel.app/) / [フィードバック](https://github.com/Yidadaa/ChatGPT-Next-Web/issues) / [Discordに参加](https://discord.gg/zrhvHCr79N) -[Zeaburでデプロイ](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FChatGPTNextWeb%2FChatGPT-Next-Web&env=OPENAI_API_KEY&env=CODE&project-name=nextchat&repository-name=NextChat) [Zeaburでデプロイ](https://zeabur.com/templates/ZBUEFA) [Gitpodで開く](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web) - +[Zeaburでデプロイ](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FChatGPTNextWeb%2FChatGPT-Next-Web&env=OPENAI_API_KEY&env=CODE&project-name=nextchat&repository-name=NextChat) [Zeaburでデプロイ](https://zeabur.com/templates/ZBUEFA) [Gitpodで開く](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web)
## Sponsor AI API + icon -[302.AI](https://302.ai/) は、オンデマンドで支払うAIアプリケーションプラットフォームで、最も安全なAI APIとAIオンラインアプリケーションを提供します。 - +[302.AI](https://302.ai/) は、オンデマンドで支払うAIアプリケーションプラットフォームで、最も安全なAI APIとAIオンラインアプリケーションを提供します。 ## 企業版 あなたの会社のプライベートデプロイとカスタマイズのニーズに応える + - **ブランドカスタマイズ**：企業向けに特別に設計された VI/UI、企業ブランドイメージとシームレスにマッチ - **リソース統合**：企業管理者が数十種類のAIリソースを統一管理、チームメンバーはすぐに使用可能 - **権限管理**：メンバーの権限、リソースの権限、ナレッジベースの権限を明確にし、企業レベルのAdmin Panelで統一管理 @@ -34,7 +33,6 @@ 企業版のお問い合わせ: **business@nextchat.dev** - ## 始めに 1. [OpenAI API Key](https://platform.openai.com/account/api-keys)を準備する; @@ -49,7 +47,6 @@ - ## 更新を維持する もし上記の手順に従ってワンクリックでプロジェクトをデプロイした場合、「更新があります」というメッセージが常に表示されることがあります。これは、Vercel がデフォルトで新しいプロジェクトを作成するためで、本プロジェクトを fork していないことが原因です。そのため、正しく更新を検出できません。 @@ -60,7 +57,6 @@ - ページ右上の fork ボタンを使って、本プロジェクトを fork する - Vercel で再度選択してデプロイする、[詳細な手順はこちらを参照してください](./docs/vercel-ja.md)。 - ### 自動更新を開く > Upstream Sync の実行エラーが発生した場合は、[手動で Sync Fork](./README_JA.md#手動でコードを更新する) してください！ @@ -71,15 +67,12 @@ ![自動更新を有効にする](./docs/images/enable-actions-sync.jpg) - ### 手動でコードを更新する 手動で即座に更新したい場合は、[GitHub のドキュメント](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork)を参照して、fork したプロジェクトを上流のコードと同期する方法を確認してください。 このプロジェクトをスターまたはウォッチしたり、作者をフォローすることで、新機能の更新通知をすぐに受け取ることができます。 - - ## ページアクセスパスワードを設定する > パスワードを設定すると、ユーザーは設定ページでアクセスコードを手動で入力しない限り、通常のチャットができず、未承認の状態であることを示すメッセージが表示されます。 @@ -94,7 +87,6 @@ code1,code2,code3 この環境変数を追加または変更した後、**プロジェクトを再デプロイ**して変更を有効にしてください。 - ## 環境変数 > 本プロジェクトのほとんどの設定は環境変数で行います。チュートリアル：[Vercel の環境変数を変更する方法](./docs/vercel-ja.md)。 @@ -205,8 +197,9 @@ ByteDance API の URL。 ### `WHITE_WEBDAV_ENDPOINTS` (オプション) アクセス許可を与える WebDAV サービスのアドレスを追加したい場合、このオプションを使用します。フォーマット要件： + - 各アドレスは完全なエンドポイントでなければなりません。 -> `https://xxxx/xxx` + > `https://xxxx/xxx` - 複数のアドレスは `,` で接続します。 ### `CUSTOM_MODELS` （オプション） @@ -217,9 +210,11 @@ ByteDance API の URL。 モデルリストを管理します。`+` でモデルを追加し、`-` でモデルを非表示にし、`モデル名=表示名` でモデルの表示名をカスタマイズし、カンマで区切ります。 Azure モードでは、`modelName@Azure=deploymentName` 形式でモデル名とデプロイ名（deploy-name）を設定できます。 + > 例：`+gpt-3.5-turbo@Azure=gpt35` この設定でモデルリストに `gpt35(Azure)` のオプションが表示されます。 ByteDance モードでは、`modelName@bytedance=deploymentName` 形式でモデル名とデプロイ名（deploy-name）を設定できます。 + > 例: `+Doubao-lite-4k@bytedance=ep-xxxxx-xxx` この設定でモデルリストに `Doubao-lite-4k(ByteDance)` のオプションが表示されます。 ### `DEFAULT_MODEL` （オプション） @@ -237,6 +232,13 @@ ByteDance モードでは、`modelName@bytedance=deploymentName` 形式でモデ 『設定』の『ユーザー入力前処理』の初期設定に使用するテンプレートをカスタマイズします。 +### `AI302_API_KEY` （オプション） + +302.AI API キー. + +### `AI302_URL` （オプション） + +302.AI API の URL. ## 開発 @@ -250,14 +252,12 @@ ByteDance モードでは、`modelName@bytedance=deploymentName` 形式でモデ OPENAI_API_KEY= ``` - ### ローカル開発 1. Node.js 18 と Yarn をインストールします。具体的な方法は ChatGPT にお尋ねください。 2. `yarn install && yarn dev` を実行します。⚠️ 注意：このコマンドはローカル開発用であり、デプロイには使用しないでください。 3. ローカルでデプロイしたい場合は、`yarn install && yarn build && yarn start` コマンドを使用してください。プロセスを守るために pm2 を使用することもできます。詳細は ChatGPT にお尋ねください。 - ## デプロイ ### コンテナデプロイ（推奨） @@ -294,7 +294,6 @@ docker run -d -p 3000:3000 \ 他の環境変数を指定する必要がある場合は、上記のコマンドに `-e 環境変数=環境変数値` を追加して指定してください。 - ### ローカルデプロイ コンソールで以下のコマンドを実行します： @@ -305,7 +304,6 @@ bash <(curl -s https://raw.githubusercontent.com/Yidadaa/ChatGPT-Next-Web/main/s ⚠️ 注意：インストール中に問題が発生した場合は、Docker を使用してデプロイしてください。 - ## 謝辞 ### 寄付者 @@ -320,7 +318,6 @@ bash <(curl -s https://raw.githubusercontent.com/Yidadaa/ChatGPT-Next-Web/main/s - [one-api](https://github.com/songquanpeng/one-api): 一つのプラットフォームで大規模モデルのクォータ管理を提供し、市場に出回っているすべての主要な大規模言語モデルをサポートします。 - ## オープンソースライセンス [MIT](https://opensource.org/license/mit/)