diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/guide.tex | 77 |
1 files changed, 72 insertions, 5 deletions
diff --git a/doc/guide.tex b/doc/guide.tex index 71a9bc7ae..b1357f3e4 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -68,6 +68,7 @@ \newcommand{\modconfigure}{\module{mod\_configure}} \newcommand{\moddisco}{\module{mod\_disco}} \newcommand{\modecho}{\module{mod\_echo}} +\newcommand{\modhttpbind}{\module{mod\_http\_bind}} \newcommand{\modhttpfileserver}{\module{mod\_http\_fileserver}} \newcommand{\modirc}{\module{mod\_irc}} \newcommand{\modlast}{\module{mod\_last}} @@ -95,10 +96,13 @@ \newcommand{\modversion}{\module{mod\_version}} %% Contributed modules -\usepackage{ifthen} -\newboolean{modhttpbind} -\newcommand{\modhttpbind}{\module{mod\_http\_bind}} -\include{contributed_modules} +%\usepackage{ifthen} +%\newboolean{modhttpbind} +%\newcommand{\modhttpbind}{\module{mod\_http\_bind}} +%\include{contributed_modules} +% +% Then in the document you can input the partial tex file with: +%\ifthenelse{\boolean{modhttpbind}}{\input{mod_http_bind.tex}}{} %% Common options \newcommand{\iqdiscitem}[1]{\titem{iqdisc} \ind{options!iqdisc}This specifies @@ -2662,7 +2666,70 @@ Example: Mirror, mirror, on the wall, who is the most beautiful ]}. \end{verbatim} -\ifthenelse{\boolean{modhttpbind}}{\input{mod_http_bind.tex}}{} +\makesubsection{modhttpbind}{\modhttpbind{}} +\ind{modules!\modhttpbind{}}\ind{modhttpbind} + +This module implements XMPP over Bosh (formerly known as HTTP Binding) +as defined in \xepref{0124} and \xepref{0206}. +It extends ejabberd's built in HTTP service with a configurable +resource at which this service will be hosted. + +To use HTTP-Binding, enable the module: +\begin{verbatim} +{modules, + [ + ... + {mod_http_bind, []}, + ... +]}. +\end{verbatim} +and add \verb|http_bind| in the HTTP service. For example: +\begin{verbatim} +{listen, + [ + ... + {5280, ejabberd_http, [ + http_bind, + http_poll, + web_admin + ] + }, + ... +]}. +\end{verbatim} +With this configuration, the module will serve the requests sent to +\verb|http://example.org:5280/http-bind/| +Remember that this page is not designed to be used by web browsers, +it is used by Jabber clients that support XMPP over Bosh. + +If you want to set the service in a different URI path or use a different module, +you can configure it manually using the option \verb|request_handlers|. +For example: +\begin{verbatim} +{listen, + [ + ... + {5280, ejabberd_http, [ + {request_handlers, [{["http-bind"], mod_http_bind}]}, + http_poll, + web_admin + ] + }, + ... +]}. +\end{verbatim} + +The maximum inactivity period is by default 30 seconds. +This can be configured with the module option \term{max\_inactivity}. +For example, to set 50 seconds: +\begin{verbatim} +{modules, + [ + ... + {mod_http_bind, [ {max_inactivity, 50} ]}, + ... +]}. +\end{verbatim} \makesubsection{modhttpfileserver}{\modhttpfileserver{}} \ind{modules!\modhttpfileserver{}}\ind{modhttpfileserver} |