From de2a8bfd6113f7e82ed1ad31fe2017809afeda84 Mon Sep 17 00:00:00 2001
From: felinae98 <731499577@qq.com>
Date: Wed, 7 Jul 2021 20:30:26 +0800
Subject: [PATCH] update doc
---
Dockerfile | 2 --
Dockerfile_browser | 12 ++++++++++
README.md | 11 ----------
docker-compose.yml | 22 +++++++++++++++++++
docs/.vuepress/config.js | 4 +++-
docs/README.md | 5 ++++-
docs/usage/README.md | 47 ++++++++++++++++++++++++++++++++++++++--
7 files changed, 86 insertions(+), 17 deletions(-)
create mode 100644 Dockerfile_browser
create mode 100644 docker-compose.yml
diff --git a/Dockerfile b/Dockerfile
index 97b9846..5e0f254 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,6 +1,4 @@
FROM python:3.9
-RUN echo "deb http://mirrors.aliyun.com/debian/ buster main contrib non-free\ndeb http://mirrors.aliyun.com/debian/ buster-updates main contrib non-free" > /etc/apt/sources.list
-RUN apt-get update && apt-get install -y fonts-wqy-microhei chromium
RUN python3 -m pip config set global.index-url https://mirrors.aliyun.com/pypi/simple
RUN python3 -m pip install poetry && poetry config virtualenvs.create false
WORKDIR /app
diff --git a/Dockerfile_browser b/Dockerfile_browser
new file mode 100644
index 0000000..97b9846
--- /dev/null
+++ b/Dockerfile_browser
@@ -0,0 +1,12 @@
+FROM python:3.9
+RUN echo "deb http://mirrors.aliyun.com/debian/ buster main contrib non-free\ndeb http://mirrors.aliyun.com/debian/ buster-updates main contrib non-free" > /etc/apt/sources.list
+RUN apt-get update && apt-get install -y fonts-wqy-microhei chromium
+RUN python3 -m pip config set global.index-url https://mirrors.aliyun.com/pypi/simple
+RUN python3 -m pip install poetry && poetry config virtualenvs.create false
+WORKDIR /app
+COPY ./pyproject.toml ./poetry.lock* /app/
+RUN poetry install --no-root --no-dev
+# RUN PYPPETEER_DOWNLOAD_HOST='http://npm.taobao.org/mirrors' pyppeteer-install
+COPY . /app/
+ENV HOST=0.0.0.0
+CMD ["python", "bot.py"]
diff --git a/README.md b/README.md
index 0e25a6d..24e2f37 100644
--- a/README.md
+++ b/README.md
@@ -35,17 +35,6 @@
本项目可作为单独插件使用，仅包含订阅相关功能（绝对simple和stupid），也可直接克隆项目进行使用（包含自动同意superuser，自动接受入群邀请等功能）
作为插件使用请安装`nonebot-hk-reporter`包，并在`bot.py`中加载`nonebot_hk_reporter`插件；或直接克隆本项目进行使用
配置与安装请参考[nonebot2文档](https://v2.nonebot.dev/)
-
-Docker部署方法
-
-Docker镜像地址为`felinae98/nonebot-hk-reporter`。例子：
-```bash
-docker run --name nonebot-hk-reporter --network -d -e 'SUPERUSERS=[]' -v :/data -e 'hk_reporter_config_path=/data' -e 'HK_REPORTER_USE_PIC=True' -e 'HK_REPORTER_USE_LOCAL=True' felinae98/nonebot-hk-reporter
-```
-go-cqhttp镜像可使用`felinae98/go-cqhttp-ffmpeg`（数据目录为`/data`），需要注意，两个容器需要在同一个network中。
-
-并且docker版本中提供了自动同意SUPERUSER好友申请和自动同意SUPERUSER的入群邀请的功能。
-
### 配置变量
* `HK_REPORTER_CONFIG_PATH` (str) 配置文件保存目录，如果不设置，则为当前目录下的`data`文件夹
diff --git a/docker-compose.yml b/docker-compose.yml
new file mode 100644
index 0000000..c767919
--- /dev/null
+++ b/docker-compose.yml
@@ -0,0 +1,22 @@
+version: '3'
+
+services:
+ cq-http:
+ image: felinae98/go-cqhttp-ffmpeg
+ volumes:
+ - ./bot-data:/data
+ browserless:
+ image: browserless/chrome
+ nonebot:
+ image: felinae98/nonebot-hk-reporter
+ volumes:
+ - ./nonebot-data:/data
+ environment:
+ TZ: Asia/Shanghai
+ HOST: 0.0.0.0
+ # SUPERUSERS: '[]'
+ HK_REPORTER_CONFIG_PATH: /data
+ HK_REPORTER_BROWSER: ws://browserless:3000
+ depends_on:
+ - browserless
+ - cq-http
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
index bf660a6..6cd8200 100644
--- a/docs/.vuepress/config.js
+++ b/docs/.vuepress/config.js
@@ -3,8 +3,10 @@ module.exports = {
description: 'Docs for Nonebot HK Reporter',
themeConfig: {
nav: [
+ { text: '主页', link: '/' },
{ text: '部署与使用', link: '/usage/' },
- { text: '开发', link: '/dev/' }
+ { text: '开发', link: '/dev/' },
+ { text: 'Github', link: 'https://github.com/felinae98/nonebot-hk-reporter' }
]
}
}
diff --git a/docs/README.md b/docs/README.md
index a7efb63..1c2d1cd 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,12 +1,15 @@
---
home: true
heroText: Nonebot HK Reporter
+tagline: 全网跑到什么地方，比其他的....bot跑得还快
actionText: 快速部署
actionLink: /usage/
features:
- title: KISS
details: 作为插件可以Simple和Stupid，作为插件可以Simple和Stupid，作为Bot提供适用的功能
- title: 拓展性强
- details: 可以快速的添加新的网站
+ details: 没有自己想要的网站？只要简单的爬虫知识就可以给它适配一个新的网站
+- title: 通用，强大
+ details: 社交媒体？网站更新？游戏开服？只要能爬就都能推，还支持自定义过滤
footer: MIT Licensed
---
diff --git a/docs/usage/README.md b/docs/usage/README.md
index b531a73..8cf9c86 100644
--- a/docs/usage/README.md
+++ b/docs/usage/README.md
@@ -2,6 +2,49 @@
sidebar: auto
---
# 部署和使用
-本节将教你快速部署和使用一个nonebot-hk-reporter
+本节将教你快速部署和使用一个nonebot-hk-reporter，如果你不知道要选择哪种部署方式，推荐使用[docker-compose](#docker-compose部署-推荐)
-## 快速上手
+## 部署
+本项目可以作为单独的Bot使用，可以作为nonebot2的插件使用
+### 作为Bot使用
+额外提供自动同意超级用户的好友申请和同意超级用户的加群邀请的功能
+#### docker-compose部署（推荐）
+1. 在一个新的目录中下载[docker-compose.yml](https://raw.githubusercontent.com/felinae98/nonebot-hk-reporter/main/docker-compose.yml)
+ 将其中的``改成自己的QQ号
+ ```bash
+ wget https://raw.githubusercontent.com/felinae98/nonebot-hk-reporter/main/docker-compose.yml
+ ```
+2. 运行配置cq-http
+ ```bash
+ docker-compose run cq-http
+ ```
+ 通信方式选择：3: 反向 Websocket 通信
+ 编辑`bot-data/config.yml`，更改下面字段：
+ ```
+ account: # 账号相关
+ uin: # QQ账号
+ password: "" # 密码为空时使用扫码登录
+
+ ............
+
+ servers:
+ - ws-reverse:
+ universal: ws://nonebot:8080/cqhttp/ws # 将这个字段写为这个值
+ ```
+3. 登录cq-http
+ 再次
+ ```bash
+ docker-compose run cq-http
+ ```
+ 参考[cq-http文档](https://docs.go-cqhttp.org/faq/slider.html#%E6%96%B9%E6%A1%88a-%E8%87%AA%E8%A1%8C%E6%8A%93%E5%8C%85)
+ 完成登录
+4. 确定完成登录后，启动bot：
+ ```bash
+ docker-compose up -d
+ ```
+#### docker部署
+#### 直接运行（不推荐）
+### 作为插件使用
+本部分假设大家会部署nonebot2
+## 配置
+## 使用