Skip to content
/ luoxu Public

A Telegram userbot to index Chinese and Japanese group contents.

License

Notifications You must be signed in to change notification settings

lilydjwg/luoxu

Repository files navigation

功能说明

落絮可以 CJK 友善的方式索引 Telegram 群组与频道,并提供 API 供前端使用。

风险提示

本程序使用 userbot,有被封号的风险。请三思而后行!

安装与配置

配置 luoxu

  • 安装 Rust nightly 以及 OpenCC 库。
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup toolchain install nightly
  • Python 库依赖请见 requirements.txt 文件
  • 获取一份 Telegram API key
  • querytrans 目录下运行 rustup run nightly cargo build --release 然后把生成的文件(target/release/libquerytrans.so)复制为 querytrans.so 并放在 Python 能找到的地方(比如当前目录)需要注意的是:构建 querytrans 之前需要提前准备好 python 环境,如果与运行 luoxu 的环境不一致将会出错。
  • 复制 config.toml.example 并按需要修改
  • (可选)词云插件需要在 luoxu-cutwords 下运行 cargo build --release 并将生成的可执行文件放到 $PATH

使用 python -m luoxu.ls_dialogs 可以列出会话的 id 和名称。频道和群组的 id 可以用于配置文件中。

设置数据库

  • 安装 PostgreSQL 及 pgroonga
  • 使用 createdb 命令创建数据库
  • 使用 postgres 用户身份连接到该数据库,并执行 CREATE EXTENSION pgroonga;
  • 导入 dbsetup.sql 脚本,如 psql DBNAME < dbsetup.sql

运行

在本项目目录下(或者将本项目目录加入 Python 模块路径),执行:

python -m luoxu

配置 Web 前端

  • 可使用 luoxu-web
  • 修改 src/App.svelte 中的 API URL
  • 运行 npm run build 编译文件
  • 使用 Web 服务器 serve dist 目录

你也可以使用 Vercel 来方便快捷地部署此项目。

当然了,你也可以自己另外编写 Web 页面来使用此 API。

注意事项

不要直接将索引了私有群组/频道的 API 公开于网络上!任何人都能获取其内容的。公开索引了公开群组或频道的服务前,也请获取群组/频道管理员的同意。

luoxu 相当于运行一个 Telegram 客户端,其权限是完全的(包括创建新的登录、结束已有会话、设置两步验证等)。请注意保护账号安全,不要在不信任的服务器上登录与运行本项目!

请注意配置数据库权限。Arch Linux 上默认安装的 PostgreSQL 很可能是对本地用户不设防的(请查阅 /var/lib/postgres/data/pg_hba.conf 配置文件)。

使用

搜索消息时,搜索字符串不区分简繁(会使用 OpenCC 自动转换),也不进行分词(请手动将可能不连在一起的词语以空格分开)。

搜索字符串支持以下功能:

  • 以空格分开的多个搜索词是「与」的关系
  • 使用 OR(全大写)来表达「或」条件
  • 使用 - 来表达排除,如 落絮 - 测试
  • 使用小括号来分组

数据库升级

当对 PostgreSQL 进行跨版本升级时,需要额外处理 pgroonga 的事情。

步骤示意:

  1. 安装新的数据库软件
  2. cp /usr/lib/postgresql/pgroonga* /opt/pgsql-13/lib
  3. 安装新的 pgroonga
  4. 执行升级(pg_upgrade
  5. 如果 pgroonga 版本已更新,执行 pgroonga 升级流程
  6. 升级完成之后需要重新索引(如果索引已被连带删除,从 SQL 文件中找到创建索引的语句并执行):
reindex index usernames_idx;
reindex index message_idx;

不兼容的变更

  • 2022年06月23日,采用分区表来提升部分查询的性能。需要更新配置文件及数据库。

About

A Telegram userbot to index Chinese and Japanese group contents.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •