From 78772e9238ddc93d41e07cbc944ee2464459322a Mon Sep 17 00:00:00 2001
From: aceberg <1502200+aceberg@users.noreply.github.com>
Date: Mon, 2 Sep 2024 19:51:49 +0700
Subject: [PATCH] Vlan README

---
 CHANGELOG.md          |  1 +
 docs/VLAN_ARP_SCAN.md | 47 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 48 insertions(+)
 create mode 100644 docs/VLAN_ARP_SCAN.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index b422a99..09de4f2 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -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
diff --git a/docs/VLAN_ARP_SCAN.md b/docs/VLAN_ARP_SCAN.md
new file mode 100644
index 0000000..ff33f4a
--- /dev/null
+++ b/docs/VLAN_ARP_SCAN.md
@@ -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"
+```
\ No newline at end of file