NetAlertX

🛡️ Core Capabilities

• Presence Detection: Tracks known devices and alerts when they disconnect, reconnect, or go offline.
• Intruder Detection: Scans for unknown or unauthorized devices joining your network.
• Scheduled & Ad-Hoc Scans: Supports regular scans or manual triggers to check for changes.
• Multi-Network Support: Can monitor multiple subnets and VLANs simultaneously.
• Plugin System: Extensible via custom plugins for scanners, publishers, and automation workflows.
• Auto-Generated UI: Plugin settings and data are rendered automatically via JSON manifests.

📡 Scanners & Integrations

• Built-in Scanners: Includes ARP scan, Nmap, NBTSCan, Avahi, and more.
• Notification Gateways: Supports over 80 services via Apprise, including:
• Email
• Telegram
• Discord
• Pushover
• Webhooks
• Automation Platforms: Integrates with Home Assistant, Unraid, and other systems.

🖥️ Interface & Visualization

• Web UI: Clean dashboard with device status, history, and scan controls.
• Topology Mapping: Auto-generates network diagrams based on MAC vendor and IP relationships.
• Customizable Views: UI elements can be tailored per plugin or user preference.

🚀 Docker Installation Steps

1. Update your system
   sudo apt update && sudo apt upgrade -y
2. Install Docker
   

   curl -fsSL https://get.docker.com -o get-docker.sh
   sudo sh get-docker.sh

3. Install Docker Compose
   sudo apt install docker-compose-plugin
4. Add your user to the Docker group
   sudo usermod -aG docker $USER
5. Enable Docker at boot
   sudo systemctl enable docker
6. Reboot
   sudo reboot
7. Test Docker
   docker run hello-world

📁 Setup NetAlertX

mkdir ~/docker
mkdir ~/docker/netalertx

🧾 Docker Compose File

In ~/docker/netalertx, on the source and target devices, create docker-compose.yml

  services:
  netalertx:
     image: jokobsk/netalertx:latest
     container_name: netalertx
     network_mode: host
     security_opt:
      - no-new-privileges:true
     cap_drop:
      - ALL                  
     cap_add:
      - NET_RAW
      - NET_ADMIN
      - NET_BIND_SERVICE
     volumes:
      - ~/docker/netalertx/data:/data:rw
      - /etc/localtime:/etc/localtime:ro
     tmpfs:
      - "/tmp:uid=20211,gid=20211,mode=1777,rw,noexec,nosuid,nodev,async,noatime,nodiratime"
     environment:
      PORT: 9996
     restart: on-failure:5

▶️ Start NetAlertX

From within ~/docker/netalertx:

📜 View Logs

🌐 Access Web Interface

Open your browser and go to "http://<SOURCE_DEVICE>:9996. When you click on Network on the left hand side, it will scan your network. This never finished on mine but when I browsed to Devices, it was populated with my network devices.