chore: 更新readme

chatgpt-web-dev · Mar 18, 2023 · daa52b8 · daa52b8
1 parent 829b9e6
commit daa52b8
Show file tree

Hide file tree

Showing 6 changed files with 101 additions and 38 deletions.
diff --git a/README.en.md b/README.en.md
@@ -196,16 +196,18 @@ http://localhost:3002/
 
 #### Docker Compose
 
-[Hub Address](https://hub.docker.com/repository/docker/chenzhaoyu94/chatgpt-web/general)
+[Hub Address](https://hub.docker.com/repository/docker/kerwin1202/chatgpt-web/general)
 
 ```yml
 version: '3'
 
 services:
   app:
-    image: chenzhaoyu94/chatgpt-web # always use latest, pull the tag image again when updating
+    image: kerwin1202/chatgpt-web # always use latest, pull the tag image again when updating
     ports:
       - 3002:3002
+    depends_on:
+      - database
     environment:
       # one of two
       OPENAI_API_KEY: xxxxxx
@@ -217,8 +219,6 @@ services:
       OPENAI_API_MODEL: xxxx
       # reverse proxy, optional
       API_REVERSE_PROXY: xxx
-      # access password，optional
-      AUTH_SECRET_KEY: xxx
       # timeout, in milliseconds, optional
       TIMEOUT_MS: 60000
       # socks proxy, optional, effective with SOCKS_PROXY_PORT
@@ -227,6 +227,45 @@ services:
       SOCKS_PROXY_PORT: xxxx
       # HTTPS Proxy，optional, support http, https, socks5
       HTTPS_PROXY: http://xxx:7890
+      # access salt，optional Allow login if not empty.
+      AUTH_SECRET_KEY: xxx
+      # mongodb's connection string
+      MONGODB_URL: 'mongodb://chatgpt:xxxx@database:27017'
+      # Register enabled
+      REGISTER_ENABLED: true
+      # After register enabled, Allowed mailbox suffixes for website registration. If empty, any suffix is allowed
+      REGISTER_MAILS: '@qq.com,@sina.com,@163.com'
+      # After register enabled, Salt for password encryption
+      PASSWORD_MD5_SALT: xxx
+      # After register enabled, super administrator
+      ROOT_USER: [email protected]
+      # After register enabled, The website's domain ending without /
+      SITE_DOMAIN: http://127.0.0.1:3002
+      # After register enabled, The smtp settings
+      SMTP_HOST: smtp.exmail.qq.com
+      SMTP_PORT: 465
+      SMTP_TSL: true
+      SMTP_USERNAME: [email protected]
+      SMTP_PASSWORD: xxx
+    links:
+      - database
+
+  database:
+    image: mongo
+    container_name: chatgptweb-database
+    ports:
+      - '27017:27017'
+    expose:
+      - '27017'
+    volumes:
+      - mongodb:/data/db
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: chatgpt
+      MONGO_INITDB_ROOT_PASSWORD: xxxx
+      MONGO_INITDB_DATABASE: chatgpt
+
+volumes:
+  mongodb: {}
 ```
 The `OPENAI_API_BASE_URL` is optional and only used when setting the `OPENAI_API_KEY`.
 The `OPENAI_API_MODEL` is optional and only used when setting the `OPENAI_API_KEY`.
@@ -316,18 +355,7 @@ Thanks to all the contributors!
 
 ## Sponsorship
 
-If you find this project helpful and circumstances permit, you can give me a little support. Thank you very much for your support~
-
-<div style="display: flex; gap: 20px;">
-	<div style="text-align: center">
-		<img style="max-width: 100%" src="./docs/wechat.png" alt="WeChat" />
-		<p>WeChat Pay</p>
-	</div>
-	<div style="text-align: center">
-		<img style="max-width: 100%" src="./docs/alipay.png" alt="Alipay" />
-		<p>Alipay</p>
-	</div>
-</div>
+If you find this project helpful, please give me a star.
 
 ## License
-MIT © [ChenZhaoYu](./license)
+MIT © [Kerwin1202](./license)
diff --git a/README.md b/README.md
@@ -201,16 +201,19 @@ http://localhost:3002/
 
 #### Docker compose
 
-[Hub 地址](https://hub.docker.com/repository/docker/chenzhaoyu94/chatgpt-web/general)
+[Hub 地址](https://hub.docker.com/repository/docker/kerwin1202/chatgpt-web/general)
 
 ```yml
 version: '3'
 
 services:
   app:
-    image: chenzhaoyu94/chatgpt-web # 总是使用 latest ,更新时重新 pull 该 tag 镜像即可
+    image: kerwin1202/chatgpt-web # 总是使用latest,更新时重新pull该tag镜像即可
+    container_name: chatgptweb
     ports:
       - 3002:3002
+    depends_on:
+      - database
     environment:
       # 二选一
       OPENAI_API_KEY: sk-xxx
@@ -222,8 +225,6 @@ services:
       OPENAI_API_MODEL: xxx
       # 反向代理，可选
       API_REVERSE_PROXY: xxx
-      # 访问权限密钥，可选
-      AUTH_SECRET_KEY: xxx
       # 超时，单位毫秒，可选
       TIMEOUT_MS: 60000
       # Socks代理，可选，和 SOCKS_PROXY_PORT 一起时生效
@@ -232,6 +233,45 @@ services:
       SOCKS_PROXY_PORT: xxx
       # HTTPS 代理，可选，支持 http，https，socks5
       HTTPS_PROXY: http://xxx:7890
+      # 访问jwt加密参数，可选 不为空则允许登录 同时需要设置 MONGODB_URL
+      AUTH_SECRET_KEY: xxx
+      # mongodb 的连接字符串
+      MONGODB_URL: 'mongodb://chatgpt:xxxx@database:27017'
+      # 网站是否开启注册
+      REGISTER_ENABLED: true
+      # 开启注册之后 网站注册允许的邮箱后缀 如果空 则允许任意后缀
+      REGISTER_MAILS: '@qq.com,@sina.com,@163.com'
+      # 开启注册之后 密码加密的盐
+      PASSWORD_MD5_SALT: xxx
+      # 开启注册之后 超级管理邮箱
+      ROOT_USER: [email protected]
+      # 开启注册之后 网站域名 不含 / 注册的时候发送验证邮箱使用
+      SITE_DOMAIN: http://127.0.0.1:3002
+      # 开启注册之后 发送验证邮箱配置
+      SMTP_HOST: smtp.exmail.qq.com
+      SMTP_PORT: 465
+      SMTP_TSL: true
+      SMTP_USERNAME: [email protected]
+      SMTP_PASSWORD: xxx
+    links:
+      - database
+
+  database:
+    image: mongo
+    container_name: chatgptweb-database
+    ports:
+      - '27017:27017'
+    expose:
+      - '27017'
+    volumes:
+      - mongodb:/data/db
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: chatgpt
+      MONGO_INITDB_ROOT_PASSWORD: xxxx
+      MONGO_INITDB_DATABASE: chatgpt
+
+volumes:
+  mongodb: {}
 ```
 - `OPENAI_API_BASE_URL`  可选，设置 `OPENAI_API_KEY` 时可用
 - `OPENAI_API_MODEL`  可选，设置 `OPENAI_API_KEY` 时可用
@@ -317,19 +357,7 @@ A: 一种可能原因是经过 Nginx 反向代理，开启了 buffer，则 Nginx
 </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>
+如果你觉得这个项目对你有帮助，请给我点个Star。
 
 ## License
-MIT © [ChenZhaoYu](./license)
+MIT © [Kerwin1202](./license)
diff --git a/docs/alipay.png b/docs/alipay.png
diff --git a/docs/wechat.png b/docs/wechat.png
diff --git a/license b/license
@@ -1,4 +1,4 @@
-MIT License
+MIT Kerwin1202
 
 Copyright (c) 2023 ChenZhaoYu
 

diff --git a/src/components/common/Setting/About.vue b/src/components/common/Setting/About.vue
@@ -47,13 +47,20 @@ onMounted(() => {
       <div class="p-2 space-y-2 rounded-md bg-neutral-100 dark:bg-neutral-700">
         <p>
           此项目开源于
+          <a
+            class="text-blue-600 dark:text-blue-500"
+            href="https://github.com/kerwin1202/chatgpt-web"
+            target="_blank"
+          >
+            kerwin1202/chatgpt-web
+          </a>是基于
           <a
             class="text-blue-600 dark:text-blue-500"
             href="https://github.com/Chanzhaoyu/chatgpt-web"
             target="_blank"
           >
-            Github
-          </a>
+            Chanzhaoyu/chatgpt-web
+          </a> 分支而来
           ，免费且基于 MIT 协议，没有任何形式的付费行为！
         </p>
         <p>