1
0

sample-ngircd.conf.tmpl 12 KB

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