ddidderr/softlan-vpn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: align gateway test command with cli help

Browse Source 
Use the canonical --interface flag in the README and MVP test guide so the
handoff command matches lanparty-gateway --help. Keep --iface documented as the
shorter accepted alias because the CLI and tests still support it.

Test Plan:
- ./target/release/lanparty-gateway --help
- cargo test -p lanparty-gateway accepts_iface_alias_for_gateway_interface
- git diff --check
- git diff --cached --check

Refs: MVP test handoff polish
This commit is contained in:
ddidderr
2026-05-22 06:43:25 +02:00
parent 731336dd5c
commit 6b081f49c4
2 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -1
View File
@@ -173,7 +173,7 @@ cargo run -p lanparty-gateway -- \
--server-name lanparty-relay.local \ --server-name lanparty-relay.local \
--relay-ca-cert relay-cert.der \ --relay-ca-cert relay-cert.der \
--room ROOM1 \ --room ROOM1 \
--iface eth0 --interface eth0
``` ```
The gateway first opens the wired LAN interface as an AF_PACKET socket with The gateway first opens the wired LAN interface as an AF_PACKET socket with
TESTING.md
+4 -3
View File
@@ -90,11 +90,12 @@ sudo ./target/release/lanparty-gateway \
--server-name lanparty-relay.local \ --server-name lanparty-relay.local \
--relay-ca-cert ./relay-cert.der \ --relay-ca-cert ./relay-cert.der \
--room ROOM1 \ --room ROOM1 \
--iface eth0 --interface eth0
``` ```
Use the real wired LAN interface name for `--iface`. Do not use Wi-Fi. The Use the real wired LAN interface name for `--interface`. `--iface` is accepted
gateway fails before joining the relay if sysfs reports no Ethernet carrier. as a shorter alias. Do not use Wi-Fi. The gateway fails before joining the
relay if sysfs reports no Ethernet carrier.
Expected gateway output: Expected gateway output: