Please read this manual before asking for help, you may also want to take a look at the FAQ for common problems. If that didn't help you can - ask for support at irc.ircsystems.net (port 6667) channel #unreal-support (strict UnrealIrcd support, dont + ask for support at irc.ircsystems.net (port 6667) channel #unreal-support (strict UnrealIRCd support, dont ask for help about services!). If you have a real bug (like a crash) then report it at http://bugs.unrealircd.org.
@@ -112,8 +112,8 @@1.2 – Notes on upgrading between 3.2.x versions
The recommended way of upgrading is:
- - Rename your old UnrealIrcd directory (or otherwise you'll overwrite it in the next step)
- - Extract the new UnrealIrcd version and run ./Config and make(*NIX).
+ - Rename your old UnrealIRCd directory (or otherwise you'll overwrite it in the next step)
+ - Extract the new UnrealIRCd version and run ./Config and make(*NIX).
- Copy your old configuration files to the new directory (unrealircd.conf, motd, rules, server.* [SSL certs], network file, etc)
Please also check .RELEASE.NOTES and maybe even Changes to see what has been changed. If you notice any changes (or bugs) between version, BE SURE TO READ THOSE FILES FIRST before reporting it as a bug!.
@@ -154,44 +154,44 @@-
Some major/nice features are explained in this section. It gives a general overview, - it will sometimes refer to the configfile (something which you maybe know nothing about yet).
-You can skip this section, or read it after installing... - But it can be quite usefull usefull to read before you install... ;)
+Some major/nice features are explained in this section. It provides a general overview, + and sometimes refers to the config file (something which you might know nothing about yet).
+You can skip this section, however it's suggested to read it before/after installing.
-Cloaking is hiding the host of users, for example if your real host is d5142341.cable.wanadoo.nl, +
Cloaking is a way to hide the real hostname of users, for example if your real host is d5142341.cable.wanadoo.nl, it will be shown (in join, part, whois, etc) as rox-2DCA3201.cable.wanadoo.nl. - This feature is usefull to prevent users flooding each other since they can't see the real host/IP.
-This is controlled by usermode +x (like: /mode yournix +x), admins can also force +x to be enabled + This feature is useful to prevent users flooding each other since they can't see the real host/IP.
+This is controlled by usermode +x (like: /mode yournick +x), admins can also force +x to be enabled by default, or make it so users can never do -x.
The cloaked host is generated by some formula which uses 3 "cloak keys", you are required to set those 3 keys in your config file, they should be 3 random numbers between 10.000 and 4.294.967.295. - If someone else knows these keys they can decode the host a bit and discover the real host so you - have to keep them secret. They also should be the same at all servers!
+ If someone else knows these keys they can decode the cloacked host and discover the real one, that's why you + have to keep them secret. They should be the same at all servers of your network! -UnrealIrcd supports modules (except on windows), modules are nice because:
- - You can decide not to load them (ex: not load the scanner module) and they wont use any memory/CPU
+
UnrealIRCd supports modules (except at windows) which is nice because:
+ - You can decide not to load them (ex: not load the scanner module) and they won't use any memory/CPU
- You can load/reload/unload them while the ircd is running (by /rehash)
- Other people can create modules as well with new commands or usermodes for example.
- UnrealIrcd only comes with a few modules, if you want others take a look at www.unrealircd.com -> modules
- or use google or something ;). [note that you at least need to load the commands module].
Note that you need to load at least the commands module!
-UnrealIrcd comes with proxy scanner modules: if a user connects it will check on some ports to see +
UnrealIRCd comes with proxy scanner modules: if a user connects it will check on some ports to see if the user is using an anonymous proxy. There's 1 main scanner module (scan.so) and two modules which do the actual scanning: scan_socks and scan_http.
-This module is not required, but often usefull.. if you load them, you also have to fill in the set::scan block.
-You can also use something like BOPM which is a seperate - program designed for proxy scanning, in that case disable UnrealIrcd's own proxy scanner.
+This module is not required, but often useful. If you load them, you need a set::scan block.
+You can also use a separate proxy scanner program like BOPM, + in that case you should disable UnrealIRCd's own proxy scanner.
-Snomasks are server notice masks, it's a special type of usermodes that controlls which +
Snomasks are server notice masks, it's a special type of usermodes that control which server notices you will receive (mostly used by opers)
-It's set by: /mode yournick +s SNOMASK, for example: /mode yournick +s +cF
- You can ofcourse also remove certain snomasks by doing for example: /mode yournick +s -c
- Or you can remove all snomasks by doing: /mode yournick -s
It can be set by: /mode yournick +s SNOMASK, for example: /mode yournick +s +cF
+ To remove certain snomasks, use something like: /mode yournick +s -c
+ Or you can remove all snomasks by simply doing: /mode yournick -s
The current available snomasks are:
c - local connects
F - far connects
@@ -204,52 +204,54 @@
n - nick change notices
q - deny nick (Q:line) rejection notices
You can control which snomasks you automatically get on connect or if you use /oper.
+You can control which snomasks you automatically get (set::snomask-on-connect) and which you get + on oper (set::snomask-on-oper, set::oper::snomask)
-With aliases you can configure things like: "/ns identify blah" will be forwarded - to nickserv as a privmsg (privmsg nickserv identify blah). They can be quite usefull ;).
+With aliases you can configure serverside alias commands. + You can for example let "/ns identify blah" be forwarded to nickserv (it will be + translated to: privmsg nickserv identify blah).
Aliases are configured by alias blocks in the configuration file, and you can also include a file with default aliases for some services.
-UnrealIrcd has a build in help system accessable by /helpop.
- For example /helpop chmodes gives you a overview of all channel modes UnrealIrcd has.
- One important thing to remember is that if you are an ircop (helpop) you have the
- prefix a ?, so /helpop becomes /helpop ? and
+
UnrealIRCd has a built-in help system accessable by /helpop.
+ For example /helpop chmodes gives you a overview of all channel modes UnrealIRCd has.
+ emember that if you are an ircop (helpop) you will have to prefix the keyword with a '?' character,
+ so /helpop becomes /helpop ? and
/helpop chmodes becomes /helpop ?chmodes etc..
There are several oper levels in UnrealIrcd and you can add additional right (like to use /gline) to +
There are several oper levels in UnrealIRCd and you can add additional rights (like to use /gline) to each of them, that way you can give each oper the privileges they need.
This is controlled by the oper flags in the oper block, see the oper block for more information.
-UnrealIrcd has a lot of powerfull oper commands which are explained in section 6, +
UnrealIRCd has a lot of powerfull oper commands which are explained in section 6, you probably want to read those after installing :).
SSL stands for Secure Socket Layer, with SSL you can make secure (encrypted) connections. It can be used to encrypt server2server traffic, but clients can also use it if you want. - If set up right it can usefull again sniffing attacks, if you don't know what I'm talking + If set up right it can useful again sniffing attacks, if you don't know what I'm talking about then SSL is (not yet) for you ;).
To setup a secure SSL port you need to add the ssl flag to the listen block. - NOTE: you cannot connect with non-ssl clients to a SSL port, so don't set port 6667 to SSl for example ;).
+ NOTE: you cannot connect with non-ssl clients to a SSL port, so don't set port 6667 to SSL for example ;). -UnrealIrcd supports IPv6, since beta15 it seems to work well altough there might be some +
UnrealIRCd supports IPv6, since beta15 it seems to work well altough there might be some bugs in it. You need to compile with IPv6 support (answer yes to the ./Config question), ofcourse your OS needs to have IPv6 support enabled too.
-Altough microsoft has an experimental IPv6 implementation for w2k/XP it is not (yet) supported by UnrealIrcd
+Altough microsoft has an experimental IPv6 implementation for w2k/XP it is not (yet) supported by UnrealIRCd
Zip links can be turned on for server2server links, it compresses the data by using zlib. - It can save you 60-80% bandwidth... Can be quite usefull for low-bandwidth links or links with + It can save 60-80% bandwidth... So it's quite useful for low-bandwidth links or links with many users, it can help a lot when you are linking since then a lot of data is sent about ever user/channel/etc.
To compile with zip links support, you need to answer Yes to the zlib question in ./Config
-UnrealIrcd has a lot of features so not everything is covered here... You'll find that out by yourself
+UnrealIRCd has a lot of features so not everything is covered here... You'll find that out by yourself
4.0 - Configuring your unrealircd.conf @@ -844,7 +846,7 @@ statement them to load the file.
example 2: aliases
Include aliases/ircservices.conf-
Another example is to use it for including alias blocks, UnrealIrcd comes with +
Another example is to use it for including alias blocks, UnrealIRCd comes with
some files which (should) contain the right aliases for most services:
aliases/ircservices.conf (IRCServices, Daylight)
aliases/epona.conf (Epona)
@@ -859,7 +861,7 @@
Syntax:
loadmodule <file-name>;
UnrealIrcd now supports modules (at *NIX). Modules make it easy to write extensions and you +
UnrealIRCd now supports modules (at *NIX). Modules make it easy to write extensions and you can load/unload them while the ircd is running.
Modules that come standard with Unreal3.2:
scan_http.so - HTTP proxy scanner module
@@ -1347,7 +1349,7 @@ loadmodule "src/modules/scan_http.so";
nick <nick-to-forward-to>;
type <type-of-alias>;
};
(Note: also see here about the standard alias files UnrealIrcd has)
+(Note: also see here about the standard alias files UnrealIRCd has)
The alias block [standard alias] allows you to forward a command to a user, for example /chanserv sends a message to the user chanserv. The alias:: specifies the name of the command that will be the alias, ex /chanserv, alias::nick is