Chapril/xmpp.chapril.org-ejabberd
25
1
Fork 0
mirror of https://github.com/processone/ejabberd.git synced 2024-11-20 16:15:59 +01:00
Code Releases Activity

Update man page

Browse Source
This commit is contained in:
Badlop 2021-07-21 16:56:54 +02:00
parent 537c8b966e
commit ea795e4bd7
1 changed files with 32 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
man/ejabberd.yml.5
View File

@ -2,12 +2,12 @@
.\" Title: ejabberd.yml .\" Title: ejabberd.yml
.\" Author: [see the "AUTHOR" section] .\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 03/26/2021 .\" Date: 07/21/2021
.\" Manual: \ \& .\" Manual: \ \&
.\" Source: \ \& .\" Source: \ \&
.\" Language: English .\" Language: English
.\" .\"
.TH "EJABBERD\&.YML" "5" "03/26/2021" "\ \&" "\ \&" .TH "EJABBERD\&.YML" "5" "07/21/2021" "\ \&" "\ \&"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -82,7 +82,7 @@ All options can be changed in runtime by running \fIejabberdctl reload\-config\f
.sp .sp
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\&. 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\&.
.sp .sp
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/21\&.01/ejabberd\&.yml\&.example\&. Once you get ejabberd running you can start changing configuration options to meet your requirements\&. 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/21\&.07/ejabberd\&.yml\&.example\&. Once you get ejabberd running you can start changing configuration options to meet your requirements\&.
.sp .sp
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\&. 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\&.
.SH "TOP LEVEL OPTIONS" .SH "TOP LEVEL OPTIONS"
@ -378,6 +378,8 @@ that can be installed from the
\fIejabberd\-contrib\fR \fIejabberd\-contrib\fR
Git repository\&. Please refer to that module\(cqs README file for details\&. Git repository\&. Please refer to that module\(cqs README file for details\&.
.RE .RE
.sp
\fINote\fR about the next option: improved in 20\&.01:
.PP .PP
\fBauth_password_format\fR: \fIplain | scram\fR \fBauth_password_format\fR: \fIplain | scram\fR
.RS 4 .RS 4
@ -996,7 +998,7 @@ minute\&.
Whether to use Whether to use
\fInew\fR \fInew\fR
SQL schema\&. All schemas are located at SQL schema\&. All schemas are located at
https://github\&.com/processone/ejabberd/tree/21\&.01/sql\&. There are two schemas available\&. The default legacy schema allows to store one XMPP domain into one ejabberd database\&. The https://github\&.com/processone/ejabberd/tree/21\&.07/sql\&. There are two schemas available\&. The default legacy schema allows to store one XMPP domain into one ejabberd database\&. The
\fInew\fR \fInew\fR
schema allows to handle several XMPP domains in a single ejabberd database\&. Using this schema allows to handle several XMPP domains in a single ejabberd database\&. Using this
\fInew\fR \fInew\fR
@ -1029,6 +1031,8 @@ Same as
\fIcache_missed\fR \fIcache_missed\fR
will be used\&. will be used\&.
.RE .RE
.sp
\fINote\fR about the next option: added in 21\&.01:
.PP .PP
\fBoauth_cache_rest_failure_life_time\fR: \fItimeout()\fR \fBoauth_cache_rest_failure_life_time\fR: \fItimeout()\fR
.RS 4 .RS 4
@ -1110,12 +1114,16 @@ Specify which address families to try, in what order\&. The default is
\fI[ipv4, ipv6]\fR \fI[ipv4, ipv6]\fR
which means it first tries connecting with IPv4, if that fails it tries using IPv6\&. which means it first tries connecting with IPv4, if that fails it tries using IPv6\&.
.RE .RE
.sp
\fINote\fR about the next option: added in 20\&.12:
.PP .PP
\fBoutgoing_s2s_ipv4_address\fR: \fIAddress\fR \fBoutgoing_s2s_ipv4_address\fR: \fIAddress\fR
.RS 4 .RS 4
Specify the IPv4 address that will be used when establishing an outgoing S2S IPv4 connection, for example "127\&.0\&.0\&.1"\&. The default value is Specify the IPv4 address that will be used when establishing an outgoing S2S IPv4 connection, for example "127\&.0\&.0\&.1"\&. The default value is
\fIundefined\fR\&. \fIundefined\fR\&.
.RE .RE
.sp
\fINote\fR about the next option: added in 20\&.12:
.PP .PP
\fBoutgoing_s2s_ipv6_address\fR: \fIAddress\fR \fBoutgoing_s2s_ipv6_address\fR: \fIAddress\fR
.RS 4 .RS 4
@ -1542,6 +1550,8 @@ An SQL database name\&. For SQLite this must be a full path to a database file\&
.RS 4 .RS 4
An interval to make a dummy SQL request to keep alive the connections to the database\&. There is no default value, so no keepalive requests are made\&. An interval to make a dummy SQL request to keep alive the connections to the database\&. There is no default value, so no keepalive requests are made\&.
.RE .RE
.sp
\fINote\fR about the next option: added in 20\&.12:
.PP .PP
\fBsql_odbc_driver\fR: \fIPath\fR \fBsql_odbc_driver\fR: \fIPath\fR
.RS 4 .RS 4
@ -1574,6 +1584,8 @@ for PostgreSQL and
\fI1433\fR \fI1433\fR
for MS SQL\&. The option has no effect for SQLite\&. for MS SQL\&. The option has no effect for SQLite\&.
.RE .RE
.sp
\fINote\fR about the next option: added in 20\&.01:
.PP .PP
\fBsql_prepared_statements\fR: \fItrue | false\fR \fBsql_prepared_statements\fR: \fItrue | false\fR
.RS 4 .RS 4
@ -1605,10 +1617,12 @@ if the latter is not set\&.
A hostname or an IP address of the SQL server\&. The default value is A hostname or an IP address of the SQL server\&. The default value is
\fIlocalhost\fR\&. \fIlocalhost\fR\&.
.RE .RE
.sp
\fINote\fR about the next option: improved in 20\&.03:
.PP .PP
\fBsql_ssl\fR: \fItrue | false\fR \fBsql_ssl\fR: \fItrue | false\fR
.RS 4 .RS 4
Whether to use SSL encrypted connections to the SQL server\&. The option is only available for PostgreSQL\&. The default value is Whether to use SSL encrypted connections to the SQL server\&. The option is only available for MySQL and PostgreSQL\&. The default value is
\fIfalse\fR\&. \fIfalse\fR\&.
.RE .RE
.PP .PP
@ -1870,7 +1884,7 @@ ejabberdctl srg\-create g1 example\&.org "\*(AqGroup number 1\*(Aq" this_is_g1 g
.RE .RE
.SS "mod_admin_update_sql" .SS "mod_admin_update_sql"
.sp .sp
This module can be used to update existing SQL database from the default to the new schema\&. Check the section Default and New Schemas for details\&. When the module is loaded use \fIupdate_sql\fR ejabberdctl command\&. This module can be used to update existing SQL database from the default to the new schema\&. Check the section Default and New Schemas for details\&. Please note that only PostgreSQL is supported\&. When the module is loaded use \fIupdate_sql\fR ejabberdctl command\&.
.sp .sp
The module has no options\&. The module has no options\&.
.SS "mod_announce" .SS "mod_announce"
@ -3749,12 +3763,16 @@ option is not specified, the only Jabber ID will be the hostname of the virtual
\fI@HOST@\fR \fI@HOST@\fR
is replaced with the real virtual host name\&. is replaced with the real virtual host name\&.
.RE .RE
.sp
\fINote\fR about the next option: added in 21\&.01:
.PP .PP
\fBmax_captcha_whitelist\fR: \fINumber\fR \fBmax_captcha_whitelist\fR: \fINumber\fR
.RS 4 .RS 4
This option defines the maximum number of characters that Captcha Whitelist can have when configuring the room\&. The default value is This option defines the maximum number of characters that Captcha Whitelist can have when configuring the room\&. The default value is
\fIinfinity\fR\&. \fIinfinity\fR\&.
.RE .RE
.sp
\fINote\fR about the next option: added in 21\&.01:
.PP .PP
\fBmax_password\fR: \fINumber\fR \fBmax_password\fR: \fINumber\fR
.RS 4 .RS 4
@ -3840,10 +3858,11 @@ Same as top\-level
option, but applied to this module only\&. option, but applied to this module only\&.
.RE .RE
.PP .PP
\fBram_db_type\fR: \fImnesia\fR \fBram_db_type\fR: \fImnesia | sql\fR
.RS 4 .RS 4
Define the type of volatile (in\-memory) storage where the module will store room information\&. The only available value for this module is Define the type of volatile (in\-memory) storage where the module will store room information (\fImuc_online_room\fR
\fImnesia\fR\&. and
\fImuc_online_users\fR)\&.
.RE .RE
.PP .PP
\fBregexp_room_id\fR: \fIstring()\fR \fBregexp_room_id\fR: \fIstring()\fR
@ -5422,7 +5441,7 @@ This option specifies the period of time until the session of a disconnected pus
\fImod_stream_mgmt\fR \fImod_stream_mgmt\fR
module is restored\&. The default value is module is restored\&. The default value is
\fI72\fR \fI72\fR
minutes\&. hours\&.
.RE .RE
.PP .PP
\fBwake_on_start\fR: \fItrue | false\fR \fBwake_on_start\fR: \fItrue | false\fR
@ -6556,7 +6575,7 @@ minutes\&.
.RE .RE
.SS "mod_stun_disco" .SS "mod_stun_disco"
.sp .sp
This module allows XMPP clients to discover STUN/TURN services and to obtain temporary credentials for using them as per XEP\-0215: External Service Discovery\&. This module allows XMPP clients to discover STUN/TURN services and to obtain temporary credentials for using them as per XEP\-0215: External Service Discovery\&. This module is included in ejabberd since version 20\&.04\&.
.sp .sp
.it 1 an-trap .it 1 an-trap
.nr an-no-space-flag 1 .nr an-no-space-flag 1
@ -7170,13 +7189,13 @@ TODO
ProcessOne\&. ProcessOne\&.
.SH "VERSION" .SH "VERSION"
.sp .sp
This document describes the configuration file of ejabberd 21\&.01\&.81\&. Configuration options of other ejabberd versions may differ significantly\&. This document describes the configuration file of ejabberd 21\&.04\&.131\&. Configuration options of other ejabberd versions may differ significantly\&.
.SH "REPORTING BUGS" .SH "REPORTING BUGS"
.sp .sp
Report bugs to https://github\&.com/processone/ejabberd/issues Report bugs to https://github\&.com/processone/ejabberd/issues
.SH "SEE ALSO" .SH "SEE ALSO"
.sp .sp
Default configuration file: https://github\&.com/processone/ejabberd/blob/21\&.01/ejabberd\&.yml\&.example Default configuration file: https://github\&.com/processone/ejabberd/blob/21\&.07/ejabberd\&.yml\&.example
.sp .sp
Main site: https://ejabberd\&.im Main site: https://ejabberd\&.im
.sp .sp