profxadke/captive.whump.shanti-portal
1
0
Fork 0
mirror of https://codeberg.org/prof_x_pvt_ltd/captive.whump.shanti-portal synced 2024-08-14 22:46:42 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
30 commits 3 branches 0 tags 630 KiB
Python 76.7%
JavaScript 13%
Smarty 7.8%
PLpgSQL 1.6%
CSS 0.9%
Find a file
Stefan Midjich 93b6ca686e starting js form submit code.
2016-04-18 18:14:05 +02:00
plugins fixing some config issues with plugins. 2016-04-18 18:13:57 +02:00
static changed plugin management to simple rq jobs instead of using pkg_resources. 2016-04-15 19:22:16 +02:00
views starting js form submit code. 2016-04-18 18:14:05 +02:00
.gitignore changed plugin management to simple rq jobs instead of using pkg_resources. 2016-04-15 19:22:16 +02:00
plugins.cfg fixing some config issues with plugins. 2016-04-18 18:13:57 +02:00
portal.cfg ttl and static files dir. 2016-04-16 16:50:05 +02:00
portal.py fixing some config issues with plugins. 2016-04-18 18:13:57 +02:00
README.md short intro 2016-04-16 19:10:28 +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/