2 ngIRCd - Next Generation IRC Server
4 (c)2001-2003 by Alexander Barton,
5 alex@barton.de, http://www.barton.de/
7 ngIRCd is free software and published under the
8 terms of the GNU General Public License.
14 I. Upgrade Information
15 ~~~~~~~~~~~~~~~~~~~~~~
17 Differences to version 0.6.x
19 - Some options of the configure script have been renamed:
20 --disable-syslog -> --without-syslog
21 --disable-zlib -> --without-zlib
22 Please call "./configure --help" to review the full list of options!
24 Differences to version 0.5.x
26 - Starting with version 0.6.0, other servers are identified using asyncronous
27 passwords: therefore the variable "Password" in [Server]-sections has been
28 replaced by "MyPassword" and "PeerPassword".
30 - New configuration variables, section [Global]: MaxConnections, MaxJoins
31 (see example configuration file "doc/sample-ngircd.conf"!).
34 II. Standard Installation
35 ~~~~~~~~~~~~~~~~~~~~~~~~~
37 ngIRCd is developed for UNIX-like systems, which means that the installation
38 on modern UNIX-like systems witch are supported by GNU autoconf and GNU
39 automake ("configure") should be no problem.
41 The normal installation procedure after getting (and expanding) the source
42 files (using a distribution archive or CVS) is as following:
44 1) ./autogen.sh [only necessary when using CVS]
51 The first step, autogen.sh, is only necessary if the configure-script isn't
52 already generated. This never happens in official ("stable") releases in
53 tar.gz-archieves, but when using CVS.
55 This step is therefore only interesting for developpers.
57 autogen.sh produces the Makefile.in's, which are necessary for the configure
58 script itself, and some more files for make. To run autogen.sh you'll need
59 GNU autoconf and GNU automake (in recent versions!).
61 Again: "end users" do not need this step!
65 The configure-script is used to detect local system dependancies.
67 In the perfect case, configure should recognize all needed libraries, header
68 files and so on. If this shouldn't work, "./configure --help" shows all
71 In addition, you can pass some command line options to "configure" to enable
72 and/or disable some features of ngIRCd. All these options are shown using
73 "./configure --help", too.
77 The make command uses the Makefiles produced by configure and compiles the
82 Use "make install" to install the server and a sample configuration file on
83 the local system. Normally, root privileges are necessary to complete this
84 step. If there is already an older configuration file present, it won't be
87 This files will be installed by default:
89 - /usr/local/sbin/ngircd: exectable server
90 - /usr/local/etc/ngircd.conf: sample configuration (if not already present)
93 II. Useful make-targets
94 ~~~~~~~~~~~~~~~~~~~~~~~
96 The Makefile produced by the configure-script contains always these useful
99 - clean: delete every product from the compiler/linker
102 - distclean: the above plus erase all generated Makefiles
103 next step: -> ./configure
105 - maintainer-clean: erease all automatic generated files
106 next step: -> ./autogen.sh
109 III. Sample configuration file ngircd.conf
110 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112 In the sample configuration file, there are comments beginning with "#" OR
113 ";" -- this is only for the better understanding of the file.
115 The file is seperated in four blocks: [Global], [Operator], [Server], and
116 [Channel]. In the [Gobal] part, there is the main configuration, like the
117 server-name and the ports, on which the server should be listening. In the
118 [Operator] section, the server-operators are defined and [Server] is the
119 section, where the server-links are configured. Use [Channel] blocks to
120 configure pre-defined ("persistent") IRC channels.
122 The meaning of the variables in the configuration file is explained in the
123 "doc/sample-ngircd.conf", which is used as sample configuration file in
124 /usr/local/etc after running "make install" (if you don't already have one).
127 IV. Command line options
128 ~~~~~~~~~~~~~~~~~~~~~~~~
130 These parameters could be passed to the ngIRCd:
133 The daemon uses the file <file> as configuration file rather than
134 the standard configuration /usr/local/etc/ngircd.conf.
137 ngIRCd should be running as a foreground process.
140 Server-links won't be automatically established.
143 Reads, validates and dumps the configuration file as interpreted
144 by the server. Then exits.
146 Use "--help" to see a short help text describing all available parameters
147 the server understands, with "--version" the ngIRCd shows its version
148 number. In both cases the server exits after the output.
152 $Id: INSTALL,v 1.11 2003/03/07 14:45:10 alex Exp $