summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBadlop <badlop@process-one.net>2022-10-25 12:07:41 +0200
committerBadlop <badlop@process-one.net>2022-10-25 12:11:24 +0200
commit2ef71a66840bece5bfe9960cb4e926eb0b65920a (patch)
tree1dbe2aa20841a1336ec506a52c71cd3533e9c2f7
parentBump version (diff)
Annotate captcha_cmd option, run make options, update man
-rw-r--r--CHANGELOG.md1
-rw-r--r--man/ejabberd.yml.519
-rw-r--r--src/ejabberd_option.erl2
-rw-r--r--src/ejabberd_options_doc.erl1
4 files changed, 20 insertions, 3 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 5ef712d3..bcf2d32d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,7 @@ Core:
- Add `log_burst_limit_*` options ([#3865](https://github.com/processone/ejabberd/issues/3865))
- Support `ERL_DIST_PORT` option to work without epmd
- Auth JWT: Catch all errors from `jose_jwt:verify` and log debugging details ([#3890](https://github.com/processone/ejabberd/issues/3890))
+- CAPTCHA: Support `@VERSION@` and `@SEMVER@` in `captcha_cmd` option ([#3835](https://github.com/processone/ejabberd/issues/3835))
- HTTP: Fix unix socket support ([#3894](https://github.com/processone/ejabberd/issues/3894))
- HTTP: Handle invalid values in `X-Forwarded-For` header more gracefuly
- Listeners: Let module take over socket
diff --git a/man/ejabberd.yml.5 b/man/ejabberd.yml.5
index dab3bcc5..a14a5c73 100644
--- a/man/ejabberd.yml.5
+++ b/man/ejabberd.yml.5
@@ -559,12 +559,26 @@ A maximum number of items (not memory!) in cache\&. The rule of thumb, for all t
\fIrouter_cache_size\fR, and
\fIsm_cache_size\fR\&.
.RE
+.sp
+\fINote\fR about the next option: improved in 21\&.10:
.PP
\fBcaptcha_cmd\fR: \fIPath\fR
.RS 4
Full path to a script that generates
CAPTCHA
-images\&. There is no default value: when this option is not set, CAPTCHA functionality is completely disabled\&.
+images\&. @VERSION@ is replaced with ejabberd version number in XX\&.YY format\&. @SEMVER@ is replaced with ejabberd version number in semver format when compiled with Elixir\(cqs mix, or XX\&.YY format otherwise\&. There is no default value: when this option is not set, CAPTCHA functionality is completely disabled\&.
+.sp
+When using the ejabberd installers or container image, the example captcha scripts can be used like this:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+captcha_cmd: /opt/ejabberd\-@VERSION@/lib/ejabberd\-@SEMVER@/priv/bin/captcha\&.sh
+.fi
+.if n \{\
+.RE
+.\}
.RE
.PP
\fBcaptcha_host\fR: \fIString\fR
@@ -1474,7 +1488,8 @@ if the latter is not set\&.
\fBs2s_timeout\fR: \fItimeout()\fR
.RS 4
A time to wait before closing an idle s2s connection\&. The default value is
-\fI10 minutes\fR\&.
+\fI1\fR
+hour\&.
.RE
.PP
\fBs2s_tls_compression\fR: \fItrue | false\fR
diff --git a/src/ejabberd_option.erl b/src/ejabberd_option.erl
index 063502f8..58872189 100644
--- a/src/ejabberd_option.erl
+++ b/src/ejabberd_option.erl
@@ -316,7 +316,7 @@ cache_size() ->
cache_size(Host) ->
ejabberd_config:get_option({cache_size, Host}).
--spec captcha_cmd() -> 'undefined' | binary().
+-spec captcha_cmd() -> any().
captcha_cmd() ->
ejabberd_config:get_option({captcha_cmd, global}).
diff --git a/src/ejabberd_options_doc.erl b/src/ejabberd_options_doc.erl
index a76fab94..c1404871 100644
--- a/src/ejabberd_options_doc.erl
+++ b/src/ejabberd_options_doc.erl
@@ -455,6 +455,7 @@ doc() ->
]}},
{captcha_cmd,
#{value => ?T("Path"),
+ note => "improved in 21.10",
desc =>
?T("Full path to a script that generates http://../basic/#captcha[CAPTCHA] images. "
"@VERSION@ is replaced with ejabberd version number in XX.YY format. "