1. ngIRCd - Next Generation IRC Server
  2. (c)2001-2007 Alexander Barton,
  4. ngIRCd is free software and published under the
  5. terms of the GNU General Public License.
  6. -- INSTALL --
  7. I. Upgrade Information
  8. ~~~~~~~~~~~~~~~~~~~~~~
  9. Differences to version 0.9.x
  10. - The option of the configure script to enable support for Zeroconf/Bonjour/
  11. Rendezvous/WhateverItIsNamedToday has been renamed:
  12. --with-rendezvous -> --with-zeroconf
  13. Differences to version 0.8.x
  14. - The maximum length of passwords has been raised to 20 characters (instead
  15. of 8 characters). If your passwords are longer than 8 characters then they
  16. are cut at an other position now.
  17. Differences to version 0.6.x
  18. - Some options of the configure script have been renamed:
  19. --disable-syslog -> --without-syslog
  20. --disable-zlib -> --without-zlib
  21. Please call "./configure --help" to review the full list of options!
  22. Differences to version 0.5.x
  23. - Starting with version 0.6.0, other servers are identified using asynchronous
  24. passwords: therefore the variable "Password" in [Server]-sections has been
  25. replaced by "MyPassword" and "PeerPassword".
  26. - New configuration variables, section [Global]: MaxConnections, MaxJoins
  27. (see example configuration file "doc/sample-ngircd.conf"!).
  28. II. Standard Installation
  29. ~~~~~~~~~~~~~~~~~~~~~~~~~
  30. ngIRCd is developed for UNIX-based systems, which means that the installation
  31. on modern UNIX-like systems that are supported by GNU autoconf and GNU
  32. automake ("configure") should be no problem.
  33. The normal installation procedure after getting (and expanding) the source
  34. files (using a distribution archive or GIT) is as following:
  35. 1) ./ [only necessary when using GIT]
  36. 2) ./configure
  37. 3) make
  38. 4) make install
  39. (Please see details below!)
  40. Now the newly compiled executable "ngircd" is installed in its standard
  41. location, /usr/local/sbin/.
  42. The next step is to configure and afterwards starting the daemon. Please
  43. have a look at the ngircd(8) and ngircd.conf(5) manual pages for details
  44. and all possible options.
  45. If no previous version of the configuration file exists (the standard name
  46. is /usr/local/etc/ngircd.conf), a sample configuration file containing all
  47. possible options will be installed there. You'll find its template in the
  48. doc/ directory: sample-ngircd.conf.
  49. 1): ""
  50. The first step,, is only necessary if the configure-script isn't
  51. already generated. This never happens in official ("stable") releases in
  52. tar.gz-archives, but when using GIT.
  53. This step is therefore only interesting for developers.
  54. produces the's, which are necessary for the configure
  55. script itself, and some more files for make. To run you'll need
  56. GNU autoconf and GNU automake (use recent versions! autoconf 2.53 and
  57. automake 1.6.1 are known to work).
  58. Again: "end users" do not need this step!
  59. 2): "./configure"
  60. The configure-script is used to detect local system dependencies.
  61. In the perfect case, configure should recognise all needed libraries, header
  62. files and so on. If this shouldn't work, "./configure --help" shows all
  63. possible options.
  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. Compiling a static binary will avoid you the hassle of feeding a chroot dir
  68. (if you want use the chroot feature). Just do something like:
  69. CFLAGS=-static ./configure [--your-options ...]
  70. Then you can use a void directory as ChrootDir (like OpenSSH's /var/empty).
  71. 3): "make"
  72. The make command uses the Makefiles produced by configure and compiles the
  73. ngIRCd daemon.
  74. 4): "make install"
  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. This files will be installed by default:
  80. - /usr/local/sbin/ngircd: executable server
  81. - /usr/local/etc/ngircd.conf: sample configuration (if not already present)
  82. - /usr/local/share/doc/ngircd/: documentation
  83. III. Additional features
  84. ~~~~~~~~~~~~~~~~~~~~~~~~
  85. The following optional features can be compiled into the daemon by passing
  86. options to the "configure" script. Most options can handle a <path> argument
  87. which will be used to search for the required libraries and header files in
  88. the given paths ("<path>/lib/...", "<path>/include/...") in addition to the
  89. standard locations.
  90. * Syslog Logging (autodetected by default):
  91. --with-syslog[=<path>] / --without-syslog
  92. Enable (disable) support for logging to "syslog", which should be
  93. available on most modern UNIX-like operating systems by default.
  94. * ZLib Compression (autodetected by default):
  95. --with-zlib[=<path>] / --without-zlib
  96. Enable (disable) support for compressed server-server links.
  97. The Z compression library ("libz") is required for this option.
  98. * IO Backend (autodetected by default):
  99. --with-select[=<path>] / --without-select
  100. --with-poll[=<path>] / --without-poll
  101. --with-devpoll[=<path>] / --without-devpoll
  102. --with-epoll[=<path>] / --without-epoll
  103. --with-kqueue[=<path>] / --without-kqueue
  104. ngIRCd can use different IO "backends": the "old school" select() and poll()
  105. API which should be supported by most UNIX-like operating systems, or the
  106. more efficient and flexible epoll() (Linux >=2.6), kqueue() (BSD) and
  107. /dev/poll APIs.
  108. By default the IO backend is autodetected, but you can use "--without-xxx"
  109. to disable a more enhanced API.
  110. When using the epoll() API, support for select() is compiled in as well by
  111. default to enable the binary to run on older Linux kernels (<2.6), too.
  112. * IDENT-Support:
  113. --with-ident[=<path>]
  114. Include support for IDENT ("AUTH") lookups. The "ident" library is
  115. required for this option.
  116. * ZeroConf Support:
  117. --with-zeroconf[=<path>]
  118. Compile ngIRCd with support for ZeroConf multicast DNS service registration.
  119. Either the Apple ZeroConf implementation (e. g. Mac OS X) or the Howl
  120. library is required. Which one is available is autodetected.
  121. * TCP-Wrappers:
  122. --with-tcp-wrappers[=<path>]
  123. Include support for Wietse Venemas "TCP Wrappers" to limit client access
  124. to the daemon, for example by using "/etc/hosts.{allow|deny}".
  125. The "libwrap" is required for this option.
  126. IV. Useful make-targets
  127. ~~~~~~~~~~~~~~~~~~~~~~~
  128. The Makefile produced by the configure-script contains always these useful
  129. targets:
  130. - clean: delete every product from the compiler/linker
  131. next step: -> make
  132. - distclean: the above plus erase all generated Makefiles
  133. next step: -> ./configure
  134. - maintainer-clean: erase all automatic generated files
  135. next step: -> ./
  136. V. Sample configuration file ngircd.conf
  137. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  138. In the sample configuration file, there are comments beginning with "#" OR
  139. ";" -- this is only for the better understanding of the file.
  140. The file is separated in four blocks: [Global], [Operator], [Server], and
  141. [Channel].
  142. In the [Global] section, there is the main configuration like the server
  143. name and the ports, on which the server should be listening. IRC operators
  144. of this server are defined in [Operator] blocks. [Server] is the section
  145. where server links are configured. And [Channel] blocks are used to
  146. configure pre-defined ("persistent") IRC channels.
  147. The meaning of the variables in the configuration file is explained in the
  148. "doc/sample-ngircd.conf", which is used as sample configuration file in
  149. /usr/local/etc after running "make install" (if you don't already have one)
  150. and in the "ngircd.conf" manual page.
  151. VI. Command line options
  152. ~~~~~~~~~~~~~~~~~~~~~~~~
  153. These parameters could be passed to the ngIRCd:
  154. -f, --config <file>
  155. The daemon uses the file <file> as configuration file rather than
  156. the standard configuration /usr/local/etc/ngircd.conf.
  157. -n, --nodaemon
  158. ngIRCd should be running as a foreground process.
  159. -p, --passive
  160. Server-links won't be automatically established.
  161. -t, --configtest
  162. Reads, validates and dumps the configuration file as interpreted
  163. by the server. Then exits.
  164. Use "--help" to see a short help text describing all available parameters
  165. the server understands, with "--version" the ngIRCd shows its version
  166. number. In both cases the server exits after the output.