IRC Bouncer

From Dark Peak
Revision as of 18:09, 2 February 2016 by Caolan (talk | contribs) (Add section on Irssi)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

A bouncer is a kind of proxy server for IRC clients; it remains connected to your IRC networks even when your client is disconnected. This way, when your client next reconnects, you can receive private messages sent to you whilst disconnected, or even read conversations in channels that you would otherwise have missed whilst offline.

The bouncer web interface lives at https://irc.darkpeak.org/ and runs an instance of ZNC (http://wiki.znc.in/).

The bouncer IRC service is exposed on:

  • irc.darkpeak.org/6667 (non-SSL)
  • irc.darkpeak.org/6697 (SSL)

Configuring ZNC

Before you can start using the bouncer, you must first configure it for your account.

  • Log into to web interface at https://irc.darkpeak.org/ using your Dark Peak account credentials.
  • On the right-hand side, choose "Your Settings"
  • Fill in your usual IRC information (nickname, nickserv ident, real name, etc.)
  • Scroll down to the bottom of the page to find the "Save" button.

Here you can also configure the networks to which you would like to connect. By default, you get one preconfigured network for Freenode, with one preconfigured channel (our very own #darkpeak channel!) In order for the bouncer to connect to the network on your behalf, you must activate the network.

  • Choose "Edit" next to Freenode in the Networks table.
  • Ensure that "Active" check box is checked.
  • Scroll down to the bottom of the page to find the "Save" button.

The bouncer will now connect to Freenode on your behalf and join all your preconfigured channels.

Configuring Your IRC Client

Now you may configure your IRC client to connect to the bouncer instead of Freenode directly.

XChat

Network List Dialogue
Edit Network Dialogue
  • Hit ctrl+s to open the "Network List" dialogue
  • Click the Add button to create a new network, give it a name and hit enter (see left-hand screenshot)
  • Click the Edit button to open the "Edit Network" dialogue and configure the newly created network
  • Click the Edit button to enter the correct IRC server/port value of irc.darkpeak.org/6697
  • Uncheck the Use global user information option
  • In the User name field, use a value of username/network, where "username" is your Dark Peak username and "network" is the name of a network you have configured in the bouncer web interface, for example mbooth/freenode
  • Check the Auto connect to this network at startup option
  • In the Server password field, use your Dark Peak account password (see right-hand screenshot)
  • Click the Close button to save your changes and dismiss the "Edit Network" dialogue
  • Click the Connect button to connect to your newly configured network and dismiss the "Network List" dialogue

Hexchat

I followed instructions for XChat, but had to check the 'Use SSL for all the servers on this network' box on the "Edit Network" dialog.

Pidgin

Pidgin is slightly braindead. It won't send your username and password to ZNC correctly unless they're set as a single string in the server password field, however you can't save an account without specifying a username, and specifying a username causes Pidgin to complain it (the username) isn't a valid channel when connecting! (Goodness knows what happens if you set your username to be a valid channel name...)

  • Select the Accounts > Manage Accounts menu option.
  • Click Add...
  • Select IRC from the Protocol drop-down on the Basic tab.
  • In the Username field, use a value of username/network, where "username" is your Dark Peak username and "network" is the name of a network you have configured in the bouncer web interface, for example graphiclunarkid/freenode.
  • Set the Server field to irc.darkpeak.org.
  • In the Password field you need to include your username as above, plus your Dark Peak account password, separated by a colon. For example: graphiclunarkid/freenode:password
    • You can check the Remember password box if you don't want to have to type this in every time you connect.
  • Switch to the Advanced tab.
  • Enter 6697 in the port field (note: this is different to the default setting of "6667").
  • Check the Use SSL box.
  • Click Add to close the dialog.
  • Check the box next to the account name in Manage accounts to connect.

Irssi

In your .irssi/config file, add an entry to the 'servers' list in the following format:

 {
   user = "NICK";
   address = "irc.darkpeak.org";
   chatnet = "NETWORK";
   port = "6697";
   autoconnect = "yes";
   use_ssl = "yes";
   password = "USERNAME/NETWORK:PASSWORD"
 },
 ...

Where NICK is the IRC nickname you use on that network. NETWORK is the network name as defined in your ZNC config. USERNAME is your Dark Peak username, and PASSWORD is your Dark Peak password. You might also want to turn on/off 'autoconnect'.

Add one of these entries for each network your've defined in ZNC.

You may also need a 'chatnets' entry for each server, if one is not already defined:

 chatnets = {
   NETWORK = { type = "IRC"; };
 };

Where NETWORK is the name of a network configured in ZNC (eg, 'Freenode').

Yaaic (Android app)

This client only displays a 'Password' field when adding a server. To provide your Dark Peak username and ZNC network name, the password you enter should be in the following format: username/network:password where 'username' is your Dark Peak username, 'network' is the name of a network configured in ZNC and 'password' is your Dark Peak password.