Main Page

UnrealIRCd documentation wiki

UnrealIRCd is an Open Source IRC Server, serving thousands of networks since 1999. It runs on Linux, OS X and Windows and is currently the most widely deployed IRCd with a market share of 42%. UnrealIRCd is a highly advanced IRCd with a strong focus on modularity, an advanced and highly configurable configuration file. Key features include SSL, cloaking, its advanced anti-flood and anti-spam systems, swear filtering and module support. We are also particularly proud on our extensive online documentation.

Project News   |   Download

Installation

• Installing on Windows
• Installing from Source (Linux, *BSD, OS X, ..)
• Upgrading from a previous version

Configuration

• UnrealIRCd files and directories
• Configuration
• Using Let's Encrypt with UnrealIRCd
• Security

Features

• IRCOp guide
• Highlighted features
• User modes
• Channel modes
• Extended bans

For UnrealIRCd 4.x users

If you are migrating from 4.x to 5.x then you may want to check out:

• UnrealIRCd 4 is End Of Life after Dec 31, 2020
• Upgrading from 4.x to 5.x
• What's new in UnrealIRCd 5
• Running a mixed UnrealIRCd 4 and UnrealIRCd 5 network

Get Support

• Frequently Asked Questions (FAQ)
• Support Forums
• Live help on IRC: #unreal-support on irc.unrealircd.org (TLS port 6697)
• Bugtracker and feature suggestions

Get involved

There are several ways you can support the UnrealIRCd project:

• Help fellow users on the forums or on IRC
• If there is a beta or release candidate: help with testing
• If you are a coder: fix bugs from the bug tracker, issue PR's on GitHub, ..
• Make a donation if you have money to spare

Development documentation

• Dev:Unreal Architecture is a good jumping off place, and describes from a very high level how the IRCd is built
• Dev:Module will help you create and understand the skeleton of a module
• Dev:Module API shows the various ways a module can plug-in into existing functionality and/or provide new commands, modes, etc.
• Server protocol explains the server-to-server protocol