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.
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!
25 # Server name in the IRC network, must contain at least one dot
26 # (".") and be unique in the IRC network. Required!
27 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 = Description
32 ;AdminInfo2 = Location
33 ;AdminEMail = admin@irc.server
35 # Info text of the server. This will be shown by WHOIS and
36 # LINKS requests for example.
37 Info = Server Info Text
39 # Comma separated list of IP addresses on which the server should
40 # listen. Default values are:
41 # "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0"
42 # so the server listens on all IP addresses of the system by default.
43 ;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 = :ETCDIR:/ngircd.motd
49 # A simple Phrase (<256 chars) if you don't want to use a motd file.
50 ;MotdPhrase = "Hello world!"
52 # Global password for all users needed to connect to the server.
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 # writeable by the ngIRCd user and exist in the chroot directory.
60 ;PidFile = /var/run/ngircd/ngircd.pid
62 # Ports on which the server should listen. There may be more than
63 # one port, separated with ",". (Default: 6667)
64 ;Ports = 6667, 6668, 6669
66 # Group ID under which the ngIRCd should run; you can use the name
67 # of the group or the numerical ID. ATTENTION: For this to work the
68 # server must have been started with root privileges!
71 # User ID under which the server should run; you can use the name
72 # of the user or the numerical ID. ATTENTION: For this to work the
73 # server must have been started with root privileges! In addition,
74 # the configuration and MOTD files must be readable by this user,
75 # otherwise RESTART and REHASH won't work!
79 # Define some limits and timeouts for this ngIRCd instance. Default
80 # values should be safe, but it is wise to double-check :-)
82 # The server tries every <ConnectRetry> seconds to establish a link
83 # to not yet (or no longer) connected servers.
86 # Maximum number of simultaneous in- and outbound connections the
87 # server is allowed to accept (0: unlimited):
90 # Maximum number of simultaneous connections from a single IP address
91 # the server will accept (0: unlimited):
94 # Maximum number of channels a user can be member of (0: no limit):
97 # Maximum length of an user nick name (Default: 9, as in RFC 2812).
98 # Please note that all servers in an IRC network MUST use the same
99 # maximum nick name length!
102 # After <PingTimeout> seconds of inactivity the server will send a
103 # PING to the peer to test whether it is alive or not.
106 # If a client fails to answer a PING with a PONG within <PongTimeout>
107 # seconds, it will be disconnected by the server.
111 # Optional features and configuration options to further tweak the
112 # behavior of ngIRCd. If you wan't to get started quickly, you most
113 # probably don't have to make changes here -- they are all optional.
115 # Are remote IRC operators allowed to control this server, e.g.
116 # use commands like CONNECT, SQUIT, DIE, ...?
117 ;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
126 # Set this hostname for every client instead of the real one.
127 # Please note: don't use the percentage sign ("%"), it is reserved for
129 ;CloakHost = irc.example.net
131 # Set every clients' user name to their nick name
132 ;CloakUserToNick = yes
134 # Try to connect to other IRC servers using IPv4 and IPv6, if possible.
138 # Do any DNS lookups when a client connects to the server.
141 # Do IDENT lookups if ngIRCd has been compiled with support for it.
144 # Normally ngIRCd doesn't send any messages to a client until it is
145 # registered. Enable this option to let the daemon send "NOTICE AUTH"
146 # messages to clients while connecting.
149 # Should IRC Operators be allowed to use the MODE command even if
150 # they are not(!) channel-operators?
153 # Mask IRC Operator mode requests as if they were coming from the
154 # server? (This is a compatibility hack for ircd-irc2 servers)
157 # Use PAM if ngIRCd has been compiled with support for it.
160 # Allow Pre-Defined Channels only (see Section [Channels])
161 ;PredefChannelsOnly = no
163 # Let ngIRCd send an "authentication PING" when a new client connects,
164 # and register this client only after receiving the corresponding
166 ;RequireAuthPing = no
168 # SSL Server Key Certificate
169 ;SSLCertFile = :ETCDIR:/ssl/server-cert.pem
171 # Diffie-Hellman parameters
172 ;SSLDHFile = :ETCDIR:/ssl/dhparams.pem
175 ;SSLKeyFile = :ETCDIR:/ssl/server-key.pem
177 # password to decrypt SSLKeyFile (OpenSSL only)
178 ;SSLKeyFilePassword = secret
180 # Additional Listen Ports that expect SSL/TLS encrypted connections
181 ;SSLPorts = 6697, 9999
183 # Syslog "facility" to which ngIRCd should send log messages.
184 # Possible values are system dependent, but most probably auth, daemon,
185 # user and local1 through local7 are possible values; see syslog(3).
186 # Default is "local5" for historical reasons, you probably want to
187 # change this to "daemon", for example.
188 SyslogFacility = local1
190 # Password required for using the WEBIRC command used by some
191 # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
192 # be used. (Default: not set)
193 ;WebircPassword = xyz
196 # [Operator] sections are used to define IRC Operators. There may be
197 # more than one [Operator] block, one for each local operator.
199 # ID of the operator (may be different of the nick name)
202 # Password of the IRC operator
205 # Optional Mask from which /OPER will be accepted
206 ;Mask = *!ident@somewhere.example.com
209 # More [Operator] sections, if you like ...
212 # Other servers are configured in [Server] sections. If you
213 # configure a port for the connection, then this ngircd tries to
214 # connect to to the other server on the given port; if not it waits
215 # for the other server to connect.
216 # There may be more than one server block, one for each server.
219 # The ngIRCd allows "server groups": You can assign an "ID" to every
220 # server with which you want this ngIRCd to link. If a server of a
221 # group won't answer, the ngIRCd tries to connect to the next server
222 # in the given group. But the ngircd never tries to connect to two
223 # servers with the same group ID.
225 # IRC name of the remote server, must match the "Name" variable in
226 # the [Global] section of the other server (when using ngIRCd).
227 ;Name = irc2.example.net
229 # Internet host name or IP address of the peer (only required when
230 # this server should establish the connection).
231 ;Host = connect-to-host.example.net
233 # IP address to use as _source_ address for the connection. if
234 # unspecified, ngircd will let the operating system pick an address.
237 # Port of the server to which the ngIRCd should connect. If you
238 # assign no port the ngIRCd waits for incoming connections.
241 # Own password for the connection. This password has to be configured
242 # as "PeerPassword" on the other server.
243 ;MyPassword = MySecret
245 # Foreign password for this connection. This password has to be
246 # configured as "MyPassword" on the other server.
247 ;PeerPassword = PeerSecret
249 # Group of this server (optional)
252 # Set the "Passive" option to "yes" if you don't want this ngIRCd to
253 # connect to the configured peer (same as leaving the "Port" variable
254 # empty). The advantage of this option is that you can actually
255 # configure a port an use the IRC command CONNECT more easily to
256 # manually connect this specific server later.
259 # Connect to the remote server using TLS/SSL (Default: false)
262 # Define a (case insensitive) mask matching nick names that should be
263 # treated as IRC services when introduced via this remote server.
264 # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
265 # (which is the default).
266 # When you are connecting IRC services which mask as a IRC server
267 # and which use "virtual users" to communicate with, for example
268 # "NickServ" and "ChanServ", you should set this parameter to
269 # something like "*Serv".
273 # More [Server] sections, if you like ...
276 # Pre-defined channels can be configured in [Channel] sections.
277 # Such channels are created by the server when starting up and even
278 # persist when there are no more members left.
279 # Persistent channels are marked with the mode 'P', which can be set
280 # and unset by IRC operators like other modes on the fly.
281 # There may be more than one [Channel] block, one for each channel.
283 # Name of the channel
286 # Topic for this channel
287 ;Topic = a great topic
289 # Initial channel modes
292 # initial channel password (mode k)
295 # Key file, syntax for each line: "<user>:<nick>:<key>".
297 ;KeyFile = :ETCDIR:/#chan.key
299 # maximum users per channel (mode l)
303 # More [Channel] sections, if you like ...