From 7c67525f85010b01e9c384818d75824155df6062 Mon Sep 17 00:00:00 2001 From: Stefan Midjich Date: Fri, 15 Apr 2016 19:24:44 +0200 Subject: [PATCH] some more info here. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 3effcf6..7606fd4 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,15 @@ This is supposed to be a captive portal webpage. Work in progress right now. + +# 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. + +# RQ worker + + rq worker -u redis://127.0.0.1:6379/