1 ---

     2 labels:

     3 - 'Stage-Beta'

     4 summary: provides captcha protection for registration form

     5 ...

     6 

     7 Introduction

     8 ============

     9 

    10 Prosody-captcha is a little modification of prosody's

    11 "mod\_register.lua" module that provides captcha protection for

    12 registration form.

    13 

    14 Installation

    15 ============

    16 

    17 First of all you should build and install lua bindings for libgd —

    18 [lua-gd](https://github.com/ittner/lua-gd/).

    19 

    20 Then clone repsository lua-captcha:

    21 

    22 **`$ git clone https://github.com/mrDoctorWho/lua-captcha`**

    23 

    24 install it:

    25 

    26 **`$ make install`**

    27 

    28 Configuration

    29 =============

    30 

    31 After that you would configure prosody. This module requires from you 4

    32 fields, you should add this into your VirtualHost entry.

    33 

    34     captcha_config = {

    35             dir = "/tmp"; -- Directory used to storage captcha images. Please make sure prosody user allowed to write there.

    36             timeout = 60; -- Timeout when captcha will expire

    37             web_path = "challenge"; -- Web path used to separate main prosody site from itself modules.

    38             font = "/usr/lib/prosody/FiraSans-Regular.ttf" -- Font used for captcha text

    39     }

    40 

    41 You can run script "install.lua" to install this or instead of that

    42 while prosody developers didn't accepted "dataforms" changes you should

    43 replace standard prosody "dataforms.lua" located in ubuntu in

    44 /usr/lib/prosody/util by another one from this repository. You should do

    45 the same thing with "mod\_register.lua" located in ubuntu in

    46 /usr/lib/prosody/modules.

    47 

    48 After this all you can try to register on your server and see the

    49 captcha.

    50 

    51 TODO

    52 ====

    53 

    54 -   Maybe use recaptcha instead of libgd.