NextChat README

The project's README from github.com/ChatGPTNextWeb/NextChat. As one markdown file: README.md.

icon

NextChat

English / 简体中文

ChatGPTNextWeb%2FChatGPT-Next-Web | Trendshift

✨ Light and Fast AI Assistant,with Claude, DeepSeek, GPT4 & Gemini Pro support.

Saas Web Windows MacOS Linux

NextChatAI / iOS APP / Web App Demo / Desktop App / Enterprise Edition

Deploy on Zeabur Deploy on Vercel Open in Gitpod Deploy with your agent

❤️ Sponsor AI API

icon

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

❤️ Source Code Coming Soon

Github iOS Image

🫣 NextChat Support MCP !

Before build, please set env ENABLE_MCP=true

Enterprise Edition

Meeting Your Company's Privatization and Customization Deployment Requirements:

For enterprise inquiries, please contact: [email protected]

Screenshots

Settings

More

Features

主界面

Roadmap

What's New

Get Started

  1. Get OpenAI API Key;
  2. Click Deploy with Vercel, remember that CODE is your page password;
  3. Enjoy :)

FAQ

English > FAQ

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:

Enable Automatic Updates

If you encounter a failure of Upstream Sync execution, please manually update 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

Enable Automatic Updates

Manually Updating Code

If you want to update instantly, you can check out the GitHub documentation 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.

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.

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:

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

Before starting development, you must create a new .env.local file at project root, and place your api key into it:

OPENAI_API_KEY=<your api key here>

# if you are not able to access openai service, use this BASE_URL
BASE_URL=https://chatgpt1.nextweb.fun/api/proxy

Local Development

# 1. install nodejs and yarn first
# 2. config local env vars in `.env.local`
# 3. run
yarn install
yarn dev

Deployment

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:

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:

-e PROXY_URL="http://127.0.0.1:7890 user pass"

If enable MCP, use:

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)

Synchronizing Chat Records (UpStash)

| 简体中文 | English | Italiano | 日本語 | 한국어

Documentation

Please go to the [docs][./docs] directory for more documentation instructions.

Translation

If you want to add a new translation, read this document.

Donation

Buy Me a Coffee

Special Thanks

Contributors

LICENSE

MIT

NextChat (ChatGPTNextWeb/NextChat)

Searching Database…

88.8K ·GitHub
这是什么?NextChat 是一个快速、轻量的 AI 聊天助手,通过统一的界面让你与 GPT-4o、Claude、Gemini、DeepSeek 以及 100 多种其他模型对话,可以一键部署,也可以自行托管。
这是网站,还是需要安装到电脑上的程序?两者都是:它既可以是一个用 Next.js 开发的网页应用,在浏览器中打开使用;也可以是用 Tauri 构建的原生客户端,安装在 Windows、macOS、Linux、iOS 和 Android 上。
怎样才能让它运行起来?点击一键部署按钮,只需一个 OpenAI API 密钥即可在 Vercel 上启动;或者克隆仓库后在本地运行 `yarn dev`(需要 Node.js >= 18);也可以通过 Docker 部署到自己的服务器上。
我必须有 OpenAI 密钥吗,还是可以使用其他服务商?你需要所选服务商的 API 密钥,支持 OpenAI、Azure、Google Gemini、Anthropic Claude、DeepSeek、百度、字节跳动等多家服务商;如果自行运行,还需要 NodeJS >=18 或 Docker >=20。
在开始设置之前,有哪些需要注意的地方?只有在构建应用前设置 ENABLEMCP=true,MCP 支持才会生效;本地知识库功能仍在规划中,尚未实现。
我能限制对已部署实例的访问吗?可以,你可以设置 CODE 环境变量,其值为一个或多个以逗号分隔的访问密码,用来限制哪些人可以使用你的部署。
MCP 支持能让我做什么?NextChat 实现了模型上下文协议(MCP),使助手能够调用外部工具和数据源;在构建前设置 ENABLEMCP=true 即可启用。
什么是 Artifacts?Artifacts 在 v2.14.0 版本中加入,它让你可以在单独的窗口中预览、复制和分享 AI 生成的内容或网页,而不必在聊天文字中不断滚动查找。
能否连接到自托管或自定义的模型?可以,它支持 LocalAI(llama、gpt4all、rwkv、vicuna、koala 等)这类自托管后端,还可以通过 CUSTOMMODELS 环境变量添加、隐藏或重命名模型。
为什么我的 Vercel 部署总是提示更新?Vercel 会新建一个全新的项目,而不是真正的分叉(fork),这会导致更新检测失效;请删除该项目,在 GitHub 上正确分叉仓库,重新部署,并启用 Upstream Sync Action 以实现每小时自动更新。
What are similar projects?chatbox, brigade, LibreChat, sim, aichat, gpt4free, kirara-ai, unsloth
Size
23.4 MB
Stars
88.8K
Age
3y
Commits · 90 Days