Merge pull request #444 from nodogsplash/4.2.1beta

Create option login_option_enabled

Makefile

@@ -43,7 +43,7 @@ install:
 	cp resources/splash.css $(DESTDIR)/etc/nodogsplash/htdocs/
 	cp resources/status.html $(DESTDIR)/etc/nodogsplash/htdocs/
 	cp resources/splash.jpg $(DESTDIR)/etc/nodogsplash/htdocs/images/
-	cp forward_authentication_service/PreAuth/demo-preauth.sh $(DESTDIR)/etc/nodogsplash/login.sh
+	cp forward_authentication_service/PreAuth/demo-preauth.sh $(DESTDIR)/usr/lib/nodogsplash/login.sh
 	cp forward_authentication_service/fas-aes/fas-aes.php $(DESTDIR)/etc/nodogsplash/
 
 checkastyle:

docs/source/customize.rst

@@ -74,6 +74,7 @@ Finally you must tell UCI to commit your changes to the configuration file:
 The Default Click and Go Splash Page
 ************************************
 
+Enabled by setting option login_option_enabled = "0" (default)
 The default default splash page can be found at:
 
   ``/etc/nodogsplash/htdocs/splash.html``
@@ -145,7 +146,20 @@ Also, note that any images you reference should reside in the subdirectory /etc/
 Dynamic Splash Pages
 ********************
 
-Dynamically generated splash pages are supported using FAS and PreAuth (including the included alternative username/email login script).
+Pre-Installed User Login Dynamic Splash Page
+============================================
+
+The pre-installed dynamic splash page is enabled by setting option login_option_enabled = "1".
+
+It generates a login page asking for username and email address.
+User logins are recorded in the log file /tmp/ndslog.log
+Details of how the script works are contained in comments in the script itself.
+
+
+Custom Dynamic Splash Pages
+===========================
+
+Custom designed dynamically generated splash pages are supported using FAS and PreAuth (such as the included alternative username/email login script).
 
 For details see the FAS and PreAuth chapters.
 

docs/source/preauth.rst

@@ -9,7 +9,7 @@ Overview
 **PreAuth** is a pre-authentication process that enables NDS to directly serve dynamic web content generated by a script or executable program.
 
 .. note::
- From version 3.3.1 onwards, a PreAuth login script is pre-installed. This generates a page asking for username and email address. Logins are recorded in a log file. It is enabled by un-commenting just 3 lines in the config file. **From version 4.0.2 onwards** it is enabled by a single line in the config file that overrides any other FAS configuration. 
+ From version 3.3.1 onwards, a PreAuth login script is pre-installed. This generates a page asking for username and email address. Logins are recorded in a log file. It is enabled by un-commenting just 3 lines in the config file. **From version 4.0.2 onwards** it is enabled by a single line in the config file that overrides any other FAS configuration.  **From version 4.3.0 onwards** it is enabled by setting config option login_option_enabled to "1"
 
 **PreAuth is enabled** by configuring NDS FAS to point to a virtual URL in the NDS web root instead of an independent FAS server. The location of the PreAuth script or program is provided in the config file.
 
@@ -19,6 +19,17 @@ A PreAuth program could be, for example, a compiled program written in C or any
 
 The PreAuth script or program will parse the url encoded command line (query string) passed to it and output html depending on the contents of the query string it receives from NDS. In turn, NDS will serve this html to the client device that is attempting to access the Internet.
 
+Selecting Pre-Installed Username / Email Login Script (v4.3.0 onwards)
+**********************************************************************
+
+The default preauth login script is installed as part of the NoDogSplash package providing username/emailaddress login as an alternative to the basic splash page.
+
+It is enabled by setting in config:
+
+option login_option_enabled = '1'
+
+No additional FAS or PreAuth config settings are required.
+
 Using PreAuth version 4.0.2 onwards
 ***********************************
 From version 4.0.2 onwards, PreAuth is enabled with a single configuration option: