Skip to content

NetAlertX: Network Intruder and Presence Detector

Original URL

GitHub - jokob-sk/NetAlertX

Introduction

NetAlertX is a comprehensive network intruder and presence detection framework designed to provide visibility and security for devices on your Wi-Fi or LAN network. It actively scans for connected devices and alerts users if new or unknown devices are detected, making it an essential tool for network management and security. With features such as automated scanning, alert notifications, and plugin support, NetAlertX serves both personal and organizational needs in monitoring network activity.

Key Features

Scanning Capabilities

  • Device Detection: Identifies new and reconnections of existing devices, along with disconnections and IP changes.
  • Methods of Discovery:
  • arp-scan
  • Pi-hole DB import
  • Pi-hole DHCP leases import
  • Generic DHCP leases import
  • UNIFI controller integration
  • SNMP-enabled router import

Notification Gateways

  • Sends alerts through over 80 services, including:
  • Telegram (via Apprise)
  • Pushsafer
  • Pushover
  • NTFY publishers

Integration and Plugins

  • Home Assistant Integration: Seamlessly feeds data and device changes into Home Assistant.
  • Webhooks: Set up custom automation flows with API endpoints.
  • Custom Plugin Development: Build your own scanners or plugins in approximately 15 minutes for tailored functionality.

Workflows Module

  • Automates repetitive tasks in network management, allowing for:
  • Automatic assignment of newly discovered devices
  • Device grouping based on vendor
  • Online status detection and auto unarchiving of devices
  • Automatic deletion of devices no longer online

Installation

NetAlertX is designed for ease of installation across multiple platforms: - Docker: Quick deployment using Docker containers. - Home Assistant: Integration with Home Assistant installations. - Bare Metal: Standard installation methods for direct server setups. - Unraid App: Simplified setup for Unraid users.

Supported Browsers

NetAlertX is compatible with: - Chrome - Firefox

Documentation and Support

Comprehensive documentation is available for: - Installation processes - Configuration and usage - Development of custom plugins and API interactions

Users can stay informed about new features, breaking changes, and release notifications via email.

Alternatives

Some alternative applications offering similar functionalities include: - PiAlert: A maintained bare-metal installation of a network scanner. - WatchYourLAN: A lightweight IP scanner with a web GUI. - Fing: A commercial network scanning app designed for mobile devices. - NetBox: A commercial network management tool.

Conclusion

NetAlertX emerges as a robust solution for anyone needing to monitor their network for unauthorized access or changes in device status. With its rich feature set, extensive integration options, and the ability to automate various tasks, it positions itself as a valuable tool for both individual and enterprise users. The supportive community and continuous updates ensure it remains a relevant choice for network security enthusiasts.

For further information, documentation, and visual aids, visit the official NetAlertX website.