How to set up WatchYourLAN with Docker Compose?

Use the provided docker-compose-auth.yml for authentication setups or adapt the standard docker-compose.yml. Ensure network mode is set to host and configure environment variables like IFACES and TZ as per the Quick start guide.

WatchYourLAN vs. Nmap: which is better for home network monitoring?

WatchYourLAN is designed for continuous, automated monitoring with a web GUI and alerts, while Nmap is ideal for on-demand scans and security auditing. For persistent device tracking in homelabs, WatchYourLAN's integrations and ease of use make it more suitable.

How to configure Telegram notifications in WatchYourLAN?

Set the SHOUTRRR_URL in the config to a Telegram bot token and chat ID using the Shoutrrr format. Refer to the config table for examples and the linked Shoutrrr documentation for precise URL formatting.

Does WatchYourLAN support IPv6 scanning?

The README doesn't mention IPv6 support; it relies on ARP scanning, which is typically for IPv4. For IPv6 networks, additional configuration or external tools might be needed, limiting its compatibility.

How to export data from WatchYourLAN to Prometheus?

Enable PROMETHEUS_ENABLE in the config and set it to true. The /metrics endpoint will then be available, allowing Prometheus to scrape data directly, as detailed in the Prometheus config section.

Can WatchYourLAN run on a Raspberry Pi?

Yes, supported architectures include arm_v5 to arm64, with packages like .apk for Alpine Linux. Install via the provided binaries or Docker, ensuring arp-scan and tzdata dependencies are met for your Pi's OS.

WatchYourLAN — Lightweight Network IP Scanner

What is WatchYourLAN?

WatchYourLAN is a lightweight network IP scanner that discovers and monitors devices on a local network via ARP scanning. It provides a web GUI to view connected hosts, track their online/offline history, and send notifications for new devices. The tool can export data to InfluxDB2 or Prometheus for integration with Grafana dashboards.

Target Audience

Home lab enthusiasts, small network administrators, and developers who need a simple, self-hosted solution for monitoring devices on their local network.

Value Proposition

Developers choose WatchYourLAN for its lightweight design, easy self-hosting via Docker, and seamless integration with Grafana for data visualization, all without the overhead of commercial network monitoring tools.

Lightweight network IP scanner written in Go. With notifications, history, export to Grafana

Use Cases

Best For

Monitoring devices on a home or lab network
Sending alerts when unknown devices join the network
Tracking device uptime and connectivity history
Visualizing network activity in Grafana dashboards
Self-hosting a network scanner without cloud dependencies
Integrating network monitoring into a homelab setup

Not Ideal For

Large enterprise networks requiring scalable, multi-vendor monitoring with SNMP or advanced protocols.
Environments needing real-time, sub-second device detection and instant alerting for security incidents.
Deployments where built-in user authentication and role-based access control are mandatory for compliance.
Teams operating exclusively on Windows or macOS without Linux or Docker infrastructure.

Pros & Cons

Pros

Easy Docker Deployment

The Quick start section provides a simple Docker run command with host network mode, making setup straightforward for homelabs without complex configuration.

Multi-Platform Notifications

Integrates Shoutrrr for alerts to Discord, Email, Telegram, and more, with configurable URLs as shown in the config table, offering flexibility for various alerting needs.

Grafana Visualization Ready

Exports data to InfluxDB2 or Prometheus, enabling custom Grafana dashboards for network monitoring, detailed in the config section with specific variables for integration.

Lightweight and Self-Hosted

Written in Go and prioritized for simplicity, it runs via binaries or containers without cloud dependencies, aligning with its philosophy of minimal overhead.

Cons

No Built-in Authentication

The Auth section explicitly states that WatchYourLAN lacks built-in auth, requiring external SSO tools or firewall measures, which adds complexity and potential security risks.

Host Network Mode Required

For Docker deployments, it must use host network mode, exposing ports and complicating secure containerization, as warned in the setup with firewall recommendations.

External Asset Dependencies

Pulls themes and fonts from the internet by default, necessitating a separate container for offline use, as described in the Local network only section, adding to deployment overhead.

Basic Scanning Capabilities

Relies solely on ARP scanning with limited customization via arp-scan arguments, which may not suffice for complex networks, VLANs, or advanced monitoring scenarios without manual tweaks.

Frequently Asked Questions

What is WatchYourLAN?

Target Audience

Home lab enthusiasts, small network administrators, and developers who need a simple, self-hosted solution for monitoring devices on their local network.

Value Proposition

Use Cases

Best For

Monitoring devices on a home or lab network
Sending alerts when unknown devices join the network
Tracking device uptime and connectivity history
Visualizing network activity in Grafana dashboards
Self-hosting a network scanner without cloud dependencies
Integrating network monitoring into a homelab setup

Not Ideal For

Large enterprise networks requiring scalable, multi-vendor monitoring with SNMP or advanced protocols.
Environments needing real-time, sub-second device detection and instant alerting for security incidents.
Deployments where built-in user authentication and role-based access control are mandatory for compliance.
Teams operating exclusively on Windows or macOS without Linux or Docker infrastructure.

Pros & Cons

Pros

Easy Docker Deployment

The Quick start section provides a simple Docker run command with host network mode, making setup straightforward for homelabs without complex configuration.

Multi-Platform Notifications

Integrates Shoutrrr for alerts to Discord, Email, Telegram, and more, with configurable URLs as shown in the config table, offering flexibility for various alerting needs.

Grafana Visualization Ready

Exports data to InfluxDB2 or Prometheus, enabling custom Grafana dashboards for network monitoring, detailed in the config section with specific variables for integration.

Lightweight and Self-Hosted

Written in Go and prioritized for simplicity, it runs via binaries or containers without cloud dependencies, aligning with its philosophy of minimal overhead.

Cons

No Built-in Authentication

The Auth section explicitly states that WatchYourLAN lacks built-in auth, requiring external SSO tools or firewall measures, which adds complexity and potential security risks.

Host Network Mode Required

For Docker deployments, it must use host network mode, exposing ports and complicating secure containerization, as warned in the setup with firewall recommendations.

External Asset Dependencies

Pulls themes and fonts from the internet by default, necessitating a separate container for offline use, as described in the Local network only section, adding to deployment overhead.

Basic Scanning Capabilities

Relies solely on ARP scanning with limited customization via arp-scan arguments, which may not suffice for complex networks, VLANs, or advanced monitoring scenarios without manual tweaks.

Frequently Asked Questions

WatchYourLAN

What is WatchYourLAN?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

WatchYourLAN

What is WatchYourLAN?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?