summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorlouiz’ <louiz@louiz.org>2017-05-22 11:20:21 +0200
committerlouiz’ <louiz@louiz.org>2017-05-23 11:45:59 +0200
commitd1dc7882797ae40c818d0cf397580aefad263296 (patch)
treec18e4c7e329a8b721570a7be517a7adb4f4eee52 /doc
parent3913e24ea3560b83c2def74d080e6910c10b6d2f (diff)
downloadbiboumi-d1dc7882797ae40c818d0cf397580aefad263296.tar.gz
biboumi-d1dc7882797ae40c818d0cf397580aefad263296.tar.bz2
biboumi-d1dc7882797ae40c818d0cf397580aefad263296.tar.xz
biboumi-d1dc7882797ae40c818d0cf397580aefad263296.zip
Better document the identd server
Diffstat (limited to 'doc')
-rw-r--r--doc/biboumi.1.rst16
1 files changed, 15 insertions, 1 deletions
diff --git a/doc/biboumi.1.rst b/doc/biboumi.1.rst
index 87b7bae..5396015 100644
--- a/doc/biboumi.1.rst
+++ b/doc/biboumi.1.rst
@@ -161,7 +161,21 @@ to IRC servers.
identd_port
-----------
-The TCP port on which to listen for identd queries. The default is the standard value: 113.
+The TCP port on which to listen for identd queries. The default is the
+standard value: 113. To be able to listen on this privileged port, biboumi
+needs to have certain capabilities: on linux, using systemd, this can be
+achieved by adding `AmbientCapabilities=CAP_NET_BIND_SERVICE` to the unit
+file. On other systems, other solutions exist, like the portacl module on
+FreeBSD.
+
+If biboumi’s identd server is properly started, it will receive queries from
+the IRC servers asking for the “identity” of each IRC connection made to it.
+Biboumi will answer with a hash of the JID that made the connection. This is
+useful for the IRC server to be able to distinguish the different users, and
+be able to deal with the absuses without having to simply ban the IP. Without
+this identd server, moderation is a lot harder, because all the different
+users of a single biboumi instance all share the same IP, and they can’t be
+distinguished by the IRC servers.
policy_directory
----------------