Welcome to openNDS’s documentation!¶
openNDS is a high performance, small footprint Captive Portal, offering by default a simple splash page restricted Internet connection, yet incorporates an API that allows the creation of sophisticated authentication applications.
It was derived originally from the codebase of the Wifi Guard Dog project.
openNDS is released under the GNU General Public License.
- Original Homepage down: http://kokoro.ucsd.edu/nodogsplash
- Wifidog: http://dev.wifidog.org/
- GNU GPL: http://www.gnu.org/copyleft/gpl.html
The following describes what openNDS does, how to get it and run it, and how to customize its behavior for your application.
Contents:
- Overview
- Installing openNDS
- How openNDS (NDS) works
- The Splash Page
- Forwarding Authentication Service (FAS)
- Overview
- Using FAS
- Security
- Example FAS Query strings
- Network Zones - Determining the Interface the Client is Connected To
- After Successful Verification by FAS
- Post FAS processing
- BinAuth Post FAS Processing
- Manual Access of NDS Virtual URL
- Running FAS on your openNDS router
- Using a Shared Hosting Server for a Remote FAS
- Using the FAS Example Scripts (fas-hid, fas-aes.php and fas-aes-https.php)
- Changing faskey
- PreAuth Option
- Overview
- Selecting Pre-Installed Username / Email Login Script (v4.3.0 onwards)
- Using PreAuth version 4.0.2 onwards
- Using PreAuth version 3.3.1 to version 4.0.1
- Enabling the Preinstalled Login Script (v3.3.1 to 4.0.1)
- Enabling the Preinstalled Login Script (v4.0.2 onwards)
- What Does the Example Login Script Do?
- PreAuth with Remote Images
- Writing A Preauth Script
- Defining and Using Variables
- Displaying Remote Banner Images
- BinAuth Option
- Library Utilities
- Data Quotas and Traffic Shaping
- Using ndsctl
- Customising openNDS
- Frequently Asked Questions
- What’s the difference between v0.9, v1, v2, v3, v4 and v5?
- Can I update from v0.9 to v1?
- Can I update from v0.9/v1 to v2.0.0?
- Can I update from v0.9/v1/v2 to v3.0.0?
- Can I update from v0.9/v1/v2/v3 to v4?
- Can I update from v0.9/v1/v2/v3/v4 to v5?
- How do I manage client data usage?
- Can I use Traffic Shaping with openNDS?
- Is an https splash page supported?
- Is https capture supported?
- What is CPD / Captive Portal Detection?
- How to Compile openNDS
- Debugging openNDS
- TODO List