mirror of
https://github.com/processone/ejabberd.git
synced 2024-06-02 21:17:12 +02:00
Document in the guide the db_type modules option (EJAB-1560)
This commit is contained in:
parent
2dc2769c92
commit
625e801431
137
doc/guide.tex
137
doc/guide.tex
|
@ -66,9 +66,7 @@
|
||||||
\newcommand{\module}[1]{\texttt{#1}}
|
\newcommand{\module}[1]{\texttt{#1}}
|
||||||
\newcommand{\modadhoc}{\module{mod\_adhoc}}
|
\newcommand{\modadhoc}{\module{mod\_adhoc}}
|
||||||
\newcommand{\modannounce}{\module{mod\_announce}}
|
\newcommand{\modannounce}{\module{mod\_announce}}
|
||||||
\newcommand{\modannounceodbc}{\module{mod\_announce\_odbc}}
|
|
||||||
\newcommand{\modblocking}{\module{mod\_blocking}}
|
\newcommand{\modblocking}{\module{mod\_blocking}}
|
||||||
\newcommand{\modblockingodbc}{\module{mod\_blocking\_odbc}}
|
|
||||||
\newcommand{\modcaps}{\module{mod\_caps}}
|
\newcommand{\modcaps}{\module{mod\_caps}}
|
||||||
\newcommand{\modconfigure}{\module{mod\_configure}}
|
\newcommand{\modconfigure}{\module{mod\_configure}}
|
||||||
\newcommand{\moddisco}{\module{mod\_disco}}
|
\newcommand{\moddisco}{\module{mod\_disco}}
|
||||||
|
@ -76,39 +74,29 @@
|
||||||
\newcommand{\modhttpbind}{\module{mod\_http\_bind}}
|
\newcommand{\modhttpbind}{\module{mod\_http\_bind}}
|
||||||
\newcommand{\modhttpfileserver}{\module{mod\_http\_fileserver}}
|
\newcommand{\modhttpfileserver}{\module{mod\_http\_fileserver}}
|
||||||
\newcommand{\modirc}{\module{mod\_irc}}
|
\newcommand{\modirc}{\module{mod\_irc}}
|
||||||
\newcommand{\modircodbc}{\module{mod\_irc\_odbc}}
|
|
||||||
\newcommand{\modlast}{\module{mod\_last}}
|
\newcommand{\modlast}{\module{mod\_last}}
|
||||||
\newcommand{\modlastodbc}{\module{mod\_last\_odbc}}
|
|
||||||
\newcommand{\modmuc}{\module{mod\_muc}}
|
\newcommand{\modmuc}{\module{mod\_muc}}
|
||||||
\newcommand{\modmucodbc}{\module{mod\_muc\_odbc}}
|
|
||||||
\newcommand{\modmuclog}{\module{mod\_muc\_log}}
|
\newcommand{\modmuclog}{\module{mod\_muc\_log}}
|
||||||
\newcommand{\modoffline}{\module{mod\_offline}}
|
\newcommand{\modoffline}{\module{mod\_offline}}
|
||||||
\newcommand{\modofflineodbc}{\module{mod\_offline\_odbc}}
|
|
||||||
\newcommand{\modping}{\module{mod\_ping}}
|
\newcommand{\modping}{\module{mod\_ping}}
|
||||||
\newcommand{\modprescounter}{\module{mod\_pres\_counter}}
|
\newcommand{\modprescounter}{\module{mod\_pres\_counter}}
|
||||||
\newcommand{\modprivacy}{\module{mod\_privacy}}
|
\newcommand{\modprivacy}{\module{mod\_privacy}}
|
||||||
\newcommand{\modprivacyodbc}{\module{mod\_privacy\_odbc}}
|
|
||||||
\newcommand{\modprivate}{\module{mod\_private}}
|
\newcommand{\modprivate}{\module{mod\_private}}
|
||||||
\newcommand{\modprivateodbc}{\module{mod\_private\_odbc}}
|
|
||||||
\newcommand{\modproxy}{\module{mod\_proxy65}}
|
\newcommand{\modproxy}{\module{mod\_proxy65}}
|
||||||
\newcommand{\modpubsub}{\module{mod\_pubsub}}
|
\newcommand{\modpubsub}{\module{mod\_pubsub}}
|
||||||
\newcommand{\modpubsubodbc}{\module{mod\_pubsub\_odbc}}
|
\newcommand{\modpubsubodbc}{\module{mod\_pubsub\_odbc}}
|
||||||
\newcommand{\modregister}{\module{mod\_register}}
|
\newcommand{\modregister}{\module{mod\_register}}
|
||||||
\newcommand{\modregisterweb}{\module{mod\_register\_web}}
|
\newcommand{\modregisterweb}{\module{mod\_register\_web}}
|
||||||
\newcommand{\modroster}{\module{mod\_roster}}
|
\newcommand{\modroster}{\module{mod\_roster}}
|
||||||
\newcommand{\modrosterodbc}{\module{mod\_roster\_odbc}}
|
|
||||||
\newcommand{\modservicelog}{\module{mod\_service\_log}}
|
\newcommand{\modservicelog}{\module{mod\_service\_log}}
|
||||||
\newcommand{\modsharedroster}{\module{mod\_shared\_roster}}
|
\newcommand{\modsharedroster}{\module{mod\_shared\_roster}}
|
||||||
\newcommand{\modsharedrosterodbc}{\module{mod\_shared\_roster\_odbc}}
|
|
||||||
\newcommand{\modsharedrosterldap}{\module{mod\_shared\_roster\_ldap}}
|
\newcommand{\modsharedrosterldap}{\module{mod\_shared\_roster\_ldap}}
|
||||||
\newcommand{\modsic}{\module{mod\_sic}}
|
\newcommand{\modsic}{\module{mod\_sic}}
|
||||||
\newcommand{\modstats}{\module{mod\_stats}}
|
\newcommand{\modstats}{\module{mod\_stats}}
|
||||||
\newcommand{\modtime}{\module{mod\_time}}
|
\newcommand{\modtime}{\module{mod\_time}}
|
||||||
\newcommand{\modvcard}{\module{mod\_vcard}}
|
\newcommand{\modvcard}{\module{mod\_vcard}}
|
||||||
\newcommand{\modvcardldap}{\module{mod\_vcard\_ldap}}
|
\newcommand{\modvcardldap}{\module{mod\_vcard\_ldap}}
|
||||||
\newcommand{\modvcardodbc}{\module{mod\_vcard\_odbc}}
|
|
||||||
\newcommand{\modvcardxupdate}{\module{mod\_vcard\_xupdate}}
|
\newcommand{\modvcardxupdate}{\module{mod\_vcard\_xupdate}}
|
||||||
\newcommand{\modvcardxupdateodbc}{\module{mod\_vcard\_xupdate\_odbc}}
|
|
||||||
\newcommand{\modversion}{\module{mod\_version}}
|
\newcommand{\modversion}{\module{mod\_version}}
|
||||||
|
|
||||||
%% Contributed modules
|
%% Contributed modules
|
||||||
|
@ -129,6 +117,11 @@ the processing discipline for #1 IQ queries (see section~\ref{modiqdiscoption}).
|
||||||
hostname of the virtual host with the prefix `\jid{#1.}'. The keyword "@HOST@"
|
hostname of the virtual host with the prefix `\jid{#1.}'. The keyword "@HOST@"
|
||||||
is replaced at start time with the real virtual host name.
|
is replaced at start time with the real virtual host name.
|
||||||
}
|
}
|
||||||
|
\newcommand{\dbtype}{\titem{\{db\_type, mnesia|odbc\}} \ind{options!dbtype}
|
||||||
|
Define the type of storage where the module will create the tables and store user information.
|
||||||
|
The default is to store in the internal Mnesia database.
|
||||||
|
If \term{odbc} value is defined, make sure you have defined the database, see~\ref{database}.
|
||||||
|
}
|
||||||
|
|
||||||
%% Title page
|
%% Title page
|
||||||
\include{version}
|
\include{version}
|
||||||
|
@ -1312,7 +1305,7 @@ These are the specific options:
|
||||||
the authentication information since the user last disconnected,
|
the authentication information since the user last disconnected,
|
||||||
to verify again the user authentication without querying again the extauth script.
|
to verify again the user authentication without querying again the extauth script.
|
||||||
Note: caching should not be enabled in a host if internal auth is also enabled.
|
Note: caching should not be enabled in a host if internal auth is also enabled.
|
||||||
If caching is enabled, \term{mod\_last} or \term{mod\_last\_odbc} must be enabled also in that vhost.
|
If caching is enabled, \term{mod\_last} must be enabled also in that vhost.
|
||||||
\end{description}
|
\end{description}
|
||||||
|
|
||||||
This example sets external authentication, the extauth script, enables caching for 10 minutes,
|
This example sets external authentication, the extauth script, enables caching for 10 minutes,
|
||||||
|
@ -2028,12 +2021,10 @@ MySQL interface. Anyway, the first configuration step is to define the odbc
|
||||||
\ind{MySQL!storage}
|
\ind{MySQL!storage}
|
||||||
|
|
||||||
MySQL also can be used to store information into from several \ejabberd{}
|
MySQL also can be used to store information into from several \ejabberd{}
|
||||||
modules. See section~\ref{modoverview} to see which modules have a version
|
modules. See section~\ref{modoverview} to see which modules can be used with
|
||||||
with the `\_odbc'. This suffix indicates that the module can be used with
|
|
||||||
relational databases like MySQL. To enable storage to your database, just make
|
relational databases like MySQL. To enable storage to your database, just make
|
||||||
sure that your database is running well (see previous sections), and replace the
|
sure that your database is running well (see previous sections), and add the
|
||||||
suffix-less or ldap module variant with the odbc module variant. Keep in mind
|
module option \term{\{db\_type, odbc\}}.
|
||||||
that you cannot have several variants of the same module loaded!
|
|
||||||
|
|
||||||
\makesubsection{mssql}{Microsoft SQL Server}
|
\makesubsection{mssql}{Microsoft SQL Server}
|
||||||
\ind{Microsoft SQL Server}\ind{Microsoft SQL Server!schema}
|
\ind{Microsoft SQL Server}\ind{Microsoft SQL Server!schema}
|
||||||
|
@ -2085,13 +2076,10 @@ ODBC compatible servers (see section~\ref{odbcauth}).
|
||||||
\ind{Microsoft SQL Server!storage}
|
\ind{Microsoft SQL Server!storage}
|
||||||
|
|
||||||
Microsoft SQL Server also can be used to store information into from several
|
Microsoft SQL Server also can be used to store information into from several
|
||||||
\ejabberd{} modules. See section~\ref{modoverview} to see which modules have
|
modules. See section~\ref{modoverview} to see which modules can be used with
|
||||||
a version with the `\_odbc'. This suffix indicates that the module can be used
|
relational databases like MySQL. To enable storage to your database, just make
|
||||||
with relational databases like Microsoft SQL Server. To enable storage to your
|
sure that your database is running well (see previous sections), and add the
|
||||||
database, just make sure that your database is running well (see previous
|
module option \term{\{db\_type, odbc\}}.
|
||||||
sections), and replace the suffix-less or ldap module variant with the odbc
|
|
||||||
module variant. Keep in mind that you cannot have several variants of the same
|
|
||||||
module loaded!
|
|
||||||
|
|
||||||
\makesubsection{pgsql}{PostgreSQL}
|
\makesubsection{pgsql}{PostgreSQL}
|
||||||
\ind{PostgreSQL}\ind{PostgreSQL!schema}
|
\ind{PostgreSQL}\ind{PostgreSQL!schema}
|
||||||
|
@ -2183,12 +2171,10 @@ PostgreSQL interface. Anyway, the first configuration step is to define the odbc
|
||||||
\ind{PostgreSQL!storage}
|
\ind{PostgreSQL!storage}
|
||||||
|
|
||||||
PostgreSQL also can be used to store information into from several \ejabberd{}
|
PostgreSQL also can be used to store information into from several \ejabberd{}
|
||||||
modules. See section~\ref{modoverview} to see which modules have a version
|
modules. See section~\ref{modoverview} to see which modules can be used with
|
||||||
with the `\_odbc'. This suffix indicates that the module can be used with
|
relational databases like MySQL. To enable storage to your database, just make
|
||||||
relational databases like PostgreSQL. To enable storage to your database, just
|
sure that your database is running well (see previous sections), and add the
|
||||||
make sure that your database is running well (see previous sections), and
|
module option \term{\{db\_type, odbc\}}.
|
||||||
replace the suffix-less or ldap module variant with the odbc module variant.
|
|
||||||
Keep in mind that you cannot have several variants of the same module loaded!
|
|
||||||
|
|
||||||
\makesubsection{odbc}{ODBC Compatible}
|
\makesubsection{odbc}{ODBC Compatible}
|
||||||
\ind{databases!ODBC}
|
\ind{databases!ODBC}
|
||||||
|
@ -2260,13 +2246,11 @@ example:
|
||||||
\ind{ODBC!storage}
|
\ind{ODBC!storage}
|
||||||
|
|
||||||
An ODBC compatible database also can be used to store information into from
|
An ODBC compatible database also can be used to store information into from
|
||||||
several \ejabberd{} modules. See section~\ref{modoverview} to see which
|
several \ejabberd{}
|
||||||
modules have a version with the `\_odbc'. This suffix indicates that the module
|
modules. See section~\ref{modoverview} to see which modules can be used with
|
||||||
can be used with ODBC compatible relational databases. To enable storage to your
|
relational databases like MySQL. To enable storage to your database, just make
|
||||||
database, just make sure that your database is running well (see previous
|
sure that your database is running well (see previous sections), and add the
|
||||||
sections), and replace the suffix-less or ldap module variant with the odbc
|
module option \term{\{db\_type, odbc\}}.
|
||||||
module variant. Keep in mind that you cannot have several variants of the same
|
|
||||||
module loaded!
|
|
||||||
|
|
||||||
\makesubsection{ldap}{LDAP}
|
\makesubsection{ldap}{LDAP}
|
||||||
\ind{databases!LDAP}
|
\ind{databases!LDAP}
|
||||||
|
@ -2584,10 +2568,7 @@ The following table lists all modules included in \ejabberd{}.
|
||||||
\hline
|
\hline
|
||||||
\hline \modadhoc{} & Ad-Hoc Commands (\xepref{0050}) & \\
|
\hline \modadhoc{} & Ad-Hoc Commands (\xepref{0050}) & \\
|
||||||
\hline \ahrefloc{modannounce}{\modannounce{}} & Manage announcements & recommends \modadhoc{} \\
|
\hline \ahrefloc{modannounce}{\modannounce{}} & Manage announcements & recommends \modadhoc{} \\
|
||||||
\hline \ahrefloc{modannounce}{\modannounceodbc{}} & Manage announcements & recommends \modadhoc{} \\
|
|
||||||
& & supported DB (*) \\
|
|
||||||
\hline \modblocking{} & Simple Communications Blocking (\xepref{0191}) & \modprivacy{} \\
|
\hline \modblocking{} & Simple Communications Blocking (\xepref{0191}) & \modprivacy{} \\
|
||||||
\hline \modblockingodbc{} & Simple Communications Blocking (\xepref{0191}) & \modprivacyodbc{} \\
|
|
||||||
\hline \modcaps{} & Entity Capabilities (\xepref{0115}) & \\
|
\hline \modcaps{} & Entity Capabilities (\xepref{0115}) & \\
|
||||||
\hline \modconfigure{} & Server configuration using Ad-Hoc & \modadhoc{} \\
|
\hline \modconfigure{} & Server configuration using Ad-Hoc & \modadhoc{} \\
|
||||||
\hline \ahrefloc{moddisco}{\moddisco{}} & Service Discovery (\xepref{0030}) & \\
|
\hline \ahrefloc{moddisco}{\moddisco{}} & Service Discovery (\xepref{0030}) & \\
|
||||||
|
@ -2595,42 +2576,29 @@ The following table lists all modules included in \ejabberd{}.
|
||||||
\hline \ahrefloc{modhttpbind}{\modhttpbind{}} & XMPP over Bosh service (HTTP Binding) & \\
|
\hline \ahrefloc{modhttpbind}{\modhttpbind{}} & XMPP over Bosh service (HTTP Binding) & \\
|
||||||
\hline \ahrefloc{modhttpfileserver}{\modhttpfileserver{}} & Small HTTP file server & \\
|
\hline \ahrefloc{modhttpfileserver}{\modhttpfileserver{}} & Small HTTP file server & \\
|
||||||
\hline \ahrefloc{modirc}{\modirc{}} & IRC transport & \\
|
\hline \ahrefloc{modirc}{\modirc{}} & IRC transport & \\
|
||||||
\hline \ahrefloc{modirc}{\modircodbc{}} & IRC transport & supported DB (*) \\
|
|
||||||
\hline \ahrefloc{modlast}{\modlast{}} & Last Activity (\xepref{0012}) & \\
|
\hline \ahrefloc{modlast}{\modlast{}} & Last Activity (\xepref{0012}) & \\
|
||||||
\hline \ahrefloc{modlast}{\modlastodbc{}} & Last Activity (\xepref{0012}) & supported DB (*) \\
|
|
||||||
\hline \ahrefloc{modmuc}{\modmuc{}} & Multi-User Chat (\xepref{0045}) & \\
|
\hline \ahrefloc{modmuc}{\modmuc{}} & Multi-User Chat (\xepref{0045}) & \\
|
||||||
\hline \ahrefloc{modmuc}{\modmucodbc{}} & Multi-User Chat (\xepref{0045}) & supported DB (*) \\
|
\hline \ahrefloc{modmuclog}{\modmuclog{}} & Multi-User Chat room logging & \modmuc{} \\
|
||||||
\hline \ahrefloc{modmuclog}{\modmuclog{}} & Multi-User Chat room logging & \modmuc{} or \modmucodbc{} \\
|
|
||||||
\hline \ahrefloc{modoffline}{\modoffline{}} & Offline message storage (\xepref{0160}) & \\
|
\hline \ahrefloc{modoffline}{\modoffline{}} & Offline message storage (\xepref{0160}) & \\
|
||||||
\hline \ahrefloc{modoffline}{\modofflineodbc{}} & Offline message storage (\xepref{0160}) & supported DB (*) \\
|
|
||||||
\hline \ahrefloc{modping}{\modping{}} & XMPP Ping and periodic keepalives (\xepref{0199}) & \\
|
\hline \ahrefloc{modping}{\modping{}} & XMPP Ping and periodic keepalives (\xepref{0199}) & \\
|
||||||
\hline \ahrefloc{modprescounter}{\modprescounter{}} & Detect presence subscription flood & \\
|
\hline \ahrefloc{modprescounter}{\modprescounter{}} & Detect presence subscription flood & \\
|
||||||
\hline \ahrefloc{modprivacy}{\modprivacy{}} & Blocking Communication (\xepref{0016}) & \\
|
\hline \ahrefloc{modprivacy}{\modprivacy{}} & Blocking Communication (\xepref{0016}) & \\
|
||||||
\hline \ahrefloc{modprivacy}{\modprivacyodbc{}} & Blocking Communication (\xepref{0016}) & supported DB (*) \\
|
|
||||||
\hline \ahrefloc{modprivate}{\modprivate{}} & Private XML Storage (\xepref{0049}) & \\
|
\hline \ahrefloc{modprivate}{\modprivate{}} & Private XML Storage (\xepref{0049}) & \\
|
||||||
\hline \ahrefloc{modprivate}{\modprivateodbc{}} & Private XML Storage (\xepref{0049}) & supported DB (*) \\
|
|
||||||
\hline \ahrefloc{modproxy}{\modproxy{}} & SOCKS5 Bytestreams (\xepref{0065}) & \\
|
\hline \ahrefloc{modproxy}{\modproxy{}} & SOCKS5 Bytestreams (\xepref{0065}) & \\
|
||||||
\hline \ahrefloc{modpubsub}{\modpubsub{}} & Pub-Sub (\xepref{0060}), PEP (\xepref{0163}) & \modcaps{} \\
|
\hline \ahrefloc{modpubsub}{\modpubsub{}} & Pub-Sub (\xepref{0060}), PEP (\xepref{0163}) & \modcaps{} \\
|
||||||
\hline \ahrefloc{modpubsub}{\modpubsubodbc{}} & Pub-Sub (\xepref{0060}), PEP (\xepref{0163}) & supported DB (*) and \modcaps{} \\
|
\hline \ahrefloc{modpubsub}{\modpubsubodbc{}} & Pub-Sub (\xepref{0060}), PEP (\xepref{0163}) & supported DB (*) and \modcaps{} \\
|
||||||
\hline \ahrefloc{modregister}{\modregister{}} & In-Band Registration (\xepref{0077}) & \\
|
\hline \ahrefloc{modregister}{\modregister{}} & In-Band Registration (\xepref{0077}) & \\
|
||||||
\hline \ahrefloc{modregisterweb}{\modregisterweb{}} & Web for Account Registrations & \\
|
\hline \ahrefloc{modregisterweb}{\modregisterweb{}} & Web for Account Registrations & \\
|
||||||
\hline \ahrefloc{modroster}{\modroster{}} & Roster management (XMPP IM) & \\
|
\hline \ahrefloc{modroster}{\modroster{}} & Roster management (XMPP IM) & \\
|
||||||
\hline \ahrefloc{modroster}{\modrosterodbc{}} & Roster management (XMPP IM) & supported DB (*) \\
|
|
||||||
\hline \ahrefloc{modservicelog}{\modservicelog{}} & Copy user messages to logger service & \\
|
\hline \ahrefloc{modservicelog}{\modservicelog{}} & Copy user messages to logger service & \\
|
||||||
\hline \ahrefloc{modsharedroster}{\modsharedroster{}} & Shared roster management & \modroster{} or \\
|
\hline \ahrefloc{modsharedroster}{\modsharedroster{}} & Shared roster management & \modroster{} \\
|
||||||
& & \modrosterodbc\\
|
\hline \ahrefloc{modsharedrosterldap}{\modsharedrosterldap{}} & LDAP Shared roster management & \modroster{} \\
|
||||||
\hline \ahrefloc{modsharedroster}{\modsharedrosterodbc{}} & Shared roster management & supported DB (*) and\\
|
|
||||||
& & \modroster{} or \modrosterodbc\\
|
|
||||||
\hline \ahrefloc{modsharedrosterldap}{\modsharedrosterldap{}} & LDAP Shared roster management & \modroster{} or \\
|
|
||||||
& & \modrosterodbc\\
|
|
||||||
\hline \ahrefloc{modsic}{\modsic{}} & Server IP Check (\xepref{0279}) & \\
|
\hline \ahrefloc{modsic}{\modsic{}} & Server IP Check (\xepref{0279}) & \\
|
||||||
\hline \ahrefloc{modstats}{\modstats{}} & Statistics Gathering (\xepref{0039}) & \\
|
\hline \ahrefloc{modstats}{\modstats{}} & Statistics Gathering (\xepref{0039}) & \\
|
||||||
\hline \ahrefloc{modtime}{\modtime{}} & Entity Time (\xepref{0202}) & \\
|
\hline \ahrefloc{modtime}{\modtime{}} & Entity Time (\xepref{0202}) & \\
|
||||||
\hline \ahrefloc{modvcard}{\modvcard{}} & vcard-temp (\xepref{0054}) & \\
|
\hline \ahrefloc{modvcard}{\modvcard{}} & vcard-temp (\xepref{0054}) & \\
|
||||||
\hline \ahrefloc{modvcardldap}{\modvcardldap{}} & vcard-temp (\xepref{0054}) & LDAP server \\
|
\hline \ahrefloc{modvcardldap}{\modvcardldap{}} & vcard-temp (\xepref{0054}) & LDAP server \\
|
||||||
\hline \ahrefloc{modvcard}{\modvcardodbc{}} & vcard-temp (\xepref{0054}) & supported DB (*) \\
|
\hline \ahrefloc{modvcardxupdate}{\modvcardxupdate{}} & vCard-Based Avatars (\xepref{0153}) & \modvcard{} \\
|
||||||
\hline \ahrefloc{modvcardxupdate}{\modvcardxupdate{}} & vCard-Based Avatars (\xepref{0153}) & \modvcard{} or \modvcardodbc{} \\
|
|
||||||
\hline \ahrefloc{modvcardxupdate}{\modvcardxupdateodbc{}} & vCard-Based Avatars (\xepref{0153}) & \modvcard{} or \modvcardodbc{} \\
|
|
||||||
\hline \ahrefloc{modversion}{\modversion{}} & Software Version (\xepref{0092}) & \\
|
\hline \ahrefloc{modversion}{\modversion{}} & Software Version (\xepref{0092}) & \\
|
||||||
\hline
|
\hline
|
||||||
\end{tabular}
|
\end{tabular}
|
||||||
|
@ -2642,37 +2610,11 @@ The following table lists all modules included in \ejabberd{}.
|
||||||
|
|
||||||
You can see which database backend each module needs by looking at the suffix:
|
You can see which database backend each module needs by looking at the suffix:
|
||||||
\begin{itemize}
|
\begin{itemize}
|
||||||
\item No suffix, this means that the modules uses Erlang's built-in database
|
\item No suffix, this means that the module uses Erlang's built-in database
|
||||||
Mnesia as backend.
|
Mnesia as backend, or a ODBC database in some cases (see~\ref{database}).
|
||||||
\item `\_odbc', this means that the module needs a supported database
|
|
||||||
(see~\ref{database}) as backend.
|
|
||||||
\item `\_ldap', this means that the module needs an LDAP server as backend.
|
\item `\_ldap', this means that the module needs an LDAP server as backend.
|
||||||
\end{itemize}
|
\end{itemize}
|
||||||
|
|
||||||
If you want to,
|
|
||||||
it is possible to use a relational database to store the tables created by some ejabberd modules.
|
|
||||||
You can do this by changing the module name to a name with an
|
|
||||||
\term{\_odbc} suffix in \ejabberd{} config file. You can use a relational
|
|
||||||
database for the following data:
|
|
||||||
|
|
||||||
\begin{itemize}
|
|
||||||
\item Last connection date and time: Use \term{mod\_last\_odbc} instead of
|
|
||||||
\term{mod\_last}.
|
|
||||||
\item Offline messages: Use \term{mod\_offline\_odbc} instead of
|
|
||||||
\term{mod\_offline}.
|
|
||||||
\item Rosters: Use \term{mod\_roster\_odbc} instead of \term{mod\_roster}.
|
|
||||||
\item Shared Rosters: Use \term{mod\_shared\_roster\_odbc} instead of \term{mod\_shared\_roster}.
|
|
||||||
\item Users' VCARD: Use \term{mod\_vcard\_odbc} instead of \term{mod\_vcard}.
|
|
||||||
\item vCard-Based Avatars: Use \term{mod\_vcard\_xupdate\_odbc} instead of \term{mod\_vcard\_xupdate}.
|
|
||||||
\item Private XML storage: Use \term{mod\_private\_odbc} instead of \term{mod\_private}.
|
|
||||||
\item User rules for blocking communications: Use \term{mod\_privacy\_odbc} instead of \term{mod\_privacy}.
|
|
||||||
\item Simple Communications Blocking: Use \term{mod\_blocking\_odbc} instead of \term{mod\_blocking}.
|
|
||||||
\item Pub-Sub nodes, items and subscriptions: Use \term{mod\_pubsub\_odbc} instead of \term{mod\_pubsub}.
|
|
||||||
\item Multi-user chats: Use \term{mod\_muc\_odbc} instead of \term{mod\_muc}.
|
|
||||||
\item Manage announcements: Use \term{mod\_announce\_odbc} instead of \term{mod\_announce}.
|
|
||||||
\item IRC transport: Use \term{mod\_irc\_odbc} instead of \term{mod\_irc}.
|
|
||||||
\end{itemize}
|
|
||||||
|
|
||||||
You can find more
|
You can find more
|
||||||
\footahref{http://www.ejabberd.im/contributions}{contributed modules} on the
|
\footahref{http://www.ejabberd.im/contributions}{contributed modules} on the
|
||||||
\ejabberd{} website. Please remember that these contributions might not work or
|
\ejabberd{} website. Please remember that these contributions might not work or
|
||||||
|
@ -2800,6 +2742,7 @@ hosts in ejabberd.
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
\begin{description}
|
\begin{description}
|
||||||
|
\dbtype
|
||||||
\titem{\{access, AccessName\}} \ind{options!access}This option specifies who is allowed to
|
\titem{\{access, AccessName\}} \ind{options!access}This option specifies who is allowed to
|
||||||
send announcements and to set the message of the day (by default, nobody is
|
send announcements and to set the message of the day (by default, nobody is
|
||||||
able to send such messages).
|
able to send such messages).
|
||||||
|
@ -3130,6 +3073,7 @@ End user information:
|
||||||
Options:
|
Options:
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\hostitem{irc}
|
\hostitem{irc}
|
||||||
|
\dbtype
|
||||||
\titem{\{access, AccessName\}} \ind{options!access}This option can be used to specify who
|
\titem{\{access, AccessName\}} \ind{options!access}This option can be used to specify who
|
||||||
may use the IRC transport (default value: \term{all}).
|
may use the IRC transport (default value: \term{all}).
|
||||||
\titem{\{default\_encoding, Encoding\}} \ind{options!defaultencoding}Set the default IRC encoding.
|
\titem{\{default\_encoding, Encoding\}} \ind{options!defaultencoding}Set the default IRC encoding.
|
||||||
|
@ -3180,6 +3124,7 @@ connected user was last active on the server, or to query the uptime of the
|
||||||
Options:
|
Options:
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\iqdiscitem{Last activity (\ns{jabber:iq:last})}
|
\iqdiscitem{Last activity (\ns{jabber:iq:last})}
|
||||||
|
\dbtype
|
||||||
\end{description}
|
\end{description}
|
||||||
|
|
||||||
\makesubsection{modmuc}{\modmuc{}}
|
\makesubsection{modmuc}{\modmuc{}}
|
||||||
|
@ -3214,6 +3159,7 @@ on an available node on first connection attempt.
|
||||||
Module options:
|
Module options:
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\hostitem{conference}
|
\hostitem{conference}
|
||||||
|
\dbtype
|
||||||
\titem{\{access, AccessName\}} \ind{options!access}You can specify who is allowed to use
|
\titem{\{access, AccessName\}} \ind{options!access}You can specify who is allowed to use
|
||||||
the Multi-User Chat service. By default everyone is allowed to use it.
|
the Multi-User Chat service. By default everyone is allowed to use it.
|
||||||
\titem{\{access\_create, AccessName\}} \ind{options!access\_create}To configure who is
|
\titem{\{access\_create, AccessName\}} \ind{options!access\_create}To configure who is
|
||||||
|
@ -3573,6 +3519,7 @@ online again. Thus it is very similar to how email works. Note that
|
||||||
(see section~\ref{ejabberdctl}).
|
(see section~\ref{ejabberdctl}).
|
||||||
|
|
||||||
\begin{description}
|
\begin{description}
|
||||||
|
\dbtype
|
||||||
\titem{\{access\_max\_user\_messages, AccessName\}}\ind{options!access\_max\_user\_messages}
|
\titem{\{access\_max\_user\_messages, AccessName\}}\ind{options!access\_max\_user\_messages}
|
||||||
This option defines which access rule will be enforced to limit
|
This option defines which access rule will be enforced to limit
|
||||||
the maximum number of offline messages that a user can have (quota).
|
the maximum number of offline messages that a user can have (quota).
|
||||||
|
@ -3703,6 +3650,7 @@ their \XMPP{} client, they will be able to:
|
||||||
Options:
|
Options:
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\iqdiscitem{Blocking Communication (\ns{jabber:iq:privacy})}
|
\iqdiscitem{Blocking Communication (\ns{jabber:iq:privacy})}
|
||||||
|
\dbtype
|
||||||
\end{description}
|
\end{description}
|
||||||
|
|
||||||
\makesubsection{modprivate}{\modprivate{}}
|
\makesubsection{modprivate}{\modprivate{}}
|
||||||
|
@ -3719,6 +3667,7 @@ of client-specific preferences; another is Bookmark Storage (\xepref{0048}).
|
||||||
Options:
|
Options:
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\iqdiscitem{Private XML Storage (\ns{jabber:iq:private})}
|
\iqdiscitem{Private XML Storage (\ns{jabber:iq:private})}
|
||||||
|
\dbtype
|
||||||
\end{description}
|
\end{description}
|
||||||
|
|
||||||
\makesubsection{modproxy}{\modproxy{}}
|
\makesubsection{modproxy}{\modproxy{}}
|
||||||
|
@ -4059,6 +4008,7 @@ It also supports Roster Versioning (\xepref{0237}).
|
||||||
Options:
|
Options:
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\iqdiscitem{Roster Management (\ns{jabber:iq:roster})}
|
\iqdiscitem{Roster Management (\ns{jabber:iq:roster})}
|
||||||
|
\dbtype
|
||||||
\titem{\{versioning, false|true\}} \ind{options!versioning}Enables
|
\titem{\{versioning, false|true\}} \ind{options!versioning}Enables
|
||||||
Roster Versioning.
|
Roster Versioning.
|
||||||
This option is disabled by default.
|
This option is disabled by default.
|
||||||
|
@ -4069,7 +4019,7 @@ Options:
|
||||||
This option does not affect the client in any way.
|
This option does not affect the client in any way.
|
||||||
This option is only useful if Roster Versioning is enabled.
|
This option is only useful if Roster Versioning is enabled.
|
||||||
This option is disabled by default.
|
This option is disabled by default.
|
||||||
Important: if you use \modsharedroster{}, \modsharedrosterodbc{} or \modsharedrosterldap{},
|
Important: if you use \modsharedroster{} or \modsharedrosterldap{},
|
||||||
you must disable this option.
|
you must disable this option.
|
||||||
\end{description}
|
\end{description}
|
||||||
|
|
||||||
|
@ -4136,6 +4086,11 @@ A shared roster group can have members from any XMPP server,
|
||||||
but the presence will only be available from and to members
|
but the presence will only be available from and to members
|
||||||
of the same virtual host where the group is created.
|
of the same virtual host where the group is created.
|
||||||
|
|
||||||
|
Options:
|
||||||
|
\begin{description}
|
||||||
|
\dbtype
|
||||||
|
\end{description}
|
||||||
|
|
||||||
Shared roster groups can be edited \emph{only} via the Web Admin. Each group
|
Shared roster groups can be edited \emph{only} via the Web Admin. Each group
|
||||||
has a unique identification and the following parameters:
|
has a unique identification and the following parameters:
|
||||||
\begin{description}
|
\begin{description}
|
||||||
|
@ -4654,6 +4609,7 @@ Options:
|
||||||
\begin{description}
|
\begin{description}
|
||||||
\hostitem{vjud}
|
\hostitem{vjud}
|
||||||
\iqdiscitem{\ns{vcard-temp}}
|
\iqdiscitem{\ns{vcard-temp}}
|
||||||
|
\dbtype
|
||||||
\titem{\{search, true|false\}}\ind{options!search}This option specifies whether the search
|
\titem{\{search, true|false\}}\ind{options!search}This option specifies whether the search
|
||||||
functionality is enabled or not
|
functionality is enabled or not
|
||||||
If disabled, the option \term{host} will be ignored and the
|
If disabled, the option \term{host} will be ignored and the
|
||||||
|
@ -4669,7 +4625,7 @@ Options:
|
||||||
\titem{\{search\_all\_hosts, true|false\}}\ind{options!search\_all\_hosts}If this option is set
|
\titem{\{search\_all\_hosts, true|false\}}\ind{options!search\_all\_hosts}If this option is set
|
||||||
to \term{true}, search operations will apply to all virtual hosts. Otherwise
|
to \term{true}, search operations will apply to all virtual hosts. Otherwise
|
||||||
only the current host will be searched. The default value is \term{true}.
|
only the current host will be searched. The default value is \term{true}.
|
||||||
This option is available in \modvcard, but not available in \modvcardodbc.
|
This option is available in \modvcard when using Mnesia, but not when using ODBC storage.
|
||||||
\end{description}
|
\end{description}
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
@ -4942,6 +4898,11 @@ presence stanza rewrite.
|
||||||
For this reason, enabling this module will introduce a computational overhead
|
For this reason, enabling this module will introduce a computational overhead
|
||||||
in servers with clients that change frequently their presence.
|
in servers with clients that change frequently their presence.
|
||||||
|
|
||||||
|
Options:
|
||||||
|
\begin{description}
|
||||||
|
\dbtype
|
||||||
|
\end{description}
|
||||||
|
|
||||||
\makesubsection{modversion}{\modversion{}}
|
\makesubsection{modversion}{\modversion{}}
|
||||||
\ind{modules!\modversion{}}\ind{protocols!XEP-0092: Software Version}
|
\ind{modules!\modversion{}}\ind{protocols!XEP-0092: Software Version}
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user