IRC stands for Internet Relay Chat. autobrr has its own IRC client built in which lets it monitor the #announce channels without the need for additional software.
You need a registered nick on most IRC servers to be able to join channels. We will set up a registered user in a few easy steps.
You need a separate IRC client to do this. Here are some free and open source options:
- Konversation - Linux
- LimeChat - MacOS
- HexChat - Windows/Linux
- The Lounge - A web based, self hosted option.
Make sure your indexer is supported before proceeding.
Click to view supported indexers
- Cathode-Ray Tube
- Romanian Metal Torrents
along with the Generic RSS and Generic Torznab/Newznab integration.
Registering with NickServ
When you first open the IRC client it usually tells you to set up your nickname and choose what server to connect to. You should preferably choose the username you use on the tracker(s) you want autobrr to monitor for this.
- Connect to the IRC network using your IRC client of choice.
- Register your nick with NickServ:
/msg nickserv register PASSWORD EMAIL
The password should not match the one you use for logging in to the tracker. The e-mail address doesn't have to match either.
If you do not plan to use grouped nicks (read the next section), make sure to disconnect from the IRC server in your IRC client before attempting to set it up in autobrr.
It is recommended to set up autobrr with a grouped IRC nick since you might want to talk in the other channels in a separate IRC client while autobrr monitors the #announce channel.
Some trackers require the |autodl or |bot part to let you join the #announce channel. Others are fine with something like user-bot or user_bot. Some IRC networks won't even accept the pipe |. Your tracker wikis usually tells you what to use.
NickServ allows you to group two nicks to the same account in a few easy steps:
- While connected to the IRC server with
/nick USERNAME|AUTODLto change to the nick you want autobrr to use.
- Ask NickServ to group your nicks:
/msg nickserv group USERNAME PASSWORD
- Change back to your username:
You have now successfully grouped your nicks and can safely connect autobrr to the IRC network with
username|autodl while using
username in another IRC client if you want.
Getting banned on IRC
In some rare occurrences your bot might get banned from the IRC network. This can happen if the network suddenly changes how people are allowed to connect for example.
Some networks won't require special authentication, while others do, but they could implement it at any time. If they do, and your bot isn't set up for it, it will just retry to join the channel into infinity on a set interval. The network owners might ban you in this case.
Usually these things can often be resolved by contacting their support. Most trackers have a #support channel as well as a ticket system on their site.
You shouldn't need to worry about it, but it's nice now to know what you need to do if that were to happen.
The initial setup of IRC networks and channels are done during the setup of indexers.
If you for some reason need to setup a network manually, or edit an existing one, you can do that in
Settings > IRC.
Before setup, make sure you have generated the necessary keys. Some networks have invite commands with extra keys. Some require you to be registered with NickServ (see registering with NickServ). Trackers have documentation for the extra authentication protocols in their wiki pages.
- If NickServ Password is marked
*as required, then you need to have a registered account on that IRC network. See registering with NickServ above.
- If NickServ Account is marked
*as required, that's only used as nick, but supports NickServ auth.
- The invite command field in
Settings > IRC > Edit networkare pre filled, but you need to add your IRC key. The rest should be left as is.
Quite a few indexers use the same network, specifically
- If you use the same nick with multiple indexers, it will reuse the same connection for them.
- If you have more than one nick on the same network in will create a new connection for each.
Adding or removing
indexers/networks/channels can therefore break things.