Update copyright notices for 2010 :)
[ngircd-alex.git] / INSTALL
1
2                      ngIRCd - Next Generation IRC Server
3                            http://ngircd.barton.de/
4
5                (c)2001-2011 Alexander Barton and Contributors.
6                ngIRCd is free software and published under the
7                    terms of the GNU General Public License.
8
9                                 -- INSTALL --
10
11
12 I. Upgrade Information
13 ~~~~~~~~~~~~~~~~~~~~~~
14
15 Differences to version 16
16
17 - Changes to the "MotdFile" specified in ngircd.conf now require a ngircd
18   configuration reload to take effect (HUP signal, REHASH command).
19
20 Differences to version 0.9.x
21
22 - The option of the configure script to enable support for Zeroconf/Bonjour/
23   Rendezvous/WhateverItIsNamedToday has been renamed:
24     --with-rendezvous  ->  --with-zeroconf
25
26 Differences to version 0.8.x
27
28 - The maximum length of passwords has been raised to 20 characters (instead
29   of 8 characters). If your passwords are longer than 8 characters then they
30   are cut at an other position now.
31
32 Differences to version 0.6.x
33
34 - Some options of the configure script have been renamed:
35     --disable-syslog  ->  --without-syslog
36     --disable-zlib    ->  --without-zlib
37   Please call "./configure --help" to review the full list of options!
38
39 Differences to version 0.5.x
40
41 - Starting with version 0.6.0, other servers are identified using asynchronous
42   passwords: therefore the variable "Password" in [Server]-sections has been
43   replaced by "MyPassword" and "PeerPassword".
44
45 - New configuration variables, section [Global]: MaxConnections, MaxJoins
46   (see example configuration file "doc/sample-ngircd.conf"!).
47
48
49 II. Standard Installation
50 ~~~~~~~~~~~~~~~~~~~~~~~~~
51
52 ngIRCd is developed for UNIX-based systems, which means that the installation
53 on modern UNIX-like systems that are supported by GNU autoconf and GNU
54 automake ("configure") should be no problem.
55
56 The normal installation procedure after getting (and expanding) the source
57 files (using a distribution archive or GIT) is as following:
58
59   1) ./autogen.sh       [only necessary when using GIT]
60   2) ./configure
61   3) make
62   4) make install
63
64 (Please see details below!)
65
66 Now the newly compiled executable "ngircd" is installed in its standard
67 location, /usr/local/sbin/.
68
69 The next step is to configure and afterwards starting the daemon. Please
70 have a look at the ngircd(8) and ngircd.conf(5) manual pages for details
71 and all possible options.
72
73 If no previous version of the configuration file exists (the standard name
74 is /usr/local/etc/ngircd.conf), a sample configuration file containing all
75 possible options will be installed there. You'll find its template in the
76 doc/ directory: sample-ngircd.conf.
77
78
79 1): "autogen.sh"
80
81 The first step, autogen.sh, is only necessary if the configure-script isn't
82 already generated. This never happens in official ("stable") releases in
83 tar.gz-archives, but when using GIT.
84
85 This step is therefore only interesting for developers.
86
87 autogen.sh produces the Makefile.in's, which are necessary for the configure
88 script itself, and some more files for make. To run autogen.sh you'll need
89 GNU autoconf and GNU automake (use recent versions! autoconf 2.53 and
90 automake 1.6.1 are known to work).
91
92 Again: "end users" do not need this step!
93
94
95 2): "./configure"
96
97 The configure-script is used to detect local system dependencies.
98
99 In the perfect case, configure should recognise all needed libraries, header
100 files and so on. If this shouldn't work, "./configure --help" shows all
101 possible options.
102
103 In addition, you can pass some command line options to "configure" to enable
104 and/or disable some features of ngIRCd. All these options are shown using
105 "./configure --help", too.
106
107 Compiling a static binary will avoid you the hassle of feeding a chroot dir
108 (if you want use the chroot feature). Just do something like:
109   CFLAGS=-static ./configure [--your-options ...]
110 Then you can use a void directory as ChrootDir (like OpenSSH's /var/empty).
111
112
113 3): "make"
114
115 The make command uses the Makefiles produced by configure and compiles the
116 ngIRCd daemon.
117
118
119 4): "make install"
120
121 Use "make install" to install the server and a sample configuration file on
122 the local system. Normally, root privileges are necessary to complete this
123 step. If there is already an older configuration file present, it won't be
124 overwritten.
125
126 This files will be installed by default:
127
128 - /usr/local/sbin/ngircd: executable server
129 - /usr/local/etc/ngircd.conf: sample configuration (if not already present)
130 - /usr/local/share/doc/ngircd/: documentation
131
132
133 III. Additional features
134 ~~~~~~~~~~~~~~~~~~~~~~~~
135
136 The following optional features can be compiled into the daemon by passing
137 options to the "configure" script. Most options can handle a <path> argument
138 which will be used to search for the required libraries and header files in
139 the given paths ("<path>/lib/...", "<path>/include/...") in addition to the
140 standard locations.
141
142 * Syslog Logging (autodetected by default): 
143   --with-syslog[=<path>] / --without-syslog
144
145   Enable (disable) support for logging to "syslog", which should be
146   available on most modern UNIX-like operating systems by default.
147
148 * ZLib Compression (autodetected by default):
149   --with-zlib[=<path>] / --without-zlib
150
151   Enable (disable) support for compressed server-server links.
152   The Z compression library ("libz") is required for this option.
153   
154 * IO Backend (autodetected by default):
155   --with-select[=<path>] / --without-select
156   --with-poll[=<path>] / --without-poll
157   --with-devpoll[=<path>] / --without-devpoll
158   --with-epoll[=<path>] / --without-epoll
159   --with-kqueue[=<path>] / --without-kqueue  
160
161   ngIRCd can use different IO "backends": the "old school" select() and poll()
162   API which should be supported by most UNIX-like operating systems, or the
163   more efficient and flexible epoll() (Linux >=2.6), kqueue() (BSD) and
164   /dev/poll APIs.
165   By default the IO backend is autodetected, but you can use "--without-xxx"
166   to disable a more enhanced API.
167   When using the epoll() API, support for select() is compiled in as well by
168   default to enable the binary to run on older Linux kernels (<2.6), too.
169
170 * IDENT-Support:
171   --with-ident[=<path>]
172
173   Include support for IDENT ("AUTH") lookups. The "ident" library is
174   required for this option.
175
176 * ZeroConf Support:
177   --with-zeroconf[=<path>] 
178
179   Compile ngIRCd with support for ZeroConf multicast DNS service registration.
180   Either the Apple ZeroConf implementation (e. g. Mac OS X) or the Howl
181   library is required. Which one is available is autodetected.
182
183 * TCP-Wrappers:
184   --with-tcp-wrappers[=<path>] 
185
186   Include support for Wietse Venemas "TCP Wrappers" to limit client access
187   to the daemon, for example by using "/etc/hosts.{allow|deny}".
188   The "libwrap" is required for this option.
189
190 * PAM:
191   --with-pam[=<path>]
192
193   Enable support for PAM, the Pluggable Authentication Modules library.
194   See doc/PAM.txt for details.
195
196 * SSL:
197   --with-openssl[=<path>]
198   --with-gnutls[=<path>]
199
200   Enable support for SSL/TLS using OpenSSL or gnutls libraries.
201   See doc/SSL.txt for details.
202
203 * IPv6:
204   --enable-ipv6
205
206   Adds support for version 6 of the Internet Protocol.
207
208
209 IV. Useful make-targets
210 ~~~~~~~~~~~~~~~~~~~~~~~
211
212 The Makefile produced by the configure-script contains always these useful
213 targets:
214
215  - clean: delete every product from the compiler/linker
216    next step: -> make
217
218  - distclean: the above plus erase all generated Makefiles
219    next step: -> ./configure
220
221  - maintainer-clean: erase all automatic generated files
222    next step: -> ./autogen.sh
223
224
225 V. Sample configuration file ngircd.conf
226 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
227
228 In the sample configuration file, there are comments beginning with "#" OR
229 ";" -- this is only for the better understanding of the file.
230
231 The file is separated in four blocks: [Global], [Operator], [Server], and
232 [Channel].
233
234 In the [Global] section, there is the main configuration like the server
235 name and the ports, on which the server should be listening. IRC operators
236 of this server are defined in [Operator] blocks. [Server] is the section
237 where server links are configured. And [Channel] blocks are used to
238 configure pre-defined ("persistent") IRC channels.
239
240 The meaning of the variables in the configuration file is explained in the 
241 "doc/sample-ngircd.conf", which is used as sample configuration file in
242 /usr/local/etc after running "make install" (if you don't already have one)
243 and in the "ngircd.conf" manual page.
244
245
246 VI. Command line options
247 ~~~~~~~~~~~~~~~~~~~~~~~~
248
249 These parameters could be passed to the ngIRCd:
250
251 -f, --config <file>
252         The daemon uses the file <file> as configuration file rather than
253         the standard configuration /usr/local/etc/ngircd.conf.
254
255 -n, --nodaemon
256         ngIRCd should be running as a foreground process.
257
258 -p, --passive
259         Server-links won't be automatically established.
260
261 -t, --configtest
262         Reads, validates and dumps the configuration file as interpreted
263         by the server. Then exits.
264
265 Use "--help" to see a short help text describing all available parameters
266 the server understands, with "--version" the ngIRCd shows its version
267 number. In both cases the server exits after the output.