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