diff --git a/README_TW.md b/README_TW.md new file mode 100644 index 00000000000..724e2c2d34e --- /dev/null +++ b/README_TW.md @@ -0,0 +1,442 @@ +
+ + + icon + + +

NextChat

+ +English / [简体中文](./README_CN.md) + +ChatGPTNextWeb%2FChatGPT-Next-Web | Trendshift + +✨ 一鍵免費部署你的私人 ChatGPT 網頁應用，支援 Claude, GPT4 & Gemini Pro 模型。 + +[![Saas][Saas-image]][saas-url] +[![Web][Web-image]][web-url] +[![Windows][Windows-image]][download-url] +[![MacOS][MacOS-image]][download-url] +[![Linux][Linux-image]][download-url] + +[NextChatAI](https://nextchat.club?utm_source=readme) / [iOS 應用程式](https://apps.apple.com/us/app/nextchat-ai/id6743085599) / [網頁應用程式演示](https://app.nextchat.club) / [桌面應用程式](https://github.com/Yidadaa/ChatGPT-Next-Web/releases) / [企業版](#enterprise-edition) + +[saas-url]: https://nextchat.club?utm_source=readme +[saas-image]: https://img.shields.io/badge/NextChat-Saas-green?logo=microsoftedge +[web-url]: https://app.nextchat.club/ +[download-url]: https://github.com/Yidadaa/ChatGPT-Next-Web/releases +[Web-image]: https://img.shields.io/badge/Web-PWA-orange?logo=microsoftedge +[Windows-image]: https://img.shields.io/badge/-Windows-blue?logo=windows +[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) + +[](https://monica.im/?utm=nxcrp) + +
+ +## ❤️ Sponsor AI API + + + icon + + +## 🥳 為 NextChat iOS 版本上線歡呼！ + +> [👉 點我立即安裝](https://apps.apple.com/us/app/nextchat-ai/id6743085599) + +> [❤️ 原始碼即將公開](https://github.com/ChatGPTNextWeb/NextChat-iOS) + +![Github iOS Image](https://github.com/user-attachments/assets/e0aa334f-4c13-4dc9-8310-e3b09fa4b9f3) + +## 🫣 NextChat 已支援 MCP ！ + +> 在進行構建前，請先設定環境變數：ENABLE_MCP=true + + + +[302.AI](https://302.ai/) 是一個依用量付費的 AI 應用平台，提供市面上最完整的 AI API 與線上 AI 應用服務。 + +## 企業版 + +滿足您公司私有化部署與客製化需求： + +- **品牌客製化**：依企業需求量身打造 VI/UI，與企業品牌形象無縫契合 +- **資源整合**：由企業管理員統一配置與管理數十種 AI 資源，團隊成員即可開箱使用 +- **權限管理**：成員權限、資源權限、知識庫權限層級清楚，透過企業級 Admin Panel 統一管控 +- **知識接入**：將企業內部知識庫結合 AI 能力，比通用 AI 更符合企業自身的業務需求 +- **安全稽核**：自動攔截敏感提問，並可追溯所有歷史對話紀錄，確保 AI 遵循企業資訊安全規範 +- **私有部署**：企業級私有化部署，支援各類主流私有雲環境，確保資料安全與隱私保護 +- **持續更新**：提供多模態、智能體等前沿能力的持續更新服務，保持功能常新且具創新性 + +企業版諮詢： **business@nextchat.dev** + +## Screenshots + +![Settings](./docs/images/settings.png) + +![More](./docs/images/more.png) + +## 開始使用 + +1. 準備好你的 [OpenAI API Key](https://platform.openai.com/account/api-keys); +2. 點擊右側按鈕開始部署： + [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FYidadaa%2FChatGPT-Next-Web&env=OPENAI_API_KEY&env=CODE&env=GOOGLE_API_KEY&project-name=chatgpt-next-web&repository-name=ChatGPT-Next-Web)，直接使用 GitHub 帳號登入即可，記得在環境變數頁面填入 API Key 和[頁面存取密碼](#配置页面访问密码) CODE； +3. 部署完成後，即可開始使用 +4. （可選）[綁定自訂網域](https://vercel.com/docs/concepts/projects/domains/add-a-domain)：Vercel 分配的預設網域在部分地區的 DNS 可能遭到污染，建議綁定自訂網域以確保可直接連線。 + +
+ +![主界面](./docs/images/cover.png) + +
+ +## 保持更新 + +若你依照上述步驟使用一鍵部署建立自己的專案，可能會遭遇「存在更新」的提示，這是由於 Vercel 預設會為你建立新的專案，而不是 fork 本專案，這會導致無法正確地檢測更新。 + +推薦你依照以下步驟重新部署： + +- 刪除先前的專案倉庫； +- 點擊頁面右上角的 Fork 按鈕，fork 本專案； +- 在 Vercel 重新選擇並部署，[詳情請見教學](./docs/vercel-cn.md#如何新建项目)。 + +### 開啟自動更新 + +> 如果你遇到 Upstream Sync 執行錯誤，請[手動 Sync Fork 一次](./README_CN.md#手动更新代码)！ + +當你 fork 專案之後，由於 GitHub 的限制，你需要手動前往 fork 後的專案的 Actions 頁面啟用 Workflows，並啟用 Upstream Sync Action。啟用後即可每小時自動更新： + +![自动更新](./docs/images/enable-actions.jpg) + +![启用自动更新](./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 的專案同步上游程式碼。 + +你可以 star / watch 本專案，或追蹤作者以便第一時間收到功能更新通知。 + +## 設定頁面訪問密碼 + +> 設定密碼後，使用者需要在設定頁手動輸入訪問碼才能正常使用聊天功能，否則會顯示未授權提示。 + +> **警告**：請務必將密碼設定為足夠長（至少7位以上），否則[可能遭到暴力破解](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/518)。 + +本專案提供有限的訪問權限控制功能。請在 Vercel 專案控制台的環境變數頁添加名為 `CODE` 的環境變數，值為以英文逗號分隔的自定義密碼： + +``` +code1,code2,code3 +``` + +新增或修改該環境變數後，請**重新部署**專案使變更生效。 + +## 環境變數 + +> 本專案大多數配置項皆透過環境變數設定。教學文件：[如何修改 Vercel 環境變數](./docs/vercel-cn.md)。 + +### `OPENAI_API_KEY`（必填） + +OpenAI 密鑰。於 openai 帳號頁面申請的 API Key，可用英文逗號分隔多個 Key，系統會自動隨機輪詢。 + +### `CODE`（可選） + +訪問密碼，可選，可使用逗號分隔多組密碼。 + +**警告**：若不設定此項，任何人都能使用你部署的網站，可能導致你的 Token 在短時間內被消耗殆盡，強烈建議設定。 + +### `BASE_URL`（可選） + +> 預設：`https://api.openai.com` + +> 範例：`http://your-openai-proxy.com` + +OpenAI API 代理 URL，如果你手動配置了 OpenAI API 代理，請填寫此選項。 + +> 若遇到 SSL 證書問題，請將 `BASE_URL` 的協定改為 http。 + +### `OPENAI_ORG_ID`（可選） + +指定 OpenAI 組織 ID。 + +### `AZURE_URL`（可選） + +> 範例：https://{azure-resource-url}/openai + +Azure 部署 URL。 + +### `AZURE_API_KEY`（可選） + +Azure 密鑰。 + +### `AZURE_API_VERSION`（可選） + +Azure API 版本，可於此查詢：[Azure 官方文件](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#chat-completions)。 + +### `GOOGLE_API_KEY`（可選） + +Google Gemini Pro 密鑰。 + +### `GOOGLE_URL`（可選） + +Google Gemini Pro API URL。 + +### `ANTHROPIC_API_KEY`（可選） + +Anthropic Claude API Key。 + +### `ANTHROPIC_API_VERSION`（可選） + +Anthropic Claude API 版本。 + +### `ANTHROPIC_URL`（可選） + +Anthropic Claude API URL。 + +### `BAIDU_API_KEY`（可選） + +Baidu Api Key. + +### `BAIDU_SECRET_KEY`（可選） + +Baidu Secret Key。 + +### `BAIDU_URL`（可選） + +Baidu Api Url。 + +### `BYTEDANCE_API_KEY`（可選） + +ByteDance Api Key。 + +### `BYTEDANCE_URL`（可選） + +ByteDance Api Url。 + +### `ALIBABA_API_KEY`（可選） + +阿里雲（千問）Api Key。 + +### `ALIBABA_URL`（可選） + +阿里雲（千問）Api Url。 + +### `IFLYTEK_URL`（可選） + +訊飛星火 Api Url。 + +### `IFLYTEK_API_KEY`（可選） + +訊飛星火 Api Key。 + +### `IFLYTEK_API_SECRET`（可選） + +訊飛星火 Api Secret。 + +### `CHATGLM_API_KEY`（可選） + +ChatGLM Api Key。 + +### `CHATGLM_URL`（可選） + +ChatGLM Api Url。 + +### `DEEPSEEK_API_KEY`（可選） + +DeepSeek Api Key。 + +### `DEEPSEEK_URL`（可選） + +DeepSeek Api Url。 + +### `HIDE_USER_API_KEY`（可選） + +如果你不希望使用者自行輸入 API Key，將此環境變數設為 1 即可。 + +### `DISABLE_GPT4`（可選） + +如果你不希望使用者使用 GPT-4，將此環境變數設為 1 即可。 + +### `ENABLE_BALANCE_QUERY`（可選） + +如果你想啟用餘額查詢功能，將此環境變數設為 1 即可。 + +### `DISABLE_FAST_LINK`（可選） + +如果你想禁止從網址解析預設設定，將此環境變數設為 1 即可。 + +### `WHITE_WEBDAV_ENDPOINTS`（可選） + +若你想增加允許存取的 WebDAV 服務地址，可使用此設定。格式要求如下： + +- 每一個地址必須是完整的 endpoint + > `https://xxxx/xxx` +- 多個地址以 `,` 分隔 + +### `CUSTOM_MODELS`（可選） + +> 示例：`+qwen-7b-chat,+glm-6b,-gpt-3.5-turbo,gpt-4-1106-preview=gpt-4-turbo` +> 表示新增 `qwen-7b-chat` 與 `glm-6b` 到模型列表，並從列表移除 `gpt-3.5-turbo`，同時將 `gpt-4-1106-preview` 的顯示名稱改為 `gpt-4-turbo`。 +> 若你想先停用所有預設模型，再啟用特定模型，可使用：`-all,+gpt-3.5-turbo`，則只會啟用 `gpt-3.5-turbo`。 + +用於控制模型列表： +- 使用 `+模型名` 新增模型 +- 使用 `-模型名` 隱藏模型 +- 使用 `模型名=顯示名` 自訂顯示名稱 +多個項目以英文逗號分隔。 + +在 Azure 模式下，可使用 `modelName@Azure=deploymentName` 同時設定模型名稱與部署名稱（deploy-name）。 + +> 示例：`+gpt-3.5-turbo@Azure=gpt35`這個配置會在模型列表中顯示一個`gpt35(Azure)`的選項。 +> 若你僅能使用 Azure 模型，可設定：`-all,+gpt-3.5-turbo@Azure=gpt35`，使其成為默認使用的模型。 + +在 ByteDance（字節跳動）模式下，也支援使用 `modelName@bytedance=deploymentName` 設定模型名稱與部署名稱。 + +> 示例：`+Doubao-lite-4k@bytedance=ep-xxxxx-xxx`這個配置會在模型列表中顯示一個`Doubao-lite-4k(ByteDance)`的選項。 + +### `DEFAULT_MODEL`（可選） + +變更預設模型。 + +### `VISION_MODELS`（可選） + +> 預設值：空 +> 示例：`gpt-4-vision,claude-3-opus,my-custom-model` 表示為這些模型額外啟用視覺能力，作為預設模式匹配的補充（預設會自動偵測包含 "vision"、"claude-3"、"gemini-1.5" 等關鍵字的模型）。 + +在預設模式匹配之外，額外指定需要啟用視覺能力的模型。多個模型以逗號分隔。 + +### `DEFAULT_INPUT_TEMPLATE`（可選） + +自訂「設定」中「使用者輸入預處理」的初始化預設模板。 + +### `STABILITY_API_KEY`（可選） + +Stability API 金鑰。 + +### `STABILITY_URL`（可選） + +自訂 Stability API 的請求地址。 + +### `ENABLE_MCP`（可選） + +啟用 MCP（Model Context Protocol）功能。 + +### `SILICONFLOW_API_KEY`（可選） + +SiliconFlow API Key。 + +### `SILICONFLOW_URL`（可選） + +SiliconFlow API URL。 + +### `AI302_API_KEY`（可選） + +302.AI API Key。 + +### `AI302_URL`（可選） + +302.AI API URL。 + +## 開發 + +點擊下方按鈕，開始二次開發： + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web) + +在開始編寫程式碼之前，請在專案根目錄建立 `.env.local` 檔案，並填入環境變數： + +``` +OPENAI_API_KEY= + +# 中國大陸使用者可使用本專案內建的代理進行開發，也可自由選擇其他代理地址 +BASE_URL=https://b.nextweb.fun/api/proxy +``` + +### 本地開發 + +1. 安裝 Node.js 18 與 yarn，具體細節可詢問 ChatGPT； +2. 執行 `yarn install && yarn dev` 即可啟動開發模式。⚠️ 注意：此指令僅限本地開發，不可用於正式部署！ +3. 如果你想本地部署，請使用 `yarn install && yarn build && yarn start` + 你也可以搭配 pm2 來守護進程，避免程式被意外終止；詳細可詢問 ChatGPT。 + +## 部署 + +### 寶塔面板部署 + +> [簡體中文 > 如何透過寶塔一鍵部署](./docs/bt-cn.md) + +### 容器部署（推薦） + +> Docker 版本需為 20 或以上，否則會提示找不到鏡像。 + +> ⚠️ 注意：docker 版本通常會落後最新版本 1～2 天，因此部署後可能持續看到「存在更新」提示，屬正常現象。 + +```shell +docker pull yidadaa/chatgpt-next-web + +docker run -d -p 3000:3000 \ + -e OPENAI_API_KEY=sk-xxxx \ + -e CODE=頁面訪問密碼 \ + yidadaa/chatgpt-next-web +``` + +你也可以指定 proxy： + +```shell +docker run -d -p 3000:3000 \ + -e OPENAI_API_KEY=sk-xxxx \ + -e CODE=頁面訪問密碼 \ + --net=host \ + -e PROXY_URL=http://127.0.0.1:7890 \ + yidadaa/chatgpt-next-web +``` + +如需啟用 MCP 功能，可使用： + +```shell +docker run -d -p 3000:3000 \ + -e OPENAI_API_KEY=sk-xxxx \ + -e CODE=頁面訪問密碼 \ + -e ENABLE_MCP=true \ + yidadaa/chatgpt-next-web +``` + +若你的本地代理需要帳號密碼，可使用： + +```shell +-e PROXY_URL="http://127.0.0.1:7890 user password" +``` + +如果你需要設定其他環境變數，請在上述命令中自行增加`-e 環境變量=環境變量值` 來指定。 + +### 本地部署 + +在終端機執行以下命令： + +```shell +bash <(curl -s https://raw.githubusercontent.com/Yidadaa/ChatGPT-Next-Web/main/scripts/setup.sh) +``` + +⚠️ 注意：若安裝過程遇到問題，建議改用 docker 部署。 + +## 鳴謝 + +### 捐贈者（Sponsers） + +> 見英文版。 + +### 貢獻者（Contributors） + +[查看專案貢獻者列表](https://github.com/Yidadaa/ChatGPT-Next-Web/graphs/contributors) + +### 相關專案 + +- [one-api](https://github.com/songquanpeng/one-api): 站式大模型額度管理平台，支援市面上各大主流語言模型 + +## 開源協議（Lisence） + +[MIT](https://opensource.org/license/mit/) + + + + diff --git a/docs/synchronise-chat-logs-tw.md b/docs/synchronise-chat-logs-tw.md new file mode 100644 index 00000000000..13f2b371cb8 --- /dev/null +++ b/docs/synchronise-chat-logs-tw.md @@ -0,0 +1,33 @@ +# 使用 UpStash 同步聊天記錄 +## 前置準備 +- Github 帳號 +- 已架設好的 ChatGPT-Next-Web 伺服器 +- [UpStash](https://upstash.com) + +## 開始使用 +1. 註冊 UpStash 帳號。 +2. 創建資料庫。 + + ![註冊與登入](./images/upstash-1.png) + + ![創建資料庫](./images/upstash-2.png) + + ![選擇伺服器](./images/upstash-3.png) + +3. 找到 REST API，分別複製 UPSTASH_REDIS_REST_URL 和 UPSTASH_REDIS_REST_TOKEN（⚠切記⚠：不要洩漏 Token!） + + ![複製](./images/upstash-4.png) + +4. UPSTASH_REDIS_REST_URL 和 UPSTASH_REDIS_REST_TOKEN 複製到你的同步配置，點擊**檢查可用性** + + ![同步1](./images/upstash-5.png) + + 如果沒什麼問題，那就成功了 + + ![同步可用性完成](./images/upstash-6.png) + +5. Success! + + ![好耶~！](./images/upstash-7.png) + +