功能说明

落絮可以以 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 密钥
• 在 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 服务器提供 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日，采用分区表来提升部分查询的性能。需要更新配置文件及数据库。