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