2 ngIRCd - Next Generation IRC Server
4 (c)2001-2004 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 asynchronous
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-based systems, which means that the installation
38 on modern UNIX-like systems that 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]
52 The first step, autogen.sh, is only necessary if the configure-script isn't
53 already generated. This never happens in official ("stable") releases in
54 tar.gz-archives, but when using CVS.
56 This step is therefore only interesting for developers.
58 autogen.sh produces the Makefile.in's, which are necessary for the configure
59 script itself, and some more files for make. To run autogen.sh you'll need
60 GNU autoconf and GNU automake (use recent versions! autoconf 2.53 and
61 automake 1.6.1 are known to work).
63 Again: "end users" do not need this step!
68 The configure-script is used to detect local system dependencies.
70 In the perfect case, configure should recognise all needed libraries, header
71 files and so on. If this shouldn't work, "./configure --help" shows all
74 In addition, you can pass some command line options to "configure" to enable
75 and/or disable some features of ngIRCd. All these options are shown using
76 "./configure --help", too.
78 Compiling a static binary will avoid you the hassle of feeding a chroot dir
79 (if you want use the chroot feature). Just do something like:
80 CFLAGS=-static ./configure [--your-options ...]
81 Then you can use a void directory as ChrootDir (like OpenSSH's /var/empty).
86 The make command uses the Makefiles produced by configure and compiles the
92 Use "make install" to install the server and a sample configuration file on
93 the local system. Normally, root privileges are necessary to complete this
94 step. If there is already an older configuration file present, it won't be
97 This files will be installed by default:
99 - /usr/local/sbin/ngircd: executable server
100 - /usr/local/etc/ngircd.conf: sample configuration (if not already present)
101 - /usr/local/share/doc/ngircd/: documentation
104 II. Useful make-targets
105 ~~~~~~~~~~~~~~~~~~~~~~~
107 The Makefile produced by the configure-script contains always these useful
110 - clean: delete every product from the compiler/linker
113 - distclean: the above plus erase all generated Makefiles
114 next step: -> ./configure
116 - maintainer-clean: erase all automatic generated files
117 next step: -> ./autogen.sh
120 III. Sample configuration file ngircd.conf
121 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
123 In the sample configuration file, there are comments beginning with "#" OR
124 ";" -- this is only for the better understanding of the file.
126 The file is separated in four blocks: [Global], [Operator], [Server], and
129 In the [Global] section, there is the main configuration like the server
130 name and the ports, on which the server should be listening. IRC operators
131 of this server are defined in [Operator] blocks. [Server] is the section
132 where server links are configured. And [Channel] blocks are used to
133 configure pre-defined ("persistent") IRC channels.
135 The meaning of the variables in the configuration file is explained in the
136 "doc/sample-ngircd.conf", which is used as sample configuration file in
137 /usr/local/etc after running "make install" (if you don't already have one)
138 and in the "ngircd.conf" manual page.
141 IV. Command line options
142 ~~~~~~~~~~~~~~~~~~~~~~~~
144 These parameters could be passed to the ngIRCd:
147 The daemon uses the file <file> as configuration file rather than
148 the standard configuration /usr/local/etc/ngircd.conf.
151 ngIRCd should be running as a foreground process.
154 Server-links won't be automatically established.
157 Reads, validates and dumps the configuration file as interpreted
158 by the server. Then exits.
160 Use "--help" to see a short help text describing all available parameters
161 the server understands, with "--version" the ngIRCd shows its version
162 number. In both cases the server exits after the output.
166 $Id: INSTALL,v 1.18.2.1 2004/05/07 11:24:17 alex Exp $