INSTALL

   1
   2                      ngIRCd - Next Generation IRC Server
   3
   4                       (c)2001-2003 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.5.x
  18
  19 - Starting with version 0.6.0, other servers are identified using asyncronous
  20   passwords: therefore the variable "Password" in [Server]-sections has been
  21   replaced by "MyPassword" and "PeerPassword".
  22
  23 - New configuration variables, section [Global]: MaxConnections, MaxJoins
  24   (see example configuration file "doc/sample-ngircd.conf"!).
  25
  26
  27 II. Standard Installation
  28 ~~~~~~~~~~~~~~~~~~~~~~~~~
  29
  30 ngIRCd is developed for UNIX-like systems, which means that the installation
  31 on modern UNIX-like systems witch are supported by GNU autoconf and GNU
  32 automake ("configure") should be no problem.
  33
  34 The normal installation procedure after getting (and expanding) the source
  35 files (using a distribution archive or CVS) is as following:
  36
  37   1) ./autogen.sh       [only necessary when using CVS]
  38   2) ./configure
  39   3) make
  40   4) make install
  41
  42 1): "autogen.sh"
  43
  44 The first step, autogen.sh, is only necessary if the configure-script isn't
  45 already generated. This never happens in official ("stable") releases in
  46 tar.gz-archieves, but when using CVS.
  47
  48 This step is therefore only interesting for developpers.
  49
  50 autogen.sh produces the Makefile.in's, which are necessary for the configure
  51 script itself, and some more files for make. To run autogen.sh you'll need
  52 GNU autoconf and GNU automake (in recent versions!).
  53
  54 Again: "end users" do not need this step!
  55
  56 4): "./configure"
  57
  58 The configure-script is used to detect local system dependancies.
  59
  60 In the perfect case, configure should recognize all needed libraries, header
  61 files and so on. If this shouldn't work, "./configure --help" shows all
  62 possible options.
  63
  64 In addition, you can pass some command line options to "configure" to enable
  65 and/or disable some features of ngIRCd. All these options are shown using
  66 "./configure --help", too.
  67
  68 5): "make"
  69
  70 The make command uses the Makefiles produced by configure and compiles the
  71 ngIRCd daemon.
  72
  73 6): "make install"
  74
  75 Use "make install" to install the server and a sample configuration file on
  76 the local system. Normally, root privileges are necessary to complete this
  77 step. If there is already an older configuration file present, it won't be
  78 overwritten.
  79
  80 This files will be installed by default:
  81
  82 - /usr/local/sbin/ngircd: exectable server
  83 - /usr/local/etc/ngircd.conf: sample configuration (if not already present)
  84
  85
  86 II. Useful make-targets
  87 ~~~~~~~~~~~~~~~~~~~~~~~
  88
  89 The Makefile produced by the configure-script contains always these useful
  90 targets:
  91
  92  - clean: delete every product from the compiler/linker
  93    next step: -> make
  94
  95  - distclean: the above plus erase all generated Makefiles
  96    next step: -> ./configure
  97
  98  - maintainer-clean: erease all automatic generated files
  99    next step: -> ./autogen.sh
 100
 101
 102 III. Sample configuration file ngircd.conf
 103 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 104
 105 In the sample configuration file, there are comments beginning with "#" OR
 106 ";" -- this is only for the better understanding of the file.
 107
 108 The file is seperated in four blocks: [Global], [Operator], [Server], and
 109 [Channel]. In the [Gobal] part, there is the main configuration, like the
 110 server-name and the ports, on which the server should be listening. In the
 111 [Operator] section, the server-operators are defined and [Server] is the
 112 section, where the server-links are configured. Use [Channel] blocks to
 113 configure pre-defined ("persistent") IRC channels.
 114
 115 The meaning of the variables in the configuration file is explained in the
 116 "doc/sample-ngircd.conf", which is used as sample configuration file in
 117 /usr/local/etc after running "make install" (if you don't already have one).
 118
 119
 120 IV. Command line options
 121 ~~~~~~~~~~~~~~~~~~~~~~~~
 122
 123 These parameters could be passed to the ngIRCd:
 124
 125 -f, --config <file>
 126         The daemon uses the file <file> as configuration file rather than
 127         the standard configuration /usr/local/etc/ngircd.conf.
 128
 129 -n, --nodaemon
 130         ngIRCd should be running as a foreground process.
 131
 132 -p, --passive
 133         Server-links won't be automatically established.
 134
 135 --configtest
 136         Reads, validates and dumps the configuration file as interpreted
 137         by the server. Then exits.
 138
 139 Use "--help" to see a short help text describing all available parameters
 140 the server understands, with "--version" the ngIRCd shows its version
 141 number. In both cases the server exits after the output.
 142
 143
 144 --
 145 $Id: INSTALL,v 1.10 2003/03/04 13:46:53 alex Exp $