danvics/watchyourlan
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Readme upd

Browse source
This commit is contained in:
aceberg 2023-08-18 20:24:04 +07:00
parent f0e1caa1dd
commit 0ee8f9b6a0
1 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -11,6 +11,7 @@
Lightweight network IP scanner with web GUI Lightweight network IP scanner with web GUI
- [Quick start](https://github.com/aceberg/WatchYourLAN#quick-start) - [Quick start](https://github.com/aceberg/WatchYourLAN#quick-start)
- [Install .deb](https://github.com/aceberg/ppa)
- [Config](https://github.com/aceberg/WatchYourLAN#config) - [Config](https://github.com/aceberg/WatchYourLAN#config)
- [Config file](https://github.com/aceberg/WatchYourLAN#config-file) - [Config file](https://github.com/aceberg/WatchYourLAN#config-file)
- [Options](https://github.com/aceberg/WatchYourLAN#options) - [Options](https://github.com/aceberg/WatchYourLAN#options)
@ -40,20 +41,21 @@ Configuration can be done through config file or environment variables
| Variable | Description | Default | | 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 | | AUTH | Enable Session-Cookie authentication | false |
| AUTH_EXPIRE | Session expiration time. A number and suffix: **m, h, d** or **M**. | 7d |
| AUTH_USER | Username | "" |
| AUTH_PASSWORD | Encrypted password (bcrypt) | "" |
| COLOR | Background color: light or dark | light |
| DBPATH | Path to Database | /data/db.sqlite | | DBPATH | Path to Database | /data/db.sqlite |
| GUIIP | Address for web GUI | localhost (127.0.0.1) | | GUIIP | Address for web GUI | localhost (127.0.0.1) |
| GUIPORT | Port for web GUI | 8840 | | GUIPORT | Port for web GUI | 8840 |
| TIMEOUT | Time between scans (seconds) | 60 (1 minute) | | 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 |
| SHOUTRRR_URL | Url to any notification service supported by [Shoutrrr](https://github.com/containrrr/shoutrrr) (gotify, email, telegram and others) or [Generic Webhook](https://github.com/containrrr/shoutrrr/blob/main/docs/services/generic.md) | "" |
| THEME | Any theme name from https://bootswatch.com in lowcase | solar |
| COLOR | Background color: light or dark | light |
| IGNOREIP | If you want to detect unknown hosts by MAC only, set this wariable to "yes" | no | | IGNOREIP | If you want to detect unknown hosts by MAC only, set this wariable to "yes" | no |
| LOGLEVEL | How much log output you want to see ("short" or "verbose") | verbose | | LOGLEVEL | How much log output you want to see ("short" or "verbose") | verbose |
| AUTH | Enable Session-Cookie authentication | false | | SHOUTRRR_URL | Url to any notification service supported by [Shoutrrr](https://github.com/containrrr/shoutrrr) (gotify, email, telegram and others) or [Generic Webhook](https://github.com/containrrr/shoutrrr/blob/main/docs/services/generic.md) | "" |
| AUTH_USER | Username | "" | | THEME | Any theme name from https://bootswatch.com in lowcase | solar |
| AUTH_PASSWORD | Encrypted password (bcrypt) | "" | | TIMEOUT | Time between scans (seconds) | 60 (1 minute) |
| AUTH_EXPIRE | Session expiration time. A number and suffix: **m, h, d** or **M**. | 7d |
## Config file ## Config file
> [!WARNING] > [!WARNING]