Sparkle - 花火

一个使用 Java 语言的 BTN 实现。

Warning

Sparkle 目前处于实验性状态，不建议部署生产环境使用

日程表

目前仍有部分功能缺失，正在努力完成

• 高频操作内存缓存，目前仍在直接查询 PostgreSQL 数据库
• 前端页面
• 高级检索功能
• ...

简述

Sparkle 是一个遵循 BTN 规范 的官方 Java 实现。能够接收 PBH 等 BTN 兼容客户端的数据上报，并下发云规则。

需要环境

• Java 21 或者更高版本
• PostgreSQL
• Redis
• Github OAuth Application

部署

目前 Sparkle 仍处于早期开发阶段，我们暂时不提供部署教程。

功能

• BTN: Submit Peers Ability (Async)
• BTN: Submit Bans Ability (Async)
• BTN: Rules Ability (Async)
• BTN: Reconfigure Ability (Async)
• 客户端特征发现
• 操作与行为审计
• 自动生成不可信 IP 规则 (从 BanHistory)
• 自动生成过量下载规则 (从 Snapshot)
• 与 Github 仓库同步生成的规则
• Snapshot/Ban 记录搜索

API 文档

https://btn-sparkle.apifox.cn