View source for Enable Mibbit on Your IRC Server

{{articles}}

If you own an IRC server, and would like to enable people to access it from Mibbit without issues, it's simple to get set up.

First of all, anyone who uses Mibbit connects from one of our four IP address to your IRC server. This needs to be handled by the IRC server. The default setup for most IRC servers is to only allow 3 or so connections from any single IP, which means that only 3 .. 12 Mibbitians would be able to connect to the server. There are two solutions to this: WebIRC (<span style="color:darkgreen;">best</span>) or a trust/session increase.

== Mibbit IP addresses ==

{| class="wikitable"
|-
!IP
!rDNS
|-
!{{Template:Mibbit_WIDGET1_IP}}
|ircip1.mibbit.com
|-
!{{Template:Mibbit_IP}} 
|ircip2.mibbit.com
|-
!{{Template:MibbitIP3}}
|ircip3.mibbit.com
|-
!{{Template:MibbitIP4}}
|ircip4.mibbit.com
|}

{{Notice|Advanced:  If you would like to automatically generate your own IRCd configurations using a script of some form either for remote include or other method depending on your IRCd you will be able to find all current Mibbit WEBIRC IPs in the ircip.mibbit.com round robin host name (last change was in 2010).  If you don't know what this means, don't ask, just skip it.}}

== WebIRC/CGI:IRC Blocks ==

The [[webirc]] protocol allows Mibbit to send over the users real IP address and hostname to the IRC server. This means that cloaks, and bans, and all other hostname/IP based things work exactly as they should. When you whois the user, it'll look like they are connecting directly from their own IP, and not through Mibbit.
This is also known as a ''cgiirc{}'' block on some servers.
This is the best method of having Mibbit connect to your network seamlessly.

{{:Setup webirc}}

=== Unrealircd ===
Config location and syntax have changed in v. 4.x, see https://www.unrealircd.org/docs/WebIRC_block for details.

