view @ 188:388b6728f506

Added missing options to the wiki.
date Wed, 13 Apr 2011 03:43:49 +0000
parents 4a6c1e35788c
children 479655c59e6d
line wrap: on
line source

#summary mini JSON registration servlet.
#labels Stage-Alpha

= Introduction =

This module let's you activate a httpserver interface to handle data from webforms with POST and JSON.

= Details =

It will accept the following format:

POST /your_register_base_url HTTP/1.0
Authorization: Basic base64authstring
Content-Type: application/json


It will require a server admin (of the given host) to provide valid credentials to submit data via Basic HTTP auth first.

The ip field is at the moment is required to be present even if unset (""), you will require to set it using the webserver's REMOTE_ADDR global (or similar) to pass the client's ip address should you want to employ throttling/blacklisting/whitelisting of requests.

= Usage =

Copy the module file into your prosody modules directory.
Load the module in your configuration file's global section, that would suffice to run it.

Hint: pairing with mod_register_url is helpful, to allow server registrations only via your webform.

Optional configuration directives:
reg_servlet_realm = "Your Realm Name of choice" -- Modifies the name of the authentication realm.
reg_servlet_port = { *your port number here* } -- Uses a custom port number for the listener.
reg_servlet_ttime = seconds -- Specifies the time (in seconds) between each request coming from the same remote address.
reg_servlet_bl = { "", "" } -- The ip addresses in this list will be blacklisted and won't be able to register.
reg_servlet_wl = { "", "" } -- The ip addresses in this list will be ignored by the throttling.

Optional TLS directives:
reg_servlet_sslcert = "path/to/your/cert" -- Your tls/ssl cert file.
reg_servlet_sslkey = "path/to/your/key" -- Your tls/ssl key file.
*To activate SSL/TLS on a listener both options need to be correctly set.*

= Compatibility =

Trunk - works.

0.8 - untested.

0.7 - untested.