INSTALL

   1
   2                      ngIRCd - Next Generation IRC Server
   3
   4                       (c)2001-2004 by Alexander Barton,
   5                     alex@barton.de, http://www.barton.de/
   6
   7                ngIRCd is free software and published under the
   8                    terms of the GNU General Public License.
   9
  10                                 -- INSTALL --
  11
  12
  13
  14 I. Upgrade Information
  15 ~~~~~~~~~~~~~~~~~~~~~~
  16
  17 Differences to version 0.9.x
  18
  19 - The option of the configure script to enable support for Zeroconf/Bonjour/
  20   Rendezvous/WhateverItIsNamedToday has been renamed:
  21     --with-rendezvous  ->  --with-zeroconf
  22
  23 Differences to version 0.8.x
  24
  25 - The maximum length of passwords has been raised to 20 characters (instead
  26   of 8 characters). If your passwords are longer than 8 characters then they
  27   are cut at an other position now.
  28
  29 Differences to version 0.6.x
  30
  31 - Some options of the configure script have been renamed:
  32     --disable-syslog  ->  --without-syslog
  33     --disable-zlib    ->  --without-zlib
  34   Please call "./configure --help" to review the full list of options!
  35
  36 Differences to version 0.5.x
  37
  38 - Starting with version 0.6.0, other servers are identified using asynchronous
  39   passwords: therefore the variable "Password" in [Server]-sections has been
  40   replaced by "MyPassword" and "PeerPassword".
  41
  42 - New configuration variables, section [Global]: MaxConnections, MaxJoins
  43   (see example configuration file "doc/sample-ngircd.conf"!).
  44
  45
  46 II. Standard Installation
  47 ~~~~~~~~~~~~~~~~~~~~~~~~~
  48
  49 ngIRCd is developed for UNIX-based systems, which means that the installation
  50 on modern UNIX-like systems that are supported by GNU autoconf and GNU
  51 automake ("configure") should be no problem.
  52
  53 The normal installation procedure after getting (and expanding) the source
  54 files (using a distribution archive or CVS) is as following:
  55
  56   1) ./autogen.sh       [only necessary when using CVS]
  57   2) ./configure
  58   3) make
  59   4) make install
  60
  61 (Please see details below!)
  62
  63 Now the newly compiled executable "ngircd" is installed in its standard
  64 location, /usr/local/sbin/.
  65
  66 The next step is to configure and afterwards starting the daemon. Please
  67 have a look at the ngircd(8) and ngircd.conf(5) manual pages for details
  68 and all possible options.
  69
  70 If no previous version of the configuration file exists (the standard name
  71 is /usr/local/etc/ngircd.conf), a sample configuration file containing all
  72 possible options will be installed there. You'll find its template in the
  73 doc/ directory: sample-ngircd.conf.
  74
  75
  76 1): "autogen.sh"
  77
  78 The first step, autogen.sh, is only necessary if the configure-script isn't
  79 already generated. This never happens in official ("stable") releases in
  80 tar.gz-archives, but when using CVS.
  81
  82 This step is therefore only interesting for developers.
  83
  84 autogen.sh produces the Makefile.in's, which are necessary for the configure
  85 script itself, and some more files for make. To run autogen.sh you'll need
  86 GNU autoconf and GNU automake (use recent versions! autoconf 2.53 and
  87 automake 1.6.1 are known to work).
  88
  89 Again: "end users" do not need this step!
  90
  91
  92 2): "./configure"
  93
  94 The configure-script is used to detect local system dependencies.
  95
  96 In the perfect case, configure should recognise all needed libraries, header
  97 files and so on. If this shouldn't work, "./configure --help" shows all
  98 possible options.
  99
 100 In addition, you can pass some command line options to "configure" to enable
 101 and/or disable some features of ngIRCd. All these options are shown using
 102 "./configure --help", too.
 103
 104 Compiling a static binary will avoid you the hassle of feeding a chroot dir
 105 (if you want use the chroot feature). Just do something like:
 106   CFLAGS=-static ./configure [--your-options ...]
 107 Then you can use a void directory as ChrootDir (like OpenSSH's /var/empty).
 108
 109
 110 3): "make"
 111
 112 The make command uses the Makefiles produced by configure and compiles the
 113 ngIRCd daemon.
 114
 115
 116 4): "make install"
 117
 118 Use "make install" to install the server and a sample configuration file on
 119 the local system. Normally, root privileges are necessary to complete this
 120 step. If there is already an older configuration file present, it won't be
 121 overwritten.
 122
 123 This files will be installed by default:
 124
 125 - /usr/local/sbin/ngircd: executable server
 126 - /usr/local/etc/ngircd.conf: sample configuration (if not already present)
 127 - /usr/local/share/doc/ngircd/: documentation
 128
 129
 130 II. Useful make-targets
 131 ~~~~~~~~~~~~~~~~~~~~~~~
 132
 133 The Makefile produced by the configure-script contains always these useful
 134 targets:
 135
 136  - clean: delete every product from the compiler/linker
 137    next step: -> make
 138
 139  - distclean: the above plus erase all generated Makefiles
 140    next step: -> ./configure
 141
 142  - maintainer-clean: erase all automatic generated files
 143    next step: -> ./autogen.sh
 144
 145
 146 III. Sample configuration file ngircd.conf
 147 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 148
 149 In the sample configuration file, there are comments beginning with "#" OR
 150 ";" -- this is only for the better understanding of the file.
 151
 152 The file is separated in four blocks: [Global], [Operator], [Server], and
 153 [Channel].
 154
 155 In the [Global] section, there is the main configuration like the server
 156 name and the ports, on which the server should be listening. IRC operators
 157 of this server are defined in [Operator] blocks. [Server] is the section
 158 where server links are configured. And [Channel] blocks are used to
 159 configure pre-defined ("persistent") IRC channels.
 160
 161 The meaning of the variables in the configuration file is explained in the
 162 "doc/sample-ngircd.conf", which is used as sample configuration file in
 163 /usr/local/etc after running "make install" (if you don't already have one)
 164 and in the "ngircd.conf" manual page.
 165
 166
 167 IV. Command line options
 168 ~~~~~~~~~~~~~~~~~~~~~~~~
 169
 170 These parameters could be passed to the ngIRCd:
 171
 172 -f, --config <file>
 173         The daemon uses the file <file> as configuration file rather than
 174         the standard configuration /usr/local/etc/ngircd.conf.
 175
 176 -n, --nodaemon
 177         ngIRCd should be running as a foreground process.
 178
 179 -p, --passive
 180         Server-links won't be automatically established.
 181
 182 -t, --configtest
 183         Reads, validates and dumps the configuration file as interpreted
 184         by the server. Then exits.
 185
 186 Use "--help" to see a short help text describing all available parameters
 187 the server understands, with "--version" the ngIRCd shows its version
 188 number. In both cases the server exits after the output.
 189
 190
 191 --
 192 $Id: INSTALL,v 1.22 2005/07/08 16:23:00 alex Exp $