diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/biboumi.1.rst | 65 |
1 files changed, 35 insertions, 30 deletions
diff --git a/doc/biboumi.1.rst b/doc/biboumi.1.rst index 89f8627..03e8a36 100644 --- a/doc/biboumi.1.rst +++ b/doc/biboumi.1.rst @@ -98,21 +98,22 @@ The bare JID of the gateway administrator. This JID will have more privileges than other standard users, for example some administration ad-hoc commands will only be available to that JID. +If you need more than one administrator, separate them with a colon (:). + fixed_irc_server ---------------- If this option contains the hostname of an IRC server (for example irc.example.org), then biboumi will enforce the connexion to that IRC -server only. This means that a JID like ``#chan@biboumi.example.com`` must -be used instead of ``#chan%irc.example.org@biboumi.example.com``. In that -mode, the virtual channel (see `Connect to an IRC server`_) is not -available. The `%` character loses any meaning in the JIDs. It can appear -in the JID but will not be interpreted as a separator (thus the JID +server only. This means that a JID like ``#chan@biboumi.example.com`` +must be used instead of ``#chan%irc.example.org@biboumi.example.com``. The +`%` character loses any meaning in the JIDs. It can appear in the JID but +will not be interpreted as a separator (thus the JID ``#channel%hello@biboumi.example.com`` points to the channel named -``#channel%hello`` on the configured IRC server) This option can for example -be used by an administrator that just wants to let their users join their own -IRC server using an XMPP client, while forbidding access to any other IRC -server. +``#channel%hello`` on the configured IRC server) This option can for +example be used by an administrator that just wants to let their users +join their own IRC server using an XMPP client, while forbidding access to +any other IRC server. persistent_by_default --------------------- @@ -206,6 +207,8 @@ 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. +To disable the built-in identd, you may set identd_port to 0. + policy_directory ---------------- @@ -295,10 +298,6 @@ the two is based on the first character: by default, if the name starts with ``'#'`` or ``'&'`` (but this can be overridden by the server, using the ISUPPORT extension) then it’s a channel name, otherwise this is a nickname. -As a special case, the channel name can also be empty (for example -``%irc.example.com``), in that case this represents the virtual channel -provided by biboumi. See `Connect to an IRC server`_ for more details. - There is two ways to address an IRC user, using a local part like this: ``nickname`` % ``irc_server`` or by using the in-room address of the participant, like this: @@ -336,9 +335,6 @@ Examples: * ``irc.example.com@biboumi.example.com`` is the IRC server irc.example.com. -* ``%irc.example.com@biboumi.example.com`` is the virtual channel provided by - biboumi, for the IRC server irc.example.com. - Note: Some JIDs are valid but make no sense in the context of biboumi: @@ -362,16 +358,7 @@ Connect to an IRC server The connection to the IRC server is automatically made when the user tries to join any channel on that IRC server. The connection is closed whenever -the last channel on that server is left by the user. To be able to stay -connected to an IRC server without having to be in a real IRC channel, -biboumi provides a virtual channel on the jid -``%irc.example.com@biboumi.example.com``. For example if you want to join the -channel ``#foo`` on the server ``irc.example.com``, but you need to authenticate -to a bot of the server before you’re allowed to join it, you can first join -the room ``%irc.example.com@biboumi.example.com`` (this will effectively -connect you to the IRC server without joining any channel), then send your -authentication message to the user ``bot%irc.example.com@biboumi.example.com`` -and finally join the room ``#foo%irc.example.com@biboumi.example.com``. +the last channel on that server is left by the user. Roster ------ @@ -638,6 +625,17 @@ On a server JID (e.g on the JID chat.freenode.org@biboumi.example.com) - configure: Lets each user configure some options that applies to the concerned IRC server. The provided configuration form contains these fields: + + * Address: This address (IPv4, IPv6 or hostname) will be used, when + biboumi connects to this server. This is a very handy way to have a + custom name for a network, and be able to edit the address to use + if one endpoint for that server is dead, but continue using the same + JID. For example, a user could configure the server + “freenode@biboumi.example.com”, set “chat.freenode.net” in its + “Address” field, and then they would be able to use “freenode” as + the network name forever: if “chat.freenode.net” breaks for some + reason, it can be changed to “irc.freenode.org” instead, and the user + would not need to change all their bookmarks and settings. * Realname: The customized “real name” as it will appear on the user’s whois. This option is not available if biboumi is configured with realname_customization to false. @@ -649,10 +647,11 @@ On a server JID (e.g on the JID chat.freenode.org@biboumi.example.com) In encoding into UTF-8. If the conversion fails at some point, some characters will be replaced by the placeholders. * Out encoding: Currently ignored. - * After-connection IRC command: A raw IRC command that will be sent to - the server immediately after the connection has been successful. It - can for example be used to identify yourself using NickServ, with a - command like this: `PRIVMSG NickServ :identify PASSWORD`. + * After-connection IRC commands: Raw IRC commands that will be sent + one by one to the server immediately after the connection has been + successful. It can for example be used to identify yourself using + NickServ, with a command like this: `PRIVMSG NickServ :identify + PASSWORD`. * Ports: The list of TCP ports to use when connecting to this IRC server. This list will be tried in sequence, until the connection succeeds for one of them. The connection made on these ports will not use TLS, the @@ -671,6 +670,12 @@ On a server JID (e.g on the JID chat.freenode.org@biboumi.example.com) * SHA-1 fingerprint of the TLS certificate to trust: if you know the hash of the certificate that the server is supposed to use, and you only want to accept this one, set its SHA-1 hash in this field. + * Nickname: A nickname that will be used instead of the nickname provided + in the initial presence sent to join a channel. This can be used if the + user always wants to have the same nickname on a given server, and not + have to bother with setting that nick in all the bookmarks on that + server. The nickname can still manually be changed with a standard nick + change presence. * Server password: A password that will be sent just after the connection, in a PASS command. This is usually used in private servers, where you’re only allowed to connect if you have the password. Note that, although |