path: root/doc
diff options
authorFlorent Le Coz <>2014-06-24 20:47:07 +0200
committerFlorent Le Coz <>2014-06-24 13:56:44 +0200
commit39175e1ad6fe6507bbe2874c6ce413cbe9c3366e (patch)
treebfe9fda3354ccc0ba437cfa959349d3ce7ab1c76 /doc
parenta2d55e4bead65d211b1c84e3b2a2a55b70f852d8 (diff)
Little documentation update
Diffstat (limited to 'doc')
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/ b/doc/
index f3f1677..fb48d4b 100644
--- a/doc/
+++ b/doc/
@@ -39,6 +39,7 @@ The configuration file uses a simple format of the form
The hostname served by the XMPP gateway. This domain must be configured in
the XMPP server as an external component. See the manual for your XMPP
server for more information.
+ For prosody, see
`password` (mandatory)
@@ -76,6 +77,11 @@ log level without having to restart biboumi) by sending SIGUSR1 or SIGUSR2
+Biboumi acts as a server, it should be run as a daemon that lives in the
+background for as long as it is needed. Note that biboumi does not
+daemonize itself, this task should be done by your init system (SysVinit,
+systemd, upstart).
When started, biboumi connects, without encryption (see *SECURITY*), to the
local XMPP server on the port `5347` and authenticates with the provided
password. Biboumi then serves the configured `hostname`: this means that