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 38%. UnrealIRCd is a highly advanced IRCd with a strong focus on modularity and security. It uses an advanced and highly configurable configuration file. Other key features include: full IRCv3 support, SSL/TLS, cloaking, advanced anti-flood and anti-spam systems, GeoIP, remote includes, and lots of other features. 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
• Tutorial: Linking servers
• Linking UnrealIRCd with anope

Features

• IRCOp guide
• Highlighted features
• User modes
• Channel modes
• Extended bans
• User & Oper commands
• JSON-RPC and Admin panel

For UnrealIRCd 5.x users

• UnrealIRCd 5 is no longer supported
• What's new in UnrealIRCd 6
• Upgrading from 5.x to 6.x

Support

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

Help out and get involved

• Become a monhly sponsor or donate once
• Buy some merch from the UnrealIRCd shop
• See Contributing for the many other ways to support and help the project, such as providing support to users, updating documentation, test releases, and more.

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