diff --git a/README.md b/README.md index 2e45c7120fa..1d3722950d0 100644 --- a/README.md +++ b/README.md @@ -4,479 +4,29 @@ icon -

NextChat

+

Frok NextChat

-English / [简体中文](./README_CN.md) - -ChatGPTNextWeb%2FChatGPT-Next-Web | Trendshift - -✨ Light and Fast AI Assistant,with Claude, DeepSeek, GPT4 & Gemini Pro support. - -[![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 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 -[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) [Deploy with your agent](https://opendeploy.dev/github/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 ! - -> 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. -- **Knowledge Integration**: Combining your internal knowledge base with AI capabilities, making it more relevant to your company's specific business needs compared to general AI. -- **Security Auditing**: Automatically intercept sensitive inquiries and trace all historical conversation records, ensuring AI adherence to corporate information security standards. -- **Private Deployment**: Enterprise-level private deployment supporting various mainstream private cloud solutions, ensuring data security and privacy protection. -- **Continuous Updates**: Ongoing updates and upgrades in cutting-edge capabilities like multimodal AI, ensuring consistent innovation and advancement. - -For enterprise inquiries, please contact: **business@nextchat.dev** - -## Screenshots - -![Settings](./docs/images/settings.png) - -![More](./docs/images/more.png) - -## Features - -- **Deploy for free with one-click** on Vercel in under 1 minute -- Compact client (~5MB) on Linux/Windows/MacOS, [download it now](https://github.com/Yidadaa/ChatGPT-Next-Web/releases) -- Fully compatible with self-deployed LLMs, recommended for use with [RWKV-Runner](https://github.com/josStorer/RWKV-Runner) or [LocalAI](https://github.com/go-skynet/LocalAI) -- Privacy first, all data is stored locally in the browser -- Markdown support: LaTex, mermaid, code highlight, etc. -- Responsive design, dark mode and PWA -- Fast first screen loading speed (~100kb), support streaming response -- New in v2: create, share and debug your chat tools with prompt templates (mask) -- Awesome prompts powered by [awesome-chatgpt-prompts-zh](https://github.com/PlexPt/awesome-chatgpt-prompts-zh) and [awesome-chatgpt-prompts](https://github.com/f/awesome-chatgpt-prompts) -- Automatically compresses chat history to support long conversations while also saving your tokens -- I18n: English, 简体中文, 繁体中文, 日本語, Français, Español, Italiano, Türkçe, Deutsch, Tiếng Việt, Русский, Čeština, 한국어, Indonesia - -
- -![主界面](./docs/images/cover.png) +English / [简体中文](./README_CN.md) / [日本語](./README_JA.md) / [한국어](./README_KO.md)
-## Roadmap - -- [x] System Prompt: pin a user defined prompt as system prompt [#138](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/138) -- [x] User Prompt: user can edit and save custom prompts to prompt list -- [x] Prompt Template: create a new chat with pre-defined in-context prompts [#993](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/993) -- [x] Share as image, share to ShareGPT [#1741](https://github.com/Yidadaa/ChatGPT-Next-Web/pull/1741) -- [x] Desktop App with tauri -- [x] Self-host Model: Fully compatible with [RWKV-Runner](https://github.com/josStorer/RWKV-Runner), as well as server deployment of [LocalAI](https://github.com/go-skynet/LocalAI): llama/gpt4all/rwkv/vicuna/koala/gpt4all-j/cerebras/falcon/dolly etc. -- [x] Artifacts: Easily preview, copy and share generated content/webpages through a separate window [#5092](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web/pull/5092) -- [x] Plugins: support network search, calculator, any other apis etc. [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165) [#5353](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web/issues/5353) - - [x] network search, calculator, any other apis etc. [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165) [#5353](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web/issues/5353) -- [x] Supports Realtime Chat [#5672](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web/issues/5672) -- [ ] 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.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! -- 🚀 v2.7 let's share conversations as image, or share to ShareGPT! -- 🚀 v2.0 is released, now you can create prompt templates, turn your ideas into reality! Read this: [ChatGPT Prompt Engineering Tips: Zero, One and Few Shot Prompting](https://www.allabtai.com/prompt-engineering-tips-zero-one-and-few-shot-prompting/). - -## Get Started - -1. Get [OpenAI API Key](https://platform.openai.com/account/api-keys); -2. Click - [![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&project-name=chatgpt-next-web&repository-name=ChatGPT-Next-Web), remember that `CODE` is your page password; -3. Enjoy :) - -## FAQ - -[English > FAQ](./docs/faq-en.md) - -## Keep Updated - -If you have deployed your own project with just one click following the steps above, you may encounter the issue of "Updates Available" constantly showing up. This is because Vercel will create a new project for you by default instead of forking this project, resulting in the inability to detect updates correctly. - -We recommend that you follow the steps below to re-deploy: - -- Delete the original repository; -- Use the fork button in the upper right corner of the page to fork this project; -- Choose and deploy in Vercel again, [please see the detailed tutorial](./docs/vercel-cn.md). - -### Enable Automatic Updates - -> If you encounter a failure of Upstream Sync execution, please [manually update code](./README.md#manually-updating-code). - -After forking the project, due to the limitations imposed by GitHub, you need to manually enable Workflows and Upstream Sync Action on the Actions page of the forked project. Once enabled, automatic updates will be scheduled every hour: - -![Automatic Updates](./docs/images/enable-actions.jpg) - -![Enable Automatic Updates](./docs/images/enable-actions-sync.jpg) - -### Manually Updating Code - -If you want to update instantly, you can check out the [GitHub documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) to learn how to synchronize a forked project with upstream code. - -You can star or watch this project or follow author to get release notifications in time. - -## Access Password - -This project provides limited access control. Please add an environment variable named `CODE` on the vercel environment variables page. The value should be passwords separated by comma like this: - -``` -code1,code2,code3 -``` - -After adding or modifying this environment variable, please redeploy the project for the changes to take effect. - -## Environment Variables - -### `CODE` (optional) - -Access password, separated by comma. - -### `OPENAI_API_KEY` (required) - -Your openai api key, join multiple api keys with comma. - -### `BASE_URL` (optional) - -> Default: `https://api.openai.com` - -> Examples: `http://your-openai-proxy.com` - -Override openai api request base url. - -### `OPENAI_ORG_ID` (optional) - -Specify OpenAI organization ID. - -### `AZURE_URL` (optional) - -> Example: https://{azure-resource-url}/openai - -Azure deploy url. - -### `AZURE_API_KEY` (optional) - -Azure Api Key. - -### `AZURE_API_VERSION` (optional) - -Azure Api Version, find it at [Azure Documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#chat-completions). - -### `GOOGLE_API_KEY` (optional) - -Google Gemini Pro Api Key. - -### `GOOGLE_URL` (optional) - -Google Gemini Pro Api Url. - -### `ANTHROPIC_API_KEY` (optional) - -anthropic claude Api Key. - -### `ANTHROPIC_API_VERSION` (optional) - -anthropic claude Api version. - -### `ANTHROPIC_URL` (optional) - -anthropic claude Api Url. - -### `BAIDU_API_KEY` (optional) - -Baidu Api Key. - -### `BAIDU_SECRET_KEY` (optional) - -Baidu Secret Key. - -### `BAIDU_URL` (optional) - -Baidu Api Url. - -### `BYTEDANCE_API_KEY` (optional) - -ByteDance Api Key. - -### `BYTEDANCE_URL` (optional) - -ByteDance Api Url. - -### `ALIBABA_API_KEY` (optional) - -Alibaba Cloud Api Key. - -### `ALIBABA_URL` (optional) - -Alibaba Cloud Api Url. - -### `IFLYTEK_URL` (Optional) - -iflytek Api Url. - -### `IFLYTEK_API_KEY` (Optional) - -iflytek Api Key. - -### `IFLYTEK_API_SECRET` (Optional) - -iflytek Api Secret. - -### `CHATGLM_API_KEY` (optional) - -ChatGLM Api Key. - -### `CHATGLM_URL` (optional) - -ChatGLM Api Url. - -### `DEEPSEEK_API_KEY` (optional) - -DeepSeek Api Key. - -### `DEEPSEEK_URL` (optional) - -DeepSeek Api Url. - -### `HIDE_USER_API_KEY` (optional) - -> Default: Empty - -If you do not want users to input their own API key, set this value to 1. - -### `DISABLE_GPT4` (optional) - -> Default: Empty - -If you do not want users to use GPT-4, set this value to 1. - -### `ENABLE_BALANCE_QUERY` (optional) - -> Default: Empty - -If you do want users to query balance, set this value to 1. - -### `DISABLE_FAST_LINK` (optional) - -> Default: Empty - -If you want to disable parse settings from url, set this to 1. - -### `CUSTOM_MODELS` (optional) - -> Default: Empty -> Example: `+llama,+claude-2,-gpt-3.5-turbo,gpt-4-1106-preview=gpt-4-turbo` means add `llama, claude-2` to model list, and remove `gpt-3.5-turbo` from list, and display `gpt-4-1106-preview` as `gpt-4-turbo`. - -To control custom models, use `+` to add a custom model, use `-` to hide a model, use `name=displayName` to customize model name, separated by comma. - -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) - -Change default model - -### `VISION_MODELS` (optional) - -> Default: Empty -> Example: `gpt-4-vision,claude-3-opus,my-custom-model` means add vision capabilities to these models in addition to the default pattern matches (which detect models containing keywords like "vision", "claude-3", "gemini-1.5", etc). - -Add additional models to have vision capabilities, beyond the default pattern matching. Multiple models should be separated by commas. - -### `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` -- Multiple addresses are connected by ', ' - -### `DEFAULT_INPUT_TEMPLATE` (optional) - -Customize the default template used to initialize the User Input Preprocessing configuration item in Settings. - -### `STABILITY_API_KEY` (optional) - -Stability API key. - -### `STABILITY_URL` (optional) - -Customize Stability API url. - -### `ENABLE_MCP` (optional) - -Enable MCP(Model Context Protocol)Feature - -### `SILICONFLOW_API_KEY` (optional) - -SiliconFlow API Key. - -### `SILICONFLOW_URL` (optional) - -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: - -``` -OPENAI_API_KEY= - -# if you are not able to access openai service, use this BASE_URL -BASE_URL=https://chatgpt1.nextweb.fun/api/proxy -``` - -### Local Development - -```shell -# 1. install nodejs and yarn first -# 2. config local env vars in `.env.local` -# 3. run -yarn install -yarn dev -``` - ## Deployment -### Docker (Recommended) - -```shell -docker pull yidadaa/chatgpt-next-web - -docker run -d -p 3000:3000 \ - -e OPENAI_API_KEY=sk-xxxx \ - -e CODE=your-password \ - yidadaa/chatgpt-next-web -``` - -You can start service behind a proxy: - -```shell -docker run -d -p 3000:3000 \ - -e OPENAI_API_KEY=sk-xxxx \ - -e CODE=your-password \ - -e PROXY_URL=http://localhost:7890 \ - yidadaa/chatgpt-next-web -``` - -If your proxy needs password, use: - -```shell --e PROXY_URL="http://127.0.0.1:7890 user pass" -``` +**[https://chat.spacetimee.xyz](https://chat.spacetimee.xyz)** -If enable MCP, use: +## Maintainer -``` -docker run -d -p 3000:3000 \ - -e OPENAI_API_KEY=sk-xxxx \ - -e CODE=your-password \ - -e ENABLE_MCP=true \ - yidadaa/chatgpt-next-web -``` +**Space Time** -### Shell +## Upstream -```shell -bash <(curl -s https://raw.githubusercontent.com/Yidadaa/ChatGPT-Next-Web/main/scripts/setup.sh) -``` +**[Next Chat](https://github.com/chatgptnextweb/nextchat)** -## Synchronizing Chat Records (UpStash) +## Contact -| [简体中文](./docs/synchronise-chat-logs-cn.md) | [English](./docs/synchronise-chat-logs-en.md) | [Italiano](./docs/synchronise-chat-logs-es.md) | [日本語](./docs/synchronise-chat-logs-ja.md) | [한국어](./docs/synchronise-chat-logs-ko.md) - -## Documentation - -> Please go to the [docs][./docs] directory for more documentation instructions. - -- [Deploy with cloudflare (Deprecated)](./docs/cloudflare-pages-en.md) -- [Frequent Ask Questions](./docs/faq-en.md) -- [How to add a new translation](./docs/translation.md) -- [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). - -## Donation - -[Buy Me a Coffee](https://www.buymeacoffee.com/yidadaa) - -## Special Thanks - -### Contributors - - - - +1. **QQ Group: 902575634** +2. **Email: Zeus6_6@163.com** -## LICENSE +## License [MIT](https://opensource.org/license/mit/) diff --git a/README_CN.md b/README_CN.md index f4c441ad006..a09c6f80054 100644 --- a/README_CN.md +++ b/README_CN.md @@ -1,392 +1,32 @@
- - icon + + icon -

NextChat

+

Frok 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) - -
- -## Sponsor AI API - - - icon - - -[302.AI](https://302.ai/) 是一个按需付费的AI应用平台,提供市面上最全的AI API和AI在线应用。 - -## 企业版 - -满足您公司私有化部署和定制需求 - -- **品牌定制**:企业量身定制 VI/UI,与企业品牌形象无缝契合 -- **资源集成**:由企业管理人员统一配置和管理数十种 AI 资源,团队成员开箱即用 -- **权限管理**:成员权限、资源权限、知识库权限层级分明,企业级 Admin Panel 统一控制 -- **知识接入**:企业内部知识库与 AI 能力相结合,比通用 AI 更贴近企业自身业务需求 -- **安全审计**:自动拦截敏感提问,支持追溯全部历史对话记录,让 AI 也能遵循企业信息安全规范 -- **私有部署**:企业级私有部署,支持各类主流私有云部署,确保数据安全和隐私保护 -- **持续更新**:提供多模态、智能体等前沿能力持续更新升级服务,常用常新、持续先进 - -企业版咨询: **business@nextchat.dev** - - - -## 开始使用 - -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) +[English](./README.md) / 简体中文 / [日本語](./README_JA.md) / [한국어](./README_KO.md)
-## 保持更新 - -如果你按照上述步骤一键部署了自己的项目,可能会发现总是提示“存在更新”的问题,这是由于 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 本项目或者 follow 作者来及时获得新功能更新通知。 - -## 配置页面访问密码 - -> 配置密码后,用户需要在设置页手动填写访问码才可以正常聊天,否则会通过消息提示未授权状态。 - -> **警告**:请务必将密码的位数设置得足够长,最好 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,这样可以随机轮询这些 key。 - -### `CODE` (可选) - -访问密码,可选,可以使用逗号隔开多个密码。 - -**警告**:如果不填写此项,则任何人都可以直接使用你部署后的网站,可能会导致你的 token 被急速消耗完毕,建议填写此选项。 - -### `BASE_URL` (可选) - -> Default: `https://api.openai.com` - -> Examples: `http://your-openai-proxy.com` - -OpenAI 接口代理 URL,如果你手动配置了 openai 接口代理,请填写此选项。 - -> 如果遇到 ssl 证书问题,请将 `BASE_URL` 的协议设置为 http。 - -### `OPENAI_ORG_ID` (可选) - -指定 OpenAI 中的组织 ID。 - -### `AZURE_URL` (可选) - -> 形如:https://{azure-resource-url}/openai - -Azure 部署地址。 - -### `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 version. - -### `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` 则可以让对话的默认使用 `gpt35(Azure)` - -在ByteDance的模式下,支持使用`modelName@bytedance=deploymentName`的方式配置模型名称和部署名称(deploy-name) - -> 示例: `+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` (可选) - -自定义默认的 template,用于初始化『设置』中的『用户输入预处理』配置项 - -### `STABILITY_API_KEY` (optional) - -Stability API密钥 - -### `STABILITY_URL` (optional) - -自定义的Stability API请求地址 - -### `ENABLE_MCP` (optional) - -启用MCP(Model Context Protocol)功能 - -### `SILICONFLOW_API_KEY` (optional) - -SiliconFlow API Key. - -### `SILICONFLOW_URL` (optional) - -SiliconFlow API URL. - -### `AI302_API_KEY` (optional) - -302.AI API Key. - -### `AI302_URL` (optional) - -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. 安装 nodejs 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 部署。 +## 部署地址 -## 鸣谢 +**[https://chat.spacetimee.xyz](https://chat.spacetimee.xyz)** -### 捐赠者 +## 维护者 -> 见英文版。 +**Space Time** -### 贡献者 +## 上游存储库 -[见项目贡献者列表](https://github.com/Yidadaa/ChatGPT-Next-Web/graphs/contributors) +**[Next Chat](https://github.com/chatgptnextweb/nextchat)** -### 相关项目 +## 联系方式 -- [one-api](https://github.com/songquanpeng/one-api): 一站式大模型额度管理平台,支持市面上所有主流大语言模型 +1. **QQ 群: 902575634** +2. **邮箱: Zeus6_6@163.com** -## 开源协议 +## 许可证 [MIT](https://opensource.org/license/mit/) diff --git a/README_JA.md b/README_JA.md index 917cc1262c0..d910fa0e00b 100644 --- a/README_JA.md +++ b/README_JA.md @@ -1,323 +1,32 @@
-プレビュー -

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) - -
- -## Sponsor AI API - - - icon + + icon -[302.AI](https://302.ai/) は、オンデマンドで支払うAIアプリケーションプラットフォームで、最も安全なAI APIとAIオンラインアプリケーションを提供します。 - -## 企業版 +

Frok NextChat

-あなたの会社のプライベートデプロイとカスタマイズのニーズに応える - -- **ブランドカスタマイズ**:企業向けに特別に設計された VI/UI、企業ブランドイメージとシームレスにマッチ -- **リソース統合**:企業管理者が数十種類のAIリソースを統一管理、チームメンバーはすぐに使用可能 -- **権限管理**:メンバーの権限、リソースの権限、ナレッジベースの権限を明確にし、企業レベルのAdmin Panelで統一管理 -- **知識の統合**:企業内部のナレッジベースとAI機能を結びつけ、汎用AIよりも企業自身の業務ニーズに近づける -- **セキュリティ監査**:機密質問を自動的にブロックし、すべての履歴対話を追跡可能にし、AIも企業の情報セキュリティ基準に従わせる -- **プライベートデプロイ**:企業レベルのプライベートデプロイ、主要なプライベートクラウドデプロイをサポートし、データのセキュリティとプライバシーを保護 -- **継続的な更新**:マルチモーダル、エージェントなどの最先端機能を継続的に更新し、常に最新であり続ける - -企業版のお問い合わせ: **business@nextchat.dev** - -## 始めに - -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) +[English](./README.md) / [简体中文](./README_CN.md) / 日本語 / [한국어](./README_KO.md)
-## 更新を維持する - -もし上記の手順に従ってワンクリックでプロジェクトをデプロイした場合、「更新があります」というメッセージが常に表示されることがあります。これは、Vercel がデフォルトで新しいプロジェクトを作成するためで、本プロジェクトを fork していないことが原因です。そのため、正しく更新を検出できません。 - -以下の手順に従って再デプロイすることをお勧めします: - -- 元のリポジトリを削除する -- ページ右上の fork ボタンを使って、本プロジェクトを fork する -- Vercel で再度選択してデプロイする、[詳細な手順はこちらを参照してください](./docs/vercel-ja.md)。 - -### 自動更新を開く - -> Upstream Sync の実行エラーが発生した場合は、[手動で Sync Fork](./README_JA.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 したプロジェクトを上流のコードと同期する方法を確認してください。 - -このプロジェクトをスターまたはウォッチしたり、作者をフォローすることで、新機能の更新通知をすぐに受け取ることができます。 - -## ページアクセスパスワードを設定する - -> パスワードを設定すると、ユーザーは設定ページでアクセスコードを手動で入力しない限り、通常のチャットができず、未承認の状態であることを示すメッセージが表示されます。 - -> **警告**:パスワードの桁数は十分に長く設定してください。7桁以上が望ましいです。さもないと、[ブルートフォース攻撃を受ける可能性があります](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/518)。 - -このプロジェクトは限られた権限管理機能を提供しています。Vercel プロジェクトのコントロールパネルで、環境変数ページに `CODE` という名前の環境変数を追加し、値をカンマで区切ったカスタムパスワードに設定してください: - -``` -code1,code2,code3 -``` - -この環境変数を追加または変更した後、**プロジェクトを再デプロイ**して変更を有効にしてください。 - -## 環境変数 - -> 本プロジェクトのほとんどの設定は環境変数で行います。チュートリアル:[Vercel の環境変数を変更する方法](./docs/vercel-ja.md)。 - -### `OPENAI_API_KEY` (必須) - -OpenAI の API キー。OpenAI アカウントページで申請したキーをカンマで区切って複数設定できます。これにより、ランダムにキーが選択されます。 - -### `CODE` (オプション) - -アクセスパスワード。カンマで区切って複数設定可能。 - -**警告**:この項目を設定しないと、誰でもデプロイしたウェブサイトを利用でき、トークンが急速に消耗する可能性があるため、設定をお勧めします。 - -### `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/deployments/{deploy-name} -> `CUSTOM_MODELS` で `displayName` 形式で {deploy-name} を設定した場合、`AZURE_URL` から {deploy-name} を省略できます。 - -Azure のデプロイ URL。 - -### `AZURE_API_KEY` (オプション) - -Azure の API キー。 - -### `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 API キー。 - -### `GOOGLE_URL` (オプション) - -Google Gemini Pro API の URL。 - -### `ANTHROPIC_API_KEY` (オプション) - -Anthropic Claude API キー。 - -### `ANTHROPIC_API_VERSION` (オプション) - -Anthropic Claude API バージョン。 - -### `ANTHROPIC_URL` (オプション) - -Anthropic Claude API の URL。 - -### `BAIDU_API_KEY` (オプション) - -Baidu API キー。 - -### `BAIDU_SECRET_KEY` (オプション) - -Baidu シークレットキー。 - -### `BAIDU_URL` (オプション) - -Baidu API の URL。 - -### `BYTEDANCE_API_KEY` (オプション) - -ByteDance API キー。 - -### `BYTEDANCE_URL` (オプション) - -ByteDance API の URL。 - -### `ALIBABA_API_KEY` (オプション) - -アリババ(千问)API キー。 - -### `ALIBABA_URL` (オプション) - -アリババ(千问)API の URL。 - -### `HIDE_USER_API_KEY` (オプション) - -ユーザーが API キーを入力できないようにしたい場合は、この環境変数を 1 に設定します。 - -### `DISABLE_GPT4` (オプション) - -ユーザーが GPT-4 を使用できないようにしたい場合は、この環境変数を 1 に設定します。 - -### `ENABLE_BALANCE_QUERY` (オプション) - -バランスクエリ機能を有効にしたい場合は、この環境変数を 1 に設定します。 - -### `DISABLE_FAST_LINK` (オプション) - -リンクからのプリセット設定解析を無効にしたい場合は、この環境変数を 1 に設定します。 - -### `WHITE_WEBDAV_ENDPOINTS` (オプション) - -アクセス許可を与える WebDAV サービスのアドレスを追加したい場合、このオプションを使用します。フォーマット要件: - -- 各アドレスは完全なエンドポイントでなければなりません。 - > `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)` のオプションが表示されます。 - -ByteDance モードでは、`modelName@bytedance=deploymentName` 形式でモデル名とデプロイ名(deploy-name)を設定できます。 - -> 例: `+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` (オプション) - -『設定』の『ユーザー入力前処理』の初期設定に使用するテンプレートをカスタマイズします。 - -### `AI302_API_KEY` (オプション) - -302.AI API キー. - -### `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= -``` - -### ローカル開発 - -1. Node.js 18 と Yarn をインストールします。具体的な方法は ChatGPT にお尋ねください。 -2. `yarn install && yarn dev` を実行します。⚠️ 注意:このコマンドはローカル開発用であり、デプロイには使用しないでください。 -3. ローカルでデプロイしたい場合は、`yarn install && yarn build && yarn start` コマンドを使用してください。プロセスを守るために pm2 を使用することもできます。詳細は ChatGPT にお尋ねください。 - -## デプロイ - -### コンテナデプロイ(推奨) - -> 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 -``` - -プロキシを指定することもできます: - -```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 -``` - -ローカルプロキシがアカウントとパスワードを必要とする場合は、以下を使用できます: - -```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 を使用してデプロイしてください。 +## デプロイ先 -## 謝辞 +**[https://chat.spacetimee.xyz](https://chat.spacetimee.xyz)** -### 寄付者 +## メンテナー -> 英語版をご覧ください。 +**Space Time** -### 貢献者 +## 上流リポジトリ -[プロジェクトの貢献者リストはこちら](https://github.com/Yidadaa/ChatGPT-Next-Web/graphs/contributors) +**[Next Chat](https://github.com/chatgptnextweb/nextchat)** -### 関連プロジェクト +## 連絡先 -- [one-api](https://github.com/songquanpeng/one-api): 一つのプラットフォームで大規模モデルのクォータ管理を提供し、市場に出回っているすべての主要な大規模言語モデルをサポートします。 +1. **QQ グループ: 902575634** +2. **メール: Zeus6_6@163.com** -## オープンソースライセンス +## ライセンス [MIT](https://opensource.org/license/mit/) diff --git a/README_KO.md b/README_KO.md index 40ba5a6a1c4..d4cadf82886 100644 --- a/README_KO.md +++ b/README_KO.md @@ -4,489 +4,29 @@ icon -

NextChat

+

Frok NextChat

-영어 / [简体中文](./README_CN.md) - - - ChatGPTNextWeb%2FChatGPT-Next-Web | Trendshift - - -✨ 빠르고 가벼운 AI 어시스턴트, Claude, DeepSeek, GPT-4, 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) - - - -## ❤️ AI API 후원사 - - - icon - - -[302.AI](https://302.ai/)는 사용한 만큼만 비용을 지불하는 AI 애플리케이션 플랫폼으로, 다양한 AI API 및 온라인 애플리케이션을 제공합니다. - -## 🥳 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 지원! - -> 빌드 전 환경 변수(env) `ENABLE_MCP=true` 설정 필요 - - - -## 엔터프라이즈 버전 - -회사 내부 시스템에 맞춘 프라이빗 배포 및 맞춤형 커스터마이징 지원: - -- **브랜드 커스터마이징**: 기업 이미지에 맞는 UI/UX 테마 적용 -- **리소스 통합 관리**: 다양한 AI 모델을 통합하여 팀원이 손쉽게 사용 가능 -- **권한 제어**: 관리자 패널을 통한 멤버·리소스·지식 베이스 권한 설정 -- **지식 통합**: 사내 문서 및 데이터와 AI를 결합한 맞춤형 답변 제공 -- **보안 감사**: 민감한 질문 차단 및 모든 기록 추적 가능 -- **프라이빗 배포 지원**: 주요 클라우드 서비스에 맞춘 배포 옵션 -- **지속적 업데이트**: 멀티모달 등 최신 AI 기능 지속 반영 - -엔터프라이즈 문의: **business@nextchat.dev** - -## 🖼️ 스크린샷 - -![설정](./docs/images/settings.png) -![기타](./docs/images/more.png) - -## 주요 기능 소개 - -- Vercel에서 원클릭 무료 배포 (1분 내 완성) -- 모든 OS(Linux/Windows/MacOS)에서 사용 가능한 클라이언트 (~5MB) [지금 다운 받기](https://github.com/Yidadaa/ChatGPT-Next-Web/releases) -- 자체 LLM 서버와 완벽 호환. [RWKV-Runner](https://github.com/josStorer/RWKV-Runner) 또는 [LocalAI](https://github.com/go-skynet/LocalAI)와 함께 사용하는 것을 추천 -- 개인 정보 보호: 모든 대화 기록은 브라우저에만 저장 -- Markdown 지원: LaTex, Mermaid, 코드 하이라이팅 등 -- 반응형 디자인, 다크 모드, PWA 지원 -- 빠른 초기 로딩 속도 (~100kb), 스트리밍 응답 -- 프롬프트 템플릿 생성/공유/디버깅 지원 (v2) -- v2: 프롬프트 템플릿 기반 도구 생성, 공유, 디버깅 가능 -- 고급 프롬프트 내장 [awesome-chatgpt-prompts-zh](https://github.com/PlexPt/awesome-chatgpt-prompts-zh) and [awesome-chatgpt-prompts](https://github.com/f/awesome-chatgpt-prompts) -- 긴 대화 내용 자동 압축 저장으로 토큰 절약 -- I18n: English, 简体中文, 繁体中文, 日本語, Français, Español, Italiano, Türkçe, Deutsch, Tiếng Việt, Русский, Čeština, 한국어, Indonesia - -
- -![主界面](./docs/images/cover.png) +[English](./README.md) / [简体中文](./README_CN.md) / [日本語](./README_JA.md) / 한국어
-## 개발 로드맵 - -- [x] 시스템 프롬프트: 사용자가 정의한 프롬프트를 시스템 프롬프트로 고정하기 [#138](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/138) -- [x] 사용자 프롬프트: 사용자 정의 프롬프트를 편집 및 저장하여 리스트로 관리 가능 -- [x] 프롬프트 템플릿: 사전 정의된 인컨텍스트 프롬프트로 새 채팅 생성 [#993](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/993) -- [x] 이미지로 공유하거나 ShareGPT로 공유 [#1741](https://github.com/Yidadaa/ChatGPT-Next-Web/pull/1741) -- [x] Tauri 기반 데스크톱 앱 -- [x] 자체 모델 호스팅: [RWKV-Runner](https://github.com/josStorer/RWKV-Runner), [LocalAI](https://github.com/go-skynet/LocalAI) 등 서버 배포 모델들과 완벽 호환 (llama, gpt4all, rwkv, vicuna, koala, gpt4all-j, cerebras, falcon, dolly 등) -- [x] 아티팩트: 생성된 콘텐츠 및 웹페이지를 별도 창으로 미리보기, 복사, 공유 가능 [#5092](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web/pull/5092) -- [x] 플러그인: 웹 검색, 계산기, 기타 외부 API 기능 지원 [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165) [#5353](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web/issues/5353) -- [x] 실시간 채팅 지원 [#5672](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web/issues/5672) -- [ ] 로컬 지식 베이스 지원 예정 - -## 🚀 최근 업데이트 - -- 🚀 v2.15.8 실시간 채팅 지원 [#5672](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web/issues/5672) -- 🚀 v2.15.4 Tauri 기반 LLM API 호출 기능 추가 → 보안 강화 [#5379](https://github.com/ChatGPTNextWeb/ChatGPT-Next-Web/issues/5379) -- 🚀 v2.15.0 플러그인 기능 추가 → [NextChat-Awesome-Plugins](https://github.com/ChatGPTNextWeb/NextChat-Awesome-Plugins) -- 🚀 v2.14.0 아티팩트 및 Stable Diffusion 기능 추가 -- 🚀 v2.10.1 Google Gemini Pro 모델 지원 -- 🚀 v2.9.11 Azure Endpoint 사용 가능 -- 🚀 v2.8 모든 플랫폼에서 실행 가능한 클라이언트 출시 -- 🚀 v2.7 대화 내용을 이미지로, 또는 ShareGPT로 공유 가능 -- 🚀 v2.0 릴리즈: 프롬프트 템플릿 생성 및 아이디어 구현 가능! → [ChatGPT Prompt Engineering Tips](https://www.allabtai.com/prompt-engineering-tips-zero-one-and-few-shot-prompting/) - -## 시작하기 - -1. [OpenAI API 키](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&project-name=chatgpt-next-web&repository-name=ChatGPT-Next-Web) 버튼을 클릭해 Vercel에 배포합니다. `CODE`는 페이지 비밀번호라는 점을 기억하세요. - -3. Enjoy :) - -## FAQ - -[FAQ](./docs/faq-ko.md) - -## 최신 상태 유지 (Keep Updated) - -Vercel로 배포한 경우, "Updates Available" 메시지가 계속 나타날 수 있습니다. 이는 프로젝트를 포크하지 않고 새로 생성했기 때문입니다. - -다음 절차에 따라 다시 배포를 권장합니다: - -1. 기존 레포 삭제 -2. 우측 상단 "Fork" 버튼 클릭 → 포크 생성 -3. 포크된 프로젝트를 다시 Vercel에 배포 - → [자세한 튜토리얼 보기](./docs/vercel-ko.md) - -### 자동 업데이트 활성화 (Enable Automatic Updates) - -> Upstream Sync 오류 발생 시, [수동으로 코드 업데이트](./README_KO.md#manually-updating-code)하세요. - -프로젝트 포크 후에는 GitHub의 제약으로 인해 Actions 페이지에서 아래 항목들을 수동으로 활성화해야 합니다: - -- `Workflows` -- `Upstream Sync Action` - -이후 매 시간 자동으로 업데이트됩니다: - -![자동 업데이트 활성화](./docs/images/enable-actions.jpg) -![업스트림 동기화 활성화](./docs/images/enable-actions-sync.jpg) - -### 수동 업데이트 방법 (Manually Updating Code) - -즉시 업데이트가 필요한 경우, [깃헙 문서](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork)를 참고해 포크된 프로젝트를 upstream code와 동기화하세요. - -릴리스 알림을 원하시면 star 또는 watch를 눌러주세요. - -## 접근 비밀번호 설정 (Access Password) - -이 프로젝트는 제한된 접근 제어를 제공합니다. -Vercel 환경 변수에 `CODE`를 다음 형식으로 추가하세요. value는 ,를 통해 구분된 비밀번호여야 합니다.: - -``` -code1,code2,code3 -``` - -수정 후 반드시 다시 배포해야 적용됩니다. - -## 환경 변수 (Environment Variables) - -### `CODE` (선택 사항) - -접속 비밀번호. 쉼표로 구분합니다. - -### `OPENAI_API_KEY` (필수) - -당신의 OpenAI API 키, 여러 개를 사용하려면 쉼표로 연결합니다. - -### `BASE_URL` (선택 사항) - -> 기본값: `https://api.openai.com` - -> 예시: `http://your-openai-proxy.com` - -OpenAI API 요청의 기본 URL을 재정의합니다. - -### `OPENAI_ORG_ID` (선택 사항) - -OpenAI organization ID를 지정합니다. - -### `AZURE_URL` (선택 사항) - -> 예시: https://{azure-resource-url}/openai - -Azure 배포 URL입니다. - -### `AZURE_API_KEY` (선택 사항) - -Azure API 키입니다. - -### `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 API 키입니다. - -### `GOOGLE_URL` (선택 사항) - -Google Gemini Pro API URL입니다. - -### `ANTHROPIC_API_KEY` (선택 사항) - -Anthropic Claude API 키입니다. - -### `ANTHROPIC_API_VERSION` (선택 사항) - -Anthropic Claude API 버전입니다. - -### `ANTHROPIC_URL` (선택 사항) - -Anthropic Claude API URL입니다. - -### `BAIDU_API_KEY` (선택 사항) - -Baidu API 키입니다. - -### `BAIDU_SECRET_KEY` (선택 사항) - -Baidu Secret 키입니다. - -### `BAIDU_URL` (선택 사항) - -Baidu API URL입니다. - -### `BYTEDANCE_API_KEY` (선택 사항) +## 배포 주소 -ByteDance API 키입니다. +**[https://chat.spacetimee.xyz](https://chat.spacetimee.xyz)** -### `BYTEDANCE_URL` (선택 사항) +## 관리자 -ByteDance API URL입니다. +**Space Time** -### `ALIBABA_API_KEY` (선택 사항) +## 업스트림 저장소 -Alibaba Cloud API 키입니다. +**[Next Chat](https://github.com/chatgptnextweb/nextchat)** -### `ALIBABA_URL` (선택 사항) +## 연락처 -Alibaba Cloud API URL입니다. - -### `IFLYTEK_URL` (선택 사항) - -iflytek API URL입니다. - -### `IFLYTEK_API_KEY` (선택 사항) - -iflytek API 키입니다. - -### `IFLYTEK_API_SECRET` (선택 사항) - -iflytek API 시크릿입니다. - -### `CHATGLM_API_KEY` (선택 사항) - -ChatGLM API 키입니다. - -### `CHATGLM_URL` (선택 사항) - -ChatGLM API URL입니다. - -### `DEEPSEEK_API_KEY` (선택 사항) - -DeepSeek API 키입니다. - -### `DEEPSEEK_URL` (선택 사항) - -DeepSeek API URL입니다. - -### `HIDE_USER_API_KEY` (선택 사항) - -> 기본값: 비어 있음 - -사용자가 자신의 API 키를 입력하지 못하게 하려면 이 값을 1로 설정하세요. - -### `DISABLE_GPT4` (선택 사항) - -> 기본값: 비어 있음 - -사용자가 GPT-4를 사용하지 못하게 하려면 이 값을 1로 설정하세요. - -### `ENABLE_BALANCE_QUERY` (선택 사항) - -> 기본값: 비어 있음 - -사용자가 쿼리 잔액을 조회할 수 있도록 하려면 이 값을 1로 설정하세요. - -### `DISABLE_FAST_LINK` (선택 사항) - -> 기본값: 비어 있음 - -URL에서 설정을 파싱하는 기능을 비활성화하려면 이 값을 1로 설정하세요. - -### `CUSTOM_MODELS` (선택 사항) - -> 기본값: 비어 있음 -> 예시: `+llama,+claude-2,-gpt-3.5-turbo,gpt-4-1106-preview=gpt-4-turbo` -이는 `llama`, `claude-2`를 모델 리스트에 추가하고, `gpt-3.5-turbo`를 제거하며, `gpt-4-1106-preview`를 `gpt-4-turbo`로 표시합니다. - -사용자 지정 모델 제어 시 `+`는 추가, `-`는 제거, `이름=표시이름`은 모델명 커스터마이징을 의미합니다. 쉼표로 구분하세요. - -- `-all`은 기본 모델을 모두 비활성화 -- `+all`은 기본 모델을 모두 활성화 - -Azure 용법 예시: `modelName@Azure=deploymentName` → 배포 이름을 커스터마이징 가능 -> 예시: `+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"` 키워드를 포함한 모델은 자동 인식됨). 기본 모델 외에도 모델을 추가할 수 있습니다. 쉼표로 구분하세요. - -### `WHITE_WEBDAV_ENDPOINTS` (선택 사항) - -접속 허용할 WebDAV 서비스 주소를 늘리고자 할 때 사용합니다. - -- 각 주소는 완전한 endpoint 여야 함: `https://xxxx/yyy` -- 여러 주소는 `,`로 구분 - -### `DEFAULT_INPUT_TEMPLATE` (선택 사항) - -설정 메뉴의 사용자 입력 전처리 구성 항목 초기화 시 사용할 기본 템플릿을 설정합니다. - -### `STABILITY_API_KEY` (선택 사항) - -Stability API 키입니다. - -### `STABILITY_URL` (선택 사항) - -Stability API URL을 커스터마이징합니다. - -### `ENABLE_MCP` (선택 사항) - -MCP (Model Context Protocol) 기능을 활성화합니다. - -### `SILICONFLOW_API_KEY` (선택 사항) - -SiliconFlow API 키입니다. - -### `SILICONFLOW_URL` (선택 사항) - -SiliconFlow API URL입니다. - -### `AI302_API_KEY` (선택 사항) - -302.AI API 키입니다. - -### `AI302_URL` (선택 사항) - -302.AI API URL입니다. - -## 요구 사항 (Requirements) - -NodeJS >= 18, Docker >= 20 - -## 개발 (Development) - -[![Gitpod에서 열기](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web) - -개발을 시작하기 전에 프로젝트 루트에 `.env.local` 파일을 만들고, 아래와 같이 API 키를 입력하세요: - -``` -OPENAI_API_KEY=<여기에 API 키 입력> - -# OpenAI 서비스를 사용할 수 없는 경우 아래 BASE_URL 사용 -BASE_URL=https://chatgpt1.nextweb.fun/api/proxy -``` - -### 로컬 개발 실행 - -```shell -# 1. Node.js와 Yarn을 먼저 설치 -# 2. `.env.local` 파일에 환경 변수 설정 -# 3. 실행 -yarn install -yarn dev -``` - -## 배포 (Deployment) - -### Docker (권장) - -```shell -docker pull yidadaa/chatgpt-next-web - -docker run -d -p 3000:3000 \ - -e OPENAI_API_KEY=sk-xxxx \ - -e CODE=your-password \ - yidadaa/chatgpt-next-web -``` - -서비스에 프록시를 사용하려면: - -```shell -docker run -d -p 3000:3000 \ - -e OPENAI_API_KEY=sk-xxxx \ - -e CODE=your-password \ - -e PROXY_URL=http://localhost:7890 \ - yidadaa/chatgpt-next-web -``` - -프록시에 인증이 필요한 경우: - -```shell --e PROXY_URL="http://127.0.0.1:7890 user pass" -``` - -MCP를 활성화하려면: - -``` -docker run -d -p 3000:3000 \ - -e OPENAI_API_KEY=sk-xxxx \ - -e CODE=your-password \ - -e ENABLE_MCP=true \ - yidadaa/chatgpt-next-web -``` - -### 로컬 배포 - -콘솔에서 다음 명령을 실행하세요. - -```shell -bash <(curl -s https://raw.githubusercontent.com/Yidadaa/ChatGPT-Next-Web/main/scripts/setup.sh) -``` - -⚠️ 참고: 설치 중에 문제가 발생하면 Docker 배포를 사용하세요. - -## 채팅 기록 동기화 (UpStash) - -| [简体中文](./docs/synchronise-chat-logs-cn.md) | [English](./docs/synchronise-chat-logs-en.md) | [Italiano](./docs/synchronise-chat-logs-es.md) | [日本語](./docs/synchronise-chat-logs-ja.md) | [한국어](./docs/synchronise-chat-logs-ko.md) - -## 문서 (Documentation) - -> 더 많은 문서는 [docs](./docs) 디렉토리를 참고하세요. - -- [Cloudflare 배포 가이드 (폐기됨)](./docs/cloudflare-pages-ko.md) -- [자주 묻는 질문](./docs/faq-ko.md) -- [새 번역 추가 방법](./docs/translation.md) -- [Vercel 사용법 (중문)](./docs/vercel-cn.md) -- [사용자 매뉴얼 (중문, 작성 중)](./docs/user-manual-cn.md) - -## 번역 (Translation) - -새로운 번역을 추가하고 싶다면, [이 문서](./docs/translation.md)를 읽어보세요. - -## 후원 (Donation) - -[Buy Me a Coffee](https://www.buymeacoffee.com/yidadaa) - -## 특별 감사 (Special Thanks) - -### 기여자 (Contributors) - - - - +1. **QQ 그룹: 902575634** +2. **이메일: Zeus6_6@163.com** -## 라이선스 (LICENSE) +## 라이선스 [MIT](https://opensource.org/license/mit/) diff --git a/docs/images/bt/bt-install-1.jpeg b/docs/images/bt/bt-install-1.jpeg index fff3406d656..ca33c8c1fc4 100644 Binary files a/docs/images/bt/bt-install-1.jpeg and b/docs/images/bt/bt-install-1.jpeg differ diff --git a/docs/images/bt/bt-install-2.jpeg b/docs/images/bt/bt-install-2.jpeg index 77256ef8d36..7d38f304d31 100644 Binary files a/docs/images/bt/bt-install-2.jpeg and b/docs/images/bt/bt-install-2.jpeg differ diff --git a/docs/images/bt/bt-install-3.jpeg b/docs/images/bt/bt-install-3.jpeg index 7790f89e850..8cbccbc5c0c 100644 Binary files a/docs/images/bt/bt-install-3.jpeg and b/docs/images/bt/bt-install-3.jpeg differ diff --git a/docs/images/bt/bt-install-4.jpeg b/docs/images/bt/bt-install-4.jpeg index 38d7caee4cb..0f78367eb51 100644 Binary files a/docs/images/bt/bt-install-4.jpeg and b/docs/images/bt/bt-install-4.jpeg differ diff --git a/docs/images/bt/bt-install-5.jpeg b/docs/images/bt/bt-install-5.jpeg index aa1a7963cb9..d0c40e2312f 100644 Binary files a/docs/images/bt/bt-install-5.jpeg and b/docs/images/bt/bt-install-5.jpeg differ diff --git a/docs/images/bt/bt-install-6.jpeg b/docs/images/bt/bt-install-6.jpeg index 42359e65ba6..43a4e3cba8f 100644 Binary files a/docs/images/bt/bt-install-6.jpeg and b/docs/images/bt/bt-install-6.jpeg differ diff --git a/public/apple-touch-icon.png b/public/apple-touch-icon.png index 6461c47c206..b1166eaba84 100644 Binary files a/public/apple-touch-icon.png and b/public/apple-touch-icon.png differ