提交 64d16466 编辑于 作者: yuudi's avatar yuudi
浏览文件

docs: update documents

上级 dd894c50
......@@ -7,6 +7,7 @@ assignees: ''
---
首先通过 issues 的搜索功能,查找这个问题是否已经有过解答。
首先查看文档中 FAQ,确认这个问题不在常见问题里。
请仔细描述使用场景、你进行的操作、你期望的表现与实际表现不一致的地方。
......
......@@ -11,9 +11,9 @@ yobot 提供了群聊、web 页面两套用户交互方式,具有操作便捷
## 获取
参考[安装教程](./install/README.md)
自建方法请参考[安装教程](./install/README.md)
或者加入[讨论群](./about.md),与他人共享机器人
或者加入交流群 {{ [770947581,1044314369,774394459][Math.floor(Math.random()*3)] }},租用或出租机器人
## 功能介绍
......
......@@ -8,11 +8,10 @@ yobot 的编写出于学习目的,很高兴此工具能为大家提供帮助
邮件: <yobot@pcrbot.com>
QQ群:
1群:770947581(满)
2群:1044314369(满)
4群:1067699252(满)
1群:770947581
2群:1044314369
4群:1067699252
5群:774394459
6群:1087420601
[项目贡献者](./project/contributors.md)
[更新日志](./project/changelog.md)
......
# Linux 使用 cqhttp-mirai 部署(测试)
## 部署过程
安装环境
```shell
# redhat / centos:
yum install -y java python3 screen wget git
# debain / ubuntu 请使用 apt-get
```
新建一个 linux 用户
```shell
groupadd qqbot
useradd -g qqbot -m qqbot
su qqbot
```
新建一个 screen
```shell
screen -S qqbot
```
下载并启动 yobot
```shell
mkdir -p ~/qqbot/yobot
cd ~/qqbot/yobot
# 下载源码
git clone https://github.com/yuudi/yobot.git --depth=1
cd yobot/src/client/
# 安装依赖
pip3 install -r requirements.txt --user
# 生成 yobotg
python3 main.py
# 启用 yobot
sh yobotg.sh
```
按下 `ctrl-a c` 连续组合键,新建一个 screen shell
启动 mirai-console
```shell
mkdir -p ~/qqbot/mirai
cd ~/qqbot/mirai
wget https://github.com/mamoe/mirai-console-wrapper/releases/download/1.2.0/mirai-console-wrapper-1.2.0-all.jar
java -jar mirai-console-wrapper-1.2.0-all.jar
```
在 mirai-console 里登录 QQ 并下载 CQHTTPMirai 插件
```shell
# (mirai-console内)
login 123456789 ppaasswwdd # 注意改成你的QQ小号的账号密码
install CQHTTPMirai
```
按下 `ctrl-a c` 连续组合键,新建一个 screen shell
修改 CQHTTPMirai 配置文件
```shell
mkdir -p ~/qqbot/mirai/plugins/CQHTTPMirai
cd ~/qqbot/mirai/plugins/CQHTTPMirai
vim setting.yml
```
修改配置文件如下(注意修改 QQ 号)
```yaml
# 要进行配置的QQ号 (Mirai支持多帐号登录, 故需要对每个帐号进行单独设置)
"1234567890":
ws_reverse:
enable: true
postMessageFormat: string
reverseHost: 127.0.0.1
reversePort: 9222
reversePath: /ws
accessToken: null
reconnectInterval: 3000
# 详细说明请参考 https://github.com/yyuueexxiinngg/cqhttp-mirai
```
保存后按下 `ctrl-a 1` 连续组合键,回到 1 号 shell (即 mirai-console 所在的 shell)
重新加载插件
```shell
# (mirai-console内)
reload
```
部署完成,按下 `ctrl-a d` 连续组合键挂起这两个 shell
## 验证安装
向机器人发送“version”,机器人会回复当前版本
## 常见问题
[FAQ](../usage/faq.md)
## 开始 web 模式
[开启方法](../usage/web-mode.md)
......@@ -4,9 +4,9 @@
由于 wine 与原生 Windows 差别较大,很多 酷Q 插件无法在 wine 中运行。
Linux 用户可以使用 Docker 部署(测试中),具体请看[这里](./docker.md)
Linux 用户可以使用 Docker 部署,具体请看[这里](./docker.md)
Linux 用户可以使用 mirai 部署(测试中),具体请看[这里](./mirai.md)
Linux 用户可以使用 mirai 部署,具体请看[这里](./Linux-cqhttp-mirai.md)
**Linux运行存在问题较多,不推荐使用**,如果你坚持使用Linux来部署机器人,可以参考本文步骤。
......
......@@ -8,6 +8,6 @@
## 使用mirai安装
mirai是最新的开源QQ机器人解决方案,免费、开放、多平台支持,稳定性差
mirai是最新的开源QQ机器人解决方案,免费、开放、多平台支持
[使用mirai部署yobot](./mirai.md)
# Windows 使用 cqhttp-mirai 部署
编写中……
......@@ -10,6 +10,8 @@ yobot搭建难度约等于搭建网站的难度,请量力而行
:::
如果想租用或出租机器人,可以加群 {{ [770947581,1044314369,774394459][Math.floor(Math.random()*3)] }}
选择一个安装教程:
## Windows 服务器:便携版(新手推荐)
......@@ -18,8 +20,6 @@ yobot搭建难度约等于搭建网站的难度,请量力而行
[快速使用](./Windows-quick-start.md)☚最简单
[详细说明](./Windows-portable.md)(一般不需要阅读这个)
## Windows 服务器:源码运行
用 python 运行源码,可以方便地做一些小改动
......
......@@ -2,22 +2,12 @@
[mirai 项目地址](https://github.com/mamoe/mirai)
## 使用 cqhttp-mirai 运行(推荐)
yobot 原生于 cqhttp,利用[cqhttp-mirai](https://github.com/yyuueexxiinngg/cqhttp-mirai)可以直接在 mirai 内使用 yobot
利用 cqhttp-mirai 可以直接在 mirai 上运行 cqhttp 项目。
## Windows 部署
编写中……
[编写中……](./Windows-cqhttp-mirai.md)
[参考链接](https://github.com/yyuueexxiinngg/cqhttp-mirai)
## Linux 部署
## 使用 yobot-mirai 运行
编写中……
[参考链接](https://github.com/yyuueexxiinngg/yobot-mirai)
## 使用 mirai-native 运行
编写中……
[参考链接](https://github.com/iTXTech/mirai-native)
[详细说明](./Linux-cqhttp-mirai.md)
......@@ -92,4 +92,4 @@ chown -R 1000:1000 .
### 这里没有我的问题
可以在[这里](https://github.com/yuudi/yobot/issues)提问,提问前可以阅读[正确的提问姿势](https://github.com/tangx/Stop-Ask-Questions-The-Stupid-Ways/blob/master/README.md)
可以在QQ群({{ [770947581,1044314369,774394459][Math.floor(Math.random()*3)] }})或[github issue](https://github.com/yuudi/yobot/issues)提问,提问前可以阅读[正确的提问姿势](https://github.com/tangx/Stop-Ask-Questions-The-Stupid-Ways/blob/master/README.md)
......@@ -19,8 +19,8 @@
由于不同的服务器提供商所需的步骤不同,所以具体方法请通过搜索引擎搜索:【你的提供商+你的操作系统+如何开放端口】
由于需要和yobot插件版兼容,默认路由设置为/yobot,直接访问根目录会产生405错误。
如果您没有修改路径,请通过 http://您的公网IP:yobot运行的端口/yobot/ 进行访问。
e.g. http://10.10.10.10:9222/yobot/
如果您没有修改路径,请通过 `http://您的公网IP:yobot运行的端口/yobot/` 进行访问。
e.g. `http://10.10.10.10:9222/yobot/`
::: warning
......
......@@ -2,14 +2,19 @@
## 使用方法
1.**你的服务器上**下载[yobot Nginx 预配置包](https://yobot.lanzous.com/iczvp8b),解压。
1. 双击 `启动.bat`,有一个窗口**一闪而过**,这是正常的。
1.**你的服务器上**下载[yobot Nginx 预配置包](https://yobot.lanzous.com/id60sli),解压。
1. 双击 `start.bat`,有一个窗口**一闪而过**,这是正常的。
1. 在你自己的电脑上打开浏览器,输入你的服务器 ip 地址,如果看到 `Welcome to nginx!` 则说明启动成功。
1. 向你的机器人发送`登录`,获得地址后,删除地址中的 `:9222` (包括冒号),复制到浏览器进入后台。
1. 进入后台的设置页面,在 `此站点的公开地址` 一栏中,删除地址中的 `:9222` (包括冒号),然后保存即可。
1. 进入后台的设置页面,在 `此站点的公开地址` 一栏中,删除地址中的 `:9222` (包括冒号),然后保存并重启即可。
## 说明
此方法是利用 nginx 反向代理将 yobot 的 9222 端口转发至标准 http 的 80 端口。
如果使用的是国内服务器,那么 80 端口不能使用**未备案**的域名。
除了 `start.bat`,预配置包中还放了一些常用的快捷指令:
stop.bat 用于停止 nignx
forced-stop.bat 用于强制停止 nignx
reload.bat 用于修改配置文件后重新加载
Supports Markdown
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册