aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBadlop <badlop@process-one.net>2014-01-02 16:31:28 +0100
committerBadlop <badlop@process-one.net>2014-01-02 16:31:28 +0100
commit155c8bb29ae90b02b15d9334d35036d259a35b44 (patch)
tree256d5931c770f389b88737b81de829863867759d
parentFix auth verification in ejabberd_xmlrpc (thanks to Vicis) (diff)
Add some ejabberd_xmlrpc documentation, and link to full details
-rw-r--r--doc/guide.tex10
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/guide.tex b/doc/guide.tex
index 468faf009..46563561e 100644
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -890,6 +890,12 @@ The available modules, their purpose and the options allowed by each one are:
Handles incoming HTTP connections.\\
Options: \texttt{captcha}, \texttt{certfile}, \texttt{default\_host}, \texttt{http\_bind}, \texttt{http\_poll},
\texttt{request\_handlers}, \texttt{tls}, \texttt{tls\_compression}, \texttt{trusted\_proxies}, \texttt{web\_admin}\\
+ \titem{\texttt{ejabberd\_xmlrpc}}
+ Handles XML-RPC requests to execute ejabberd commands (\ref{eja-commands}).\\
+ Options: \texttt{access\_commands}, \texttt{maxsessions}, \texttt{timeout}.\\
+ You can find option explanations, example configuration in old and new format,
+ and example calls in several languages in the old
+ \footahref{https://raw.github.com/processone/ejabberd-contrib/master/ejabberd\_xmlrpc/README.txt}{ejabberd\_xmlrpc README.txt}
\end{description}
@@ -5130,9 +5136,9 @@ with a defined number and type of calling arguments and type of result
that is registered in the \term{ejabberd\_commands} service.
Those commands can be defined in any Erlang module and executed using any valid frontend.
-\ejabberd{} includes a frontend to execute \term{ejabberd commands}: the script \term{ejabberdctl}.
+\ejabberd{} includes two frontends to execute \term{ejabberd commands}: the script \term{ejabberdctl} (\ref{ejabberdctl})
+and the \term{ejabberd\_xmlrpc} listener (\ref{listened-module}).
Other known frontends that can be installed to execute ejabberd commands in different ways are:
-\term{ejabberd\_xmlrpc} (XML-RPC service),
\term{mod\_rest} (HTTP POST service),
\term{mod\_shcommands} (ejabberd WebAdmin page).