INSTALL 8.9 KB

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