X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=INSTALL;h=4e1cd2fb7916e779824b1bb08077ff278061fd0c;hp=58e5c38b87bf040866e065f59a5f3f370f4721cc;hb=b1b83831d199cc893606e924255a8747c97cd572;hpb=6bbc086760499cb829bf2055e67d4e52a3789794 diff --git a/INSTALL b/INSTALL index 58e5c38b..4e1cd2fb 100644 --- a/INSTALL +++ b/INSTALL @@ -1,19 +1,71 @@ ngIRCd - Next Generation IRC Server + http://ngircd.barton.de/ - (c)2001-2004 by Alexander Barton, - alex@barton.de, http://www.barton.de/ - + (c)2001-2012 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. + +- The structure of ngircd.conf has been cleaned up and three new configuration + sections have been introduced: [Limits], [Options], and [SSL]. + Lots of configuration variables stored in the [Global] section are now + deprecated there and should be stored in one of these new sections (but + still work in [Global]): + "AllowRemoteOper" -> [Options] + "ChrootDir" -> [Options] + "ConnectIPv4" -> [Options] + "ConnectIPv6" -> [Options] + "ConnectRetry" -> [Limits] + "MaxConnections" -> [Limits] + "MaxConnectionsIP" -> [Limits] + "MaxJoins" -> [Limits] + "MaxNickLength" -> [Limits] + "NoDNS" -> [Options], and renamed to "DNS" + "NoIdent" -> [Options], and renamed to "Ident" + "NoPAM" -> [Options], and renamed to "PAM" + "OperCanUseMode" -> [Options] + "OperServerMode" -> [Options] + "PingTimeout" -> [Limits] + "PongTimeout" -> [Limits] + "PredefChannelsOnly" -> [Options] + "SSLCertFile" -> [SSL], and renamed to "CertFile" + "SSLDHFile" -> [SSL], and renamed to "DHFile" + "SSLKeyFile" -> [SSL], and renamed to "KeyFile" + "SSLKeyFilePassword" -> [SSL], and renamed to "KeyFilePassword" + "SSLPorts" -> [SSL], and renamed to "Ports" + "SyslogFacility" -> [Options] + "WebircPassword" -> [Options] + You should adjust your ngircd.conf and run "ngircd --configtest" to make + sure that your settings are correct and up to date! + +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/ + Rendezvous/WhateverItIsNamedToday has been renamed: + --with-rendezvous -> --with-zeroconf + +Differences to version 0.8.x + +- The maximum length of passwords has been raised to 20 characters (instead + of 8 characters). If your passwords are longer than 8 characters then they + are cut at an other position now. + Differences to version 0.6.x - Some options of the configure script have been renamed: @@ -39,19 +91,59 @@ 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] + 0) Satisfy prerequisites + 1) ./autogen.sh [only necessary when using GIT] 2) ./configure 3) make 4) make install +(Please see details below!) + +Now the newly compiled executable "ngircd" is installed in its standard +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 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 +possible options will be installed there. You'll find its template in the +doc/ directory: sample-ngircd.conf. + + +0): Satisfy prerequisites + +When building from source, you'll need some other software to build ngIRCd: +for example a working C compiler, make tool, GNU automake and autoconf (only +when not using a distribution archive), and a few libraries depending on the +features you want to compile in (like IDENT support, SSL, and PAM). + +If you are using one of the "big" operating systems or Linux distributions, +you can use the following commands to install all the required packages to +build the sources including all optional features and to run the test suite: + +* RedHat / Fedora based distributions: + + yum install \ + autoconf automake expect gcc glibc-devel gnutls-devel \ + libident-devel make pam-devel tcp_wrappers-devel telnet zlib-devel + +* Debian / Ubuntu based distributions: + + apt-get install \ + autoconf automake build-essential expect libgnutls-dev \ + libident-dev libpam-dev libwrap0-dev libz-dev telnet + 1): "autogen.sh" 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. @@ -67,7 +159,7 @@ Again: "end users" do not need this step! The configure-script is used to detect local system dependencies. -In the perfect case, configure should recognise all needed libraries, header +In the perfect case, configure should recognize all needed libraries, header files and so on. If this shouldn't work, "./configure --help" shows all possible options. @@ -75,6 +167,11 @@ In addition, you can pass some command line options to "configure" to enable and/or disable some features of ngIRCd. All these options are shown using "./configure --help", too. +Compiling a static binary will avoid you the hassle of feeding a chroot dir +(if you want use the chroot feature). Just do something like: + CFLAGS=-static ./configure [--your-options ...] +Then you can use a void directory as ChrootDir (like OpenSSH's /var/empty). + 3): "make" @@ -89,14 +186,84 @@ 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 +~~~~~~~~~~~~~~~~~~~~~~~~ +The following optional features can be compiled into the daemon by passing +options to the "configure" script. Most options can handle a argument +which will be used to search for the required libraries and header files in +the given paths ("/lib/...", "/include/...") in addition to the +standard locations. -II. Useful make-targets +* Syslog Logging (autodetected by default): + --with-syslog[=] / --without-syslog + + Enable (disable) support for logging to "syslog", which should be + available on most modern UNIX-like operating systems by default. + +* ZLib Compression (autodetected by default): + --with-zlib[=] / --without-zlib + + Enable (disable) support for compressed server-server links. + The Z compression library ("libz") is required for this option. + +* IO Backend (autodetected by default): + --with-select[=] / --without-select + --with-poll[=] / --without-poll + --with-devpoll[=] / --without-devpoll + --with-epoll[=] / --without-epoll + --with-kqueue[=] / --without-kqueue + + ngIRCd can use different IO "backends": the "old school" select() and poll() + API which should be supported by most UNIX-like operating systems, or the + more efficient and flexible epoll() (Linux >=2.6), kqueue() (BSD) and + /dev/poll APIs. + By default the IO backend is autodetected, but you can use "--without-xxx" + to disable a more enhanced API. + When using the epoll() API, support for select() is compiled in as well by + default to enable the binary to run on older Linux kernels (<2.6), too. + +* IDENT-Support: + --with-ident[=] + + Include support for IDENT ("AUTH") lookups. The "ident" library is + required for this option. + +* TCP-Wrappers: + --with-tcp-wrappers[=] + + Include support for Wietse Venemas "TCP Wrappers" to limit client access + 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 ~~~~~~~~~~~~~~~~~~~~~~~ The Makefile produced by the configure-script contains always these useful @@ -112,28 +279,29 @@ targets: next step: -> ./autogen.sh -III. Sample configuration file ngircd.conf -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +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. -IV. Command line options +VI. Command line options ~~~~~~~~~~~~~~~~~~~~~~~~ These parameters could be passed to the ngIRCd: @@ -148,7 +316,7 @@ These parameters could be passed to the ngIRCd: -p, --passive Server-links won't be automatically established. ---configtest +-t, --configtest Reads, validates and dumps the configuration file as interpreted by the server. Then exits. @@ -156,6 +324,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.17 2004/01/26 02:23:54 alex Exp $ +Please see the ngircd(8) manual page for complete details!