Go to file

Stefan Midjich 630a1f93c5 better plugin logging.		2016-04-17 10:21:22 +02:00
plugins	better plugin logging.	2016-04-17 10:21:22 +02:00
static	changed plugin management to simple rq jobs instead of using pkg_resources.	2016-04-15 19:22:16 +02:00
views	changed plugin management to simple rq jobs instead of using pkg_resources.	2016-04-15 19:22:16 +02:00
.gitignore	changed plugin management to simple rq jobs instead of using pkg_resources.	2016-04-15 19:22:16 +02:00
README.md	short intro	2016-04-16 19:10:28 +02:00
plugins.cfg	fixed chain command to insert.	2016-04-16 21:30:43 +02:00
portal.cfg	ttl and static files dir.	2016-04-16 16:50:05 +02:00
portal.py	add config info to plugin arg dict.	2016-04-16 19:09:22 +02:00
requirements.txt	confused about how to use requirements.txt along with setup.py dependencies.	2016-04-16 16:49:24 +02:00
setup.py	added sh for iptables dependency.	2016-04-16 16:49:39 +02:00

README.md

Captive Portal

Work in progress right now.

Captive portal webpage written with simplicity in mind.

Present a webpage to the user
Users submits a form
Plugins are executed with form data
User is granted access to whatever treasure the portal is guarding

This is a commonly seen setup in public Wifi networks or hotspots.

This app was specifically written for such a hotspot and as such requires a lot of other configuration around it. This is an ongoing documentation project here.

Plugins

Plugins are executed when the user clicks through the captive portal form, whether they submit data or just approve an EULA these plugins are executed.

Plugins accept data from the request of the user, as of writing this is only wsgi environ data.

There is a sample plugin called logging.py. Plugins are merely rq jobs that are executed by an rq worker. As such they can only be so complex.

Get started

python setup.py install
python portal.py

RQ worker

rq worker -u redis://127.0.0.1:6379/