| docs/examples | ||
| plugins | ||
| static | ||
| views | ||
| .gitignore | ||
| plugins.cfg | ||
| portal.cfg | ||
| portal.py | ||
| README.md | ||
| requirements.txt | ||
| setup.py | ||
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.
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
python portal.py
RQ worker
rq worker -u redis://127.0.0.1:6379/
Deployment
See examples in docs/examples directory.