X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=INSTALL;h=302f52103318e240e7d1c5078928a5bca60a61a8;hp=b42a17ac4640e9a2bfe5e480e44d0eef3f365928;hb=a673a6e3af783c9c80cadd0cf3c963c754d84649;hpb=f4ade537d550b872b7e86e6ffce940dfbad4c60c diff --git a/INSTALL b/INSTALL index b42a17ac..302f5210 100644 --- a/INSTALL +++ b/INSTALL @@ -1,182 +1,367 @@ -Basic Installation -================== - - These are generic installation instructions. - - The `configure' shell script attempts to guess correct values for -various system-dependent variables used during compilation. It uses -those values to create a `Makefile' in each directory of the package. -It may also create one or more `.h' files containing system-dependent -definitions. Finally, it creates a shell script `config.status' that -you can run in the future to recreate the current configuration, a file -`config.cache' that saves the results of its tests to speed up -reconfiguring, and a file `config.log' containing compiler output -(useful mainly for debugging `configure'). - - If you need to do unusual things to compile the package, please try -to figure out how `configure' could check whether to do them, and mail -diffs or instructions to the address given in the `README' so they can -be considered for the next release. If at some point `config.cache' -contains results you don't want to keep, you may remove or edit it. - - The file `configure.in' is used to create `configure' by a program -called `autoconf'. You only need `configure.in' if you want to change -it or regenerate `configure' using a newer version of `autoconf'. - -The simplest way to compile this package is: - - 1. `cd' to the directory containing the package's source code and type - `./configure' to configure the package for your system. If you're - using `csh' on an old version of System V, you might need to type - `sh ./configure' instead to prevent `csh' from trying to execute - `configure' itself. - - Running `configure' takes awhile. While running, it prints some - messages telling which features it is checking for. - - 2. Type `make' to compile the package. - - 3. Optionally, type `make check' to run any self-tests that come with - the package. - - 4. Type `make install' to install the programs and any data files and - documentation. - - 5. You can remove the program binaries and object files from the - source code directory by typing `make clean'. To also remove the - files that `configure' created (so you can compile the package for - a different kind of computer), type `make distclean'. There is - also a `make maintainer-clean' target, but that is intended mainly - for the package's developers. If you use it, you may have to get - all sorts of other programs in order to regenerate files that came - with the distribution. - -Compilers and Options -===================== - - Some systems require unusual options for compilation or linking that -the `configure' script does not know about. You can give `configure' -initial values for variables by setting them in the environment. Using -a Bourne-compatible shell, you can do that on the command line like -this: - CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure - -Or on systems that have the `env' program, you can do it like this: - env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure - -Compiling For Multiple Architectures -==================================== - - You can compile the package for more than one kind of computer at the -same time, by placing the object files for each architecture in their -own directory. To do this, you must use a version of `make' that -supports the `VPATH' variable, such as GNU `make'. `cd' to the -directory where you want the object files and executables to go and run -the `configure' script. `configure' automatically checks for the -source code in the directory that `configure' is in and in `..'. - - If you have to use a `make' that does not supports the `VPATH' -variable, you have to compile the package for one architecture at a time -in the source code directory. After you have installed the package for -one architecture, use `make distclean' before reconfiguring for another -architecture. - -Installation Names -================== - - By default, `make install' will install the package's files in -`/usr/local/bin', `/usr/local/man', etc. You can specify an -installation prefix other than `/usr/local' by giving `configure' the -option `--prefix=PATH'. - - You can specify separate installation prefixes for -architecture-specific files and architecture-independent files. If you -give `configure' the option `--exec-prefix=PATH', the package will use -PATH as the prefix for installing programs and libraries. -Documentation and other data files will still use the regular prefix. - - In addition, if you use an unusual directory layout you can give -options like `--bindir=PATH' to specify different values for particular -kinds of files. Run `configure --help' for a list of the directories -you can set and what kinds of files go in them. - - If the package supports it, you can cause programs to be installed -with an extra prefix or suffix on their names by giving `configure' the -option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. - -Optional Features -================= - - Some packages pay attention to `--enable-FEATURE' options to -`configure', where FEATURE indicates an optional part of the package. -They may also pay attention to `--with-PACKAGE' options, where PACKAGE -is something like `gnu-as' or `x' (for the X Window System). The -`README' should mention any `--enable-' and `--with-' options that the -package recognizes. - - For packages that use the X Window System, `configure' can usually -find the X include and library files automatically, but if it doesn't, -you can use the `configure' options `--x-includes=DIR' and -`--x-libraries=DIR' to specify their locations. - -Specifying the System Type -========================== - - There may be some features `configure' can not figure out -automatically, but needs to determine by the type of host the package -will run on. Usually `configure' can figure that out, but if it prints -a message saying it can not guess the host type, give it the -`--host=TYPE' option. TYPE can either be a short name for the system -type, such as `sun4', or a canonical name with three fields: - CPU-COMPANY-SYSTEM - -See the file `config.sub' for the possible values of each field. If -`config.sub' isn't included in this package, then this package doesn't -need to know the host type. - - If you are building compiler tools for cross-compiling, you can also -use the `--target=TYPE' option to select the type of system they will -produce code for and the `--build=TYPE' option to select the type of -system on which you are compiling the package. - -Sharing Defaults -================ - - If you want to set default values for `configure' scripts to share, -you can create a site shell script called `config.site' that gives -default values for variables like `CC', `cache_file', and `prefix'. -`configure' looks for `PREFIX/share/config.site' if it exists, then -`PREFIX/etc/config.site' if it exists. Or, you can set the -`CONFIG_SITE' environment variable to the location of the site script. -A warning: not all `configure' scripts look for a site script. - -Operation Controls -================== - - `configure' recognizes the following options to control how it -operates. - -`--cache-file=FILE' - Use and save the results of the tests in FILE instead of - `./config.cache'. Set FILE to `/dev/null' to disable caching, for - debugging `configure'. - -`--help' - Print a summary of the options to `configure', and exit. - -`--quiet' -`--silent' -`-q' - Do not print messages saying which checks are being made. To - suppress all normal output, redirect it to `/dev/null' (any error - messages will still be shown). - -`--srcdir=DIR' - Look for the package's source code in directory DIR. Usually - `configure' can determine that directory automatically. - -`--version' - Print the version of Autoconf used to generate the `configure' - script, and exit. - -`configure' also accepts some other, not widely useful, options. + + ngIRCd - Next Generation IRC Server + http://ngircd.barton.de/ + + (c)2001-2016 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 22.x + +- The "NoticeAuth" ngircd.conf configuration variable has been renamed to + "NoticeBeforeRegistration". The old "NoticeAuth" variable still works but + is deprecated now. + +- The default value of the SSL "CipherList" variable has been changed to + "HIGH:!aNULL:@STRENGTH:!SSLv3" (OpenSSL) and "SECURE128:-VERS-SSL3.0" + (GnuTLS) to disable the old SSLv3 protocol by default. + To enable connections of clients still requiring the weak SSLv3 protocol, + the "CipherList" must be set to its old value (not recommended!), which + was "HIGH:!aNULL:@STRENGTH" (OpenSSL) and "SECURE128" (GnuTLS), see below. + +Differences to version 20.x + +- Starting with ngIRCd 21, the ciphers used by SSL are configurable and + default to "HIGH:!aNULL:@STRENGTH" (OpenSSL) or "SECURE128" (GnuTLS). + Previous version were using the OpenSSL or GnuTLS defaults, "DEFAULT" + and "NORMAL" respectively. + +- When adding GLINE's or KLINE's to ngIRCd 21 (or newer), all clients matching + the new mask will be KILL'ed. This was not the case with earlier versions + that only added the mask but didn't kill already connected users. + +- The "PredefChannelsOnly" configuration variable has been superseded by the + new "AllowedChannelTypes" variable. It is still supported and translated to + the appropriate "AllowedChannelTypes" setting but is deprecated now. + +Differences to version 19.x + +- Starting with ngIRCd 20, users can "cloak" their hostname only when the + configuration variable "CloakHostModeX" (introduced in 19.2) is set. + Otherwise, only IRC operators, other servers, and services are allowed to + set mode +x. This prevents regular users from changing their hostmask to + the name of the IRC server itself, which confused quite a few people ;-) + +Differences to version 17.x + +- 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.x + +- 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: + --disable-syslog -> --without-syslog + --disable-zlib -> --without-zlib + Please call "./configure --help" to review the full list of options! + +Differences to version 0.5.x + +- Starting with version 0.6.0, other servers are identified using asynchronous + passwords: therefore the variable "Password" in [Server]-sections has been + replaced by "MyPassword" and "PeerPassword". + +- New configuration variables, section [Global]: MaxConnections, MaxJoins + (see example configuration file "doc/sample-ngircd.conf"!). + + +II. Standard Installation +~~~~~~~~~~~~~~~~~~~~~~~~~ + +ngIRCd is developed for UNIX-based systems, which means that the installation +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 GIT) is as following: + + 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: + +* Red Hat / 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 GIT. + +This step is therefore only interesting for developers. + +autogen.sh produces the Makefile.in's, which are necessary for the configure +script itself, and some more files for make. To run autogen.sh you'll need +GNU autoconf and GNU automake: at least autoconf 2.61 and automake 1.10 are +required, newer is better. But don't use automake 1.12 or newer for creating +distribution archives: it will work but lack "de-ANSI-fication" support in the +generated Makefile's! Stick with automake 1.11.x for this purpose ... +So automake 1.11.x and autoconf 2.67+ is recommended. + +Again: "end users" do not need this step and neither need GNU autoconf nor GNU +automake at all! + + +2): "./configure" + +The configure-script is used to detect local system dependencies. + +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. + +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" + +The make command uses the Makefiles produced by configure and compiles the +ngIRCd daemon. + + +4): "make install" + +Use "make install" to install the server and a sample configuration file on +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. + +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. + +* 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 +targets: + + - clean: delete every product from the compiler/linker + next step: -> make + + - distclean: the above plus erase all generated Makefiles + next step: -> ./configure + + - maintainer-clean: erase all automatic generated files + next step: -> ./autogen.sh + + +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 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. 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(5) manual page. + + +VI. Command line options +~~~~~~~~~~~~~~~~~~~~~~~~ + +These parameters could be passed to the ngIRCd: + +-f, --config + The daemon uses the file as configuration file rather than + the standard configuration /usr/local/etc/ngircd.conf. + +-n, --nodaemon + ngIRCd should be running as a foreground process. + +-p, --passive + Server-links won't be automatically established. + +-t, --configtest + Reads, validates and dumps the configuration file as interpreted + by the server. Then exits. + +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. + +Please see the ngircd(8) manual page for complete details!