323 lines
10 KiB
Markdown
323 lines
10 KiB
Markdown
# ChatGPT Web
|
||
|
||
<div style="font-size: 1.5rem;">
|
||
<a href="./README.md">中文</a> |
|
||
<a href="./README.en.md">English</a>
|
||
</div>
|
||
</br>
|
||
|
||
> 声明：此项目只发布于 Github，基于 MIT 协议，免费且作为开源学习使用。并且不会有任何形式的卖号、付费服务、讨论群、讨论组等行为。谨防受骗。
|
||
|
||
|
||
|
||
|
||
- [ChatGPT Web](#chatgpt-web)
|
||
- [介绍](#介绍)
|
||
- [待实现路线](#待实现路线)
|
||
- [前置要求](#前置要求)
|
||
- [Node](#node)
|
||
- [PNPM](#pnpm)
|
||
- [填写密钥](#填写密钥)
|
||
- [安装依赖](#安装依赖)
|
||
- [后端](#后端)
|
||
- [前端](#前端)
|
||
- [测试环境运行](#测试环境运行)
|
||
- [后端服务](#后端服务)
|
||
- [前端网页](#前端网页)
|
||
- [打包](#打包)
|
||
- [使用 Docker](#使用-docker)
|
||
- [Docker 参数示例](#docker-参数示例)
|
||
- [Docker build \& Run](#docker-build--run)
|
||
- [Docker compose](#docker-compose)
|
||
- [使用 Railway 部署](#使用-railway-部署)
|
||
- [Railway 环境变量](#railway-环境变量)
|
||
- [手动打包](#手动打包)
|
||
- [后端服务](#后端服务-1)
|
||
- [前端网页](#前端网页-1)
|
||
- [常见问题](#常见问题)
|
||
- [参与贡献](#参与贡献)
|
||
- [赞助](#赞助)
|
||
- [License](#license)
|
||
## 介绍
|
||
|
||
支持双模型，提供了两种非官方 `ChatGPT API` 方法
|
||
|
||
| 方式 | 免费？ | 可靠性 | 质量 |
|
||
| --------------------------------------------- | ------ | ---------- | ---- |
|
||
| `ChatGPTAPI(gpt-3.5-turbo-0301)` | 否 | 可靠 | 相对较笨 |
|
||
| `ChatGPTUnofficialProxyAPI(网页 accessToken)` | 是 | 相对不可靠 | 聪明 |
|
||
|
||
对比：
|
||
1. `ChatGPTAPI` 使用 `gpt-3.5-turbo-0301` 通过官方`OpenAI`补全`API`模拟`ChatGPT`（最稳健的方法，但它不是免费的，并且没有使用针对聊天进行微调的模型）
|
||
2. `ChatGPTUnofficialProxyAPI` 使用非官方代理服务器访问 `ChatGPT` 的后端`API`，绕过`Cloudflare`（使用真实的的`ChatGPT`，非常轻量级，但依赖于第三方服务器，并且有速率限制）
|
||
|
||
[查看详情](https://github.com/Chanzhaoyu/chatgpt-web/issues/138)
|
||
|
||
切换方式：
|
||
1. 进入 `service/.env.example` 文件，复制内容到 `service/.env` 文件
|
||
2. 使用 `OpenAI API Key` 请填写 `OPENAI_API_KEY` 字段 [(获取 apiKey)](https://platform.openai.com/overview)
|
||
3. 使用 `Web API` 请填写 `OPENAI_ACCESS_TOKEN` 字段 [(获取 accessToken)](https://chat.openai.com/api/auth/session)
|
||
4. 同时存在时以 `OpenAI API Key` 优先
|
||
|
||
反向代理：
|
||
|
||
`ChatGPTUnofficialProxyAPI`时可用，[详情](https://github.com/transitive-bullshit/chatgpt-api#reverse-proxy)
|
||
|
||
```shell
|
||
# service/.env
|
||
API_REVERSE_PROXY=
|
||
```
|
||
|
||
环境变量：
|
||
|
||
全部参数变量请查看或[这里](#docker-参数示例)
|
||
|
||
```
|
||
/service/.env
|
||
```
|
||
|
||
## 待实现路线
|
||
[✓] 双模型
|
||
|
||
[✓] 多会话储存和上下文逻辑
|
||
|
||
[✓] 对代码等消息类型的格式化美化处理
|
||
|
||
[✓] 访问权限控制
|
||
|
||
[✓] 数据导入、导出
|
||
|
||
[✓] 保存消息到本地图片
|
||
|
||
[✓] 界面多语言
|
||
|
||
[✓] 界面主题
|
||
|
||
[✗] More...
|
||
|
||
## 前置要求
|
||
|
||
### Node
|
||
|
||
`node` 需要 `^16 || ^18` 版本（`node >= 14` 需要安装 [fetch polyfill](https://github.com/developit/unfetch#usage-as-a-polyfill)），使用 [nvm](https://github.com/nvm-sh/nvm) 可管理本地多个 `node` 版本
|
||
|
||
```shell
|
||
node -v
|
||
```
|
||
|
||
### PNPM
|
||
如果你没有安装过 `pnpm`
|
||
```shell
|
||
npm install pnpm -g
|
||
```
|
||
|
||
### 填写密钥
|
||
获取 `Openai Api Key` 或 `accessToken` 并填写本地环境变量 [跳转](#介绍)
|
||
|
||
```
|
||
# service/.env 文件
|
||
|
||
# OpenAI API Key - https://platform.openai.com/overview
|
||
OPENAI_API_KEY=
|
||
|
||
# change this to an `accessToken` extracted from the ChatGPT site's `https://chat.openai.com/api/auth/session` response
|
||
OPENAI_ACCESS_TOKEN=
|
||
```
|
||
|
||
## 安装依赖
|
||
|
||
> 为了简便 `后端开发人员` 的了解负担，所以并没有采用前端 `workspace` 模式，而是分文件夹存放。如果只需要前端页面做二次开发，删除 `service` 文件夹即可。
|
||
|
||
### 后端
|
||
|
||
进入文件夹 `/service` 运行以下命令
|
||
|
||
```shell
|
||
pnpm install
|
||
```
|
||
|
||
### 前端
|
||
根目录下运行以下命令
|
||
```shell
|
||
pnpm bootstrap
|
||
```
|
||
|
||
## 测试环境运行
|
||
### 后端服务
|
||
|
||
进入文件夹 `/service` 运行以下命令
|
||
|
||
```shell
|
||
pnpm start
|
||
```
|
||
|
||
### 前端网页
|
||
根目录下运行以下命令
|
||
```shell
|
||
pnpm dev
|
||
```
|
||
|
||
## 打包
|
||
|
||
### 使用 Docker
|
||
|
||
#### Docker 参数示例
|
||
|
||
- `OPENAI_API_KEY` 二选一
|
||
- `OPENAI_ACCESS_TOKEN` 二选一，同时存在时，`OPENAI_API_KEY` 优先
|
||
- `OPENAI_API_BASE_URL` 可选，设置 `OPENAI_API_KEY` 时可用
|
||
- `OPENAI_API_MODEL` 可选，设置 `OPENAI_API_KEY` 时可用
|
||
- `API_REVERSE_PROXY` 可选，设置 `OPENAI_ACCESS_TOKEN` 时可用 [参考](#介绍)
|
||
- `AUTH_SECRET_KEY` 访问权限密钥，可选
|
||
- `TIMEOUT_MS` 超时，单位毫秒，可选
|
||
- `SOCKS_PROXY_HOST` 可选，和 SOCKS_PROXY_PORT 一起时生效
|
||
- `SOCKS_PROXY_PORT` 可选，和 SOCKS_PROXY_HOST 一起时生效
|
||
|
||
|
||
|
||
#### Docker build & Run
|
||
|
||
```bash
|
||
docker build -t chatgpt-web .
|
||
|
||
# 前台运行
|
||
docker run --name chatgpt-web --rm -it -p 3002:3002 --env OPENAI_API_KEY=your_api_key chatgpt-web
|
||
|
||
# 后台运行
|
||
docker run --name chatgpt-web -d -p 3002:3002 --env OPENAI_API_KEY=your_api_key chatgpt-web
|
||
|
||
# 运行地址
|
||
http://localhost:3002/
|
||
```
|
||
|
||
#### Docker compose
|
||
|
||
[Hub 地址](https://hub.docker.com/repository/docker/chenzhaoyu94/chatgpt-web/general)
|
||
|
||
```yml
|
||
version: '3'
|
||
|
||
services:
|
||
app:
|
||
image: chenzhaoyu94/chatgpt-web # 总是使用 latest ,更新时重新 pull 该 tag 镜像即可
|
||
ports:
|
||
- 3002:3002
|
||
environment:
|
||
# 二选一
|
||
OPENAI_API_KEY: xxxxxx
|
||
# 二选一
|
||
OPENAI_ACCESS_TOKEN: xxxxxx
|
||
# API接口地址，可选，设置 OPENAI_API_KEY 时可用
|
||
OPENAI_API_BASE_URL: xxxx
|
||
# API模型，可选，设置 OPENAI_API_KEY 时可用
|
||
OPENAI_API_MODEL: xxxx
|
||
# 反向代理，可选
|
||
API_REVERSE_PROXY: xxx
|
||
# 访问权限密钥，可选
|
||
AUTH_SECRET_KEY: xxx
|
||
# 超时，单位毫秒，可选
|
||
TIMEOUT_MS: 60000
|
||
# Socks代理，可选，和 SOCKS_PROXY_PORT 一起时生效
|
||
SOCKS_PROXY_HOST: xxxx
|
||
# Socks代理端口，可选，和 SOCKS_PROXY_HOST 一起时生效
|
||
SOCKS_PROXY_PORT: xxxx
|
||
```
|
||
- `OPENAI_API_BASE_URL` 可选，设置 `OPENAI_API_KEY` 时可用
|
||
- `OPENAI_API_MODEL` 可选，设置 `OPENAI_API_KEY` 时可用
|
||
### 使用 Railway 部署
|
||
|
||
[](https://railway.app/new/template/yytmgc)
|
||
|
||
#### Railway 环境变量
|
||
|
||
| 环境变量名称 | 必填 | 备注 |
|
||
| --------------------- | ---------------------- | -------------------------------------------------------------------------------------------------- |
|
||
| `PORT` | 必填 | 默认 `3002`
|
||
| `AUTH_SECRET_KEY` | 可选 | 访问权限密钥 |
|
||
| `TIMEOUT_MS` | 可选 | 超时时间，单位毫秒 |
|
||
| `OPENAI_API_KEY` | `OpenAI API` 二选一 | 使用 `OpenAI API` 所需的 `apiKey` [(获取 apiKey)](https://platform.openai.com/overview) |
|
||
| `OPENAI_ACCESS_TOKEN` | `Web API` 二选一 | 使用 `Web API` 所需的 `accessToken` [(获取 accessToken)](https://chat.openai.com/api/auth/session) |
|
||
| `OPENAI_API_BASE_URL` | 可选，`OpenAI API` 时可用 | `API`接口地址 |
|
||
| `OPENAI_API_MODEL` | 可选，`OpenAI API` 时可用 | `API`模型 |
|
||
| `API_REVERSE_PROXY` | 可选，`Web API` 时可用 | `Web API` 反向代理地址 [详情](https://github.com/transitive-bullshit/chatgpt-api#reverse-proxy) |
|
||
| `SOCKS_PROXY_HOST` | 可选，和 `SOCKS_PROXY_PORT` 一起时生效 | Socks代理 |
|
||
| `SOCKS_PROXY_PORT` | 可选，和 `SOCKS_PROXY_HOST` 一起时生效 | Socks代理端口 |
|
||
|
||
> 注意: `Railway` 修改环境变量会重新 `Deploy`
|
||
|
||
### 手动打包
|
||
#### 后端服务
|
||
> 如果你不需要本项目的 `node` 接口，可以省略如下操作
|
||
|
||
复制 `service` 文件夹到你有 `node` 服务环境的服务器上。
|
||
|
||
```shell
|
||
# 安装
|
||
pnpm install
|
||
|
||
# 打包
|
||
pnpm build
|
||
|
||
# 运行
|
||
pnpm prod
|
||
```
|
||
|
||
PS: 不进行打包，直接在服务器上运行 `pnpm start` 也可
|
||
|
||
#### 前端网页
|
||
|
||
1、修改根目录下 `.env` 文件中的 `VITE_APP_API_BASE_URL` 为你的实际后端接口地址
|
||
|
||
2、根目录下运行以下命令，然后将 `dist` 文件夹内的文件复制到你网站服务的根目录下
|
||
|
||
[参考信息](https://cn.vitejs.dev/guide/static-deploy.html#building-the-app)
|
||
|
||
```shell
|
||
pnpm build
|
||
```
|
||
|
||
## 常见问题
|
||
Q: 为什么 `Git` 提交总是报错？
|
||
|
||
A: 因为有提交信息验证，请遵循 [Commit 指南](./CONTRIBUTING.md)
|
||
|
||
Q: 如果只使用前端页面，在哪里改请求接口？
|
||
|
||
A: 根目录下 `.env` 文件中的 `VITE_GLOB_API_URL` 字段。
|
||
|
||
Q: 文件保存时全部爆红?
|
||
|
||
A: `vscode` 请安装项目推荐插件，或手动安装 `Eslint` 插件。
|
||
|
||
Q: 前端没有打字机效果？
|
||
|
||
A: 一种可能原因是经过 Nginx 反向代理，开启了 buffer，则 Nginx 会尝试从后端缓冲一定大小的数据再发送给浏览器。请尝试在反代参数后添加 `proxy_buffering off;`，然后重载 Nginx。其他 web server 配置同理。
|
||
|
||
## 参与贡献
|
||
|
||
贡献之前请先阅读 [贡献指南](./CONTRIBUTING.md)
|
||
|
||
感谢所有做过贡献的人!
|
||
|
||
<a href="https://github.com/Chanzhaoyu/chatgpt-web/graphs/contributors">
|
||
<img src="https://contrib.rocks/image?repo=Chanzhaoyu/chatgpt-web" />
|
||
</a>
|
||
|
||
## 赞助
|
||
|
||
如果你觉得这个项目对你有帮助，并且情况允许的话，可以给我一点点支持，总之非常感谢支持～
|
||
|
||
<div style="display: flex; gap: 20px;">
|
||
<div style="text-align: center">
|
||
<img style="max-width: 100%" src="./docs/wechat.png" alt="微信" />
|
||
<p>WeChat Pay</p>
|
||
</div>
|
||
<div style="text-align: center">
|
||
<img style="max-width: 100%" src="./docs/alipay.png" alt="支付宝" />
|
||
<p>Alipay</p>
|
||
</div>
|
||
</div>
|
||
|
||
## License
|
||
MIT © [ChenZhaoYu](./license)
|