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.
23 # Server name in the IRC network, must contain at least one dot
24 # (".") and be unique in the IRC network. Required!
27 # Info text of the server. This will be shown by WHOIS and
28 # LINKS requests for example.
29 Info = Server Info Text
31 # Global password for all users needed to connect to the server.
35 # Password required for using the WEBIRC command used by some
36 # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
37 # be used. (Default: not set)
40 # Information about the server and the administrator, used by the
41 # ADMIN command. Not required by server but by RFC!
42 ;AdminInfo1 = Description
43 ;AdminInfo2 = Location
44 ;AdminEMail = admin@irc.server
46 # Ports on which the server should listen. There may be more than
47 # one port, separated with ",". (Default: 6667)
48 ;Ports = 6667, 6668, 6669
50 # Additional Listen Ports that expect SSL/TLS encrypted connections
51 ;SSLPorts = 6697, 9999
54 ;SSLKeyFile = /usr/local/etc/ngircd/ssl/server-key.pem
56 # password to decrypt SSLKeyFile (OpenSSL only)
57 ;SSLKeyFilePassword = secret
59 # SSL Server Key Certificate
60 ;SSLCertFile = /usr/local/etc/ngircd/ssl/server-cert.pem
62 # Diffie-Hellman parameters
63 ;SSLDHFile = /usr/local/etc/ngircd/ssl/dhparams.pem
65 # comma separated list of IP addresses on which the server should
66 # listen. Default values are:
67 # "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0"
68 # so the server listens on all IP addresses of the system by default.
69 ;Listen = 127.0.0.1,192.168.0.1
71 # Text file with the "message of the day" (MOTD). This message will
72 # be shown to all users connecting to the server:
73 ;MotdFile = /usr/local/etc/ngircd.motd
75 # A simple Phrase (<256 chars) if you don't want to use a motd file.
76 # If it is set no MotdFile will be read at all.
77 ;MotdPhrase = "Hello world!"
79 # User ID under which the server should run; you can use the name
80 # of the user or the numerical ID. ATTENTION: For this to work the
81 # server must have been started with root privileges! In addition,
82 # the configuration and MOTD files must be readable by this user,
83 # otherwise RESTART and REHASH won't work!
86 # Group ID under which the ngircd should run; you can use the name
87 # of the group or the numerical ID. ATTENTION: For this to work the
88 # server must have been started with root privileges!
91 # A directory to chroot in when everything is initialized. It
92 # doesn't need to be populated if ngIRCd is compiled as a static
93 # binary. By default ngIRCd won't use the chroot() feature.
94 # ATTENTION: For this to work the server must have been started
95 # with root privileges!
96 ;ChrootDir = /var/empty
98 # This tells ngircd to write its current process id to a file.
99 # Note that the pidfile is written AFTER chroot and switching uid,
100 # i. e. the Directory the pidfile resides in must be writeable by
101 # the ngircd user and exist in the chroot directory.
102 ;PidFile = /var/run/ngircd/ngircd.pid
104 # After <PingTimeout> seconds of inactivity the server will send a
105 # PING to the peer to test whether it is alive or not.
108 # If a client fails to answer a PING with a PONG within <PongTimeout>
109 # seconds, it will be disconnected by the server.
112 # The server tries every <ConnectRetry> seconds to establish a link
113 # to not yet (or no longer) connected servers.
116 # Should IRC Operators be allowed to use the MODE command even if
117 # they are not(!) channel-operators?
120 # Mask IRC Operator mode requests as if they were coming from the
121 # server? (This is a compatibility hack for ircd-irc2 servers)
124 # Are remote IRC operators allowed to control this server, e. g.
125 # use commands like CONNECT, SQUIT, DIE, ...?
126 ;AllowRemoteOper = no
128 # Allow Pre-Defined Channels only (see Section [Channels])
129 ;PredefChannelsOnly = no
131 # Don't do any DNS lookups when a client connects to the server.
134 # Don't do any IDENT lookups, even if ngIRCd has been compiled
135 # with support for it.
138 # Don't use PAM, even if ngIRCd has been compiled with support for it.
141 # try to connect to other irc servers using ipv4 and ipv6, if possible
145 # Maximum number of simultaneous in- and outbound connections the
146 # server is allowed to accept (0: unlimited):
149 # Maximum number of simultaneous connections from a single IP address
150 # the server will accept (0: unlimited):
151 ;MaxConnectionsIP = 5
153 # Maximum number of channels a user can be member of (0: no limit):
156 # Maximum length of an user nick name (Default: 9, as in RFC 2812).
157 # Please note that all servers in an IRC network MUST use the same
158 # maximum nick name length!
162 # [Operator] sections are used to define IRC Operators. There may be
163 # more than one [Operator] block, one for each local operator.
165 # ID of the operator (may be different of the nick name)
168 # Password of the IRC operator
171 # Optional Mask from which /OPER will be accepted
172 ;Mask = *!ident@somewhere.example.com
175 # More [Operator] sections, if you like ...
178 # Other servers are configured in [Server] sections. If you
179 # configure a port for the connection, then this ngircd tries to
180 # connect to to the other server on the given port; if not it waits
181 # for the other server to connect.
182 # There may be more than one server block, one for each server.
185 # The ngIRCd allows "server groups": You can assign an "ID" to every
186 # server with which you want this ngIRCd to link. If a server of a
187 # group won't answer, the ngIRCd tries to connect to the next server
188 # in the given group. But the ngircd never tries to connect to two
189 # servers with the same group ID.
191 # IRC name of the remote server, must match the "Name" variable in
192 # the [Global] section of the other server (when using ngIRCd).
195 # Internet host name or IP address of the peer (only required when
196 # this server should establish the connection).
197 ;Host = connect-to-host.the.net
199 # IP address to use as _source_ address for the connection. if
200 # unspecified, ngircd will let the operating system pick an address.
203 # Port of the server to which the ngIRCd should connect. If you
204 # assign no port the ngIRCd waits for incoming connections.
207 # Own password for the connection. This password has to be configured
208 # as "PeerPassword" on the other server.
209 ;MyPassword = MySecret
211 # Foreign password for this connection. This password has to be
212 # configured as "MyPassword" on the other server.
213 ;PeerPassword = PeerSecret
215 # Group of this server (optional)
218 # Set the "Passive" option to "yes" if you don't want this ngIRCd to
219 # connect to the configured peer (same as leaving the "Port" variable
220 # empty). The advantage of this option is that you can actually
221 # configure a port an use the IRC command CONNECT more easily to
222 # manually connect this specific server later.
225 # Connect to the remote server using TLS/SSL (Default: false)
228 # Define a (case insensitive) mask matching nick names that should be
229 # treated as IRC services when introduced via this remote server.
230 # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
231 # (which is the default).
232 # When you are connecting IRC services which mask as a IRC server
233 # and which use "virtual users" to communicate with, for example
234 # "NickServ" and "ChanServ", you should set this parameter to
235 # something like "*Serv".
239 # More [Server] sections, if you like ...
242 # Pre-defined channels can be configured in [Channel] sections.
243 # Such channels are created by the server when starting up and even
244 # persist when there are no more members left.
245 # Persistent channels are marked with the mode 'P', which can be set
246 # and unset by IRC operators like other modes on the fly.
247 # There may be more than one [Channel] block, one for each channel.
249 # Name of the channel
252 # Topic for this channel
253 ;Topic = a great topic
255 # Initial channel modes
258 # initial channel password (mode k)
261 # Key file, syntax for each line: "<user>:<nick>:<key>".
263 ;KeyFile = /etc/ngircd/#chan.key
265 # maximum users per channel (mode l)
269 # More [Channel] sections, if you like ...