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

Vlan README

Browse source
This commit is contained in:
aceberg 2024-09-02 19:51:49 +07:00
parent 74b1b3cb2e
commit 78772e9238
2 changed files with 48 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -8,6 +8,7 @@ All notable changes to this project will be documented in this file.
### Fixed
- Bug [#103](https://github.com/aceberg/WatchYourLAN/issues/103)
- Bug [#104](https://github.com/aceberg/WatchYourLAN/issues/104)
## [v2.0.0] - 2024-08-30
### Added

47
docs/VLAN_ARP_SCAN.md Normal file
View file

@ -0,0 +1,47 @@
## Passing arguments to arp-scan
### 1. IFACES
`IFACES` is a required variable for WYL to work. It can be set through GUI, config file or environment variables.
`IFACES` is a list of network interfaces to scan, space separated. For example
```sh
IFACES: "enp4s0 wlxf4ec3892dd51"
```
You can get a list of network interfaces by running `ip link show` or `netstat -i`.
By default, the scan command will look like this:
```sh
arp-scan -glNx -I $ONE_IFACE
```
### 2. ARP_ARGS
Setting `ARP_ARGS` is optional. It can be set through GUI, config file or environment variables.
`ARP_ARGS` is additional arguments for `arp-scan`, that will be applied for **every** one of `IFACES`. For example:
```sh
ARP_ARGS: "-r 1"
```
```sh
arp-scan -glNx -r 1 -I $ONE_IFACE
```
See `man arp-scan` for all arguments available.
### 3. ARP_STRS
If `ARP_STRS` is set, it will initiate a completely separate from `IFACES` scan.
> [!WARNING]
> `ARP_STRS` can be set only through GUI or config file. For environment (docker-compose) see `ARP_STRS_JOINED`.
`ARP_STRS` is a list of strings. `arp-scan` will run for each of them:
```sh
arp-scan $ONE_STRING
```
Every string must contain all information you need to pass to `arp-scan`. For example:
```sh
arp-scan -gNx 10.0.107.0/24 -Q 107 -I eth0
```
Where `-Q` is a `vlan` id. **Warning:** the last element of string (`eth0` in this example) will be set as `Interface` for found hosts, so it is recommended to put interface at the end.
### 4. ARP_STRS_JOINED
`ARP_STRS_JOINED` is a way to set `ARP_STRS` from ENV. It's a list of strings, comma separated, without spaces before or after comma.
```sh
ARP_STRS_JOINED: "-glNx -I enp1s0,-glNx -I enp1s0"
```