Skip to content

Commit

Permalink
Merge pull request #284 from nodogsplash/v3.2.0
Browse files Browse the repository at this point in the history
Release V3.2.0
  • Loading branch information
bluewavenet committed Sep 2, 2018
2 parents 5d1dea6 + 74a2f4b commit bbff6eb
Show file tree
Hide file tree
Showing 16 changed files with 597 additions and 483 deletions.
12 changes: 12 additions & 0 deletions ChangeLog
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
nodogsplash (3.2.0)

* Add Redirect to Status page support for FAS [bluewavenet]
* Add iptables version check [mwarning]
* Add ndsctl status output for FAS and Binauth status. [bluewavenet]
* Initialize fas_remoteip with gw_address and simplify code [mwarning]
* Fix Readthedocs updates and update Docs URL [bluewavenet]
* Update documentation and Debian man page [bluewavenet]

-- Rob White <dot@blue-wave.net> Sun, 2 Sep 2018 16:09:00 +0000


nodogsplash (3.1.0)

* Integrated support for separate Forward Authentication Service (FAS), adding the following configuration options [bluewavenet, mwarning]:
Expand Down
48 changes: 29 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
## 0. The Nodogsplash project

Nodogsplash offers a simple way to provide restricted access to an internet
connection. It is derived from the codebase of the Wifi Guard Dog project.
Nodogsplash is a Captive Portal that offers a simple way to provide restricted access to the Internet by showing a splash page to the user before Internet access is granted.

It also incorporates an API that allows the creation of sophisticated authentication applications.

It was derived originally from the codebase of the Wifi Guard Dog project.

Nodogsplash is released under the GNU General Public License.

* Mailing List: http://ml.ninux.org/mailman/listinfo/nodogsplash
Expand All @@ -14,23 +18,29 @@ how to customize its behavior for your application.

## 1. Overview

Nodogsplash offers a solution to this problem: You want to provide controlled
and reasonably secure public access to an internet connection; and while you
want to require users to give some acknowledgment of the service you are
providing, you don't need or want the complexity of user account names and
passwords and maintaining a separate database-backed authentication server.
When installed and running, Nodogsplash implements a simple 'authentication'
protocol. First, it detects any user attempting to use your internet connection
to request a web page. It captures the request, and instead serves back a
'splash' web page using its own builtin web server. The splash page contains a
link which, when the user clicks on it, opens limited access for them to the
internet via your connection, beginning by being redirected to their originally
requested page. This access expires after a certain time interval.
Nodogsplash also permits limiting the aggregate bandwidth provided to users, if
you don't want to grant all of your available upload or download bandwidth.
Specific features of Nodogsplash are configurable, by editing the configuration
file and the splash page. The default installed configuration may be all you
need, though.
**Nodogspash** (NDS) 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.

**If you want to provide simple and immediate public access** to an Internet connection with users giving some acknowledgment of the service, Nodogsplash does this by default.
Customising the page seen by users is a simple matter of editing the simple default html splash page file.

**If you want to enforce use of a set of preset usernames** and passwords with perhaps a limited connection time, the addition of a simple shell script is all that is required.

**If you want a more sophisticated authentication system** providing a dynamic web interface you can do that too by providing your own web service written in a language such as php running on its own server.

**Taking this to the extreme**, if you want to link Nodogsplash to your own centralised Internet based authentication service with user account self generation and access charging, you can do that too, or anything in between.

All modern mobile devices, most desktop operating systems and most browsers now have a Captive Portal Detection process that automatically issues a port 80 request on connection to a network. Nodogsplash detects this and serves a 'splash' web page.

The splash page in its most basic form, contains a Continue button. When the user clicks on it, access to the internet is granted subject to a preset time interval.

Nodogsplash does not currently support traffic control but is fully compatible with other stand alone systems such as SQM scripts.

**Nodogsplash supports multiple means of authentication**:

- Click the submit button (default)
- Call an external script that may accept username/password and set session durations per user.
- Forwarding authentication to an external service


## 2. Documentation

Expand Down
12 changes: 11 additions & 1 deletion debian/changelog
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
nodogsplash (3.2.0) stable; urgency=medium

* Add Redirect to Status page support for FAS [bluewavenet]
* Add iptables version check [mwarning]
* Add ndsctl status output for FAS and Binauth status. [bluewavenet]
* Initialize fas_remoteip with gw_address and simplify code [mwarning]
* Fix Readthedocs updates and update Docs URL [bluewavenet]
* Update documentation and Debian man page [bluewavenet]

-- Rob White <dot@blue-wave.net> Sun, 2 Sep 2018 16:09:00 +0000

nodogsplash (3.1.0) stable; urgency=medium

* Integrated support for separate Forward Authentication Service (FAS), adding the following configuration options:
Expand All @@ -8,7 +19,6 @@ nodogsplash (3.1.0) stable; urgency=medium

-- Rob White <dot@blue-wave.net> Sun, 26 Aug 2018 10:05:00 +0000


nodogsplash (3.0.0-1) stable; urgency=medium

* Removed settings without implementation due to the change of the http library:
Expand Down
7 changes: 4 additions & 3 deletions debian/copyright
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,15 @@ Upstream-Name: nodogsplash
Source: http://github.com/nodogsplash

Files: *
Copyright: 2013 Moritz Warning <moritzwarning@web.de>
Copyright: 2013-18 BlueWave Projects and Services <dot@blue-wave.net>
2013-18 Moritz Warning <moritzwarning@web.de>
2013 Shiao-An Yuan <shiao.an.yuan@gmail.com>
2010 Fred Moyer <fred@slwifi.com>
2010 Paul Kube <nodogsplash@kokoro.ucsd.edu>
License: GPL-2.0+

Files: libhttpd/*
Copyright: 2001-2006, Hughes Technologies Pty Ltd, Australia
Files: libmicrohttpd/*
Copyright (C) 2007-2014 Daniel Pittman and Christian Grothoff
License: GPL-2.0+

License: GPL-2.0+
Expand Down

0 comments on commit bbff6eb

Please sign in to comment.