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

readme, config docs, installer

This commit is contained in:
Cyberes 2023-06-13 16:13:32 -06:00
parent 217555e786
commit e851416d23
Signed by: cyberes
GPG Key ID: 6B4A33836A9500FE
3 changed files with 27 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1,3 +1,12 @@
# wlan2eth # wlan2eth
*Transparently bridge your WiFi connection to your Ethernet interface.*
Transparently bridge your WiFi connection to your Ethernet interface. ## Install
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!

4
bridge-install.sh
View File

@ -83,13 +83,15 @@ if [ "$DIR" != "$INSTALL_DIR" ]; then
echo -e "\nGoing to copy $DIR to $INSTALL_DIR" echo -e "\nGoing to copy $DIR to $INSTALL_DIR"
read -p "Press ENTER to continue or CTRL+C to cancel..." read -p "Press ENTER to continue or CTRL+C to cancel..."
fi fi
echo "Copying files..."
mkdir -p "$INSTALL_DIR" mkdir -p "$INSTALL_DIR"
cp -r "$DIR"/* "$INSTALL_DIR" cp -r "$DIR"/* "$INSTALL_DIR"
chown -R root:root /opt/wlan2eth
else else
echo "We are already in $INSTALL_DIR, not copying files." echo "We are already in $INSTALL_DIR, not copying files."
fi fi
echo -e "Updating...\n" echo -e "Upgrading...\n"
apt-get update apt-get update
apt-get upgrade $NON_INTERACTIVE_APT apt-get upgrade $NON_INTERACTIVE_APT

17
config/config.sh.example
View File

@ -1,14 +1,25 @@
# Interface names # Name of the Ethernet interface that the bridged client will plug into.
# This will be your LAN port.
ETH_IFACE="enp0s31f6" ETH_IFACE="enp0s31f6"
# Name of the WiFi interface that will connect to the wider network.
# This will be your WAN port.
WLAN_IFACE="wlxc8d7193710f4" WLAN_IFACE="wlxc8d7193710f4"
# RADIUS login # Name of the WiFi network to connect to.
WIFI_SSID="Example-Network" WIFI_SSID="Example-Network"
# "psk": WPA2-PSK auth.
# "peap": WPA2-Enterprise in PEAP mode. Make sure to fill out the RADIUS login details below.
# WIFI_AUTH_MODE="peap"
# TODO: implement psk mode
# RADIUS login
WIFI_USERNAME="username" WIFI_USERNAME="username"
WIFI_PWD="password" WIFI_PWD="password"
# Make this port accessible on the router and have its SSH server on it. # Make this port accessible on the router and have its SSH server on it.
# The installer will modify the SSH server's config. # The installer will modify the SSH server's config for you.
ROUTER_SSH_PORT=64535 ROUTER_SSH_PORT=64535
# "transparent": the bridge device clones the client's MAC address and NATs traffic to a private LAN. Only supports one bridged client. # "transparent": the bridge device clones the client's MAC address and NATs traffic to a private LAN. Only supports one bridged client.