sample-ngircd.conf.tmpl 14 KB

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