uspot: initial documentation of config options

Signed-off-by: Thibaut VARÈNE <hacks@slashdirt.org>
This commit is contained in:
Thibaut VARÈNE
2023-05-12 13:56:46 +02:00
committed by John Crispin
parent a7341b418e
commit 8262342e1c

View File

@@ -1 +1,39 @@
config webroot def_captive config webroot def_captive
#config uspot 'example'
# option auth_mode '' # one of 'uam', 'radius', 'credentials', 'click-to-continue'
# option web_root '0' # ?
# option idle_timeout '600' # client is kicked when idle for more than N seconds, defaults to 600, option used if not provided by radius
# option session_timeout '0' # client is kicked if connected for more than N seconds, defaults to 0, option used if not provided by radius
# list ifname '' # network devices to capture
# option debug '0'
# option configure_spotfilter '1' # allow 'captive generate' to generate spotfilter config from uspot config
# for auth mode 'uam' and 'radius':
# option auth_server '' # radius authentication server name or address
# option auth_port '1812' # radius authentication server port
# option auth_secret '' # radius authentication server password
# option auth_proxy '' # radius authentication server proxy
# option acct_server '' # radius accounting server name or address
# option acct_port '1812' # radius accounting server port
# option acct_secret '' # radius accounting server password
# option acct_proxy '' # radius accounting server proxy
# option nasid '' # radius NAS-Identitifer, UAM '&nasid='
# option nasmac '' # radius Called-Station, UAM '&called='
# option mac_format '' # MAC format specifier: 'aabbccddeeff', 'aa-bb-cc-dd-ee-ff', 'aa:bb:cc:dd:ee:ff' or the equivalent uppercase
# for auth_mode 'uam':
# option uam_port '3990' # local UAM server port
# option uam_secret '' # remote UAM server password
# option uam_server 'https://uam.example.com/' # remote uam server url
# option challenge '' # UAM CHAP shared challenge
# option final_redirect_url 'uam' # ?
# option mac_auth '0' # Attempt MAC-authentication first
# option mac_password '' # Password sent for MAC-auth, defaults to MAC address
# option mac_suffix '' # Optional suffix appended to username for MAC-auth
# if config_spotfilter=1:
# option interface '' # network interface (from config/network) to redirect captured traffic to
# list wl_hosts '' # whitelisted host names
# list wl_addrs '' # whitelisted IP addresses
# option client_autoremove '0' #