From e851416d231ca4dfa80bc0335974cd41ae73ec2b Mon Sep 17 00:00:00 2001
From: Cyberes <cyberes@evulid.cc>
Date: Tue, 13 Jun 2023 16:13:32 -0600
Subject: [PATCH] readme, config docs, installer

---
 README.md                | 11 ++++++++++-
 bridge-install.sh        |  4 +++-
 config/config.sh.example | 17 ++++++++++++++---
 3 files changed, 27 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index b992445..ea04d60 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,12 @@
 # wlan2eth
+*Transparently bridge your WiFi connection to your Ethernet interface.*
 
-Transparently bridge your WiFi connection to your Ethernet interface.
\ No newline at end of file
+## 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!
diff --git a/bridge-install.sh b/bridge-install.sh
index b6119f4..becad18 100755
--- a/bridge-install.sh
+++ b/bridge-install.sh
@@ -83,13 +83,15 @@ if [ "$DIR" != "$INSTALL_DIR" ]; then
     echo -e "\nGoing to copy $DIR to $INSTALL_DIR"
     read -p "Press ENTER to continue or CTRL+C to cancel..."
   fi
+  echo "Copying files..."
   mkdir -p "$INSTALL_DIR"
   cp -r "$DIR"/* "$INSTALL_DIR"
+  chown -R root:root /opt/wlan2eth
 else
     echo "We are already in $INSTALL_DIR, not copying files."
 fi
 
-echo -e "Updating...\n"
+echo -e "Upgrading...\n"
 
 apt-get update
 apt-get upgrade $NON_INTERACTIVE_APT
diff --git a/config/config.sh.example b/config/config.sh.example
index 1582dfc..ef4bac5 100644
--- a/config/config.sh.example
+++ b/config/config.sh.example
@@ -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"
+
+# Name of the WiFi interface that will connect to the wider network.
+# This will be your WAN port.
 WLAN_IFACE="wlxc8d7193710f4"
 
-# RADIUS login
+# Name of the WiFi network to connect to.
 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_PWD="password"
 
 # 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
 
 # "transparent": the bridge device clones the client's MAC address and NATs traffic to a private LAN. Only supports one bridged client.