Scanner IP réseau léger avec interface graphique Web. Caractéristiques:
Envoyer une notification lorsqu'un nouvel hôte est trouvé
Surveiller l'historique en ligne/hors ligne des hôtes
Conserver une liste de tous les hôtes du réseau
Envoyer des données à InfluxDB2
pour créer un tableau de bord Grafana
Remplacez $YOURTIMEZONE
par le fuseau horaire correct et $YOURIFACE
par l'interface réseau que vous souhaitez analyser. Le mode réseau doit être host
. Définissez $DOCKERDATAPATH
pour que le conteneur enregistre les données :
docker run --nom wyl -e "IFACES=$VOTREIFACE" -e "TZ=$VOTREZONE TEMPS" --network="hôte" -v $DOCKERDATAPATH/wyl:/data/WatchYourLAN aceberg/watchyourlan
L'interface graphique Web doit être à l'adresse http://localhost:8840
WatchYourLAN n'a pas d'option d'authentification intégrée. Mais vous pouvez l'utiliser avec des outils SSO comme Authelia ou ma simple application d'authentification ForAuth.
Voici un exemple docker-compose-auth.yml.
⚠️ AVERTISSEMENT!
N'oubliez pas que WYL a besoin du mode réseauhost
pour fonctionner. Ainsi, le port WYL sera exposé dans cette configuration. Vous devez en limiter l'accès avec un pare-feu ou d'autres mesures.
Tous les packages binaires peuvent être trouvés dans la dernière version. Il existe des fichiers .deb
, .rpm
, .apk
(Alpine Linux) et .tar.gz
.
Architectures prises en charge : amd64
, i386
, arm_v5
, arm_v6
, arm_v7
, arm64
.
Dépendances : arp-scan
, tzdata
.
Pour amd64
un dépôt deb
est disponible
La configuration peut être effectuée via un fichier de configuration, une interface graphique ou des variables d'environnement. Les noms de variables du fichier config_v2.yaml
sont les mêmes, mais en minuscules.
Variable | Description | Défaut |
---|---|---|
TZ | Réglez votre fuseau horaire pour l'heure correcte | |
HÔTE | Adresse d'écoute | 0.0.0.0 |
PORT | Port pour l'interface graphique Web | 8840 |
THÈME | Tout nom de thème de https://bootswatch.com en minuscules ou supplémentaires | sable |
COULEUR | Couleur de fond : clair ou foncé | sombre |
CHEMIN DE NŒUD | Chemin d'accès aux modules de nœuds locaux | |
SHOUTRRR_URL | WatchYourLAN utilise Shoutrrr pour envoyer des notifications. Il est déjà intégré, il suffit d'une URL correcte. Des exemples pour Discord, Email, Gotify, Matrix, Ntfy, Pushover, Slack, Telegram, Generic Webhook, etc. sont ici |
Variable | Description | Défaut |
---|---|---|
IFACES | Interfaces à scanner. Il peut y en avoir un ou plusieurs, séparés par un espace. Voir docs/VLAN_ARP_SCAN.md. | |
TEMPS MORT | Temps entre les analyses (secondes) | 120 |
ARP_ARGS | Arguments pour arp-scan . Activez le niveau de journalisation debug pour voir la commande résultante. (Exemple : -r 1 ). Voir docs/VLAN_ARP_SCAN.md. | |
ARP_STRS ARP_STRS_JOINED | Voir docs/VLAN_ARP_SCAN.md. | |
LOG_LEVEL | Niveau de journalisation : debug , info , warn ou error | infos |
TRIM_HIST | Supprimer l'historique après (heures) | 48 |
HIST_IN_DB | Stocker l'historique dans la base de données - si false , l'historique sera stocké uniquement en mémoire et sera perdu au redémarrage de l'application. Cependant, cela réduira la taille de la base de données de l'application (et InfluxDB est recommandé pour le stockage de l'historique à long terme) | FAUX |
USE_DB | Soit sqlite , soit postgres | SQLite |
PG_CONNECT | Adresse pour se connecter à PostgreSQL. (Exemple : postgres://username:[email protected]:5432/dbname?sslmode=disable ). Liste complète des paramètres d'URL ici |
Cette configuration correspond à la configuration de Grafana pour la source de données InfluxDB
Variable | Description | Défaut | Exemple |
---|---|---|---|
INFLUX_ENABLE | Activer l'exportation vers InfluxDB2 | FAUX | vrai |
INFLUX_SKIP_TLS | Ignorer la vérification TLS | FAUX | vrai |
INFLUX_ADDR | Adresse : port du serveur InfluxDB2 | https://192.168.2.3:8086/ | |
INFLUX_BUCKET | Compartiment InfluxDB2 | test | |
INFLUX_ORG | Organisation InfluxDB2 | maison | |
INFLUX_TOKEN | Jeton secret, généré par InfluxDB2 |
Le nom du fichier de configuration est config_v2.yaml
. Exemple:
arp_args: "" Color: darkhist_in_db: falsehost: 0.0.0.0ifaces: enp4s0influx_addr: "" afflux_bucket: "" afflux_enable: fauxflux_org: "" afflux_skip_tls: "pg_c_c screamrrr_url : "gotify://192.168.0.1:8083/AwQqpAae.rrl5Ob/?title=Hôte inconnu détecté&DisableTLS=yes"thème : sandtimeout : 60trim_hist : 48use_db : sqlite
Clé | Description | Défaut |
---|---|---|
-d | Chemin vers le répertoire de configuration | /data/SurveillezVotreLAN |
-n | Chemin d'accès aux modules de nœuds (voir ci-dessous) |
Par défaut, cette application extrait des thèmes, des icônes et des polices d'Internet. Mais, dans certains cas, il peut être utile de disposer d’une configuration indépendante du réseau mondial. J'ai créé une image séparée avec tous les modules et polices nécessaires. Exécuter avec Docker :
docker run --name nœud-bootstrap -p8850:8850 aceberg/noeud-bootstrap
docker run --nom wyl -e "IFACES=$VOTREIFACE" -e "TZ=$VOTREZONE TEMPS" --network="hôte" -v $DOCKERDATAPATH/wyl:/data/WatchYourLAN aceberg/watchyourlan -n "http://$VOTRE_IP:8850"
Ou utilisez docker-compose
Déplacé vers docs/API.md
Client API Python par drwahl
Tous les packages Go répertoriés dans les dépendances
Favicon et logo : Icônes de point d'accès créées par Freepik - Flaticon
Amorçage
Thèmes : thèmes gratuits pour Bootstrap