From 4f8c9ae89986e470acd1e286e4d59c23f0660a2a Mon Sep 17 00:00:00 2001 From: jerry Date: Sat, 28 Apr 2018 17:05:37 +0800 Subject: [PATCH] update README.md added run shell. --- README.md | 88 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- run.sh | 13 ++++++++ 2 files changed, 100 insertions(+), 1 deletion(-) create mode 100644 run.sh diff --git a/README.md b/README.md index 99e5b391..cece8daa 100755 --- a/README.md +++ b/README.md @@ -1,2 +1,88 @@ # CQBot-swoole -A fast and multi-task framework for Coolq-HTTP-API +A fast and multi-task framework for Coolq-HTTP-API
+一个快速、多进程的CQ-HTTP-API插件框架 made by php-swoole +
+
+
+

什么是swoole

+Swoole是一个C编写的、高性能的PHP扩展。支持多线程、多进程、同步、异步、协程、SQL等。
+Swoole的用处最简单可以理解为，只需要简单几行代码即可运行一个HTTP服务器，比python等同类型解释型语言快非常多。
+此外小声说Swoole官方声明Swoole将重新定义PHP
+官网点我
+
+
+
+

框架简介

+· CQBot-swoole采用swoole框架为基础，在框架上以PHP作为开发语言进行编写。
+· CQBot采用常驻内存+websocket的方式，最大程度地提升了CQHTTP插件处理消息事件的速度
+· 框架采用快速开发的模板，可以在非常短的时间内添加一个功能
+· 框架保留了微信公众号接口，后期我会添加和微信公众号的互通
+
+
+
+

环境需求

+1. Linux（由于酷Q是基于Windows版的，所以这里推荐搭配docker版） +2. php7.0以上 +3. php-mbstring（多字节扩展） +4. swoole-2.x +5. screen（可选） +6. CQ-http-api插件和酷Q（docker版） +
+
+
+

环境部署

+

安装docker-coolq

+如果你想重新开始，则运行安装richardchien的docker镜像快速安装即可 +
$ docker pull richardchien/cqhttp:latest
+$ git clone https://github.com/BlueWhaleNetwork/CQBot-swoole.git
+$ mkdir coolq  # 用于存储酷 Q 的程序文件
+
+#如果你想将docker运行在screen里，输入下面的指令
+$ screen -R coolq 
+
+#将启动脚本移到和coolq目录平级的文件夹（可选）
+$ mv CQBot-swoole/run.sh ./
+
+#启动docker的指令
+$ sh ./run.sh
+docker启动后打开浏览器，输入http://你的服务器地址:9000
+默认密码为MAX8char，此后登陆QQ即可
+
+
+
+

Framework部署

+由于Framework是基于swoole和php7的，所以需要先安装php7和swoole扩展
+由于本教程不是PHP安装教程，所以仅简单介绍PHP安装，具体安装步骤可以自己google一下 +

1. Debian系安装PHP

+
#安装PHP
+$ sudo apt-get install php php-dev php-mbstring php7
+
+#测试php安装是否成功
+$ php -v
+

2. 安装swoole扩展

+
#从github拉取
+$ git clone https://github.com/swoole/swoole-src.git
+$ cd swoole-src
+$ phpize
+$ ./configure
+$ make && make install
+

3. 编辑php.ini文件添加swoole

+
#找到php.ini文件
+#一般在/etc/php.ini或者/etc/php/7.0/cli/php.ini或其他地方
+#php -i可以查看php.ini位置
+
+#修改php.ini，添加swoole.so到扩展列表里
+#if使用vim编辑
+$ sudo vim /etc/php.ini
+#找到extension=xxxx.dll一堆那个地方
+#插入一行：extension=swoole.so
+#然后就成功安装了swoole扩展！
+

4. 运行框架

+
#if框架可运行在screen，方便驻留后端并查看log
+$ screen -R fw
+
+#运行框架
+$ cd CQBot-swoole/
+$ php start.php
+

5. 修改自己的参数

+你可以进入start.php文件中，修改自己的机器人管理群、管理员QQ号、错误日志显示等级等功能。 \ No newline at end of file diff --git a/run.sh b/run.sh new file mode 100644 index 00000000..c413e296 --- /dev/null +++ b/run.sh @@ -0,0 +1,13 @@ +#!/bin/bash +docker run --rm \ +--add-host localhost:$(ifconfig eth0 |grep "inet addr"| cut -f 2 -d ":"|cut -f 1 -d " ") -ti \ +--name cqhttp \ +-v $(pwd)/coolq:/home/user/coolq \ +-p 9000:9000 \ +-p 10000:10000 \ +-e CQHTTP_USE_WS=yes \ +-e CQHTTP_WS_HOST=0.0.0.0 \ +-e CQHTTP_WS_PORT=10000 \ +-e CQHTTP_USE_WS_REVERSE=yes \ +-e CQHTTP_WS_REVERSE_EVENT_URL=ws://localhost:20000/ \ +richardchien/cqhttp:latest