这份详细的部署教程将指引您安装和使用 leak-check——一个用于检测个人信息是否出现在公开数据中的接口工具。

⚠️ 重要声明与使用前提

  • 定义:此工具检测的是您的“个人信息”是否出现在被“互联网”广泛传播的“部分”数据中。
  • 隐私承诺:该项目不记录查询记录不提供除检测结果外的更多信息
  • 使用目的:项目强调“舆论监督”,旨在帮助您了解自身数据的公开状态。请确保您使用此工具的行为符合所在地区的法律法规。

🚀 快速部署

第一步:环境准备

项目基于 Python 开发,推荐使用 uv 工具管理依赖。请确保您的系统已安装 Python 3.8+ 和 uv (安装命令: pip install uv)。

第二步:一键安装脚本(推荐)

这是最简单的部署方式,脚本会自动处理环境配置。

1
curl -LsSf https://raw.githubusercontent.com/garinasset/leak-check/refs/heads/main/install.sh | bash

此命令会克隆项目仓库并自动设置好运行环境。

第三步:手动部署(备选)

如果您更倾向于手动操作,可以按以下步骤进行:

  1. 克隆仓库

    1
    2
    git clone https://github.com/garinasset/leak-check.git
    cd leak-check
  2. 安装依赖:项目使用 uv 管理依赖,运行以下命令安装:

    1
    uv sync

🗄️ 数据库配置

本项目不提供具体的数据拷贝,您需要使用自己的数据源。项目默认使用 SQLite 数据库,您需要按照以下结构创建表:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
-- 在 leak-check 目录下执行
sqlite3 ./db/leak-check.db

-- 创建源信息表
CREATE TABLE source (
id INTEGER PRIMARY KEY,
source TEXT DEFAULT NULL
);

-- 创建个人信息表
CREATE TABLE person(
id TEXT DEFAULT NULL,
name TEXT DEFAULT NULL,
receiver TEXT DEFAULT NULL,
nickname TEXT DEFAULT NULL,
phone TEXT DEFAULT NULL,
address TEXT DEFAULT NULL,
car TEXT DEFAULT NULL,
email TEXT DEFAULT NULL,
qq INTEGER DEFAULT NULL,
weibo INTEGER DEFAULT NULL,
contact TEXT DEFAULT NULL,
company TEXT DEFAULT NULL,
source_id INTEGER DEFAULT 0,
FOREIGN KEY (source_id) REFERENCES source(id)
);

您需要自行将数据导入到 person 表中,接口将基于这些数据进行查询。

🚀 启动服务

完成配置后,在项目根目录下执行以下命令启动 API 服务:

1
uv run uvicorn main:app --host 0.0.0.0 --port 8000

服务启动后,您可以通过 http://127.0.0.1:8000 访问 API 接口。具体的接口文档和使用方式,请参考项目 README 或源码。

🧹 完全删除

如果您需要彻底移除该项目,只需删除其目录即可:

1
rm -rf leak-check/

📚 进一步了解