Installing from source

To install UnrealIRCd on Linux, FreeBSD, OpenBSD, OS X and other *NIX systems you generally compile and install from source. This page explains how to do just that.

= Grab the source (.tar.gz) =

Surf to https://www.unrealircd.org/ -> Downloads and select a release. In the final screen it will say something like: "The download should begin in 5 seconds, if it doesn't click here." In that screen right-click on the "click here" and copy the URL (Copy link location). In the example below we will assume this is: https://www.unrealircd.org/downloads/Unreal3.4-alpha3.tar.gz

Connect to the *NIX server via SSH. All the following commands execute on the *NIX server.

Download the .tar.gz to the shell: wget --no-check-certificate https://www.unrealircd.org/downloads/Unreal3.4-alpha3.tar.gz on FreeBSD you may have to use: fetch https://www.unrealircd.org/downloads/Unreal3.4-alpha3.tar.gz

If neither works, for example you get an 'unknown command' then you should install the 'wget' package on your system.

Alternatively, you could upload the .tar.gz from your own machine to your *NIX shell.

= Extract the source = Extract the .tar.gz and enter the Unreal3.4.x directory: tar xzvf Unreal3.4-alpha3.tar.gz cd Unreal3.4-alpha3 NOTE: There's a logic here. If the file is called, say, Unreal3.4.0-lala1.tar.gz then it will extract to the Unreal3.4.0-lala1/ directory. As you can see, the directory name is different for each release to make sure you don't accidentally overwrite your existing installation.

= Compiling = First, run the ./Config script which will ask a number of questions. You can just press Enter to accept the default answers. ./Config

Now, compile UnrealIRCd by running make, this may take a minute (or two): make

Finally, run make install which will copy the right files to the right place (TODO: new in 3.4.x // default) make install

= Creating a configuration file =
 * 1) Copy doc/example.conf to your Unreal3.4.x main directory and rename it to unrealircd.conf
 * 2) Open the file with an editor (eg: nano unrealircd.conf)
 * 3) Read the Configuration file syntax article. It takes maybe 2-3 minutes but will save you a lot of trouble in next step(s).
 * 4) Walk through the unrealircd.conf block by block / line by line and edit the settings to suit your needs
 * 5) Boot UnrealIRCd by running ./unreal start
 * 6) Errors? Edit your unrealircd.conf, fix them (see the FAQ for common problems), and try starting UnrealIRCd again
 * 7) Up and running? Connect with an IRC client to your server and have fun. See next section.