ngIRCd - Next Generation IRC Server
+ http://ngircd.barton.de/
- (c)2001-2006 by Alexander Barton,
- alex@barton.de, http://www.barton.de/
-
+ (c)2001-2011 Alexander Barton and Contributors.
ngIRCd is free software and published under the
terms of the GNU General Public License.
-- INSTALL --
-
I. Upgrade Information
~~~~~~~~~~~~~~~~~~~~~~
+Differences to version 17
+
+- Support for ZeroConf/Bonjour/Rendezvous service registration has been
+ removed. The configuration option "NoZeroconf" is no longer available.
+
+Differences to version 16
+
+- Changes to the "MotdFile" specified in ngircd.conf now require a ngircd
+ configuration reload to take effect (HUP signal, REHASH command).
+
Differences to version 0.9.x
- The option of the configure script to enable support for Zeroconf/Bonjour/
automake ("configure") should be no problem.
The normal installation procedure after getting (and expanding) the source
-files (using a distribution archive or CVS) is as following:
+files (using a distribution archive or GIT) is as following:
- 1) ./autogen.sh [only necessary when using CVS]
+ 1) ./autogen.sh [only necessary when using GIT]
2) ./configure
3) make
4) make install
The next step is to configure and afterwards starting the daemon. Please
have a look at the ngircd(8) and ngircd.conf(5) manual pages for details
-and all possible options.
+and all possible options -- and don't forget to run "ngircd --configtest"
+to validate your configuration file!
If no previous version of the configuration file exists (the standard name
is /usr/local/etc/ngircd.conf), a sample configuration file containing all
The first step, autogen.sh, is only necessary if the configure-script isn't
already generated. This never happens in official ("stable") releases in
-tar.gz-archives, but when using CVS.
+tar.gz-archives, but when using GIT.
This step is therefore only interesting for developers.
step. If there is already an older configuration file present, it won't be
overwritten.
-This files will be installed by default:
+These files and folders will be installed by default:
- /usr/local/sbin/ngircd: executable server
- /usr/local/etc/ngircd.conf: sample configuration (if not already present)
- /usr/local/share/doc/ngircd/: documentation
+- /usr/local/share/man/: manual pages
III. Additional features
Include support for IDENT ("AUTH") lookups. The "ident" library is
required for this option.
-* ZeroConf Support:
- --with-zeroconf[=<path>]
-
- Compile ngIRCd with support for ZeroConf multicast DNS service registration.
- Either the Apple ZeroConf implementation (e. g. Mac OS X) or the Howl
- library is required. Which one is available is autodetected.
-
* TCP-Wrappers:
--with-tcp-wrappers[=<path>]
to the daemon, for example by using "/etc/hosts.{allow|deny}".
The "libwrap" is required for this option.
+* PAM:
+ --with-pam[=<path>]
+
+ Enable support for PAM, the Pluggable Authentication Modules library.
+ See doc/PAM.txt for details.
+
+* SSL:
+ --with-openssl[=<path>]
+ --with-gnutls[=<path>]
+
+ Enable support for SSL/TLS using OpenSSL or gnutls libraries.
+ See doc/SSL.txt for details.
+
+* IPv6:
+ --enable-ipv6
+
+ Adds support for version 6 of the Internet Protocol.
+
IV. Useful make-targets
~~~~~~~~~~~~~~~~~~~~~~~
In the sample configuration file, there are comments beginning with "#" OR
";" -- this is only for the better understanding of the file.
-The file is separated in four blocks: [Global], [Operator], [Server], and
-[Channel].
+The file is separated in five blocks: [Global], [Features], [Operator],
+[Server], and [Channel].
In the [Global] section, there is the main configuration like the server
-name and the ports, on which the server should be listening. IRC operators
-of this server are defined in [Operator] blocks. [Server] is the section
-where server links are configured. And [Channel] blocks are used to
-configure pre-defined ("persistent") IRC channels.
+name and the ports, on which the server should be listening. Options in
+the [Features] section enable or disable functionality in the daemon.
+IRC operators of this server are defined in [Operator] blocks, remote
+servers are configured in [Server] sections, and [Channel] blocks are
+used to configure pre-defined ("persistent") IRC channels.
The meaning of the variables in the configuration file is explained in the
"doc/sample-ngircd.conf", which is used as sample configuration file in
/usr/local/etc after running "make install" (if you don't already have one)
-and in the "ngircd.conf" manual page.
+and in the ngircd.conf(5) manual page.
VI. Command line options
the server understands, with "--version" the ngIRCd shows its version
number. In both cases the server exits after the output.
-
---
-$Id: INSTALL,v 1.25 2006/12/28 13:53:19 alex Exp $
+Please see the ngircd(8) manual page for complete details!