mirror/ lanwatch
1
1
Fork 0
mirror of https://github.com/BillDietrich/lanwatch.git synced 2024-05-09 15:46:04 +02:00
Code Issues Releases Activity

test on Ubuntu, fix various README things

This commit is contained in:
BillDietrich 2020-05-22 18:28:10 +02:00
parent 8b783fee86
commit 10858091bd
2 changed files with 20 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -11,6 +11,10 @@ https://github.com/BillDietrich/lanwatch
In the GitHub repo, click the "Clone or download" button, then click the "Download ZIP" button. Save the ZIP file to disk.
#### On Linux
Copy files lanwatch.py and lanwatch-MACVendors.csv from the ZIP file to /usr/local/bin
```bash
sudo cp lanwatch.py /usr/local/bin
sudo cp lanwatch-MACVendors.csv /usr/local/bin
```
#### On Windows 10
Copy files lanwatch.cmd and lanwatch.py and lanwatch-MACVendors.csv from the ZIP file to some folder.
@ -33,11 +37,10 @@ sudo apt-get install smbclient
pip3 install plyer
pip3 install scapy
pip3 install smbprotocol
```
If you want to do desktop notifications, you must also:
```bash
sudo -H pip3 install plyer
sudo -H pip3 install scapy
sudo -H pip3 install smbprotocol
```
#### On Windows 10
@ -119,9 +122,13 @@ Edit lanwatch.py to set gsUIChoice to "syslog".
You will see reports in the system log:
For Linux, to see output, on command-line do
For Linux, to see output for new devices, on command-line do
```bash
sudo journalctl | grep lanwatch
sudo journalctl | grep lanwatch.py
```
Or to see the whole list of known devices, with newest at end, do
```bash
cat /usr/local/bin/lanwatch.csv
```
For Win10, to see output, run Event Viewer application. Look in administrative events from Applications, and look for events with Origin "lanwatch".
@ -146,13 +153,15 @@ Double-click on lanwatch.cmd file.
#### From a Linux systemd service started at system boot time
```bash
sudo cp lanwatch.py /usr/local/bin # you may have done this already
sudo edit /usr/local/bin/lanwatch.py # to set gsUIChoice to "syslog".
sudo edit /usr/local/bin/lanwatch.py # to set gsUIChoice to "syslog", and add "/usr/local/bin/" to filenames
sudo cp lanwatch.service /etc/systemd/system
sudo systemctl enable lanwatch
sudo systemctl start lanwatch
```
After rebooting, when desired to see if there are any new devices, on command-line do
When desired to see if there are any new devices, on command-line do
```bash
sudo journalctl | grep lanwatch
sudo journalctl | grep lanwatch.py
```
#### From a Windows 10 task started when you log in
@ -178,11 +187,10 @@ sudo journalctl | grep lanwatch
* Not tested on a LAN with no internet access.
* Requires Python 3.3 or greater.
* Polls every 5 minutes, so a quick, transient device appear/disappear probably won't be detected.
* Doesn't get host names automatically.
* Doesn't get host names automatically, except for the local machine.
## To-Do
* Desktop notifications don't work because of sudo.
* Automatically set host names of at least this machine and the router.
* Find a way to get host names automatically.
---

4
lanwatch.py
View File

@ -33,9 +33,9 @@
# edit these to change the behavior of the app
gsIPRange = '192.168.0.0/24' # "/24" means "first 24 bits are constant"
gsIPRange = '192.168.0.0/16' # "/16" means "first 16 bits are constant"
gsUIChoice = 'stdout' # one or more of: notification syslog stdout
gsUIChoice = 'notification' # one or more of: notification syslog stdout
# file of machines seen on the LAN; read and written by this application
gsDatabaseFilename = 'lanwatch.csv'