Pi.Alert README

The project's README from github.com/leiweibau/Pi.Alert. As one markdown file: README.md.

Pi.Alert

Pi.Alert keeps an eye on your Wi-Fi and LAN and lets you know when something changes. It discovers devices on your network, tracks their availability, and provides a web interface for managing everything in one place.

Pi.Alert main screen Pi.Alert main alternate screen

What Pi.Alert can do

Need visibility into another network segment? The companion Pi.Alert-Satellite project can scan independently and send its results to an existing Pi.Alert instance.

See how this version compares with the original project.

Scan methods and imports

Pi.Alert can collect device information from several sources:

How it works

Backend

The backend is normally started by the operating system's cron service every five minutes. It runs the configured scans and imports, stores their results, and sends notifications when relevant changes are detected. It also monitors manually configured hosts and web services.

Notifications can be delivered through the frontend, email (setup guide), Pushsafer, Pushover, ntfy, or Telegram through the Telegram Bot API. Shoutrrr remains available as an optional discovery helper (setup guide).

Web interface

The web interface gives you a central place to:

The interface is available in English, German, Spanish, French, Italian, Polish, Danish, Dutch, Czech, Finnish, Swedish, Norwegian, Lithuanian, Ukrainian, and Russian. Login protection is enabled during installation with a randomly generated password. You can change it later with pialert-cli.

Skin-specific favicons and home-screen icons are included. They can also be linked directly from this repository when iOS refuses to load icons from an HTTP or self-signed HTTPS installation.

Installation

Pi.Alert was originally designed for the Raspberry Pi and targets Debian-based systems using apt. Before installing it on DietPi, Ubuntu Server, or another Debian-based distribution, check the distribution notes.

Run the installer as root:

sudo bash -c "$(wget -qLO - https://github.com/leiweibau/Pi.Alert/raw/main/install/pialert_install.sh)"

Once installation is complete, continue with the first-start guide.

Proxmox LXC

For an LXC installation, take a look at the Proxmox VE Helper-Scripts, originally provided by the now archived tteck/Proxmox repository. This installation method uses the Pi.Alert version from this repository after the container has been created and provides its own update command.

Updating

The Update Check entry in the sidebar shows available Pi.Alert releases, their changes, and the status of the GeoLite2 database.

To update an existing installation, run:

sudo bash -c "$(wget -qLO - https://github.com/leiweibau/Pi.Alert/raw/main/install/pialert_update.sh)"

If your installation still uses the previous home-directory layout, follow the migration guide.

Older releases and their release notes are available from the Pi.Alert release archive.

Documentation

Support and thanks

If Pi.Alert is useful to you and you would like to support its development:

GitHub Sponsors Buy Me a Coffee
Sponsor on GitHub Buy Me a Coffee

Thank you to everyone who sponsors, contributes to, tests, translates, or otherwise supports the project.

License

Pi.Alert is released under the GNU General Public License 3.0.

Contact

Questions and feedback are welcome at [email protected].

Credits

Pi.Alert also uses or has benefited from the following projects and services:

Pi.Alert (leiweibau/Pi.Alert)

Searching Database…

这是什么?Pi.Alert 监控你的 Wi-Fi 或局域网,在未知设备接入、已知设备断开或受监控的网站服务宕机时向你告警。它还会为你配置的网站服务检查 HTTP 状态、响应时间和 SSL 证书。
这是后台服务,还是我直接交互的东西?它是一个自托管应用,分两部分:一个通过 cron 每五分钟运行一次、扫描网络并发送告警的后端,以及一个用于管理设备、服务和设置的网页界面。
它需要 Pi-hole 或特殊的网络硬件才能工作吗?不需要,核心方法是在局域网上运行 arp-scan,但如果你已经在用 Pi-hole、FRITZ!Box、MikroTik、UniFi、OpenWrt、AsusWRT、pfSense、OPNsense 或 AdGuard Home,它也可以从这些来源拉取数据。
它和原来的 Pi.Alert 项目是同一个吗?不是,这是由另一位作者维护的延续版本;原版 pucherot/Pi.Alert 已无人维护,另一个名为 NetAlertX 的分支则已发展成独立的基于 Docker 的项目。
它是为谁打造的?面向 Homelab 和自托管网络用户,他们想确切知道自己的网络里有哪些设备,并在出现入侵者、服务中断或 SSL 证书即将过期时收到通知。
它支持哪些通知渠道?告警可以通过网页前端、电子邮件、Pushsafer、Pushover、ntfy,或经 Telegram Bot API 的 Telegram 发送。
Pi.Alert-Satellite 是什么?它是一个配套项目,可以扫描另一个独立网段并把结果回传给现有的 Pi.Alert 实例,在你有多个子网时很有用。
登录安全是怎么处理的?安装过程中会自动启用带随机生成密码的登录保护,之后可以用 pialert-cli 工具修改。
网页界面支持多少种语言?界面自带 15 种语言,包括英语、德语、西班牙语、法语、意大利语、波兰语、荷兰语、捷克语、瑞典语、乌克兰语和俄语。
Creator
leiweibau
Size
1.1 GB
Stars
1.2K
Age
4y
Commits · 90 Days