Services.txt 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  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. ngIRCd doesn't implement a "special IRC services interface", but services
  8. acting as a "regular servers" ("pseudo servers") are supported, either
  9. using the IRC protocol as defined in RFC 1459 or RFC 2812.
  10. Support for Services has been tested using
  11. - Anope 1.9.8 or later (<http://www.anope.org/>)
  12. - Atheme 7.0.2 or later (<https://atheme.org/>)
  13. - "IRC Services" 5.1.x by Andrew Church (<http://achurch.org/services/>)
  14. This document describes setting up ngIRCd and these services.
  15. Please let us know if you are successfully using other IRC service packages or
  16. which problems you encounter -- thanks!
  17. Setting up ngIRCd
  18. ~~~~~~~~~~~~~~~~~
  19. The "pseudo server" handling the IRC services is configured as a regular
  20. remote server in the ngircd.conf(5). In addition the variable "ServiceMask"
  21. should be set, enabling this ngIRCd to recognize the "pseudo users" as IRC
  22. services instead of regular IRC users.
  23. Example:
  24. [GLOBAL]
  25. Name = server.irc.net
  26. Ports = 6667
  27. [SERVER]
  28. Name = services.irc.net
  29. MyPassword = 123abc
  30. PeerPassword = 123abc
  31. ServiceMask = *Serv
  32. Setting up Anope 1.9.x & 2.x
  33. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  34. Anope 1.9.8 or later (<http://www.anope.org/>) can be used with ngIRCd using
  35. the "ngircd" protocol module.
  36. At least the following settings have to be tweaked, in addition to all the
  37. settings marked as required by Anope:
  38. In conf/services.conf:
  39. define
  40. {
  41. name = "services.host"
  42. value = "services.irc.net"
  43. }
  44. uplink
  45. {
  46. host = "server.irc.net"
  47. port = 6667
  48. password = "123abc"
  49. }
  50. # Load ngIRCd protocol module
  51. module
  52. {
  53. name = "ngircd"
  54. }
  55. networkinfo
  56. {
  57. # Must be set to the "MaxNickLength" setting of ngIRCd!
  58. nicklen = 9
  59. # When not using "strict mode", which is the default:
  60. userlen = 20
  61. chanlen = 50
  62. }
  63. In conf/nickserv.conf:
  64. module
  65. {
  66. name = "nickserv"
  67. # not required if you are running ngIRCd with a higher nickname limit
  68. # ("MaxNickLength") than 11 characters, but REQUIRED by default!
  69. guestnickprefix = "G-"
  70. }
  71. Setting up Atheme 7.0.2 or later
  72. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73. Atheme 7.0.2 or later (<https://atheme.org/>) may be used with ngIRCd using
  74. the "ngircd" protocol module.
  75. The following settings need to be in atheme.conf:
  76. loadmodule "modules/protocol/ngircd";
  77. serverinfo {
  78. name = "services.irc.net";
  79. }
  80. uplink "server.irc.net" {
  81. password = "123abc";
  82. port = 6667;
  83. };
  84. The documentation of Atheme can be found in the doc/ directory of the
  85. Atheme source distribution.
  86. Setting up IRC Services 5.1.x
  87. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  88. IRC Services 5.1.3 and above can be used with ngIRCd using the "rfc1459"
  89. protocol module.
  90. Please note that versions up to and including 5.1.3 contain a bug that
  91. sometimes causes IRC Services to hang on startup. There are two workarounds:
  92. a) send the services process a HUP signal ("killall -HUP ircservices")
  93. b) apply this patch to the IRC Services source tree:
  94. <http://arthur.barton.de/pub/ngircd/contrib/IRCServices513-FlushBuffer.patch>
  95. At least the following settings have to be tweaked, in addition to all the
  96. settings marked as required by IRC Services:
  97. In ircservices.conf:
  98. Variable Example value
  99. RemoteServer server.irc.net 6667 "123abc"
  100. ServerName "services.irc.net"
  101. LoadModule protocol/rfc1459
  102. In modules.conf:
  103. Module protocol/rfc1459
  104. The documentation of IRC Services can be found here:
  105. <http://www.ircservices.za.net/docs/>