Skip to content

Commit 8a52027

Browse files
committed
Update documentation to ejabberd 23.01
1 parent 6f6ec85 commit 8a52027

File tree

2 files changed

+61
-9
lines changed

2 files changed

+61
-9
lines changed

content/admin/configuration/modules.md

+39
Original file line numberDiff line numberDiff line change
@@ -1342,6 +1342,45 @@ connection is closed. The default value is *5* minutes.
13421342
- **use\_cache**: *true | false*
13431343
Same as top-level [use_cache](/admin/configuration/toplevel/#use-cache) option, but applied to this module only.
13441344

1345+
mod\_mqtt\_bridge
1346+
-----------------
1347+
1348+
This module adds ability to synchronize local MQTT topics with data on
1349+
remote servers It can update topics on remote servers when local user
1350+
updates local topic, or can subscribe for changes on remote server, and
1351+
update local copy when remote data is updated. It is available since
1352+
ejabberd <a href="/archive/23_01/">23.01</a>.
1353+
1354+
__Available options:__
1355+
1356+
- **replication\_user**: *JID*
1357+
Identifier of a user that will be assigned as owner of local changes.
1358+
1359+
- **servers**: *{ServerUrl: {publish: \[TopicPairs, subscribe: \[TopicPairs\], authentication: \[AuthInfo\]}}\]*
1360+
Declaration of data to share, must contain *publish* or *subscribe* or
1361+
both, and *authentication* section with username/password field or
1362+
certfile pointing to client certificate. Accepted urls can use schema
1363+
mqtt, mqtts (mqtt with tls), mqtt5, mqtt5s (both to trigger v5
1364+
protocol), ws, wss, ws5, wss5. Certifcate authentication can be only
1365+
used with mqtts, mqtt5s, wss, wss5.
1366+
1367+
__**Example**:__
1368+
1369+
modules:
1370+
...
1371+
mod_mqtt_bridge:
1372+
servers:
1373+
"mqtt://server.com":
1374+
publish:
1375+
"localA": "remoteA" # local changes to 'localA' will be replicated on remote server as 'remoteA'
1376+
"topicB": "topicB"
1377+
subscribe:
1378+
"remoteB": "localB" # changes to 'remoteB' on remote server will be stored as 'localB' on local server
1379+
authentication:
1380+
certfile: "/etc/ejabberd/mqtt_server.pem"
1381+
replication_user: "[email protected]"
1382+
...
1383+
13451384
mod\_muc
13461385
--------
13471386

content/admin/configuration/toplevel.md

+22-9
Original file line numberDiff line numberDiff line change
@@ -399,18 +399,19 @@ core ejabberd parts support similar options too, see
399399
[auth_cache_size](/admin/configuration/toplevel/#auth-cache-size), [oauth_cache_size](/admin/configuration/toplevel/#oauth-cache-size), [router_cache_size](/admin/configuration/toplevel/#router-cache-size), and
400400
[sm_cache_size](/admin/configuration/toplevel/#sm-cache-size).
401401

402-
<div class="note-down">improved in <a href="/archive/21_10/">21.10</a></div>
402+
<div class="note-down">improved in <a href="/archive/23_01/">23.01</a></div>
403403

404404
## captcha\_cmd
405405

406-
*Path*
406+
*Path | ModuleName*
407407

408408
Full path to a script that generates [CAPTCHA](/admin/configuration/basic/#captcha)
409409
images. @VERSION@ is replaced with ejabberd version number in XX.YY
410410
format. @SEMVER@ is replaced with ejabberd version number in semver
411-
format when compiled with Elixir’s mix, or XX.YY format otherwise. There
412-
is no default value: when this option is not set, CAPTCHA functionality
413-
is completely disabled.
411+
format when compiled with Elixir’s mix, or XX.YY format otherwise.
412+
Alternatively, it can be the name of a module that implements ejabberd
413+
CAPTCHA support. There is no default value: when this option is not set,
414+
CAPTCHA functionality is completely disabled.
414415

415416
When using the ejabberd installers or container image, the example
416417
captcha scripts can be used like this:
@@ -871,6 +872,15 @@ before starting to drop them. Default 500
871872

872873
The time period to rate-limit log messages by. Defaults to 1 second.
873874

875+
<div class="note-down">added in <a href="/archive/23_01/">23.01</a></div>
876+
877+
## log\_modules\_fully
878+
879+
*\[Module, ...\]*
880+
881+
List of modules that will log everything independently from the general
882+
loglevel option.
883+
874884
## log\_rotate\_count
875885

876886
*Number*
@@ -940,7 +950,7 @@ default value is *1 minute*.
940950
*true | false*
941951

942952
Whether to use *new* SQL schema. All schemas are located at
943-
<https://github.com/processone/ejabberd/tree/22.05/sql>. There are two
953+
<https://github.com/processone/ejabberd/tree/23.01/sql>. There are two
944954
schemas available. The default legacy schema allows to store one XMPP
945955
domain into one ejabberd database. The *new* schema allows to handle
946956
several XMPP domains in a single ejabberd database. Using this *new*
@@ -1048,13 +1058,16 @@ activated with some of the processes possibly be killed (see
10481058
[oom_killer](/admin/configuration/toplevel/#oom-killer) option). Later, when memory drops below this *Percent*,
10491059
OOM killer is deactivated. The default value is *80* percents.
10501060

1061+
<div class="note-down">changed in <a href="/archive/23_01/">23.01</a></div>
1062+
10511063
## outgoing\_s2s\_families
10521064

1053-
*\[ipv4 | ipv6, ...\]*
1065+
*\[ipv6 | ipv4, ...\]*
10541066

10551067
Specify which address families to try, in what order. The default is
1056-
*\[ipv4, ipv6\]* which means it first tries connecting with IPv4, if
1057-
that fails it tries using IPv6.
1068+
*\[ipv6, ipv4\]* which means it first tries connecting with IPv6, if
1069+
that fails it tries using IPv4. This option is obsolete and irrelevant
1070+
when using ejabberd <a href="/archive/23_01/">23.01</a> and Erlang/OTP 22, or newer versions of them.
10581071

10591072
<div class="note-down">added in <a href="/archive/20_12/">20.12</a></div>
10601073

0 commit comments

Comments
 (0)