aceberg / WatchYourLAN

Lightweight network IP scanner with web GUI

self-hosted docker selfhosted golang gui arp-scan

WatchYourLAN

WatchYourLAN is a lightweight, web-based IP scanner written in Go which allows you to monitor your network for new devices. It is completely self-hosted and can be deployed on any Linux system.

Features

Lightweight and fast
Web-based GUI
Supports multiple network interfaces
Scans for devices using ARP
Detects new devices and displays their MAC address, IP address, and hostname
Sends notifications when new devices are detected (via email, webhooks, or Pushover)
Docker image available

Installation

To install WatchYourLAN, simply download the latest binary from the releases page and run it with root privileges.

wget https://github.com/zdenek-svoboda/watchyourlan/releases/download/v0.2.0/watchyourlan-linux-amd64
chmod +x watchyourlan-linux-amd64
sudo ./watchyourlan-linux-amd64

Once WatchYourLAN is running, you can access the web interface at http://localhost:8080.

Configuration

WatchYourLAN can be configured using a simple YAML configuration file. The default configuration file is located at /etc/watchyourlan.yaml.

The following options are available:

network_interfaces: A list of network interfaces to scan.
scan_interval: The interval between scans, in seconds.
notification_email: The email address to send notifications to.
notification_webhook: The webhook URL to send notifications to.
notification_pushover_user: Your Pushover user key.
notification_pushover_token: Your Pushover token.

Docker

WatchYourLAN can also be deployed using Docker. To do so, simply run the following command:

docker run -d --name watchyourlan -p 8080:8080 zdeneksvoboda/watchyourlan

Screenshots

WatchYourLAN screenshot

WatchYourLAN notifications screenshot

Contributing

Contributions are welcome! Please read the contributing guidelines before submitting a pull request.