INSTALL

   1
   2                      ngIRCd - Next Generation IRC Server
   3                            http://ngircd.barton.de/
   4
   5                (c)2001-2011 Alexander Barton and Contributors.
   6                ngIRCd is free software and published under the
   7                    terms of the GNU General Public License.
   8
   9                                 -- INSTALL --
  10
  11
  12 I. Upgrade Information
  13 ~~~~~~~~~~~~~~~~~~~~~~
  14
  15 Differences to version 17
  16
  17 - Support for ZeroConf/Bonjour/Rendezvous service registration has been
  18   removed. The configuration option "NoZeroconf" is no longer available.
  19
  20 Differences to version 16
  21
  22 - Changes to the "MotdFile" specified in ngircd.conf now require a ngircd
  23   configuration reload to take effect (HUP signal, REHASH command).
  24
  25 Differences to version 0.9.x
  26
  27 - The option of the configure script to enable support for Zeroconf/Bonjour/
  28   Rendezvous/WhateverItIsNamedToday has been renamed:
  29     --with-rendezvous  ->  --with-zeroconf
  30
  31 Differences to version 0.8.x
  32
  33 - The maximum length of passwords has been raised to 20 characters (instead
  34   of 8 characters). If your passwords are longer than 8 characters then they
  35   are cut at an other position now.
  36
  37 Differences to version 0.6.x
  38
  39 - Some options of the configure script have been renamed:
  40     --disable-syslog  ->  --without-syslog
  41     --disable-zlib    ->  --without-zlib
  42   Please call "./configure --help" to review the full list of options!
  43
  44 Differences to version 0.5.x
  45
  46 - Starting with version 0.6.0, other servers are identified using asynchronous
  47   passwords: therefore the variable "Password" in [Server]-sections has been
  48   replaced by "MyPassword" and "PeerPassword".
  49
  50 - New configuration variables, section [Global]: MaxConnections, MaxJoins
  51   (see example configuration file "doc/sample-ngircd.conf"!).
  52
  53
  54 II. Standard Installation
  55 ~~~~~~~~~~~~~~~~~~~~~~~~~
  56
  57 ngIRCd is developed for UNIX-based systems, which means that the installation
  58 on modern UNIX-like systems that are supported by GNU autoconf and GNU
  59 automake ("configure") should be no problem.
  60
  61 The normal installation procedure after getting (and expanding) the source
  62 files (using a distribution archive or GIT) is as following:
  63
  64   1) ./autogen.sh       [only necessary when using GIT]
  65   2) ./configure
  66   3) make
  67   4) make install
  68
  69 (Please see details below!)
  70
  71 Now the newly compiled executable "ngircd" is installed in its standard
  72 location, /usr/local/sbin/.
  73
  74 The next step is to configure and afterwards starting the daemon. Please
  75 have a look at the ngircd(8) and ngircd.conf(5) manual pages for details
  76 and all possible options -- and don't forget to run "ngircd --configtest"
  77 to validate your configuration file!
  78
  79 If no previous version of the configuration file exists (the standard name
  80 is /usr/local/etc/ngircd.conf), a sample configuration file containing all
  81 possible options will be installed there. You'll find its template in the
  82 doc/ directory: sample-ngircd.conf.
  83
  84
  85 1): "autogen.sh"
  86
  87 The first step, autogen.sh, is only necessary if the configure-script isn't
  88 already generated. This never happens in official ("stable") releases in
  89 tar.gz-archives, but when using GIT.
  90
  91 This step is therefore only interesting for developers.
  92
  93 autogen.sh produces the Makefile.in's, which are necessary for the configure
  94 script itself, and some more files for make. To run autogen.sh you'll need
  95 GNU autoconf and GNU automake (use recent versions! autoconf 2.53 and
  96 automake 1.6.1 are known to work).
  97
  98 Again: "end users" do not need this step!
  99
 100
 101 2): "./configure"
 102
 103 The configure-script is used to detect local system dependencies.
 104
 105 In the perfect case, configure should recognise all needed libraries, header
 106 files and so on. If this shouldn't work, "./configure --help" shows all
 107 possible options.
 108
 109 In addition, you can pass some command line options to "configure" to enable
 110 and/or disable some features of ngIRCd. All these options are shown using
 111 "./configure --help", too.
 112
 113 Compiling a static binary will avoid you the hassle of feeding a chroot dir
 114 (if you want use the chroot feature). Just do something like:
 115   CFLAGS=-static ./configure [--your-options ...]
 116 Then you can use a void directory as ChrootDir (like OpenSSH's /var/empty).
 117
 118
 119 3): "make"
 120
 121 The make command uses the Makefiles produced by configure and compiles the
 122 ngIRCd daemon.
 123
 124
 125 4): "make install"
 126
 127 Use "make install" to install the server and a sample configuration file on
 128 the local system. Normally, root privileges are necessary to complete this
 129 step. If there is already an older configuration file present, it won't be
 130 overwritten.
 131
 132 These files and folders will be installed by default:
 133
 134 - /usr/local/sbin/ngircd: executable server
 135 - /usr/local/etc/ngircd.conf: sample configuration (if not already present)
 136 - /usr/local/share/doc/ngircd/: documentation
 137 - /usr/local/share/man/: manual pages
 138
 139
 140 III. Additional features
 141 ~~~~~~~~~~~~~~~~~~~~~~~~
 142
 143 The following optional features can be compiled into the daemon by passing
 144 options to the "configure" script. Most options can handle a <path> argument
 145 which will be used to search for the required libraries and header files in
 146 the given paths ("<path>/lib/...", "<path>/include/...") in addition to the
 147 standard locations.
 148
 149 * Syslog Logging (autodetected by default):
 150   --with-syslog[=<path>] / --without-syslog
 151
 152   Enable (disable) support for logging to "syslog", which should be
 153   available on most modern UNIX-like operating systems by default.
 154
 155 * ZLib Compression (autodetected by default):
 156   --with-zlib[=<path>] / --without-zlib
 157
 158   Enable (disable) support for compressed server-server links.
 159   The Z compression library ("libz") is required for this option.
 160
 161 * IO Backend (autodetected by default):
 162   --with-select[=<path>] / --without-select
 163   --with-poll[=<path>] / --without-poll
 164   --with-devpoll[=<path>] / --without-devpoll
 165   --with-epoll[=<path>] / --without-epoll
 166   --with-kqueue[=<path>] / --without-kqueue
 167
 168   ngIRCd can use different IO "backends": the "old school" select() and poll()
 169   API which should be supported by most UNIX-like operating systems, or the
 170   more efficient and flexible epoll() (Linux >=2.6), kqueue() (BSD) and
 171   /dev/poll APIs.
 172   By default the IO backend is autodetected, but you can use "--without-xxx"
 173   to disable a more enhanced API.
 174   When using the epoll() API, support for select() is compiled in as well by
 175   default to enable the binary to run on older Linux kernels (<2.6), too.
 176
 177 * IDENT-Support:
 178   --with-ident[=<path>]
 179
 180   Include support for IDENT ("AUTH") lookups. The "ident" library is
 181   required for this option.
 182
 183 * TCP-Wrappers:
 184   --with-tcp-wrappers[=<path>]
 185
 186   Include support for Wietse Venemas "TCP Wrappers" to limit client access
 187   to the daemon, for example by using "/etc/hosts.{allow|deny}".
 188   The "libwrap" is required for this option.
 189
 190 * PAM:
 191   --with-pam[=<path>]
 192
 193   Enable support for PAM, the Pluggable Authentication Modules library.
 194   See doc/PAM.txt for details.
 195
 196 * SSL:
 197   --with-openssl[=<path>]
 198   --with-gnutls[=<path>]
 199
 200   Enable support for SSL/TLS using OpenSSL or gnutls libraries.
 201   See doc/SSL.txt for details.
 202
 203 * IPv6:
 204   --enable-ipv6
 205
 206   Adds support for version 6 of the Internet Protocol.
 207
 208
 209 IV. Useful make-targets
 210 ~~~~~~~~~~~~~~~~~~~~~~~
 211
 212 The Makefile produced by the configure-script contains always these useful
 213 targets:
 214
 215  - clean: delete every product from the compiler/linker
 216    next step: -> make
 217
 218  - distclean: the above plus erase all generated Makefiles
 219    next step: -> ./configure
 220
 221  - maintainer-clean: erase all automatic generated files
 222    next step: -> ./autogen.sh
 223
 224
 225 V. Sample configuration file ngircd.conf
 226 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 227
 228 In the sample configuration file, there are comments beginning with "#" OR
 229 ";" -- this is only for the better understanding of the file.
 230
 231 The file is separated in five blocks: [Global], [Features], [Operator],
 232 [Server], and [Channel].
 233
 234 In the [Global] section, there is the main configuration like the server
 235 name and the ports, on which the server should be listening. Options in
 236 the [Features] section enable or disable functionality in the daemon.
 237 IRC operators of this server are defined in [Operator] blocks, remote
 238 servers are configured in [Server] sections, and [Channel] blocks are
 239 used to configure pre-defined ("persistent") IRC channels.
 240
 241 The meaning of the variables in the configuration file is explained in the
 242 "doc/sample-ngircd.conf", which is used as sample configuration file in
 243 /usr/local/etc after running "make install" (if you don't already have one)
 244 and in the ngircd.conf(5) manual page.
 245
 246
 247 VI. Command line options
 248 ~~~~~~~~~~~~~~~~~~~~~~~~
 249
 250 These parameters could be passed to the ngIRCd:
 251
 252 -f, --config <file>
 253         The daemon uses the file <file> as configuration file rather than
 254         the standard configuration /usr/local/etc/ngircd.conf.
 255
 256 -n, --nodaemon
 257         ngIRCd should be running as a foreground process.
 258
 259 -p, --passive
 260         Server-links won't be automatically established.
 261
 262 -t, --configtest
 263         Reads, validates and dumps the configuration file as interpreted
 264         by the server. Then exits.
 265
 266 Use "--help" to see a short help text describing all available parameters
 267 the server understands, with "--version" the ngIRCd shows its version
 268 number. In both cases the server exits after the output.
 269
 270 Please see the ngircd(8) manual page for complete details!