IPChronicle 文档
简体中文 | English
IPChronicle 是面向个人自托管用户的公网 IP 质量与历史系统。root Agent 在受管 Linux 节点上发现可到达的公网 IPv4/IPv6 出口并执行完整探测,Center 统一管理 节点、报告、历史和通知。
当前稳定版
本文档对应 v0.1.1。 特定版本的安装产物和冻结文档以对应的 GitHub Release 为准。
快速开始
在 Linux 服务器上安装 Docker Engine 和 Docker Compose,然后运行:
sh
mkdir ipchronicle
cd ipchronicle
curl --proto '=https' --tlsv1.2 -fLO \
"https://github.com/ipchronicle/ipchronicle/releases/latest/download/compose.yaml"
curl --proto '=https' --tlsv1.2 -fL \
"https://github.com/ipchronicle/ipchronicle/releases/latest/download/default.env.example" \
-o .env
docker compose up -d浏览器打开 http://服务器地址:8080,使用 admin / admin 登录。随后:
- 在账户中修改登录信息并按需启用 TOTP。
- 打开节点,生成注册密钥并复制安装命令。
- 在受管 Linux 节点上以 root 执行命令。
- 确认 Agent 发现的公网 IP,并执行首次完整探测。
Cloudflare Tunnel、反向代理和数据目录说明见部署 Center。
核心能力
- 自动发现直连、NAT 和节点级代理可到达的不同公网出口;
- 对实际公网 IP 执行完整质量探测,保存原始与结构化报告;
- 记录公网 IP 和探测字段的有效变化,支持快照比较与保留策略;
- 通过 Telegram、Webhook 或隔离 JavaScript 发送文字或图片通知;
- 使用中英文管理界面维护单个自托管实例。
产品边界
- 一套实例只面向一位管理员,不提供多人、租户或公开结果模式。
- Center 支持在 Linux 上通过 Docker Compose 部署。
- Agent 只主动连接 Center,不需要开放入站管理端口。
- TLS 和反向代理由服务器管理员维护;建议对外连接使用 HTTPS。
- 探测对象来自 Agent 实际确认的公网出口,不接受手动输入任意 IP。
文档入口
产品源码位于 ipchronicle/ipchronicle,产品定义与 架构决策位于 ipchronicle/workspace。