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…

What is this?Pi.Alert watches your Wi-Fi or LAN and alerts you when an unknown device connects, a known device disconnects, or a monitored web service goes down. It also checks HTTP status, response time, and SSL certificates for web services you configure.
Is this a background service or something I interact with directly?It is a self-hosted app with two parts: a backend that runs via cron every five minutes to scan the network and send alerts, and a web interface for managing devices, services, and settings.
Does it need Pi-hole or special network hardware to work?No, the core method is arp-scan on the local network, but it can also pull data from Pi-hole, FRITZ!Box, MikroTik, UniFi, OpenWrt, AsusWRT, pfSense, OPNsense, or AdGuard Home if you already run those.
Is this the same as the original Pi.Alert project?No, this is a continuation maintained by a different author; the original pucherot/Pi.Alert is now unmaintained, and another fork called NetAlertX has become an independent Docker-based project.
Who is this built for?Homelab and self-hosted-network users who want to know exactly what devices are on their network and get notified about intruders, outages, or expiring SSL certificates.
What notification channels does it support?Alerts can go through the web frontend, email, Pushsafer, Pushover, ntfy, or Telegram via the Telegram Bot API.
What is Pi.Alert-Satellite?It is a companion project that can scan an additional, separate network segment and send its results back to an existing Pi.Alert instance, useful when you have multiple subnets.
How is login security handled?Login protection with a randomly generated password is enabled automatically during installation and can later be changed with the pialert-cli tool.
How many languages does the web interface support?The interface ships in 15 languages, including English, German, Spanish, French, Italian, Polish, Dutch, Czech, Swedish, Ukrainian, and Russian.
Creator
leiweibau
Size
1.1 GB
Stars
1.2K
Age
4y
Commits · 90 Days