ngircd.conf 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282
  1. #
  2. # This is a sample configuration file for the ngIRCd IRC daemon, which must
  3. # be customized to the local preferences and needs.
  4. #
  5. # Comments are started with "#" or ";".
  6. #
  7. # A lot of configuration options in this file start with a ";". You have
  8. # to remove the ";" in front of each variable to actually set a value!
  9. # The disabled variables are shown with example values for completeness only
  10. # and the daemon is using compiled-in default settings.
  11. #
  12. # Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
  13. # server interprets the configuration file as expected!
  14. #
  15. # Please see ngircd.conf(5) for a complete list of configuration options.
  16. #
  17. # The original can be found at:
  18. # /usr/share/doc/ngircd/examples/sample-ngircd.conf.gz
  19. [Global]
  20. # The [Global] section of this file is used to define the main
  21. # configuration of the server, like the server name and the ports
  22. # on which the server should be listening.
  23. # Server name in the IRC network, must contain at least one dot
  24. # (".") and be unique in the IRC network. Required!
  25. Name = irc.example.net
  26. # Info text of the server. This will be shown by WHOIS and
  27. # LINKS requests for example.
  28. Info = Yet another IRC Server running on Debian GNU/Linux
  29. # Global password for all users needed to connect to the server
  30. # (Default: not set)
  31. ;Password = wealllikedebian
  32. # Password required for using the WEBIRC command used by some
  33. # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
  34. # be used. (Default: not set)
  35. ;WebircPassword = xyz
  36. # Information about the server and the administrator, used by the
  37. # ADMIN command. Not required by server but by RFC!
  38. AdminInfo1 = Debian User
  39. AdminInfo2 = Debian City
  40. AdminEMail = root@localhost
  41. # Ports on which the server should listen. There may be more than
  42. # one port, separated with ",". (Default: 6667)
  43. ;Ports = 6667, 6668, 6669
  44. # Additional Listen Ports that expect SSL/TLS encrypted connections
  45. ;SSLPorts = 6697, 9999
  46. # SSL Server Key
  47. ;SSLKeyFile = /etc/ssl/private/server.key
  48. # password to decrypt SSLKeyFile (OpenSSL only)
  49. ;SSLKeyFilePassword = secret
  50. # SSL Server Key Certificate
  51. ;SSLCertFile = /etc/ssl/certs/server.crt
  52. # Diffie-Hellman parameters
  53. ;SSLDHFile = /etc/ngircd/dhparams.pem
  54. # comma separated list of IP addresses on which the server should
  55. # listen. Default values are:
  56. # "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0"
  57. # so the server listens on all IP addresses of the system by default.
  58. ;Listen = 127.0.0.1,192.168.0.1
  59. # Syslog "facility" to which ngIRCd should send log messages.
  60. # Possible values are system dependant, but most probably auth, daemon,
  61. # user and local1 through local7 are possible values; see syslog(3).
  62. # Default is "local5" for historical reasons, you probably want to
  63. # change this to "daemon", for example.
  64. SyslogFacility = local1
  65. # Text file with the "message of the day" (MOTD). This message will
  66. # be shown to all users connecting to the server:
  67. MotdFile = /etc/ngircd/ngircd.motd
  68. # A simple Phrase (<256 chars) if you don't want to use a motd file.
  69. ;MotdPhrase = "Hello. This is the Debian default MOTD sentence"
  70. # User ID under which the server should run; you can use the name
  71. # of the user or the numerical ID. ATTENTION: For this to work the
  72. # server must have been started with root privileges! In addition,
  73. # the configuration and MOTD files must be readable by this user,
  74. # otherwise RESTART and REHASH won't work!
  75. # Keep this setting in sync with DAEMONUSER in /etc/init.d/ngircd
  76. ServerUID = irc
  77. # Group ID under which the ngircd should run; you can use the name
  78. # of the group or the numerical ID. ATTENTION: For this to work the
  79. # server must have been started with root privileges!
  80. ServerGID = irc
  81. # A directory to chroot in when everything is initialized. It
  82. # doesn't need to be populated if ngIRCd is compiled as a static
  83. # binary. By default ngIRCd won't use the chroot() feature.
  84. # ATTENTION: For this to work the server must have been started
  85. # with root privileges!
  86. ;ChrootDir = /var/empty
  87. # This tells ngircd to write its current process id to a file.
  88. # Note that the pidfile is written AFTER chroot and switching uid,
  89. # i. e. the Directory the pidfile resides in must be writeable by
  90. # the ngircd user and exist in the chroot directory.
  91. # Keep this setting in sync with PIDFILE in /etc/init.d/ngircd
  92. PidFile = /var/run/ngircd/ngircd.pid
  93. # After <PingTimeout> seconds of inactivity the server will send a
  94. # PING to the peer to test whether it is alive or not.
  95. PingTimeout = 120
  96. # If a client fails to answer a PING with a PONG within <PongTimeout>
  97. # seconds, it will be disconnected by the server.
  98. PongTimeout = 20
  99. # The server tries every <ConnectRetry> seconds to establish a link
  100. # to not yet (or no longer) connected servers.
  101. ConnectRetry = 60
  102. # Should IRC Operators be allowed to use the MODE command even if
  103. # they are not(!) channel-operators?
  104. OperCanUseMode = yes
  105. # Are remote IRC operators allowed to control this server, e. g.
  106. # use commands like CONNECT, SQUIT, DIE, ...?
  107. ;AllowRemoteOper = no
  108. # Allow Pre-Defined Channels only (see Section [Channels])
  109. ;PredefChannelsOnly = no
  110. # Don't do any DNS lookups when a client connects to the server.
  111. ;NoDNS = no
  112. # Don't do any IDENT lookups, even if ngIRCd has been compiled
  113. # with support for it.
  114. ;NoIdent = no
  115. # Don't use PAM, even if ngIRCd has been compiled with support for it.
  116. NoPAM = no
  117. # Don't use ZeroConf service registration, even if ngIRCd has been
  118. # compiled with support for it (e.g. Howl, Avahi, Mac OS X).
  119. # Note: This Debian package was compiled without ZeroConf support
  120. ;NoZeroConf = no
  121. # try to connect to other irc servers using ipv4 and ipv6, if possible
  122. ;ConnectIPv6 = yes
  123. ;ConnectIPv4 = yes
  124. # Maximum number of simultaneous in- and outbound connections the
  125. # server is allowed to accept (0: unlimited):
  126. MaxConnections = 500
  127. # Maximum number of simultaneous connections from a single IP address
  128. # the server will accept (0: unlimited):
  129. MaxConnectionsIP = 10
  130. # Maximum number of channels a user can be member of (0: no limit):
  131. MaxJoins = 10
  132. # Maximum length of an user nick name (Default: 9, as in RFC 2812).
  133. # Please note that all servers in an IRC network MUST use the same
  134. # maximum nick name length!
  135. ;MaxNickLength = 9
  136. [Operator]
  137. # [Operator] sections are used to define IRC Operators. There may be
  138. # more than one [Operator] block, one for each local operator.
  139. # ID of the operator (may be different of the nick name)
  140. ;Name = TheOper
  141. # Password of the IRC operator
  142. ;Password = ThePwd
  143. # Optional Mask from which /OPER will be accepted
  144. ;Mask = *!ident@somewhere.example.com
  145. [Operator]
  146. # More [Operator] sections, if you like ...
  147. [Server]
  148. # Other servers are configured in [Server] sections. If you
  149. # configure a port for the connection, then this ngircd tries to
  150. # connect to to the other server on the given port; if not it waits
  151. # for the other server to connect.
  152. # There may be more than one server block, one for each server.
  153. #
  154. # Server Groups:
  155. # The ngIRCd allows "server groups": You can assign an "ID" to every
  156. # server with which you want this ngIRCd to link. If a server of a
  157. # group won't answer, the ngIRCd tries to connect to the next server
  158. # in the given group. But the ngircd never tries to connect to two
  159. # servers with the same group ID.
  160. # IRC name of the remote server, must match the "Name" variable in
  161. # the [Global] section of the other server (when using ngIRCd).
  162. ;Name = irc2.example.net
  163. # Internet host name or IP address of the peer (only required when
  164. # this server should establish the connection).
  165. ;Host = connect-to-host.the.net
  166. # IP address to use as _source_ address for the connection. if
  167. # unspecified, ngircd will let the operating system pick an address.
  168. ;Bind = 10.0.0.1
  169. # Port of the server to which the ngIRCd should connect. If you
  170. # assign no port the ngIRCd waits for incoming connections.
  171. ;Port = 6667
  172. # Own password for the connection. This password has to be configured
  173. # as "PeerPassword" on the other server.
  174. ;MyPassword = MySecret
  175. # Foreign password for this connection. This password has to be
  176. # configured as "MyPassword" on the other server.
  177. ;PeerPassword = PeerSecret
  178. # Group of this server (optional)
  179. ;Group = 123
  180. # Set the "Passive" option to "yes" if you don't want this ngIRCd to
  181. # connect to the configured peer (same as leaving the "Port" variable
  182. # empty). The advantage of this option is that you can actually
  183. # configure a port an use the IRC command CONNECT more easily to
  184. # manually connect this specific server later.
  185. ;Passive = no
  186. # Connect to the remote server using TLS/SSL (Default: false)
  187. ;SSLConnect = yes
  188. # Define a (case insensitive) mask matching nick names that should be
  189. # treated as IRC services when introduced via this remote server.
  190. # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
  191. # (which is the default).
  192. # When you are connecting IRC services which mask as a IRC server
  193. # and which use "virtual users" to communicate with, for example
  194. # "NickServ" and "ChanServ", you should set this parameter to
  195. # something like "*Serv".
  196. ;ServiceMask = *Serv
  197. [Server]
  198. # More [Server] sections, if you like ...
  199. [Channel]
  200. # Pre-defined channels can be configured in [Channel] sections.
  201. # Such channels are created by the server when starting up and even
  202. # persist when there are no more members left.
  203. # Persistent channels are marked with the mode 'P', which can be set
  204. # and unset by IRC operators like other modes on the fly.
  205. # There may be more than one [Channel] block, one for each channel.
  206. # Name of the channel
  207. ;Name = #ngircd
  208. # Topic for this channel
  209. ;Topic = Our ngircd testing channel
  210. # Initial channel modes
  211. ;Modes = tnk
  212. # initial channel password (mode k)
  213. ;Key = Secret
  214. # Key file, syntax for each line: "<user>:<nick>:<key>".
  215. # Default: none.
  216. ;KeyFile = /etc/ngircd/#chan.key
  217. # maximum users per channel (mode l)
  218. ;MaxUsers = 23
  219. [Channel]
  220. # More [Channel] sections, if you like ...
  221. # -eof-