|
|
@@ -0,0 +1,120 @@
|
|
|
+👉🏼 Fork of <https://github.com/Yidadaa/ChatGPT-Next-Web>
|
|
|
+
|
|
|
+Using this fork to help keep my information local while allowing me to store custom prompts.
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+## Features
|
|
|
+
|
|
|
+- Privacy first, all data 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
|
|
|
+- create, share and debug your chat tools with prompt templates (masks)
|
|
|
+- 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
|
|
|
+
|
|
|
+## 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).
|
|
|
+
|
|
|
+
|
|
|
+## 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
|
|
|
+
|
|
|
+
|
|
|
+### `OPENAI_API_KEY` (required)
|
|
|
+
|
|
|
+Your openai api key.
|
|
|
+
|
|
|
+### `CODE` (optional)
|
|
|
+
|
|
|
+Access passsword, 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.
|
|
|
+
|
|
|
+### `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.
|
|
|
+
|
|
|
+## Development
|
|
|
+
|
|
|
+
|
|
|
+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>
|
|
|
+```
|
|
|
+
|
|
|
+### 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
|
|
|
+```
|
