183 lines
No EOL
6.8 KiB
Markdown
183 lines
No EOL
6.8 KiB
Markdown
<h1><a href="https://github.com/aceberg/WatchYourLAN">
|
|
<img src="https://raw.githubusercontent.com/aceberg/WatchYourLAN/main/assets/logo.png" width="20" />
|
|
</a>WatchYourLAN</h1>
|
|
<br/>
|
|
|
|
[](https://github.com/aceberg/WatchYourLAN/actions/workflows/main-docker-all.yml)
|
|
[](https://goreportcard.com/report/github.com/aceberg/WatchYourLAN)
|
|
[](https://codeclimate.com/github/aceberg/WatchYourLAN/maintainability)
|
|
|
|
|
|
|
|
Lightweight network IP scanner with web GUI. Features:
|
|
- Send notification when new host is found
|
|
- Monitor hosts online/offline history
|
|
- Keep a list of all hosts in the network
|
|
- Send data to `InfluxDB2` to make a `Grafana` dashboard
|
|
|
|
> [!WARNING]
|
|
> This is version 2.0. Version 1.0 can be found in this brunch: [v1](https://github.com/aceberg/WatchYourLAN/tree/v1)
|
|
|
|
> [!CAUTION]
|
|
> **BREAKING CHANGES!** Version 2.0 is not compatible with v1.0. For now v2.0 docker images will be released under `v2` tag. It will be tagged `latest` in a few weeks (probably, in October).
|
|
|
|
|
|
|
|
## More screenshots
|
|
|
|
<details>
|
|
<summary>Expand</summary>
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
## Quick start
|
|
|
|
<details>
|
|
<summary>Expand</summary>
|
|
|
|
Replace `$YOURTIMEZONE` with correct time zone and `$YOURIFACE` with network interface you want to scan. Network mode must be `host`. Set `$DOCKERDATAPATH` for container to save data:
|
|
|
|
```sh
|
|
docker run --name wyl \
|
|
-e "IFACES=$YOURIFACE" \
|
|
-e "TZ=$YOURTIMEZONE" \
|
|
--network="host" \
|
|
-v $DOCKERDATAPATH/wyl:/data/WatchYourLAN \
|
|
aceberg/watchyourlan:v2
|
|
```
|
|
Web GUI should be at http://localhost:8840
|
|
|
|
</details>
|
|
|
|
## Config
|
|
<details>
|
|
<summary>Expand</summary>
|
|
|
|
Configuration can be done through config file, GUI or environment variables
|
|
|
|
### Basic config
|
|
| Variable | Description | Default |
|
|
| -------- | ----------- | ------- |
|
|
| TZ | Set your timezone for correct time | |
|
|
| HOST | Listen address | 0.0.0.0 |
|
|
| PORT | Port for web GUI | 8840 |
|
|
| THEME | Any theme name from https://bootswatch.com in lowcase or [additional](https://github.com/aceberg/aceberg-bootswatch-fork) | sand |
|
|
| COLOR | Background color: light or dark | dark |
|
|
| NODEPATH | Path to local node modules | |
|
|
| SHOUTRRR_URL | Link 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) | |
|
|
|
|
### Scan settings
|
|
| Variable | Description | Default |
|
|
| -------- | ----------- | ------- |
|
|
| IFACES | Interfaces to scan. Could be one or more, separated by space. Currently `docker0` is not supported, as `arp-scan` wouldn't work with it correctly | |
|
|
| TIMEOUT | Time between scans (seconds) | 120 |
|
|
| ARP_ARGS | Arguments for `arp-scan`. See `man arp-scan` for more. Enable `debug` log level to see resulting command. (Example: `-r 1`) | |
|
|
| LOG_LEVEL | Log level: `debug`, `info`, `warn` or `error` | info |
|
|
| TRIM_HIST | Remove history after (hours) | 48 |
|
|
| HIST_IN_DB | Store History in DB - if `false`, the History will be stored only in memory and will be lost on app restart. Though, it will keep the app DB smaller (and InfluxDB is recommended for long term History storage) | false |
|
|
| USE_DB | Either `sqlite` or `postgres` | sqlite |
|
|
| PG_CONNECT | Address to connect to PostgreSQL. (Example: `postgres://username:password@192.168.0.1:5432/dbname?sslmode=disable`). Full list of URL parameters [here](https://pkg.go.dev/github.com/lib/pq#hdr-Connection_String_Parameters) | |
|
|
|
|
### InfluxDB2 config
|
|
This config matches Grafana's config for InfluxDB data source
|
|
|
|
| Variable | Description | Default | Example |
|
|
| -------- | ----------- | ------- | ------- |
|
|
| INFLUX_ENABLE | Enable export to InfluxDB2 | false | true |
|
|
| INFLUX_SKIP_TLS | Skip TLS Verify | false | true |
|
|
| INFLUX_ADDR | Address:port of InfluxDB2 server | | https://192.168.2.3:8086/ |
|
|
| INFLUX_BUCKET | InfluxDB2 bucket | | test |
|
|
| INFLUX_ORG | InfluxDB2 org | | home |
|
|
| INFLUX_TOKEN | Secret token, generated by InfluxDB2 | | |
|
|
|
|
</details>
|
|
|
|
## Config file
|
|
|
|
<details>
|
|
<summary>Expand</summary>
|
|
|
|
Config file name is `config_v2.yaml`. Example:
|
|
|
|
```yaml
|
|
arp_args: ""
|
|
color: dark
|
|
hist_in_db: false
|
|
host: 0.0.0.0
|
|
ifaces: enp4s0
|
|
influx_addr: ""
|
|
influx_bucket: ""
|
|
influx_enable: false
|
|
influx_org: ""
|
|
influx_skip_tls: false
|
|
influx_token: ""
|
|
log_level: info
|
|
nodepath: ""
|
|
pg_connect: ""
|
|
port: "8840"
|
|
shoutrrr_url: "gotify://192.168.0.1:8083/AwQqpAae.rrl5Ob/?title=Unknown host detected&DisableTLS=yes"
|
|
theme: sand
|
|
timeout: 60
|
|
trim_hist: 48
|
|
use_db: sqlite
|
|
```
|
|
|
|
</details>
|
|
|
|
## Options
|
|
|
|
<details>
|
|
<summary>Expand</summary>
|
|
|
|
| Key | Description | Default |
|
|
| -------- | ----------- | ------- |
|
|
| -d | Path to config dir | /data/WatchYourLAN |
|
|
| -n | Path to node modules (see below) | |
|
|
|
|
</details>
|
|
|
|
## Local network only
|
|
<details>
|
|
<summary>Expand</summary>
|
|
|
|
By default, this app pulls themes, icons and fonts from the internet. But, in some cases, it may be useful to have an independent from global network setup. I created a separate [image](https://github.com/aceberg/my-dockerfiles/tree/main/node-bootstrap) with all necessary modules and fonts.
|
|
Run with Docker:
|
|
```sh
|
|
docker run --name node-bootstrap \
|
|
-p 8850:8850 \
|
|
aceberg/node-bootstrap
|
|
```
|
|
```sh
|
|
docker run --name wyl \
|
|
-e "IFACES=$YOURIFACE" \
|
|
-e "TZ=$YOURTIMEZONE" \
|
|
--network="host" \
|
|
-v $DOCKERDATAPATH/wyl:/data/WatchYourLAN \
|
|
aceberg/watchyourlan:v2 -n "http://$YOUR_IP:8850"
|
|
```
|
|
Or use [docker-compose](docker-compose-local.yml)
|
|
|
|
</details>
|
|
|
|
## API
|
|
|
|
<details>
|
|
<summary>Expand</summary>
|
|
|
|
Moved to [docs/API.md](./docs/API.md)
|
|
</details>
|
|
|
|
## Thanks
|
|
<details>
|
|
<summary>Expand</summary>
|
|
|
|
- All go packages listed in [dependencies](https://github.com/aceberg/WatchYourLAN/network/dependencies)
|
|
- Favicon and logo: [Access point icons created by Freepik - Flaticon](https://www.flaticon.com/free-icons/access-point)
|
|
- [Bootstrap](https://getbootstrap.com/)
|
|
- Themes: [Free themes for Bootstrap](https://bootswatch.com)
|
|
|
|
</details> |