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 через Telegram Bot API.
Что такое Pi.Alert-Satellite?Это сопутствующий проект, который может сканировать дополнительный отдельный сегмент сети и отправлять результаты в существующий экземпляр Pi.Alert — удобно, когда у вас несколько подсетей.
Как устроена защита входа?Защита входа со случайно сгенерированным паролем включается автоматически при установке, а позже её можно изменить инструментом pialert-cli.
Сколько языков поддерживает веб-интерфейс?Интерфейс поставляется на 15 языках, включая английский, немецкий, испанский, французский, итальянский, польский, нидерландский, чешский, шведский, украинский и русский.
Creator
leiweibau
Size
1.1 GB
Stars
1.2K
Age
4y
Commits · 90 Days