X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=INSTALL;h=8547efc16463fa7ac062f2754f173e5becc93511;hp=6c62a031aae96f79e10e27c5c8b858a283d35596;hb=dd7d64f577633d68a11b6dc0e97ec00df0645343;hpb=95b7dbcc187e5e16477b64215af947b5b53cbdec diff --git a/INSTALL b/INSTALL index 6c62a031..8547efc1 100644 --- a/INSTALL +++ b/INSTALL @@ -1,19 +1,27 @@ 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/ @@ -51,9 +59,9 @@ on modern UNIX-like systems that are supported by GNU autoconf and GNU 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 @@ -65,7 +73,8 @@ location, /usr/local/sbin/. 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 @@ -77,7 +86,7 @@ doc/ directory: sample-ngircd.conf. 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. @@ -120,11 +129,12 @@ the local system. Normally, root privileges are necessary to complete this 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 @@ -170,13 +180,6 @@ standard locations. Include support for IDENT ("AUTH") lookups. The "ident" library is required for this option. -* ZeroConf Support: - --with-zeroconf[=] - - 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[=] @@ -184,6 +187,24 @@ standard locations. to the daemon, for example by using "/etc/hosts.{allow|deny}". The "libwrap" is required for this option. +* PAM: + --with-pam[=] + + Enable support for PAM, the Pluggable Authentication Modules library. + See doc/PAM.txt for details. + +* SSL: + --with-openssl[=] + --with-gnutls[=] + + 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 ~~~~~~~~~~~~~~~~~~~~~~~ @@ -207,19 +228,20 @@ V. Sample configuration file ngircd.conf 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 @@ -245,6 +267,4 @@ Use "--help" to see a short help text describing all available parameters 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!