Requirements

NodeJS >= 18, Docker >= 20

1. install nodejs and yarn first

Deployment

Docker (Recommended)

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

Screenshots

Environment Variables

`CODE` (optional)

Access password, separated by 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.

`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.

2. config local env vars in `.env.local`

❤️ Sponsor AI API

<a href='https://302.ai/'> <img src="https://github.com/user-attachments/assets/a03edf82-2031-4f23-bdb8-bfc0bfd168a4" width="100%" alt="icon"/> </a>

302.AI is a pay-as-you-go AI application platform that offers the most comprehensive AI APIs and online applications available.

`OPENAI_API_KEY` (required)

Your openai api key, join multiple api keys with comma.

FAQ

English > FAQ