Update Documentation

Signed-off-by: Rob White <rob@blue-wave.net>
This commit is contained in:
Rob White
2023-01-17 14:37:23 +00:00
parent 7ea4f2eaf0
commit 8d25b620af
3 changed files with 53 additions and 4 deletions

View File

@@ -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
----------------

View File

@@ -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