diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/dev.html | 1 | ||||
| -rw-r--r-- | doc/guide.html | 214 | ||||
| -rw-r--r-- | doc/guide.tex | 20 | ||||
| -rw-r--r-- | doc/introduction.tex | 4 |
4 files changed, 142 insertions, 97 deletions
diff --git a/doc/dev.html b/doc/dev.html index 0daaf175b..8681b1521 100644 --- a/doc/dev.html +++ b/doc/dev.html @@ -153,6 +153,7 @@ Native MySQL support. <LI CLASS="li-itemize">Native PostgreSQL support. <LI CLASS="li-itemize">Mnesia. <LI CLASS="li-itemize">ODBC data storage support. +<LI CLASS="li-itemize">Microsoft SQL Server support (via ODBC). </UL> <LI CLASS="li-itemize">Authentication <UL CLASS="itemize"><LI CLASS="li-itemize"> diff --git a/doc/guide.html b/doc/guide.html index 7dc2ddc22..554201a54 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -92,68 +92,69 @@ BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;} </UL> <LI CLASS="li-toc"><A HREF="#htoc24">3.2 Relational Database Support</A> <UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc25">3.2.1 Authentication against a relational database</A> -<LI CLASS="li-toc"><A HREF="#htoc26">3.2.2 Relational database for other modules</A> +<A HREF="#htoc25">3.2.1 Preliminary steps</A> +<LI CLASS="li-toc"><A HREF="#htoc26">3.2.2 Authentication against a relational database</A> +<LI CLASS="li-toc"><A HREF="#htoc27">3.2.3 Relational database for other modules</A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc27">3.3 Creating an Initial Administrator</A> -<LI CLASS="li-toc"><A HREF="#htoc28">3.4 Online Configuration and Monitoring</A> +<LI CLASS="li-toc"><A HREF="#htoc28">3.3 Creating an Initial Administrator</A> +<LI CLASS="li-toc"><A HREF="#htoc29">3.4 Online Configuration and Monitoring</A> <UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc29">3.4.1 Web Interface</A> -<LI CLASS="li-toc"><A HREF="#htoc30">3.4.2 <TT>ejabberdctl</TT></A> +<A HREF="#htoc30">3.4.1 Web Interface</A> +<LI CLASS="li-toc"><A HREF="#htoc31">3.4.2 <TT>ejabberdctl</TT></A> </UL> </UL> -<LI CLASS="li-toc"><A HREF="#htoc31">4 Firewall Settings</A> -<LI CLASS="li-toc"><A HREF="#htoc32">5 SRV Records</A> -<LI CLASS="li-toc"><A HREF="#htoc33">6 Clustering</A> +<LI CLASS="li-toc"><A HREF="#htoc32">4 Firewall Settings</A> +<LI CLASS="li-toc"><A HREF="#htoc33">5 SRV Records</A> +<LI CLASS="li-toc"><A HREF="#htoc34">6 Clustering</A> <UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc34">6.1 How it Works</A> +<A HREF="#htoc35">6.1 How it Works</A> <UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc35">6.1.1 Router</A> -<LI CLASS="li-toc"><A HREF="#htoc36">6.1.2 Local Router</A> -<LI CLASS="li-toc"><A HREF="#htoc37">6.1.3 Session Manager</A> -<LI CLASS="li-toc"><A HREF="#htoc38">6.1.4 s2s Manager</A> +<A HREF="#htoc36">6.1.1 Router</A> +<LI CLASS="li-toc"><A HREF="#htoc37">6.1.2 Local Router</A> +<LI CLASS="li-toc"><A HREF="#htoc38">6.1.3 Session Manager</A> +<LI CLASS="li-toc"><A HREF="#htoc39">6.1.4 s2s Manager</A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc39">6.2 Clustering Setup</A> +<LI CLASS="li-toc"><A HREF="#htoc40">6.2 Clustering Setup</A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc40">A Built-in Modules</A> +<LI CLASS="li-toc"><A HREF="#htoc41">A Built-in Modules</A> <UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc41">A.1 Overview</A> -<LI CLASS="li-toc"><A HREF="#htoc42">A.2 Common Options</A> +<A HREF="#htoc42">A.1 Overview</A> +<LI CLASS="li-toc"><A HREF="#htoc43">A.2 Common Options</A> <UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc43">A.2.1 <TT>iqdisc</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc44">A.2.2 <TT>hosts</TT></A> +<A HREF="#htoc44">A.2.1 <TT>iqdisc</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc45">A.2.2 <TT>hosts</TT></A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc45">A.3 <TT>mod_announce</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc46">A.4 <TT>mod_disco</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc47">A.5 <TT>mod_echo</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc48">A.6 <TT>mod_irc</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc49">A.7 <TT>mod_last</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc50">A.8 <TT>mod_muc</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc51">A.9 <TT>mod_muc_log</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc52">A.10 <TT>mod_offline</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc53">A.11 <TT>mod_privacy</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc54">A.12 <TT>mod_private</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc55">A.13 <TT>mod_pubsub</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc56">A.14 <TT>mod_register</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc57">A.15 <TT>mod_roster</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc58">A.16 <TT>mod_service_log</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc59">A.17 <TT>mod_shared_roster</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc60">A.18 <TT>mod_stats</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc61">A.19 <TT>mod_time</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc62">A.20 <TT>mod_vcard</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc63">A.21 <TT>mod_version</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc46">A.3 <TT>mod_announce</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc47">A.4 <TT>mod_disco</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc48">A.5 <TT>mod_echo</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc49">A.6 <TT>mod_irc</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc50">A.7 <TT>mod_last</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc51">A.8 <TT>mod_muc</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc52">A.9 <TT>mod_muc_log</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc53">A.10 <TT>mod_offline</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc54">A.11 <TT>mod_privacy</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc55">A.12 <TT>mod_private</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc56">A.13 <TT>mod_pubsub</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc57">A.14 <TT>mod_register</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc58">A.15 <TT>mod_roster</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc59">A.16 <TT>mod_service_log</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc60">A.17 <TT>mod_shared_roster</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc61">A.18 <TT>mod_stats</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc62">A.19 <TT>mod_time</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc63">A.20 <TT>mod_vcard</TT></A> +<LI CLASS="li-toc"><A HREF="#htoc64">A.21 <TT>mod_version</TT></A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc64">B Internationalization and Localization</A> -<LI CLASS="li-toc"><A HREF="#htoc65">C Release Notes</A> +<LI CLASS="li-toc"><A HREF="#htoc65">B Internationalization and Localization</A> +<LI CLASS="li-toc"><A HREF="#htoc66">C Release Notes</A> <UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc66">C.1 ejabberd 0.9</A> -<LI CLASS="li-toc"><A HREF="#htoc67">C.2 ejabberd 0.9.1</A> -<LI CLASS="li-toc"><A HREF="#htoc68">C.3 ejabberd 0.9.8</A> -<LI CLASS="li-toc"><A HREF="#htoc69">C.4 ejabberd 1.0.0</A> -<LI CLASS="li-toc"><A HREF="#htoc70">C.5 ejabberd 1.1.0</A> -<LI CLASS="li-toc"><A HREF="#htoc71">C.6 ejabberd 1.1.1</A> +<A HREF="#htoc67">C.1 ejabberd 0.9</A> +<LI CLASS="li-toc"><A HREF="#htoc68">C.2 ejabberd 0.9.1</A> +<LI CLASS="li-toc"><A HREF="#htoc69">C.3 ejabberd 0.9.8</A> +<LI CLASS="li-toc"><A HREF="#htoc70">C.4 ejabberd 1.0.0</A> +<LI CLASS="li-toc"><A HREF="#htoc71">C.5 ejabberd 1.1.0</A> +<LI CLASS="li-toc"><A HREF="#htoc72">C.6 ejabberd 1.1.1</A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc72">D Acknowledgements</A> +<LI CLASS="li-toc"><A HREF="#htoc73">D Acknowledgements</A> </UL> <!--TOC section Introduction--> @@ -230,6 +231,7 @@ Native MySQL support. <LI CLASS="li-itemize">Native PostgreSQL support. <LI CLASS="li-itemize">Mnesia. <LI CLASS="li-itemize">ODBC data storage support. +<LI CLASS="li-itemize">Microsoft SQL Server support (via ODBC). </UL> <LI CLASS="li-itemize">Authentication <UL CLASS="itemize"><LI CLASS="li-itemize"> @@ -973,9 +975,29 @@ available from: <H3 CLASS="subsection"><A NAME="htoc24">3.2</A> Relational Database Support</H3><!--SEC END --> <A NAME="sec:relationaldatabase"></A> +<!--TOC subsubsection Preliminary steps--> + +<H4 CLASS="subsubsection"><A NAME="htoc25">3.2.1</A> Preliminary steps</H4><!--SEC END --> + +<A NAME="sec:relationaldatabasecompilation"></A> +If you have installed ejabberd using a binary version, the compilation steps +are not needed as they have already been done correctly.<BR> +<BR> +Otherwise, to be able to use ejabberd with a relational database you need to +enable ODBC modules during compilation, even if you want to use ejabberd with +MySQL or PostgreSQL in native mode. The following <TT>configure</TT> command can +be used to enable the relational modules: +<PRE CLASS="verbatim"> +./configure --enable-odbc +</PRE> +If you are planning to use Microsoft SQL Server with ODBC, you need to specify +it from the <TT>configure</TT> command before compilation: +<PRE CLASS="verbatim"> +./configure --enable-odbc --enable-mssql +</PRE> <!--TOC subsubsection Authentication against a relational database--> -<H4 CLASS="subsubsection"><A NAME="htoc25">3.2.1</A> Authentication against a relational database</H4><!--SEC END --> +<H4 CLASS="subsubsection"><A NAME="htoc26">3.2.2</A> Authentication against a relational database</H4><!--SEC END --> <A NAME="sec:relationaldatabaseauth"></A> ejabberd use its internal Mnesia database as a default. It is however possible @@ -1030,7 +1052,7 @@ available from: <A HREF="http://support.process-one.net/doc/display/MESSENGER/Us <BR> <!--TOC subsubsection Relational database for other modules--> -<H4 CLASS="subsubsection"><A NAME="htoc26">3.2.2</A> Relational database for other modules</H4><!--SEC END --> +<H4 CLASS="subsubsection"><A NAME="htoc27">3.2.3</A> Relational database for other modules</H4><!--SEC END --> <A NAME="sec:relationaldatabaseextra"></A> It is possible to use a relational database to store pieces of @@ -1047,7 +1069,7 @@ Last connection date and time: Use <TT>mod_last_odbc</TT> instead of </UL> <!--TOC subsection Creating an Initial Administrator--> -<H3 CLASS="subsection"><A NAME="htoc27">3.3</A> Creating an Initial Administrator</H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc28">3.3</A> Creating an Initial Administrator</H3><!--SEC END --> <A NAME="sec:initialadmin"></A> Before the web interface can be entered to perform administration tasks, an @@ -1079,12 +1101,12 @@ Register an account on your <TT>ejabberd</TT> deployment. An account can be </OL> <!--TOC subsection Online Configuration and Monitoring--> -<H3 CLASS="subsection"><A NAME="htoc28">3.4</A> Online Configuration and Monitoring</H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc29">3.4</A> Online Configuration and Monitoring</H3><!--SEC END --> <A NAME="sec:onlineconfig"></A> <!--TOC subsubsection Web Interface--> -<H4 CLASS="subsubsection"><A NAME="htoc29">3.4.1</A> Web Interface</H4><!--SEC END --> +<H4 CLASS="subsubsection"><A NAME="htoc30">3.4.1</A> Web Interface</H4><!--SEC END --> <A NAME="sec:webadm"></A> @@ -1158,7 +1180,7 @@ You can serve the web interface on the same port as the </PRE></UL> <!--TOC subsubsection <TT>ejabberdctl</TT>--> -<H4 CLASS="subsubsection"><A NAME="htoc30">3.4.2</A> <TT>ejabberdctl</TT></H4><!--SEC END --> +<H4 CLASS="subsubsection"><A NAME="htoc31">3.4.2</A> <TT>ejabberdctl</TT></H4><!--SEC END --> <A NAME="sec:ejabberdctl"></A> It is possible to do some administration operations using the command @@ -1204,7 +1226,7 @@ Additional information: </DL> <!--TOC section Firewall Settings--> -<H2 CLASS="section"><A NAME="htoc31">4</A> Firewall Settings</H2><!--SEC END --> +<H2 CLASS="section"><A NAME="htoc32">4</A> Firewall Settings</H2><!--SEC END --> <A NAME="sec:firewall"></A> @@ -1233,7 +1255,7 @@ You need to take the following TCP ports in mind when configuring your firewall: <DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> <!--TOC section SRV Records--> -<H2 CLASS="section"><A NAME="htoc32">5</A> SRV Records</H2><!--SEC END --> +<H2 CLASS="section"><A NAME="htoc33">5</A> SRV Records</H2><!--SEC END --> <A NAME="sec:srv"></A> @@ -1245,13 +1267,13 @@ General information: </UL> <!--TOC section Clustering--> -<H2 CLASS="section"><A NAME="htoc33">6</A> Clustering</H2><!--SEC END --> +<H2 CLASS="section"><A NAME="htoc34">6</A> Clustering</H2><!--SEC END --> <A NAME="sec:clustering"></A> <!--TOC subsection How it Works--> -<H3 CLASS="subsection"><A NAME="htoc34">6.1</A> How it Works</H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc35">6.1</A> How it Works</H3><!--SEC END --> <A NAME="sec:howitworks"></A> @@ -1272,7 +1294,7 @@ router, </UL> <!--TOC subsubsection Router--> -<H4 CLASS="subsubsection"><A NAME="htoc35">6.1.1</A> Router</H4><!--SEC END --> +<H4 CLASS="subsubsection"><A NAME="htoc36">6.1.1</A> Router</H4><!--SEC END --> This module is the main router of Jabber packets on each node. It @@ -1283,7 +1305,7 @@ appropriate process. If not, it is sent to the s2s manager.<BR> <BR> <!--TOC subsubsection Local Router--> -<H4 CLASS="subsubsection"><A NAME="htoc36">6.1.2</A> Local Router</H4><!--SEC END --> +<H4 CLASS="subsubsection"><A NAME="htoc37">6.1.2</A> Local Router</H4><!--SEC END --> This module routes packets which have a destination domain equal to @@ -1293,7 +1315,7 @@ on its content.<BR> <BR> <!--TOC subsubsection Session Manager--> -<H4 CLASS="subsubsection"><A NAME="htoc37">6.1.3</A> Session Manager</H4><!--SEC END --> +<H4 CLASS="subsubsection"><A NAME="htoc38">6.1.3</A> Session Manager</H4><!--SEC END --> This module routes packets to local users. It looks up to which user @@ -1303,7 +1325,7 @@ storage, or bounced back.<BR> <BR> <!--TOC subsubsection s2s Manager--> -<H4 CLASS="subsubsection"><A NAME="htoc38">6.1.4</A> s2s Manager</H4><!--SEC END --> +<H4 CLASS="subsubsection"><A NAME="htoc39">6.1.4</A> s2s Manager</H4><!--SEC END --> This module routes packets to other Jabber servers. First, it @@ -1314,7 +1336,7 @@ serving this connection, otherwise a new connection is opened.<BR> <BR> <!--TOC subsection Clustering Setup--> -<H3 CLASS="subsection"><A NAME="htoc39">6.2</A> Clustering Setup</H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc40">6.2</A> Clustering Setup</H3><!--SEC END --> <A NAME="sec:cluster"></A> @@ -1387,13 +1409,13 @@ domain.<BR> <!--TOC section Built-in Modules--> -<H2 CLASS="section"><A NAME="htoc40">A</A> Built-in Modules</H2><!--SEC END --> +<H2 CLASS="section"><A NAME="htoc41">A</A> Built-in Modules</H2><!--SEC END --> <A NAME="sec:modules"></A> <!--TOC subsection Overview--> -<H3 CLASS="subsection"><A NAME="htoc41">A.1</A> Overview</H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc42">A.1</A> Overview</H3><!--SEC END --> <A NAME="sec:modoverview"></A> @@ -1605,7 +1627,7 @@ XMPP compliancy.<BR> <BR> <!--TOC subsection Common Options--> -<H3 CLASS="subsection"><A NAME="htoc42">A.2</A> Common Options</H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc43">A.2</A> Common Options</H3><!--SEC END --> <A NAME="sec:modcommonopts"></A> The following options are used by many modules. Therefore, they are described in @@ -1613,7 +1635,7 @@ this separate section.<BR> <BR> <!--TOC subsubsection <TT>iqdisc</TT>--> -<H4 CLASS="subsubsection"><A NAME="htoc43">A.2.1</A> <TT>iqdisc</TT></H4><!--SEC END --> +<H4 CLASS="subsubsection"><A NAME="htoc44">A.2.1</A> <TT>iqdisc</TT></H4><!--SEC END --> <A NAME="sec:modiqdiscoption"></A> @@ -1647,7 +1669,7 @@ Example: </PRE> <!--TOC subsubsection <TT>hosts</TT>--> -<H4 CLASS="subsubsection"><A NAME="htoc44">A.2.2</A> <TT>hosts</TT></H4><!--SEC END --> +<H4 CLASS="subsubsection"><A NAME="htoc45">A.2.2</A> <TT>hosts</TT></H4><!--SEC END --> <A NAME="sec:modhostsoption"></A> @@ -1686,7 +1708,7 @@ Serving the echo module on one domain: </PRE></UL> <!--TOC subsection <TT>mod_announce</TT>--> -<H3 CLASS="subsection"><A NAME="htoc45">A.3</A> <TT>mod_announce</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc46">A.3</A> <TT>mod_announce</TT></H3><!--SEC END --> <A NAME="sec:modannounce"></A> @@ -1752,7 +1774,7 @@ Only administrators can send announcements: </PRE></UL> <!--TOC subsection <TT>mod_disco</TT>--> -<H3 CLASS="subsection"><A NAME="htoc46">A.4</A> <TT>mod_disco</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc47">A.4</A> <TT>mod_disco</TT></H3><!--SEC END --> <A NAME="sec:moddisco"></A> @@ -1804,7 +1826,7 @@ To serve a link to the Jabber User Directory on <TT>jabber.org</TT>: </PRE></UL> <!--TOC subsection <TT>mod_echo</TT>--> -<H3 CLASS="subsection"><A NAME="htoc47">A.5</A> <TT>mod_echo</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc48">A.5</A> <TT>mod_echo</TT></H3><!--SEC END --> <A NAME="sec:modecho"></A> @@ -1837,7 +1859,7 @@ Mirror, mirror, on the wall, who is the most beautiful </UL> <!--TOC subsection <TT>mod_irc</TT>--> -<H3 CLASS="subsection"><A NAME="htoc48">A.6</A> <TT>mod_irc</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc49">A.6</A> <TT>mod_irc</TT></H3><!--SEC END --> <A NAME="sec:modirc"></A> @@ -1907,7 +1929,7 @@ In the first example, the IRC transport is available on (all) your </PRE></UL> <!--TOC subsection <TT>mod_last</TT>--> -<H3 CLASS="subsection"><A NAME="htoc49">A.7</A> <TT>mod_last</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc50">A.7</A> <TT>mod_last</TT></H3><!--SEC END --> <A NAME="sec:modlast"></A> @@ -1924,7 +1946,7 @@ the processing discipline for Last activity (<TT>jabber:iq:last</TT>) IQ queries </DL> <!--TOC subsection <TT>mod_muc</TT>--> -<H3 CLASS="subsection"><A NAME="htoc50">A.8</A> <TT>mod_muc</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc51">A.8</A> <TT>mod_muc</TT></H3><!--SEC END --> <A NAME="sec:modmuc"></A> @@ -2014,7 +2036,7 @@ In the first example everyone is allowed to use the Multi-User Chat </PRE></UL> <!--TOC subsection <TT>mod_muc_log</TT>--> -<H3 CLASS="subsection"><A NAME="htoc51">A.9</A> <TT>mod_muc_log</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc52">A.9</A> <TT>mod_muc_log</TT></H3><!--SEC END --> <A NAME="sec:modmuclog"></A> @@ -2086,7 +2108,7 @@ Example configuration: </PRE> <!--TOC subsection <TT>mod_offline</TT>--> -<H3 CLASS="subsection"><A NAME="htoc52">A.10</A> <TT>mod_offline</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc53">A.10</A> <TT>mod_offline</TT></H3><!--SEC END --> <A NAME="sec:modoffline"></A> @@ -2098,7 +2120,7 @@ online again. Thus it is very similar to how email works. Note that <BR> <!--TOC subsection <TT>mod_privacy</TT>--> -<H3 CLASS="subsection"><A NAME="htoc53">A.11</A> <TT>mod_privacy</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc54">A.11</A> <TT>mod_privacy</TT></H3><!--SEC END --> <A NAME="sec:modprivacy"></A> @@ -2133,7 +2155,7 @@ the processing discipline for Blocking Communication (<TT>jabber:iq:privacy</TT> </DL> <!--TOC subsection <TT>mod_private</TT>--> -<H3 CLASS="subsection"><A NAME="htoc54">A.12</A> <TT>mod_private</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc55">A.12</A> <TT>mod_private</TT></H3><!--SEC END --> <A NAME="sec:modprivate"></A> @@ -2152,7 +2174,7 @@ the processing discipline for Private XML Storage (<TT>jabber:iq:private</TT>) I </DL> <!--TOC subsection <TT>mod_pubsub</TT>--> -<H3 CLASS="subsection"><A NAME="htoc55">A.13</A> <TT>mod_pubsub</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc56">A.13</A> <TT>mod_pubsub</TT></H3><!--SEC END --> <A NAME="sec:modpubsub"></A> @@ -2205,7 +2227,7 @@ Example: </PRE> <!--TOC subsection <TT>mod_register</TT>--> -<H3 CLASS="subsection"><A NAME="htoc56">A.14</A> <TT>mod_register</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc57">A.14</A> <TT>mod_register</TT></H3><!--SEC END --> <A NAME="sec:modregister"></A> @@ -2262,7 +2284,7 @@ Next example prohibits the registration of too short account names and of </PRE></UL> <!--TOC subsection <TT>mod_roster</TT>--> -<H3 CLASS="subsection"><A NAME="htoc57">A.15</A> <TT>mod_roster</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc58">A.15</A> <TT>mod_roster</TT></H3><!--SEC END --> <A NAME="sec:modroster"></A> @@ -2276,7 +2298,7 @@ the processing discipline for Roster Management (<TT>jabber:iq:roster</TT>) IQ q </DL> <!--TOC subsection <TT>mod_service_log</TT>--> -<H3 CLASS="subsection"><A NAME="htoc58">A.16</A> <TT>mod_service_log</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc59">A.16</A> <TT>mod_service_log</TT></H3><!--SEC END --> <A NAME="sec:modservicelog"></A> @@ -2316,7 +2338,7 @@ To log all end user packets to the Bandersnatch service running on </PRE></UL> <!--TOC subsection <TT>mod_shared_roster</TT>--> -<H3 CLASS="subsection"><A NAME="htoc59">A.17</A> <TT>mod_shared_roster</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc60">A.17</A> <TT>mod_shared_roster</TT></H3><!--SEC END --> <A NAME="sec:modsharedroster"></A> @@ -2443,7 +2465,7 @@ Take the case of a computer club that wants all its members seeing each </UL> <!--TOC subsection <TT>mod_stats</TT>--> -<H3 CLASS="subsection"><A NAME="htoc60">A.18</A> <TT>mod_stats</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc61">A.18</A> <TT>mod_stats</TT></H3><!--SEC END --> <A NAME="sec:modstats"></A> @@ -2485,7 +2507,7 @@ You can request the number of online users on the current virtual host </PRE></UL> <!--TOC subsection <TT>mod_time</TT>--> -<H3 CLASS="subsection"><A NAME="htoc61">A.19</A> <TT>mod_time</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc62">A.19</A> <TT>mod_time</TT></H3><!--SEC END --> <A NAME="sec:modtime"></A> @@ -2500,7 +2522,7 @@ the processing discipline for Entity Time (<TT>jabber:iq:time</TT>) IQ queries </DL> <!--TOC subsection <TT>mod_vcard</TT>--> -<H3 CLASS="subsection"><A NAME="htoc62">A.20</A> <TT>mod_vcard</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc63">A.20</A> <TT>mod_vcard</TT></H3><!--SEC END --> <A NAME="sec:modvcard"></A> @@ -2566,7 +2588,7 @@ In this first situation, search results are limited to twenty items, </PRE></UL> <!--TOC subsection <TT>mod_version</TT>--> -<H3 CLASS="subsection"><A NAME="htoc63">A.21</A> <TT>mod_version</TT></H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc64">A.21</A> <TT>mod_version</TT></H3><!--SEC END --> <A NAME="sec:modversion"></A> @@ -2581,7 +2603,7 @@ the processing discipline for Software Version (<TT>jabber:iq:version</TT>) IQ q </DL> <!--TOC section Internationalization and Localization--> -<H2 CLASS="section"><A NAME="htoc64">B</A> Internationalization and Localization</H2><!--SEC END --> +<H2 CLASS="section"><A NAME="htoc65">B</A> Internationalization and Localization</H2><!--SEC END --> <A NAME="sec:i18nl10n"></A> @@ -2624,13 +2646,13 @@ figure <A HREF="#fig:webadmmainru">3</A> with figure <A HREF="#fig:web <DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> <!--TOC section Release Notes--> -<H2 CLASS="section"><A NAME="htoc65">C</A> Release Notes</H2><!--SEC END --> +<H2 CLASS="section"><A NAME="htoc66">C</A> Release Notes</H2><!--SEC END --> <A NAME="sec:releasenotes"></A> <!--TOC subsection ejabberd 0.9--> -<H3 CLASS="subsection"><A NAME="htoc66">C.1</A> ejabberd 0.9</H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc67">C.1</A> ejabberd 0.9</H3><!--SEC END --> <PRE CLASS="verbatim"> Release notes @@ -2724,7 +2746,7 @@ Bugfixes </PRE> <!--TOC subsection ejabberd 0.9.1--> -<H3 CLASS="subsection"><A NAME="htoc67">C.2</A> ejabberd 0.9.1</H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc68">C.2</A> ejabberd 0.9.1</H3><!--SEC END --> <PRE CLASS="verbatim"> Release notes @@ -2792,7 +2814,7 @@ Bugfixes </PRE> <!--TOC subsection ejabberd 0.9.8--> -<H3 CLASS="subsection"><A NAME="htoc68">C.3</A> ejabberd 0.9.8</H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc69">C.3</A> ejabberd 0.9.8</H3><!--SEC END --> <PRE CLASS="verbatim"> Release notes @@ -2897,7 +2919,7 @@ END </PRE> <!--TOC subsection ejabberd 1.0.0--> -<H3 CLASS="subsection"><A NAME="htoc69">C.4</A> ejabberd 1.0.0</H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc70">C.4</A> ejabberd 1.0.0</H3><!--SEC END --> <PRE CLASS="verbatim"> Release Notes @@ -3023,7 +3045,7 @@ END </PRE> <!--TOC subsection ejabberd 1.1.0--> -<H3 CLASS="subsection"><A NAME="htoc70">C.5</A> ejabberd 1.1.0</H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc71">C.5</A> ejabberd 1.1.0</H3><!--SEC END --> <PRE CLASS="verbatim"> Release Notes @@ -3144,7 +3166,7 @@ END </PRE> <!--TOC subsection ejabberd 1.1.1--> -<H3 CLASS="subsection"><A NAME="htoc71">C.6</A> ejabberd 1.1.1</H3><!--SEC END --> +<H3 CLASS="subsection"><A NAME="htoc72">C.6</A> ejabberd 1.1.1</H3><!--SEC END --> <PRE CLASS="verbatim"> Release Notes @@ -3269,7 +3291,7 @@ END </PRE> <!--TOC section Acknowledgements--> -<H2 CLASS="section"><A NAME="htoc72">D</A> Acknowledgements</H2><!--SEC END --> +<H2 CLASS="section"><A NAME="htoc73">D</A> Acknowledgements</H2><!--SEC END --> <A NAME="sec:acknowledgements"></A> diff --git a/doc/guide.tex b/doc/guide.tex index 99e2df91a..0a757ca58 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -860,6 +860,26 @@ available from: \subsection{Relational Database Support} \label{sec:relationaldatabase} +\subsubsection{Preliminary steps} +\label{sec:relationaldatabasecompilation} + +If you have installed ejabberd using a binary version, the compilation steps +are not needed as they have already been done correctly. + +Otherwise, to be able to use ejabberd with a relational database you need to +enable ODBC modules during compilation, even if you want to use ejabberd with +MySQL or PostgreSQL in native mode. The following \term{configure} command can +be used to enable the relational modules: +\begin{verbatim} +./configure --enable-odbc +\end{verbatim} + +If you are planning to use Microsoft SQL Server with ODBC, you need to specify +it from the \term{configure} command before compilation: +\begin{verbatim} +./configure --enable-odbc --enable-mssql +\end{verbatim} + \subsubsection{Authentication against a relational database} \label{sec:relationaldatabaseauth} diff --git a/doc/introduction.tex b/doc/introduction.tex index 7bf10db62..4ad14bc50 100644 --- a/doc/introduction.tex +++ b/doc/introduction.tex @@ -100,7 +100,9 @@ Besides common \Jabber{} server features, \ejabberd{} comes with a wide range of \item Native MySQL support.\new{} \item Native PostgreSQL support. \item Mnesia. -\item ODBC data storage support. \moreinfo{ --- ODBC requests can be load balanced between several connections.} +\item ODBC data storage support. \moreinfo{ --- ODBC requests can be load + balanced between several connections.} +\item Microsoft SQL Server support (via ODBC).\new{} \end{itemize} \item Authentication \begin{itemize} |