mirror of
https://github.com/processone/ejabberd.git
synced 2024-11-26 16:26:24 +01:00
Document STUN server (thanks to Evgeniy Khramtsov), and minor doc enhancements.
* Add stun listener to example config file, disabled. * Improve enumeration of listeners options SVN Revision: 2460
This commit is contained in:
parent
cf90c8176e
commit
3078c28d1a
437
doc/guide.html
437
doc/guide.html
@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
ejabberd 3.0.0-alpha
|
ejabberd 2.1.0-alpha
|
||||||
|
|
||||||
Installation and Operation Guide
|
Installation and Operation Guide
|
||||||
|
|
||||||
@ -76,7 +76,7 @@ BLOCKQUOTE.figure DIV.center DIV.center HR{display:none;}
|
|||||||
<HR SIZE=2><BR>
|
<HR SIZE=2><BR>
|
||||||
<BR>
|
<BR>
|
||||||
|
|
||||||
<TABLE CELLSPACING=6 CELLPADDING=0><TR><TD ALIGN=right NOWRAP> <FONT SIZE=6><B>ejabberd 3.0.0-alpha </B></FONT></TD></TR>
|
<TABLE CELLSPACING=6 CELLPADDING=0><TR><TD ALIGN=right NOWRAP> <FONT SIZE=6><B>ejabberd 2.1.0-alpha </B></FONT></TD></TR>
|
||||||
<TR><TD ALIGN=right NOWRAP> </TD></TR>
|
<TR><TD ALIGN=right NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=right NOWRAP> <FONT SIZE=6>Installation and Operation Guide</FONT></TD></TR>
|
<TR><TD ALIGN=right NOWRAP> <FONT SIZE=6>Installation and Operation Guide</FONT></TD></TR>
|
||||||
</TABLE><BR>
|
</TABLE><BR>
|
||||||
@ -144,80 +144,81 @@ BLOCKQUOTE.figure DIV.center DIV.center HR{display:none;}
|
|||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc42">3.3.5  <TT>mod_echo</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc42">3.3.5  <TT>mod_echo</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc43">3.3.6  <TT>mod_http_bind</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc43">3.3.6  <TT>mod_http_bind</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc44">3.3.7  <TT>mod_http_fileserver</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc44">3.3.7  <TT>mod_http_fileserver</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc45">3.3.8  <TT>mod_last</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc45">3.3.8  <TT>mod_irc</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc46">3.3.9  <TT>mod_muc</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc46">3.3.9  <TT>mod_last</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc47">3.3.10  <TT>mod_muc_log</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc47">3.3.10  <TT>mod_muc</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc48">3.3.11  <TT>mod_offline</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc48">3.3.11  <TT>mod_muc_log</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc49">3.3.12  <TT>mod_ping</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc49">3.3.12  <TT>mod_offline</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc50">3.3.13  <TT>mod_privacy</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc50">3.3.13  <TT>mod_ping</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc51">3.3.14  <TT>mod_private</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc51">3.3.14  <TT>mod_privacy</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc52">3.3.15  <TT>mod_proxy65</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc52">3.3.15  <TT>mod_private</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc53">3.3.16  <TT>mod_pubsub</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc53">3.3.16  <TT>mod_proxy65</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc54">3.3.17  <TT>mod_register</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc54">3.3.17  <TT>mod_pubsub</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc55">3.3.18  <TT>mod_roster</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc55">3.3.18  <TT>mod_register</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc56">3.3.19  <TT>mod_service_log</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc56">3.3.19  <TT>mod_roster</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc57">3.3.20  <TT>mod_shared_roster</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc57">3.3.20  <TT>mod_service_log</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc58">3.3.21  <TT>mod_stats</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc58">3.3.21  <TT>mod_shared_roster</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc59">3.3.22  <TT>mod_time</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc59">3.3.22  <TT>mod_stats</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc60">3.3.23  <TT>mod_vcard</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc60">3.3.23  <TT>mod_time</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc61">3.3.24  <TT>mod_vcard_ldap</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc61">3.3.24  <TT>mod_vcard</TT></A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc62">3.3.25  <TT>mod_version</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc62">3.3.25  <TT>mod_vcard_ldap</TT></A>
|
||||||
|
</LI><LI CLASS="li-toc"><A HREF="#htoc63">3.3.26  <TT>mod_version</TT></A>
|
||||||
</LI></UL>
|
</LI></UL>
|
||||||
</LI></UL>
|
</LI></UL>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc63">Chapter 4  Managing an <TT>ejabberd</TT> Server</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc64">Chapter 4  Managing an <TT>ejabberd</TT> Server</A>
|
||||||
<UL CLASS="toc"><LI CLASS="li-toc">
|
<UL CLASS="toc"><LI CLASS="li-toc">
|
||||||
<A HREF="#htoc64">4.1  <TT>ejabberdctl</TT></A>
|
<A HREF="#htoc65">4.1  <TT>ejabberdctl</TT></A>
|
||||||
<UL CLASS="toc"><LI CLASS="li-toc">
|
<UL CLASS="toc"><LI CLASS="li-toc">
|
||||||
<A HREF="#htoc65">4.1.1  ejabberdctl Commands</A>
|
<A HREF="#htoc66">4.1.1  ejabberdctl Commands</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc66">4.1.2  Erlang Runtime System</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc67">4.1.2  Erlang Runtime System</A>
|
||||||
</LI></UL>
|
</LI></UL>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc67">4.2  <TT>ejabberd</TT> Commands</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc68">4.2  <TT>ejabberd</TT> Commands</A>
|
||||||
<UL CLASS="toc"><LI CLASS="li-toc">
|
<UL CLASS="toc"><LI CLASS="li-toc">
|
||||||
<A HREF="#htoc68">4.2.1  List of ejabberd Commands</A>
|
<A HREF="#htoc69">4.2.1  List of ejabberd Commands</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc69">4.2.2  Restrict Execution with AccessCommands</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc70">4.2.2  Restrict Execution with AccessCommands</A>
|
||||||
</LI></UL>
|
</LI></UL>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc70">4.3  Web Admin</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc71">4.3  Web Admin</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc71">4.4  Ad-hoc Commands</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc72">4.4  Ad-hoc Commands</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc72">4.5  Change Computer Hostname</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc73">4.5  Change Computer Hostname</A>
|
||||||
</LI></UL>
|
</LI></UL>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc73">Chapter 5  Securing <TT>ejabberd</TT></A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc74">Chapter 5  Securing <TT>ejabberd</TT></A>
|
||||||
<UL CLASS="toc"><LI CLASS="li-toc">
|
<UL CLASS="toc"><LI CLASS="li-toc">
|
||||||
<A HREF="#htoc74">5.1  Firewall Settings</A>
|
<A HREF="#htoc75">5.1  Firewall Settings</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc75">5.2  epmd</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc76">5.2  epmd</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc76">5.3  Erlang Cookie</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc77">5.3  Erlang Cookie</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc77">5.4  Erlang Node Name</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc78">5.4  Erlang Node Name</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc78">5.5  Securing Sensible Files</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc79">5.5  Securing Sensible Files</A>
|
||||||
</LI></UL>
|
</LI></UL>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc79">Chapter 6  Clustering</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc80">Chapter 6  Clustering</A>
|
||||||
<UL CLASS="toc"><LI CLASS="li-toc">
|
<UL CLASS="toc"><LI CLASS="li-toc">
|
||||||
<A HREF="#htoc80">6.1  How it Works</A>
|
<A HREF="#htoc81">6.1  How it Works</A>
|
||||||
<UL CLASS="toc"><LI CLASS="li-toc">
|
<UL CLASS="toc"><LI CLASS="li-toc">
|
||||||
<A HREF="#htoc81">6.1.1  Router</A>
|
<A HREF="#htoc82">6.1.1  Router</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc82">6.1.2  Local Router</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc83">6.1.2  Local Router</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc83">6.1.3  Session Manager</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc84">6.1.3  Session Manager</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc84">6.1.4  s2s Manager</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc85">6.1.4  s2s Manager</A>
|
||||||
</LI></UL>
|
</LI></UL>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc85">6.2  Clustering Setup</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc86">6.2  Clustering Setup</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc86">6.3  Service Load-Balancing</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc87">6.3  Service Load-Balancing</A>
|
||||||
<UL CLASS="toc"><LI CLASS="li-toc">
|
<UL CLASS="toc"><LI CLASS="li-toc">
|
||||||
<A HREF="#htoc87">6.3.1  Components Load-Balancing</A>
|
<A HREF="#htoc88">6.3.1  Components Load-Balancing</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc88">6.3.2  Domain Load-Balancing Algorithm</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc89">6.3.2  Domain Load-Balancing Algorithm</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc89">6.3.3  Load-Balancing Buckets</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc90">6.3.3  Load-Balancing Buckets</A>
|
||||||
</LI></UL>
|
</LI></UL>
|
||||||
</LI></UL>
|
</LI></UL>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc90">Chapter 7  Debugging</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc91">Chapter 7  Debugging</A>
|
||||||
<UL CLASS="toc"><LI CLASS="li-toc">
|
<UL CLASS="toc"><LI CLASS="li-toc">
|
||||||
<A HREF="#htoc91">7.1  Log Files</A>
|
<A HREF="#htoc92">7.1  Log Files</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc92">7.2  Debug Console</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc93">7.2  Debug Console</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc93">7.3  Watchdog Alerts</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc94">7.3  Watchdog Alerts</A>
|
||||||
</LI></UL>
|
</LI></UL>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc94">Appendix A  Internationalization and Localization</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc95">Appendix A  Internationalization and Localization</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc95">Appendix B  Release Notes</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc96">Appendix B  Release Notes</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc96">Appendix C  Acknowledgements</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc97">Appendix C  Acknowledgements</A>
|
||||||
</LI><LI CLASS="li-toc"><A HREF="#htoc97">Appendix D  Copyright Information</A>
|
</LI><LI CLASS="li-toc"><A HREF="#htoc98">Appendix D  Copyright Information</A>
|
||||||
</LI></UL><!--TOC chapter Introduction-->
|
</LI></UL><!--TOC chapter Introduction-->
|
||||||
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc1">Chapter 1</A>  Introduction</H1><!--SEC END --><P>
|
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc1">Chapter 1</A>  Introduction</H1><!--SEC END --><P>
|
||||||
<A NAME="intro"></A></P><P><TT>ejabberd</TT> is a free and open source instant messaging server written in <A HREF="http://www.erlang.org/">Erlang/OTP</A>.</P><P><TT>ejabberd</TT> is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.</P><P><TT>ejabberd</TT> is designed to be a rock-solid and feature rich XMPP server.</P><P><TT>ejabberd</TT> is suitable for small deployments, whether they need to be scalable or not, as well as extremely big deployments.</P><!--TOC section Key Features-->
|
<A NAME="intro"></A></P><P><TT>ejabberd</TT> is a free and open source instant messaging server written in <A HREF="http://www.erlang.org/">Erlang</A>.</P><P><TT>ejabberd</TT> is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.</P><P><TT>ejabberd</TT> is designed to be a rock-solid and feature rich XMPP server.</P><P><TT>ejabberd</TT> is suitable for small deployments, whether they need to be scalable or not, as well as extremely big deployments.</P><!--TOC section Key Features-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc2">1.1</A>  Key Features</H2><!--SEC END --><P>
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc2">1.1</A>  Key Features</H2><!--SEC END --><P>
|
||||||
<A NAME="keyfeatures"></A>
|
<A NAME="keyfeatures"></A>
|
||||||
</P><P><TT>ejabberd</TT> is:
|
</P><P><TT>ejabberd</TT> is:
|
||||||
@ -268,12 +269,13 @@ Internal Authentication.
|
|||||||
</LI><LI CLASS="li-itemize">Others
|
</LI><LI CLASS="li-itemize">Others
|
||||||
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
<UL CLASS="itemize"><LI CLASS="li-itemize">
|
||||||
Support for virtual hosting.
|
Support for virtual hosting.
|
||||||
</LI><LI CLASS="li-itemize">Compressing XML streams with Stream Compression (<A HREF="http://xmpp.org/extensions/xep-0138.html">XEP-0138</A>).
|
</LI><LI CLASS="li-itemize">Compressing XML streams with Stream Compression (<A HREF="http://www.xmpp.org/extensions/xep-0138.html">XEP-0138</A>).
|
||||||
</LI><LI CLASS="li-itemize">Statistics via Statistics Gathering (<A HREF="http://xmpp.org/extensions/xep-0039.html">XEP-0039</A>).
|
</LI><LI CLASS="li-itemize">Statistics via Statistics Gathering (<A HREF="http://www.xmpp.org/extensions/xep-0039.html">XEP-0039</A>).
|
||||||
</LI><LI CLASS="li-itemize">IPv6 support both for c2s and s2s connections.
|
</LI><LI CLASS="li-itemize">IPv6 support both for c2s and s2s connections.
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://xmpp.org/extensions/xep-0045.html">Multi-User Chat</A> module with support for clustering and HTML logging. </LI><LI CLASS="li-itemize">Users Directory based on users vCards.
|
</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0045.html">Multi-User Chat</A> module with support for clustering and HTML logging. </LI><LI CLASS="li-itemize">Users Directory based on users vCards.
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component with support for <A HREF="http://xmpp.org/extensions/xep-0163.html">Personal Eventing via Pubsub</A>.
|
</LI><LI CLASS="li-itemize"><A HREF="http://www.xmpp.org/extensions/xep-0060.html">Publish-Subscribe</A> component with support for <A HREF="http://www.xmpp.org/extensions/xep-0163.html">Personal Eventing via Pubsub</A>.
|
||||||
</LI><LI CLASS="li-itemize">Support for web clients: <A HREF="http://xmpp.org/extensions/xep-0025.html">HTTP Polling</A> and <A HREF="http://xmpp.org/extensions/xep-0206.html">HTTP Binding (BOSH)</A> services.
|
</LI><LI CLASS="li-itemize">Support for web clients: <A HREF="http://www.xmpp.org/extensions/xep-0025.html">HTTP Polling</A> and <A HREF="http://www.xmpp.org/extensions/xep-0206.html">HTTP Binding (BOSH)</A> services.
|
||||||
|
</LI><LI CLASS="li-itemize">IRC transport.
|
||||||
</LI><LI CLASS="li-itemize">Component support: interface with networks such as AIM, ICQ and MSN installing special tranports.
|
</LI><LI CLASS="li-itemize">Component support: interface with networks such as AIM, ICQ and MSN installing special tranports.
|
||||||
</LI></UL>
|
</LI></UL>
|
||||||
</LI></UL><P> <A NAME="installing"></A> </P><!--TOC chapter Installing <TT>ejabberd</TT>-->
|
</LI></UL><P> <A NAME="installing"></A> </P><!--TOC chapter Installing <TT>ejabberd</TT>-->
|
||||||
@ -336,14 +338,16 @@ as long as your system have all the dependencies.</P><P> <A NAME="installreq"></
|
|||||||
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
||||||
GNU Make
|
GNU Make
|
||||||
</LI><LI CLASS="li-itemize">GCC
|
</LI><LI CLASS="li-itemize">GCC
|
||||||
</LI><LI CLASS="li-itemize">Erlang/OTP R12B-4 or higher, R13B or higher.
|
</LI><LI CLASS="li-itemize">Libexpat 1.95 or higher
|
||||||
</LI><LI CLASS="li-itemize">exmpp 0.9.1 or higher
|
</LI><LI CLASS="li-itemize">Erlang/OTP R10B-9 or higher. The recommended version is R12B-5. Support for R13 is experimental.
|
||||||
</LI><LI CLASS="li-itemize">OpenSSL 0.9.6 or higher, for STARTTLS, SASL and SSL encryption. Optional, highly recommended.
|
</LI><LI CLASS="li-itemize">OpenSSL 0.9.6 or higher, for STARTTLS, SASL and SSL encryption. Optional, highly recommended.
|
||||||
</LI><LI CLASS="li-itemize">Zlib 1.2.3 or higher, for Stream Compression support (<A HREF="http://xmpp.org/extensions/xep-0138.html">XEP-0138</A>). Optional.
|
</LI><LI CLASS="li-itemize">Zlib 1.2.3 or higher, for Stream Compression support (<A HREF="http://www.xmpp.org/extensions/xep-0138.html">XEP-0138</A>). Optional.
|
||||||
</LI><LI CLASS="li-itemize">Erlang mysql library. Optional. For MySQL authentication or storage. See section <A HREF="#compilemysql">3.2.1</A>.
|
</LI><LI CLASS="li-itemize">Erlang mysql library. Optional. For MySQL authentication or storage. See section <A HREF="#compilemysql">3.2.1</A>.
|
||||||
</LI><LI CLASS="li-itemize">Erlang pgsql library. Optional. For PostgreSQL authentication or storage. See section <A HREF="#compilepgsql">3.2.3</A>.
|
</LI><LI CLASS="li-itemize">Erlang pgsql library. Optional. For PostgreSQL authentication or storage. See section <A HREF="#compilepgsql">3.2.3</A>.
|
||||||
</LI><LI CLASS="li-itemize">PAM library. Optional. For Pluggable Authentication Modules (PAM). See section <A HREF="#pam">3.1.4</A>.
|
</LI><LI CLASS="li-itemize">PAM library. Optional. For Pluggable Authentication Modules (PAM). See section <A HREF="#pam">3.1.4</A>.
|
||||||
|
</LI><LI CLASS="li-itemize">GNU Iconv 1.8 or higher, for the IRC Transport (mod_irc). Optional. Not needed on systems with GNU Libc. See section <A HREF="#modirc">3.3.8</A>.
|
||||||
</LI><LI CLASS="li-itemize">ImageMagick’s Convert program. Optional. For CAPTCHA challenges. See section <A HREF="#captcha">3.1.8</A>.
|
</LI><LI CLASS="li-itemize">ImageMagick’s Convert program. Optional. For CAPTCHA challenges. See section <A HREF="#captcha">3.1.8</A>.
|
||||||
|
</LI><LI CLASS="li-itemize">exmpp 0.9.1 or higher. Optional. For import/export user data with <A HREF="http://www.xmpp.org/extensions/xep-0227.html">XEP-0227</A> XML files.
|
||||||
</LI></UL><P> <A NAME="download"></A> </P><!--TOC subsection Download Source Code-->
|
</LI></UL><P> <A NAME="download"></A> </P><!--TOC subsection Download Source Code-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc10">2.4.2</A>  <A HREF="#download">Download Source Code</A></H3><!--SEC END --><P> <A NAME="download"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc10">2.4.2</A>  <A HREF="#download">Download Source Code</A></H3><!--SEC END --><P> <A NAME="download"></A>
|
||||||
</P><P>Released versions of <TT>ejabberd</TT> are available in the ProcessOne <TT>ejabberd</TT> downloads page:
|
</P><P>Released versions of <TT>ejabberd</TT> are available in the ProcessOne <TT>ejabberd</TT> downloads page:
|
||||||
@ -458,25 +462,31 @@ for example:
|
|||||||
<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#windowsreq">Requirements</A></H4><!--SEC END --><P> <A NAME="windowsreq"></A> </P><P>To compile <TT>ejabberd</TT> on a Microsoft Windows system, you need:
|
<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#windowsreq">Requirements</A></H4><!--SEC END --><P> <A NAME="windowsreq"></A> </P><P>To compile <TT>ejabberd</TT> on a Microsoft Windows system, you need:
|
||||||
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
||||||
MS Visual C++ 6.0 Compiler
|
MS Visual C++ 6.0 Compiler
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://www.erlang.org/download.html">Erlang/OTP R12B-5</A>. Support for R13 or higher is experimental.
|
</LI><LI CLASS="li-itemize"><A HREF="http://www.erlang.org/download.html">Erlang/OTP R11B-5</A>
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://support.process-one.net/doc/display/EXMPP">exmpp 0.9.1 or higher</A>
|
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://sourceforge.net/project/showfiles.php?group_id=10127&package_id=11277">Expat 2.0.0 or higher</A>
|
</LI><LI CLASS="li-itemize"><A HREF="http://sourceforge.net/project/showfiles.php?group_id=10127&package_id=11277">Expat 2.0.0 or higher</A>
|
||||||
|
</LI><LI CLASS="li-itemize"><A HREF="http://www.gnu.org/software/libiconv/">GNU Iconv 1.9.2</A>
|
||||||
|
(optional)
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://www.slproweb.com/products/Win32OpenSSL.html">Shining Light OpenSSL 0.9.8d or higher</A>
|
</LI><LI CLASS="li-itemize"><A HREF="http://www.slproweb.com/products/Win32OpenSSL.html">Shining Light OpenSSL 0.9.8d or higher</A>
|
||||||
(to enable SSL connections)
|
(to enable SSL connections)
|
||||||
</LI><LI CLASS="li-itemize"><A HREF="http://www.zlib.net/">Zlib 1.2.3 or higher</A>
|
</LI><LI CLASS="li-itemize"><A HREF="http://www.zlib.net/">Zlib 1.2.3 or higher</A>
|
||||||
</LI></UL><P> <A NAME="windowscom"></A> </P><!--TOC subsubsection Compilation-->
|
</LI></UL><P> <A NAME="windowscom"></A> </P><!--TOC subsubsection Compilation-->
|
||||||
<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#windowscom">Compilation</A></H4><!--SEC END --><P> <A NAME="windowscom"></A> </P><P>We assume that we will try to put as much library as possible into <CODE>C:\sdk\</CODE> to make it easier to track what is install for <TT>ejabberd</TT>.</P><OL CLASS="enumerate" type=1><LI CLASS="li-enumerate">
|
<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#windowscom">Compilation</A></H4><!--SEC END --><P> <A NAME="windowscom"></A> </P><P>We assume that we will try to put as much library as possible into <CODE>C:\sdk\</CODE> to make it easier to track what is install for <TT>ejabberd</TT>.</P><OL CLASS="enumerate" type=1><LI CLASS="li-enumerate">
|
||||||
Install Erlang emulator (for example, into <CODE>C:\sdk\erl5.6.5</CODE>).
|
Install Erlang emulator (for example, into <CODE>C:\sdk\erl5.5.5</CODE>).
|
||||||
</LI><LI CLASS="li-enumerate">Install Expat library into <CODE>C:\sdk\Expat-2.0.0</CODE>
|
</LI><LI CLASS="li-enumerate">Install Expat library into <CODE>C:\sdk\Expat-2.0.0</CODE>
|
||||||
directory.<P>Copy file <CODE>C:\sdk\Expat-2.0.0\Libs\libexpat.dll</CODE>
|
directory.<P>Copy file <CODE>C:\sdk\Expat-2.0.0\Libs\libexpat.dll</CODE>
|
||||||
to your Windows system directory (for example, <CODE>C:\WINNT</CODE> or
|
to your Windows system directory (for example, <CODE>C:\WINNT</CODE> or
|
||||||
<CODE>C:\WINNT\System32</CODE>)
|
<CODE>C:\WINNT\System32</CODE>)
|
||||||
Note: instead of copying libexpat.dll to the Windows
|
</P></LI><LI CLASS="li-enumerate">Build and install the Iconv library into the directory
|
||||||
directory, you can add the directory <CODE>C:\sdk\Expat-2.0.0\Libs</CODE>
|
<CODE>C:\sdk\GnuWin32</CODE>.<P>Copy file <CODE>C:\sdk\GnuWin32\bin\lib*.dll</CODE> to your
|
||||||
to the <CODE>PATH</CODE> environment variable.
|
Windows system directory (more installation instructions can be found in the
|
||||||
|
file README.woe32 in the iconv distribution).</P><P>Note: instead of copying libexpat.dll and iconv.dll to the Windows
|
||||||
|
directory, you can add the directories
|
||||||
|
<CODE>C:\sdk\Expat-2.0.0\Libs</CODE> and
|
||||||
|
<CODE>C:\sdk\GnuWin32\bin</CODE> to the <CODE>PATH</CODE> environment
|
||||||
|
variable.
|
||||||
</P></LI><LI CLASS="li-enumerate">Install OpenSSL in <CODE>C:\sdk\OpenSSL</CODE> and add <CODE>C:\sdk\OpenSSL\lib\VC</CODE> to your path or copy the binaries to your system directory.
|
</P></LI><LI CLASS="li-enumerate">Install OpenSSL in <CODE>C:\sdk\OpenSSL</CODE> and add <CODE>C:\sdk\OpenSSL\lib\VC</CODE> to your path or copy the binaries to your system directory.
|
||||||
</LI><LI CLASS="li-enumerate">Install ZLib in <CODE>C:\sdk\gnuWin32</CODE>. Copy
|
</LI><LI CLASS="li-enumerate">Install ZLib in <CODE>C:\sdk\gnuWin32</CODE>. Copy
|
||||||
<CODE>C:\sdk\GnuWin32\bin\zlib1.dll</CODE> to your system directory.
|
<CODE>C:\sdk\GnuWin32\bin\zlib1.dll</CODE> to your system directory. If you change your path it should already be set after libiconv install.
|
||||||
</LI><LI CLASS="li-enumerate">Make sure the you can access Erlang binaries from your path. For example: <CODE>set PATH=%PATH%;"C:\sdk\erl5.6.5\bin"</CODE>
|
</LI><LI CLASS="li-enumerate">Make sure the you can access Erlang binaries from your path. For example: <CODE>set PATH=%PATH%;"C:\sdk\erl5.6.5\bin"</CODE>
|
||||||
</LI><LI CLASS="li-enumerate">Depending on how you end up actually installing the library you might need to check and tweak the paths in the file configure.erl.
|
</LI><LI CLASS="li-enumerate">Depending on how you end up actually installing the library you might need to check and tweak the paths in the file configure.erl.
|
||||||
</LI><LI CLASS="li-enumerate">While in the directory <CODE>ejabberd\src</CODE> run:
|
</LI><LI CLASS="li-enumerate">While in the directory <CODE>ejabberd\src</CODE> run:
|
||||||
@ -493,7 +503,7 @@ There are two ways to register a Jabber account:
|
|||||||
<OL CLASS="enumerate" type=a><LI CLASS="li-enumerate">
|
<OL CLASS="enumerate" type=a><LI CLASS="li-enumerate">
|
||||||
Using <TT>ejabberdctl</TT> (see section <A HREF="#ejabberdctl">4.1</A>):
|
Using <TT>ejabberdctl</TT> (see section <A HREF="#ejabberdctl">4.1</A>):
|
||||||
<PRE CLASS="verbatim">ejabberdctl register admin1 example.org FgT5bk3
|
<PRE CLASS="verbatim">ejabberdctl register admin1 example.org FgT5bk3
|
||||||
</PRE></LI><LI CLASS="li-enumerate">Using a Jabber client and In-Band Registration (see section <A HREF="#modregister">3.3.17</A>).
|
</PRE></LI><LI CLASS="li-enumerate">Using a Jabber client and In-Band Registration (see section <A HREF="#modregister">3.3.18</A>).
|
||||||
</LI></OL>
|
</LI></OL>
|
||||||
</LI><LI CLASS="li-enumerate">Edit the <TT>ejabberd</TT> configuration file to give administration rights to the Jabber account you created:
|
</LI><LI CLASS="li-enumerate">Edit the <TT>ejabberd</TT> configuration file to give administration rights to the Jabber account you created:
|
||||||
<PRE CLASS="verbatim">{acl, admins, {user, "admin1", "example.org"}}.
|
<PRE CLASS="verbatim">{acl, admins, {user, "admin1", "example.org"}}.
|
||||||
@ -667,7 +677,7 @@ Handles incoming s2s connections.<BR>
|
|||||||
Options: <TT>max_stanza_size</TT>
|
Options: <TT>max_stanza_size</TT>
|
||||||
</DD><DT CLASS="dt-description"><B><TT>ejabberd_service</TT></B></DT><DD CLASS="dd-description">
|
</DD><DT CLASS="dt-description"><B><TT>ejabberd_service</TT></B></DT><DD CLASS="dd-description">
|
||||||
Interacts with an <A HREF="http://www.ejabberd.im/tutorials-transports">external component</A>
|
Interacts with an <A HREF="http://www.ejabberd.im/tutorials-transports">external component</A>
|
||||||
(as defined in the Jabber Component Protocol (<A HREF="http://xmpp.org/extensions/xep-0114.html">XEP-0114</A>).<BR>
|
(as defined in the Jabber Component Protocol (<A HREF="http://www.xmpp.org/extensions/xep-0114.html">XEP-0114</A>).<BR>
|
||||||
Options: <TT>access</TT>, <TT>hosts</TT>,
|
Options: <TT>access</TT>, <TT>hosts</TT>,
|
||||||
<TT>shaper</TT>, <TT>service_check_from</TT>
|
<TT>shaper</TT>, <TT>service_check_from</TT>
|
||||||
</DD><DT CLASS="dt-description"><B><TT>ejabberd_http</TT></B></DT><DD CLASS="dd-description">
|
</DD><DT CLASS="dt-description"><B><TT>ejabberd_http</TT></B></DT><DD CLASS="dd-description">
|
||||||
@ -685,7 +695,7 @@ To define a certificate file specific for a given domain, use the global option
|
|||||||
This option can be used with <TT>ejabberd_service</TT> only. It is
|
This option can be used with <TT>ejabberd_service</TT> only. It is
|
||||||
used to disable control on the from field on packets send by an
|
used to disable control on the from field on packets send by an
|
||||||
external components. The option can be either <TT>true</TT> or
|
external components. The option can be either <TT>true</TT> or
|
||||||
<TT>false</TT>. The default value is <TT>true</TT> which conforms to <A HREF="http://xmpp.org/extensions/xep-0114.html">XEP-0114</A>.
|
<TT>false</TT>. The default value is <TT>true</TT> which conforms to <A HREF="http://www.xmpp.org/extensions/xep-0114.html">XEP-0114</A>.
|
||||||
</DD><DT CLASS="dt-description"><B><TT>{hosts, [Hostnames], [HostOptions]}</TT></B></DT><DD CLASS="dd-description">
|
</DD><DT CLASS="dt-description"><B><TT>{hosts, [Hostnames], [HostOptions]}</TT></B></DT><DD CLASS="dd-description">
|
||||||
The external Jabber component that connects to this <TT>ejabberd_service</TT>
|
The external Jabber component that connects to this <TT>ejabberd_service</TT>
|
||||||
can serve one or more hostnames.
|
can serve one or more hostnames.
|
||||||
@ -698,7 +708,7 @@ as seen in an example below.
|
|||||||
</DD><DT CLASS="dt-description"><B><TT>captcha</TT></B></DT><DD CLASS="dd-description">
|
</DD><DT CLASS="dt-description"><B><TT>captcha</TT></B></DT><DD CLASS="dd-description">
|
||||||
Simple web page that allows a user to fill a CAPTCHA challenge (see section <A HREF="#captcha">3.1.8</A>).
|
Simple web page that allows a user to fill a CAPTCHA challenge (see section <A HREF="#captcha">3.1.8</A>).
|
||||||
</DD><DT CLASS="dt-description"><B><TT>http_bind</TT></B></DT><DD CLASS="dd-description">
|
</DD><DT CLASS="dt-description"><B><TT>http_bind</TT></B></DT><DD CLASS="dd-description">
|
||||||
This option enables HTTP Binding (<A HREF="http://xmpp.org/extensions/xep-0124.html">XEP-0124</A> and <A HREF="http://xmpp.org/extensions/xep-0206.html">XEP-0206</A>) support. HTTP Bind
|
This option enables HTTP Binding (<A HREF="http://www.xmpp.org/extensions/xep-0124.html">XEP-0124</A> and <A HREF="http://www.xmpp.org/extensions/xep-0206.html">XEP-0206</A>) support. HTTP Bind
|
||||||
enables access via HTTP requests to <TT>ejabberd</TT> from behind firewalls which
|
enables access via HTTP requests to <TT>ejabberd</TT> from behind firewalls which
|
||||||
do not allow outgoing sockets on port 5222.<P>Remember that you must also install and enable the module mod_http_bind.</P><P>If HTTP Bind is enabled, it will be available at
|
do not allow outgoing sockets on port 5222.<P>Remember that you must also install and enable the module mod_http_bind.</P><P>If HTTP Bind is enabled, it will be available at
|
||||||
<CODE>http://server:port/http-bind/</CODE>. Be aware that support for HTTP Bind
|
<CODE>http://server:port/http-bind/</CODE>. Be aware that support for HTTP Bind
|
||||||
@ -709,7 +719,7 @@ interesting to host a web-based Jabber client such as
|
|||||||
<A HREF="http://www.ejabberd.im/jwchat-localserver">embedded local web server</A>
|
<A HREF="http://www.ejabberd.im/jwchat-localserver">embedded local web server</A>
|
||||||
or <A HREF="http://www.ejabberd.im/jwchat-apache">Apache</A>).
|
or <A HREF="http://www.ejabberd.im/jwchat-apache">Apache</A>).
|
||||||
</P></DD><DT CLASS="dt-description"><B><TT>http_poll</TT></B></DT><DD CLASS="dd-description">
|
</P></DD><DT CLASS="dt-description"><B><TT>http_poll</TT></B></DT><DD CLASS="dd-description">
|
||||||
This option enables HTTP Polling (<A HREF="http://xmpp.org/extensions/xep-0025.html">XEP-0025</A>) support. HTTP Polling
|
This option enables HTTP Polling (<A HREF="http://www.xmpp.org/extensions/xep-0025.html">XEP-0025</A>) support. HTTP Polling
|
||||||
enables access via HTTP requests to <TT>ejabberd</TT> from behind firewalls which
|
enables access via HTTP requests to <TT>ejabberd</TT> from behind firewalls which
|
||||||
do not allow outgoing sockets on port 5222.<P>If HTTP Polling is enabled, it will be available at
|
do not allow outgoing sockets on port 5222.<P>If HTTP Polling is enabled, it will be available at
|
||||||
<CODE>http://server:port/http-poll/</CODE>. Be aware that support for HTTP Polling
|
<CODE>http://server:port/http-poll/</CODE>. Be aware that support for HTTP Polling
|
||||||
@ -735,7 +745,7 @@ and you also want <TT>mod_http_bind</TT> to serve the URIs <TT>/http-bind/</TT>,
|
|||||||
use this option: <TT>{request_handlers, [{["a", "b"], mod_foo}, {["http-bind"], mod_http_bind}]}</TT>
|
use this option: <TT>{request_handlers, [{["a", "b"], mod_foo}, {["http-bind"], mod_http_bind}]}</TT>
|
||||||
</DD><DT CLASS="dt-description"><B><TT>{service_check_from, true|false}</TT></B></DT><DD CLASS="dd-description">
|
</DD><DT CLASS="dt-description"><B><TT>{service_check_from, true|false}</TT></B></DT><DD CLASS="dd-description">
|
||||||
By enabling this option, <TT>ejabberd</TT> allows the component to send packets with any arbitrary domain in the ’from’ attribute.
|
By enabling this option, <TT>ejabberd</TT> allows the component to send packets with any arbitrary domain in the ’from’ attribute.
|
||||||
Note that <A HREF="http://xmpp.org/extensions/xep-0114.html">XEP-0114</A> requires that the domain must match the hostname of the component.
|
Note that <A HREF="http://www.xmpp.org/extensions/xep-0114.html">XEP-0114</A> requires that the domain must match the hostname of the component.
|
||||||
Only enable this option if you are completely sure you need to enable it.
|
Only enable this option if you are completely sure you need to enable it.
|
||||||
Default value: false.
|
Default value: false.
|
||||||
</DD><DT CLASS="dt-description"><B><TT>{shaper, <access rule>}</TT></B></DT><DD CLASS="dd-description"> This option defines a
|
</DD><DT CLASS="dt-description"><B><TT>{shaper, <access rule>}</TT></B></DT><DD CLASS="dd-description"> This option defines a
|
||||||
@ -756,7 +766,7 @@ This was the traditional encryption method in the early Jabber software,
|
|||||||
commonly on port 5223 for client-to-server communications.
|
commonly on port 5223 for client-to-server communications.
|
||||||
But this method is nowadays deprecated and not recommended.
|
But this method is nowadays deprecated and not recommended.
|
||||||
The preferable encryption method is STARTTLS on port 5222, as defined
|
The preferable encryption method is STARTTLS on port 5222, as defined
|
||||||
<A HREF="http://xmpp.org/specs/rfc3920.html#tls">RFC 3920: XMPP Core</A>,
|
<A HREF="http://www.xmpp.org/specs/rfc3920.html#tls">RFC 3920: XMPP Core</A>,
|
||||||
which can be enabled in <TT>ejabberd</TT> with the option <TT>starttls</TT>.
|
which can be enabled in <TT>ejabberd</TT> with the option <TT>starttls</TT>.
|
||||||
If this option is set, you should also set the <TT>certfile</TT> option.
|
If this option is set, you should also set the <TT>certfile</TT> option.
|
||||||
</DD><DT CLASS="dt-description"><B><TT>web_admin</TT></B></DT><DD CLASS="dd-description"> This option
|
</DD><DT CLASS="dt-description"><B><TT>web_admin</TT></B></DT><DD CLASS="dd-description"> This option
|
||||||
@ -765,7 +775,7 @@ at <CODE>http://server:port/admin/</CODE>. Login and password are the username a
|
|||||||
password of one of the registered users who are granted access by the
|
password of one of the registered users who are granted access by the
|
||||||
‘configure’ access rule.
|
‘configure’ access rule.
|
||||||
</DD><DT CLASS="dt-description"><B><TT>zlib</TT></B></DT><DD CLASS="dd-description"> This
|
</DD><DT CLASS="dt-description"><B><TT>zlib</TT></B></DT><DD CLASS="dd-description"> This
|
||||||
option specifies that Zlib stream compression (as defined in <A HREF="http://xmpp.org/extensions/xep-0138.html">XEP-0138</A>)
|
option specifies that Zlib stream compression (as defined in <A HREF="http://www.xmpp.org/extensions/xep-0138.html">XEP-0138</A>)
|
||||||
is available on connections to the port. Client connections cannot use
|
is available on connections to the port. Client connections cannot use
|
||||||
stream compression and stream encryption simultaneously. Hence, if you
|
stream compression and stream encryption simultaneously. Hence, if you
|
||||||
specify both <TT>starttls</TT> (or <TT>tls</TT>) and <TT>zlib</TT>, the latter
|
specify both <TT>starttls</TT> (or <TT>tls</TT>) and <TT>zlib</TT>, the latter
|
||||||
@ -1216,7 +1226,7 @@ can be seen by Jabber clients. If a Jabber client does not support
|
|||||||
</PRE><P>Appendix <A HREF="#i18ni10n">A</A> provides more details about internationalization and localization.</P><P> <A NAME="captcha"></A> </P><!--TOC subsection CAPTCHA-->
|
</PRE><P>Appendix <A HREF="#i18ni10n">A</A> provides more details about internationalization and localization.</P><P> <A NAME="captcha"></A> </P><!--TOC subsection CAPTCHA-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc28">3.1.8</A>  <A HREF="#captcha">CAPTCHA</A></H3><!--SEC END --><P> <A NAME="captcha"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc28">3.1.8</A>  <A HREF="#captcha">CAPTCHA</A></H3><!--SEC END --><P> <A NAME="captcha"></A>
|
||||||
</P><P>Some <TT>ejabberd</TT> modules can be configured to require a CAPTCHA challenge on certain actions.
|
</P><P>Some <TT>ejabberd</TT> modules can be configured to require a CAPTCHA challenge on certain actions.
|
||||||
If the client does not support CAPTCHA Forms (<A HREF="http://xmpp.org/extensions/xep-0158.html">XEP-0158</A>),
|
If the client does not support CAPTCHA Forms (<A HREF="http://www.xmpp.org/extensions/xep-0158.html">XEP-0158</A>),
|
||||||
a web link is provided so the user can fill the challenge in a web browser.</P><P>An example script is provided that generates the image
|
a web link is provided so the user can fill the challenge in a web browser.</P><P>An example script is provided that generates the image
|
||||||
using ImageMagick’s Convert program.</P><P>The configurable options are:
|
using ImageMagick’s Convert program.</P><P>The configurable options are:
|
||||||
</P><DL CLASS="description"><DT CLASS="dt-description">
|
</P><DL CLASS="description"><DT CLASS="dt-description">
|
||||||
@ -1616,7 +1626,7 @@ user’s part of a JID. For example, <TT>"%u@example.org"</TT>. The default
|
|||||||
value is <TT>"%u"</TT>.
|
value is <TT>"%u"</TT>.
|
||||||
</DD></DL>
|
</DD></DL>
|
||||||
</DD><DT CLASS="dt-description"><B><TT>ldap_filter</TT></B></DT><DD CLASS="dd-description">
|
</DD><DT CLASS="dt-description"><B><TT>ldap_filter</TT></B></DT><DD CLASS="dd-description">
|
||||||
<A HREF="http://tools.ietf.org/html/rfc4515">RFC 4515</A> LDAP filter. The
|
<A HREF="http://www.faqs.org/rfcs/rfc2254.html">RFC 2254</A> LDAP filter. The
|
||||||
default is <TT>none</TT>. Example:
|
default is <TT>none</TT>. Example:
|
||||||
<TT>"(&(objectClass=shadowAccount)(memberOf=Jabber Users))"</TT>. Please, do
|
<TT>"(&(objectClass=shadowAccount)(memberOf=Jabber Users))"</TT>. Please, do
|
||||||
not forget to close brackets and do not use superfluous whitespaces. Also you
|
not forget to close brackets and do not use superfluous whitespaces. Also you
|
||||||
@ -1775,37 +1785,38 @@ all entries end with a comma:
|
|||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc38">3.3.1</A>  <A HREF="#modoverview">Modules Overview</A></H3><!--SEC END --><P> <A NAME="modoverview"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc38">3.3.1</A>  <A HREF="#modoverview">Modules Overview</A></H3><!--SEC END --><P> <A NAME="modoverview"></A>
|
||||||
</P><P>The following table lists all modules included in <TT>ejabberd</TT>.</P><BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV>
|
</P><P>The following table lists all modules included in <TT>ejabberd</TT>.</P><BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV>
|
||||||
<TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1><TR><TD ALIGN=left NOWRAP><B>Module</B></TD><TD ALIGN=left NOWRAP><B>Feature</B></TD><TD ALIGN=left NOWRAP><B>Dependencies</B></TD></TR>
|
<TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1><TR><TD ALIGN=left NOWRAP><B>Module</B></TD><TD ALIGN=left NOWRAP><B>Feature</B></TD><TD ALIGN=left NOWRAP><B>Dependencies</B></TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><TT>mod_adhoc</TT></TD><TD ALIGN=left NOWRAP>Ad-Hoc Commands (<A HREF="http://xmpp.org/extensions/xep-0050.html">XEP-0050</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><TT>mod_adhoc</TT></TD><TD ALIGN=left NOWRAP>Ad-Hoc Commands (<A HREF="http://www.xmpp.org/extensions/xep-0050.html">XEP-0050</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modannounce"><TT>mod_announce</TT></A></TD><TD ALIGN=left NOWRAP>Manage announcements</TD><TD ALIGN=left NOWRAP>recommends <TT>mod_adhoc</TT></TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modannounce"><TT>mod_announce</TT></A></TD><TD ALIGN=left NOWRAP>Manage announcements</TD><TD ALIGN=left NOWRAP>recommends <TT>mod_adhoc</TT></TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><TT>mod_caps</TT></TD><TD ALIGN=left NOWRAP>Entity Capabilities (<A HREF="http://xmpp.org/extensions/xep-0115.html">XEP-0115</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><TT>mod_caps</TT></TD><TD ALIGN=left NOWRAP>Entity Capabilities (<A HREF="http://www.xmpp.org/extensions/xep-0115.html">XEP-0115</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><TT>mod_configure</TT></TD><TD ALIGN=left NOWRAP>Server configuration using Ad-Hoc</TD><TD ALIGN=left NOWRAP><TT>mod_adhoc</TT></TD></TR>
|
<TR><TD ALIGN=left NOWRAP><TT>mod_configure</TT></TD><TD ALIGN=left NOWRAP>Server configuration using Ad-Hoc</TD><TD ALIGN=left NOWRAP><TT>mod_adhoc</TT></TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#moddisco"><TT>mod_disco</TT></A></TD><TD ALIGN=left NOWRAP>Service Discovery (<A HREF="http://xmpp.org/extensions/xep-0030.html">XEP-0030</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#moddisco"><TT>mod_disco</TT></A></TD><TD ALIGN=left NOWRAP>Service Discovery (<A HREF="http://www.xmpp.org/extensions/xep-0030.html">XEP-0030</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modecho"><TT>mod_echo</TT></A></TD><TD ALIGN=left NOWRAP>Echoes Jabber packets</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modecho"><TT>mod_echo</TT></A></TD><TD ALIGN=left NOWRAP>Echoes Jabber packets</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modlast"><TT>mod_last</TT></A></TD><TD ALIGN=left NOWRAP>Last Activity (<A HREF="http://xmpp.org/extensions/xep-0012.html">XEP-0012</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modirc"><TT>mod_irc</TT></A></TD><TD ALIGN=left NOWRAP>IRC transport</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modlast"><TT>mod_last_odbc</TT></A></TD><TD ALIGN=left NOWRAP>Last Activity (<A HREF="http://xmpp.org/extensions/xep-0012.html">XEP-0012</A>)</TD><TD ALIGN=left NOWRAP>supported DB (*)</TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modlast"><TT>mod_last</TT></A></TD><TD ALIGN=left NOWRAP>Last Activity (<A HREF="http://www.xmpp.org/extensions/xep-0012.html">XEP-0012</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modmuc"><TT>mod_muc</TT></A></TD><TD ALIGN=left NOWRAP>Multi-User Chat (<A HREF="http://xmpp.org/extensions/xep-0045.html">XEP-0045</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modlast"><TT>mod_last_odbc</TT></A></TD><TD ALIGN=left NOWRAP>Last Activity (<A HREF="http://www.xmpp.org/extensions/xep-0012.html">XEP-0012</A>)</TD><TD ALIGN=left NOWRAP>supported DB (*)</TD></TR>
|
||||||
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modmuc"><TT>mod_muc</TT></A></TD><TD ALIGN=left NOWRAP>Multi-User Chat (<A HREF="http://www.xmpp.org/extensions/xep-0045.html">XEP-0045</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modmuclog"><TT>mod_muc_log</TT></A></TD><TD ALIGN=left NOWRAP>Multi-User Chat room logging</TD><TD ALIGN=left NOWRAP><TT>mod_muc</TT></TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modmuclog"><TT>mod_muc_log</TT></A></TD><TD ALIGN=left NOWRAP>Multi-User Chat room logging</TD><TD ALIGN=left NOWRAP><TT>mod_muc</TT></TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modoffline"><TT>mod_offline</TT></A></TD><TD ALIGN=left NOWRAP>Offline message storage (<A HREF="http://xmpp.org/extensions/xep-0160.html">XEP-0160</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modoffline"><TT>mod_offline</TT></A></TD><TD ALIGN=left NOWRAP>Offline message storage (<A HREF="http://www.xmpp.org/extensions/xep-0160.html">XEP-0160</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modoffline"><TT>mod_offline_odbc</TT></A></TD><TD ALIGN=left NOWRAP>Offline message storage (<A HREF="http://xmpp.org/extensions/xep-0160.html">XEP-0160</A>)</TD><TD ALIGN=left NOWRAP>supported DB (*)</TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modoffline"><TT>mod_offline_odbc</TT></A></TD><TD ALIGN=left NOWRAP>Offline message storage (<A HREF="http://www.xmpp.org/extensions/xep-0160.html">XEP-0160</A>)</TD><TD ALIGN=left NOWRAP>supported DB (*)</TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modping"><TT>mod_ping</TT></A></TD><TD ALIGN=left NOWRAP>XMPP Ping and periodic keepalives (<A HREF="http://xmpp.org/extensions/xep-0199.html">XEP-0199</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modping"><TT>mod_ping</TT></A></TD><TD ALIGN=left NOWRAP>XMPP Ping and periodic keepalives (<A HREF="http://www.xmpp.org/extensions/xep-0199.html">XEP-0199</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modprivacy"><TT>mod_privacy</TT></A></TD><TD ALIGN=left NOWRAP>Blocking Communication (XMPP IM)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modprivacy"><TT>mod_privacy</TT></A></TD><TD ALIGN=left NOWRAP>Blocking Communication (XMPP IM)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modprivacy"><TT>mod_privacy_odbc</TT></A></TD><TD ALIGN=left NOWRAP>Blocking Communication (XMPP IM)</TD><TD ALIGN=left NOWRAP>supported DB (*)</TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modprivacy"><TT>mod_privacy_odbc</TT></A></TD><TD ALIGN=left NOWRAP>Blocking Communication (XMPP IM)</TD><TD ALIGN=left NOWRAP>supported DB (*)</TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modprivate"><TT>mod_private</TT></A></TD><TD ALIGN=left NOWRAP>Private XML Storage (<A HREF="http://xmpp.org/extensions/xep-0049.html">XEP-0049</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modprivate"><TT>mod_private</TT></A></TD><TD ALIGN=left NOWRAP>Private XML Storage (<A HREF="http://www.xmpp.org/extensions/xep-0049.html">XEP-0049</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modprivate"><TT>mod_private_odbc</TT></A></TD><TD ALIGN=left NOWRAP>Private XML Storage (<A HREF="http://xmpp.org/extensions/xep-0049.html">XEP-0049</A>)</TD><TD ALIGN=left NOWRAP>supported DB (*)</TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modprivate"><TT>mod_private_odbc</TT></A></TD><TD ALIGN=left NOWRAP>Private XML Storage (<A HREF="http://www.xmpp.org/extensions/xep-0049.html">XEP-0049</A>)</TD><TD ALIGN=left NOWRAP>supported DB (*)</TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modproxy"><TT>mod_proxy65</TT></A></TD><TD ALIGN=left NOWRAP>SOCKS5 Bytestreams (<A HREF="http://xmpp.org/extensions/xep-0065.html">XEP-0065</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modproxy"><TT>mod_proxy65</TT></A></TD><TD ALIGN=left NOWRAP>SOCKS5 Bytestreams (<A HREF="http://www.xmpp.org/extensions/xep-0065.html">XEP-0065</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modpubsub"><TT>mod_pubsub</TT></A></TD><TD ALIGN=left NOWRAP>Pub-Sub (<A HREF="http://xmpp.org/extensions/xep-0060.html">XEP-0060</A>), PEP (<A HREF="http://xmpp.org/extensions/xep-0163.html">XEP-0163</A>)</TD><TD ALIGN=left NOWRAP><TT>mod_caps</TT></TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modpubsub"><TT>mod_pubsub</TT></A></TD><TD ALIGN=left NOWRAP>Pub-Sub (<A HREF="http://www.xmpp.org/extensions/xep-0060.html">XEP-0060</A>), PEP (<A HREF="http://www.xmpp.org/extensions/xep-0163.html">XEP-0163</A>)</TD><TD ALIGN=left NOWRAP><TT>mod_caps</TT></TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modregister"><TT>mod_register</TT></A></TD><TD ALIGN=left NOWRAP>In-Band Registration (<A HREF="http://xmpp.org/extensions/xep-0077.html">XEP-0077</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modregister"><TT>mod_register</TT></A></TD><TD ALIGN=left NOWRAP>In-Band Registration (<A HREF="http://www.xmpp.org/extensions/xep-0077.html">XEP-0077</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modroster"><TT>mod_roster</TT></A></TD><TD ALIGN=left NOWRAP>Roster management (XMPP IM)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modroster"><TT>mod_roster</TT></A></TD><TD ALIGN=left NOWRAP>Roster management (XMPP IM)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modroster"><TT>mod_roster_odbc</TT></A></TD><TD ALIGN=left NOWRAP>Roster management (XMPP IM)</TD><TD ALIGN=left NOWRAP>supported DB (*)</TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modroster"><TT>mod_roster_odbc</TT></A></TD><TD ALIGN=left NOWRAP>Roster management (XMPP IM)</TD><TD ALIGN=left NOWRAP>supported DB (*)</TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modservicelog"><TT>mod_service_log</TT></A></TD><TD ALIGN=left NOWRAP>Copy user messages to logger service</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modservicelog"><TT>mod_service_log</TT></A></TD><TD ALIGN=left NOWRAP>Copy user messages to logger service</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modsharedroster"><TT>mod_shared_roster</TT></A></TD><TD ALIGN=left NOWRAP>Shared roster management</TD><TD ALIGN=left NOWRAP><TT>mod_roster</TT> or</TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modsharedroster"><TT>mod_shared_roster</TT></A></TD><TD ALIGN=left NOWRAP>Shared roster management</TD><TD ALIGN=left NOWRAP><TT>mod_roster</TT> or</TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP> </TD><TD ALIGN=left NOWRAP> </TD><TD ALIGN=left NOWRAP><TT>mod_roster_odbc</TT></TD></TR>
|
<TR><TD ALIGN=left NOWRAP> </TD><TD ALIGN=left NOWRAP> </TD><TD ALIGN=left NOWRAP><TT>mod_roster_odbc</TT></TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modstats"><TT>mod_stats</TT></A></TD><TD ALIGN=left NOWRAP>Statistics Gathering (<A HREF="http://xmpp.org/extensions/xep-0039.html">XEP-0039</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modstats"><TT>mod_stats</TT></A></TD><TD ALIGN=left NOWRAP>Statistics Gathering (<A HREF="http://www.xmpp.org/extensions/xep-0039.html">XEP-0039</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modtime"><TT>mod_time</TT></A></TD><TD ALIGN=left NOWRAP>Entity Time (<A HREF="http://xmpp.org/extensions/xep-0202.html">XEP-0202</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modtime"><TT>mod_time</TT></A></TD><TD ALIGN=left NOWRAP>Entity Time (<A HREF="http://www.xmpp.org/extensions/xep-0202.html">XEP-0202</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modvcard"><TT>mod_vcard</TT></A></TD><TD ALIGN=left NOWRAP>vcard-temp (<A HREF="http://xmpp.org/extensions/xep-0054.html">XEP-0054</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modvcard"><TT>mod_vcard</TT></A></TD><TD ALIGN=left NOWRAP>vcard-temp (<A HREF="http://www.xmpp.org/extensions/xep-0054.html">XEP-0054</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modvcardldap"><TT>mod_vcard_ldap</TT></A></TD><TD ALIGN=left NOWRAP>vcard-temp (<A HREF="http://xmpp.org/extensions/xep-0054.html">XEP-0054</A>)</TD><TD ALIGN=left NOWRAP>LDAP server</TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modvcardldap"><TT>mod_vcard_ldap</TT></A></TD><TD ALIGN=left NOWRAP>vcard-temp (<A HREF="http://www.xmpp.org/extensions/xep-0054.html">XEP-0054</A>)</TD><TD ALIGN=left NOWRAP>LDAP server</TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modvcard"><TT>mod_vcard_odbc</TT></A></TD><TD ALIGN=left NOWRAP>vcard-temp (<A HREF="http://xmpp.org/extensions/xep-0054.html">XEP-0054</A>)</TD><TD ALIGN=left NOWRAP>supported DB (*)</TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modvcard"><TT>mod_vcard_odbc</TT></A></TD><TD ALIGN=left NOWRAP>vcard-temp (<A HREF="http://www.xmpp.org/extensions/xep-0054.html">XEP-0054</A>)</TD><TD ALIGN=left NOWRAP>supported DB (*)</TD></TR>
|
||||||
<TR><TD ALIGN=left NOWRAP><A HREF="#modversion"><TT>mod_version</TT></A></TD><TD ALIGN=left NOWRAP>Software Version (<A HREF="http://xmpp.org/extensions/xep-0092.html">XEP-0092</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
<TR><TD ALIGN=left NOWRAP><A HREF="#modversion"><TT>mod_version</TT></A></TD><TD ALIGN=left NOWRAP>Software Version (<A HREF="http://www.xmpp.org/extensions/xep-0092.html">XEP-0092</A>)</TD><TD ALIGN=left NOWRAP> </TD></TR>
|
||||||
</TABLE>
|
</TABLE>
|
||||||
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE><UL CLASS="itemize"><LI CLASS="li-itemize">
|
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE><UL CLASS="itemize"><LI CLASS="li-itemize">
|
||||||
(*) This module requires a supported database. For a list of supported databases, see section <A HREF="#database">3.2</A>.
|
(*) This module requires a supported database. For a list of supported databases, see section <A HREF="#database">3.2</A>.
|
||||||
@ -1902,7 +1913,7 @@ message is sent to all registered users. If the user is online and connected
|
|||||||
to several resources, only the resource with the highest priority will receive
|
to several resources, only the resource with the highest priority will receive
|
||||||
the message. If the registered user is not connected, the message will be
|
the message. If the registered user is not connected, the message will be
|
||||||
stored offline in assumption that offline storage
|
stored offline in assumption that offline storage
|
||||||
(see section <A HREF="#modoffline">3.3.11</A>) is enabled.
|
(see section <A HREF="#modoffline">3.3.12</A>) is enabled.
|
||||||
</DD><DT CLASS="dt-description"><B><TT>example.org/announce/online (example.org/announce/all-hosts/online)</TT></B></DT><DD CLASS="dd-description">The
|
</DD><DT CLASS="dt-description"><B><TT>example.org/announce/online (example.org/announce/all-hosts/online)</TT></B></DT><DD CLASS="dd-description">The
|
||||||
message is sent to all connected users. If the user is online and connected
|
message is sent to all connected users. If the user is online and connected
|
||||||
to several resources, all resources will receive the message.
|
to several resources, all resources will receive the message.
|
||||||
@ -1955,11 +1966,11 @@ disabled for instances of <TT>ejabberd</TT> with hundreds of thousands users.</P
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
</P><P>This module adds support for Service Discovery (<A HREF="http://xmpp.org/extensions/xep-0030.html">XEP-0030</A>). With
|
</P><P>This module adds support for Service Discovery (<A HREF="http://www.xmpp.org/extensions/xep-0030.html">XEP-0030</A>). With
|
||||||
this module enabled, services on your server can be discovered by
|
this module enabled, services on your server can be discovered by
|
||||||
Jabber clients. Note that <TT>ejabberd</TT> has no modules with support
|
Jabber clients. Note that <TT>ejabberd</TT> has no modules with support
|
||||||
for the superseded Jabber Browsing (<A HREF="http://xmpp.org/extensions/xep-0011.html">XEP-0011</A>) and Agent Information
|
for the superseded Jabber Browsing (<A HREF="http://www.xmpp.org/extensions/xep-0011.html">XEP-0011</A>) and Agent Information
|
||||||
(<A HREF="http://xmpp.org/extensions/xep-0094.html">XEP-0094</A>). Accordingly, Jabber clients need to have support for
|
(<A HREF="http://www.xmpp.org/extensions/xep-0094.html">XEP-0094</A>). Accordingly, Jabber clients need to have support for
|
||||||
the newer Service Discovery protocol if you want them be able to discover
|
the newer Service Discovery protocol if you want them be able to discover
|
||||||
the services you offer.</P><P>Options:
|
the services you offer.</P><P>Options:
|
||||||
</P><DL CLASS="description"><DT CLASS="dt-description">
|
</P><DL CLASS="description"><DT CLASS="dt-description">
|
||||||
@ -1970,7 +1981,7 @@ the processing discipline for Service Discovery (<TT>http://jabber.org/protocol/
|
|||||||
you can specify a list of extra domains that are added to the Service Discovery item list.
|
you can specify a list of extra domains that are added to the Service Discovery item list.
|
||||||
</DD><DT CLASS="dt-description"><B><TT>{server_info, [ {Modules, Field, [Value]} ]}</TT></B></DT><DD CLASS="dd-description">
|
</DD><DT CLASS="dt-description"><B><TT>{server_info, [ {Modules, Field, [Value]} ]}</TT></B></DT><DD CLASS="dd-description">
|
||||||
Specify additional information about the server,
|
Specify additional information about the server,
|
||||||
as described in Contact Addresses for XMPP Services (<A HREF="http://xmpp.org/extensions/xep-0157.html">XEP-0157</A>).
|
as described in Contact Addresses for XMPP Services (<A HREF="http://www.xmpp.org/extensions/xep-0157.html">XEP-0157</A>).
|
||||||
<TT>Modules</TT> can be the keyword ‘all’,
|
<TT>Modules</TT> can be the keyword ‘all’,
|
||||||
in which case the information is reported in all the services;
|
in which case the information is reported in all the services;
|
||||||
or a list of <TT>ejabberd</TT> modules,
|
or a list of <TT>ejabberd</TT> modules,
|
||||||
@ -2046,7 +2057,7 @@ of them all?
|
|||||||
</PRE><P> <A NAME="modhttpbind"></A> </P><!--TOC subsection <TT>mod_http_bind</TT>-->
|
</PRE><P> <A NAME="modhttpbind"></A> </P><!--TOC subsection <TT>mod_http_bind</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc43">3.3.6</A>  <A HREF="#modhttpbind"><TT>mod_http_bind</TT></A></H3><!--SEC END --><P> <A NAME="modhttpbind"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc43">3.3.6</A>  <A HREF="#modhttpbind"><TT>mod_http_bind</TT></A></H3><!--SEC END --><P> <A NAME="modhttpbind"></A>
|
||||||
</P><P>This module implements XMPP over Bosh (formerly known as HTTP Binding)
|
</P><P>This module implements XMPP over Bosh (formerly known as HTTP Binding)
|
||||||
as defined in <A HREF="http://xmpp.org/extensions/xep-0124.html">XEP-0124</A> and <A HREF="http://xmpp.org/extensions/xep-0206.html">XEP-0206</A>.
|
as defined in <A HREF="http://www.xmpp.org/extensions/xep-0124.html">XEP-0124</A> and <A HREF="http://www.xmpp.org/extensions/xep-0206.html">XEP-0206</A>.
|
||||||
It extends ejabberd’s built in HTTP service with a configurable
|
It extends ejabberd’s built in HTTP service with a configurable
|
||||||
resource at which this service will be hosted.</P><P>To use HTTP-Binding, enable the module:
|
resource at which this service will be hosted.</P><P>To use HTTP-Binding, enable the module:
|
||||||
</P><PRE CLASS="verbatim">{modules,
|
</P><PRE CLASS="verbatim">{modules,
|
||||||
@ -2154,9 +2165,69 @@ To use this module you must enable it:
|
|||||||
},
|
},
|
||||||
...
|
...
|
||||||
]}.
|
]}.
|
||||||
</PRE><P> <A NAME="modlast"></A> </P><!--TOC subsection <TT>mod_last</TT>-->
|
</PRE><P> <A NAME="modirc"></A> </P><!--TOC subsection <TT>mod_irc</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc45">3.3.8</A>  <A HREF="#modlast"><TT>mod_last</TT></A></H3><!--SEC END --><P> <A NAME="modlast"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc45">3.3.8</A>  <A HREF="#modirc"><TT>mod_irc</TT></A></H3><!--SEC END --><P> <A NAME="modirc"></A>
|
||||||
</P><P>This module adds support for Last Activity (<A HREF="http://xmpp.org/extensions/xep-0012.html">XEP-0012</A>). It can be used to
|
</P><P>This module is an IRC transport that can be used to join channels on IRC
|
||||||
|
servers.</P><P>End user information:
|
||||||
|
|
||||||
|
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
||||||
|
A Jabber client with ‘groupchat 1.0’ support or Multi-User
|
||||||
|
Chat support (<A HREF="http://www.xmpp.org/extensions/xep-0045.html">XEP-0045</A>) is necessary to join IRC channels.
|
||||||
|
</LI><LI CLASS="li-itemize">An IRC channel can be joined in nearly the same way as joining a
|
||||||
|
Jabber Multi-User Chat room. The difference is that the room name will
|
||||||
|
be ‘channel%<TT>irc.example.org</TT>’ in case <TT>irc.example.org</TT> is
|
||||||
|
the IRC server hosting ‘channel’. And of course the host should point
|
||||||
|
to the IRC transport instead of the Multi-User Chat service.
|
||||||
|
</LI><LI CLASS="li-itemize">You can register your nickame by sending ‘IDENTIFY password’ to<BR>
|
||||||
|
<TT>nickserver!irc.example.org@irc.jabberserver.org</TT>.
|
||||||
|
</LI><LI CLASS="li-itemize">Entering your password is possible by sending ‘LOGIN nick password’<BR>
|
||||||
|
to <TT>nickserver!irc.example.org@irc.jabberserver.org</TT>.
|
||||||
|
</LI><LI CLASS="li-itemize">The IRC transport provides Ad-Hoc Commands (<A HREF="http://www.xmpp.org/extensions/xep-0050.html">XEP-0050</A>)
|
||||||
|
to join a channel, and to set custom IRC username and encoding.
|
||||||
|
</LI><LI CLASS="li-itemize">When using a popular Jabber server, it can occur that no
|
||||||
|
connection can be achieved with some IRC servers because they limit the
|
||||||
|
number of conections from one IP.
|
||||||
|
</LI></UL><P>Options:
|
||||||
|
</P><DL CLASS="description"><DT CLASS="dt-description">
|
||||||
|
|
||||||
|
<B><TT>host</TT></B></DT><DD CLASS="dd-description"> This option defines the Jabber ID of the
|
||||||
|
service. If the <TT>host</TT> option is not specified, the Jabber ID will be the
|
||||||
|
hostname of the virtual host with the prefix ‘<TT>irc.</TT>’. The keyword "@HOST@"
|
||||||
|
is replaced at start time with the real virtual host name.
|
||||||
|
|
||||||
|
</DD><DT CLASS="dt-description"><B><TT>access</TT></B></DT><DD CLASS="dd-description"> This option can be used to specify who
|
||||||
|
may use the IRC transport (default value: <TT>all</TT>).
|
||||||
|
</DD><DT CLASS="dt-description"><B><TT>default_encoding</TT></B></DT><DD CLASS="dd-description"> Set the default IRC encoding (default value: <TT>"koi8-r"</TT>).
|
||||||
|
</DD></DL><P>Examples:
|
||||||
|
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
||||||
|
In the first example, the IRC transport is available on (all) your
|
||||||
|
virtual host(s) with the prefix ‘<TT>irc.</TT>’. Furthermore, anyone is
|
||||||
|
able to use the transport. The default encoding is set to "iso8859-15".
|
||||||
|
<PRE CLASS="verbatim">{modules,
|
||||||
|
[
|
||||||
|
...
|
||||||
|
{mod_irc, [{access, all}, {default_encoding, "iso8859-15"}]},
|
||||||
|
...
|
||||||
|
]}.
|
||||||
|
</PRE></LI><LI CLASS="li-itemize">In next example the IRC transport is available with JIDs with prefix <TT>irc-t.net</TT>.
|
||||||
|
Moreover, the transport is only accessible to two users
|
||||||
|
of <TT>example.org</TT>, and any user of <TT>example.com</TT>:
|
||||||
|
<PRE CLASS="verbatim">{acl, paying_customers, {user, "customer1", "example.org"}}.
|
||||||
|
{acl, paying_customers, {user, "customer2", "example.org"}}.
|
||||||
|
{acl, paying_customers, {server, "example.com"}}.
|
||||||
|
|
||||||
|
{access, irc_users, [{allow, paying_customers}, {deny, all}]}.
|
||||||
|
|
||||||
|
{modules,
|
||||||
|
[
|
||||||
|
...
|
||||||
|
{mod_irc, [{access, irc_users},
|
||||||
|
{host, "irc.example.net"}]},
|
||||||
|
...
|
||||||
|
]}.
|
||||||
|
</PRE></LI></UL><P> <A NAME="modlast"></A> </P><!--TOC subsection <TT>mod_last</TT>-->
|
||||||
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc46">3.3.9</A>  <A HREF="#modlast"><TT>mod_last</TT></A></H3><!--SEC END --><P> <A NAME="modlast"></A>
|
||||||
|
</P><P>This module adds support for Last Activity (<A HREF="http://www.xmpp.org/extensions/xep-0012.html">XEP-0012</A>). It can be used to
|
||||||
discover when a disconnected user last accessed the server, to know when a
|
discover when a disconnected user last accessed the server, to know when a
|
||||||
connected user was last active on the server, or to query the uptime of the
|
connected user was last active on the server, or to query the uptime of the
|
||||||
<TT>ejabberd</TT> server.</P><P>Options:
|
<TT>ejabberd</TT> server.</P><P>Options:
|
||||||
@ -2164,8 +2235,8 @@ connected user was last active on the server, or to query the uptime of the
|
|||||||
<B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
|
<B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
|
||||||
the processing discipline for Last activity (<TT>jabber:iq:last</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
|
the processing discipline for Last activity (<TT>jabber:iq:last</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
|
||||||
</DD></DL><P> <A NAME="modmuc"></A> </P><!--TOC subsection <TT>mod_muc</TT>-->
|
</DD></DL><P> <A NAME="modmuc"></A> </P><!--TOC subsection <TT>mod_muc</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc46">3.3.9</A>  <A HREF="#modmuc"><TT>mod_muc</TT></A></H3><!--SEC END --><P> <A NAME="modmuc"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc47">3.3.10</A>  <A HREF="#modmuc"><TT>mod_muc</TT></A></H3><!--SEC END --><P> <A NAME="modmuc"></A>
|
||||||
</P><P>This module provides a Multi-User Chat (<A HREF="http://xmpp.org/extensions/xep-0045.html">XEP-0045</A>) service.
|
</P><P>This module provides a Multi-User Chat (<A HREF="http://www.xmpp.org/extensions/xep-0045.html">XEP-0045</A>) service.
|
||||||
Users can discover existing rooms, join or create them.
|
Users can discover existing rooms, join or create them.
|
||||||
Occupants of a room can chat in public or have private chats.</P><P>Some of the features of Multi-User Chat:
|
Occupants of a room can chat in public or have private chats.</P><P>Some of the features of Multi-User Chat:
|
||||||
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
||||||
@ -2387,7 +2458,7 @@ the newly created rooms have by default those options.
|
|||||||
...
|
...
|
||||||
]}.
|
]}.
|
||||||
</PRE></LI></UL><P> <A NAME="modmuclog"></A> </P><!--TOC subsection <TT>mod_muc_log</TT>-->
|
</PRE></LI></UL><P> <A NAME="modmuclog"></A> </P><!--TOC subsection <TT>mod_muc_log</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc47">3.3.10</A>  <A HREF="#modmuclog"><TT>mod_muc_log</TT></A></H3><!--SEC END --><P> <A NAME="modmuclog"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc48">3.3.11</A>  <A HREF="#modmuclog"><TT>mod_muc_log</TT></A></H3><!--SEC END --><P> <A NAME="modmuclog"></A>
|
||||||
</P><P>This module enables optional logging of Multi-User Chat (MUC) public conversations to
|
</P><P>This module enables optional logging of Multi-User Chat (MUC) public conversations to
|
||||||
HTML. Once you enable this module, users can join a room using a MUC capable
|
HTML. Once you enable this module, users can join a room using a MUC capable
|
||||||
Jabber client, and if they have enough privileges, they can request the
|
Jabber client, and if they have enough privileges, they can request the
|
||||||
@ -2397,7 +2468,7 @@ Room details are added on top of each page: room title, JID,
|
|||||||
author, subject and configuration.
|
author, subject and configuration.
|
||||||
</LI><LI CLASS="li-itemize">
|
</LI><LI CLASS="li-itemize">
|
||||||
The room JID in the generated HTML is a link to join the room (using
|
The room JID in the generated HTML is a link to join the room (using
|
||||||
<A HREF="http://xmpp.org/rfcs/rfc5122.html">XMPP URI</A>).
|
<A HREF="http://www.xmpp.org/rfcs/rfc5122.html">XMPP URI</A>).
|
||||||
</LI><LI CLASS="li-itemize">Subject and room configuration changes are tracked and displayed.
|
</LI><LI CLASS="li-itemize">Subject and room configuration changes are tracked and displayed.
|
||||||
</LI><LI CLASS="li-itemize">Joins, leaves, nick changes, kicks, bans and ‘/me’ are tracked and
|
</LI><LI CLASS="li-itemize">Joins, leaves, nick changes, kicks, bans and ‘/me’ are tracked and
|
||||||
displayed, including the reason if available.
|
displayed, including the reason if available.
|
||||||
@ -2507,8 +2578,8 @@ top link will be the default <CODE><a href="/">Home</a></CODE>.
|
|||||||
...
|
...
|
||||||
]}.
|
]}.
|
||||||
</PRE></LI></UL><P> <A NAME="modoffline"></A> </P><!--TOC subsection <TT>mod_offline</TT>-->
|
</PRE></LI></UL><P> <A NAME="modoffline"></A> </P><!--TOC subsection <TT>mod_offline</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc48">3.3.11</A>  <A HREF="#modoffline"><TT>mod_offline</TT></A></H3><!--SEC END --><P> <A NAME="modoffline"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc49">3.3.12</A>  <A HREF="#modoffline"><TT>mod_offline</TT></A></H3><!--SEC END --><P> <A NAME="modoffline"></A>
|
||||||
</P><P>This module implements offline message storage (<A HREF="http://xmpp.org/extensions/xep-0160.html">XEP-0160</A>).
|
</P><P>This module implements offline message storage (<A HREF="http://www.xmpp.org/extensions/xep-0160.html">XEP-0160</A>).
|
||||||
This means that all messages
|
This means that all messages
|
||||||
sent to an offline user will be stored on the server until that user comes
|
sent to an offline user will be stored on the server until that user comes
|
||||||
online again. Thus it is very similar to how email works. Note that
|
online again. Thus it is very similar to how email works. Note that
|
||||||
@ -2539,8 +2610,8 @@ and all the other users up to 100.
|
|||||||
...
|
...
|
||||||
]}.
|
]}.
|
||||||
</PRE><P> <A NAME="modping"></A> </P><!--TOC subsection <TT>mod_ping</TT>-->
|
</PRE><P> <A NAME="modping"></A> </P><!--TOC subsection <TT>mod_ping</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc49">3.3.12</A>  <A HREF="#modping"><TT>mod_ping</TT></A></H3><!--SEC END --><P> <A NAME="modping"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc50">3.3.13</A>  <A HREF="#modping"><TT>mod_ping</TT></A></H3><!--SEC END --><P> <A NAME="modping"></A>
|
||||||
</P><P>This module implements support for XMPP Ping (<A HREF="http://xmpp.org/extensions/xep-0199.html">XEP-0199</A>) and periodic keepalives.
|
</P><P>This module implements support for XMPP Ping (<A HREF="http://www.xmpp.org/extensions/xep-0199.html">XEP-0199</A>) and periodic keepalives.
|
||||||
When this module is enabled ejabberd responds correctly to
|
When this module is enabled ejabberd responds correctly to
|
||||||
ping requests, as defined in the protocol.</P><P>Configuration options:
|
ping requests, as defined in the protocol.</P><P>Configuration options:
|
||||||
</P><DL CLASS="description"><DT CLASS="dt-description">
|
</P><DL CLASS="description"><DT CLASS="dt-description">
|
||||||
@ -2567,7 +2638,7 @@ and if a client does not answer to the ping in less than 32 seconds, its connect
|
|||||||
...
|
...
|
||||||
]}.
|
]}.
|
||||||
</PRE><P> <A NAME="modprivacy"></A> </P><!--TOC subsection <TT>mod_privacy</TT>-->
|
</PRE><P> <A NAME="modprivacy"></A> </P><!--TOC subsection <TT>mod_privacy</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc50">3.3.13</A>  <A HREF="#modprivacy"><TT>mod_privacy</TT></A></H3><!--SEC END --><P> <A NAME="modprivacy"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc51">3.3.14</A>  <A HREF="#modprivacy"><TT>mod_privacy</TT></A></H3><!--SEC END --><P> <A NAME="modprivacy"></A>
|
||||||
</P><P>This module implements Blocking Communication (also known as Privacy Rules)
|
</P><P>This module implements Blocking Communication (also known as Privacy Rules)
|
||||||
as defined in section 10 from XMPP IM. If end users have support for it in
|
as defined in section 10 from XMPP IM. If end users have support for it in
|
||||||
their Jabber client, they will be able to:
|
their Jabber client, they will be able to:
|
||||||
@ -2589,26 +2660,26 @@ or subscription type (or globally).
|
|||||||
</LI><LI CLASS="li-itemize">Allowing or blocking all communications based on JID, group, or
|
</LI><LI CLASS="li-itemize">Allowing or blocking all communications based on JID, group, or
|
||||||
subscription type (or globally).
|
subscription type (or globally).
|
||||||
</LI></UL>
|
</LI></UL>
|
||||||
(from <A HREF="http://xmpp.org/specs/rfc3921.html#privacy"><TT>http://xmpp.org/specs/rfc3921.html#privacy</TT></A>)
|
(from <A HREF="http://www.xmpp.org/specs/rfc3921.html#privacy"><TT>http://www.xmpp.org/specs/rfc3921.html#privacy</TT></A>)
|
||||||
</BLOCKQUOTE><P>Options:
|
</BLOCKQUOTE><P>Options:
|
||||||
</P><DL CLASS="description"><DT CLASS="dt-description">
|
</P><DL CLASS="description"><DT CLASS="dt-description">
|
||||||
<B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
|
<B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
|
||||||
the processing discipline for Blocking Communication (<TT>jabber:iq:privacy</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
|
the processing discipline for Blocking Communication (<TT>jabber:iq:privacy</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
|
||||||
</DD></DL><P> <A NAME="modprivate"></A> </P><!--TOC subsection <TT>mod_private</TT>-->
|
</DD></DL><P> <A NAME="modprivate"></A> </P><!--TOC subsection <TT>mod_private</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc51">3.3.14</A>  <A HREF="#modprivate"><TT>mod_private</TT></A></H3><!--SEC END --><P> <A NAME="modprivate"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc52">3.3.15</A>  <A HREF="#modprivate"><TT>mod_private</TT></A></H3><!--SEC END --><P> <A NAME="modprivate"></A>
|
||||||
</P><P>This module adds support for Private XML Storage (<A HREF="http://xmpp.org/extensions/xep-0049.html">XEP-0049</A>):
|
</P><P>This module adds support for Private XML Storage (<A HREF="http://www.xmpp.org/extensions/xep-0049.html">XEP-0049</A>):
|
||||||
</P><BLOCKQUOTE CLASS="quote">
|
</P><BLOCKQUOTE CLASS="quote">
|
||||||
Using this method, Jabber entities can store private data on the server and
|
Using this method, Jabber entities can store private data on the server and
|
||||||
retrieve it whenever necessary. The data stored might be anything, as long as
|
retrieve it whenever necessary. The data stored might be anything, as long as
|
||||||
it is valid XML. One typical usage for this namespace is the server-side storage
|
it is valid XML. One typical usage for this namespace is the server-side storage
|
||||||
of client-specific preferences; another is Bookmark Storage (<A HREF="http://xmpp.org/extensions/xep-0048.html">XEP-0048</A>).
|
of client-specific preferences; another is Bookmark Storage (<A HREF="http://www.xmpp.org/extensions/xep-0048.html">XEP-0048</A>).
|
||||||
</BLOCKQUOTE><P>Options:
|
</BLOCKQUOTE><P>Options:
|
||||||
</P><DL CLASS="description"><DT CLASS="dt-description">
|
</P><DL CLASS="description"><DT CLASS="dt-description">
|
||||||
<B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
|
<B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
|
||||||
the processing discipline for Private XML Storage (<TT>jabber:iq:private</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
|
the processing discipline for Private XML Storage (<TT>jabber:iq:private</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
|
||||||
</DD></DL><P> <A NAME="modproxy"></A> </P><!--TOC subsection <TT>mod_proxy65</TT>-->
|
</DD></DL><P> <A NAME="modproxy"></A> </P><!--TOC subsection <TT>mod_proxy65</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc52">3.3.15</A>  <A HREF="#modproxy"><TT>mod_proxy65</TT></A></H3><!--SEC END --><P> <A NAME="modproxy"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc53">3.3.16</A>  <A HREF="#modproxy"><TT>mod_proxy65</TT></A></H3><!--SEC END --><P> <A NAME="modproxy"></A>
|
||||||
</P><P>This module implements SOCKS5 Bytestreams (<A HREF="http://xmpp.org/extensions/xep-0065.html">XEP-0065</A>).
|
</P><P>This module implements SOCKS5 Bytestreams (<A HREF="http://www.xmpp.org/extensions/xep-0065.html">XEP-0065</A>).
|
||||||
It allows <TT>ejabberd</TT> to act as a file transfer proxy between two
|
It allows <TT>ejabberd</TT> to act as a file transfer proxy between two
|
||||||
XMPP clients.</P><P>Options:
|
XMPP clients.</P><P>Options:
|
||||||
</P><DL CLASS="description"><DT CLASS="dt-description">
|
</P><DL CLASS="description"><DT CLASS="dt-description">
|
||||||
@ -2662,10 +2733,10 @@ The simpliest configuration of the module:
|
|||||||
...
|
...
|
||||||
]}.
|
]}.
|
||||||
</PRE></LI></UL><P> <A NAME="modpubsub"></A> </P><!--TOC subsection <TT>mod_pubsub</TT>-->
|
</PRE></LI></UL><P> <A NAME="modpubsub"></A> </P><!--TOC subsection <TT>mod_pubsub</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc53">3.3.16</A>  <A HREF="#modpubsub"><TT>mod_pubsub</TT></A></H3><!--SEC END --><P> <A NAME="modpubsub"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc54">3.3.17</A>  <A HREF="#modpubsub"><TT>mod_pubsub</TT></A></H3><!--SEC END --><P> <A NAME="modpubsub"></A>
|
||||||
</P><P>This module offers a Publish-Subscribe Service (<A HREF="http://xmpp.org/extensions/xep-0060.html">XEP-0060</A>).
|
</P><P>This module offers a Publish-Subscribe Service (<A HREF="http://www.xmpp.org/extensions/xep-0060.html">XEP-0060</A>).
|
||||||
The functionality in <TT>mod_pubsub</TT> can be extended using plugins.
|
The functionality in <TT>mod_pubsub</TT> can be extended using plugins.
|
||||||
The plugin that implements PEP (Personal Eventing via Pubsub) (<A HREF="http://xmpp.org/extensions/xep-0163.html">XEP-0163</A>)
|
The plugin that implements PEP (Personal Eventing via Pubsub) (<A HREF="http://www.xmpp.org/extensions/xep-0163.html">XEP-0163</A>)
|
||||||
is enabled in the default ejabberd configuration file,
|
is enabled in the default ejabberd configuration file,
|
||||||
and it requires <TT>mod_caps</TT>.</P><P>Options:
|
and it requires <TT>mod_caps</TT>.</P><P>Options:
|
||||||
</P><DL CLASS="description"><DT CLASS="dt-description">
|
</P><DL CLASS="description"><DT CLASS="dt-description">
|
||||||
@ -2708,8 +2779,8 @@ The following example will use node_tune instead of node_pep for every PEP node
|
|||||||
...
|
...
|
||||||
]}.
|
]}.
|
||||||
</PRE><P> <A NAME="modregister"></A> </P><!--TOC subsection <TT>mod_register</TT>-->
|
</PRE><P> <A NAME="modregister"></A> </P><!--TOC subsection <TT>mod_register</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc54">3.3.17</A>  <A HREF="#modregister"><TT>mod_register</TT></A></H3><!--SEC END --><P> <A NAME="modregister"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc55">3.3.18</A>  <A HREF="#modregister"><TT>mod_register</TT></A></H3><!--SEC END --><P> <A NAME="modregister"></A>
|
||||||
</P><P>This module adds support for In-Band Registration (<A HREF="http://xmpp.org/extensions/xep-0077.html">XEP-0077</A>). This protocol
|
</P><P>This module adds support for In-Band Registration (<A HREF="http://www.xmpp.org/extensions/xep-0077.html">XEP-0077</A>). This protocol
|
||||||
enables end users to use a Jabber client to:
|
enables end users to use a Jabber client to:
|
||||||
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
||||||
Register a new account on the server.
|
Register a new account on the server.
|
||||||
@ -2781,10 +2852,10 @@ Also define a registration timeout of one hour:
|
|||||||
...
|
...
|
||||||
]}.
|
]}.
|
||||||
</PRE></LI></UL><P> <A NAME="modroster"></A> </P><!--TOC subsection <TT>mod_roster</TT>-->
|
</PRE></LI></UL><P> <A NAME="modroster"></A> </P><!--TOC subsection <TT>mod_roster</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc55">3.3.18</A>  <A HREF="#modroster"><TT>mod_roster</TT></A></H3><!--SEC END --><P> <A NAME="modroster"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc56">3.3.19</A>  <A HREF="#modroster"><TT>mod_roster</TT></A></H3><!--SEC END --><P> <A NAME="modroster"></A>
|
||||||
</P><P>This module implements roster management as defined in
|
</P><P>This module implements roster management as defined in
|
||||||
<A HREF="http://xmpp.org/specs/rfc3921.html#roster">RFC 3921: XMPP IM</A>.
|
<A HREF="http://www.xmpp.org/specs/rfc3921.html#roster">RFC 3921: XMPP IM</A>.
|
||||||
It also supports Roster Versioning (<A HREF="http://xmpp.org/extensions/xep-0237.html">XEP-0237</A>).</P><P>Options:
|
It also supports Roster Versioning (<A HREF="http://www.xmpp.org/extensions/xep-0237.html">XEP-0237</A>).</P><P>Options:
|
||||||
</P><DL CLASS="description"><DT CLASS="dt-description">
|
</P><DL CLASS="description"><DT CLASS="dt-description">
|
||||||
<B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
|
<B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
|
||||||
the processing discipline for Roster Management (<TT>jabber:iq:roster</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
|
the processing discipline for Roster Management (<TT>jabber:iq:roster</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
|
||||||
@ -2807,7 +2878,7 @@ Important: if you use <TT>mod_shared_roster</TT>, you must disable this option.
|
|||||||
...
|
...
|
||||||
]}.
|
]}.
|
||||||
</PRE><P> <A NAME="modservicelog"></A> </P><!--TOC subsection <TT>mod_service_log</TT>-->
|
</PRE><P> <A NAME="modservicelog"></A> </P><!--TOC subsection <TT>mod_service_log</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc56">3.3.19</A>  <A HREF="#modservicelog"><TT>mod_service_log</TT></A></H3><!--SEC END --><P> <A NAME="modservicelog"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc57">3.3.20</A>  <A HREF="#modservicelog"><TT>mod_service_log</TT></A></H3><!--SEC END --><P> <A NAME="modservicelog"></A>
|
||||||
</P><P>This module adds support for logging end user packets via a Jabber message
|
</P><P>This module adds support for logging end user packets via a Jabber message
|
||||||
auditing service such as
|
auditing service such as
|
||||||
<A HREF="http://www.funkypenguin.info/project/bandersnatch/">Bandersnatch</A>. All user
|
<A HREF="http://www.funkypenguin.info/project/bandersnatch/">Bandersnatch</A>. All user
|
||||||
@ -2837,7 +2908,7 @@ To log all end user packets to the Bandersnatch service running on
|
|||||||
...
|
...
|
||||||
]}.
|
]}.
|
||||||
</PRE></LI></UL><P> <A NAME="modsharedroster"></A> </P><!--TOC subsection <TT>mod_shared_roster</TT>-->
|
</PRE></LI></UL><P> <A NAME="modsharedroster"></A> </P><!--TOC subsection <TT>mod_shared_roster</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc57">3.3.20</A>  <A HREF="#modsharedroster"><TT>mod_shared_roster</TT></A></H3><!--SEC END --><P> <A NAME="modsharedroster"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc58">3.3.21</A>  <A HREF="#modsharedroster"><TT>mod_shared_roster</TT></A></H3><!--SEC END --><P> <A NAME="modsharedroster"></A>
|
||||||
</P><P>This module enables you to create shared roster groups. This means that you can
|
</P><P>This module enables you to create shared roster groups. This means that you can
|
||||||
create groups of people that can see members from (other) groups in their
|
create groups of people that can see members from (other) groups in their
|
||||||
rosters. The big advantages of this feature are that end users do not need to
|
rosters. The big advantages of this feature are that end users do not need to
|
||||||
@ -2912,8 +2983,8 @@ roster groups as shown in the following table:
|
|||||||
</TABLE>
|
</TABLE>
|
||||||
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
|
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
|
||||||
</LI></UL><P> <A NAME="modstats"></A> </P><!--TOC subsection <TT>mod_stats</TT>-->
|
</LI></UL><P> <A NAME="modstats"></A> </P><!--TOC subsection <TT>mod_stats</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc58">3.3.21</A>  <A HREF="#modstats"><TT>mod_stats</TT></A></H3><!--SEC END --><P> <A NAME="modstats"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc59">3.3.22</A>  <A HREF="#modstats"><TT>mod_stats</TT></A></H3><!--SEC END --><P> <A NAME="modstats"></A>
|
||||||
</P><P>This module adds support for Statistics Gathering (<A HREF="http://xmpp.org/extensions/xep-0039.html">XEP-0039</A>). This protocol
|
</P><P>This module adds support for Statistics Gathering (<A HREF="http://www.xmpp.org/extensions/xep-0039.html">XEP-0039</A>). This protocol
|
||||||
allows you to retrieve next statistics from your <TT>ejabberd</TT> deployment:
|
allows you to retrieve next statistics from your <TT>ejabberd</TT> deployment:
|
||||||
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
||||||
Total number of registered users on the current virtual host (users/total).
|
Total number of registered users on the current virtual host (users/total).
|
||||||
@ -2944,16 +3015,16 @@ by sending:
|
|||||||
</query>
|
</query>
|
||||||
</iq>
|
</iq>
|
||||||
</PRE></LI></UL><P> <A NAME="modtime"></A> </P><!--TOC subsection <TT>mod_time</TT>-->
|
</PRE></LI></UL><P> <A NAME="modtime"></A> </P><!--TOC subsection <TT>mod_time</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc59">3.3.22</A>  <A HREF="#modtime"><TT>mod_time</TT></A></H3><!--SEC END --><P> <A NAME="modtime"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc60">3.3.23</A>  <A HREF="#modtime"><TT>mod_time</TT></A></H3><!--SEC END --><P> <A NAME="modtime"></A>
|
||||||
</P><P>This module features support for Entity Time (<A HREF="http://xmpp.org/extensions/xep-0202.html">XEP-0202</A>). By using this XEP,
|
</P><P>This module features support for Entity Time (<A HREF="http://www.xmpp.org/extensions/xep-0202.html">XEP-0202</A>). By using this XEP,
|
||||||
you are able to discover the time at another entity’s location.</P><P>Options:
|
you are able to discover the time at another entity’s location.</P><P>Options:
|
||||||
</P><DL CLASS="description"><DT CLASS="dt-description">
|
</P><DL CLASS="description"><DT CLASS="dt-description">
|
||||||
<B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
|
<B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
|
||||||
the processing discipline for Entity Time (<TT>jabber:iq:time</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
|
the processing discipline for Entity Time (<TT>jabber:iq:time</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
|
||||||
</DD></DL><P> <A NAME="modvcard"></A> </P><!--TOC subsection <TT>mod_vcard</TT>-->
|
</DD></DL><P> <A NAME="modvcard"></A> </P><!--TOC subsection <TT>mod_vcard</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc60">3.3.23</A>  <A HREF="#modvcard"><TT>mod_vcard</TT></A></H3><!--SEC END --><P> <A NAME="modvcard"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc61">3.3.24</A>  <A HREF="#modvcard"><TT>mod_vcard</TT></A></H3><!--SEC END --><P> <A NAME="modvcard"></A>
|
||||||
</P><P>This module allows end users to store and retrieve their vCard, and to retrieve
|
</P><P>This module allows end users to store and retrieve their vCard, and to retrieve
|
||||||
other users vCards, as defined in vcard-temp (<A HREF="http://xmpp.org/extensions/xep-0054.html">XEP-0054</A>). The module also
|
other users vCards, as defined in vcard-temp (<A HREF="http://www.xmpp.org/extensions/xep-0054.html">XEP-0054</A>). The module also
|
||||||
implements an uncomplicated Jabber User Directory based on the vCards of
|
implements an uncomplicated Jabber User Directory based on the vCards of
|
||||||
these users. Moreover, it enables the server to send its vCard when queried.</P><P>Options:
|
these users. Moreover, it enables the server to send its vCard when queried.</P><P>Options:
|
||||||
</P><DL CLASS="description"><DT CLASS="dt-description">
|
</P><DL CLASS="description"><DT CLASS="dt-description">
|
||||||
@ -3006,7 +3077,7 @@ and that all virtual hosts will be searched instead of only the current one:
|
|||||||
...
|
...
|
||||||
]}.
|
]}.
|
||||||
</PRE></LI></UL><P> <A NAME="modvcardldap"></A> </P><!--TOC subsection <TT>mod_vcard_ldap</TT>-->
|
</PRE></LI></UL><P> <A NAME="modvcardldap"></A> </P><!--TOC subsection <TT>mod_vcard_ldap</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc61">3.3.24</A>  <A HREF="#modvcardldap"><TT>mod_vcard_ldap</TT></A></H3><!--SEC END --><P> <A NAME="modvcardldap"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc62">3.3.25</A>  <A HREF="#modvcardldap"><TT>mod_vcard_ldap</TT></A></H3><!--SEC END --><P> <A NAME="modvcardldap"></A>
|
||||||
</P><P><TT>ejabberd</TT> can map LDAP attributes to vCard fields. This behaviour is
|
</P><P><TT>ejabberd</TT> can map LDAP attributes to vCard fields. This behaviour is
|
||||||
implemented in the <TT>mod_vcard_ldap</TT> module. This module does not depend on the
|
implemented in the <TT>mod_vcard_ldap</TT> module. This module does not depend on the
|
||||||
authentication method (see <A HREF="#ldapauth">3.2.5</A>).</P><P>Note that <TT>ejabberd</TT> treats LDAP as a read-only storage:
|
authentication method (see <A HREF="#ldapauth">3.2.5</A>).</P><P>Note that <TT>ejabberd</TT> treats LDAP as a read-only storage:
|
||||||
@ -3040,7 +3111,7 @@ all search results are reported. The default value is <TT>30</TT>.
|
|||||||
set the table that maps LDAP attributes to vCard fields. The format is:
|
set the table that maps LDAP attributes to vCard fields. The format is:
|
||||||
<TT>[</TT><TT>Name_of_vCard_field, Pattern, List_of_LDAP_attributes</TT><TT>, ...]</TT>.
|
<TT>[</TT><TT>Name_of_vCard_field, Pattern, List_of_LDAP_attributes</TT><TT>, ...]</TT>.
|
||||||
<TT>Name_of_vcard_field</TT> is the type name of the vCard as defined in
|
<TT>Name_of_vcard_field</TT> is the type name of the vCard as defined in
|
||||||
<A HREF="http://tools.ietf.org/html/rfc2426">RFC 2426</A>. <TT>Pattern</TT> is a
|
<A HREF="http://www.ietf.org/rfc/rfc2426.txt">RFC 2426</A>. <TT>Pattern</TT> is a
|
||||||
string which contains pattern variables <TT>"%u"</TT>, <TT>"%d"</TT> or
|
string which contains pattern variables <TT>"%u"</TT>, <TT>"%d"</TT> or
|
||||||
<TT>"%s"</TT>. <TT>List_of_LDAP_attributes</TT> is the list containing LDAP
|
<TT>"%s"</TT>. <TT>List_of_LDAP_attributes</TT> is the list containing LDAP
|
||||||
attributes. The pattern variables <TT>"%s"</TT> will be sequentially replaced
|
attributes. The pattern variables <TT>"%s"</TT> will be sequentially replaced
|
||||||
@ -3182,8 +3253,8 @@ searching his info in LDAP.</P></LI><LI CLASS="li-itemize"><TT>ldap_vcard_map</T
|
|||||||
{"Nickname", "NICKNAME"}
|
{"Nickname", "NICKNAME"}
|
||||||
]},
|
]},
|
||||||
</PRE></LI></UL><P> <A NAME="modversion"></A> </P><!--TOC subsection <TT>mod_version</TT>-->
|
</PRE></LI></UL><P> <A NAME="modversion"></A> </P><!--TOC subsection <TT>mod_version</TT>-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc62">3.3.25</A>  <A HREF="#modversion"><TT>mod_version</TT></A></H3><!--SEC END --><P> <A NAME="modversion"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc63">3.3.26</A>  <A HREF="#modversion"><TT>mod_version</TT></A></H3><!--SEC END --><P> <A NAME="modversion"></A>
|
||||||
</P><P>This module implements Software Version (<A HREF="http://xmpp.org/extensions/xep-0092.html">XEP-0092</A>). Consequently, it
|
</P><P>This module implements Software Version (<A HREF="http://www.xmpp.org/extensions/xep-0092.html">XEP-0092</A>). Consequently, it
|
||||||
answers <TT>ejabberd</TT>’s version when queried.</P><P>Options:
|
answers <TT>ejabberd</TT>’s version when queried.</P><P>Options:
|
||||||
</P><DL CLASS="description"><DT CLASS="dt-description">
|
</P><DL CLASS="description"><DT CLASS="dt-description">
|
||||||
<B><TT>show_os</TT></B></DT><DD CLASS="dd-description">Should the operating system be revealed or not.
|
<B><TT>show_os</TT></B></DT><DD CLASS="dd-description">Should the operating system be revealed or not.
|
||||||
@ -3191,8 +3262,8 @@ The default value is <TT>true</TT>.
|
|||||||
</DD><DT CLASS="dt-description"><B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
|
</DD><DT CLASS="dt-description"><B><TT>iqdisc</TT></B></DT><DD CLASS="dd-description"> This specifies
|
||||||
the processing discipline for Software Version (<TT>jabber:iq:version</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
|
the processing discipline for Software Version (<TT>jabber:iq:version</TT>) IQ queries (see section <A HREF="#modiqdiscoption">3.3.2</A>).
|
||||||
</DD></DL><P> <A NAME="manage"></A> </P><!--TOC chapter Managing an <TT>ejabberd</TT> Server-->
|
</DD></DL><P> <A NAME="manage"></A> </P><!--TOC chapter Managing an <TT>ejabberd</TT> Server-->
|
||||||
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc63">Chapter 4</A>  <A HREF="#manage">Managing an <TT>ejabberd</TT> Server</A></H1><!--SEC END --><P> <A NAME="manage"></A> </P><P> <A NAME="ejabberdctl"></A> </P><!--TOC section <TT>ejabberdctl</TT>-->
|
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc64">Chapter 4</A>  <A HREF="#manage">Managing an <TT>ejabberd</TT> Server</A></H1><!--SEC END --><P> <A NAME="manage"></A> </P><P> <A NAME="ejabberdctl"></A> </P><!--TOC section <TT>ejabberdctl</TT>-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc64">4.1</A>  <A HREF="#ejabberdctl"><TT>ejabberdctl</TT></A></H2><!--SEC END --><P> <A NAME="ejabberdctl"></A> </P><P>With the <TT>ejabberdctl</TT> command line administration script
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc65">4.1</A>  <A HREF="#ejabberdctl"><TT>ejabberdctl</TT></A></H2><!--SEC END --><P> <A NAME="ejabberdctl"></A> </P><P>With the <TT>ejabberdctl</TT> command line administration script
|
||||||
you can execute <TT>ejabberdctl commands</TT> (described in the next section, <A HREF="#ectl-commands">4.1.1</A>)
|
you can execute <TT>ejabberdctl commands</TT> (described in the next section, <A HREF="#ectl-commands">4.1.1</A>)
|
||||||
and also many general <TT>ejabberd commands</TT> (described in section <A HREF="#eja-commands">4.2</A>).
|
and also many general <TT>ejabberd commands</TT> (described in section <A HREF="#eja-commands">4.2</A>).
|
||||||
This means you can start, stop and perform many other administrative tasks
|
This means you can start, stop and perform many other administrative tasks
|
||||||
@ -3204,7 +3275,7 @@ and other codes may be used for specific results.
|
|||||||
This can be used by other scripts to determine automatically
|
This can be used by other scripts to determine automatically
|
||||||
if a command succeeded or failed,
|
if a command succeeded or failed,
|
||||||
for example using: <TT>echo $?</TT></P><P> <A NAME="ectl-commands"></A> </P><!--TOC subsection ejabberdctl Commands-->
|
for example using: <TT>echo $?</TT></P><P> <A NAME="ectl-commands"></A> </P><!--TOC subsection ejabberdctl Commands-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc65">4.1.1</A>  <A HREF="#ectl-commands">ejabberdctl Commands</A></H3><!--SEC END --><P> <A NAME="ectl-commands"></A> </P><P>When <TT>ejabberdctl</TT> is executed without any parameter,
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc66">4.1.1</A>  <A HREF="#ectl-commands">ejabberdctl Commands</A></H3><!--SEC END --><P> <A NAME="ectl-commands"></A> </P><P>When <TT>ejabberdctl</TT> is executed without any parameter,
|
||||||
it displays the available options. If there isn’t an <TT>ejabberd</TT> server running,
|
it displays the available options. If there isn’t an <TT>ejabberd</TT> server running,
|
||||||
the available parameters are:
|
the available parameters are:
|
||||||
</P><DL CLASS="description"><DT CLASS="dt-description">
|
</P><DL CLASS="description"><DT CLASS="dt-description">
|
||||||
@ -3240,7 +3311,7 @@ robot1
|
|||||||
testuser1
|
testuser1
|
||||||
testuser2
|
testuser2
|
||||||
</PRE><P> <A NAME="erlangconfiguration"></A> </P><!--TOC subsection Erlang Runtime System-->
|
</PRE><P> <A NAME="erlangconfiguration"></A> </P><!--TOC subsection Erlang Runtime System-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc66">4.1.2</A>  <A HREF="#erlangconfiguration">Erlang Runtime System</A></H3><!--SEC END --><P> <A NAME="erlangconfiguration"></A> </P><P><TT>ejabberd</TT> is an Erlang/OTP application that runs inside an Erlang runtime system.
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc67">4.1.2</A>  <A HREF="#erlangconfiguration">Erlang Runtime System</A></H3><!--SEC END --><P> <A NAME="erlangconfiguration"></A> </P><P><TT>ejabberd</TT> is an Erlang/OTP application that runs inside an Erlang runtime system.
|
||||||
This system is configured using environment variables and command line parameters.
|
This system is configured using environment variables and command line parameters.
|
||||||
The <TT>ejabberdctl</TT> administration script uses many of those possibilities.
|
The <TT>ejabberdctl</TT> administration script uses many of those possibilities.
|
||||||
You can configure some of them with the file <TT>ejabberdctl.cfg</TT>,
|
You can configure some of them with the file <TT>ejabberdctl.cfg</TT>,
|
||||||
@ -3313,7 +3384,7 @@ Starts the Erlang system detached from the system console.
|
|||||||
</DD></DL><P>
|
</DD></DL><P>
|
||||||
Note that some characters need to be escaped when used in shell scripts, for instance <CODE>"</CODE> and <CODE>{}</CODE>.
|
Note that some characters need to be escaped when used in shell scripts, for instance <CODE>"</CODE> and <CODE>{}</CODE>.
|
||||||
You can find other options in the Erlang manual page (<TT>erl -man erl</TT>).</P><P> <A NAME="eja-commands"></A> </P><!--TOC section <TT>ejabberd</TT> Commands-->
|
You can find other options in the Erlang manual page (<TT>erl -man erl</TT>).</P><P> <A NAME="eja-commands"></A> </P><!--TOC section <TT>ejabberd</TT> Commands-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc67">4.2</A>  <A HREF="#eja-commands"><TT>ejabberd</TT> Commands</A></H2><!--SEC END --><P> <A NAME="eja-commands"></A> </P><P>An <TT>ejabberd command</TT> is an abstract function identified by a name,
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc68">4.2</A>  <A HREF="#eja-commands"><TT>ejabberd</TT> Commands</A></H2><!--SEC END --><P> <A NAME="eja-commands"></A> </P><P>An <TT>ejabberd command</TT> is an abstract function identified by a name,
|
||||||
with a defined number and type of calling arguments and type of result
|
with a defined number and type of calling arguments and type of result
|
||||||
that is registered in the <TT>ejabberd_commands</TT> service.
|
that is registered in the <TT>ejabberd_commands</TT> service.
|
||||||
Those commands can be defined in any Erlang module and executed using any valid frontend.</P><P><TT>ejabberd</TT> includes a frontend to execute <TT>ejabberd commands</TT>: the script <TT>ejabberdctl</TT>.
|
Those commands can be defined in any Erlang module and executed using any valid frontend.</P><P><TT>ejabberd</TT> includes a frontend to execute <TT>ejabberd commands</TT>: the script <TT>ejabberdctl</TT>.
|
||||||
@ -3321,7 +3392,7 @@ Other known frontends that can be installed to execute ejabberd commands in diff
|
|||||||
<TT>ejabberd_xmlrpc</TT> (XML-RPC service),
|
<TT>ejabberd_xmlrpc</TT> (XML-RPC service),
|
||||||
<TT>mod_rest</TT> (HTTP POST service),
|
<TT>mod_rest</TT> (HTTP POST service),
|
||||||
<TT>mod_shcommands</TT> (ejabberd WebAdmin page).</P><P> <A NAME="list-eja-commands"></A> </P><!--TOC subsection List of ejabberd Commands-->
|
<TT>mod_shcommands</TT> (ejabberd WebAdmin page).</P><P> <A NAME="list-eja-commands"></A> </P><!--TOC subsection List of ejabberd Commands-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc68">4.2.1</A>  <A HREF="#list-eja-commands">List of ejabberd Commands</A></H3><!--SEC END --><P> <A NAME="list-eja-commands"></A> </P><P><TT>ejabberd</TT> includes a few ejabberd Commands by default.
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc69">4.2.1</A>  <A HREF="#list-eja-commands">List of ejabberd Commands</A></H3><!--SEC END --><P> <A NAME="list-eja-commands"></A> </P><P><TT>ejabberd</TT> includes a few ejabberd Commands by default.
|
||||||
When more modules are installed, new commands may be available in the frontends.</P><P>The easiest way to get a list of the available commands, and get help for them is to use
|
When more modules are installed, new commands may be available in the frontends.</P><P>The easiest way to get a list of the available commands, and get help for them is to use
|
||||||
the ejabberdctl script:
|
the ejabberdctl script:
|
||||||
</P><PRE CLASS="verbatim">$ ejabberdctl help
|
</P><PRE CLASS="verbatim">$ ejabberdctl help
|
||||||
@ -3356,7 +3427,7 @@ This is not recommended for big databases, as it will consume much time,
|
|||||||
memory and processor. In that case it’s preferable to use <TT>backup</TT> and <TT>install_fallback</TT>.
|
memory and processor. In that case it’s preferable to use <TT>backup</TT> and <TT>install_fallback</TT>.
|
||||||
</DD><DT CLASS="dt-description"><B><TT>import_piefxis, export_piefxis, export_piefxis_host</TT></B></DT><DD CLASS="dd-description">
|
</DD><DT CLASS="dt-description"><B><TT>import_piefxis, export_piefxis, export_piefxis_host</TT></B></DT><DD CLASS="dd-description">
|
||||||
These options can be used to migrate accounts
|
These options can be used to migrate accounts
|
||||||
using <A HREF="http://xmpp.org/extensions/xep-0227.html">XEP-0227</A> formatted XML files
|
using <A HREF="http://www.xmpp.org/extensions/xep-0227.html">XEP-0227</A> formatted XML files
|
||||||
from/to other Jabber/XMPP servers
|
from/to other Jabber/XMPP servers
|
||||||
or move users of a vhost to another ejabberd installation.
|
or move users of a vhost to another ejabberd installation.
|
||||||
See also
|
See also
|
||||||
@ -3371,7 +3442,7 @@ There exist tutorials to
|
|||||||
in offline storage. This might be useful when the number of offline messages
|
in offline storage. This might be useful when the number of offline messages
|
||||||
is very high.
|
is very high.
|
||||||
</DD></DL><P> <A NAME="accesscommands"></A> </P><!--TOC subsection Restrict Execution with AccessCommands-->
|
</DD></DL><P> <A NAME="accesscommands"></A> </P><!--TOC subsection Restrict Execution with AccessCommands-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc69">4.2.2</A>  <A HREF="#accesscommands">Restrict Execution with AccessCommands</A></H3><!--SEC END --><P> <A NAME="accesscommands"></A> </P><P>The frontends can be configured to restrict access to certain commands.
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc70">4.2.2</A>  <A HREF="#accesscommands">Restrict Execution with AccessCommands</A></H3><!--SEC END --><P> <A NAME="accesscommands"></A> </P><P>The frontends can be configured to restrict access to certain commands.
|
||||||
In that case, authentication information must be provided.
|
In that case, authentication information must be provided.
|
||||||
In each frontend the <TT>AccessCommands</TT> option is defined
|
In each frontend the <TT>AccessCommands</TT> option is defined
|
||||||
in a different place. But in all cases the option syntax is the same:
|
in a different place. But in all cases the option syntax is the same:
|
||||||
@ -3417,7 +3488,7 @@ and the provided arguments do not contradict Arguments.</P><P>As an example to u
|
|||||||
{_bot_reg_test, [register, unregister], [{host, "test.org"}]}
|
{_bot_reg_test, [register, unregister], [{host, "test.org"}]}
|
||||||
]
|
]
|
||||||
</PRE><P> <A NAME="webadmin"></A> </P><!--TOC section Web Admin-->
|
</PRE><P> <A NAME="webadmin"></A> </P><!--TOC section Web Admin-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc70">4.3</A>  <A HREF="#webadmin">Web Admin</A></H2><!--SEC END --><P> <A NAME="webadmin"></A>
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc71">4.3</A>  <A HREF="#webadmin">Web Admin</A></H2><!--SEC END --><P> <A NAME="webadmin"></A>
|
||||||
</P><P>The <TT>ejabberd</TT> Web Admin allows to administer most of <TT>ejabberd</TT> using a web browser.</P><P>This feature is enabled by default:
|
</P><P>The <TT>ejabberd</TT> Web Admin allows to administer most of <TT>ejabberd</TT> using a web browser.</P><P>This feature is enabled by default:
|
||||||
a <TT>ejabberd_http</TT> listener with the option <TT>web_admin</TT> (see
|
a <TT>ejabberd_http</TT> listener with the option <TT>web_admin</TT> (see
|
||||||
section <A HREF="#listened">3.1.3</A>) is included in the listening ports. Then you can open
|
section <A HREF="#listened">3.1.3</A>) is included in the listening ports. Then you can open
|
||||||
@ -3489,13 +3560,13 @@ The file is searched by default in
|
|||||||
The directory of the documentation can be specified in
|
The directory of the documentation can be specified in
|
||||||
the environment variable <TT>EJABBERD_DOC_PATH</TT>.
|
the environment variable <TT>EJABBERD_DOC_PATH</TT>.
|
||||||
See section <A HREF="#erlangconfiguration">4.1.2</A>.</P><P> <A NAME="adhoccommands"></A> </P><!--TOC section Ad-hoc Commands-->
|
See section <A HREF="#erlangconfiguration">4.1.2</A>.</P><P> <A NAME="adhoccommands"></A> </P><!--TOC section Ad-hoc Commands-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc71">4.4</A>  <A HREF="#adhoccommands">Ad-hoc Commands</A></H2><!--SEC END --><P> <A NAME="adhoccommands"></A> </P><P>If you enable <TT>mod_configure</TT> and <TT>mod_adhoc</TT>,
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc72">4.4</A>  <A HREF="#adhoccommands">Ad-hoc Commands</A></H2><!--SEC END --><P> <A NAME="adhoccommands"></A> </P><P>If you enable <TT>mod_configure</TT> and <TT>mod_adhoc</TT>,
|
||||||
you can perform several administrative tasks in <TT>ejabberd</TT>
|
you can perform several administrative tasks in <TT>ejabberd</TT>
|
||||||
with a Jabber client.
|
with a Jabber client.
|
||||||
The client must support Ad-Hoc Commands (<A HREF="http://xmpp.org/extensions/xep-0050.html">XEP-0050</A>),
|
The client must support Ad-Hoc Commands (<A HREF="http://www.xmpp.org/extensions/xep-0050.html">XEP-0050</A>),
|
||||||
and you must login in the Jabber server with
|
and you must login in the Jabber server with
|
||||||
an account with proper privileges.</P><P> <A NAME="changeerlangnodename"></A> </P><!--TOC section Change Computer Hostname-->
|
an account with proper privileges.</P><P> <A NAME="changeerlangnodename"></A> </P><!--TOC section Change Computer Hostname-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc72">4.5</A>  <A HREF="#changeerlangnodename">Change Computer Hostname</A></H2><!--SEC END --><P> <A NAME="changeerlangnodename"></A> </P><P><TT>ejabberd</TT> uses the distributed Mnesia database.
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc73">4.5</A>  <A HREF="#changeerlangnodename">Change Computer Hostname</A></H2><!--SEC END --><P> <A NAME="changeerlangnodename"></A> </P><P><TT>ejabberd</TT> uses the distributed Mnesia database.
|
||||||
Being distributed, Mnesia enforces consistency of its file,
|
Being distributed, Mnesia enforces consistency of its file,
|
||||||
so it stores the name of the Erlang node in it (see section <A HREF="#nodename">5.4</A>).
|
so it stores the name of the Erlang node in it (see section <A HREF="#nodename">5.4</A>).
|
||||||
The name of an Erlang node includes the hostname of the computer.
|
The name of an Erlang node includes the hostname of the computer.
|
||||||
@ -3532,8 +3603,8 @@ mv /var/lib/ejabberd/*.* /var/lib/ejabberd/oldfiles/
|
|||||||
</PRE></LI><LI CLASS="li-enumerate">Check that the information of the old database is available: accounts, rosters...
|
</PRE></LI><LI CLASS="li-enumerate">Check that the information of the old database is available: accounts, rosters...
|
||||||
After you finish, remember to delete the temporary backup files from public directories.
|
After you finish, remember to delete the temporary backup files from public directories.
|
||||||
</LI></OL><P> <A NAME="secure"></A> </P><!--TOC chapter Securing <TT>ejabberd</TT>-->
|
</LI></OL><P> <A NAME="secure"></A> </P><!--TOC chapter Securing <TT>ejabberd</TT>-->
|
||||||
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc73">Chapter 5</A>  <A HREF="#secure">Securing <TT>ejabberd</TT></A></H1><!--SEC END --><P> <A NAME="secure"></A> </P><P> <A NAME="firewall"></A> </P><!--TOC section Firewall Settings-->
|
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc74">Chapter 5</A>  <A HREF="#secure">Securing <TT>ejabberd</TT></A></H1><!--SEC END --><P> <A NAME="secure"></A> </P><P> <A NAME="firewall"></A> </P><!--TOC section Firewall Settings-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc74">5.1</A>  <A HREF="#firewall">Firewall Settings</A></H2><!--SEC END --><P> <A NAME="firewall"></A>
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc75">5.1</A>  <A HREF="#firewall">Firewall Settings</A></H2><!--SEC END --><P> <A NAME="firewall"></A>
|
||||||
</P><P>You need to take the following TCP ports in mind when configuring your firewall:
|
</P><P>You need to take the following TCP ports in mind when configuring your firewall:
|
||||||
</P><BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV>
|
</P><BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV>
|
||||||
<TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1><TR><TD ALIGN=left NOWRAP><B>Port</B></TD><TD ALIGN=left NOWRAP><B>Description</B></TD></TR>
|
<TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1><TR><TD ALIGN=left NOWRAP><B>Port</B></TD><TD ALIGN=left NOWRAP><B>Description</B></TD></TR>
|
||||||
@ -3544,7 +3615,7 @@ After you finish, remember to delete the temporary backup files from public dire
|
|||||||
<TR><TD ALIGN=left NOWRAP>port range</TD><TD ALIGN=left NOWRAP>Used for connections between Erlang nodes. This range is configurable (see section <A HREF="#epmd">5.2</A>).</TD></TR>
|
<TR><TD ALIGN=left NOWRAP>port range</TD><TD ALIGN=left NOWRAP>Used for connections between Erlang nodes. This range is configurable (see section <A HREF="#epmd">5.2</A>).</TD></TR>
|
||||||
</TABLE>
|
</TABLE>
|
||||||
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE><P> <A NAME="epmd"></A> </P><!--TOC section epmd-->
|
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE><P> <A NAME="epmd"></A> </P><!--TOC section epmd-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc75">5.2</A>  <A HREF="#epmd">epmd</A></H2><!--SEC END --><P> <A NAME="epmd"></A> </P><P><A HREF="http://www.erlang.org/doc/man/epmd.html">epmd (Erlang Port Mapper Daemon)</A>
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc76">5.2</A>  <A HREF="#epmd">epmd</A></H2><!--SEC END --><P> <A NAME="epmd"></A> </P><P><A HREF="http://www.erlang.org/doc/man/epmd.html">epmd (Erlang Port Mapper Daemon)</A>
|
||||||
is a small name server included in Erlang/OTP
|
is a small name server included in Erlang/OTP
|
||||||
and used by Erlang programs when establishing distributed Erlang communications.
|
and used by Erlang programs when establishing distributed Erlang communications.
|
||||||
<TT>ejabberd</TT> needs <TT>epmd</TT> to use <TT>ejabberdctl</TT> and also when clustering <TT>ejabberd</TT> nodes.
|
<TT>ejabberd</TT> needs <TT>epmd</TT> to use <TT>ejabberdctl</TT> and also when clustering <TT>ejabberd</TT> nodes.
|
||||||
@ -3569,7 +3640,7 @@ but can be configured in the file <TT>ejabberdctl.cfg</TT>.
|
|||||||
The Erlang command-line parameter used internally is, for example:
|
The Erlang command-line parameter used internally is, for example:
|
||||||
</P><PRE CLASS="verbatim">erl ... -kernel inet_dist_listen_min 4370 inet_dist_listen_max 4375
|
</P><PRE CLASS="verbatim">erl ... -kernel inet_dist_listen_min 4370 inet_dist_listen_max 4375
|
||||||
</PRE><P> <A NAME="cookie"></A> </P><!--TOC section Erlang Cookie-->
|
</PRE><P> <A NAME="cookie"></A> </P><!--TOC section Erlang Cookie-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc76">5.3</A>  <A HREF="#cookie">Erlang Cookie</A></H2><!--SEC END --><P> <A NAME="cookie"></A> </P><P>The Erlang cookie is a string with numbers and letters.
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc77">5.3</A>  <A HREF="#cookie">Erlang Cookie</A></H2><!--SEC END --><P> <A NAME="cookie"></A> </P><P>The Erlang cookie is a string with numbers and letters.
|
||||||
An Erlang node reads the cookie at startup from the command-line parameter <TT>-setcookie</TT>.
|
An Erlang node reads the cookie at startup from the command-line parameter <TT>-setcookie</TT>.
|
||||||
If not indicated, the cookie is read from the cookie file <TT>$HOME/.erlang.cookie</TT>.
|
If not indicated, the cookie is read from the cookie file <TT>$HOME/.erlang.cookie</TT>.
|
||||||
If this file does not exist, it is created immediately with a random cookie.
|
If this file does not exist, it is created immediately with a random cookie.
|
||||||
@ -3583,7 +3654,7 @@ to prevent unauthorized access or intrusion to an Erlang node.
|
|||||||
The communication between Erlang nodes are not encrypted,
|
The communication between Erlang nodes are not encrypted,
|
||||||
so the cookie could be read sniffing the traffic on the network.
|
so the cookie could be read sniffing the traffic on the network.
|
||||||
The recommended way to secure the Erlang node is to block the port 4369.</P><P> <A NAME="nodename"></A> </P><!--TOC section Erlang Node Name-->
|
The recommended way to secure the Erlang node is to block the port 4369.</P><P> <A NAME="nodename"></A> </P><!--TOC section Erlang Node Name-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc77">5.4</A>  <A HREF="#nodename">Erlang Node Name</A></H2><!--SEC END --><P> <A NAME="nodename"></A> </P><P>An Erlang node may have a node name.
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc78">5.4</A>  <A HREF="#nodename">Erlang Node Name</A></H2><!--SEC END --><P> <A NAME="nodename"></A> </P><P>An Erlang node may have a node name.
|
||||||
The name can be short (if indicated with the command-line parameter <TT>-sname</TT>)
|
The name can be short (if indicated with the command-line parameter <TT>-sname</TT>)
|
||||||
or long (if indicated with the parameter <TT>-name</TT>).
|
or long (if indicated with the parameter <TT>-name</TT>).
|
||||||
Starting an Erlang node with -sname limits the communication between Erlang nodes to the LAN.</P><P>Using the option <TT>-sname</TT> instead of <TT>-name</TT> is a simple method
|
Starting an Erlang node with -sname limits the communication between Erlang nodes to the LAN.</P><P>Using the option <TT>-sname</TT> instead of <TT>-name</TT> is a simple method
|
||||||
@ -3592,7 +3663,7 @@ However, it is not ultimately effective to prevent access to the Erlang node,
|
|||||||
because it may be possible to fake the fact that you are on another network
|
because it may be possible to fake the fact that you are on another network
|
||||||
using a modified version of Erlang <TT>epmd</TT>.
|
using a modified version of Erlang <TT>epmd</TT>.
|
||||||
The recommended way to secure the Erlang node is to block the port 4369.</P><P> <A NAME="secure-files"></A> </P><!--TOC section Securing Sensible Files-->
|
The recommended way to secure the Erlang node is to block the port 4369.</P><P> <A NAME="secure-files"></A> </P><!--TOC section Securing Sensible Files-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc78">5.5</A>  <A HREF="#secure-files">Securing Sensible Files</A></H2><!--SEC END --><P> <A NAME="secure-files"></A> </P><P><TT>ejabberd</TT> stores sensible data in the file system either in plain text or binary files.
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc79">5.5</A>  <A HREF="#secure-files">Securing Sensible Files</A></H2><!--SEC END --><P> <A NAME="secure-files"></A> </P><P><TT>ejabberd</TT> stores sensible data in the file system either in plain text or binary files.
|
||||||
The file system permissions should be set to only allow the proper user to read,
|
The file system permissions should be set to only allow the proper user to read,
|
||||||
write and execute those files and directories.</P><DL CLASS="description"><DT CLASS="dt-description">
|
write and execute those files and directories.</P><DL CLASS="description"><DT CLASS="dt-description">
|
||||||
<B><TT>ejabberd configuration file: /etc/ejabberd/ejabberd.cfg</TT></B></DT><DD CLASS="dd-description">
|
<B><TT>ejabberd configuration file: /etc/ejabberd/ejabberd.cfg</TT></B></DT><DD CLASS="dd-description">
|
||||||
@ -3612,9 +3683,9 @@ so it is preferable to secure the whole <TT>/var/lib/ejabberd/</TT> directory.
|
|||||||
</DD><DT CLASS="dt-description"><B><TT>Erlang cookie file: /var/lib/ejabberd/.erlang.cookie</TT></B></DT><DD CLASS="dd-description">
|
</DD><DT CLASS="dt-description"><B><TT>Erlang cookie file: /var/lib/ejabberd/.erlang.cookie</TT></B></DT><DD CLASS="dd-description">
|
||||||
See section <A HREF="#cookie">5.3</A>.
|
See section <A HREF="#cookie">5.3</A>.
|
||||||
</DD></DL><P> <A NAME="clustering"></A> </P><!--TOC chapter Clustering-->
|
</DD></DL><P> <A NAME="clustering"></A> </P><!--TOC chapter Clustering-->
|
||||||
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc79">Chapter 6</A>  <A HREF="#clustering">Clustering</A></H1><!--SEC END --><P> <A NAME="clustering"></A>
|
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc80">Chapter 6</A>  <A HREF="#clustering">Clustering</A></H1><!--SEC END --><P> <A NAME="clustering"></A>
|
||||||
</P><P> <A NAME="howitworks"></A> </P><!--TOC section How it Works-->
|
</P><P> <A NAME="howitworks"></A> </P><!--TOC section How it Works-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc80">6.1</A>  <A HREF="#howitworks">How it Works</A></H2><!--SEC END --><P> <A NAME="howitworks"></A>
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc81">6.1</A>  <A HREF="#howitworks">How it Works</A></H2><!--SEC END --><P> <A NAME="howitworks"></A>
|
||||||
</P><P>A Jabber domain is served by one or more <TT>ejabberd</TT> nodes. These nodes can
|
</P><P>A Jabber domain is served by one or more <TT>ejabberd</TT> nodes. These nodes can
|
||||||
be run on different machines that are connected via a network. They all
|
be run on different machines that are connected via a network. They all
|
||||||
must have the ability to connect to port 4369 of all another nodes, and must
|
must have the ability to connect to port 4369 of all another nodes, and must
|
||||||
@ -3628,29 +3699,29 @@ router,
|
|||||||
</LI><LI CLASS="li-itemize">session manager,
|
</LI><LI CLASS="li-itemize">session manager,
|
||||||
</LI><LI CLASS="li-itemize">s2s manager.
|
</LI><LI CLASS="li-itemize">s2s manager.
|
||||||
</LI></UL><P> <A NAME="router"></A> </P><!--TOC subsection Router-->
|
</LI></UL><P> <A NAME="router"></A> </P><!--TOC subsection Router-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc81">6.1.1</A>  <A HREF="#router">Router</A></H3><!--SEC END --><P> <A NAME="router"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc82">6.1.1</A>  <A HREF="#router">Router</A></H3><!--SEC END --><P> <A NAME="router"></A>
|
||||||
</P><P>This module is the main router of Jabber packets on each node. It
|
</P><P>This module is the main router of Jabber packets on each node. It
|
||||||
routes them based on their destination’s domains. It uses a global
|
routes them based on their destination’s domains. It uses a global
|
||||||
routing table. The domain of the packet’s destination is searched in the
|
routing table. The domain of the packet’s destination is searched in the
|
||||||
routing table, and if it is found, the packet is routed to the
|
routing table, and if it is found, the packet is routed to the
|
||||||
appropriate process. If not, it is sent to the s2s manager.</P><P> <A NAME="localrouter"></A> </P><!--TOC subsection Local Router-->
|
appropriate process. If not, it is sent to the s2s manager.</P><P> <A NAME="localrouter"></A> </P><!--TOC subsection Local Router-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc82">6.1.2</A>  <A HREF="#localrouter">Local Router</A></H3><!--SEC END --><P> <A NAME="localrouter"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc83">6.1.2</A>  <A HREF="#localrouter">Local Router</A></H3><!--SEC END --><P> <A NAME="localrouter"></A>
|
||||||
</P><P>This module routes packets which have a destination domain equal to
|
</P><P>This module routes packets which have a destination domain equal to
|
||||||
one of this server’s host names. If the destination JID has a non-empty user
|
one of this server’s host names. If the destination JID has a non-empty user
|
||||||
part, it is routed to the session manager, otherwise it is processed depending
|
part, it is routed to the session manager, otherwise it is processed depending
|
||||||
on its content.</P><P> <A NAME="sessionmanager"></A> </P><!--TOC subsection Session Manager-->
|
on its content.</P><P> <A NAME="sessionmanager"></A> </P><!--TOC subsection Session Manager-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc83">6.1.3</A>  <A HREF="#sessionmanager">Session Manager</A></H3><!--SEC END --><P> <A NAME="sessionmanager"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc84">6.1.3</A>  <A HREF="#sessionmanager">Session Manager</A></H3><!--SEC END --><P> <A NAME="sessionmanager"></A>
|
||||||
</P><P>This module routes packets to local users. It looks up to which user
|
</P><P>This module routes packets to local users. It looks up to which user
|
||||||
resource a packet must be sent via a presence table. Then the packet is
|
resource a packet must be sent via a presence table. Then the packet is
|
||||||
either routed to the appropriate c2s process, or stored in offline
|
either routed to the appropriate c2s process, or stored in offline
|
||||||
storage, or bounced back.</P><P> <A NAME="s2smanager"></A> </P><!--TOC subsection s2s Manager-->
|
storage, or bounced back.</P><P> <A NAME="s2smanager"></A> </P><!--TOC subsection s2s Manager-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc84">6.1.4</A>  <A HREF="#s2smanager">s2s Manager</A></H3><!--SEC END --><P> <A NAME="s2smanager"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc85">6.1.4</A>  <A HREF="#s2smanager">s2s Manager</A></H3><!--SEC END --><P> <A NAME="s2smanager"></A>
|
||||||
</P><P>This module routes packets to other Jabber servers. First, it
|
</P><P>This module routes packets to other Jabber servers. First, it
|
||||||
checks if an opened s2s connection from the domain of the packet’s
|
checks if an opened s2s connection from the domain of the packet’s
|
||||||
source to the domain of the packet’s destination exists. If that is the case,
|
source to the domain of the packet’s destination exists. If that is the case,
|
||||||
the s2s manager routes the packet to the process
|
the s2s manager routes the packet to the process
|
||||||
serving this connection, otherwise a new connection is opened.</P><P> <A NAME="cluster"></A> </P><!--TOC section Clustering Setup-->
|
serving this connection, otherwise a new connection is opened.</P><P> <A NAME="cluster"></A> </P><!--TOC section Clustering Setup-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc85">6.2</A>  <A HREF="#cluster">Clustering Setup</A></H2><!--SEC END --><P> <A NAME="cluster"></A>
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc86">6.2</A>  <A HREF="#cluster">Clustering Setup</A></H2><!--SEC END --><P> <A NAME="cluster"></A>
|
||||||
</P><P>Suppose you already configured <TT>ejabberd</TT> on one machine named (<TT>first</TT>),
|
</P><P>Suppose you already configured <TT>ejabberd</TT> on one machine named (<TT>first</TT>),
|
||||||
and you need to setup another one to make an <TT>ejabberd</TT> cluster. Then do
|
and you need to setup another one to make an <TT>ejabberd</TT> cluster. Then do
|
||||||
following steps:</P><OL CLASS="enumerate" type=1><LI CLASS="li-enumerate">
|
following steps:</P><OL CLASS="enumerate" type=1><LI CLASS="li-enumerate">
|
||||||
@ -3684,14 +3755,14 @@ the Erlang shell. This probably can take some time if Mnesia has not yet
|
|||||||
transfered and processed all data it needed from <TT>first</TT>.</LI><LI CLASS="li-enumerate">Now run <TT>ejabberd</TT> on <TT>second</TT> with a configuration similar as
|
transfered and processed all data it needed from <TT>first</TT>.</LI><LI CLASS="li-enumerate">Now run <TT>ejabberd</TT> on <TT>second</TT> with a configuration similar as
|
||||||
on <TT>first</TT>: you probably do not need to duplicate ‘<CODE>acl</CODE>’
|
on <TT>first</TT>: you probably do not need to duplicate ‘<CODE>acl</CODE>’
|
||||||
and ‘<CODE>access</CODE>’ options because they will be taken from
|
and ‘<CODE>access</CODE>’ options because they will be taken from
|
||||||
<TT>first</TT>. If you installed <CODE>mod_irc</CODE>, notice that it should be
|
<TT>first</TT>; and <CODE>mod_irc</CODE> should be
|
||||||
enabled only on one machine in the cluster.
|
enabled only on one machine in the cluster.
|
||||||
</LI></OL><P>You can repeat these steps for other machines supposed to serve this
|
</LI></OL><P>You can repeat these steps for other machines supposed to serve this
|
||||||
domain.</P><P> <A NAME="servicelb"></A> </P><!--TOC section Service Load-Balancing-->
|
domain.</P><P> <A NAME="servicelb"></A> </P><!--TOC section Service Load-Balancing-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc86">6.3</A>  <A HREF="#servicelb">Service Load-Balancing</A></H2><!--SEC END --><P> <A NAME="servicelb"></A>
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc87">6.3</A>  <A HREF="#servicelb">Service Load-Balancing</A></H2><!--SEC END --><P> <A NAME="servicelb"></A>
|
||||||
</P><P> <A NAME="componentlb"></A> </P><!--TOC subsection Components Load-Balancing-->
|
</P><P> <A NAME="componentlb"></A> </P><!--TOC subsection Components Load-Balancing-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc87">6.3.1</A>  <A HREF="#componentlb">Components Load-Balancing</A></H3><!--SEC END --><P> <A NAME="componentlb"></A> </P><P> <A NAME="domainlb"></A> </P><!--TOC subsection Domain Load-Balancing Algorithm-->
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc88">6.3.1</A>  <A HREF="#componentlb">Components Load-Balancing</A></H3><!--SEC END --><P> <A NAME="componentlb"></A> </P><P> <A NAME="domainlb"></A> </P><!--TOC subsection Domain Load-Balancing Algorithm-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc88">6.3.2</A>  <A HREF="#domainlb">Domain Load-Balancing Algorithm</A></H3><!--SEC END --><P> <A NAME="domainlb"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc89">6.3.2</A>  <A HREF="#domainlb">Domain Load-Balancing Algorithm</A></H3><!--SEC END --><P> <A NAME="domainlb"></A>
|
||||||
</P><P><TT>ejabberd</TT> includes an algorithm to load balance the components that are plugged on an <TT>ejabberd</TT> cluster. It means that you can plug one or several instances of the same component on each <TT>ejabberd</TT> cluster and that the traffic will be automatically distributed.</P><P>The default distribution algorithm try to deliver to a local instance of a component. If several local instances are available, one instance is chosen randomly. If no instance is available locally, one instance is chosen randomly among the remote component instances.</P><P>If you need a different behaviour, you can change the load balancing behaviour with the option <TT>domain_balancing</TT>. The syntax of the option is the following:</P><PRE CLASS="verbatim">{domain_balancing, "component.example.com", <balancing_criterium>}.
|
</P><P><TT>ejabberd</TT> includes an algorithm to load balance the components that are plugged on an <TT>ejabberd</TT> cluster. It means that you can plug one or several instances of the same component on each <TT>ejabberd</TT> cluster and that the traffic will be automatically distributed.</P><P>The default distribution algorithm try to deliver to a local instance of a component. If several local instances are available, one instance is chosen randomly. If no instance is available locally, one instance is chosen randomly among the remote component instances.</P><P>If you need a different behaviour, you can change the load balancing behaviour with the option <TT>domain_balancing</TT>. The syntax of the option is the following:</P><PRE CLASS="verbatim">{domain_balancing, "component.example.com", <balancing_criterium>}.
|
||||||
</PRE><P>Several balancing criteria are available:
|
</PRE><P>Several balancing criteria are available:
|
||||||
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
||||||
@ -3700,13 +3771,13 @@ domain.</P><P> <A NAME="servicelb"></A> </P><!--TOC section Service Load-Balanci
|
|||||||
</LI><LI CLASS="li-itemize"><TT>bare_destination</TT>: the bare JID (without resource) of the packet <TT>to</TT> attribute is used.
|
</LI><LI CLASS="li-itemize"><TT>bare_destination</TT>: the bare JID (without resource) of the packet <TT>to</TT> attribute is used.
|
||||||
</LI><LI CLASS="li-itemize"><TT>bare_source</TT>: the bare JID (without resource) of the packet <TT>from</TT> attribute is used.
|
</LI><LI CLASS="li-itemize"><TT>bare_source</TT>: the bare JID (without resource) of the packet <TT>from</TT> attribute is used.
|
||||||
</LI></UL><P>If the value corresponding to the criteria is the same, the same component instance in the cluster will be used.</P><P> <A NAME="lbbuckets"></A> </P><!--TOC subsection Load-Balancing Buckets-->
|
</LI></UL><P>If the value corresponding to the criteria is the same, the same component instance in the cluster will be used.</P><P> <A NAME="lbbuckets"></A> </P><!--TOC subsection Load-Balancing Buckets-->
|
||||||
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc89">6.3.3</A>  <A HREF="#lbbuckets">Load-Balancing Buckets</A></H3><!--SEC END --><P> <A NAME="lbbuckets"></A>
|
<H3 CLASS="subsection"><!--SEC ANCHOR --><A NAME="htoc90">6.3.3</A>  <A HREF="#lbbuckets">Load-Balancing Buckets</A></H3><!--SEC END --><P> <A NAME="lbbuckets"></A>
|
||||||
</P><P>When there is a risk of failure for a given component, domain balancing can cause service trouble. If one component is failing the service will not work correctly unless the sessions are rebalanced.</P><P>In this case, it is best to limit the problem to the sessions handled by the failing component. This is what the <TT>domain_balancing_component_number</TT> option does, making the load balancing algorithm not dynamic, but sticky on a fix number of component instances.</P><P>The syntax is the following:
|
</P><P>When there is a risk of failure for a given component, domain balancing can cause service trouble. If one component is failing the service will not work correctly unless the sessions are rebalanced.</P><P>In this case, it is best to limit the problem to the sessions handled by the failing component. This is what the <TT>domain_balancing_component_number</TT> option does, making the load balancing algorithm not dynamic, but sticky on a fix number of component instances.</P><P>The syntax is the following:
|
||||||
</P><PRE CLASS="verbatim">{domain_balancing_component_number, "component.example.com", N}
|
</P><PRE CLASS="verbatim">{domain_balancing_component_number, "component.example.com", N}
|
||||||
</PRE><P> <A NAME="debugging"></A> </P><!--TOC chapter Debugging-->
|
</PRE><P> <A NAME="debugging"></A> </P><!--TOC chapter Debugging-->
|
||||||
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc90">Chapter 7</A>  <A HREF="#debugging">Debugging</A></H1><!--SEC END --><P> <A NAME="debugging"></A>
|
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc91">Chapter 7</A>  <A HREF="#debugging">Debugging</A></H1><!--SEC END --><P> <A NAME="debugging"></A>
|
||||||
</P><P> <A NAME="logfiles"></A> </P><!--TOC section Log Files-->
|
</P><P> <A NAME="logfiles"></A> </P><!--TOC section Log Files-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc91">7.1</A>  <A HREF="#logfiles">Log Files</A></H2><!--SEC END --><P> <A NAME="logfiles"></A> </P><P>An <TT>ejabberd</TT> node writes two log files:
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc92">7.1</A>  <A HREF="#logfiles">Log Files</A></H2><!--SEC END --><P> <A NAME="logfiles"></A> </P><P>An <TT>ejabberd</TT> node writes two log files:
|
||||||
</P><DL CLASS="description"><DT CLASS="dt-description">
|
</P><DL CLASS="description"><DT CLASS="dt-description">
|
||||||
<B><TT>ejabberd.log</TT></B></DT><DD CLASS="dd-description"> is the ejabberd service log, with the messages reported by <TT>ejabberd</TT> code
|
<B><TT>ejabberd.log</TT></B></DT><DD CLASS="dd-description"> is the ejabberd service log, with the messages reported by <TT>ejabberd</TT> code
|
||||||
</DD><DT CLASS="dt-description"><B><TT>sasl.log</TT></B></DT><DD CLASS="dd-description"> is the Erlang/OTP system log, with the messages reported by Erlang/OTP using SASL (System Architecture Support Libraries)
|
</DD><DT CLASS="dt-description"><B><TT>sasl.log</TT></B></DT><DD CLASS="dd-description"> is the Erlang/OTP system log, with the messages reported by Erlang/OTP using SASL (System Architecture Support Libraries)
|
||||||
@ -3728,12 +3799,12 @@ The ejabberdctl command <TT>reopen-log</TT>
|
|||||||
(please refer to section <A HREF="#ectl-commands">4.1.1</A>)
|
(please refer to section <A HREF="#ectl-commands">4.1.1</A>)
|
||||||
reopens the log files,
|
reopens the log files,
|
||||||
and also renames the old ones if you didn’t rename them.</P><P> <A NAME="debugconsole"></A> </P><!--TOC section Debug Console-->
|
and also renames the old ones if you didn’t rename them.</P><P> <A NAME="debugconsole"></A> </P><!--TOC section Debug Console-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc92">7.2</A>  <A HREF="#debugconsole">Debug Console</A></H2><!--SEC END --><P> <A NAME="debugconsole"></A> </P><P>The Debug Console is an Erlang shell attached to an already running <TT>ejabberd</TT> server.
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc93">7.2</A>  <A HREF="#debugconsole">Debug Console</A></H2><!--SEC END --><P> <A NAME="debugconsole"></A> </P><P>The Debug Console is an Erlang shell attached to an already running <TT>ejabberd</TT> server.
|
||||||
With this Erlang shell, an experienced administrator can perform complex tasks.</P><P>This shell gives complete control over the <TT>ejabberd</TT> server,
|
With this Erlang shell, an experienced administrator can perform complex tasks.</P><P>This shell gives complete control over the <TT>ejabberd</TT> server,
|
||||||
so it is important to use it with extremely care.
|
so it is important to use it with extremely care.
|
||||||
There are some simple and safe examples in the article
|
There are some simple and safe examples in the article
|
||||||
<A HREF="http://www.ejabberd.im/interconnect-erl-nodes">Interconnecting Erlang Nodes</A></P><P>To exit the shell, close the window or press the keys: control+c control+c.</P><P> <A NAME="watchdog"></A> </P><!--TOC section Watchdog Alerts-->
|
<A HREF="http://www.ejabberd.im/interconnect-erl-nodes">Interconnecting Erlang Nodes</A></P><P>To exit the shell, close the window or press the keys: control+c control+c.</P><P> <A NAME="watchdog"></A> </P><!--TOC section Watchdog Alerts-->
|
||||||
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc93">7.3</A>  <A HREF="#watchdog">Watchdog Alerts</A></H2><!--SEC END --><P> <A NAME="watchdog"></A>
|
<H2 CLASS="section"><!--SEC ANCHOR --><A NAME="htoc94">7.3</A>  <A HREF="#watchdog">Watchdog Alerts</A></H2><!--SEC END --><P> <A NAME="watchdog"></A>
|
||||||
</P><P><TT>ejabberd</TT> includes a watchdog mechanism that may be useful to developers
|
</P><P><TT>ejabberd</TT> includes a watchdog mechanism that may be useful to developers
|
||||||
when troubleshooting a problem related to memory usage.
|
when troubleshooting a problem related to memory usage.
|
||||||
If a process in the <TT>ejabberd</TT> server consumes more memory than the configured threshold,
|
If a process in the <TT>ejabberd</TT> server consumes more memory than the configured threshold,
|
||||||
@ -3751,7 +3822,7 @@ or in a conversation with the watchdog alert bot.</P><P>Example configuration:
|
|||||||
To remove all watchdog admins, set the option with an empty list:
|
To remove all watchdog admins, set the option with an empty list:
|
||||||
</P><PRE CLASS="verbatim">{watchdog_admins, []}.
|
</P><PRE CLASS="verbatim">{watchdog_admins, []}.
|
||||||
</PRE><P> <A NAME="i18ni10n"></A> </P><!--TOC chapter Internationalization and Localization-->
|
</PRE><P> <A NAME="i18ni10n"></A> </P><!--TOC chapter Internationalization and Localization-->
|
||||||
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc94">Appendix A</A>  <A HREF="#i18ni10n">Internationalization and Localization</A></H1><!--SEC END --><P> <A NAME="i18ni10n"></A>
|
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc95">Appendix A</A>  <A HREF="#i18ni10n">Internationalization and Localization</A></H1><!--SEC END --><P> <A NAME="i18ni10n"></A>
|
||||||
</P><P>The source code of <TT>ejabberd</TT> supports localization.
|
</P><P>The source code of <TT>ejabberd</TT> supports localization.
|
||||||
The translators can edit the
|
The translators can edit the
|
||||||
<A HREF="http://www.gnu.org/software/gettext/">gettext</A> .po files
|
<A HREF="http://www.gnu.org/software/gettext/">gettext</A> .po files
|
||||||
@ -3786,9 +3857,9 @@ HTTP header ‘Accept-Language: ru’</TD></TR>
|
|||||||
</TABLE></DIV>
|
</TABLE></DIV>
|
||||||
<A NAME="fig:webadmmainru"></A>
|
<A NAME="fig:webadmmainru"></A>
|
||||||
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE><P> <A NAME="releasenotes"></A> </P><!--TOC chapter Release Notes-->
|
<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE><P> <A NAME="releasenotes"></A> </P><!--TOC chapter Release Notes-->
|
||||||
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc95">Appendix B</A>  <A HREF="#releasenotes">Release Notes</A></H1><!--SEC END --><P> <A NAME="releasenotes"></A>
|
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc96">Appendix B</A>  <A HREF="#releasenotes">Release Notes</A></H1><!--SEC END --><P> <A NAME="releasenotes"></A>
|
||||||
</P><P>Release notes are available from <A HREF="http://www.process-one.net/en/ejabberd/release_notes/">ejabberd Home Page</A></P><P> <A NAME="acknowledgements"></A> </P><!--TOC chapter Acknowledgements-->
|
</P><P>Release notes are available from <A HREF="http://www.process-one.net/en/ejabberd/release_notes/">ejabberd Home Page</A></P><P> <A NAME="acknowledgements"></A> </P><!--TOC chapter Acknowledgements-->
|
||||||
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc96">Appendix C</A>  <A HREF="#acknowledgements">Acknowledgements</A></H1><!--SEC END --><P> <A NAME="acknowledgements"></A> </P><P>Thanks to all people who contributed to this guide:
|
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc97">Appendix C</A>  <A HREF="#acknowledgements">Acknowledgements</A></H1><!--SEC END --><P> <A NAME="acknowledgements"></A> </P><P>Thanks to all people who contributed to this guide:
|
||||||
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
</P><UL CLASS="itemize"><LI CLASS="li-itemize">
|
||||||
Alexey Shchepin (<A HREF="xmpp:aleksey@jabber.ru"><TT>xmpp:aleksey@jabber.ru</TT></A>)
|
Alexey Shchepin (<A HREF="xmpp:aleksey@jabber.ru"><TT>xmpp:aleksey@jabber.ru</TT></A>)
|
||||||
</LI><LI CLASS="li-itemize">Badlop (<A HREF="xmpp:badlop@jabberes.org"><TT>xmpp:badlop@jabberes.org</TT></A>)
|
</LI><LI CLASS="li-itemize">Badlop (<A HREF="xmpp:badlop@jabberes.org"><TT>xmpp:badlop@jabberes.org</TT></A>)
|
||||||
@ -3800,7 +3871,7 @@ Alexey Shchepin (<A HREF="xmpp:aleksey@jabber.ru"><TT>xmpp:aleksey@jabber.ru</TT
|
|||||||
</LI><LI CLASS="li-itemize">Sergei Golovan (<A HREF="xmpp:sgolovan@nes.ru"><TT>xmpp:sgolovan@nes.ru</TT></A>)
|
</LI><LI CLASS="li-itemize">Sergei Golovan (<A HREF="xmpp:sgolovan@nes.ru"><TT>xmpp:sgolovan@nes.ru</TT></A>)
|
||||||
</LI><LI CLASS="li-itemize">Vsevolod Pelipas (<A HREF="xmpp:vsevoload@jabber.ru"><TT>xmpp:vsevoload@jabber.ru</TT></A>)
|
</LI><LI CLASS="li-itemize">Vsevolod Pelipas (<A HREF="xmpp:vsevoload@jabber.ru"><TT>xmpp:vsevoload@jabber.ru</TT></A>)
|
||||||
</LI></UL><P> <A NAME="copyright"></A> </P><!--TOC chapter Copyright Information-->
|
</LI></UL><P> <A NAME="copyright"></A> </P><!--TOC chapter Copyright Information-->
|
||||||
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc97">Appendix D</A>  <A HREF="#copyright">Copyright Information</A></H1><!--SEC END --><P> <A NAME="copyright"></A> </P><P>Ejabberd Installation and Operation Guide.<BR>
|
<H1 CLASS="chapter"><!--SEC ANCHOR --><A NAME="htoc98">Appendix D</A>  <A HREF="#copyright">Copyright Information</A></H1><!--SEC END --><P> <A NAME="copyright"></A> </P><P>Ejabberd Installation and Operation Guide.<BR>
|
||||||
Copyright © 2003 — 2009 ProcessOne</P><P>This document is free software; you can redistribute it and/or
|
Copyright © 2003 — 2009 ProcessOne</P><P>This document is free software; you can redistribute it and/or
|
||||||
modify it under the terms of the GNU General Public License
|
modify it under the terms of the GNU General Public License
|
||||||
as published by the Free Software Foundation; either version 2
|
as published by the Free Software Foundation; either version 2
|
||||||
|
@ -720,11 +720,11 @@ other different modules for some specific virtual hosts:
|
|||||||
\makesubsection{listened}{Listening Ports}
|
\makesubsection{listened}{Listening Ports}
|
||||||
\ind{options!listen}
|
\ind{options!listen}
|
||||||
|
|
||||||
The option \option{listen} defines for which addresses and ports \ejabberd{}
|
The option \option{listen} defines for which ports, addresses and network protocols \ejabberd{}
|
||||||
will listen and what services will be run on them. Each element of the list is a
|
will listen and what services will be run on them. Each element of the list is a
|
||||||
tuple with the following elements:
|
tuple with the following elements:
|
||||||
\begin{itemize}
|
\begin{itemize}
|
||||||
\item Port number. Optionally also the IP address.
|
\item Port number. Optionally also the IP address and/or a transport protocol.
|
||||||
\item Listening module that serves this port.
|
\item Listening module that serves this port.
|
||||||
\item Options for the TCP socket and for the listening module.
|
\item Options for the TCP socket and for the listening module.
|
||||||
\end{itemize}
|
\end{itemize}
|
||||||
@ -742,10 +742,12 @@ With the basic syntax the ports will listen on all IPv4 network addresses:
|
|||||||
It is possible to specify the IP address for a port using the full syntax:
|
It is possible to specify the IP address for a port using the full syntax:
|
||||||
\begin{verbatim}
|
\begin{verbatim}
|
||||||
{{<port-number>, <ip-address>}, <module>, [<options>]}
|
{{<port-number>, <ip-address>}, <module>, [<options>]}
|
||||||
|
{{<port-number>, <transport-protocol>}, <module>, [<options>]}
|
||||||
|
{{<port-number>, <ip-address>, <transport-protocol>}, <module>, [<options>]}
|
||||||
\end{verbatim}
|
\end{verbatim}
|
||||||
|
|
||||||
|
|
||||||
\makesubsubsection{listened-port}{Port Number and IP Address}
|
\makesubsubsection{listened-port}{Port Number, IP Address and Transport Protocol}
|
||||||
|
|
||||||
The port number defines which port to listen for incoming connections.
|
The port number defines which port to listen for incoming connections.
|
||||||
It can be a Jabber/XMPP standard port
|
It can be a Jabber/XMPP standard port
|
||||||
@ -769,6 +771,9 @@ Some example values for IP address:
|
|||||||
\item \verb|{16#fdca, 16#8ab6, 16#a243, 16#75ef, 0, 0, 0, 1}| is the IPv6 address \verb|FDCA:8AB6:A243:75EF::1/128|
|
\item \verb|{16#fdca, 16#8ab6, 16#a243, 16#75ef, 0, 0, 0, 1}| is the IPv6 address \verb|FDCA:8AB6:A243:75EF::1/128|
|
||||||
\end{itemize}
|
\end{itemize}
|
||||||
|
|
||||||
|
The transport protocol can be \term{tcp} or \term{udp}.
|
||||||
|
Default is \term{tcp}.
|
||||||
|
|
||||||
|
|
||||||
\makesubsubsection{listened-module}{Listening Module}
|
\makesubsubsection{listened-module}{Listening Module}
|
||||||
|
|
||||||
@ -789,6 +794,10 @@ The available modules, their purpose and the options allowed by each one are:
|
|||||||
(as defined in the Jabber Component Protocol (\xepref{0114}).\\
|
(as defined in the Jabber Component Protocol (\xepref{0114}).\\
|
||||||
Options: \texttt{access}, \texttt{hosts},
|
Options: \texttt{access}, \texttt{hosts},
|
||||||
\texttt{shaper}, \texttt{service\_check\_from}
|
\texttt{shaper}, \texttt{service\_check\_from}
|
||||||
|
\titem{\texttt{ejabberd\_stun}}
|
||||||
|
Handles STUN Binding requests as defined in
|
||||||
|
\footahref{http://tools.ietf.org/html/rfc5389}{RFC 5389}.\\
|
||||||
|
Options: \texttt{certfile}
|
||||||
\titem{\texttt{ejabberd\_http}}
|
\titem{\texttt{ejabberd\_http}}
|
||||||
Handles incoming HTTP connections.\\
|
Handles incoming HTTP connections.\\
|
||||||
Options: \texttt{captcha}, \texttt{certfile}, \texttt{http\_bind}, \texttt{http\_poll},
|
Options: \texttt{captcha}, \texttt{certfile}, \texttt{http\_bind}, \texttt{http\_poll},
|
||||||
@ -944,6 +953,7 @@ However, the c2s and s2s connections to the domain \term{example.com} use the fi
|
|||||||
and also allows plain connections for old clients.
|
and also allows plain connections for old clients.
|
||||||
\item Port 5223 listens for c2s connections with the old SSL.
|
\item Port 5223 listens for c2s connections with the old SSL.
|
||||||
\item Port 5269 listens for s2s connections with STARTTLS. The socket is set for IPv6 instead of IPv4.
|
\item Port 5269 listens for s2s connections with STARTTLS. The socket is set for IPv6 instead of IPv4.
|
||||||
|
\item Port 3478 listens for STUN requests over UDP.
|
||||||
\item Port 5280 listens for HTTP requests, and serves the HTTP Poll service.
|
\item Port 5280 listens for HTTP requests, and serves the HTTP Poll service.
|
||||||
\item Port 5281 listens for HTTP requests, and serves the Web Admin using HTTPS as explained in
|
\item Port 5281 listens for HTTP requests, and serves the Web Admin using HTTPS as explained in
|
||||||
section~\ref{webadmin}. The socket only listens connections to the IP address 127.0.0.1.
|
section~\ref{webadmin}. The socket only listens connections to the IP address 127.0.0.1.
|
||||||
@ -968,6 +978,7 @@ However, the c2s and s2s connections to the domain \term{example.com} use the fi
|
|||||||
{shaper, s2s_shaper},
|
{shaper, s2s_shaper},
|
||||||
{max_stanza_size, 131072}
|
{max_stanza_size, 131072}
|
||||||
]},
|
]},
|
||||||
|
{{3478, udp}, ejabberd_stun, []},
|
||||||
{5280, ejabberd_http, [
|
{5280, ejabberd_http, [
|
||||||
http_poll
|
http_poll
|
||||||
]},
|
]},
|
||||||
@ -1548,6 +1559,45 @@ Example configuration:
|
|||||||
]}.
|
]}.
|
||||||
\end{verbatim}
|
\end{verbatim}
|
||||||
|
|
||||||
|
\makesubsection{stun}{STUN}
|
||||||
|
\ind{options!stun}\ind{stun}
|
||||||
|
|
||||||
|
\ejabberd{} is able to act as a stand-alone STUN server
|
||||||
|
(\footahref{http://tools.ietf.org/html/rfc5389}{RFC 5389}). Currently only Binding usage
|
||||||
|
is supported. In that role \ejabberd{} helps clients with Jingle ICE (\xepref{0176}) support to discover their external addresses and ports.
|
||||||
|
|
||||||
|
You should configure \term{ejabberd\_stun} listening module as described in \ref{listened} section.
|
||||||
|
If \option{certfile} option is defined, \ejabberd{} multiplexes TCP and
|
||||||
|
TLS over TCP connections on the same port. Obviously, \option{certfile} option
|
||||||
|
is defined for \term{tcp} only. Note however that TCP or TLS over TCP
|
||||||
|
support is not required for Binding usage and is reserved for
|
||||||
|
\footahref{http://tools.ietf.org/html/draft-ietf-behave-turn-16}{TURN}
|
||||||
|
functionality. Feel free to configure \term{udp} transport only.
|
||||||
|
|
||||||
|
Example configuration:
|
||||||
|
\begin{verbatim}
|
||||||
|
{listen,
|
||||||
|
[
|
||||||
|
...
|
||||||
|
{{3478, udp}, ejabberd_stun, []},
|
||||||
|
{3478, ejabberd_stun, []},
|
||||||
|
{5349, ejabberd_stun, [{certfile, "/etc/ejabberd/server.pem"}]},
|
||||||
|
...
|
||||||
|
]
|
||||||
|
}.
|
||||||
|
\end{verbatim}
|
||||||
|
|
||||||
|
You also need to configure DNS SRV records properly so clients can easily discover a
|
||||||
|
STUN server serving your XMPP domain. Refer to section
|
||||||
|
\footahref{http://tools.ietf.org/html/rfc5389\#section-9}{DNS Discovery of a Server}
|
||||||
|
of \footahref{http://tools.ietf.org/html/rfc5389}{RFC 5389} for details.
|
||||||
|
|
||||||
|
Example DNS SRV configuration:
|
||||||
|
\begin{verbatim}
|
||||||
|
_stun._udp IN SRV 0 0 3478 stun.example.com.
|
||||||
|
_stun._tcp IN SRV 0 0 3478 stun.example.com.
|
||||||
|
_stuns._tcp IN SRV 0 0 5349 stun.example.com.
|
||||||
|
\end{verbatim}
|
||||||
|
|
||||||
\makesubsection{includeconfigfile}{Include Additional Configuration Files}
|
\makesubsection{includeconfigfile}{Include Additional Configuration Files}
|
||||||
\ind{options!includeconfigfile}\ind{includeconfigfile}
|
\ind{options!includeconfigfile}\ind{includeconfigfile}
|
||||||
|
@ -149,6 +149,11 @@
|
|||||||
%% }
|
%% }
|
||||||
%% ]},
|
%% ]},
|
||||||
|
|
||||||
|
%%
|
||||||
|
%% ejabberd_stun: Handles STUN Binding requests
|
||||||
|
%%
|
||||||
|
%%{{3478, udp}, ejabberd_stun, []},
|
||||||
|
|
||||||
{5280, ejabberd_http, [
|
{5280, ejabberd_http, [
|
||||||
%%{request_handlers,
|
%%{request_handlers,
|
||||||
%% [
|
%% [
|
||||||
|
Loading…
Reference in New Issue
Block a user