From: Mickaël Rémond <mremond@process-one.net>
Date: Sat, 25 May 2019 09:21:30 +0000 (+0200)
Subject: Improve captcha.sh script documentation
X-Git-Tag: 19.05~4
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=b90fe4c5c93e9196b87d6ef2af1df76c5e08423b;p=ejabberd

Improve captcha.sh script documentation
---

diff --git a/tools/captcha.sh b/tools/captcha.sh
index 560a048ad..9fa4a52c4 100755
--- a/tools/captcha.sh
+++ b/tools/captcha.sh
@@ -1,5 +1,18 @@
 #!/bin/sh
 
+# This script is an example captcha script.
+# It takes the text to recognize in the captcha image as a parameter.
+# It return the image binary as a result. ejabberd support PNG, JPEG and GIF.
+
+# The whole idea of the captcha script is to let server admins adapt it to
+# their own needs. The goal is to be able to make the captcha generation as
+# unique as possible, to make the captcha challenge difficult to bypass by
+# a bot.
+# Server admins are thus supposed to write and use their own captcha generators.
+
+# This script relies on ImageMagick.
+# It is NOT compliant with ImageMagick forks like GraphicsMagick.
+
 INPUT=$1
 
 if test -n ${BASH_VERSION:-''} ; then