<B><TT>all</TT></B><DD> Always return ``<TT>allow</TT>''
<DT><B><TT>none</TT></B><DD> Always return ``<TT>deny</TT>''
</DL>
+<!--TOC subsubsection Shapers Configuration-->
+
+<H4><A NAME="htoc11">3.1.3</A> Shapers Configuration</H4><!--SEC END -->
+
+<A NAME="sec:configshaper"></A>
+With shapers is possible to bound connection traffic. The declarations of
+shapers in config file have following syntax:
+<PRE>
+{shaper, <shapername>, <kind>}.
+</PRE>Currently implemented only one kind of shaper: <TT>maxrate</TT>. It have
+following syntax:
+<PRE>
+{maxrate, <rate>}
+</PRE>where <TT><rate></TT> means maximum allowed incomig rate in bytes/second.
+E. g. to define shaper with name ``<TT>normal</TT>'' and maximum allowed rate
+1000 bytes/s, add following line in config:
+<PRE>
+{shaper, normal, {maxrate, 1000}}.
+</PRE>
<!--TOC subsubsection Listened Sockets-->
-<H4><A NAME="htoc11">3.1.3</A> Listened Sockets</H4><!--SEC END -->
+<H4><A NAME="htoc12">3.1.4</A> Listened Sockets</H4><!--SEC END -->
<A NAME="sec:configlistened"></A>
Option <TT>listen</TT> defines list of listened sockets and what services
<DL COMPACT=compact><DT>
<B><TT>{access, <access rule>}</TT></B><DD> This option defines access of users
to this C2S port. Default value is ``<TT>all</TT>''.
+ <DT><B><TT>{shaper, <access rule>}</TT></B><DD> This option is like previous, but
+ use shapers instead of ``<TT>allow</TT>'' and ``<TT>deny</TT>''. Default
+ value is ``<TT>none</TT>''.
</DL>
<DT><B><TT>ejabberd_s2s_in</TT></B><DD> This module serves incoming S2S connections.
<DT><B><TT>ejabberd_service</TT></B><DD> This module serves connections to Jabber
For example, the following configuration defines that C2S connections are
listened on port 5222 and denied for user ``<TT>bad</TT>'', S2S on port 5269
and that service <TT>conference.jabber.org</TT> must be connected to port 8888
-with a password ``<TT>secret</TT>''.
+with a password ``<TT>secret</TT>''. Also all users except admins have traffic
+limit 1000 b/s.
<PRE>
{acl, blocked, {user, "bad"}}.
{access, c2s, [{deny, blocked},
{allow, all}]}.
-{listen, [{5222, ejabberd_c2s, start, [{access, c2s}]},
+{shaper, normal, {maxrate, 1000}}.
+{access, c2s_shaper, [{none, admin},
+ {normal, all}]}.
+{listen, [{5222, ejabberd_c2s, start, [{access, c2s},
+ {shaper, c2s_shaper}]},
{5269, ejabberd_s2s_in, start, []},
{8888, ejabberd_service, start,
[{host, "conference.jabber.org", [{password, "secret"}]}]}
</PRE>
<!--TOC subsubsection Modules-->
-<H4><A NAME="htoc12">3.1.4</A> Modules</H4><!--SEC END -->
+<H4><A NAME="htoc13">3.1.5</A> Modules</H4><!--SEC END -->
<A NAME="sec:configmodules"></A>
Option <TT>modules</TT> defines the list of modules that will be loaded after
</PRE>
<!--TOC subsection Online Configuration and Monitoring-->
-<H3><A NAME="htoc13">3.2</A> Online Configuration and Monitoring</H3><!--SEC END -->
+<H3><A NAME="htoc14">3.2</A> Online Configuration and Monitoring</H3><!--SEC END -->
<A NAME="sec:onlineconfig"></A>
To perform online reconfiguration of <TT>ejabberd</TT> you will need to have
<DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
<!--TOC subsubsection Node <TT>config</TT>: Global Configuration-->
-<H4><A NAME="htoc14">3.2.1</A> Node <TT>config</TT>: Global Configuration</H4><!--SEC END -->
+<H4><A NAME="htoc15">3.2.1</A> Node <TT>config</TT>: Global Configuration</H4><!--SEC END -->
Under this node the following nodes exists:<BR>
<BR>
<BR>
<!--TOC subsubsection Node <TT>online users</TT>: List of Online Users-->
-<H4><A NAME="htoc15">3.2.2</A> Node <TT>online users</TT>: List of Online Users</H4><!--SEC END -->
+<H4><A NAME="htoc16">3.2.2</A> Node <TT>online users</TT>: List of Online Users</H4><!--SEC END -->
<!--TOC subsubsection Node <TT>all users</TT>: List of Registered User-->
-<H4><A NAME="htoc16">3.2.3</A> Node <TT>all users</TT>: List of Registered User</H4><!--SEC END -->
+<H4><A NAME="htoc17">3.2.3</A> Node <TT>all users</TT>: List of Registered User</H4><!--SEC END -->
<BLOCKQUOTE><DIV ALIGN=center><DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV>
<DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
<!--TOC subsubsection Node <TT>outgoing s2s</TT>: List of Outgoing S2S connections-->
-<H4><A NAME="htoc17">3.2.4</A> Node <TT>outgoing s2s</TT>: List of Outgoing S2S connections</H4><!--SEC END -->
+<H4><A NAME="htoc18">3.2.4</A> Node <TT>outgoing s2s</TT>: List of Outgoing S2S connections</H4><!--SEC END -->
<!--TOC subsubsection Node <TT>running nodes</TT>: List of Running <TT>ejabberd</TT> Nodes-->
-<H4><A NAME="htoc18">3.2.5</A> Node <TT>running nodes</TT>: List of Running <TT>ejabberd</TT> Nodes</H4><!--SEC END -->
+<H4><A NAME="htoc19">3.2.5</A> Node <TT>running nodes</TT>: List of Running <TT>ejabberd</TT> Nodes</H4><!--SEC END -->
<BLOCKQUOTE><DIV ALIGN=center><DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV>
<DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE>
<!--TOC subsubsection Node <TT>stopped nodes</TT>: List of Stopped Nodes-->
-<H4><A NAME="htoc19">3.2.6</A> Node <TT>stopped nodes</TT>: List of Stopped Nodes</H4><!--SEC END -->
+<H4><A NAME="htoc20">3.2.6</A> Node <TT>stopped nodes</TT>: List of Stopped Nodes</H4><!--SEC END -->
TBD<BR>
<BR>
<!--TOC section Distribution-->
-<H2><A NAME="htoc20">4</A> Distribution</H2><!--SEC END -->
+<H2><A NAME="htoc21">4</A> Distribution</H2><!--SEC END -->
<A NAME="sec:distribution"></A>
<!--TOC subsection How it works-->
-<H3><A NAME="htoc21">4.1</A> How it works</H3><!--SEC END -->
+<H3><A NAME="htoc22">4.1</A> How it works</H3><!--SEC END -->
<A NAME="sec:howitworks"></A>
A Jabber domain is served by one or more <TT>ejabberd</TT> nodes. These nodes can
</UL>
<!--TOC subsubsection Router-->
-<H4><A NAME="htoc22">4.1.1</A> Router</H4><!--SEC END -->
+<H4><A NAME="htoc23">4.1.1</A> Router</H4><!--SEC END -->
This module is the main router of Jabber packets on each node. It routes
them based on their destinations domains. It has two tables: local and global
<BR>
<!--TOC subsubsection Local Router-->
-<H4><A NAME="htoc23">4.1.2</A> Local Router</H4><!--SEC END -->
+<H4><A NAME="htoc24">4.1.2</A> Local Router</H4><!--SEC END -->
This module routes packets which have a destination domain equal to this server
name. If destination JID has a node, then it routed to the session manager,
<BR>
<!--TOC subsubsection Session Manager-->
-<H4><A NAME="htoc24">4.1.3</A> Session Manager</H4><!--SEC END -->
+<H4><A NAME="htoc25">4.1.3</A> Session Manager</H4><!--SEC END -->
This module routes packets to local users. It searches for what user resource
packet must be sended via presence table. If this resource is connected to
<BR>
<!--TOC subsubsection S2S Manager-->
-<H4><A NAME="htoc25">4.1.4</A> S2S Manager</H4><!--SEC END -->
+<H4><A NAME="htoc26">4.1.4</A> S2S Manager</H4><!--SEC END -->
This module routes packets to other Jabber servers. First, it checks if an
open S2S connection from the domain of the packet source to the domain of
<BR>
<!--TOC section Built-in Modules-->
-<H2><A NAME="htoc26">A</A> Built-in Modules</H2><!--SEC END -->
+<H2><A NAME="htoc27">A</A> Built-in Modules</H2><!--SEC END -->
<A NAME="sec:modules"></A>
<!--TOC subsection Common Options-->
-<H3><A NAME="htoc27">A.1</A> Common Options</H3><!--SEC END -->
+<H3><A NAME="htoc28">A.1</A> Common Options</H3><!--SEC END -->
<A NAME="sec:modcommonopts"></A>
Following options used by many modules, so they described in separate section.<BR>
<BR>
<!--TOC subsubsection Option <TT>iqdisc</TT>-->
-<H4><A NAME="htoc28">A.1.1</A> Option <TT>iqdisc</TT></H4><!--SEC END -->
+<H4><A NAME="htoc29">A.1.1</A> Option <TT>iqdisc</TT></H4><!--SEC END -->
Many modules define handlers for processing IQ queries of different namespaces
to this server or to user (e. g. to <TT>myjabber.org</TT> or to
</PRE>
<!--TOC subsubsection Option <TT>host</TT>-->
-<H4><A NAME="htoc29">A.1.2</A> Option <TT>host</TT></H4><!--SEC END -->
+<H4><A NAME="htoc30">A.1.2</A> Option <TT>host</TT></H4><!--SEC END -->
Some modules may act as services, and wants to have different domain name.
This option explicitly defines this name.<BR>
</PRE>
<!--TOC subsection <TT>mod_register</TT>-->
-<H3><A NAME="htoc30">A.2</A> <TT>mod_register</TT></H3><!--SEC END -->
+<H3><A NAME="htoc31">A.2</A> <TT>mod_register</TT></H3><!--SEC END -->
<A NAME="sec:modregister"></A>
<!--TOC subsection <TT>mod_roster</TT>-->
-<H3><A NAME="htoc31">A.3</A> <TT>mod_roster</TT></H3><!--SEC END -->
+<H3><A NAME="htoc32">A.3</A> <TT>mod_roster</TT></H3><!--SEC END -->
<A NAME="sec:modroster"></A>
<!--TOC subsection <TT>mod_configure</TT>-->
-<H3><A NAME="htoc32">A.4</A> <TT>mod_configure</TT></H3><!--SEC END -->
+<H3><A NAME="htoc33">A.4</A> <TT>mod_configure</TT></H3><!--SEC END -->
<A NAME="sec:modconfigure"></A>
<!--TOC subsection <TT>mod_disco</TT>-->
-<H3><A NAME="htoc33">A.5</A> <TT>mod_disco</TT></H3><!--SEC END -->
+<H3><A NAME="htoc34">A.5</A> <TT>mod_disco</TT></H3><!--SEC END -->
<A NAME="sec:moddisco"></A>
<!--TOC subsection <TT>mod_stats</TT>-->
-<H3><A NAME="htoc34">A.6</A> <TT>mod_stats</TT></H3><!--SEC END -->
+<H3><A NAME="htoc35">A.6</A> <TT>mod_stats</TT></H3><!--SEC END -->
<A NAME="sec:modstats"></A>
This module adds support of
<BR>
<!--TOC subsection <TT>mod_vcard</TT>-->
-<H3><A NAME="htoc35">A.7</A> <TT>mod_vcard</TT></H3><!--SEC END -->
+<H3><A NAME="htoc36">A.7</A> <TT>mod_vcard</TT></H3><!--SEC END -->
<A NAME="sec:modvcard"></A>
<!--TOC subsection <TT>mod_offline</TT>-->
-<H3><A NAME="htoc36">A.8</A> <TT>mod_offline</TT></H3><!--SEC END -->
+<H3><A NAME="htoc37">A.8</A> <TT>mod_offline</TT></H3><!--SEC END -->
<A NAME="sec:modoffline"></A>
<!--TOC subsection <TT>mod_echo</TT>-->
-<H3><A NAME="htoc37">A.9</A> <TT>mod_echo</TT></H3><!--SEC END -->
+<H3><A NAME="htoc38">A.9</A> <TT>mod_echo</TT></H3><!--SEC END -->
<A NAME="sec:modecho"></A>
<!--TOC subsection <TT>mod_private</TT>-->
-<H3><A NAME="htoc38">A.10</A> <TT>mod_private</TT></H3><!--SEC END -->
+<H3><A NAME="htoc39">A.10</A> <TT>mod_private</TT></H3><!--SEC END -->
<A NAME="sec:modprivate"></A>
This module adds support of
</DL>
<!--TOC subsection <TT>mod_time</TT>-->
-<H3><A NAME="htoc39">A.11</A> <TT>mod_time</TT></H3><!--SEC END -->
+<H3><A NAME="htoc40">A.11</A> <TT>mod_time</TT></H3><!--SEC END -->
<A NAME="sec:modtime"></A>
This module answers UTC time on <TT>jabber:iq:time</TT> queries.<BR>
</DL>
<!--TOC subsection <TT>mod_version</TT>-->
-<H3><A NAME="htoc40">A.12</A> <TT>mod_version</TT></H3><!--SEC END -->
+<H3><A NAME="htoc41">A.12</A> <TT>mod_version</TT></H3><!--SEC END -->
<A NAME="sec:modversion"></A>
This module answers <TT>ejabberd</TT> version on <TT>jabber:iq:version</TT> queries.<BR>
</DL>
<!--TOC section I18n/L10n-->
-<H2><A NAME="htoc41">B</A> I18n/L10n</H2><!--SEC END -->
+<H2><A NAME="htoc42">B</A> I18n/L10n</H2><!--SEC END -->
<A NAME="sec:i18nl10n"></A>
Many modules supports <TT>xml:lang</TT> attribute inside IQ queries. E. g.
\end{description}
+
+\subsubsection{Shapers Configuration}
+\label{sec:configshaper}
+
+With shapers is possible to bound connection traffic. The declarations of
+shapers in config file have following syntax:
+\begin{verbatim}
+{shaper, <shapername>, <kind>}.
+\end{verbatim}
+Currently implemented only one kind of shaper: \texttt{maxrate}. It have
+following syntax:
+\begin{verbatim}
+{maxrate, <rate>}
+\end{verbatim}
+where \texttt{<rate>} means maximum allowed incomig rate in bytes/second.
+E.\,g.\ to define shaper with name ``\texttt{normal}'' and maximum allowed rate
+1000\,bytes/s, add following line in config:
+\begin{verbatim}
+{shaper, normal, {maxrate, 1000}}.
+\end{verbatim}
+
+
+
+
\subsubsection{Listened Sockets}
\label{sec:configlistened}
\begin{description}
\item[\texttt{\{access, <access rule>\}}] This option defines access of users
to this C2S port. Default value is ``\texttt{all}''.
+ \item[\texttt{\{shaper, <access rule>\}}] This option is like previous, but
+ use shapers instead of ``\texttt{allow}'' and ``\texttt{deny}''. Default
+ value is ``\texttt{none}''.
\end{description}
\item[\texttt{ejabberd\_s2s\_in}] This module serves incoming S2S connections.
\item[\texttt{ejabberd\_service}] This module serves connections to \Jabber{}
For example, the following configuration defines that C2S connections are
listened on port 5222 and denied for user ``\texttt{bad}'', S2S on port 5269
and that service \texttt{conference.jabber.org} must be connected to port 8888
-with a password ``\texttt{secret}''.
-
+with a password ``\texttt{secret}''. Also all users except admins have traffic
+limit 1000\,b/s.
\begin{verbatim}
{acl, blocked, {user, "bad"}}.
{access, c2s, [{deny, blocked},
{allow, all}]}.
-{listen, [{5222, ejabberd_c2s, start, [{access, c2s}]},
+{shaper, normal, {maxrate, 1000}}.
+{access, c2s_shaper, [{none, admin},
+ {normal, all}]}.
+{listen, [{5222, ejabberd_c2s, start, [{access, c2s},
+ {shaper, c2s_shaper}]},
{5269, ejabberd_s2s_in, start, []},
{8888, ejabberd_service, start,
[{host, "conference.jabber.org", [{password, "secret"}]}]}
-
\subsubsection{Modules}
\label{sec:configmodules}
projects / ejabberd / commitdiff