ngircd.conf 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410
  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. # Text file which contains the ngIRCd help text. This file is required
  35. # to display help texts when using the "HELP <cmd>" command.
  36. ;HelpFile = /usr/share/doc/ngircd/Commands.txt
  37. # Info text of the server. This will be shown by WHOIS and
  38. # LINKS requests for example.
  39. Info = Yet another IRC Server running on Debian GNU/Linux
  40. # Comma separated list of IP addresses on which the server should
  41. # listen. Default values are:
  42. # "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0"
  43. # so the server listens on all IP addresses of the system by default.
  44. ;Listen = 127.0.0.1,192.168.0.1
  45. # Text file with the "message of the day" (MOTD). This message will
  46. # be shown to all users connecting to the server:
  47. MotdFile = /etc/ngircd/ngircd.motd
  48. # A simple Phrase (<127 chars) if you don't want to use a motd file.
  49. ;MotdPhrase = "Hello. This is the Debian default MOTD sentence"
  50. # The name of the IRC network to which this server belongs. This name
  51. # is optional, should only contain ASCII characters, and can't contain
  52. # spaces. It is only used to inform clients. The default is empty,
  53. # so no network name is announced to clients.
  54. ;Network = aIRCnetwork
  55. # Global password for all users needed to connect to the server.
  56. # (Default: not set)
  57. ;Password = wealllikedebian
  58. # This tells ngIRCd to write its current process ID to a file.
  59. # Note that the pidfile is written AFTER chroot and switching the
  60. # user ID, e.g. the directory the pidfile resides in must be
  61. # writable by the ngIRCd user and exist in the chroot directory.
  62. # Keep this setting in sync with PIDFILE in /etc/init.d/ngircd
  63. PidFile = /run/ngircd/ngircd.pid
  64. # Ports on which the server should listen. There may be more than
  65. # one port, separated with ",". (Default: 6667)
  66. ;Ports = 6667, 6668, 6669
  67. # Group ID under which the ngIRCd should run; you can use the name
  68. # of the group or the numerical ID. ATTENTION: For this to work the
  69. # server must have been started with root privileges!
  70. # Keep this setting in sync with DAEMONUSER in the init script and/or
  71. # the Group= setting in service file.
  72. ServerGID = irc
  73. # User ID under which the server should run; you can use the name
  74. # of the user or the numerical ID. ATTENTION: For this to work the
  75. # server must have been started with root privileges! In addition,
  76. # the configuration and MOTD files must be readable by this user,
  77. # otherwise RESTART and REHASH won't work!
  78. # Keep this setting in sync with DAEMONUSER in the init script and/or
  79. # the User= setting in service file.
  80. ServerUID = irc
  81. [Limits]
  82. # Define some limits and timeouts for this ngIRCd instance. Default
  83. # values should be safe, but it is wise to double-check :-)
  84. # The server tries every <ConnectRetry> seconds to establish a link
  85. # to not yet (or no longer) connected servers.
  86. ConnectRetry = 60
  87. # Number of seconds after which the whole daemon should shutdown when
  88. # no connections are left active after handling at least one client
  89. # (0: never, which is the default).
  90. # This can be useful for testing or when ngIRCd is started using
  91. # "socket activation" with systemd(8), for example.
  92. ;IdleTimeout = 0
  93. # Maximum number of simultaneous in- and outbound connections the
  94. # server is allowed to accept (0: unlimited):
  95. MaxConnections = 500
  96. # Maximum number of simultaneous connections from a single IP address
  97. # the server will accept (0: unlimited):
  98. MaxConnectionsIP = 10
  99. # Maximum number of channels a user can be member of (0: no limit):
  100. MaxJoins = 10
  101. # Maximum length of an user nickname (Default: 9, as in RFC 2812).
  102. # Please note that all servers in an IRC network MUST use the same
  103. # maximum nickname length!
  104. ;MaxNickLength = 9
  105. # Maximum penalty time increase in seconds, per penalty event. Set to -1
  106. # for no limit (the default), 0 to disable penalties altogether. The
  107. # daemon doesn't use penalty increases higher than 2 seconds during
  108. # normal operation, so values greater than 1 rarely make sense.
  109. ;MaxPenaltyTime = -1
  110. # Maximum number of channels returned in response to a /list
  111. # command (0: unlimited):
  112. ;MaxListSize = 100
  113. # After <PingTimeout> seconds of inactivity the server will send a
  114. # PING to the peer to test whether it is alive or not.
  115. PingTimeout = 120
  116. # If a client fails to answer a PING with a PONG within <PongTimeout>
  117. # seconds, it will be disconnected by the server.
  118. PongTimeout = 20
  119. [Options]
  120. # Optional features and configuration options to further tweak the
  121. # behavior of ngIRCd. If you want to get started quickly, you most
  122. # probably don't have to make changes here -- they are all optional.
  123. # List of allowed channel types (channel prefixes) for newly created
  124. # channels on the local server. By default, all supported channel
  125. # types are allowed. Set this variable to the empty string to disallow
  126. # creation of new channels by local clients at all.
  127. ;AllowedChannelTypes = #&+
  128. # Are remote IRC operators allowed to control this server, e.g.
  129. # use commands like CONNECT, SQUIT, DIE, ...?
  130. ;AllowRemoteOper = no
  131. # A directory to chroot in when everything is initialized. It
  132. # doesn't need to be populated if ngIRCd is compiled as a static
  133. # binary. By default ngIRCd won't use the chroot() feature.
  134. # ATTENTION: For this to work the server must have been started
  135. # with root privileges!
  136. ;ChrootDir = /var/empty
  137. # Set this hostname for every client instead of the real one.
  138. # Use %x to add the hashed value of the original hostname.
  139. ;CloakHost = cloaked.host
  140. # Use this hostname for hostname cloaking on clients that have the
  141. # user mode "+x" set, instead of the name of the server.
  142. # Use %x to add the hashed value of the original hostname.
  143. ;CloakHostModeX = cloaked.user
  144. # The Salt for cloaked hostname hashing. When undefined a random
  145. # hash is generated after each server start.
  146. ;CloakHostSalt = abcdefghijklmnopqrstuvwxyz
  147. # Set every clients' user name to their nickname
  148. ;CloakUserToNick = yes
  149. # Try to connect to other IRC servers using IPv4 and IPv6, if possible.
  150. ;ConnectIPv6 = yes
  151. ;ConnectIPv4 = yes
  152. # Default user mode(s) to set on new local clients. Please note that
  153. # only modes can be set that the client could set using regular MODE
  154. # commands, you can't set "a" (away) for example! Default: none.
  155. ;DefaultUserModes = i
  156. # Do DNS lookups when a client connects to the server.
  157. ;DNS = yes
  158. # Do IDENT lookups if ngIRCd has been compiled with support for it.
  159. # Users identified using IDENT are registered without the "~" character
  160. # prepended to their user name.
  161. ;Ident = yes
  162. # Directory containing configuration snippets (*.conf), that should
  163. # be read in after parsing this configuration file.
  164. ;IncludeDir = /etc/ngircd/conf.d
  165. # Enhance user privacy slightly (useful for IRC server on TOR or I2P)
  166. # by censoring some information like idle time, logon time, etc.
  167. ;MorePrivacy = no
  168. # Normally ngIRCd doesn't send any messages to a client until it is
  169. # registered. Enable this option to let the daemon send "NOTICE *"
  170. # messages to clients while connecting.
  171. ;NoticeBeforeRegistration = no
  172. # Should IRC Operators be allowed to use the MODE command even if
  173. # they are not(!) channel-operators?
  174. OperCanUseMode = yes
  175. # Should IRC Operators get AutoOp (+o) in persistent (+P) channels?
  176. ;OperChanPAutoOp = yes
  177. # Mask IRC Operator mode requests as if they were coming from the
  178. # server? (This is a compatibility hack for ircd-irc2 servers)
  179. ;OperServerMode = no
  180. # Use PAM if ngIRCd has been compiled with support for it.
  181. # Users identified using PAM are registered without the "~" character
  182. # prepended to their user name.
  183. PAM = no
  184. # When PAM is enabled, all clients are required to be authenticated
  185. # using PAM; connecting to the server without successful PAM
  186. # authentication isn't possible.
  187. # If this option is set, clients not sending a password are still
  188. # allowed to connect: they won't become "identified" and keep the "~"
  189. # character prepended to their supplied user name.
  190. # Please note: To make some use of this behavior, it most probably
  191. # isn't useful to enable "Ident", "PAM" and "PAMIsOptional" at the
  192. # same time, because you wouldn't be able to distinguish between
  193. # Ident'ified and PAM-authenticated users: both don't have a "~"
  194. # character prepended to their respective user names!
  195. ;PAMIsOptional = no
  196. # When PAM is enabled, this value determines the used PAM
  197. # configuration.
  198. # This setting allows to run multiple ngIRCd instances with
  199. # different PAM configurations on each instance.
  200. # If you set it to "ngircd-foo", PAM will use
  201. # /etc/pam.d/ngircd-foo instead of the default
  202. # /etc/pam.d/ngircd.
  203. ;PAMServiceName = ngircd
  204. # Let ngIRCd send an "authentication PING" when a new client connects,
  205. # and register this client only after receiving the corresponding
  206. # "PONG" reply.
  207. ;RequireAuthPing = no
  208. # Silently drop all incoming CTCP requests.
  209. ;ScrubCTCP = no
  210. # Syslog "facility" to which ngIRCd should send log messages.
  211. # Possible values are system dependent, but most probably auth, daemon,
  212. # user and local1 through local7 are possible values; see syslog(3).
  213. # Default is "local5" for historical reasons, you probably want to
  214. # change this to "daemon", for example.
  215. SyslogFacility = local1
  216. # Password required for using the WEBIRC command used by some
  217. # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
  218. # be used. (Default: not set)
  219. ;WebircPassword = xyz
  220. [SSL]
  221. # SSL-related configuration options. Please note that this section
  222. # is only available when ngIRCd is compiled with support for SSL!
  223. # So don't forget to remove the ";" above if this is the case ...
  224. # SSL Server Key Certificate
  225. ;CertFile = /etc/ssl/certs/server.crt
  226. # Select cipher suites allowed for SSL/TLS connections. This defaults
  227. # to HIGH:!aNULL:@STRENGTH (OpenSSL) or SECURE128 (GnuTLS).
  228. # See 'man 1ssl ciphers' (OpenSSL) or 'man 3 gnutls_priority_init'
  229. # (GnuTLS) for details.
  230. # For OpenSSL:
  231. ;CipherList = HIGH:!aNULL:@STRENGTH:!SSLv3
  232. # For GnuTLS (this Debian package was linked against GnuTLS):
  233. CipherList = SECURE128:-VERS-SSL3.0
  234. # Diffie-Hellman parameters
  235. ;DHFile = /etc/ngircd/dhparams.pem
  236. # SSL Server Key
  237. ;KeyFile = /etc/ssl/private/server.key
  238. # password to decrypt SSLKeyFile (OpenSSL only)
  239. # Note that this Debian package is linked against GnuTLS so this
  240. # option has no effect.
  241. ;KeyFilePassword = secret
  242. # Additional Listen Ports that expect SSL/TLS encrypted connections
  243. ;Ports = 6697, 9999
  244. [Operator]
  245. # [Operator] sections are used to define IRC Operators. There may be
  246. # more than one [Operator] block, one for each local operator.
  247. # ID of the operator (may be different of the nickname)
  248. ;Name = TheOper
  249. # Password of the IRC operator
  250. ;Password = ThePwd
  251. # Optional Mask from which /OPER will be accepted
  252. ;Mask = *!ident@somewhere.example.com
  253. [Operator]
  254. # More [Operator] sections, if you like ...
  255. [Server]
  256. # Other servers are configured in [Server] sections. If you
  257. # configure a port for the connection, then this ngircd tries to
  258. # connect to the other server on the given port; if not it waits
  259. # for the other server to connect.
  260. # There may be more than one server block, one for each server.
  261. #
  262. # Server Groups:
  263. # The ngIRCd allows "server groups": You can assign an "ID" to every
  264. # server with which you want this ngIRCd to link. If a server of a
  265. # group won't answer, the ngIRCd tries to connect to the next server
  266. # in the given group. But the ngircd never tries to connect to two
  267. # servers with the same group ID.
  268. # IRC name of the remote server, must match the "Name" variable in
  269. # the [Global] section of the other server (when using ngIRCd).
  270. ;Name = irc2.example.net
  271. # Internet host name or IP address of the peer (only required when
  272. # this server should establish the connection).
  273. ;Host = connect-to-host.example.net
  274. # IP address to use as _source_ address for the connection. if
  275. # unspecified, ngircd will let the operating system pick an address.
  276. ;Bind = 10.0.0.1
  277. # Port of the server to which the ngIRCd should connect. If you
  278. # assign no port the ngIRCd waits for incoming connections.
  279. ;Port = 6667
  280. # Own password for the connection. This password has to be configured
  281. # as "PeerPassword" on the other server.
  282. ;MyPassword = MySecret
  283. # Foreign password for this connection. This password has to be
  284. # configured as "MyPassword" on the other server.
  285. ;PeerPassword = PeerSecret
  286. # Group of this server (optional)
  287. ;Group = 123
  288. # Set the "Passive" option to "yes" if you don't want this ngIRCd to
  289. # connect to the configured peer (same as leaving the "Port" variable
  290. # empty). The advantage of this option is that you can actually
  291. # configure a port an use the IRC command CONNECT more easily to
  292. # manually connect this specific server later.
  293. ;Passive = no
  294. # Connect to the remote server using TLS/SSL (Default: false)
  295. ;SSLConnect = yes
  296. # Define a (case insensitive) list of masks matching nicknames that
  297. # should be treated as IRC services when introduced via this remote
  298. # server, separated by commas (",").
  299. # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
  300. # (which is the default).
  301. # When you are connecting IRC services which mask as a IRC server
  302. # and which use "virtual users" to communicate with, for example
  303. # "NickServ" and "ChanServ", you should set this parameter to
  304. # something like "*Serv" or "NickServ,ChanServ,XyzServ".
  305. ;ServiceMask = *Serv,Global
  306. [Server]
  307. # More [Server] sections, if you like ...
  308. [Channel]
  309. # Pre-defined channels can be configured in [Channel] sections.
  310. # Such channels are created by the server when starting up and even
  311. # persist when there are no more members left.
  312. # Persistent channels are marked with the mode 'P', which can be set
  313. # and unset by IRC operators like other modes on the fly.
  314. # There may be more than one [Channel] block, one for each channel.
  315. # Name of the channel
  316. ;Name = #ngircd
  317. # Topic for this channel
  318. ;Topic = Our ngircd testing channel
  319. # Initial channel modes, as used in "MODE" commands. Modifying lists
  320. # (ban list, invite list, exception list) is supported.
  321. # This option can be specified multiple times, evaluated top to bottom.
  322. ;Modes = +tnk mykey +l 5
  323. ;Modes = +b nick!~user@bad.host.example.com
  324. # Key file, syntax for each line: "<user>:<nick>:<key>".
  325. # Default: none.
  326. ;KeyFile = /etc/ngircd/#chan.key
  327. [Channel]
  328. # More [Channel] sections, if you like ...
  329. # -eof-