Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yangjian102621 committed Aug 16, 2023
1 parent fab4309 commit b84039b
Show file tree
Hide file tree
Showing 6 changed files with 44 additions and 16 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
# 更新日志

## v3.0.7

1. 聊天主界面:新增聊天引导页面,介绍产品功能
2. 功能重构:拆分项目,将函数插件以及微信机器人,MidJourney 机器人等功能拆分新项目独立部署。
3. 功能新增:新增 MidJourney AI 绘画支持,当识别到用户的绘画需求时,自动调用 MidJourney 绘画函数进行绘画。
4. 功能新增:支持导出聊天记录为 PDF 文件。
5. 功能优化:在后台 dashboard 页面新增统计今日众筹收入。
6. 功能优化:支持用户设置默认的 GPT 模型
7. Bug修复:修复若干已知的的 Bug

## v3.0.6

1. 管理后台:新增用户名和手机号码搜索功能
2. 管理后台:新增重置用户密码功能
3. 管理后台:支持关闭注册功能,新增添加用户功能,适用于内部使用场景
Expand Down
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@

![ChatGPT function plugin](docs/imgs/plugin.png)

![ChatGPT function plugin](docs/imgs/mj.jpg)

### 用户设置

![ChatGPT user profle](docs/imgs/user_profile.png)
Expand Down Expand Up @@ -138,8 +140,6 @@ Listen = "0.0.0.0:5678"
ProxyURL = ["YOUR_PROXY_URL"] # 替换成你本地代理,如:http://127.0.0.1:7777
#ProxyURL = "" 如果你的服务器本身就在墙外,那么你直接留空就好了
MysqlDns = "root:12345678@tcp(172.22.11.200:3307)/chatgpt_plus?charset=utf8&parseTime=True&loc=Local"
StartWechatBot = false # 是否启动微信机器人,默认关闭,如果设置为 TRUE 则启动服务的时候需要微信扫码登录
EnabledMsgService = false # 注册时是否开启短信验证功能,该功能需要配合短信服务一起使用

[Session]
SecretKey = "azyehq3ivunjhbntz78isj00i4hz2mt9xtddysfucxakadq4qbfrt0b7q3lnvg80"
Expand All @@ -155,7 +155,7 @@ EnabledMsgService = false # 注册时是否开启短信验证功能,该功能
Username = "admin"
Password = "admin123" # 如果是生产环境的话,这里管理员的密码记得修改

[ApiConfig] # 插件 API 服务配置,此为第三方插件服务,如需使用请联系作者开通
[ApiConfig] # 微博热搜,今日头条等函数服务 API 配置,此为第三方插件服务,如需使用请联系作者开通
ApiURL = "{URL}"
AppId = "{APP_ID}"
Token = "{TOKEN}"
Expand All @@ -166,8 +166,14 @@ EnabledMsgService = false # 注册时是否开启短信验证功能,该功能
Product = "Dysmsapi"
Domain = "dysmsapi.aliyuncs.com"

[ExtConfig] # MidJourney和微信机器人服务 API 配置,开通此功能需要配合 chatpgt-plus-exts 项目部署
ApiURL = "插件扩展 API 地址"
Token = "插件扩展 API Token" # 这个 token 随便填,只要确保跟 chatgpt-plus-exts 项目的 token 一样就行
```

> 如果要启用微信收款服务和 MidJourney
> 绘画功能,请先部署扩展服务项目 [chatgpt-plus-exts](https://github.com/yangjian102621/chatgpt-plus-exts)
修改 nginx 配置文档 `docker/conf/nginx/conf.d/chatgpt-plus.conf`,把后端转发的地址改成当前主机的内网 IP 地址。

```shell
Expand Down Expand Up @@ -284,7 +290,6 @@ make clean linux
## 参与贡献

个人的力量始终有限,任何形式的贡献都是欢迎的,包括但不限于贡献代码,优化文档,提交 issue 和 PR 等。
**尤其是新版本的开发计划比较大,包括各种语言的后端 API 实现,本人精力有限,希望借助社区的力量来完成这些 API 的开发。**

如果有兴趣的话,也可以加微信进入微信讨论群(**添加好友时请注明来自Github!!!**)。

Expand Down
6 changes: 3 additions & 3 deletions api/config.sample.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ MysqlDns = "root:mysql_pass@tcp(localhost:3306)/chatgpt_plus?charset=utf8mb4&col
StaticDir = "./static"
StaticUrl = "http://localhost:5678/static"
AesEncryptKey = "{YOUR_AES_KEY}"
StartWechatBot = false
EnabledMsgService = false

[Session]
Driver = "cookie"
Expand Down Expand Up @@ -38,4 +36,6 @@ EnabledMsgService = false
Product = "Dysmsapi"
Domain = "dysmsapi.aliyuncs.com"


[ExtConfig]
ApiURL = "插件扩展 API 地址"
Token = "插件扩展 API Token"
6 changes: 3 additions & 3 deletions docker/conf/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ MysqlDns = "root:mysql_pass@tcp(localhost:3306)/chatgpt_plus?charset=utf8mb4&col
StaticDir = "./static"
StaticUrl = "http://localhost:5678/static"
AesEncryptKey = "{YOUR_AES_KEY}"
StartWechatBot = false
EnabledMsgService = false

[Session]
Driver = "cookie"
Expand Down Expand Up @@ -38,4 +36,6 @@ EnabledMsgService = false
Product = "Dysmsapi"
Domain = "dysmsapi.aliyuncs.com"


[ExtConfig]
ApiURL = "插件扩展 API 地址"
Token = "插件扩展 API Token"
Binary file added docs/imgs/mj.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 18 additions & 6 deletions web/src/components/Welcome.vue
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<div class="item-list">
<ul>
<li v-for="item in samples"><a @click="send(item)">{{ item }}</a></li>
<li v-for="item in samples" :key="item"><a @click="send(item)">{{ item }}</a></li>
</ul>
</div>
</div>
Expand All @@ -27,7 +27,7 @@

<div class="item-list">
<ul>
<li v-for="item in plugins"><a @click="send(item.value)">{{ item.text }}</a></li>
<li v-for="item in plugins" :key="item.value"><a @click="send(item.value)">{{ item.text }}</a></li>
</ul>
</div>
</div>
Expand All @@ -41,7 +41,10 @@

<div class="item-list">
<ul>
<li v-for="item in capabilities">{{ item }}</li>
<li v-for="item in capabilities" :key="item">
<span v-if="item.value === ''">{{ item.text }}</span>
<a @click="send(item.value)" v-else>{{ item.text }}</a>
</li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -76,9 +79,18 @@ const plugins = ref([
])
const capabilities = ref([
"轻松扮演翻译专家,程序员,AI 女友,文案高手...",
"国产大语言模型支持,GLM2 模型接入中",
"Midjourney, Stable Diffusion AI 绘画支持"
{
text: "轻松扮演翻译专家,程序员,AI 女友,文案高手...",
value: ""
},
{
text: "国产大语言模型支持,GLM2 模型接入中",
value: ""
},
{
text: "绘画:马斯克开拖拉机,20世纪,中国农村。3:2",
value: "绘画:马斯克开拖拉机,20世纪,中国农村。3:2"
}
])
const emits = defineEmits(['send']);
Expand Down

0 comments on commit b84039b

Please sign in to comment.