Bram Matthys
6d3a98653e
The new question in ./Config now defaults to 'auto' (both for new installs and for upgrades). You can still specify a manual limit but it is no longer recommended. A MAXCONNECTIONS of 'auto' means - at present - that UnrealIRCd will try to set a limit of 8192. This is quite a bump from the original 1024. On systems where this is not possible we will simply use the highest amount possible, such as 4096 on many systems, or 1024. In fact, we now no longer error when MAXCONNECTIONS is higher than the 'ulimit -n' limit but will adjust ourselves to the limit. Only if the effective limit is below 100 we will print out a fatal error since running in such a scenario is highly discouraged. The reason for this change is that nowadays with drone attacks we may need to be able to handle more concurrent sockets. Also, many Linux distro's have a default setting of unlimited or 4096 nowadays, out of the box. For people packaging UnrealIRCd (not end-users): The ./configure --with-fd-setsize=xx option was removed and the optional(!!) --with-maxconnections=xx option has been added. We recommend you NOT to pass this option. Not passing it means that the previously mentioned 'auto' mode will be used, which is likely best for most users. Module coders: Although it is unlikely you accessed the 'MAXCLIENTS' variable, if you did, it is now called 'maxclients' (lowercase) since it is adjusted at runtime and no longer a macro.
About UnrealIRCd
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 over 50%. 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.
How to get started
Please consult our excellent online documentation at https://www.unrealircd.org/docs/ when setting up the IRCd!
Step 1: Installation
Windows
Simply download the UnrealIRCd Windows version from www.unrealircd.org
Alternatively you can compile UnrealIRCd for Windows yourself. However this is not straightforward and thus not recommended.
*BSD/Linux/macOS
First you must compile the IRCd:
- Run
./Config - Run
make - Run
make install - Now change to the directory where you installed UnrealIRCd, e.g.
cd /home/xxxx/unrealircd
Step 2: Configuration
Configuration files are stored in the conf/ folder by default (eg: /home/xxxx/unrealircd/conf)
Create a configuration file
If you are new, then you need to create your own configuration file: Copy conf/examples/example.conf to conf/ and call it unrealircd.conf. Then open it in an editor and carefully modify it using the documentation and FAQ as a guide (see below).
Step 3: Booting
Linux/*BSD/macOS
Run ./unrealircd start in the directory where you installed UnrealIRCd.
Windows
Start -> All Programs -> UnrealIRCd -> UnrealIRCd
Documentation & FAQ
You can find the documentation online at: https://www.unrealircd.org/docs/
We also have a good FAQ: https://www.unrealircd.org/docs/FAQ
Website, support, and other links
- https://www.unrealircd.org - Our main website
- https://forums.unrealircd.org - Support
- https://bugs.unrealircd.org - Bug tracker
- ircs://irc.unrealircd.org:6697/unreal-support - IRC support