diff --git a/README.md b/README.md index 55a6da404..ba4a6dc49 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,8 @@ One-Click to deploy well-designed ChatGPT web UI on Vercel. - 一键导出聊天记录,完整的 Markdown 支持 - 拥有自己的域名?好上加好,绑定后即可在任何地方**无障碍**快速访问 -## 开发计划 +## 开发计划 + - [x] 为每个对话设置系统 Prompt [#138](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/138) - [ ] 允许用户自行编辑内置 Prompt 列表 - [ ] 使用 tauri 打包桌面应用 @@ -58,11 +59,12 @@ One-Click to deploy well-designed ChatGPT web UI on Vercel. - [ ] 插件机制,支持联网搜索、计算器、调用其他平台 api [#165](https://github.com/Yidadaa/ChatGPT-Next-Web/issues/165) ### 不会开发的功能 + - 界面文字自定义 - 用户登录、账号管理、消息云同步 - ## Get Started + > [简体中文 > 如何开始使用](./README_CN.md#开始使用) 1. Get [OpenAI API Key](https://platform.openai.com/account/api-keys); @@ -71,9 +73,11 @@ One-Click to deploy well-designed ChatGPT web UI on Vercel. 3. Enjoy :) ## FAQ + [简体中文 > 常见问题](./docs/faq-cn.md) | [English > FAQ](./docs/faq.en.md) ## Keep Updated + > [简体中文 > 如何保持代码更新](./README_CN.md#保持更新) 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. @@ -87,11 +91,12 @@ We recommend that you follow the steps below to re-deploy: This project will be continuously updated, and after forking the project, the upstream code will be automatically synchronized every day without additional operations. -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. +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 notifictions in time. ## Access Password + > [简体中文 > 如何增加访问密码](./README_CN.md#配置页面访问密码) 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: @@ -103,6 +108,7 @@ code1,code2,code3 After adding or modifying this environment variable, please redeploy the project for the changes to take effect. ## Environment Variables + > [简体中文 > 如何配置 api key、访问密码、接口代理](./README_CN.md#环境变量) ### `OPENAI_API_KEY` (required) @@ -128,6 +134,7 @@ Override openai api request base url. Override openai api request protocol. ## Development + > [简体中文 > 如何进行二次开发](./README_CN.md#开发) [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web) @@ -149,13 +156,28 @@ yarn dev ``` ## Deployment + > [简体中文 > 如何部署到私人服务器](./README_CN.md#部署) + ### Docker (Recommended) ```shell docker pull yidadaa/chatgpt-next-web -docker run -d -p 3000:3000 -e OPENAI_API_KEY="" -e CODE="" 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 ``` ### Shell @@ -163,6 +185,7 @@ docker run -d -p 3000:3000 -e OPENAI_API_KEY="" -e CODE="" yidadaa/chatgpt-next- ```shell bash <(curl -s https://raw.githubusercontent.com/Yidadaa/ChatGPT-Next-Web/main/scripts/setup.sh) ``` + ## Screenshots ![Settings](./docs/images/settings.png) @@ -170,9 +193,11 @@ bash <(curl -s https://raw.githubusercontent.com/Yidadaa/ChatGPT-Next-Web/main/s ![More](./docs/images/more.png) ## Donation + [Buy Me a Coffee](https://www.buymeacoffee.com/yidadaa) ## Special Thanks + ### Sponsor [@mushan0x0](https://github.com/mushan0x0) diff --git a/README_CN.md b/README_CN.md index efd5d56a1..0833ae1ac 100644 --- a/README_CN.md +++ b/README_CN.md @@ -64,6 +64,7 @@ code1,code2,code3 增加或修改该环境变量后,请**重新部署**项目使改动生效。 ## 环境变量 + > 本项目大多数配置项都通过环境变量来设置。 ### `OPENAI_API_KEY` (必填项) @@ -110,25 +111,42 @@ OPENAI_API_KEY= 2. 执行 `yarn install && yarn dev` 即可。 ## 部署 + ### 容器部署 (推荐) + > 注意:docker 版本在大多数时间都会落后最新的版本 1 到 2 天,所以部署后会持续出现“存在更新”的提示,属于正常现象。 ```shell docker pull yidadaa/chatgpt-next-web -docker run -d -p 3000:3000 -e OPENAI_API_KEY="" -e CODE="" 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="页面访问密码" \ + -e PROXY_URL="http://localhost:7890" \ + yidadaa/chatgpt-next-web ``` ### 本地部署 + 在控制台运行下方命令: ```shell bash <(curl -s https://raw.githubusercontent.com/Yidadaa/ChatGPT-Next-Web/main/scripts/setup.sh) ``` - ## 鸣谢 + ### 捐赠者 + > 仅列出了部分大额打赏,小额打赏(< 100RMB)人数太多,在此不再列出,敬请谅解。 [@mushan0x0](https://github.com/mushan0x0) @@ -141,6 +159,7 @@ bash <(curl -s https://raw.githubusercontent.com/Yidadaa/ChatGPT-Next-Web/main/s [见项目贡献者列表](https://github.com/Yidadaa/ChatGPT-Next-Web/graphs/contributors) ## 开源协议 + > 反对 996,从我开始。 [Anti 996 License](https://github.com/kattgu7/Anti-996-License/blob/master/LICENSE_CN_EN)