.. openNDS documentation master file, created by
   sphinx-quickstart on Thu Nov 10 13:53:25 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the documentation for openNDS
========================================

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 is a fork of the NoDogSplash project that in turn was derived originally from the codebase of the Wifi Guard Dog project.

openNDS is released under the GNU General Public License.

* openNDS: https://github.com/openNDS/openNDS
* Original Homepage *down*: http://kokoro.ucsd.edu/nodogsplash
* Archive: https://web.archive.org/web/20140210131130/http://kokoro.ucsd.edu/nodogsplash
* Wifidog: http://dev.wifidog.org/
* NoDogSplash: https://github.com/nodogsplash/nodogsplash
* 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:

.. toctree::
   :maxdepth: 2

   overview
   install
   howitworks
   splash
   fas
   preauth
   binauth
   libraries
   traffic
   walledgarden
   ndsctl
   customize
   faq
   compile
   debug
   todo

Indices and tables
==================

* :ref:`genindex`
* :ref:`search`