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