diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guide.html | 86 | ||||
| -rw-r--r-- | doc/guide.tex | 89 |
2 files changed, 147 insertions, 28 deletions
diff --git a/doc/guide.html b/doc/guide.html index fe22bbd91..f139dac6a 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -455,11 +455,23 @@ The following options are defined: <DT><CODE><B>ejabberd_service</B></CODE><DD> This module serves connections from Jabber services (i. e. that use the <TT>jabber:component:accept</TT> namespace). </DL> -For example, the following configuration defines that C2S connections are -listened on port 5222 and 5223 (SSL) and denied for user ``<TT>bad</TT>'', S2S -on port 5269, and that service <TT>conference.example.org</TT> must be -connected to port 8888 with a password ``<TT>secret</TT>''. Also all users -except admins have traffic limit 1000 b/s. +For example, the following configuration defines that: +<UL><LI> +C2S connections are listened on port 5222 and 5223 (SSL) and denied for + user ``<TT>bad</TT>'' +<LI>S2S connections are listened on port 5269 +<LI>All users except admins have traffic limit 1000 B/s +<LI>AIM service <TT>aim.example.org</TT> is connected to port 5233 with + password ``<TT>aimsecret</TT>'' +<LI>JIT services <TT>icq.example.org</TT> and <TT>sms.example.org</TT> are + connected to port 5234 with password ``<TT>jitsecret</TT>'' +<LI>MSN service <TT>msn.example.org</TT> is connected to port 5235 with + password ``<TT>msnsecret</TT>'' +<LI>YAHOO service <TT>yahoo.example.org</TT> is connected to port 5236 with + password ``<TT>yahoosecret</TT>'' +<LI>ILE service <TT>ile.example.org</TT> is connected to port 5237 with + password ``<TT>ilesecret</TT>'' +</UL> <PRE> {acl, blocked, {user, "bad"}}. {access, c2s, [{deny, blocked}, @@ -467,14 +479,62 @@ except admins have traffic limit 1000 b/s. {shaper, normal, {maxrate, 1000}}. {access, c2s_shaper, [{none, admin}, {normal, all}]}. -{listen, [{5222, ejabberd_c2s, [{access, c2s}, - {shaper, c2s_shaper}]}, - {5223, ejabberd_c2s, [{access, c2s}, - {ssl, [{certfile, "/path/to/ssl.pem"}]}]}, - {5269, ejabberd_s2s_in, []}, - {8888, ejabberd_service, - [{hosts, ["conference.example.org"], [{password, "secret"}]}]} - ]}. +{listen, + [{5222, ejabberd_c2s, [{access, c2s}, {shaper, c2s_shaper}]}, + {5223, ejabberd_c2s, [{access, c2s}, + ssl, {certfile, "/path/to/ssl.pem"}]}, + {5269, ejabberd_s2s_in, []}, + {5233, ejabberd_service, [{host, "aim.example.org", + [{password, "aimsecret"}]}]}, + {5234, ejabberd_service, [{hosts, ["icq.example.org", "sms.example.org"], + [{password, "jitsecret"}]}]}, + {5235, ejabberd_service, [{host, "msn.example.org", + [{password, "msnsecret"}]}]}, + {5236, ejabberd_service, [{host, "yahoo.example.org", + [{password, "yahoosecret"}]}]}, + {5237, ejabberd_service, [{host, "gg.example.org", + [{password, "ggsecret"}]}]}, + {5238, ejabberd_service, [{host, "ile.example.org", + [{password, "ilesecret"}]}]} + ] +}. +</PRE>Note, that for jabberd14- or wpjabberd-based services you need to make the +transports log and do xdb by themselves: +<PRE> + <!-- + You need to add elogger and rlogger entries here when using ejabberd. + In this case the transport will do the logging. + --> + + <log id='elogger'> + <host/> + <logtype/> + <format>%d: [%t] (%h): %s</format> + <file>/var/log/jabber/error/aim-t.log</file> + </log> + + <log id='rlogger'> + <host/> + <logtype>record</logtype> + <format>%d %h %s</format> + <file>/var/log/jabber/record/aim-t.log</file> + </log> + + <!-- + Some Jabber server implementations do not provide + XDB services (for example jabberd 2.0 and ejabberd). + AIM-t is loaded into handle all XDB requests. + --> + + <xdb id="xdb"> + <host/> + <load> + <xdb_file>/usr/lib/jabber/xdb_file.so</xdb_file> <!-- this is a lib of wpjabber or jabberd --> + </load> + <xdb_file xmlns="jabber:config:xdb_file"> + <spool><jabberd:cmdline flag='s'>/var/spool/jabber</jabberd:cmdline></spool> + </xdb_file> + </xdb> </PRE> <!--TOC subsubsection Modules--> diff --git a/doc/guide.tex b/doc/guide.tex index 7e980b3d9..1d9bbe9e0 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -437,11 +437,23 @@ Currently three modules are implemented: services (i.\,e.\ that use the \texttt{jabber:component:accept} namespace). \end{description} -For example, the following configuration defines that C2S connections are -listened on port 5222 and 5223 (SSL) and denied for user ``\texttt{bad}'', S2S -on port 5269, and that service \texttt{conference.example.org} must be -connected to port 8888 with a password ``\texttt{secret}''. Also all users -except admins have traffic limit 1000\,b/s. +For example, the following configuration defines that: +\begin{itemize} +\item C2S connections are listened on port 5222 and 5223 (SSL) and denied for + user ``\texttt{bad}'' +\item S2S connections are listened on port 5269 +\item All users except admins have traffic limit 1000\,B/s +\item AIM service \texttt{aim.example.org} is connected to port 5233 with + password ``\texttt{aimsecret}'' +\item JIT services \texttt{icq.example.org} and \texttt{sms.example.org} are + connected to port 5234 with password ``\texttt{jitsecret}'' +\item MSN service \texttt{msn.example.org} is connected to port 5235 with + password ``\texttt{msnsecret}'' +\item YAHOO service \texttt{yahoo.example.org} is connected to port 5236 with + password ``\texttt{yahoosecret}'' +\item ILE service \texttt{ile.example.org} is connected to port 5237 with + password ``\texttt{ilesecret}'' +\end{itemize} \begin{verbatim} {acl, blocked, {user, "bad"}}. {access, c2s, [{deny, blocked}, @@ -449,17 +461,64 @@ except admins have traffic limit 1000\,b/s. {shaper, normal, {maxrate, 1000}}. {access, c2s_shaper, [{none, admin}, {normal, all}]}. -{listen, [{5222, ejabberd_c2s, [{access, c2s}, - {shaper, c2s_shaper}]}, - {5223, ejabberd_c2s, [{access, c2s}, - ssl, {certfile, "/path/to/ssl.pem"}]}, - {5269, ejabberd_s2s_in, []}, - {8888, ejabberd_service, - [{hosts, ["conference.example.org"], [{password, "secret"}]}]} - ]}. +{listen, + [{5222, ejabberd_c2s, [{access, c2s}, {shaper, c2s_shaper}]}, + {5223, ejabberd_c2s, [{access, c2s}, + ssl, {certfile, "/path/to/ssl.pem"}]}, + {5269, ejabberd_s2s_in, []}, + {5233, ejabberd_service, [{host, "aim.example.org", + [{password, "aimsecret"}]}]}, + {5234, ejabberd_service, [{hosts, ["icq.example.org", "sms.example.org"], + [{password, "jitsecret"}]}]}, + {5235, ejabberd_service, [{host, "msn.example.org", + [{password, "msnsecret"}]}]}, + {5236, ejabberd_service, [{host, "yahoo.example.org", + [{password, "yahoosecret"}]}]}, + {5237, ejabberd_service, [{host, "gg.example.org", + [{password, "ggsecret"}]}]}, + {5238, ejabberd_service, [{host, "ile.example.org", + [{password, "ilesecret"}]}]} + ] +}. +\end{verbatim} +Note, that for jabberd14- or wpjabberd-based services you need to make the +transports log and do xdb by themselves: +\begin{verbatim} + <!-- + You need to add elogger and rlogger entries here when using ejabberd. + In this case the transport will do the logging. + --> + + <log id='elogger'> + <host/> + <logtype/> + <format>%d: [%t] (%h): %s</format> + <file>/var/log/jabber/error/aim-t.log</file> + </log> + + <log id='rlogger'> + <host/> + <logtype>record</logtype> + <format>%d %h %s</format> + <file>/var/log/jabber/record/aim-t.log</file> + </log> + + <!-- + Some Jabber server implementations do not provide + XDB services (for example jabberd 2.0 and ejabberd). + AIM-t is loaded into handle all XDB requests. + --> + + <xdb id="xdb"> + <host/> + <load> + <xdb_file>/usr/lib/jabber/xdb_file.so</xdb_file> <!-- this is a lib of wpjabber or jabberd --> + </load> + <xdb_file xmlns="jabber:config:xdb_file"> + <spool><jabberd:cmdline flag='s'>/var/spool/jabber</jabberd:cmdline></spool> + </xdb_file> + </xdb> \end{verbatim} - - \subsubsection{Modules} |