2 194f18c8 2001-12-31 alex ngIRCd - Next Generation IRC Server
3 6d11fb14 2011-01-09 alex http://ngircd.barton.de/
5 2bb917f0 2017-01-15 alex (c)2001-2017 Alexander Barton and Contributors.
6 fd4a6b5d 2003-03-04 alex ngIRCd is free software and published under the
7 fd4a6b5d 2003-03-04 alex terms of the GNU General Public License.
9 fd4a6b5d 2003-03-04 alex -- INSTALL --
12 fd4a6b5d 2003-03-04 alex I. Upgrade Information
13 fd4a6b5d 2003-03-04 alex ~~~~~~~~~~~~~~~~~~~~~~
15 6e423544 2014-10-26 alex Differences to version 22.x
17 85dc4d87 2015-08-01 alex - The "NoticeAuth" ngircd.conf configuration variable has been renamed to
18 85dc4d87 2015-08-01 alex "NoticeBeforeRegistration". The old "NoticeAuth" variable still works but
19 85dc4d87 2015-08-01 alex is deprecated now.
21 6e423544 2014-10-26 alex - The default value of the SSL "CipherList" variable has been changed to
22 6e423544 2014-10-26 alex "HIGH:!aNULL:@STRENGTH:!SSLv3" (OpenSSL) and "SECURE128:-VERS-SSL3.0"
23 6e423544 2014-10-26 alex (GnuTLS) to disable the old SSLv3 protocol by default.
24 6e423544 2014-10-26 alex To enable connections of clients still requiring the weak SSLv3 protocol,
25 6e423544 2014-10-26 alex the "CipherList" must be set to its old value (not recommended!), which
26 6e423544 2014-10-26 alex was "HIGH:!aNULL:@STRENGTH" (OpenSSL) and "SECURE128" (GnuTLS), see below.
28 ea8a2bf1 2013-10-07 alex Differences to version 20.x
30 0985d69c 2013-09-17 fgsch - Starting with ngIRCd 21, the ciphers used by SSL are configurable and
31 6e423544 2014-10-26 alex default to "HIGH:!aNULL:@STRENGTH" (OpenSSL) or "SECURE128" (GnuTLS).
32 6e423544 2014-10-26 alex Previous version were using the OpenSSL or GnuTLS defaults, "DEFAULT"
33 6e423544 2014-10-26 alex and "NORMAL" respectively.
35 ea8a2bf1 2013-10-07 alex - When adding GLINE's or KLINE's to ngIRCd 21 (or newer), all clients matching
36 ea8a2bf1 2013-10-07 alex the new mask will be KILL'ed. This was not the case with earlier versions
37 ea8a2bf1 2013-10-07 alex that only added the mask but didn't kill already connected users.
39 cb3a4321 2015-09-06 alex - The "PredefChannelsOnly" configuration variable has been superseded by the
40 34578b8b 2015-08-01 alex new "AllowedChannelTypes" variable. It is still supported and translated to
41 cb3a4321 2015-09-06 alex the appropriate "AllowedChannelTypes" setting but is deprecated now.
43 d21afce2 2012-09-26 alex Differences to version 19.x
45 d21afce2 2012-09-26 alex - Starting with ngIRCd 20, users can "cloak" their hostname only when the
46 d21afce2 2012-09-26 alex configuration variable "CloakHostModeX" (introduced in 19.2) is set.
47 0985d69c 2013-09-17 fgsch Otherwise, only IRC operators, other servers, and services are allowed to
48 d21afce2 2012-09-26 alex set mode +x. This prevents regular users from changing their hostmask to
49 d21afce2 2012-09-26 alex the name of the IRC server itself, which confused quite a few people ;-)
51 34578b8b 2015-08-01 alex Differences to version 17.x
53 4a6d44dc 2011-01-09 alex - Support for ZeroConf/Bonjour/Rendezvous service registration has been
54 4a6d44dc 2011-01-09 alex removed. The configuration option "NoZeroconf" is no longer available.
56 3282c132 2011-06-26 alex - The structure of ngircd.conf has been cleaned up and three new configuration
57 3282c132 2011-06-26 alex sections have been introduced: [Limits], [Options], and [SSL].
58 3282c132 2011-06-26 alex Lots of configuration variables stored in the [Global] section are now
59 3282c132 2011-06-26 alex deprecated there and should be stored in one of these new sections (but
60 3282c132 2011-06-26 alex still work in [Global]):
61 3282c132 2011-06-26 alex "AllowRemoteOper" -> [Options]
62 3282c132 2011-06-26 alex "ChrootDir" -> [Options]
63 3282c132 2011-06-26 alex "ConnectIPv4" -> [Options]
64 3282c132 2011-06-26 alex "ConnectIPv6" -> [Options]
65 3282c132 2011-06-26 alex "ConnectRetry" -> [Limits]
66 3282c132 2011-06-26 alex "MaxConnections" -> [Limits]
67 3282c132 2011-06-26 alex "MaxConnectionsIP" -> [Limits]
68 3282c132 2011-06-26 alex "MaxJoins" -> [Limits]
69 3282c132 2011-06-26 alex "MaxNickLength" -> [Limits]
70 3282c132 2011-06-26 alex "NoDNS" -> [Options], and renamed to "DNS"
71 3282c132 2011-06-26 alex "NoIdent" -> [Options], and renamed to "Ident"
72 3282c132 2011-06-26 alex "NoPAM" -> [Options], and renamed to "PAM"
73 3282c132 2011-06-26 alex "OperCanUseMode" -> [Options]
74 3282c132 2011-06-26 alex "OperServerMode" -> [Options]
75 3282c132 2011-06-26 alex "PingTimeout" -> [Limits]
76 3282c132 2011-06-26 alex "PongTimeout" -> [Limits]
77 3282c132 2011-06-26 alex "PredefChannelsOnly" -> [Options]
78 3282c132 2011-06-26 alex "SSLCertFile" -> [SSL], and renamed to "CertFile"
79 3282c132 2011-06-26 alex "SSLDHFile" -> [SSL], and renamed to "DHFile"
80 3282c132 2011-06-26 alex "SSLKeyFile" -> [SSL], and renamed to "KeyFile"
81 3282c132 2011-06-26 alex "SSLKeyFilePassword" -> [SSL], and renamed to "KeyFilePassword"
82 3282c132 2011-06-26 alex "SSLPorts" -> [SSL], and renamed to "Ports"
83 3282c132 2011-06-26 alex "SyslogFacility" -> [Options]
84 3282c132 2011-06-26 alex "WebircPassword" -> [Options]
85 3282c132 2011-06-26 alex You should adjust your ngircd.conf and run "ngircd --configtest" to make
86 3282c132 2011-06-26 alex sure that your settings are correct and up to date!
88 34578b8b 2015-08-01 alex Differences to version 16.x
90 90a18615 2010-08-29 alex - Changes to the "MotdFile" specified in ngircd.conf now require a ngircd
91 90a18615 2010-08-29 alex configuration reload to take effect (HUP signal, REHASH command).
93 0e2f5a4f 2005-07-08 alex Differences to version 0.9.x
95 0e2f5a4f 2005-07-08 alex - The option of the configure script to enable support for Zeroconf/Bonjour/
96 0e2f5a4f 2005-07-08 alex Rendezvous/WhateverItIsNamedToday has been renamed:
97 0e2f5a4f 2005-07-08 alex --with-rendezvous -> --with-zeroconf
99 0993ff81 2005-02-10 alex Differences to version 0.8.x
101 0993ff81 2005-02-10 alex - The maximum length of passwords has been raised to 20 characters (instead
102 0993ff81 2005-02-10 alex of 8 characters). If your passwords are longer than 8 characters then they
103 0993ff81 2005-02-10 alex are cut at an other position now.
105 7640aa51 2003-03-07 alex Differences to version 0.6.x
107 7640aa51 2003-03-07 alex - Some options of the configure script have been renamed:
108 7640aa51 2003-03-07 alex --disable-syslog -> --without-syslog
109 7640aa51 2003-03-07 alex --disable-zlib -> --without-zlib
110 7640aa51 2003-03-07 alex Please call "./configure --help" to review the full list of options!
112 fd4a6b5d 2003-03-04 alex Differences to version 0.5.x
114 a84b9d99 2003-03-09 alex - Starting with version 0.6.0, other servers are identified using asynchronous
115 fd4a6b5d 2003-03-04 alex passwords: therefore the variable "Password" in [Server]-sections has been
116 fd4a6b5d 2003-03-04 alex replaced by "MyPassword" and "PeerPassword".
118 fd4a6b5d 2003-03-04 alex - New configuration variables, section [Global]: MaxConnections, MaxJoins
119 fd4a6b5d 2003-03-04 alex (see example configuration file "doc/sample-ngircd.conf"!).
122 fd4a6b5d 2003-03-04 alex II. Standard Installation
123 fd4a6b5d 2003-03-04 alex ~~~~~~~~~~~~~~~~~~~~~~~~~
125 312e4aeb 2003-03-23 alex ngIRCd is developed for UNIX-based systems, which means that the installation
126 312e4aeb 2003-03-23 alex on modern UNIX-like systems that are supported by GNU autoconf and GNU
127 fd4a6b5d 2003-03-04 alex automake ("configure") should be no problem.
129 fd4a6b5d 2003-03-04 alex The normal installation procedure after getting (and expanding) the source
130 09968ee8 2008-04-24 alex files (using a distribution archive or GIT) is as following:
132 c9b152fa 2012-05-18 alex 0) Satisfy prerequisites
133 c9b152fa 2012-05-18 alex 1) ./autogen.sh [only necessary when using GIT]
134 fd4a6b5d 2003-03-04 alex 2) ./configure
136 fd4a6b5d 2003-03-04 alex 4) make install
138 d27196e3 2004-09-03 alex (Please see details below!)
140 d27196e3 2004-09-03 alex Now the newly compiled executable "ngircd" is installed in its standard
141 d27196e3 2004-09-03 alex location, /usr/local/sbin/.
143 d27196e3 2004-09-03 alex The next step is to configure and afterwards starting the daemon. Please
144 d27196e3 2004-09-03 alex have a look at the ngircd(8) and ngircd.conf(5) manual pages for details
145 d587926e 2011-03-23 alex and all possible options -- and don't forget to run "ngircd --configtest"
146 d587926e 2011-03-23 alex to validate your configuration file!
148 d27196e3 2004-09-03 alex If no previous version of the configuration file exists (the standard name
149 d27196e3 2004-09-03 alex is /usr/local/etc/ngircd.conf), a sample configuration file containing all
150 d27196e3 2004-09-03 alex possible options will be installed there. You'll find its template in the
151 d27196e3 2004-09-03 alex doc/ directory: sample-ngircd.conf.
154 c9b152fa 2012-05-18 alex 0): Satisfy prerequisites
156 c9b152fa 2012-05-18 alex When building from source, you'll need some other software to build ngIRCd:
157 c9b152fa 2012-05-18 alex for example a working C compiler, make tool, GNU automake and autoconf (only
158 c9b152fa 2012-05-18 alex when not using a distribution archive), and a few libraries depending on the
159 c9b152fa 2012-05-18 alex features you want to compile in (like IDENT support, SSL, and PAM).
161 c9b152fa 2012-05-18 alex If you are using one of the "big" operating systems or Linux distributions,
162 c9b152fa 2012-05-18 alex you can use the following commands to install all the required packages to
163 c9b152fa 2012-05-18 alex build the sources including all optional features and to run the test suite:
165 cb3a4321 2015-09-06 alex * Red Hat / Fedora based distributions:
167 c9b152fa 2012-05-18 alex yum install \
168 c9b152fa 2012-05-18 alex autoconf automake expect gcc glibc-devel gnutls-devel \
169 c9b152fa 2012-05-18 alex libident-devel make pam-devel tcp_wrappers-devel telnet zlib-devel
171 c9b152fa 2012-05-18 alex * Debian / Ubuntu based distributions:
173 c9b152fa 2012-05-18 alex apt-get install \
174 c9b152fa 2012-05-18 alex autoconf automake build-essential expect libgnutls-dev \
175 c9b152fa 2012-05-18 alex libident-dev libpam-dev libwrap0-dev libz-dev telnet
178 fd4a6b5d 2003-03-04 alex 1): "autogen.sh"
180 fd4a6b5d 2003-03-04 alex The first step, autogen.sh, is only necessary if the configure-script isn't
181 fd4a6b5d 2003-03-04 alex already generated. This never happens in official ("stable") releases in
182 09968ee8 2008-04-24 alex tar.gz-archives, but when using GIT.
184 a84b9d99 2003-03-09 alex This step is therefore only interesting for developers.
186 fd4a6b5d 2003-03-04 alex autogen.sh produces the Makefile.in's, which are necessary for the configure
187 fd4a6b5d 2003-03-04 alex script itself, and some more files for make. To run autogen.sh you'll need
188 a3f3a109 2012-09-24 alex GNU autoconf and GNU automake: at least autoconf 2.61 and automake 1.10 are
189 cb3a4321 2015-09-06 alex required, newer is better. But don't use automake 1.12 or newer for creating
190 3f1547ec 2014-09-04 alex distribution archives: it will work but lack "de-ANSI-fication" support in the
191 a3f3a109 2012-09-24 alex generated Makefile's! Stick with automake 1.11.x for this purpose ...
192 a3f3a109 2012-09-24 alex So automake 1.11.x and autoconf 2.67+ is recommended.
194 a3f3a109 2012-09-24 alex Again: "end users" do not need this step and neither need GNU autoconf nor GNU
195 a3f3a109 2012-09-24 alex automake at all!
198 23a28fa3 2003-03-08 alex 2): "./configure"
200 a84b9d99 2003-03-09 alex The configure-script is used to detect local system dependencies.
202 bd118c65 2011-06-28 alex In the perfect case, configure should recognize all needed libraries, header
203 fd4a6b5d 2003-03-04 alex files and so on. If this shouldn't work, "./configure --help" shows all
204 fd4a6b5d 2003-03-04 alex possible options.
206 fd4a6b5d 2003-03-04 alex In addition, you can pass some command line options to "configure" to enable
207 fd4a6b5d 2003-03-04 alex and/or disable some features of ngIRCd. All these options are shown using
208 fd4a6b5d 2003-03-04 alex "./configure --help", too.
210 7281b8dd 2004-05-07 alex Compiling a static binary will avoid you the hassle of feeding a chroot dir
211 7281b8dd 2004-05-07 alex (if you want use the chroot feature). Just do something like:
212 7281b8dd 2004-05-07 alex CFLAGS=-static ./configure [--your-options ...]
213 7281b8dd 2004-05-07 alex Then you can use a void directory as ChrootDir (like OpenSSH's /var/empty).
218 fd4a6b5d 2003-03-04 alex The make command uses the Makefiles produced by configure and compiles the
219 fd4a6b5d 2003-03-04 alex ngIRCd daemon.
222 23a28fa3 2003-03-08 alex 4): "make install"
224 fd4a6b5d 2003-03-04 alex Use "make install" to install the server and a sample configuration file on
225 fd4a6b5d 2003-03-04 alex the local system. Normally, root privileges are necessary to complete this
226 fd4a6b5d 2003-03-04 alex step. If there is already an older configuration file present, it won't be
227 fd4a6b5d 2003-03-04 alex overwritten.
229 d587926e 2011-03-23 alex These files and folders will be installed by default:
231 a84b9d99 2003-03-09 alex - /usr/local/sbin/ngircd: executable server
232 fd4a6b5d 2003-03-04 alex - /usr/local/etc/ngircd.conf: sample configuration (if not already present)
233 4d656d12 2003-04-21 alex - /usr/local/share/doc/ngircd/: documentation
234 d587926e 2011-03-23 alex - /usr/local/share/man/: manual pages
237 6eb2e372 2005-12-30 alex III. Additional features
238 6eb2e372 2005-12-30 alex ~~~~~~~~~~~~~~~~~~~~~~~~
240 6eb2e372 2005-12-30 alex The following optional features can be compiled into the daemon by passing
241 6eb2e372 2005-12-30 alex options to the "configure" script. Most options can handle a <path> argument
242 6eb2e372 2005-12-30 alex which will be used to search for the required libraries and header files in
243 6eb2e372 2005-12-30 alex the given paths ("<path>/lib/...", "<path>/include/...") in addition to the
244 6eb2e372 2005-12-30 alex standard locations.
246 3f1547ec 2014-09-04 alex * Syslog Logging (autodetected by default):
247 6eb2e372 2005-12-30 alex --with-syslog[=<path>] / --without-syslog
249 6eb2e372 2005-12-30 alex Enable (disable) support for logging to "syslog", which should be
250 6eb2e372 2005-12-30 alex available on most modern UNIX-like operating systems by default.
252 6eb2e372 2005-12-30 alex * ZLib Compression (autodetected by default):
253 6eb2e372 2005-12-30 alex --with-zlib[=<path>] / --without-zlib
255 6eb2e372 2005-12-30 alex Enable (disable) support for compressed server-server links.
256 6eb2e372 2005-12-30 alex The Z compression library ("libz") is required for this option.
258 6eb2e372 2005-12-30 alex * IO Backend (autodetected by default):
259 95b7dbcc 2006-12-28 alex --with-select[=<path>] / --without-select
260 95b7dbcc 2006-12-28 alex --with-poll[=<path>] / --without-poll
261 95b7dbcc 2006-12-28 alex --with-devpoll[=<path>] / --without-devpoll
262 6eb2e372 2005-12-30 alex --with-epoll[=<path>] / --without-epoll
263 3f1547ec 2014-09-04 alex --with-kqueue[=<path>] / --without-kqueue
265 95b7dbcc 2006-12-28 alex ngIRCd can use different IO "backends": the "old school" select() and poll()
266 6eb2e372 2005-12-30 alex API which should be supported by most UNIX-like operating systems, or the
267 95b7dbcc 2006-12-28 alex more efficient and flexible epoll() (Linux >=2.6), kqueue() (BSD) and
268 95b7dbcc 2006-12-28 alex /dev/poll APIs.
269 6eb2e372 2005-12-30 alex By default the IO backend is autodetected, but you can use "--without-xxx"
270 95b7dbcc 2006-12-28 alex to disable a more enhanced API.
271 95b7dbcc 2006-12-28 alex When using the epoll() API, support for select() is compiled in as well by
272 95b7dbcc 2006-12-28 alex default to enable the binary to run on older Linux kernels (<2.6), too.
274 6eb2e372 2005-12-30 alex * IDENT-Support:
275 6eb2e372 2005-12-30 alex --with-ident[=<path>]
277 6eb2e372 2005-12-30 alex Include support for IDENT ("AUTH") lookups. The "ident" library is
278 6eb2e372 2005-12-30 alex required for this option.
280 6eb2e372 2005-12-30 alex * TCP-Wrappers:
281 3f1547ec 2014-09-04 alex --with-tcp-wrappers[=<path>]
283 6eb2e372 2005-12-30 alex Include support for Wietse Venemas "TCP Wrappers" to limit client access
284 6eb2e372 2005-12-30 alex to the daemon, for example by using "/etc/hosts.{allow|deny}".
285 6eb2e372 2005-12-30 alex The "libwrap" is required for this option.
288 761b2284 2010-07-11 alex --with-pam[=<path>]
290 761b2284 2010-07-11 alex Enable support for PAM, the Pluggable Authentication Modules library.
291 761b2284 2010-07-11 alex See doc/PAM.txt for details.
294 9c6230e1 2010-08-12 fw --with-openssl[=<path>]
295 9c6230e1 2010-08-12 fw --with-gnutls[=<path>]
297 9c6230e1 2010-08-12 fw Enable support for SSL/TLS using OpenSSL or gnutls libraries.
298 9c6230e1 2010-08-12 fw See doc/SSL.txt for details.
301 9c6230e1 2010-08-12 fw --enable-ipv6
303 9c6230e1 2010-08-12 fw Adds support for version 6 of the Internet Protocol.
306 6eb2e372 2005-12-30 alex IV. Useful make-targets
307 fd4a6b5d 2003-03-04 alex ~~~~~~~~~~~~~~~~~~~~~~~
309 fd4a6b5d 2003-03-04 alex The Makefile produced by the configure-script contains always these useful
312 fd4a6b5d 2003-03-04 alex - clean: delete every product from the compiler/linker
313 fd4a6b5d 2003-03-04 alex next step: -> make
315 fd4a6b5d 2003-03-04 alex - distclean: the above plus erase all generated Makefiles
316 fd4a6b5d 2003-03-04 alex next step: -> ./configure
318 a84b9d99 2003-03-09 alex - maintainer-clean: erase all automatic generated files
319 fd4a6b5d 2003-03-04 alex next step: -> ./autogen.sh
322 6eb2e372 2005-12-30 alex V. Sample configuration file ngircd.conf
323 6eb2e372 2005-12-30 alex ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
325 fd4a6b5d 2003-03-04 alex In the sample configuration file, there are comments beginning with "#" OR
326 fd4a6b5d 2003-03-04 alex ";" -- this is only for the better understanding of the file.
328 d587926e 2011-03-23 alex The file is separated in five blocks: [Global], [Features], [Operator],
329 d587926e 2011-03-23 alex [Server], and [Channel].
331 10bb43c6 2003-03-10 alex In the [Global] section, there is the main configuration like the server
332 d587926e 2011-03-23 alex name and the ports, on which the server should be listening. Options in
333 d587926e 2011-03-23 alex the [Features] section enable or disable functionality in the daemon.
334 d587926e 2011-03-23 alex IRC operators of this server are defined in [Operator] blocks, remote
335 d587926e 2011-03-23 alex servers are configured in [Server] sections, and [Channel] blocks are
336 d587926e 2011-03-23 alex used to configure pre-defined ("persistent") IRC channels.
338 3f1547ec 2014-09-04 alex The meaning of the variables in the configuration file is explained in the
339 fd4a6b5d 2003-03-04 alex "doc/sample-ngircd.conf", which is used as sample configuration file in
340 10bb43c6 2003-03-10 alex /usr/local/etc after running "make install" (if you don't already have one)
341 d587926e 2011-03-23 alex and in the ngircd.conf(5) manual page.
344 6eb2e372 2005-12-30 alex VI. Command line options
345 be54db83 2002-05-08 alex ~~~~~~~~~~~~~~~~~~~~~~~~
347 fd4a6b5d 2003-03-04 alex These parameters could be passed to the ngIRCd:
349 be54db83 2002-05-08 alex -f, --config <file>
350 fd4a6b5d 2003-03-04 alex The daemon uses the file <file> as configuration file rather than
351 fd4a6b5d 2003-03-04 alex the standard configuration /usr/local/etc/ngircd.conf.
353 be54db83 2002-05-08 alex -n, --nodaemon
354 fd4a6b5d 2003-03-04 alex ngIRCd should be running as a foreground process.
356 be54db83 2002-05-08 alex -p, --passive
357 fd4a6b5d 2003-03-04 alex Server-links won't be automatically established.
359 17fffea8 2004-02-22 alex -t, --configtest
360 fd4a6b5d 2003-03-04 alex Reads, validates and dumps the configuration file as interpreted
361 fd4a6b5d 2003-03-04 alex by the server. Then exits.
363 fd4a6b5d 2003-03-04 alex Use "--help" to see a short help text describing all available parameters
364 fd4a6b5d 2003-03-04 alex the server understands, with "--version" the ngIRCd shows its version
365 fd4a6b5d 2003-03-04 alex number. In both cases the server exits after the output.
367 d587926e 2011-03-23 alex Please see the ngircd(8) manual page for complete details!
