cyberes
/
wlan2eth
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

expand readme

This commit is contained in:
Cyberes 2023-06-13 17:01:10 -06:00
parent 54ebfd1822
commit af84822358
Signed by: cyberes
GPG Key ID: 6B4A33836A9500FE
1 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,12 +1,32 @@
# wlan2eth
*Transparently bridge your WiFi connection to your Ethernet interface.*
_Transparently bridge your WiFi connection to your Ethernet interface._
This is a wireless to Ethernet router that bridges traffic from your wireless network to a wired client. The router creates a private LAN and clones the client's MAC address to its wired interface to get an IP from the DHCP server. All ports are forwarded to the client so traffic can flow in both directions.
This is about as transparent as you can get without using custom software, messy hacks, or a Wireless Distribution System (WDS).
## Install
Copy `config/config.sh.example` to `config/config.sh` and edit the file.
This service was developed for Ubuntu but will likely work with other Linux versions as well.
First, copy `config/config.sh.example` to `config/config.sh` and edit the file.
Then run `sudo ./bridge-install.sh` and everything will be set up the way it needs to be. This should be installed on a fresh machine. The install script is safe to run as many times as you need to.
The current folder will be copied to `/opt/wlan2eth` and chown-ed to `root`.
Once the install script has finished, reboot and you're good to go!
## Use
To bridge your wired client to your WiFi network, simply plug it into the port you specified in `ETH_IFACE`. Wait a few seconds for the bridge to configure itself and once your client is given the IP `192.168.2.2`, you're good to go.
The bridge watches the status of the wired interface and when it is unplugged it will reset itself and wait for reconnection. It waits for its wireless interface to get an IP from DHCP before continuing so if you notice the bridge isn't giving your client an IP, check the bridge's WiFi connection.
The bridge device forwards all ports to your client, except the port specified in `ROUTER_SSH_PORT` (default is `64535`). This is the bridge's SSH server.
To access the bridge over SSH, do `ssh [username]@[IP] -P [ROUTER_SSH_PORT]`. You can use the command `sudo journalctl -b -f -u wlan2eth` to view the bridge logs.
## To Do
- [ ] forward multicast traffic from the WLAN?