aboutsummaryrefslogtreecommitdiff
path: root/src/ejabberd_options_doc.erl
diff options
context:
space:
mode:
Diffstat (limited to 'src/ejabberd_options_doc.erl')
-rw-r--r--src/ejabberd_options_doc.erl21
1 files changed, 12 insertions, 9 deletions
diff --git a/src/ejabberd_options_doc.erl b/src/ejabberd_options_doc.erl
index a725f4572..9d4cea829 100644
--- a/src/ejabberd_options_doc.erl
+++ b/src/ejabberd_options_doc.erl
@@ -1,5 +1,5 @@
%%%----------------------------------------------------------------------
-%%% ejabberd, Copyright (C) 2002-2021 ProcessOne
+%%% ejabberd, Copyright (C) 2002-2022 ProcessOne
%%%
%%% This program is free software; you can redistribute it and/or
%%% modify it under the terms of the GNU General Public License as
@@ -220,7 +220,9 @@ doc() ->
{access_rules,
#{value => "{AccessName: {allow|deny: ACLRules|ACLName}}",
desc =>
- ?T("The option specifies access rules. Each access rule is "
+ ?T("This option defines "
+ "http://../basic/#access-rules[Access Rules]. "
+ "Each access rule is "
"assigned a name that can be referenced from other parts "
"of the configuration file (mostly from 'access' options of "
"ejabberd modules). Each rule definition may contain "
@@ -387,7 +389,7 @@ doc() ->
{auth_scram_hash,
#{value => "sha | sha256 | sha512",
desc =>
- ?T("Hash algorith that should be used to store password in SCRAM format. "
+ ?T("Hash algorithm that should be used to store password in SCRAM format. "
"You shouldn't change this if you already have passwords generated with "
"a different algorithm - users that have such passwords will not be able "
"to authenticate. The default value is 'sha'.")}},
@@ -449,7 +451,7 @@ doc() ->
desc =>
[?T("Path to a file of CA root certificates. "
"The default is to use system defined file if possible."), "",
- ?T("For server conections, this 'ca_file' option is overriden by the http://../toplevel/#s2s-cafile[s2s_cafile] option."), ""
+ ?T("For server connections, this 'ca_file' option is overridden by the http://../toplevel/#s2s-cafile[s2s_cafile] option."), ""
]}},
{captcha_cmd,
#{value => ?T("Path"),
@@ -1083,9 +1085,10 @@ doc() ->
{s2s_access,
#{value => ?T("Access"),
desc =>
- ?T("The access rule to restrict server-to-server connections. "
- "The default value is 'all' which means no restrictions "
- "are applied.")}},
+ ?T("This http://../basic/#access-rules[Access Rule] defines to "
+ "what remote servers can s2s connections be established. "
+ "The default value is 'all'; no restrictions are applied, it is"
+ " allowed to connect s2s to/from all remote servers.")}},
{s2s_cafile,
#{value => ?T("Path"),
desc =>
@@ -1373,14 +1376,14 @@ doc() ->
"protect against connections from other domains than given "
"in the configuration file. In this way, the lower layer load "
"balancer can be chosen for a specific ejabberd implementation "
- "while still providing a secure Websocket connection. "
+ "while still providing a secure WebSocket connection. "
"The default value is 'ignore'. An example value of the 'URL' is "
"\"https://test.example.org:8081\".")}},
{websocket_ping_interval,
#{value => "timeout()",
desc =>
?T("Defines time between pings sent by the server to a client "
- "(Websocket level protocol pings are used for this) to keep "
+ "(WebSocket level protocol pings are used for this) to keep "
"a connection active. If the client doesn't respond to two "
"consecutive pings, the connection will be assumed as closed. "
"The value of '0' can be used to disable the feature. This option "