update README.md

This commit is contained in:
BennyThink
2021-04-24 20:51:03 +08:00
parent 0b2a27dbf7
commit 99c6b42170
4 changed files with 104 additions and 104 deletions

View File

@@ -1,4 +1,76 @@
# bot开发手册
# 项目手册
# 部署运行
## docker-compose
* 参见 [这里](https://github.com/tgbot-collection/BotsRunner)
* 本目录下的 `docker-compose.yml` 也可以作为参考
* nginx reverse proxy可以[参考这里](https://github.com/BennyThink/WebsiteRunner)
* [参考这里获取数据库](web/README.md)
```shell
# 启动数据库
docker-compose up -d mongo
# 导入数据库
docker cp db.tgz 1234da:/tmp
# 进入容器
docker-compose exec mongo bash
tar xf db.tgz
mongorestore
exit
# 开启服务
docker-compose up -d
```
## 常规方式
### 1. 环境
推荐使用Python 3.6+,环境要求
* redis
* 可选MongoDB
```bash
pip install -r requirements.txt
```
### 2. 配置TOKEN
修改`config.py`,根据需求修改如下配置项
* TOKENbot token
* USERNAME人人影视的有效的用户名
* PASSWORD :人人影视的有效的密码
* MAINTAINER维护者的Telegram UserID
* REDISredis的地址一般为localhost
* MONGODB: mongodb的地址
### 3. 导入数据(可选)
如果使用yyets那么需要导入数据到MongoDB。可以在将数据导入到MySQL之后使用如下脚本导入数据到MongoDB
```shell
python3 web/prepare/convert_db.py
```
**不再兼容旧版本数据**
### 4. 运行
```bash
python /path/to/YYeTsBot/yyetsbot/bot.py
```
### 5. systemd 单元文件
参考 `yyets.service`
### 6. 网站部署运行方式
参考 `worker``web`目录下的 `README`。需要注意cf worker已经停止开发。
## 添加新的资源网站
@@ -39,4 +111,23 @@
### 3. rate limit
404的访问会被计数超过10次会被拉入黑名单持续3600秒再次访问会持续叠加。
404的访问会被计数超过10次会被拉入黑名单持续3600秒再次访问会持续叠加。
# 持续部署
使用[Docker Hub Webhook](https://docs.docker.com/docker-hub/webhooks/)
(顺便吐槽一句这是个什么垃圾文档……自己实现validation吧)
参考listener [Webhook listener](https://github.com/tgbot-collection/Webhook)
# 归档资源下载
## Telegram 频道分享
* 包含了2021年1月11日为止的人人影视最新资源MySQL为主。有兴趣的盆友可以用这个数据进行二次开发[戳我查看详情](https://t.me/mikuri520/668)
* 字幕侠离线数据库 [从这里下载](https://t.me/mikuri520/715),这个数据比较粗糙,并且字幕侠网站还在,因此不建议使用这个
## 本地下载
如果无法访问Telegram可以使用如下网址下载数据
* [网站实时数据MongoDB](https://yyets.dmesg.app/data/yyets_mongo.gz)
* [MySQL](https://yyets.dmesg.app/data/yyets_mysql.zip)
* [SQLite](https://yyets.dmesg.app/data/yyets_sqlite.zip)

111
README.md
View File

@@ -26,8 +26,7 @@
**由于译名的不同,建议输入部分译名,然后从列表中进行选择。比如说想看权力的游戏第四季,那么直接搜索"权力的游戏"就可以了。**
# 命令
## 命令
```
start - 开始使用
help - 帮助
@@ -59,99 +58,17 @@ yyets_offline - 人人影视离线数据
![](assets/3.png)
# 部署运行
# 如何下载磁力和电驴资源?迅雷提示资源敏感
## 电驴资源
请下载使用 [eMule](https://www.emule-project.net/home/perl/general.cgi?l=42) 然后添加如下两个server list
* [server.met](http://www.server-met.de/)
* [server list for emule](https://www.emule-security.org/serverlist/)
## docker-compose
![](assets/emule.jpeg)
速度还可以哦
* 参见 [这里](https://github.com/tgbot-collection/BotsRunner)
* 本目录下的 `docker-compose.yml` 也可以作为参考
* nginx reverse proxy可以[参考这里](https://github.com/BennyThink/WebsiteRunner)
* [参考这里获取数据库](web/README.md)
```shell
# 启动数据库
docker-compose up -d mongo
# 导入数据库
docker cp db.tgz 1234da:/tmp
# 进入容器
docker-compose exec mongo bash
tar xf db.tgz
mongorestore
exit
# 开启服务
docker-compose up -d
```
## 常规方式
### 1. 环境
推荐使用Python 3.6+,环境要求
* redis
* 可选MongoDB
```bash
pip install -r requirements.txt
```
### 2. 配置TOKEN
修改`config.py`,根据需求修改如下配置项
* TOKENbot token
* USERNAME人人影视的有效的用户名
* PASSWORD :人人影视的有效的密码
* MAINTAINER维护者的Telegram UserID
* REDISredis的地址一般为localhost
* MONGODB: mongodb的地址
### 3. 导入数据(可选)
如果使用yyets那么需要导入数据到MongoDB。可以在将数据导入到MySQL之后使用如下脚本导入数据到MongoDB
```shell
python3 web/prepare/convert_db.py
```
**不再兼容旧版本数据**
### 4. 运行
```bash
python /path/to/YYeTsBot/yyetsbot/bot.py
```
### 5. systemd 单元文件
参考 `yyets.service`
### 6. 网站部署运行方式
参考 `worker``web`目录下的 `README`。需要注意cf worker已经停止开发。
# TODO
- [x] 添加对FIX的支持
- [x] 文件/函数重命名,类化
- [x] 优先字幕组顺序设置 - 动态设置
- [x] 添加个人喜好搜索
- [x] 整理fix资源初步完成
- [x] 独立网站
- [x] 独立网站网页优化
- [ ] test case...啊不想写
# 归档资源下载
## Telegram 频道分享
* 包含了2021年1月11日为止的人人影视最新资源MySQL为主。有兴趣的盆友可以用这个数据进行二次开发[戳我查看详情](https://t.me/mikuri520/668)
* 字幕侠离线数据库 [从这里下载](https://t.me/mikuri520/715),这个数据比较粗糙,并且字幕侠网站还在,因此不建议使用这个
## 本地下载
如果无法访问Telegram可以使用如下网址下载数据
* [网站实时数据MongoDB](https://yyets.dmesg.app/data/yyets_mongo.gz)
* [MySQL](https://yyets.dmesg.app/data/yyets_mysql.zip)
* [SQLite](https://yyets.dmesg.app/data/yyets_sqlite.zip)
## 磁力
使用百度网盘、115等离线或使用utorrent等工具记得更新下 [tracker list](https://raw.githubusercontent.com/ngosang/trackerslist/master/trackers_all.txt) 哦
# 开发
@@ -179,13 +96,5 @@ python /path/to/YYeTsBot/yyetsbot/bot.py
# 感谢
[Thanks](THANKS.md)
# 持续部署
使用[Docker Hub Webhook](https://docs.docker.com/docker-hub/webhooks/)
(顺便吐槽一句这是个什么垃圾文档……自己实现validation吧)
参考listener [Webhook listener](https://github.com/tgbot-collection/Webhook)
# License
[MIT](LICENSE)

BIN
assets/emule.jpeg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

View File

@@ -18,7 +18,7 @@
2. 运行 `python prepare/convert_db.py`
## 方法2:使用我的导出
参考 README.md
参考 [这里](https://yyets.dmesg.app/help.html)
# 运行
`python server.py`