Tip of the day: Channel mode +f is a powerful anti-flood feature. It is also slightly complex. Enable it in your most important channels, and consider setting a default in set::modes-on-join.

Upgrading from 4.x

From UnrealIRCd documentation wiki
Jump to navigation Jump to search

IMPORTANT: If you are running UnrealIRCd 4 and want to upgrade, then just upgrade straight from UnrealIRCd 4 to UnrealIRCd 6 (no need to do U4 -> U5 -> U6).
If you are in a hurry you could more or less skip skip reading this page, read Upgrading from 5.x instead, since most of the changes were between U5 and U6.

Below outlines the process of upgrading UnrealIRCd 4 to UnrealIRCd 5, which is, as stated above, not what you want to do, you want to go straight to UnrealIRCd 6. But it is left here for historic purposes:

Upgrading from UnrealIRCd 4.x to UnrealIRCd 5 is really easy, there are almost no configuration changes needed!

You should probably read the following, so you know the new functionality and the temporary effects during upgrading.

  1. What's new in UnrealIRCd 5
  2. Read below about the minor config changes
  3. Read Running a mixed UnrealIRCd 4 and UnrealIRCd 5 network

...just so you know the new functionality and the temporary effects during upgrading.

If you have more than 1 server and you will have some servers on 4.x and some on 5.x, then be sure to read the important recommendations in Running a mixed UnrealIRCd 4 and UnrealIRCd 5 network.

Services

If you use Services, then be sure to use the latest versions. In particular:

  • anope (version 2.0.7 or higher) - with the "unreal4" protocol module
  • atheme (version 7.2.9 or higher) - with the "unreal4" protocol module

File locations

On *NIX, all the file locations are pretty much the same. The only difference is that conf/ssl is now called conf/tls. A symlink will be created if you are upgrading an existing installation.

On Windows, it is important to note that UnrealIRCd is now 64-bit and installs to C:\Program Files\UnrealIRCd 5 instead of the old C:\Program Files (x86)\UnrealIRCd 4.

Installation / upgrading

The installation of UnrealIRCd 5 works exactly the same as installing UnrealIRCd 4. Just follow the installation procedure for *NIX or for Windows.

Configuration changes

Your UnrealIRCd 4.x configuration file will work fine on 5.x.

There are 2 major changes that will raise a warning only (the IRC server will start up fine, though):

  • The except tkl { } block is now called except ban { }. Solution: simply rename except tkl to except ban in your configuration files. See Except ban block#UnrealIRCd 5 if you want more information.
  • The setting set::oper-only-stats is removed, we now have set::allow-user-stats which does the inverse. Solution: simply delete your oper-only-stats line from the configuration, most likely you don't need it.

Third party modules

If you do have 3rd party modules then be advised that all modules for 4.x need to be updated for use with UnrealIRCd 5.x.

Many 3rd party modules have been updated and added to the public 3rd party modules repository. With the help of the new Module manager you can install the modules with one simply command!

Do you have a third party module which has not been ported yet? Post the module source on the modules forum and ask if someone is kind enough to convert the module from 4.x to 5.x.