]> jfr.im git - irc/unrealircd/unrealircd.git/blame - README.md
Don't put insecure gatewayed/proxied connections in 'tls-users' security group.
[irc/unrealircd/unrealircd.git] / README.md
CommitLineData
6d541442 1[![Twitter Follow](https://img.shields.io/twitter/follow/Unreal_IRCd.svg?style=social&label=Follow)](https://twitter.com/Unreal_IRCd)
5c1b742e 2
32ada3f9 3## About UnrealIRCd
635c4e22 4UnrealIRCd is an Open Source IRC Server, serving thousands of networks since 1999.
32ada3f9 5It runs on Linux, OS X and Windows and is currently the most widely deployed IRCd
61cd88c7 6with a market share of 38%. UnrealIRCd is a highly advanced IRCd with a strong
635c4e22
BM
7focus on modularity and security. It uses an advanced and highly configurable
8configuration file. Other key features include: full IRCv3 support, SSL/TLS,
9cloaking, advanced anti-flood and anti-spam systems, GeoIP, remote includes,
10and lots of [other features](https://www.unrealircd.org/docs/About_UnrealIRCd).
11We are also particularly proud on our extensive online documentation.
32ada3f9 12
35ab4407 13## Versions
6354445d 14* UnrealIRCd 6 is the *stable* series since December 2021. It is the only supported version.
96413cb9
BM
15* For full details of release scheduling and EOL dates, see
16 [UnrealIRCd releases](https://www.unrealircd.org/docs/UnrealIRCd_releases) on the wiki
35ab4407 17
32ada3f9 18## How to get started
44394e2f 19Follow the installation guide on the wiki. See:
96413cb9
BM
20* [Installing from source for *NIX](https://www.unrealircd.org/docs/Installing_from_source)
21* [Installating instructions for Windows](https://www.unrealircd.org/docs/Installing_(Windows))
22
32ada3f9 23## Documentation & FAQ
44394e2f 24You can find all **documentation** online at: https://www.unrealircd.org/docs/
32ada3f9 25
91e10849 26We also have a good **FAQ**: https://www.unrealircd.org/docs/FAQ
32ada3f9
BM
27
28## Website, support, and other links ##
ce290f7a
BM
29* https://www.unrealircd.org - Our main website
30* https://forums.unrealircd.org - Support
31* https://bugs.unrealircd.org - Bug tracker
217ea69f 32* ircs://irc.unrealircd.org:6697/unreal-support - IRC support