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