Skip to content

Commit daa52b8

Browse files
author
Kerwin
committed
chore: 更新readme
1 parent 829b9e6 commit daa52b8

File tree

6 files changed

+101
-38
lines changed

6 files changed

+101
-38
lines changed

‎README.en.md

Lines changed: 45 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -196,16 +196,18 @@ http://localhost:3002/
196196

197197
#### Docker Compose
198198

199-
[Hub Address](https://hub.docker.com/repository/docker/chenzhaoyu94/chatgpt-web/general)
199+
[Hub Address](https://hub.docker.com/repository/docker/kerwin1202/chatgpt-web/general)
200200

201201
```yml
202202
version: '3'
203203

204204
services:
205205
app:
206-
image: chenzhaoyu94/chatgpt-web # always use latest, pull the tag image again when updating
206+
image: kerwin1202/chatgpt-web # always use latest, pull the tag image again when updating
207207
ports:
208208
- 3002:3002
209+
depends_on:
210+
- database
209211
environment:
210212
# one of two
211213
OPENAI_API_KEY: xxxxxx
@@ -217,8 +219,6 @@ services:
217219
OPENAI_API_MODEL: xxxx
218220
# reverse proxy, optional
219221
API_REVERSE_PROXY: xxx
220-
# access password，optional
221-
AUTH_SECRET_KEY: xxx
222222
# timeout, in milliseconds, optional
223223
TIMEOUT_MS: 60000
224224
# socks proxy, optional, effective with SOCKS_PROXY_PORT
@@ -227,6 +227,45 @@ services:
227227
SOCKS_PROXY_PORT: xxxx
228228
# HTTPS Proxy，optional, support http, https, socks5
229229
HTTPS_PROXY: http://xxx:7890
230+
# access salt，optional Allow login if not empty.
231+
AUTH_SECRET_KEY: xxx
232+
# mongodb's connection string
233+
MONGODB_URL: 'mongodb://chatgpt:xxxx@database:27017'
234+
# Register enabled
235+
REGISTER_ENABLED: true
236+
# After register enabled, Allowed mailbox suffixes for website registration. If empty, any suffix is allowed
237+
REGISTER_MAILS: '@qq.com,@sina.com,@163.com'
238+
# After register enabled, Salt for password encryption
239+
PASSWORD_MD5_SALT: xxx
240+
# After register enabled, super administrator
241+
ROOT_USER: me@example.com
242+
# After register enabled, The website's domain ending without /
243+
SITE_DOMAIN: http://127.0.0.1:3002
244+
# After register enabled, The smtp settings
245+
SMTP_HOST: smtp.exmail.qq.com
246+
SMTP_PORT: 465
247+
SMTP_TSL: true
248+
SMTP_USERNAME: noreply@examile.com
249+
SMTP_PASSWORD: xxx
250+
links:
251+
- database
252+
253+
database:
254+
image: mongo
255+
container_name: chatgptweb-database
256+
ports:
257+
- '27017:27017'
258+
expose:
259+
- '27017'
260+
volumes:
261+
- mongodb:/data/db
262+
environment:
263+
MONGO_INITDB_ROOT_USERNAME: chatgpt
264+
MONGO_INITDB_ROOT_PASSWORD: xxxx
265+
MONGO_INITDB_DATABASE: chatgpt
266+
267+
volumes:
268+
mongodb: {}
230269
```
231270
The `OPENAI_API_BASE_URL` is optional and only used when setting the `OPENAI_API_KEY`.
232271
The `OPENAI_API_MODEL` is optional and only used when setting the `OPENAI_API_KEY`.
@@ -316,18 +355,7 @@ Thanks to all the contributors!
316355

317356
## Sponsorship
318357

319-
If you find this project helpful and circumstances permit, you can give me a little support. Thank you very much for your support~
320-
321-
<div style="display: flex; gap: 20px;">
322-
<div style="text-align: center">
323-
<img style="max-width: 100%" src="./docs/wechat.png" alt="WeChat" />
324-
<p>WeChat Pay</p>
325-
</div>
326-
<div style="text-align: center">
327-
<img style="max-width: 100%" src="./docs/alipay.png" alt="Alipay" />
328-
<p>Alipay</p>
329-
</div>
330-
</div>
358+
If you find this project helpful, please give me a star.
331359

332360
## License
333-
MIT © [ChenZhaoYu](./license)
361+
MIT © [Kerwin1202](./license)

‎README.md

Lines changed: 46 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -201,16 +201,19 @@ http://localhost:3002/
201201

202202
#### Docker compose
203203

204-
[Hub 地址](https://hub.docker.com/repository/docker/chenzhaoyu94/chatgpt-web/general)
204+
[Hub 地址](https://hub.docker.com/repository/docker/kerwin1202/chatgpt-web/general)
205205

206206
```yml
207207
version: '3'
208208

209209
services:
210210
app:
211-
image: chenzhaoyu94/chatgpt-web # 总是使用 latest ,更新时重新 pull 该 tag 镜像即可
211+
image: kerwin1202/chatgpt-web # 总是使用latest,更新时重新pull该tag镜像即可
212+
container_name: chatgptweb
212213
ports:
213214
- 3002:3002
215+
depends_on:
216+
- database
214217
environment:
215218
# 二选一
216219
OPENAI_API_KEY: sk-xxx
@@ -222,8 +225,6 @@ services:
222225
OPENAI_API_MODEL: xxx
223226
# 反向代理，可选
224227
API_REVERSE_PROXY: xxx
225-
# 访问权限密钥，可选
226-
AUTH_SECRET_KEY: xxx
227228
# 超时，单位毫秒，可选
228229
TIMEOUT_MS: 60000
229230
# Socks代理，可选，和 SOCKS_PROXY_PORT 一起时生效
@@ -232,6 +233,45 @@ services:
232233
SOCKS_PROXY_PORT: xxx
233234
# HTTPS 代理，可选，支持 http，https，socks5
234235
HTTPS_PROXY: http://xxx:7890
236+
# 访问jwt加密参数，可选 不为空则允许登录 同时需要设置 MONGODB_URL
237+
AUTH_SECRET_KEY: xxx
238+
# mongodb 的连接字符串
239+
MONGODB_URL: 'mongodb://chatgpt:xxxx@database:27017'
240+
# 网站是否开启注册
241+
REGISTER_ENABLED: true
242+
# 开启注册之后 网站注册允许的邮箱后缀 如果空 则允许任意后缀
243+
REGISTER_MAILS: '@qq.com,@sina.com,@163.com'
244+
# 开启注册之后 密码加密的盐
245+
PASSWORD_MD5_SALT: xxx
246+
# 开启注册之后 超级管理邮箱
247+
ROOT_USER: me@example.com
248+
# 开启注册之后 网站域名 不含 / 注册的时候发送验证邮箱使用
249+
SITE_DOMAIN: http://127.0.0.1:3002
250+
# 开启注册之后 发送验证邮箱配置
251+
SMTP_HOST: smtp.exmail.qq.com
252+
SMTP_PORT: 465
253+
SMTP_TSL: true
254+
SMTP_USERNAME: noreply@examile.com
255+
SMTP_PASSWORD: xxx
256+
links:
257+
- database
258+
259+
database:
260+
image: mongo
261+
container_name: chatgptweb-database
262+
ports:
263+
- '27017:27017'
264+
expose:
265+
- '27017'
266+
volumes:
267+
- mongodb:/data/db
268+
environment:
269+
MONGO_INITDB_ROOT_USERNAME: chatgpt
270+
MONGO_INITDB_ROOT_PASSWORD: xxxx
271+
MONGO_INITDB_DATABASE: chatgpt
272+
273+
volumes:
274+
mongodb: {}
235275
```
236276
- `OPENAI_API_BASE_URL` 可选，设置 `OPENAI_API_KEY` 时可用
237277
- `OPENAI_API_MODEL` 可选，设置 `OPENAI_API_KEY` 时可用
@@ -317,19 +357,7 @@ A: 一种可能原因是经过 Nginx 反向代理，开启了 buffer，则 Nginx
317357
</a>
318358

319359
## 赞助
320-
321-
如果你觉得这个项目对你有帮助，并且情况允许的话，可以给我一点点支持，总之非常感谢支持～
322-
323-
<div style="display: flex; gap: 20px;">
324-
<div style="text-align: center">
325-
<img style="max-width: 100%" src="./docs/wechat.png" alt="微信" />
326-
<p>WeChat Pay</p>
327-
</div>
328-
<div style="text-align: center">
329-
<img style="max-width: 100%" src="./docs/alipay.png" alt="支付宝" />
330-
<p>Alipay</p>
331-
</div>
332-
</div>
360+
如果你觉得这个项目对你有帮助，请给我点个Star。
333361

334362
## License
335-
MIT © [ChenZhaoYu](./license)
363+
MIT © [Kerwin1202](./license)

‎docs/alipay.png

-61.1 KB
Binary file not shown.

‎docs/wechat.png

-79.6 KB
Binary file not shown.

‎license

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
MIT License
1+
MIT Kerwin1202
22

33
Copyright (c) 2023 ChenZhaoYu
44

‎src/components/common/Setting/About.vue

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,20 @@ onMounted(() => {
4747
<div class="p-2 space-y-2 rounded-md bg-neutral-100 dark:bg-neutral-700">
4848
<p>
4949
此项目开源于
50+
<a
51+
class="text-blue-600 dark:text-blue-500"
52+
href="https://github.com/kerwin1202/chatgpt-web"
53+
target="_blank"
54+
>
55+
kerwin1202/chatgpt-web
56+
</a>是基于
5057
<a
5158
class="text-blue-600 dark:text-blue-500"
5259
href="https://github.com/Chanzhaoyu/chatgpt-web"
5360
target="_blank"
5461
>
55-
Github
56-
</a>
62+
Chanzhaoyu/chatgpt-web
63+
</a> 分支而来
5764
，免费且基于 MIT 协议，没有任何形式的付费行为！
5865
</p>
5966
<p>

0 commit comments

Comments
 (0)