2 # This is a sample configuration file for the ngIRCd IRC daemon, which must
3 # be customized to the local preferences and needs.
5 # Comments are started with "#" or ";".
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.
12 # Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
13 # server interprets the configuration file as expected!
15 # Please see ngircd.conf(5) for a complete list of configuration options
16 # and their descriptions.
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 # These settings depend on your personal preferences, so you should
24 # 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
30 # Information about the server and the administrator, used by the
31 # ADMIN command. Not required by server but by RFC!
32 ;AdminInfo1 = Description
33 ;AdminInfo2 = Location
34 ;AdminEMail = admin@irc.server
36 # Info text of the server. This will be shown by WHOIS and
37 # LINKS requests for example.
38 Info = Server Info Text
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
46 # Text file with the "message of the day" (MOTD). This message will
47 # be shown to all users connecting to the server:
48 ;MotdFile = :ETCDIR:/ngircd.motd
50 # A simple Phrase (<256 chars) if you don't want to use a motd file.
51 ;MotdPhrase = "Hello world!"
53 # Global password for all users needed to connect to the server.
57 # This tells ngIRCd to write its current process ID to a file.
58 # Note that the pidfile is written AFTER chroot and switching the
59 # user ID, e.g. the directory the pidfile resides in must be
60 # writable by the ngIRCd user and exist in the chroot directory.
61 ;PidFile = /var/run/ngircd/ngircd.pid
63 # Ports on which the server should listen. There may be more than
64 # one port, separated with ",". (Default: 6667)
65 ;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!
72 # User ID under which the server should run; you can use the name
73 # of the user or the numerical ID. ATTENTION: For this to work the
74 # server must have been started with root privileges! In addition,
75 # the configuration and MOTD files must be readable by this user,
76 # otherwise RESTART and REHASH won't work!
80 # Define some limits and timeouts for this ngIRCd instance. Default
81 # values should be safe, but it is wise to double-check :-)
83 # The server tries every <ConnectRetry> seconds to establish a link
84 # to not yet (or no longer) connected servers.
87 # Maximum number of simultaneous in- and outbound connections the
88 # server is allowed to accept (0: unlimited):
91 # Maximum number of simultaneous connections from a single IP address
92 # the server will accept (0: unlimited):
95 # Maximum number of channels a user can be member of (0: no limit):
98 # Maximum length of an user nick name (Default: 9, as in RFC 2812).
99 # Please note that all servers in an IRC network MUST use the same
100 # maximum nick name length!
103 # After <PingTimeout> seconds of inactivity the server will send a
104 # PING to the peer to test whether it is alive or not.
107 # If a client fails to answer a PING with a PONG within <PongTimeout>
108 # seconds, it will be disconnected by the server.
112 # Optional features and configuration options to further tweak the
113 # behavior of ngIRCd. If you want to get started quickly, you most
114 # probably don't have to make changes here -- they are all optional.
116 # Are remote IRC operators allowed to control this server, e.g.
117 # use commands like CONNECT, SQUIT, DIE, ...?
118 ;AllowRemoteOper = no
120 # A directory to chroot in when everything is initialized. It
121 # doesn't need to be populated if ngIRCd is compiled as a static
122 # binary. By default ngIRCd won't use the chroot() feature.
123 # ATTENTION: For this to work the server must have been started
124 # with root privileges!
125 ;ChrootDir = /var/empty
127 # Set this hostname for every client instead of the real one.
128 # Please note: don't use the percentage sign ("%"), it is reserved for
130 ;CloakHost = cloaked.host
132 # Use this hostname for hostname cloaking on clients that have the
133 # user mode "+x" set, instead of the name of the server.
134 # Please note: don't use the percentage sign ("%"), it is reserved for
136 ;CloakHostModeX = cloaked.user
138 # Set every clients' user name to their nick name
139 ;CloakUserToNick = yes
141 # Try to connect to other IRC servers using IPv4 and IPv6, if possible.
145 # Do any DNS lookups when a client connects to the server.
148 # Do IDENT lookups if ngIRCd has been compiled with support for it.
149 # Users identified using IDENT are registered without the "~" character
150 # prepended to their user name.
153 # Enhance user privacy slightly (useful for IRC server on TOR or I2P)
154 # by censoring some information like idle time, logon time, etc.
157 # Normally ngIRCd doesn't send any messages to a client until it is
158 # registered. Enable this option to let the daemon send "NOTICE AUTH"
159 # messages to clients while connecting.
162 # Should IRC Operators be allowed to use the MODE command even if
163 # they are not(!) channel-operators?
166 # Mask IRC Operator mode requests as if they were coming from the
167 # server? (This is a compatibility hack for ircd-irc2 servers)
170 # Use PAM if ngIRCd has been compiled with support for it.
171 # Users identified using PAM are registered without the "~" character
172 # prepended to their user name.
175 # When PAM is enabled, all clients are required to be authenticated
176 # using PAM; connecting to the server without successful PAM
177 # authentication isn't possible.
178 # If this option is set, clients not sending a password are still
179 # allowed to connect: they won't become "identified" and keep the "~"
180 # character prepended to their supplied user name.
181 # Please note: To make some use of this behavior, it most probably
182 # isn't useful to enable "Ident", "PAM" and "PAMIsOptional" at the
183 # same time, because you wouldn't be able to distinguish between
184 # Ident'ified and PAM-authenticated users: both don't have a "~"
185 # character prepended to their respective user names!
188 # Allow Pre-Defined Channels only (see Section [Channels])
189 ;PredefChannelsOnly = no
191 # Let ngIRCd send an "authentication PING" when a new client connects,
192 # and register this client only after receiving the corresponding
194 ;RequireAuthPing = no
196 # Silently drop all incoming CTCP requests.
199 # Syslog "facility" to which ngIRCd should send log messages.
200 # Possible values are system dependent, but most probably auth, daemon,
201 # user and local1 through local7 are possible values; see syslog(3).
202 # Default is "local5" for historical reasons, you probably want to
203 # change this to "daemon", for example.
204 ;SyslogFacility = local1
206 # Password required for using the WEBIRC command used by some
207 # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
208 # be used. (Default: not set)
209 ;WebircPassword = xyz
212 # SSL-related configuration options. Please note that this section
213 # is only available when ngIRCd is compiled with support for SSL!
214 # So don't forget to remove the ";" above if this is the case ...
216 # SSL Server Key Certificate
217 ;CertFile = :ETCDIR:/ssl/server-cert.pem
219 # Diffie-Hellman parameters
220 ;DHFile = :ETCDIR:/ssl/dhparams.pem
223 ;KeyFile = :ETCDIR:/ssl/server-key.pem
225 # password to decrypt SSLKeyFile (OpenSSL only)
226 ;KeyFilePassword = secret
228 # Additional Listen Ports that expect SSL/TLS encrypted connections
232 # [Operator] sections are used to define IRC Operators. There may be
233 # more than one [Operator] block, one for each local operator.
235 # ID of the operator (may be different of the nick name)
238 # Password of the IRC operator
241 # Optional Mask from which /OPER will be accepted
242 ;Mask = *!ident@somewhere.example.com
245 # More [Operator] sections, if you like ...
248 # Other servers are configured in [Server] sections. If you
249 # configure a port for the connection, then this ngircd tries to
250 # connect to to the other server on the given port; if not it waits
251 # for the other server to connect.
252 # There may be more than one server block, one for each server.
255 # The ngIRCd allows "server groups": You can assign an "ID" to every
256 # server with which you want this ngIRCd to link. If a server of a
257 # group won't answer, the ngIRCd tries to connect to the next server
258 # in the given group. But the ngircd never tries to connect to two
259 # servers with the same group ID.
261 # IRC name of the remote server, must match the "Name" variable in
262 # the [Global] section of the other server (when using ngIRCd).
263 ;Name = irc2.example.net
265 # Internet host name or IP address of the peer (only required when
266 # this server should establish the connection).
267 ;Host = connect-to-host.example.net
269 # IP address to use as _source_ address for the connection. if
270 # unspecified, ngircd will let the operating system pick an address.
273 # Port of the server to which the ngIRCd should connect. If you
274 # assign no port the ngIRCd waits for incoming connections.
277 # Own password for the connection. This password has to be configured
278 # as "PeerPassword" on the other server.
279 ;MyPassword = MySecret
281 # Foreign password for this connection. This password has to be
282 # configured as "MyPassword" on the other server.
283 ;PeerPassword = PeerSecret
285 # Group of this server (optional)
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.
295 # Connect to the remote server using TLS/SSL (Default: false)
298 # Define a (case insensitive) mask matching nick names that should be
299 # treated as IRC services when introduced via this remote server.
300 # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
301 # (which is the default).
302 # When you are connecting IRC services which mask as a IRC server
303 # and which use "virtual users" to communicate with, for example
304 # "NickServ" and "ChanServ", you should set this parameter to
305 # something like "*Serv".
309 # More [Server] sections, if you like ...
312 # Pre-defined channels can be configured in [Channel] sections.
313 # Such channels are created by the server when starting up and even
314 # persist when there are no more members left.
315 # Persistent channels are marked with the mode 'P', which can be set
316 # and unset by IRC operators like other modes on the fly.
317 # There may be more than one [Channel] block, one for each channel.
319 # Name of the channel
322 # Topic for this channel
323 ;Topic = a great topic
325 # Initial channel modes
328 # initial channel password (mode k)
331 # Key file, syntax for each line: "<user>:<nick>:<key>".
333 ;KeyFile = :ETCDIR:/#chan.key
335 # maximum users per channel (mode l)
339 # More [Channel] sections, if you like ...