Skip to content

Commit 41ddc6a

Browse files
committed
chore: docs change
1 parent 0481726 commit 41ddc6a

File tree

1 file changed

+29
-28
lines changed

1 file changed

+29
-28
lines changed

README.md

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
- [测试环境运行](#测试环境运行)
2525
- [后端服务](#后端服务)
2626
- [前端网页](#前端网页)
27+
- [环境变量](#环境变量)
2728
- [打包](#打包)
2829
- [使用 Docker](#使用-docker)
2930
- [Docker 参数示例](#docker-参数示例)
@@ -52,31 +53,21 @@
5253
2. `ChatGPTUnofficialProxyAPI` 使用非官方代理服务器访问 `ChatGPT` 的后端`API`,绕过`Cloudflare`(使用真实的的`ChatGPT`,非常轻量级,但依赖于第三方服务器,并且有速率限制)
5354

5455
警告:
55-
1. 你应该使用 `API` 方式并自建代理使你使用的风险降到最低。
56-
2. 使用 `accessToken` 方式时反向代理将向第三方暴露您的访问令牌。这样做应该不会产生任何不良影响,但在使用这种方法之前请考虑风险,修改代理地址时也请使用公开的[社区方案](https://github.com/transitive-bullshit/chatgpt-api#reverse-proxy),不要不要不要使用来源不明的地址!
57-
2. 因为国内 `API` 被墙,如果服务器不在国外,则需要代理才能请求到官方接口,也非常不建议使用别人发出来的代理地址,请自己搭建。
58-
3. 人性是丑陋的,你永远不知道你相信的某些乐于分享的`好人`在用你的账号做什么!!!
59-
60-
注:强烈建议使用`ChatGPTAPI`,因为它使用 `OpenAI` 官方支持的`API`。并且可能会在将来的版本中删除对`ChatGPTUnofficialProxyAPI`的支持。
56+
1. 你应该首先使用 `API` 方式
57+
2. 使用 `API` 时,如果网络不通,那是国内被墙了,你需要自建代理,绝对不要使用别人的公开代理,那是危险的。
58+
3. 使用 `accessToken` 方式时反向代理将向第三方暴露您的访问令牌,这样做应该不会产生任何不良影响,但在使用这种方法之前请考虑风险。
59+
4. 使用 `accessToken` 时,不管你是国内还是国外的机器,都会使用代理。默认代理为 [acheong08](https://github.com/acheong08) 大佬的 `https://bypass.duti.tech/api/conversation`,这不是后门也不是监听,除非你有能力自己翻过 `CF` 验证,用前请知悉。[社区代理](https://github.com/transitive-bullshit/chatgpt-api#reverse-proxy)(注意:只有这两个是推荐,其他第三方来源,请自行甄别)
60+
5. 把项目发布到公共网络时,你应该设置 `AUTH_SECRET_KEY` 变量添加你的密码访问权限,你也应该修改 `index.html` 中的 `title`,防止被关键词搜索到。
6161

6262
切换方式:
6363
1. 进入 `service/.env.example` 文件,复制内容到 `service/.env` 文件
6464
2. 使用 `OpenAI API Key` 请填写 `OPENAI_API_KEY` 字段 [(获取 apiKey)](https://platform.openai.com/overview)
6565
3. 使用 `Web API` 请填写 `OPENAI_ACCESS_TOKEN` 字段 [(获取 accessToken)](https://chat.openai.com/api/auth/session)
6666
4. 同时存在时以 `OpenAI API Key` 优先
6767

68-
反向代理:
69-
70-
`ChatGPTUnofficialProxyAPI`时可用,[详情](https://github.com/transitive-bullshit/chatgpt-api#reverse-proxy)
71-
72-
```shell
73-
# service/.env
74-
API_REVERSE_PROXY=
75-
```
76-
7768
环境变量:
7869

79-
全部参数变量请查看或[这里](#docker-参数示例)
70+
全部参数变量请查看或[这里](#环境变量)
8071

8172
```
8273
/service/.env
@@ -163,23 +154,33 @@ pnpm start
163154
pnpm dev
164155
```
165156

166-
## 打包
157+
## 环境变量
167158

168-
### 使用 Docker
159+
`API` 可用:
169160

170-
#### Docker 参数示例
161+
- `OPENAI_API_KEY``OPENAI_ACCESS_TOKEN` 二选一
162+
- `OPENAI_API_MODEL` 设置模型,可选,默认:`gpt-3.5-turbo`
163+
- `OPENAI_API_BASE_URL` 设置接口地址,可选,默认:`https://api.openai.com`
164+
165+
`ACCESS_TOKEN` 可用:
166+
167+
- `OPENAI_ACCESS_TOKEN``OPENAI_API_KEY` 二选一,同时存在时,`OPENAI_API_KEY` 优先
168+
- `API_REVERSE_PROXY` 设置反向代理,可选,默认:`https://bypass.duti.tech/api/conversation`[社区](https://github.com/transitive-bullshit/chatgpt-api#reverse-proxy)(注意:只有这两个是推荐,其他第三方来源,请自行甄别)
169+
170+
通用:
171171

172-
- `OPENAI_API_KEY` 二选一
173-
- `OPENAI_ACCESS_TOKEN` 二选一,同时存在时,`OPENAI_API_KEY` 优先
174-
- `OPENAI_API_BASE_URL` 可选,设置 `OPENAI_API_KEY` 时可用
175-
- `OPENAI_API_MODEL` 可选,设置 `OPENAI_API_KEY` 时可用
176-
- `API_REVERSE_PROXY` 可选,设置 `OPENAI_ACCESS_TOKEN` 时可用 [参考](#介绍)
177172
- `AUTH_SECRET_KEY` 访问权限密钥,可选
178173
- `TIMEOUT_MS` 超时,单位毫秒,可选
179-
- `SOCKS_PROXY_HOST` 可选,和 SOCKS_PROXY_PORT 一起时生效
180-
- `SOCKS_PROXY_PORT` 可选,和 SOCKS_PROXY_HOST 一起时生效
181-
- `HTTPS_PROXY` 可选,支持 http,https, socks5
182-
- `ALL_PROXY` 可选,支持 http,https, socks5
174+
- `SOCKS_PROXY_HOST``SOCKS_PROXY_PORT` 一起时生效,可选
175+
- `SOCKS_PROXY_PORT``SOCKS_PROXY_HOST` 一起时生效,可选
176+
- `HTTPS_PROXY` 支持 `http``https`, `socks5`,可选
177+
- `ALL_PROXY` 支持 `http``https`, `socks5`,可选
178+
179+
## 打包
180+
181+
### 使用 Docker
182+
183+
#### Docker 参数示例
183184

184185
![docker](./docs/docker.png)
185186

0 commit comments

Comments
 (0)