diff --git a/Changes b/Changes index e0a8ee3e6..d6871e206 100644 --- a/Changes +++ b/Changes @@ -481,4 +481,5 @@ seen. gmtime warning still there - Fixed some compilation error with IPv6 - Fixed-fixed listen format troubles, larne++ - Possible fixed some +d bug(s) - +- Added doc/unrealircd.conf.txt (by devdev), doc/services-install-guide + (zyrol, edited a bit by stskeeps) diff --git a/doc/services-install-guide b/doc/services-install-guide new file mode 100644 index 000000000..b6450d45c --- /dev/null +++ b/doc/services-install-guide @@ -0,0 +1,83 @@ + Services Install Guide For Unreal 3.2 by zyrorl (zyrorl@unrealircd.com) + ======================================================================= + + last updated: 4/5/2001 (4th May 2001) + + +First of all you will be required to download a services package for your +network. + +A few of the most popular services are: + + IRCServices - http://www.ircservices.za.net/ + Epona - http://www.pegsoft.net/epona/ + Wrecked - http://www.wrecked.net/services/index.html + Magick - http://www.magick.tm/ + Sirius - http://ircsystems.net/sirius + +After you have downloaded the appropriate services package, you will have to +upload it to your shell, and untar and un-gzip the file by typing: tar -zxvf +services.x.x.tar.gz + +Then you will need to enter the directory created by your services package (for +a listing type ls -a) and type ./configure . This will run the configure script +to setup your services. The script will ask you questions regarding the path +want to install your services to, where you want the services data files to be +installed to, encryption options, and the type of ircd that you are using (Most +probably Unreal). If you have previously used any other services package, it +may also ask you if you would like to convert their databases. It may also ask +you if you would like the services to dump a core file when a segmentation fault +occurs so that you can find out the cause of the problem and bug report to the +developers of the ircd services. + +Then you will be required to compile your services package by typing "make" or +possibly "gmake". To install services after compiled, type "make install". +Then you will need to enter the directory that you specified for the location +for the data of the services. You will most likely see a example.conf file in +the folder. You will need to rename this file to services.conf by typing "mv +example.conf services.conf" and then you will need to edit the services.conf +file in your favourite text editor. We recommend new users use pico, to edit +the file using pico type "pico services.conf". Edit the file to your liking, +make sure you follow their recommendations in settings, and make sure you edit +the root services passwords, server to link to, password and port. + +After you have configured your services you will then be required to edit your +unrealircd.conf. You will require to add server connection lines to your server +in order for services to work. All services on your network will need to have +the same U line as the server that services are linking to. A sample of the +configuration for services for unrealircd.conf is listed below: + +link services.yournetwork.net { + username *; + hostname 0.0.0.0; /*Server Ip Address Or Hostmask */ + bind-ip *; /* IP To Bind To When Connecting */ + port 6667; /* Port Number */ + password-connect "passwordsend"; /*Password To Send On Connection*/ + password-receive "passwordreceive"; /* Password To Receive From + Server Connecting */ + class servers; + options { autoconnect; }; +}; + +Make sure you then add a u:line entry for services. All the servers on your +network will be required to have a U:line. For UnrealIRCD 3.2 the U:lines +should look something like this: + +ulines { + services.yournetwork.net; +}; + +Servers Running UnrealIRCD 3.1.1 Darkshades or below the U:Line for the servers +should look something like this: + + U:services.yournetwork.net:*:* + +You will then be required to edit your unrealircd.conf's network configuration +services name line, which has to be the same name as chosen on the connection +line for your services. ie. in this case your network configuration line would +look something like: + + services-name "services.yournetwork.net"; + +Then you will require to /rehash your ircd and then go back to your services +directory and type ./services to run services. diff --git a/doc/unrealircd.conf.txt b/doc/unrealircd.conf.txt new file mode 100644 index 000000000..c3e4b2838 --- /dev/null +++ b/doc/unrealircd.conf.txt @@ -0,0 +1,430 @@ + * * * * * * * * * * * * * * * * * * * + * Unrealircd.conf Documentation * + * http://www.unrealircd.com * + * Made for Version 3.2+ Daemon * + * by devdev * + * * * * * * * * * * * * * * * * * * * + + + * * * * T a b l e o f C o n t e n t s * * * * + + Section 1.0 : Introduction + Section 2.0 : me{} line + 2.1 : Syntax + 2.2 : Variables + Section 3.0 : admin{} line + 3.1 : Syntax + 3.2 : Variables + Section 4.0 : class{} line + 4.1 : Syntax + 4.2 : Variables + Section 5.0 : allow{} line + 5.1 : Syntax + 5.2 : Variables + Section 6.0 : drpass{} line + 6.1 : Syntax + 6.2 : Variables + Section 7.0 : oper{} line + 7.1 : Syntax + 7.2 : Variables + 7.3 : Oper Flags + 7.4 : Flag Usage + Section 8.0 : listen{} line + 8.1 : Syntax + 8.2 : Variables + 8.3 : Port Options + 9.0 : link{} line + 9.1 : Syntax + 9.2 : Variables + 9.3 : Link Options + Section 10.0 : ulines{} line + 10.1 : Syntax + 10.2 : Variables + Section 11.0 : tld{} line + 11.1 : Syntax + 11.2 : Variables + Section 12.0 : ban{} line + 12.1 : ban nick{} + 12.2 : ban ip{} + 12.3 : ban server{} + 12.4 : ban realname{} + 12.5 : ban user{} + Section 13.0 : except{} line + 13.1 : except ban{} + 13.2 : except socks{} + Section 14.0 : vhost{} line + 14.1 : Syntax + 14.2 : Variables + + * * * * * * * * * * * * * * * * * * * * * * * * + +1.0) Introduction: + + As you may have noticed, in this version of Unreal, the ircd.conf + has changed dramatically and has a new name... unrealircd.conf. + + This will be a fully explanatory guide to the new unrealircd.conf + Every aspect of the new config file is explained below. + +2.0) me{} (Server Information Line): + + This is the same idea as the old M:line. Gives the server name, + description, and numeric. This, however, does not include the ip + of the server. + +2.1) Syntax: + me { + name ; + info ""; + numeric ; + }; + +2.2) Variables: + + Server name (irc.network.com) + Server description (Network Hub) + Connection Numeric (Number 1-254) + +3.0) admin{} (Administrator Line): + + This is the same as the A:line. This line gives information about + the server owner/administrator including Name, nickname, and email. + This is not restricted to a number of lines. Shown at /admin + +3.1) Syntax: + admin { + ""; + }; + +3.2) Variables: + Text shown at /admin (Admin Name) + + The ""; can be repeated as many times as you wish. We suggest + placing the admins nickname and an email to reach them at. + +4.0) class{} (Connection Classes Line): + + These connection classes are used to define the ping freqency, maximum + amount of clients, and sendq limit for a certain class. + +4.1) Syntax: + class { + connfreq ; /*server only*/ + ping freq ; + maxclients ; + sendq ; + }; + +4.2) Variables: + Name of connection class (client, server, oper) + Seconds between connection attempts (seconds) + Ping Frequency (every x seconds) (seconds) + Number of maximum connections (number) + Limit for sends (number) + +5.0) allow{} (Allowed Connections): + + This line specifies from which hostnames/ips users can connect from and their + restrictions. + +5.1) Syntax: + allow { + ip ""; + hostname ""; + class ; + password ""; + maxperip ; + }; + +5.2) Variables: + IP to allow connections from (1.2.3.4) + Hostname to allow connections from (ident@host) + Class name to use defined above (name) + Password required for connection (password) + Maximum per ip address (number) + +6.0) drpass{} (Die/Restart Password): + + This line will defy the passwords required to restart or shutdown the irc server. + +6.1) Syntax: + drpass { + die ""; + restart ""; + }; + +6.2) Variables: + Password to shutdown the server (password) + Password to restart the server (password) + +7.0) oper{} (IRC Operator Line): + + This line will define who (after suppling a login and password) will be allowed to have certain permissions + granted. Such as global kills compared to local kills, and being able to restart the server. + +7.1) Syntax: + oper { + class ; + from { + userhost ; + userhost + }; + password ""; + flags { + ; + ; + } + }; + +7.2) Variables + Login user name (opername) + Class the oper will connect from (class) + Host the oper is allowed to op from (ident@host) + Password to accompany login-name (password) + Flags to define permissions (see 7.3) + +7.3) Oper Flags (old and new) + + Old | New |Description + ------- |---------------- |------------------------------ + N | netadmin | Network Admnistrator + T | techadmin | Technical Administrator + A | admin | Server Administrator + a | sadmin | Services Operator + C | coadmin | Co Administrator + o | local | Local IRC Operator + O | global | Global IRC Operator + r | can_rehash | Is able to rehash the server + e | eyes | Can use the eyes message mode + D | can_die | Can shutdown the server (with password) + R | can_restart | Can restart the server (with password) + h | helpop | ..is available for help. Can see /helpops + g | can_globops | Can use /globops + w | can_wallops | Can use /wallops + l | locop | Can't kill remote users + c | can_localroute | Can locally /connect and /squit servers + L | can_globalroute | Can globally /connect and /squit servers + k | can_localkill | Can do local /kills + K | can_globalkill | Can do global /kills + b | can_kline | Can set a /kline + B | can_unkline | Can unset a /kline + n | can_localnotice | Can send local notices + G | can_globalnotice| Can send global notices + z | can_zline | Can set /zlines + ^ | can_stealth | Is invisible to /names + + +7.4) Oper Flag Usage: + + Usage: + flags oldflags; + [or] + flags { new flag; new flag; }; + + Example: + flags oN; + [or] + flags { netadmin; helpop; }; + + + Local operators are defined by having no additional flags in the oper line or if the IRCD finsd an error in + the flags, locop will be set (default). + +8.0) listen{} (Available Ports): + + These line(s) define which ports the IRCd will be using. Ports that servers and clients can connect to. + +8.1) Syntax: + listen :; + { + options + { +