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!
25 Name = irc.example.net
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 = :ETCDIR:/ssl/server-key.pem
56 # password to decrypt SSLKeyFile (OpenSSL only)
57 ;SSLKeyFilePassword = secret
59 # SSL Server Key Certificate
60 ;SSLCertFile = :ETCDIR:/ssl/server-cert.pem
62 # Diffie-Hellman parameters
63 ;SSLDHFile = :ETCDIR:/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 # Syslog "facility" to which ngIRCd should send log messages.
72 # Possible values are system dependant, but most probably auth, daemon,
73 # user and local1 through local7 are possible values; see syslog(3).
74 # Default is "local5" for historical reasons, you probably want to
75 # change this to "daemon", for example.
76 SyslogFacility = local1
78 # Text file with the "message of the day" (MOTD). This message will
79 # be shown to all users connecting to the server:
80 ;MotdFile = :ETCDIR:/ngircd.motd
82 # A simple Phrase (<256 chars) if you don't want to use a motd file.
83 ;MotdPhrase = "Hello world!"
85 # User ID under which the server should run; you can use the name
86 # of the user or the numerical ID. ATTENTION: For this to work the
87 # server must have been started with root privileges! In addition,
88 # the configuration and MOTD files must be readable by this user,
89 # otherwise RESTART and REHASH won't work!
92 # Group ID under which the ngircd should run; you can use the name
93 # of the group or the numerical ID. ATTENTION: For this to work the
94 # server must have been started with root privileges!
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
104 # This tells ngircd to write its current process id to a file.
105 # Note that the pidfile is written AFTER chroot and switching uid,
106 # i. e. the Directory the pidfile resides in must be writeable by
107 # the ngircd user and exist in the chroot directory.
108 ;PidFile = /var/run/ngircd/ngircd.pid
110 # After <PingTimeout> seconds of inactivity the server will send a
111 # PING to the peer to test whether it is alive or not.
114 # If a client fails to answer a PING with a PONG within <PongTimeout>
115 # seconds, it will be disconnected by the server.
118 # The server tries every <ConnectRetry> seconds to establish a link
119 # to not yet (or no longer) connected servers.
122 # Should IRC Operators be allowed to use the MODE command even if
123 # they are not(!) channel-operators?
126 # Mask IRC Operator mode requests as if they were coming from the
127 # server? (This is a compatibility hack for ircd-irc2 servers)
130 # Are remote IRC operators allowed to control this server, e. g.
131 # use commands like CONNECT, SQUIT, DIE, ...?
132 ;AllowRemoteOper = no
134 # Allow Pre-Defined Channels only (see Section [Channels])
135 ;PredefChannelsOnly = no
137 # try to connect to other irc servers using ipv4 and ipv6, if possible
141 # Maximum number of simultaneous in- and outbound connections the
142 # server is allowed to accept (0: unlimited):
145 # Maximum number of simultaneous connections from a single IP address
146 # the server will accept (0: unlimited):
147 ;MaxConnectionsIP = 5
149 # Maximum number of channels a user can be member of (0: no limit):
152 # Maximum length of an user nick name (Default: 9, as in RFC 2812).
153 # Please note that all servers in an IRC network MUST use the same
154 # maximum nick name length!
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 # Set this hostname for every client instead of the real one.
163 # Please note: don't use the percentage sign ("%"), it is reserved for
165 ;CloakHost = irc.example.net
167 # Set every clients' user name to their nick name
168 ;CloakUserToNick = yes
171 # Do any DNS lookups when a client connects to the server.
174 # Do any IDENT lookups if ngIRCd has been compiled with support for it.
177 # Use PAM if ngIRCd has been compiled with support for it.
181 # [Operator] sections are used to define IRC Operators. There may be
182 # more than one [Operator] block, one for each local operator.
184 # ID of the operator (may be different of the nick name)
187 # Password of the IRC operator
190 # Optional Mask from which /OPER will be accepted
191 ;Mask = *!ident@somewhere.example.com
194 # More [Operator] sections, if you like ...
197 # Other servers are configured in [Server] sections. If you
198 # configure a port for the connection, then this ngircd tries to
199 # connect to to the other server on the given port; if not it waits
200 # for the other server to connect.
201 # There may be more than one server block, one for each server.
204 # The ngIRCd allows "server groups": You can assign an "ID" to every
205 # server with which you want this ngIRCd to link. If a server of a
206 # group won't answer, the ngIRCd tries to connect to the next server
207 # in the given group. But the ngircd never tries to connect to two
208 # servers with the same group ID.
210 # IRC name of the remote server, must match the "Name" variable in
211 # the [Global] section of the other server (when using ngIRCd).
212 ;Name = irc2.example.net
214 # Internet host name or IP address of the peer (only required when
215 # this server should establish the connection).
216 ;Host = connect-to-host.example.net
218 # IP address to use as _source_ address for the connection. if
219 # unspecified, ngircd will let the operating system pick an address.
222 # Port of the server to which the ngIRCd should connect. If you
223 # assign no port the ngIRCd waits for incoming connections.
226 # Own password for the connection. This password has to be configured
227 # as "PeerPassword" on the other server.
228 ;MyPassword = MySecret
230 # Foreign password for this connection. This password has to be
231 # configured as "MyPassword" on the other server.
232 ;PeerPassword = PeerSecret
234 # Group of this server (optional)
237 # Set the "Passive" option to "yes" if you don't want this ngIRCd to
238 # connect to the configured peer (same as leaving the "Port" variable
239 # empty). The advantage of this option is that you can actually
240 # configure a port an use the IRC command CONNECT more easily to
241 # manually connect this specific server later.
244 # Connect to the remote server using TLS/SSL (Default: false)
247 # Define a (case insensitive) mask matching nick names that should be
248 # treated as IRC services when introduced via this remote server.
249 # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
250 # (which is the default).
251 # When you are connecting IRC services which mask as a IRC server
252 # and which use "virtual users" to communicate with, for example
253 # "NickServ" and "ChanServ", you should set this parameter to
254 # something like "*Serv".
258 # More [Server] sections, if you like ...
261 # Pre-defined channels can be configured in [Channel] sections.
262 # Such channels are created by the server when starting up and even
263 # persist when there are no more members left.
264 # Persistent channels are marked with the mode 'P', which can be set
265 # and unset by IRC operators like other modes on the fly.
266 # There may be more than one [Channel] block, one for each channel.
268 # Name of the channel
271 # Topic for this channel
272 ;Topic = a great topic
274 # Initial channel modes
277 # initial channel password (mode k)
280 # Key file, syntax for each line: "<user>:<nick>:<key>".
282 ;KeyFile = :ETCDIR:/#chan.key
284 # maximum users per channel (mode l)
288 # More [Channel] sections, if you like ...