Skip to content

Commit 21c6cc8

Browse files
badlopbadlop
committed
Update man page to 25.10
1 parent 5728db7 commit 21c6cc8

File tree

1 file changed

+147
-27
lines changed

1 file changed

+147
-27
lines changed

‎man/ejabberd.yml.5‎

Lines changed: 147 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: ejabberd.yml
33
.\" Author: [see the "AUTHOR" section]
44
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5-
.\" Date: 08/22/2025
5+
.\" Date: 10/28/2025
66
.\" Manual: \ \&
77
.\" Source: \ \&
88
.\" Language: English
99
.\"
10-
.TH "EJABBERD\&.YML" "5" "08/22/2025" "\ \&" "\ \&"
10+
.TH "EJABBERD\&.YML" "5" "10/28/2025" "\ \&" "\ \&"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -82,12 +82,12 @@ All options can be changed in runtime by running \fIejabberdctl reload\-config\f
8282
.sp
8383
Some options can be specified for particular virtual host(s) only using \fIhost_config\fR or \fIappend_host_config\fR options\&. Such options are called \fIlocal\fR\&. Examples are \fImodules\fR, \fIauth_method\fR and \fIdefault_db\fR\&. The options that cannot be defined per virtual host are called \fIglobal\fR\&. Examples are \fIloglevel\fR, \fIcertfiles\fR and \fIlisten\fR\&. It is a configuration mistake to put \fIglobal\fR options under \fIhost_config\fR or \fIappend_host_config\fR section \- ejabberd will refuse to load such configuration\&.
8484
.sp
85-
It is not recommended to write ejabberd\&.yml from scratch\&. Instead it is better to start from "default" configuration file available at https://github\&.com/processone/ejabberd/blob/25\&.08/ejabberd\&.yml\&.example\&. Once you get ejabberd running you can start changing configuration options to meet your requirements\&.
85+
It is not recommended to write ejabberd\&.yml from scratch\&. Instead it is better to start from "default" configuration file available at https://github\&.com/processone/ejabberd/blob/25\&.10/ejabberd\&.yml\&.example\&. Once you get ejabberd running you can start changing configuration options to meet your requirements\&.
8686
.sp
8787
Note that this document is intended to provide comprehensive description of all configuration options that can be consulted to understand the meaning of a particular option, its format and possible values\&. It will be quite hard to understand how to configure ejabberd by reading this document only \- for this purpose the reader is recommended to read online Configuration Guide available at https://docs\&.ejabberd\&.im/admin/configuration\&.
8888
.SH "TOP LEVEL OPTIONS"
8989
.sp
90-
This section describes top level options of ejabberd 25\&.08\&. The options that changed in this version are marked with 🟤\&.
90+
This section describes top level options of ejabberd 25\&.10\&. The options that changed in this version are marked with 🟤\&.
9191
.PP
9292
\fBaccess_rules\fR: \fI{AccessName: {allow|deny: ACLName|ACLDefinition}}\fR
9393
.RS 4
@@ -1282,17 +1282,12 @@ This option can be used to tune tick time parameter of
12821282
\fI1 minute\fR\&.
12831283
.RE
12841284
.PP
1285-
\fBnew_sql_schema\fR: \fItrue | false\fR
1285+
\fBnew_sql_schema 🟤\fR: \fItrue | false\fR
12861286
.RS 4
1287-
Whether to use the
1288-
\fIdatabase\&.md#default\-and\-new\-schemas|new SQL schema\fR\&. All schemas are located at
1289-
https://github\&.com/processone/ejabberd/tree/25\&.08/sql\&. There are two schemas available\&. The default legacy schema stores one XMPP domain into one ejabberd database\&. The
1290-
\fInew\fR
1291-
schema can handle several XMPP domains in a single ejabberd database\&. Using this
1292-
\fInew\fR
1293-
schema is best when serving several XMPP domains and/or changing domains from time to time\&. This avoid need to manage several databases and handle complex configuration changes\&. The default depends on configuration flag
1294-
\fI\-\-enable\-new\-sql\-schema\fR
1295-
which is set at compile time\&.
1287+
\fINote\fR
1288+
about this option: obsoleted in 25\&.10\&. This option was renamed to
1289+
\fIsql_schema_multihost\fR
1290+
in ejabberd 25\&.10\&. Please update your configuration to use the new option name
12961291
.RE
12971292
.PP
12981293
\fBoauth_access\fR: \fIAccessName\fR
@@ -1958,6 +1953,22 @@ or
19581953
if the latter is not set\&.
19591954
.RE
19601955
.PP
1956+
\fBsql_schema_multihost 🟤\fR: \fItrue | false\fR
1957+
.RS 4
1958+
\fINote\fR
1959+
about this option: renamed in 25\&.10\&. Whether to use the
1960+
\fIdatabase\&.md#default\-and\-new\-schemas|multihost SQL schema\fR\&. All schemas are located at
1961+
https://github\&.com/processone/ejabberd/tree/25\&.10/sql\&. There are two schemas available\&. The legacy
1962+
\fIsinglehost\fR
1963+
schema stores one XMPP domain into one ejabberd database\&. The
1964+
\fImultihost\fR
1965+
schema can handle several XMPP domains in a single ejabberd database\&. The
1966+
\fImultihost\fR
1967+
schema is preferable when serving several XMPP domains and/or changing domains from time to time\&. This avoid need to manage several databases and handle complex configuration changes\&. The default depends on configuration flag
1968+
\fI\-\-enable\-sql\-schema\-multihost\fR
1969+
which is set at compile time\&.
1970+
.RE
1971+
.PP
19611972
\fBsql_server\fR: \fIHost | IP Address | ODBC Connection String | Unix Socket Path\fR
19621973
.RS 4
19631974
\fINote\fR
@@ -2107,7 +2118,7 @@ seconds\&.
21072118
.RE
21082119
.SH "MODULES"
21092120
.sp
2110-
This section describes modules options of ejabberd 25\&.08\&. The modules that changed in this version are marked with 🟤\&.
2121+
This section describes modules options of ejabberd 25\&.10\&. The modules that changed in this version are marked with 🟤\&.
21112122
.SS "mod_adhoc"
21122123
.sp
21132124
def:ad\-hoc command
@@ -2277,7 +2288,7 @@ This module can be used to update existing SQL database from the default to the
22772288
The module has no options\&.
22782289
.SS "mod_announce"
22792290
.sp
2280-
This module enables configured users to broadcast announcements and to set the message of the day (MOTD)\&. Configured users can perform these actions with an XMPP client either using Ad\-Hoc Commands or sending messages to specific JIDs\&.
2291+
This module enables configured users to broadcast announcements and to set the message of the day (MOTD)\&. Configured users can perform these actions with an XMPP client either using Ad\-Hoc Commands or sending messages to specific JIDs\&. Equivalent API commands are also available\&.
22812292
.if n \{\
22822293
.sp
22832294
.\}
@@ -2462,6 +2473,8 @@ Same as top\-level
24622473
\fIuse_cache\fR
24632474
option, but applied to this module only\&.
24642475
.RE
2476+
.sp
2477+
\fBAPI Tags:\fR \fI\&.\&./\&.\&./developer/ejabberd\-api/admin\-tags\&.md#announce|announce\fR
24652478
.RE
24662479
.SS "mod_antispam"
24672480
.sp
@@ -2590,6 +2603,8 @@ modules:
25902603
.if n \{\
25912604
.RE
25922605
.\}
2606+
.sp
2607+
\fBAPI Tags:\fR \fI\&.\&./\&.\&./developer/ejabberd\-api/admin\-tags\&.md#spam|spam\fR
25932608
.RE
25942609
.SS "mod_auth_fast"
25952610
.sp
@@ -2708,9 +2723,11 @@ The option is supposed to be used when
27082723
\fIallow_local_users\fR
27092724
and
27102725
\fIallow_transports\fR
2711-
are not enough\&. It\(cqs an ACL where
2726+
are not enough\&. It\(cqs an Access Rule where
27122727
\fIdeny\fR
2713-
means the message will be rejected (or a CAPTCHA would be generated for a presence, if configured), and
2728+
means the stanza will be rejected; there\(cqs an exception if option
2729+
\fIcaptcha\fR
2730+
is configured\&. And
27142731
\fIallow\fR
27152732
means the sender is whitelisted and the stanza will pass through\&. The default value is
27162733
\fInone\fR, which means nothing is whitelisted\&.
@@ -2732,7 +2749,7 @@ and some server\(cqs JID is in user\(cqs roster, then messages from any user of
27322749
.PP
27332750
\fBcaptcha\fR: \fItrue | false\fR
27342751
.RS 4
2735-
Whether to generate CAPTCHA or not in response to messages from strangers\&. See also section
2752+
Whether to generate CAPTCHA challenges in response to incoming presence subscription requests from strangers\&. See also section
27362753
\fIbasic\&.md#captcha|CAPTCHA\fR
27372754
of the Configuration Guide\&. The default value is
27382755
\fIfalse\fR\&.
@@ -2956,7 +2973,9 @@ While a client is inactive, queue presence stanzas that indicate (un)availabilit
29562973
\fItrue\fR\&.
29572974
.RE
29582975
.RE
2959-
.SS "mod_configure"
2976+
.SS "mod_configure 🟤"
2977+
.sp
2978+
\fINote\fR about this option: improved in 25\&.10\&.
29602979
.sp
29612980
The module provides server configuration functionalities using XEP\-0030: Service Discovery and XEP\-0050: Ad\-Hoc Commands:
29622981
.sp
@@ -2994,6 +3013,100 @@ XEP\-0133: Service Administration
29943013
Additional custom ad\-hoc commands specific to ejabberd
29953014
.RE
29963015
.sp
3016+
Ad\-hoc commands from XEP\-0133 that behave differently to the XEP:
3017+
.sp
3018+
.RS 4
3019+
.ie n \{\
3020+
\h'-04'\(bu\h'+03'\c
3021+
.\}
3022+
.el \{\
3023+
.sp -1
3024+
.IP \(bu 2.3
3025+
.\}
3026+
get\-user\-roster: returns standard fields instead of roster items that client cannot display
3027+
.RE
3028+
.sp
3029+
Those ad\-hoc commands from XEP\-0133 do not include in the response the client that executed the command:
3030+
.sp
3031+
.RS 4
3032+
.ie n \{\
3033+
\h'-04'\(bu\h'+03'\c
3034+
.\}
3035+
.el \{\
3036+
.sp -1
3037+
.IP \(bu 2.3
3038+
.\}
3039+
get\-active\-users\-num
3040+
.RE
3041+
.sp
3042+
.RS 4
3043+
.ie n \{\
3044+
\h'-04'\(bu\h'+03'\c
3045+
.\}
3046+
.el \{\
3047+
.sp -1
3048+
.IP \(bu 2.3
3049+
.\}
3050+
get\-idle\-users\-num
3051+
.RE
3052+
.sp
3053+
.RS 4
3054+
.ie n \{\
3055+
\h'-04'\(bu\h'+03'\c
3056+
.\}
3057+
.el \{\
3058+
.sp -1
3059+
.IP \(bu 2.3
3060+
.\}
3061+
get\-active\-users
3062+
.RE
3063+
.sp
3064+
.RS 4
3065+
.ie n \{\
3066+
\h'-04'\(bu\h'+03'\c
3067+
.\}
3068+
.el \{\
3069+
.sp -1
3070+
.IP \(bu 2.3
3071+
.\}
3072+
get\-idle\-users
3073+
.RE
3074+
.sp
3075+
Those ad\-hoc commands from XEP\-0133 are not implemented:
3076+
.sp
3077+
.RS 4
3078+
.ie n \{\
3079+
\h'-04'\(bu\h'+03'\c
3080+
.\}
3081+
.el \{\
3082+
.sp -1
3083+
.IP \(bu 2.3
3084+
.\}
3085+
edit\-blacklist
3086+
.RE
3087+
.sp
3088+
.RS 4
3089+
.ie n \{\
3090+
\h'-04'\(bu\h'+03'\c
3091+
.\}
3092+
.el \{\
3093+
.sp -1
3094+
.IP \(bu 2.3
3095+
.\}
3096+
edit\-whitelist
3097+
.RE
3098+
.sp
3099+
.RS 4
3100+
.ie n \{\
3101+
\h'-04'\(bu\h'+03'\c
3102+
.\}
3103+
.el \{\
3104+
.sp -1
3105+
.IP \(bu 2.3
3106+
.\}
3107+
edit\-admin
3108+
.RE
3109+
.sp
29973110
This module requires \fImod_adhoc\fR (to execute the commands), and recommends \fImod_disco\fR (to discover the commands)\&.
29983111
.sp
29993112
Please notice that all the ad\-hoc commands implemented by this module have an equivalent API Command that you can execute using \fImod_adhoc_api\fR or any other API frontend\&.
@@ -4091,6 +4204,13 @@ This access rule defines who is allowed to modify the MAM preferences\&. The def
40914204
\fIall\fR\&.
40924205
.RE
40934206
.PP
4207+
\fBarchive_muc_as_mucsub 🟤\fR: \fItrue | false\fR
4208+
.RS 4
4209+
\fINote\fR
4210+
about this option: added in 25\&.10\&. When this option is enabled incoming groupchat messages for users that have mucsub subscription to a room from which message originated will have those messages archived after being converted to mucsub event messages\&.The default value is
4211+
\fIfalse\fR\&.
4212+
.RE
4213+
.PP
40944214
\fBassume_mam_usage\fR: \fItrue | false\fR
40954215
.RS 4
40964216
This option determines how ejabberd\(cqs stream management code (see
@@ -4176,7 +4296,7 @@ When this option is disabled, for each individual subscriber a separate mucsub m
41764296
.sp
41774297
\fBAPI Tags:\fR \fI\&.\&./\&.\&./developer/ejabberd\-api/admin\-tags\&.md#mam|mam\fR, \fI\&.\&./\&.\&./developer/ejabberd\-api/admin\-tags\&.md#purge|purge\fR
41784298
.RE
4179-
.SS "mod_matrix_gw 🟤"
4299+
.SS "mod_matrix_gw"
41804300
.sp
41814301
\fINote\fR about this option: improved in 25\&.08\&.
41824302
.sp
@@ -4861,10 +4981,10 @@ in order to accept their join in the room\&. The default value is
48614981
Short description of the room\&. The default value is an empty string\&.
48624982
.RE
48634983
.PP
4864-
\fBenable_hats\fR: \fItrue | false\fR
4984+
\fBenable_hats 🟤\fR: \fItrue | false\fR
48654985
.RS 4
48664986
\fINote\fR
4867-
about this option: improved in 25\&.03\&. Allow extended roles as defined in XEP\-0317 Hats\&. Check the
4987+
about this option: improved in 25\&.10\&. Allow extended roles as defined in XEP\-0317 Hats\&. Check the
48684988
\fI\&.\&./\&.\&./tutorials/muc\-hats\&.md|MUC Hats\fR
48694989
tutorial\&. The default value is
48704990
\fIfalse\fR\&.
@@ -6203,7 +6323,7 @@ modules:
62036323
.RE
62046324
.\}
62056325
.RE
6206-
.SS "mod_providers 🟤"
6326+
.SS "mod_providers"
62076327
.sp
62086328
\fINote\fR about this option: added in 25\&.08\&.
62096329
.sp
@@ -8862,21 +8982,21 @@ Should the operating system be revealed or not\&. The default value is
88628982
.RE
88638983
.SH "LISTENERS"
88648984
.sp
8865-
This section describes listeners options of ejabberd 25\&.08\&.
8985+
This section describes listeners options of ejabberd 25\&.10\&.
88668986
.sp
88678987
TODO
88688988
.SH "AUTHOR"
88698989
.sp
88708990
ProcessOne\&.
88718991
.SH "VERSION"
88728992
.sp
8873-
This document describes the configuration file of ejabberd 25\&.08\&. Configuration options of other ejabberd versions may differ significantly\&.
8993+
This document describes the configuration file of ejabberd 25\&.10\&. Configuration options of other ejabberd versions may differ significantly\&.
88748994
.SH "REPORTING BUGS"
88758995
.sp
88768996
Report bugs to https://github\&.com/processone/ejabberd/issues
88778997
.SH "SEE ALSO"
88788998
.sp
8879-
Default configuration file: https://github\&.com/processone/ejabberd/blob/25\&.08/ejabberd\&.yml\&.example
8999+
Default configuration file: https://github\&.com/processone/ejabberd/blob/25\&.10/ejabberd\&.yml\&.example
88809000
.sp
88819001
Main site: https://ejabberd\&.im
88829002
.sp

0 commit comments

Comments
 (0)