Services.txt 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. ngIRCd - Next Generation IRC Server
  2. http://ngircd.barton.de/
  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. -- Services.txt --
  7. At the moment, ngIRCd doesn't implement a "special IRC services interface".
  8. But services acting as a "regular server" are supported, either using the IRC
  9. protocol defined in RFC 1459 or RFC 2812.
  10. Support for Services has been tested using "IRC Services" version 5.x by
  11. Andrew Church (<http://achurch.org/services/>), and a Anope 1.9 using a
  12. preliminary protocol module for ngIRCd (<http://www.anope.org/>).
  13. This document describes setting up ngIRCd and these services.
  14. Setting up ngIRCd
  15. ~~~~~~~~~~~~~~~~~
  16. The "pseudo server" handling the IRC services is configured as a regular
  17. remote server in the ngircd.conf(5). In addition the variable "ServiceMask"
  18. should be set, enabling this ngIRCd to recognize the "pseudo users" as IRC
  19. services instead of regular IRC users.
  20. Example:
  21. [SERVER]
  22. Name = services.irc.net
  23. MyPassword = 123abc
  24. PeerPassword = 123abc
  25. ServiceMask = *Serv
  26. Setting up Anope 1.9.x
  27. ~~~~~~~~~~~~~~~~~~~~~~
  28. Anope 1.9.4 (and above) can be used with ngIRCd using a preliminary "ngircd"
  29. protocol module contained in our contrib/Anope/ directory. Please see the
  30. file contrib/Anope/README for installation instructions!
  31. After patching and installing Anope, at least the following configuration
  32. variables have to be adjusted in data/services.conf, in addition to all the
  33. settings marked as required:
  34. uplink
  35. {
  36. host = "server.irc.net"
  37. port = 6667
  38. password = "123abc"
  39. }
  40. serverinfo
  41. {
  42. name = "services.irc.net"
  43. type = "ngircd"
  44. }
  45. Setting up IRC Services 5.1.x
  46. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  47. IRC Services 5.1.3 and above can be used with ngIRCd using the "rfc1459"
  48. protocol module.
  49. Please note that versions up to and including 5.1.3 contain a bug that
  50. sometimes causes IRC Services to hang on startup. There are two workarounds:
  51. a) send the services process a HUP signal ("killall -HUP ircservices")
  52. b) apply this patch to the IRC Services source tree:
  53. <ftp://ngircd.barton.de/ngircd/contrib/IRCServices513-FlushBuffer.patch>
  54. At least the following settings have to be tweaked, in addition to all the
  55. settings marked as required by IRC Services:
  56. In ircservices.conf:
  57. Variable Example value
  58. RemoteServer server.irc.net 6667 "123abc"
  59. ServerName "services.irc.net"
  60. LoadModule protocol/rfc1459
  61. In modules.conf:
  62. Module protocol/rfc1459
  63. The documentation of IRC Services can be found here:
  64. <http://www.ircservices.za.net/docs/>
  65. Please let us know if you are successfully using other IRC service packages or
  66. which problems you encounter, thanks!