diff --git a/src/.vuepress/dist.zip b/src/.vuepress/dist.zip new file mode 100644 index 000000000..8476f044b Binary files /dev/null and b/src/.vuepress/dist.zip differ diff --git a/src/.vuepress/navbar.ts b/src/.vuepress/navbar.ts index 7615ea2c4..d74a50d4f 100644 --- a/src/.vuepress/navbar.ts +++ b/src/.vuepress/navbar.ts @@ -2,44 +2,21 @@ import { navbar } from "vuepress-theme-hope"; export default navbar([ "/", - "/posts/", - // { - // text: "插件相关", - // icon: "lightbulb", - // prefix: "/guide/", - // children: [ - // { - // text: "插件使用", - // icon: "lightbulb", - // prefix: "bar/", - // children: [ - // { text: "简介", icon: "", link: "" }, - // { text: "安装", icon: "ellipsis", link: "" }, - // { text: "管理", icon: "ellipsis", link: "" }, - // { text: "内容函数", icon: "ellipsis", link: "" }, - // ], - // }, - // { - // text: "插件开发", - // icon: "lightbulb", - // prefix: "foo/", - // children: ["ray", { text: "...", icon: "ellipsis", link: "" }], - // }, - // ], - // }, + "/posts/deploymentTutorial/", + "/posts/functionIntroduction", { - text: "插件相关", - icon: "operate", + text: "疑难解答", + icon: "discover", children: [ { - text: "插件使用", - icon: "shell", - link: "/doc/PluginsUse", + text: "常见报错", + icon: "info", + link: "/posts/commonErrors/", }, { - text: "插件开发", - icon: "config", - link: "/doc/PluginsDevelop", + text: "问题解答", + icon: "blog", + link: "/posts/Q&A", }, ], }, diff --git a/src/.vuepress/sidebar.ts b/src/.vuepress/sidebar.ts index f14d025f5..d49316c66 100644 --- a/src/.vuepress/sidebar.ts +++ b/src/.vuepress/sidebar.ts @@ -4,17 +4,45 @@ export default sidebar({ "/": [ "", { - text: "使用方法", + text: "部署教程", icon: "blog", - prefix: "posts/", - link: "posts/", + prefix: "posts/deploymentTutorial/", + link: "posts/deploymentTutorial/", children: "structure", }, { - text: "插件相关", + text: "功能介绍", icon: "operate", - prefix: "doc/", - link: "doc/", + prefix: "posts/functionIntroduction", + link: "posts/functionIntroduction", + children: "structure", + }, + { + text: "插件使用", + icon: "plugin", + prefix: "posts/PluginsUse/", + link: "posts/PluginsUse/", + children: "structure", + }, + { + text: "常见报错", + icon: "info", + link: "posts/commonErrors/", + prefix: "posts/commonErrors/", + children: "structure", + }, + { + text: "问题解答", + icon: "blog", + link: "posts/Q&A", + prefix: "posts/Q&A", + children: "structure", + }, + { + text: "插件开发", + icon: "code", + link: "posts/PluginsDevelop", + prefix: "posts/PluginsDevelop", children: "structure", }, ], diff --git a/src/.vuepress/theme.ts b/src/.vuepress/theme.ts index 97766c6c4..a0c6f7c16 100644 --- a/src/.vuepress/theme.ts +++ b/src/.vuepress/theme.ts @@ -14,7 +14,7 @@ export default hopeTheme({ logo: "/logo.png", - repo: "https://github.com/the-lazy-me", + repo: "https://github.com/the-lazy-me/QChatGPT-Wiki", docsDir: "src", @@ -66,6 +66,7 @@ export default hopeTheme({ katex: true, mark: true, mermaid: true, + //card:true, playground: { presets: ["ts", "vue"], }, diff --git a/src/README.md b/src/README.md index 1fa6c0cc4..d60c9406c 100644 --- a/src/README.md +++ b/src/README.md @@ -11,7 +11,7 @@ heroText: QChatGPT tagline: 😎高稳定性、🧩支持插件、🌏实时联网的 ChatGPT QQ 机器人🤖 | 支持 Claude、Google Bard、gpt4free、One API 的 QQ 机器人平台 actions: - text: 🚀 快速上手 - link: ./posts/ + link: ./posts/deploymentTutorial/ type: primary - text: 查看项目 @@ -143,24 +143,24 @@ highlights: # link: https://theme-hope.vuejs.press/zh/guide/markdown/presentation/ - header: 部署和使用 - description: 提供自动化部署或手动部署两种方式 + description: 提供多种部署方式 image: /assets/image/layout.svg bgImage: https://theme-hope-assets.vuejs.press/bg/5-light.svg bgImageDark: https://theme-hope-assets.vuejs.press/bg/5-dark.svg highlights: - - title: 自动化安装器部署（Windows推荐） - icon: object-group - details: 点击此处看详细教程 - link: https://lazyfree.top/2023/08/11/QChatGPT%E9%83%A8%E7%BD%B2%E6%95%99%E7%A8%8B-Win-mirai/ - - title: Docker（Linux首选） - icon: circle-half-stroke - details: Docker要求熟悉Docker的基本操作，点此查看详细教程 - link: https://theme-hope.vuejs.press/zh/guide/interface/darkmode.html + - title: 自动化安装器方式 + + details: 自动化让小白也能一键上手 + link: /posts/deploymentTutorial/#自动化部署 + - title: Docker方式 + + details: Docker部署实例更加快捷，可移植性更加强大 + link: /posts/deploymentTutorial/#docker - title: 手动部署（适用所有平台） - icon: palette - details: 强烈推荐，避免网络问题导致安装器部署失败，点此查看详细教程 - link: https://theme-hope.vuejs.press/zh/guide/interface/theme-color.html + + details: 手动部署让你避免各种环境问题 + link: /posts/deploymentTutorial/#手动部署 # # - title: 幻灯片页面 # icon: person-chalkboard @@ -179,33 +179,32 @@ highlights: features: - title: 机器人联网 icon: network - details: 配合 Waline 来开启阅读量统计与评论支持 - link: https://theme-hope.vuejs.press/zh/guide/feature/comment.html + details: 基于GPT的Function Calling功能实现的类似ChatGPT的WebPilot插件的功能 + link: https://github.com/RockChinQ/WebwlkrPlugin - title: 逆向功能 icon: tree - details: 为你的文章添加作者、写作日期、预计阅读时间、字数统计等信息 - link: https://theme-hope.vuejs.press/zh/guide/feature/page-info.html + details: 可以接入ChatGPT网页版,New Bing,Claude,Bard… + link: https://github.com/RockChinQ/revLibs - title: 模型切换 icon: flow - details: 你可以为你的特定页面或特定目录进行加密，以便陌生人不能随意访问它们 - link: https://theme-hope.vuejs.press/zh/guide/feature/encrypt.html - - - title: 语音合成 - icon: write - details: 支持 docsearch 和基于客户端的搜索 - link: https://theme-hope.vuejs.press/zh/guide/feature/search.html + details: 支持通过命令在聊天环境中切换使用的模型 + link: https://github.com/RockChinQ/revLibs - title: 故事叙述和绘图 icon: copy - details: 一键复制代码块中的代码 - link: https://theme-hope.vuejs.press/zh/guide/feature/copy-code.html + details: 基于Holara的ai绘图插件 + link: https://github.com/oliverkirk-sudo/QChatAIPaint + - title: 语音合成 + icon: write + details: 文字转语音输出，支持HuggingFace的VITS模型,Azure语音合成,本地vits语音合成,sovits语音合成 + link: https://github.com/oliverkirk-sudo/chat_voice - title: 点击查看更多插件 icon: search details: 点此查看所有插件列表 - link: ./doc/PluginsUse + link: /posts/PluginsUse/pluginsList.md - header: 致谢 description: 向QChatGPT项目开发者及其插件开发者致以诚挚的敬意 @@ -223,6 +222,11 @@ highlights: details: QChatGPT的仓库页 link: https://github.com/RockChinQ/QChatGPT + - title: 插件贡献者 + icon: group + details: QChatGPT的仓库页 + link: https://github.com/RockChinQ/QChatGPT/graphs/contributors + # - title: dominoar # icon: home # details: 为本项目开发多种插件 @@ -269,5 +273,5 @@ highlights: # link: https://theme-hope.vuejs.press/zh/guide/advanced/pwa.html copyright: false -footer: QChatGPT 项目的Wiki页  |  MIT 协议, 版权所有 © 2023-present RockChinQ +footer: QChatGPT 项目的Wiki页  |  MIT 协议, 版权所有 © 2023-present Lazy --- diff --git a/src/doc/README.md b/src/doc/README.md deleted file mode 100644 index 97e0af66b..000000000 --- a/src/doc/README.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: 使用方法 -index: false -icon: blog -date: 2023-09-30 -category: - - 使用指南 ---- - -## 目录 -- [插件使用](/PluginsUse.md) -- [插件开发](/PluginsDevelop.md) diff --git a/src/doc/PluginsDevelop.md b/src/posts/PluginsDevelop.md similarity index 61% rename from src/doc/PluginsDevelop.md rename to src/posts/PluginsDevelop.md index 874e451e5..ac9230615 100644 --- a/src/doc/PluginsDevelop.md +++ b/src/posts/PluginsDevelop.md @@ -1,5 +1,5 @@ --- title: 插件开发 -icon: config +icon: code --- diff --git a/src/posts/PluginsUse/README.md b/src/posts/PluginsUse/README.md new file mode 100644 index 000000000..c8ac6a48c --- /dev/null +++ b/src/posts/PluginsUse/README.md @@ -0,0 +1,17 @@ +--- +title: 插件使用 +icon: blog +date: 2023-09-30 +category: + - 使用指南 +index: false +--- +:::info 目录 +[[toc]] +::: + +## 插件一览 +- [点击查看插件列表](pluginsList.md) +## 插件的使用方法 +- +## 更多插件的使用方法 \ No newline at end of file diff --git a/src/doc/PluginsUse.md b/src/posts/PluginsUse/pluginsList.md similarity index 98% rename from src/doc/PluginsUse.md rename to src/posts/PluginsUse/pluginsList.md index 4e6dcafe3..aea161069 100644 --- a/src/doc/PluginsUse.md +++ b/src/posts/PluginsUse/pluginsList.md @@ -1,9 +1,9 @@ --- -title: 插件使用 -icon: shell +title: 插件列表 +icon: list order: 1 author: Lazy -date: 2023-9-30 +date: 2023-09-30 category: - 使用指南 --- diff --git a/src/posts/Q&A.md b/src/posts/Q&A.md index 0b6f292ea..0a6766d92 100644 --- a/src/posts/Q&A.md +++ b/src/posts/Q&A.md @@ -1,12 +1,13 @@ --- title: 问题解答 -icon: ask -order: 4 +icon: blog author: Lazy date: 2023-09-30 category: - - 使用指南 + - 问题解答 --- - +:::info 目录 +[[toc]] +::: \ No newline at end of file diff --git a/src/posts/README.md b/src/posts/README.md deleted file mode 100644 index d4731df78..000000000 --- a/src/posts/README.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: 使用方法 -index: false -icon: blog -date: 2023-09-30 -category: - - 使用指南 ---- - -## 目录 - - -- [部署教程](/posts/deploymentTutorial.md) -- [功能介绍](/posts/functionIntroduction.md) -- [常见报错](/posts/commonErrors.md) -- [问题解答](/posts/Q&A.md) diff --git a/src/posts/commonErrors/README.md b/src/posts/commonErrors/README.md new file mode 100644 index 000000000..560d35049 --- /dev/null +++ b/src/posts/commonErrors/README.md @@ -0,0 +1,9 @@ +--- +title: 常见报错 +icon: info +author: Lazy +date: 2023-09-30 +category: + - 常见报错 +index: false +--- \ No newline at end of file diff --git a/src/posts/commonErrors/byMirai.md b/src/posts/commonErrors/byMirai.md new file mode 100644 index 000000000..b8b314634 --- /dev/null +++ b/src/posts/commonErrors/byMirai.md @@ -0,0 +1,37 @@ +--- +title: Mirai报错 +icon: notice +order: 1 +author: Lazy +date: 2023-09-30 +category: + - 常见报错 +--- +> 本人能力有限，报错收集将会逐步完善增补，望广大用户献计献策，众人拾柴火焰高，共同完善 +:::info 目录 +[[toc]] +::: +## code=45 +![code=45](https://s2.loli.net/2023/08/16/CcJFZiXLw6oGNxI.png) +> **这个问题已经说过无数次了，要使用签名服务！！！** + +不知道什么是签名服务，怎么用签名服务，直接看下面教程，完全看不懂的严格根据教程重来，看懂的直接翻到里面签名服务部分 +* [点我查看Windows部署教程](http://lazyfree.top/2023/08/11/QChatGPT%E9%83%A8%E7%BD%B2%E6%95%99%E7%A8%8B-Win-mirai/) +* [点我查看Linux部署教程](http://lazyfree.top/2023/08/11/QChatGPT%E9%83%A8%E7%BD%B2%E6%95%99%E7%A8%8B-Linux-mirai/) + +> 2023年9月13日发现最新问题，即使加载了签名服务，仍然报错code=45，以下博主发现的一个可能行得通的解决办法（2023年9月15日发现，所使用的[签名服务](https://github.com/MrXiaoM/qsign)版本是1.0.9，该解决方法可靠性未知）： +1. 删除mirai文件夹下的bots文件夹 +2. 更新qsgin签名服务为最新版（当时最新为1.0.9），更新方法见`https://github.com/MrXiaoM/qsign#%E5%8D%87%E7%BA%A7%E6%8F%92%E4%BB%B6` + - 替换mirai文件夹中的plugins文件夹里面的`qsign-x.x.x.mirai2.jar`为你下载到的最新版，当时最新的为`qsign-1.0.9.mirai2.jar` + - 替换mirai文件夹中的txlib文件，换成你下载到的最新版 +3. 修改config\top.mrxiaom.qsign的config.yml文件，修改`base-path: 'txlib/8.9.63'`为`base-path: 'txlib/8.9.73'`[之所以改为8.9.73，是因为mirai文件夹中txlib文件夹中最新的就是8.9.73，如果有更新的，请自行改成最新的] +4. 按照常规方式在mirai中进行登录你的机器人QQ + +## code=16 +![code=16](https://s2.loli.net/2023/08/17/8ONDlwVTbtAQa7H.png) +删除mirai下的bots文件夹，然后重新登录，按要求输入 +## code=237 +![code=237](https://s2.loli.net/2023/08/17/AW3g2swTJ1aVUfN.png) +打开mirai/config/Console文件夹，打开`AutoLogin.yml`文件 +按照下图修改 +![解决code_237.png](https://s2.loli.net/2023/08/17/dJ9tCHpiyQ8eusP.png) \ No newline at end of file diff --git a/src/posts/commonErrors.md b/src/posts/commonErrors/byQchatgpt.md similarity index 50% rename from src/posts/commonErrors.md rename to src/posts/commonErrors/byQchatgpt.md index a7f59c5bb..03878e1c4 100644 --- a/src/posts/commonErrors.md +++ b/src/posts/commonErrors/byQchatgpt.md @@ -1,40 +1,34 @@ --- -title: 常见报错 -icon: notice -order: 3 +title: QChatGPT报错 +icon: type +order: 2 author: Lazy date: 2023-09-30 category: - - 使用指南 + - 常见报错 --- -## 目录 -运行run-mirai报错， code=45, 16，237等问题 -启动run-bot.bat闪退，命令行运行报错: No module named 'colorlog' -运行run-bot.bat闪退，检查发现目录下无QChatGPT目录 -启动主程序后卡住，发送消息不回复 -运行run-bot.bat，报错ModuleNotFoundError: No module named 'pkg' -运行run-bot.bat，报错：捕捉到未知异常 -Websockets版本过低：As of 3.10, the *loop* parameter was removed from Lock() since it is no longer necessary -### 运行run-mirai报错， code=45, 16，237等问题 +:::info 目录 +[[toc]] +::: -### 启动run-bot.bat闪退，命令行运行报错: No module named 'colorlog' -![Q8_2.png](https://s2.loli.net/2023/08/16/PUXj6mxustQicvH.png) -[点击跳转issue页查看解决办法](https://github.com/RockChinQ/qcg-installer/issues/15) - -### 运行run-bot.bat闪退，检查发现目录下无QChatGPT目录 +## 运行run-bot.bat闪退，检查发现目录下无QChatGPT目录 ![Q8_3.png](https://s2.loli.net/2023/08/16/HzTR5dAivUOKNMP.png) [点击跳转issue页查看解决办法](https://github.com/RockChinQ/qcg-installer/issues/2) -### 启动主程序后卡住，发送消息不回复 +## 启动run-bot.bat闪退，命令行运行报错: No module named 'colorlog' +![Q8_2.png](https://s2.loli.net/2023/08/16/PUXj6mxustQicvH.png) +[点击跳转issue页查看解决办法](https://github.com/RockChinQ/qcg-installer/issues/15) + +## 启动主程序后卡住，发送消息不回复 [点击跳转issue页查看解决办法](https://github.com/RockChinQ/QChatGPT/issues/37) -### 运行run-bot.bat，报错ModuleNotFoundError: No module named 'pkg' +## 运行run-bot.bat，报错ModuleNotFoundError: No module named 'pkg' [点击跳转issue页查看解决办法](https://github.com/RockChinQ/qcg-installer/issues/40) -### 运行run-bot.bat，报错：捕捉到未知异常 +## 运行run-bot.bat，报错：捕捉到未知异常 [点击跳转issue页查看解决办法](https://github.com/RockChinQ/qcg-installer/issues/31) -### Websockets版本过低：As of 3.10, the *loop* parameter was removed from Lock() since it is no longer necessary +## Websockets版本过低：As of 3.10, the *loop* parameter was removed from Lock() since it is no longer necessary 解决方法： - 由自动安装器进行部署的，到安装器目录执行以下指令（即run-bot所在目录） - Windows平台 @@ -51,6 +45,4 @@ Websockets版本过低：As of 3.10, the *loop* parameter was removed from Lock( ``` 想要查看更多有关Q8_7 问题的，请点击下方： -[点击跳转issue页查看解决办法](https://github.com/RockChinQ/QChatGPT/issues/5) - - \ No newline at end of file +[点击跳转issue页查看解决办法](https://github.com/RockChinQ/QChatGPT/issues/5) \ No newline at end of file diff --git a/src/posts/deploymentTutorial.md b/src/posts/deploymentTutorial.md deleted file mode 100644 index 96151d068..000000000 --- a/src/posts/deploymentTutorial.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: 部署教程 -icon: creative -order: 2 -author: Lazy -date: 2023-09-30 -category: - - 使用指南 ---- - -# 快速上手 -> 手动部署使用于所有平台，若采用自动化部署，Linux首选Docker，Windows首选安装器 -## 手动部署（所有平台适用） -[点此查看安装教程](https://github.com/RockChinQ/QChatGPT#--%E6%89%8B%E5%8A%A8%E9%83%A8%E7%BD%B2) - -## 自动化部署 -1. 安装器部署（Windows推荐） - - [点此查看安装教程](https://lazyfree.top/2023/08/11/QChatGPT%E9%83%A8%E7%BD%B2%E6%95%99%E7%A8%8B-Win-mirai/) - -2. Docker部署（Linux推荐） - - [点此查看安装教程](https://github.com/RockChinQ/QChatGPT/blob/master/res/docs/docker_deployment.md) - - \ No newline at end of file diff --git a/src/posts/deploymentTutorial/README.md b/src/posts/deploymentTutorial/README.md new file mode 100644 index 000000000..c4690fca0 --- /dev/null +++ b/src/posts/deploymentTutorial/README.md @@ -0,0 +1,30 @@ +--- +title: 部署教程 +icon: info +author: Lazy +date: 2023-09-30 +category: + - 部署教程 +index: false +--- +:::info 目录 +[[toc]] +::: +## 自动化部署 +:::tip +Windows首选[安装器](#windows)，Linux首选[Docker](#docker) +::: +### 安装器 +> 部署过程最简单，但有一定失败概率 + +安装器可在Windows和Linux平台下使用 +- [ 点击查看Windows的具体操作](auto_app_win.md) + +- [ 点击查看Linux的具体操作](auto_app_win.md) +### Docker +> docker方式较为复杂，若您不熟悉docker的操作及相关知识，强烈建议您使用其他方式部署，我们不会且难以解决您主机上多个容器的连接问题。 +- [ 点击查看Docker部署的具体操作](auto_docker.md) + +## 手动部署 +> 全平台通用，可以避免安装器部署失败的问题 +- [ 点击查看手动部署的具体操作](manual.md) \ No newline at end of file diff --git a/src/posts/deploymentTutorial/auto_app_linux.md b/src/posts/deploymentTutorial/auto_app_linux.md new file mode 100644 index 000000000..30f3da7d2 --- /dev/null +++ b/src/posts/deploymentTutorial/auto_app_linux.md @@ -0,0 +1,151 @@ +--- +title: 安装器部署(Linux) +icon: linux +order: 2 +author: Lazy +date: 2023-09-30 +category: + - 使用指南 +--- +:::info 目录 +[[toc]] +::: + +## 第一步：下载安装器文件 + +在根目录输入以下指令创建一个文件夹（bot 为文件夹的名字，随便起） + +```terminal +mkdir bot +``` + +然后输入指令进入 bot 文件夹（bot 切换为你起的名字） + +```terminal +cd bot +``` + +创建一个 screen 窗口，命名为 bot，可以随便 + +```terminal +screen -S bot +``` + +然后输入以下指令下载安装器文件 + +```terminal +wget https://github.com/RockChinQ/qcg-installer/releases/download/v0.13.2/qcg-installer-linux-amd64 +``` + +## 第二步：运行安装器 + +依次执行以下命令 + +```terminal +sudo chmod -R 777 qcg-installer-linux-amd64 +``` + +```terminal +./qcg-installer-linux-amd64 +``` + +耐心等待，可能需要半个小时，直至如图界面 + +![图1](https://s2.loli.net/2023/08/11/j5DnQPVCYh1sJ78.jpg) + +输入你的 api_key 并回车，然后输机器人 QQ 号再回车 + +## 第三步：配置签名服务器 + +打开这个网页，点击 release，点击下载 zip 压缩包 + +[https://github.com/MrXiaoM/qsign](https://github.com/MrXiaoM/qsign) + +将下载好的压缩包解压后里面会有两个文件夹，其中 plugins 文件夹里面的 jar 包上传到 mirai 文件夹下的 plugins 文件夹 + +![图2](https://s2.loli.net/2023/08/11/KiJQozRlPDdtBUs.png) + +txlib 文件夹上传到 mirai 文件夹下 + +![图3](https://s2.loli.net/2023/08/11/OD8C9Fa156BugcT.png) + +## 第四步：登录 + +手机上打开这个网页 + +[https://github.com/KasukuSakura/mirai-login-solver-sakura](https://github.com/KasukuSakura/mirai-login-solver-sakura) + +点击 release，点击下载 apk-release.apk 文件，然后安装 + +返回到 FinalShell，输入以下指令 + +```terminal +./run-mirai.sh +``` + +耐心等待，然后输入，其中 123456 是替换为你机器人的 QQ 号，67890 替换为你机器人 QQ 的密码 + +```terminal +login 12345 67890 +``` + +回车后可以看到这些提示 + +![图4](https://s2.loli.net/2023/08/11/MymgAkDBQU4NpE9.jpg) + +输入这个命令并回车 + +```terminal +TxCaptchaHelper +``` + +然后可以看到提示要在手机端输入请求码，这时打开刚才手机上安装的软件，输入请求码，点击下一步，验证完成后，可以在 FinalShell 上看到提示是否要发送验证码 + +![图5](https://s2.loli.net/2023/08/11/bI5jzOyGvCiUhTV.jpg) + +输入指令并回车 + +```terminal +yes +``` + +稍后填入手机收到的验证码 + +这时可以看到就登录成功了 + +点击蓝色界面，然后按快捷键 CTRL+a+c（先按下 ctrl+a 不放，再按 c），可以看到新建了一个窗口，输入指令 + +```terminal +./run-bot.sh +``` + +然后会提示输入管理员 QQ + +然后就可以成功与机器人对话了，私聊直接发信息，群聊需要@ + +## 第五步：反向代理 + +当然，目前使用仍然需要代理或要求你的服务器在国外，否则就会报超时错误，但是考虑到不一定有海外服务器或方便设置全局代理，我们可以通过设置反向代理来解决 +具体操作：打开QChatGPT文件夹下的config.py文件（可以用记事本或VScode等任何代码编辑器） +找到这一行，在你填写API_Key的附近 +``` +"reverse_proxy": None +``` +将这行代码改为 +``` +"reverse_proxy": "双引号里面写你的反代地址" +``` +若使用[**本UP主**](https://space.bilibili.com/407410594)免费提供的反代地址请输入为`"reverse_proxy": "http://api.openai.lazyshare.top/v1"`，反代地址不一定长久有效，且用且珍惜 +设置完成后应是如图情况 +![反代设置.jpg](https://s2.loli.net/2023/08/16/GeoiZCbLtfg3uqH.jpg) +然后记得保存，并重新运行run-bot + +## 补充：Linux部署时报错 + +### GLIBC 2.XX缺乏 +通常此情况发送于基于Red Hat的系统，例如CentOS + +这是由于glibc依赖版本不足导致的，此时并不建议去升级glibc。，glibc版本升级可能导致操作系统无法使用，所以请务必谨慎操作，先在同版本操作系统系统模拟测试，将glibc新版本所依赖的软件完成升级后再行升级。 + +这种情况下，建议使用手动部署 +教程请看项目仓库，[点击跳转](https://github.com/RockChinQ/QChatGPT#--%E6%89%8B%E5%8A%A8%E9%83%A8%E7%BD%B2) \ No newline at end of file diff --git a/src/posts/deploymentTutorial/auto_app_win.md b/src/posts/deploymentTutorial/auto_app_win.md new file mode 100644 index 000000000..7b4472ec6 --- /dev/null +++ b/src/posts/deploymentTutorial/auto_app_win.md @@ -0,0 +1,89 @@ +--- +title: 安装器部署(Win) +icon: windows +order: 1 +author: Lazy +date: 2023-09-30 +category: + - 使用指南 +--- +:::info 目录 +[[toc]] +::: + +## 第一步：下载一键安装器 + +打开这个网页 + +[https://github.com/RockChinQ/qcg-installer](https://github.com/RockChinQ/qcg-installer) + +点击 release，点击下载 exe 文件，保存到一个合适位置 + +双击刚才的 exe 文件，程序即可自动加载 + +如果速度过慢，可以关闭该窗口，删除多出来的 python 文件夹，在文件夹空白处右击，在终端中打开，输入以下指令 + +```terminal +.\qcg-installer-windows-amd64.exe -p http://localhost:7890 +``` + +耐心等待，程序将自动运行至提示输入OpenAI api_key，这时输入你的 api_key 并回车，获取 api_key 链接在这里 + +[https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys) + +然后输入你机器人的 QQ 号并回车 + +## 第二步：配置签名服务器 + +打开这个网页，点击 release，点击下载 zip 压缩包 + +[https://github.com/MrXiaoM/qsign](https://github.com/MrXiaoM/qsign) + +将下载好的压缩包解压后里面会有两个文件夹，其中 plugins 文件夹里面的 jar 包放到到 mirai 文件夹下的 plugins 文件夹，txlib 文件夹移动到 mirai 文件夹，如图所示 + +![图1](https://s2.loli.net/2023/08/11/vH4u7jlYCt1iKEG.png) + +![图2](https://s2.loli.net/2023/08/11/bC2ZapYwjMAErq4.png) + +## 第三步：登录 + +手机上打开这个网页 + +[https://github.com/KasukuSakura/mirai-login-solver-sakura](https://github.com/KasukuSakura/mirai-login-solver-sakura) + +点击 release，下载 apk-release.apk 文件，然后安装 + +双击 run-mirai.bat，耐心等待，然后输入，其中 123456 是替换为你机器人的 QQ 号，67890 替换为你机器人 QQ 的密码 + +```terminal +login 12345 67890 +``` + +然后输入 + +```terminal +TxCaptchaHelper +``` + +回车后可以看到弹窗提示，点击第二个，弹出二维码，打开手机刚才下载的软件，点击扫描二维码，验证完成后，可以看到电脑提示验证，选择短信验证，然后输入收到的验证码，点击确定即可成功登录 +如果没有弹窗提示，可以看到终端提示要在手机端输入识别码，打开手机刚才下载的软件，输入，验证通过后，可以看到电脑提示要发送短信验证码，输入` yes `后回车，然后输入手机收到的短信验证码，回车后就可以看到登录成功了 + +然后点击 run-bot.bat，可以看到提示登录成功了，这时就可以给你的机器人发送消息了，私聊直接发送，群聊需要@ +## 第四步：反向代理 + +当然，目前使用仍然需要全局代理，但考虑到总是全局代理不方便，我们可以通过设置反向代理来解决 +具体操作：打开QChatGPT文件夹下的config.py文件（可以用记事本或VScode等任何代码编辑器） +找到这一行，在你填写API_Key的附近 +``` +"reverse_proxy": None +``` +将这行代码改为 +``` +"reverse_proxy": "双引号里面写你的反代地址" +``` +若使用[**本UP主**](https://space.bilibili.com/407410594)免费提供的反代地址请输入为`"reverse_proxy": "http://api.openai.lazyshare.top/v1"`，反代地址不一定长久有效，且用且珍惜 +设置完成后应是如图情况 +![反代设置.jpg](https://s2.loli.net/2023/08/16/GeoiZCbLtfg3uqH.jpg) +然后记得保存，并重新运行run-bot + + \ No newline at end of file diff --git a/src/posts/deploymentTutorial/auto_docker.md b/src/posts/deploymentTutorial/auto_docker.md new file mode 100644 index 000000000..2c7c218e9 --- /dev/null +++ b/src/posts/deploymentTutorial/auto_docker.md @@ -0,0 +1,80 @@ +--- +title: Docker部署 +icon: warn +order: 4 +author: Lazy +date: 2023-09-30 +category: + - 使用指南 +--- + + +:::warning +请您确保您**确实**需要 Docker 部署，您**必须**具有以下能力： + - 了解 `Docker` 和 `Docker Compose` 的使用 + - 了解容器间网络通信配置方式 + - 了解容器文件挂载机制 + - 了解容器调试操作 + - 动手能力强、资料查找能力强 + + 若您不完全具有以上能力，请勿使用 Docker 部署，由于误操作导致的配置不正确，我们将不会解答您的问题并不负任何责任。 + **非常不建议**您在除 Linux 之外的系统上使用 Docker 进行部署。 +::: + +:::info 目录 +[[toc]] +::: + +## 概览 + +QChatGPT 主程序需要连接`QQ登录框架`以与QQ通信，您可以选择 [Mirai](https://github.com/mamoe/mirai)（还需要配置mirai-api-http，请查看此仓库README中手动部署部分） 或 [go-cqhttp](https://github.com/Mrs4s/go-cqhttp)，我们仅发布 QChatGPT主程序 的镜像，您需要自行配置QQ登录框架（可以参考[README.md](https://github.com/RockChinQ/QChatGPT#-%E9%85%8D%E7%BD%AEqq%E7%99%BB%E5%BD%95%E6%A1%86%E6%9E%B6)中的教程，或自行寻找其镜像）并在 QChatGPT 的配置文件中设置连接地址。 + +> **Note** +> 请先确保 Docker 和 Docker Compose 已安装 + +## 准备文件 + +> QChatGPT 目前暂不可以在没有配置模板文件的情况下自动生成文件，您需要按照以下步骤手动创建需要挂载的文件。 +> 如无特殊说明，模板文件均在此仓库中。 + +> 如果您不想挨个创建，也可以直接clone本仓库到本地，执行`python main.py`后即可自动根据模板生成所需文件。 + +现在请在一个空目录创建以下文件或目录： + +### 📄`config.py` + +复制根目录的`config-template.py`所有内容，创建`config.py`并根据其中注释进行修改。 + +### 📄`banlist.py` + +复制`res/templates/banlist-template.py`所有内容，创建`banlist.py`，这是黑名单配置文件，根据需要修改。 + +### 📄`cmdpriv.json` + +复制`res/templates/cmdpriv-template.json`所有内容，创建`cmdpriv.json`，这是各命令的权限配置文件，根据需要修改。 + +### 📄`sensitive.json` + +复制`res/templates/sensitive-template.json`所有内容，创建`sensitive.json`，这是敏感词配置，根据需要修改。 + +### 📄`tips.py` + +复制`tips-custom-template.py`所有内容，创建`tips.py`，这是部分提示语的配置，根据需要修改。 + +## 运行 + +已预先准备好`docker-compose.yaml`，您需要根据您的网络配置进行适当修改，使容器内的 QChatGPT 程序可以正常与 Mirai 或 go-cqhttp 通信。 + +将`docker-compose.yaml`复制到本目录，根据网络环境进行配置，并执行: + +```bash +docker compose up +``` + +若无报错即配置完成，您可以Ctrl+C关闭后使用`docker compose up -d`将其置于后台运行 + +## 注意 + +- 安装的插件都会保存在`plugins`(映射到本目录`plugins`)，安装插件时可能会自动安装相应的依赖，此时若`重新创建`容器，已安装的插件将被加载，但所需的增量依赖并未安装，会导致引入问题。您可以删除插件目录后重启，再次安装插件，以便程序可以自动安装插件所需依赖。 + + \ No newline at end of file diff --git a/src/posts/deploymentTutorial/manual.md b/src/posts/deploymentTutorial/manual.md new file mode 100644 index 000000000..b37d7acf6 --- /dev/null +++ b/src/posts/deploymentTutorial/manual.md @@ -0,0 +1,74 @@ +--- +title: 手动部署 +icon: support +order: 3 +author: Lazy +date: 2023-09-30 +category: + - 使用指南 +--- +:::warning +请使用Python 3.9.x以上版本 +::: + +:::info 目录 +[[toc]] +::: + +## 配置QQ登录框架 + +目前支持mirai和go-cqhttp，配置任意一个即可 + +
+mirai + +1. 按照[此教程](https://yiri-mirai.wybxc.cc/tutorials/01/configuration)配置Mirai及mirai-api-http +2. 启动mirai-console后，使用`login`命令登录QQ账号，保持mirai-console运行状态 +3. 在下一步配置主程序时请在config.py中将`msg_source_adapter`设为`yirimirai` + +
+ +
+go-cqhttp + +1. 按照[此文档](https://github.com/RockChinQ/QChatGPT/wiki/9-go-cqhttp%E9%85%8D%E7%BD%AE)配置go-cqhttp +2. 启动go-cqhttp，确保登录成功，保持运行 +3. 在下一步配置主程序时请在config.py中将`msg_source_adapter`设为`nakuru` + +
+ +## 配置主程序 + +1. 克隆此项目 + +```bash +git clone https://github.com/RockChinQ/QChatGPT +cd QChatGPT +``` + +2. 安装依赖 + +```bash +pip3 install requests yiri-mirai openai colorlog func_timeout dulwich Pillow nakuru-project-idk CallingGPT tiktoken +``` + +3. 运行一次主程序，生成配置文件 + +```bash +python3 main.py +``` + +4. 编辑配置文件`config.py` + +按照文件内注释填写配置信息 + +5. 运行主程序 + +```bash +python3 main.py +``` + +无报错信息即为运行成功 + + + \ No newline at end of file diff --git a/src/posts/functionIntroduction.md b/src/posts/functionIntroduction.md index a8249b4dc..4d708ff19 100644 --- a/src/posts/functionIntroduction.md +++ b/src/posts/functionIntroduction.md @@ -8,7 +8,11 @@ category: - 使用指南 --- -> [QChatGPT项目](https://github.com/RockChinQ/QChatGPT)的功能介绍 +> 此页面是[QChatGPT项目](https://github.com/RockChinQ/QChatGPT)的功能介绍 + +:::info 目录 +[[toc]] +::: ## 选择不同的登录器 @@ -406,5 +410,7 @@ process_message_timeout = 30 process_message_timeout = 180 ``` ## 提出建议 -> 欢迎广大用户积极提出意见和建议，帮助我们进一步改善 +:::tip +欢迎广大用户积极提出意见和建议，帮助我们进一步改善 +::: \ No newline at end of file