Bridges an irc channel to a jabber conference room.
jirc [\s-1OPTIONS\s0] --config \s-1CONFIG\s0
-C, --config CONFIG Load config file as specified by CONFIG -V, --version Report version of script -h, --help Show detailed documentation.
Specify the configuration file to load. Required.
Report the version of this script.
Show detailed documentation.
The jirc bot logs into an \s-1IRC\s0 channel and a Jabber conference room. It will relay conversations between the two rooms, identifying each of the speakers in braces ([]). Actions are forwarded as well.
There are some in-room commands that jirc responds to:
!help Display summary of available jirc commands. !who Display a list of people online on the other end of the bridge. !shutdown Immediately quit the rooms and shutdown.
The file specified with the --config option contains field/value pairs, one per line:
field: value
For example:
mode: production
The required configuration fields are:
Can be either \*(L"production\*(R" or \*(L"test\*(R". When running in \*(L"test\*(R" mode, the nicks and channel names all have \*(L"-test\*(R" appended to them so that jirc behavior can be tested in separate channel.
The \s-1IRC\s0 nickname to sign in with. Since this is a bridge, a short nick is recommended. To avoid confusion, it should match the jabber-alias.
The \s-1IDENT\s0 username to sign in with. Since this is a bridge, a short name is recommended. To avoid confusion, it should match the irc-nick.
The \s-1IRC\s0 Username to sign in with. Since this is a bridge, a description of the bridge and a contact email address is recommended.
The \s-1IRC\s0 channel to join; the \s-1IRC\s0 side of the bridge.
The \s-1IRC\s0 server to join.
The Jabber protocol to use, either \*(L"\s-1XMPP\s0\*(R" or \*(L"Legacy\*(R".
The Jabber identifier, in the form: NAME@SERVER/RESOURCE
Not all Jabber servers run on the same \s-1IP\s0 as the A record for their domain indicates. If your server runs like this, set the correct \s-1IP\s0 or hostname here. Note that jirc doesn't currently pay attention to \s-1SRV\s0 records.
The password for the Jabber \s-1ID\s0.
Set to \*(L"1\*(R" to allow the password to be sent over the wire in plaintext or not - you'll need this for some servers that don't support \s-1DIGEST-MD5\s0 with legacy authentication. (Default: 0)
How long to wait in seconds between disconnects before attempting a reconnect. (Default: 0)
The port to use for Jabber connections. This is normally 5222.
The name of the Jabber conference room to join, in the form ROOM@SERVER
The Jabber alias to use when joining the Jabber conference room. Since this is a bridge, a short nick is recommend. To avoid confusion, it should match the irc-nick.
The email address of this bot's owner.
The prefix used for the built-in in-room commands. This is normally \*(L"!\*(R".
Suppress bridging of status messages (joins, parts and presence changes). Normally 0.
The port to use for \s-1IRC\s0 connections. This is normally 6667.
How many seconds to wait until reconnecting after a missed \s-1IRC\s0 \*(L"\s-1TIME\s0\*(R" response. This is normally 60.
How many seconds between \*(L"\s-1TIME\s0\*(R" requests. This is normally 30.
When set to 1, this enables verbose debugging of the \s-1IRC\s0 side of communications. This is normally 0.
When set to 1, this enables verbose debugging of the Jabber side of communications. This is normally 0.
When set to 1, this enable verbose debugging of the general operation of the jirc bridge. This is normally 0.
Kees Cook <[email protected]>
Copyright 2005-2009 by Kees Cook <[email protected]>. This program is licensed under the terms of the \s-1GNU\s0 General Public License.