Update Documentation

Signed-off-by: Rob White <rob@blue-wave.net>

docs/source/config.rst

@@ -1167,9 +1167,31 @@ To add Paypal to the Walled Garden, the list entries would be:
 User Access to Services On the Router
 *************************************
 
-Access is automatically granted to resources required for normal operation of the captive portal.
+Access is automatically granted to resources required for normal operation of the captive portal and all other access is blocked.
 
-Additional access falls into two categories:
+By default the user to router access rules are **not** passed through to the system firewall for additional processing.
+
+Users to Router Passthrough
+---------------------------
+
+(Applies to OpenWrt only)
+
+Default: 0 (disabled)
+
+To enable passthrough, set to 1
+
+``option users_to_router_passthrough '1'``
+
+**WARNING**: Do not enable unless you know what you are doing.
+
+*Enabling passthrough may well soft brick your router, particularly if openNDS is bound to a guest network.*
+
+Access to the router.
+---------------------
+
+Access falls into two categories:
+ * Essential
+ * Optional
 
 Essential Access
 ----------------

docs/source/libraries.rst

@@ -308,6 +308,32 @@ send_to_fas_custom:
 
 Returns exit code 0 if sent, 1 if failed
 
+users_to_router:
+----------------
+
+    arg1: users_to_router, sets allow or passthrough mode for users_to_router rules.
+
+        arg2: the mode to set (ie allow, passthrough or cleanup)
+
+
+    Passthrough facilitates chaining to lower priority nftables tables/chains (eg FW4 in OpenWrt)
+
+Returns exit code 0 if set, 1 if failed
+
+pre_setup:
+----------
+
+    arg1: pre_setup, creates/configures openNDS nftables base chains
+
+Returns exit code 0 if successful, 1 if failed
+
+delete_chains:
+--------------
+
+    arg1: delete_chains, deletes the openNDS nftables base chains
+
+Returns exit code 0 always
+
 ?fas:
 -----
     **arg1**: "*?fas=<b64string>*", generates ThemeSpec html using b64encoded data sent from openNDS

forward_authentication_service/libs/libopennds.sh

@@ -1781,7 +1781,8 @@ elif [ "$1" = "users_to_router" ]; then
 	exit $ret
 
 elif [ "$1" = "pre_setup" ]; then
-	# Pre-setup before openNDS does its built in configuration
+	# creates/configures openNDS nftables base chains
+
 	# Returns exit code 0 if done, 1 if failed
 
 	pre_setup
@@ -1789,7 +1790,7 @@ elif [ "$1" = "pre_setup" ]; then
 	exit $ret
 
 elif [ "$1" = "delete_chains" ]; then
-	# Delete the openNDS nft chains
+	# Deletes the openNDS nftables base chains
 
 	delete_chains