From 959ecf6df6164cc4d7eff0b2b19c0d8f3c6869d5 Mon Sep 17 00:00:00 2001 From: Stefan Midjich Date: Mon, 18 Apr 2016 21:46:04 +0200 Subject: [PATCH] more explanation of plugins. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index ce2c503..464baf8 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,13 @@ Plugins are executed when the user clicks through the captive portal form, wheth Plugins accept data from the request of the user, as of writing this is only wsgi environ data. +Result of the plugins decide whether the user gets accepted into the portal or not. As such plugins have the potential to do anything from check the users IP against a whitelist to authenticate against a RADIUS server or Active Directory. + Sample plugins prefixed with sample\_ are a good starting point for understanding the plugins. Plugins can be made mandatory, or skipped by being disabled, see plugins.cfg for more configuration. + # Get started python setup.py install