No description
Find a file
2022-12-28 22:34:40 +07:00
.github refactor 2022-12-28 22:01:30 +07:00
assets Notifications 2022-08-25 12:24:10 +07:00
cmd/WatchYourLAN new project structure 2022-12-25 23:15:12 +07:00
internal full code refactoring 2022-12-28 22:34:40 +07:00
.gitignore Conf and models 2022-11-16 22:37:54 +07:00
.version IP sort fixed 2022-09-14 20:48:57 +07:00
CHANGELOG.md IP sort fixed 2022-09-14 20:48:57 +07:00
docker-compose.yml Theme config 2022-08-26 16:04:16 +07:00
Dockerfile DB: sort by date 2022-08-24 16:04:28 +07:00
go.mod full code refactoring 2022-12-28 22:34:40 +07:00
go.sum full code refactoring 2022-12-28 22:34:40 +07:00
LICENSE.md Create LICENSE.md 2022-08-23 15:59:53 +07:00
Makefile refactor 2022-12-25 22:52:16 +07:00
README.md full code refactoring 2022-12-28 22:34:40 +07:00


WatchYourLAN

Docker Go Report Card GitHub Docker Image Size (latest semver)

Lightweight network IP scanner with web GUI
https://github.com/aceberg/WatchYourLAN

Screenshot_v0.6

Quick start

Replace $YOURTIMEZONE with correct time zone and $YOURIFACE with network interface you want to scan. Network mode must be host.

docker run --name wyl \
	-e "IFACE=$YOURIFACE" \
	-e "TZ=$YOURTIMEZONE" \
	--network="host" \
    aceberg/watchyourlan

Set $DOCKERDATAPATH for container to save data:

docker run --name wyl \
	-e "IFACE=$YOURIFACE" \
	-e "TZ=$YOURTIMEZONE" \
	--network="host" \
	-v $DOCKERDATAPATH/wyl:/data \
    aceberg/watchyourlan

Web GUI should be at http://localhost:8840

Config

Configuration can be done through config file or environment variables

Variable Description Default
IFACE Interface to scan. Could be one or more, separated by space. Currently docker0 is not allowed, as arp-scan wouldn't work with it correctly enp1s0
DBPATH Path to Database /data/db.sqlite
GUIIP Address for web GUI localhost (127.0.0.1)
GUIPORT Port for web GUI 8840
TIMEOUT Time between scans (seconds) 60 (1 minute)
SHOUTRRR_URL Url to any notification service supported by Shoutrrr (gotify, email, telegram and others) ""
THEME Any theme name from https://bootswatch.com in lowcase solar

Config file

Config file path is /data/config. All variables could be set there. Example:

IFACE="enp2s0 wg0"
DBPATH="/data/hosts.db"
GUIIP="192.168.2.1"     		# To access from LAN
GUIPORT="8840"
TIMEOUT="300"           		# 5 minutes
SHOUTRRR_URL="gotify://192.168.2.1:8083/AwQqpAae.rrl5Ob/?title=Unknown host detected&DisableTLS=yes"	# Url to notify
THEME="darkly"

Thanks