ngircd.conf 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358
  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. # and their descriptions.
  17. #
  18. # The original can be found at:
  19. # /usr/share/doc/ngircd/sample-ngircd.conf.gz
  20. [Global]
  21. # The [Global] section of this file is used to define the main
  22. # configuration of the server, like the server name and the ports
  23. # on which the server should be listening.
  24. # These settings depend on your personal preferences, so you should
  25. # make sure that they correspond to your installation and setup!
  26. # Server name in the IRC network, must contain at least one dot
  27. # (".") and be unique in the IRC network. Required!
  28. Name = irc.example.net
  29. # Information about the server and the administrator, used by the
  30. # ADMIN command. Not required by server but by RFC!
  31. AdminInfo1 = Debian User
  32. AdminInfo2 = Debian City
  33. AdminEMail = irc@irc.example.com
  34. # Info text of the server. This will be shown by WHOIS and
  35. # LINKS requests for example.
  36. Info = Yet another IRC Server running on Debian GNU/Linux
  37. # Comma separated list of IP addresses on which the server should
  38. # listen. Default values are:
  39. # "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0"
  40. # so the server listens on all IP addresses of the system by default.
  41. ;Listen = 127.0.0.1,192.168.0.1
  42. # Text file with the "message of the day" (MOTD). This message will
  43. # be shown to all users connecting to the server:
  44. MotdFile = /etc/ngircd/ngircd.motd
  45. # A simple Phrase (<256 chars) if you don't want to use a motd file.
  46. ;MotdPhrase = "Hello. This is the Debian default MOTD sentence"
  47. # Global password for all users needed to connect to the server.
  48. # (Default: not set)
  49. ;Password = wealllikedebian
  50. # This tells ngIRCd to write its current process ID to a file.
  51. # Note that the pidfile is written AFTER chroot and switching the
  52. # user ID, e.g. the directory the pidfile resides in must be
  53. # writable by the ngIRCd user and exist in the chroot directory.
  54. # Keep this setting in sync with PIDFILE in /etc/init.d/ngircd
  55. PidFile = /var/run/ngircd/ngircd.pid
  56. # Ports on which the server should listen. There may be more than
  57. # one port, separated with ",". (Default: 6667)
  58. ;Ports = 6667, 6668, 6669
  59. # Group ID under which the ngIRCd should run; you can use the name
  60. # of the group or the numerical ID. ATTENTION: For this to work the
  61. # server must have been started with root privileges!
  62. # Keep this setting in sync with DAEMONUSER in /etc/init.d/ngircd
  63. ServerGID = irc
  64. # User ID under which the server should run; you can use the name
  65. # of the user or the numerical ID. ATTENTION: For this to work the
  66. # server must have been started with root privileges! In addition,
  67. # the configuration and MOTD files must be readable by this user,
  68. # otherwise RESTART and REHASH won't work!
  69. # Keep this setting in sync with DAEMONUSER in /etc/init.d/ngircd
  70. ServerUID = irc
  71. [Limits]
  72. # Define some limits and timeouts for this ngIRCd instance. Default
  73. # values should be safe, but it is wise to double-check :-)
  74. # The server tries every <ConnectRetry> seconds to establish a link
  75. # to not yet (or no longer) connected servers.
  76. ConnectRetry = 60
  77. # Maximum number of simultaneous in- and outbound connections the
  78. # server is allowed to accept (0: unlimited):
  79. MaxConnections = 500
  80. # Maximum number of simultaneous connections from a single IP address
  81. # the server will accept (0: unlimited):
  82. MaxConnectionsIP = 10
  83. # Maximum number of channels a user can be member of (0: no limit):
  84. MaxJoins = 10
  85. # Maximum length of an user nick name (Default: 9, as in RFC 2812).
  86. # Please note that all servers in an IRC network MUST use the same
  87. # maximum nick name length!
  88. ;MaxNickLength = 9
  89. # Maximum number of channels returned in response to a /list
  90. # command (0: unlimited):
  91. ;MaxListSize = 100
  92. # After <PingTimeout> seconds of inactivity the server will send a
  93. # PING to the peer to test whether it is alive or not.
  94. PingTimeout = 120
  95. # If a client fails to answer a PING with a PONG within <PongTimeout>
  96. # seconds, it will be disconnected by the server.
  97. PongTimeout = 20
  98. [Options]
  99. # Optional features and configuration options to further tweak the
  100. # behavior of ngIRCd. If you want to get started quickly, you most
  101. # probably don't have to make changes here -- they are all optional.
  102. # Are remote IRC operators allowed to control this server, e.g.
  103. # use commands like CONNECT, SQUIT, DIE, ...?
  104. ;AllowRemoteOper = no
  105. # A directory to chroot in when everything is initialized. It
  106. # doesn't need to be populated if ngIRCd is compiled as a static
  107. # binary. By default ngIRCd won't use the chroot() feature.
  108. # ATTENTION: For this to work the server must have been started
  109. # with root privileges!
  110. ;ChrootDir = /var/empty
  111. # Set this hostname for every client instead of the real one.
  112. # Use %x to add the hashed value of the original hostname.
  113. ;CloakHost = cloaked.host
  114. # Use this hostname for hostname cloaking on clients that have the
  115. # user mode "+x" set, instead of the name of the server.
  116. # Use %x to add the hashed value of the original hostname.
  117. ;CloakHostModeX = cloaked.user
  118. # The Salt for cloaked hostname hashing. When undefined a random
  119. # hash is generated after each server start.
  120. ;CloakHostSalt = abcdefghijklmnopqrstuvwxyz
  121. # Set every clients' user name to their nick name
  122. ;CloakUserToNick = yes
  123. # Try to connect to other IRC servers using IPv4 and IPv6, if possible.
  124. ;ConnectIPv6 = yes
  125. ;ConnectIPv4 = yes
  126. # Do any DNS lookups when a client connects to the server.
  127. ;DNS = yes
  128. # Do IDENT lookups if ngIRCd has been compiled with support for it.
  129. # Users identified using IDENT are registered without the "~" character
  130. # prepended to their user name.
  131. # Note: The Debian package was compiled without ident support.
  132. ;Ident = yes
  133. # Enhance user privacy slightly (useful for IRC server on TOR or I2P)
  134. # by censoring some information like idle time, logon time, etc.
  135. ;MorePrivacy = no
  136. # Normally ngIRCd doesn't send any messages to a client until it is
  137. # registered. Enable this option to let the daemon send "NOTICE AUTH"
  138. # messages to clients while connecting.
  139. ;NoticeAuth = no
  140. # Should IRC Operators be allowed to use the MODE command even if
  141. # they are not(!) channel-operators?
  142. OperCanUseMode = yes
  143. # Should IRC Operators get AutoOp (+o) in persistent (+P) channels?
  144. ;OperChanPAutoOp = yes
  145. # Mask IRC Operator mode requests as if they were coming from the
  146. # server? (This is a compatibility hack for ircd-irc2 servers)
  147. ;OperServerMode = no
  148. # Use PAM if ngIRCd has been compiled with support for it.
  149. # Users identified using PAM are registered without the "~" character
  150. # prepended to their user name.
  151. # Note: The Debian package was compiled without PAM support.
  152. ;PAM = yes
  153. # When PAM is enabled, all clients are required to be authenticated
  154. # using PAM; connecting to the server without successful PAM
  155. # authentication isn't possible.
  156. # If this option is set, clients not sending a password are still
  157. # allowed to connect: they won't become "identified" and keep the "~"
  158. # character prepended to their supplied user name.
  159. # Please note: To make some use of this behavior, it most probably
  160. # isn't useful to enable "Ident", "PAM" and "PAMIsOptional" at the
  161. # same time, because you wouldn't be able to distinguish between
  162. # Ident'ified and PAM-authenticated users: both don't have a "~"
  163. # character prepended to their respective user names!
  164. ;PAMIsOptional = no
  165. # Allow Pre-Defined Channels only (see Section [Channels])
  166. ;PredefChannelsOnly = no
  167. # Let ngIRCd send an "authentication PING" when a new client connects,
  168. # and register this client only after receiving the corresponding
  169. # "PONG" reply.
  170. ;RequireAuthPing = no
  171. # Silently drop all incoming CTCP requests.
  172. ;ScrubCTCP = no
  173. # Syslog "facility" to which ngIRCd should send log messages.
  174. # Possible values are system dependent, but most probably auth, daemon,
  175. # user and local1 through local7 are possible values; see syslog(3).
  176. # Default is "local5" for historical reasons, you probably want to
  177. # change this to "daemon", for example.
  178. SyslogFacility = local1
  179. # Password required for using the WEBIRC command used by some
  180. # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
  181. # be used. (Default: not set)
  182. ;WebircPassword = xyz
  183. [SSL]
  184. # SSL-related configuration options.
  185. # SSL Server Key Certificate
  186. ;CertFile = /etc/ssl/certs/server.crt
  187. # Diffie-Hellman parameters
  188. ;DHFile = /etc/ngircd/dhparams.pem
  189. # SSL Server Key
  190. ;KeyFile = /etc/ssl/private/server.key
  191. # password to decrypt SSLKeyFile (OpenSSL only)
  192. # Note that this Debian package was linked against GnuTLS so this
  193. # option has no effect.
  194. ;KeyFilePassword = secret
  195. # Additional Listen Ports that expect SSL/TLS encrypted connections
  196. ;Ports = 6697, 9999
  197. [Operator]
  198. # [Operator] sections are used to define IRC Operators. There may be
  199. # more than one [Operator] block, one for each local operator.
  200. # ID of the operator (may be different of the nick name)
  201. ;Name = TheOper
  202. # Password of the IRC operator
  203. ;Password = ThePwd
  204. # Optional Mask from which /OPER will be accepted
  205. ;Mask = *!ident@somewhere.example.com
  206. [Operator]
  207. # More [Operator] sections, if you like ...
  208. [Server]
  209. # Other servers are configured in [Server] sections. If you
  210. # configure a port for the connection, then this ngircd tries to
  211. # connect to to the other server on the given port; if not it waits
  212. # for the other server to connect.
  213. # There may be more than one server block, one for each server.
  214. #
  215. # Server Groups:
  216. # The ngIRCd allows "server groups": You can assign an "ID" to every
  217. # server with which you want this ngIRCd to link. If a server of a
  218. # group won't answer, the ngIRCd tries to connect to the next server
  219. # in the given group. But the ngircd never tries to connect to two
  220. # servers with the same group ID.
  221. # IRC name of the remote server, must match the "Name" variable in
  222. # the [Global] section of the other server (when using ngIRCd).
  223. ;Name = irc2.example.net
  224. # Internet host name or IP address of the peer (only required when
  225. # this server should establish the connection).
  226. ;Host = connect-to-host.example.net
  227. # IP address to use as _source_ address for the connection. if
  228. # unspecified, ngircd will let the operating system pick an address.
  229. ;Bind = 10.0.0.1
  230. # Port of the server to which the ngIRCd should connect. If you
  231. # assign no port the ngIRCd waits for incoming connections.
  232. ;Port = 6667
  233. # Own password for the connection. This password has to be configured
  234. # as "PeerPassword" on the other server.
  235. ;MyPassword = MySecret
  236. # Foreign password for this connection. This password has to be
  237. # configured as "MyPassword" on the other server.
  238. ;PeerPassword = PeerSecret
  239. # Group of this server (optional)
  240. ;Group = 123
  241. # Set the "Passive" option to "yes" if you don't want this ngIRCd to
  242. # connect to the configured peer (same as leaving the "Port" variable
  243. # empty). The advantage of this option is that you can actually
  244. # configure a port an use the IRC command CONNECT more easily to
  245. # manually connect this specific server later.
  246. ;Passive = no
  247. # Connect to the remote server using TLS/SSL (Default: false)
  248. ;SSLConnect = yes
  249. # Define a (case insensitive) list of masks matching nicknames that
  250. # should be treated as IRC services when introduced via this remote
  251. # server, separated by commas (",").
  252. # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
  253. # (which is the default).
  254. # When you are connecting IRC services which mask as a IRC server
  255. # and which use "virtual users" to communicate with, for example
  256. # "NickServ" and "ChanServ", you should set this parameter to
  257. # something like "*Serv" or "NickServ,ChanServ,XyzServ".
  258. ;ServiceMask = *Serv,Global
  259. [Server]
  260. # More [Server] sections, if you like ...
  261. [Channel]
  262. # Pre-defined channels can be configured in [Channel] sections.
  263. # Such channels are created by the server when starting up and even
  264. # persist when there are no more members left.
  265. # Persistent channels are marked with the mode 'P', which can be set
  266. # and unset by IRC operators like other modes on the fly.
  267. # There may be more than one [Channel] block, one for each channel.
  268. # Name of the channel
  269. ;Name = #ngircd
  270. # Topic for this channel
  271. ;Topic = Our ngircd testing channel
  272. # Initial channel modes
  273. ;Modes = tnk
  274. # initial channel password (mode k)
  275. ;Key = Secret
  276. # Key file, syntax for each line: "<user>:<nick>:<key>".
  277. # Default: none.
  278. ;KeyFile = /etc/ngircd/#chan.key
  279. # maximum users per channel (mode l)
  280. ;MaxUsers = 23
  281. [Channel]
  282. # More [Channel] sections, if you like ...
  283. # -eof-