Add documentation for "ScrubCTCP" configuration option
[ngircd-alex.git] / doc / sample-ngircd.conf.tmpl
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 #
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
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
28
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
34
35         # Info text of the server. This will be shown by WHOIS and
36         # LINKS requests for example.
37         Info = Server Info Text
38
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
44
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
48
49         # A simple Phrase (<256 chars) if you don't want to use a motd file.
50         ;MotdPhrase = "Hello world!"
51
52         # Global password for all users needed to connect to the server.
53         # (Default: not set)
54         ;Password = abc
55
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
61
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
65
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!
69         ;ServerGID = 65534
70
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!
76         ;ServerUID = 65534
77
78 [Limits]
79         # Define some limits and timeouts for this ngIRCd instance. Default
80         # values should be safe, but it is wise to double-check :-)
81
82         # The server tries every <ConnectRetry> seconds to establish a link
83         # to not yet (or no longer) connected servers.
84         ;ConnectRetry = 60
85
86         # Maximum number of simultaneous in- and outbound connections the
87         # server is allowed to accept (0: unlimited):
88         ;MaxConnections = 0
89
90         # Maximum number of simultaneous connections from a single IP address
91         # the server will accept (0: unlimited):
92         ;MaxConnectionsIP = 5
93
94         # Maximum number of channels a user can be member of (0: no limit):
95         ;MaxJoins = 10
96
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!
100         ;MaxNickLength = 9
101
102         # After <PingTimeout> seconds of inactivity the server will send a
103         # PING to the peer to test whether it is alive or not.
104         ;PingTimeout = 120
105
106         # If a client fails to answer a PING with a PONG within <PongTimeout>
107         # seconds, it will be disconnected by the server.
108         ;PongTimeout = 20
109
110 [Options]
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.
114
115         # Are remote IRC operators allowed to control this server, e.g.
116         # use commands like CONNECT, SQUIT, DIE, ...?
117         ;AllowRemoteOper = no
118
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
125
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
128         # future extensions!
129         ;CloakHost = irc.example.net
130
131         # Set every clients' user name to their nick name
132         ;CloakUserToNick = yes
133
134         # Try to connect to other IRC servers using IPv4 and IPv6, if possible.
135         ;ConnectIPv6 = yes
136         ;ConnectIPv4 = yes
137
138         # Do any DNS lookups when a client connects to the server.
139         ;DNS = yes
140
141         # Do IDENT lookups if ngIRCd has been compiled with support for it.
142         ;Ident = yes
143
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.
147         ;NoticeAuth = no
148
149         # Should IRC Operators be allowed to use the MODE command even if
150         # they are not(!) channel-operators?
151         ;OperCanUseMode = no
152
153         # Mask IRC Operator mode requests as if they were coming from the
154         # server? (This is a compatibility hack for ircd-irc2 servers)
155         ;OperServerMode = no
156
157         # Use PAM if ngIRCd has been compiled with support for it.
158         ;PAM = no
159
160         # Allow Pre-Defined Channels only (see Section [Channels])
161         ;PredefChannelsOnly = no
162
163         # Let ngIRCd send an "authentication PING" when a new client connects,
164         # and register this client only after receiving the corresponding
165         # "PONG" reply.
166         ;RequireAuthPing = no
167
168         # Silently drop all incomming CTCP requests.
169         ;ScrubCTCP = no
170
171         # SSL Server Key Certificate
172         ;SSLCertFile = :ETCDIR:/ssl/server-cert.pem
173
174         # Diffie-Hellman parameters
175         ;SSLDHFile = :ETCDIR:/ssl/dhparams.pem
176
177         # SSL Server Key
178         ;SSLKeyFile = :ETCDIR:/ssl/server-key.pem
179
180         # password to decrypt SSLKeyFile (OpenSSL only)
181         ;SSLKeyFilePassword = secret
182
183         # Additional Listen Ports that expect SSL/TLS encrypted connections
184         ;SSLPorts = 6697, 9999
185
186         # Syslog "facility" to which ngIRCd should send log messages.
187         # Possible values are system dependent, but most probably auth, daemon,
188         # user and local1 through local7 are possible values; see syslog(3).
189         # Default is "local5" for historical reasons, you probably want to
190         # change this to "daemon", for example.
191         SyslogFacility = local1
192
193         # Password required for using the WEBIRC command used by some
194         # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
195         # be used. (Default: not set)
196         ;WebircPassword = xyz
197
198 [Operator]
199         # [Operator] sections are used to define IRC Operators. There may be
200         # more than one [Operator] block, one for each local operator.
201
202         # ID of the operator (may be different of the nick name)
203         ;Name = TheOper
204
205         # Password of the IRC operator
206         ;Password = ThePwd
207
208         # Optional Mask from which /OPER will be accepted
209         ;Mask = *!ident@somewhere.example.com
210
211 [Operator]
212         # More [Operator] sections, if you like ...
213
214 [Server]
215         # Other servers are configured in [Server] sections. If you
216         # configure a port for the connection, then this ngircd tries to
217         # connect to to the other server on the given port; if not it waits
218         # for the other server to connect.
219         # There may be more than one server block, one for each server.
220         #
221         # Server Groups:
222         # The ngIRCd allows "server groups": You can assign an "ID" to every
223         # server with which you want this ngIRCd to link. If a server of a
224         # group won't answer, the ngIRCd tries to connect to the next server
225         # in the given group. But the ngircd never tries to connect to two
226         # servers with the same group ID.
227
228         # IRC name of the remote server, must match the "Name" variable in
229         # the [Global] section of the other server (when using ngIRCd).
230         ;Name = irc2.example.net
231
232         # Internet host name or IP address of the peer (only required when
233         # this server should establish the connection).
234         ;Host = connect-to-host.example.net
235
236         # IP address to use as _source_ address for the connection. if
237         # unspecified, ngircd will let the operating system pick an address.
238         ;Bind = 10.0.0.1
239
240         # Port of the server to which the ngIRCd should connect. If you
241         # assign no port the ngIRCd waits for incoming connections.
242         ;Port = 6667
243
244         # Own password for the connection. This password has to be configured
245         # as "PeerPassword" on the other server.
246         ;MyPassword = MySecret
247
248         # Foreign password for this connection. This password has to be
249         # configured as "MyPassword" on the other server.
250         ;PeerPassword = PeerSecret
251
252         # Group of this server (optional)
253         ;Group = 123
254
255         # Set the "Passive" option to "yes" if you don't want this ngIRCd to
256         # connect to the configured peer (same as leaving the "Port" variable
257         # empty). The advantage of this option is that you can actually
258         # configure a port an use the IRC command CONNECT more easily to
259         # manually connect this specific server later.
260         ;Passive = no
261
262         # Connect to the remote server using TLS/SSL (Default: false)
263         ;SSLConnect = yes
264
265         # Define a (case insensitive) mask matching nick names that should be
266         # treated as IRC services when introduced via this remote server.
267         # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
268         # (which is the default).
269         # When you are connecting IRC services which mask as a IRC server
270         # and which use "virtual users" to communicate with, for example
271         # "NickServ" and "ChanServ", you should set this parameter to
272         # something like "*Serv".
273         ;ServiceMask = *Serv
274
275 [Server]
276         # More [Server] sections, if you like ...
277
278 [Channel]
279         # Pre-defined channels can be configured in [Channel] sections.
280         # Such channels are created by the server when starting up and even
281         # persist when there are no more members left.
282         # Persistent channels are marked with the mode 'P', which can be set
283         # and unset by IRC operators like other modes on the fly.
284         # There may be more than one [Channel] block, one for each channel.
285
286         # Name of the channel
287         ;Name = #TheName
288
289         # Topic for this channel
290         ;Topic = a great topic
291
292         # Initial channel modes
293         ;Modes = tnk
294
295         # initial channel password (mode k)
296         ;Key = Secret
297
298         # Key file, syntax for each line: "<user>:<nick>:<key>".
299         # Default: none.
300         ;KeyFile = :ETCDIR:/#chan.key
301
302         # maximum users per channel (mode l)
303         ;MaxUsers = 23
304
305 [Channel]
306         # More [Channel] sections, if you like ...
307
308 # -eof-