UnrealIRCd old cgiirc block setup/configuration example (Requires [http://www.unrealircd.com/downloads.php UnrealIRCd 3.2.5] or higher):
 // Datacenter one :
 cgiirc {
        type webirc;
        hostname {{Template:Mibbit_IP}};
        password <cgiirc_pw>; // no spaces, no <> brackets around cgiirc_pw!
 };
 // Datacenter two:
 cgiirc {
        type webirc;
        hostname {{Template:Mibbit_WIDGET1_IP}};
        password <password>; // same as above!
 };
 // Datacenter three:
 cgiirc {
        type webirc;
        hostname {{Template:MibbitIP3}};
        password <password>; // same as above!
 };
 // Datacenter four:
 cgiirc {
        type webirc;
        hostname {{Template:MibbitIP4}};
        password <password>; // same as above!
 };

'''Note:''' UnrealIRCd versions between 3.2.5 to 3.2.7 have cgiirc block bugs in IPv6 compiles of UnrealIRCd, [http://bugs.unrealircd.org/view.php?id=3163 Patch available here], this issue however is resolved in version 3.2.8 and up.

Read the [http://www.unrealircd.com/files/docs/unreal32docs.html#cgiirc CGI:IRC Block documentation] for more information on cgiirc blocks.<br />

'''After''' updating your configuration please '''rehash''' and let us know the information requested [[#WebIRC/CGI:IRC Blocks|above]].

=== Inspircd ===
<!-- [[IRCd Config/Inspircd1.1|Inspircd1.1]] example -->
These are instructions for how to configure an InspIRCd installation.

1.) Locate the cgiirc module in the modules.conf (or inspircd.conf) called m_cgiirc.so<br />Look for <pre><module name="m_cgiirc.so"></pre> and uncomment it.

2.) Locate the cgihost tag below and configure as follows:
:* Choose type as Webirc
:* In the ''password'' attribute, replace <password> with the password you chose.
:* In the ''mask'' attribute, enter our IP addresses ({{Mibbit_IP}}, {{Mibbit_WIDGET1_IP}}, {{MibbitIP3}}, {{MibbitIP4}})<br />Note: In some cases its been reported that connection from mibbit users were not resolved to the correct address. In some cases this can be fixed by setting the mask to "*". Try it only as last resort.
: Your cgihost should look like this:
::'''&lt;cgihost type="webirc" password="<password>" mask="{{Mibbit_IP}}"&gt;'''
::'''&lt;cgihost type="webirc" password="<password>" mask="{{Mibbit_WIDGET1_IP}}"&gt;'''
::'''&lt;cgihost type="webirc" password="<password>" mask="{{MibbitIP3}}"&gt;'''
::'''&lt;cgihost type="webirc" password="<password>" mask="{{MibbitIP4}}"&gt;'''
NO <> brackets around password!

3.) Locate your connection block and add an additional block as follows (Inspircd '''1.*'''):

 &lt;connect 
    allow="{{Mibbit_IP}}" 
    allow="{{Mibbit_WIDGET1_IP}}"
    allow="{{MibbitIP3}}" 
    allow="{{MibbitIP4}}" 
    timeout="60" 
    flood="10" 
    pingfreq="120"
    threshold="5" 
    sendq="131074"
    recvq="4096"
    globalmax="30"
    localmax="30"
    port="6667"&gt;

Inspircd '''2.0+''' seems to require '''separate <connect allow="...>''' lines, see their docs.

'''<span style="color:red;">Warning</span>''': if '''all''' mibbitians get the '''same''' Mibbit@ircip*.mibbit.com (or the obfuscated version) as ident@host after the changes, you need to '''reload the cgiirc module''' (after '''every''' change, even if they claim the bug was fixed). A password mismatch results in the same "bad host" issue. No "invalid password" error message is sent to us! You might see something like "user tried to use WEBIRC, but didn't match any configured webirc blocks" in your server logs.

The major difference from your normal &lt;connect&gt; block should be the ''allow'' parameter and the ''globalmax'' and ''localmax''. The reason for these changes is so that the server does not identify several users of mibbit as coming from the same IP and then raises a session exceeded error.

If you are having problems getting the module to work, try rehashing and reloading the module after configuration changes.  The easiest way to do this is by rehashing, then issuing the command "/reloadmodule m_cgiirc.so". Sometimes only a server restart helps.

For more information see InspIRCd m_cgiirc documentation

Then let us know the information requested [[#WebIRC/CGI:IRC Blocks|above]].

===Nefarious===
If F:CRYPT_OPER_PASSWORD is set to TRUE (default) you will need to use "/mkpasswd <password>" to crypt the password before adding it to the W:Line. If F:CRYPT_OPER_PASSWORD is set to FALSE then you will have to put the password in the W:Line in plain text.

To check the version and revision use "/version" or "/quote version" depending on your IRC client and then look for:
 u2.10.11.07+Nefarious(<version>)+[<revision> <date>].

Sample config for Nefarious 1.3:
 WebIRC {
   mask = "*@{{Template:Mibbit_IP}}";
   pass = "<password>";
   flags = "s";
   ident = "mibbit";
   desc = "Mibbit";
 };
 WebIRC {
   mask = "*@{{Template:Mibbit_WIDGET1_IP}}";
   pass = "<password>";
   flags = "s";
   ident = "mibbit";
   desc = "Mibbit";
 };
 WebIRC {
   mask = "*@{{Template:MibbitIP3}}";
   pass = "<password>";
   flags = "s";
   ident = "mibbit";
   desc = "Mibbit";
 };
 WebIRC {
   mask = "*@{{Template:MibbitIP4}}";
   pass = "<password>";
   flags = "s";
   ident = "mibbit";
   desc = "Mibbit";
 };

Sample config for Nefarious 2.0:
 WebIRC {
  host = "*@{{Template:Mibbit_IP}}";
  password = "<password>";
  ident = "mibbit";
  description = "Mibbit";
 };
 WebIRC {
  host = "*@{{Template:Mibbit_WIDGET1_IP}}";
  password = "<password>";
  ident = "mibbit";
  description = "Mibbit";
 };
 WebIRC {
  host = "*@{{Template:MibbitIP3}}";
  password = "<password>";
  ident = "mibbit";
  description = "Mibbit";
 };
 WebIRC {
  host = "*@{{Template:MibbitIP4}}";
  password = "<password>";
  ident = "mibbit";
  description = "Mibbit";
 };
mask = "*@*.mibbit.com"; may be neccessary (encrypted passwords could result in a "WEBIRC Password invalid for your host" error).

Then let us know the information requested [[#WebIRC/CGI:IRC Blocks|above]].

===Charybdis===
(tested with Charybdis-3.1.0)
 # Enable the webirc module:
 loadmodule "extensions/m_webirc.so";
 # Place it were it belongs.
 auth {
        # Mibbit one      
        user = "*@{{Template:Mibbit_IP}}";
        # Mibbit two
        user = "*@{{Template:Mibbit_WIDGET1_IP}}";
        # Mibbit three        
        user = "*@{{Template:MibbitIP3}}";
        # Mibbit four        
        user = "*@{{Template:MibbitIP4}}";
        # Place here your password (default: unencrypted).
        password = "<password>"; 
        # The line below makes care that
        # Charybdis understands this is the webirc module.
        spoof = "webirc.";
        # The class.
        class = "users";
 };
 # NO <> brackets around password!
Always check your config with the following command (path to your charybdis installation)/bin/ircd -conftest to make sure it loads the module correctly and your config is intact. Anyways, if that succeeds it shows:   notice: loading module extensions/m_webirc.so ...

Then let us know the information requested [[#WebIRC/CGI:IRC Blocks|above]].

=== RatboxIRCd===
Example RatboxIRCd cgiirc block setup/configuration (Requires [http://www.ircd-ratbox.org/download.shtml RatboxIRCd 3.0.x] or higher):
 // For all datacenters :
 auth {
         user = "cgiirc@{{Template:Mibbit_IP}}";     
         user = "cgiirc@{{Template:Mibbit_WIDGET1_IP}}";     
         user = "cgiirc@{{Template:MibbitIP3}}";     
         user = "cgiirc@{{Template:MibbitIP4}}";     
         password = "<password>";
         spoof = "webirc.";
         class = "users";
 };
 // NO <> brackets around password!
 // The above needs to be before the following existing lines in your config
 auth {
    user = "*@*";
    class = "users";
 };

'''Note:''' The m_webirc.c module is not installed by default. Compile the m_webirc.c module, then '''loadmod contribs/m_webirc.so'''. See the output similar to '''*** Notice -- Module m_webirc.so [version: $Revision: 26401 $; MAPI version: 1] loaded at 0x29e3c580'''.

Then let us know the information requested [[#WebIRC/CGI:IRC Blocks|above]].

===Hybrid===
This section applies to [http://ircd-hybrid.org/ ircd-hybrid-8]


Back-story & credit:

While attempting to support webirc for ircd-hybrid I discovered that the module linked by this page no longer compiled properly for the current stable release (as of this writing 7.2.3). After a bit of time with Google I discovered [http://code.freequest.net/2007/04/13/cgiirc-and-ircd-hybrid-and-more/ this article]. 
*ircd-hybrid Initial help by The_Spider (irc.smoothnet.org)


To compile:

* Download the [http://files.freequest.net/software/hybrid-modules/m_webirc.c m_webirc.c] module and place it in the contrib folder.
* Modify 'Makefile' (not .in, also located in the contrib folder) by adding the line between any line at 34-48:
  m_webirc.c \
* Follow normal installation instructions.(Don't forget to 'make install' in the contrib folder after you configure the main branch. Otherwise none of the modules there will be compiled and installed)


Configuration:

Modify the proper sections of your ircd.conf to reflect the following:
 // For all datacenters :
  auth {
    user = "*@{{Template:Mibbit_WIDGET1_IP}}";
    user = "*@{{Template:Mibbit_IP}}";
    user = "*@{{Template:MibbitIP3}}";
    user = "*@{{Template:MibbitIP4}}";
    password = "<password>";
    encrypted = no;
    spoof = "webirc.";
    class = "users";
    flags = exceed_limit, kline_exempt; //, webirc;??, see docs
  };
 // NO <> brackets around password!

 // The Mibbit webirc auth block has to be before your catch-all auth block,
 // since Hybrid will use the first auth block that matches.
 auth {
    user = "*@*";
    class = "users";
 };

 // The module should also be loaded after the auth block.
 module = "m_webirc.so";

* Remove an existing example gecos ban
** This prevents connection after a successful webirc conversion, generating a "Bad user info" ban.
*** After a successful webirc conversion, the RealName/GECOS is changed to "http://www.mibbit.com"
  gecos {
    name = "*http*";
    reason = "Spambot";
  };

As of posting, there is concern that host cloaking can override this module and render the host back to the original Mibbit IP. This can be seen as the user is presented with a clear message that webirc conversion was successful, yet /whois shows the host reverted. Disabling host cloaking does prove that the webirc process is working. This is not a recommendation to disable host cloaking. This was seen on hybrid-7.2.3+plexus-3.0.0(20070716_2-509

===Other===

The protocol is pretty simple. The first command sent to the server is:

 WEBIRC <password> cgiirc <hostname> <ip>
(NO <> brackets around password!)

The server then uses the hostname and ip for that connection.

== Trust/session limit increase ==

If webirc is unavailable, mibbit sends over the users IP address and hostname.
In the ident reply, we send the users IP address in hex form.
We also set the users realname to be their hostname.
If you use this method, you can ban individuals on their username.
You just need to increase the connection limit for the Mibbit IP, and please remember NOT to k-line/ban the whole of *.mibbit.com . Ban individuals instead.

Our IPs are {{Mibbit_IP}}, {{Mibbit_WIDGET1_IP}}, {{MibbitIP3}}, {{MibbitIP4}}.

=== Configuration examples ===
:*[[IRCd Config/Unreal3.2|Unreal3.2]]


[[Category:How To]][[Category:IRC]][[Category:Unreal]][[Category:Code]]