New configuration option "NoZeroConf" to disable ZeroConf registration
[ngircd-alex.git] / doc / sample-ngircd.conf
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
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.the.net
26
27         # Info text of the server. This will be shown by WHOIS and
28         # LINKS requests for example.
29         Info = Server Info Text
30
31         # Global password for all users needed to connect to the server.
32         # (Default: not set)
33         ;Password = abc
34
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)
38         ;WebircPassword = xyz
39
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
45  
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
49
50         # Additional Listen Ports that expect SSL/TLS encrypted connections
51         ;SSLPorts = 6697, 9999
52
53         # SSL Server Key
54         ;SSLKeyFile = /usr/local/etc/ngircd/ssl/server-key.pem
55
56         # password to decrypt SSLKeyFile (OpenSSL only)
57         ;SSLKeyFilePassword = secret
58
59         # SSL Server Key Certificate
60         ;SSLCertFile = /usr/local/etc/ngircd/ssl/server-cert.pem
61
62         # Diffie-Hellman parameters
63         ;SSLDHFile = /usr/local/etc/ngircd/ssl/dhparams.pem
64
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
70
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
77
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 = /usr/local/etc/ngircd.motd
81
82         # A simple Phrase (<256 chars) if you don't want to use a motd file.
83         ;MotdPhrase = "Hello world!"
84
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!
90         ;ServerUID = 65534
91
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!
95         ;ServerGID = 65534
96
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
103
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
109
110         # After <PingTimeout> seconds of inactivity the server will send a
111         # PING to the peer to test whether it is alive or not.
112         ;PingTimeout = 120
113
114         # If a client fails to answer a PING with a PONG within <PongTimeout>
115         # seconds, it will be disconnected by the server.
116         ;PongTimeout = 20
117
118         # The server tries every <ConnectRetry> seconds to establish a link
119         # to not yet (or no longer) connected servers.
120         ;ConnectRetry = 60
121
122         # Should IRC Operators be allowed to use the MODE command even if
123         # they are not(!) channel-operators?
124         ;OperCanUseMode = no
125
126         # Mask IRC Operator mode requests as if they were coming from the
127         # server? (This is a compatibility hack for ircd-irc2 servers)
128         ;OperServerMode = no
129
130         # Are remote IRC operators allowed to control this server, e. g.
131         # use commands like CONNECT, SQUIT, DIE, ...?
132         ;AllowRemoteOper = no
133
134         # Allow Pre-Defined Channels only (see Section [Channels])
135         ;PredefChannelsOnly = no
136
137         # Don't do any DNS lookups when a client connects to the server.
138         ;NoDNS = no
139
140         # Don't do any IDENT lookups, even if ngIRCd has been compiled
141         # with support for it.
142         ;NoIdent = no
143
144         # Don't use PAM, even if ngIRCd has been compiled with support for it.
145         ;NoPAM = no
146
147         # Don't use ZeroConf service registration, even if ngIRCd has been
148         # compiled with support for it (e.g. Howl, Avahi, Mac OS X).
149         ;NoZeroConf = no
150
151         # try to connect to other irc servers using ipv4 and ipv6, if possible
152         ;ConnectIPv6 = yes
153         ;ConnectIPv4 = yes
154
155         # Maximum number of simultaneous in- and outbound connections the
156         # server is allowed to accept (0: unlimited):
157         ;MaxConnections = 0
158
159         # Maximum number of simultaneous connections from a single IP address
160         # the server will accept (0: unlimited):
161         ;MaxConnectionsIP = 5
162
163         # Maximum number of channels a user can be member of (0: no limit):
164         ;MaxJoins = 10
165
166         # Maximum length of an user nick name (Default: 9, as in RFC 2812).
167         # Please note that all servers in an IRC network MUST use the same
168         # maximum nick name length!
169         ;MaxNickLength = 9
170
171 [Operator]
172         # [Operator] sections are used to define IRC Operators. There may be
173         # more than one [Operator] block, one for each local operator.
174
175         # ID of the operator (may be different of the nick name)
176         ;Name = TheOper
177
178         # Password of the IRC operator
179         ;Password = ThePwd
180
181         # Optional Mask from which /OPER will be accepted
182         ;Mask = *!ident@somewhere.example.com
183
184 [Operator]
185         # More [Operator] sections, if you like ...
186
187 [Server]
188         # Other servers are configured in [Server] sections. If you
189         # configure a port for the connection, then this ngircd tries to
190         # connect to to the other server on the given port; if not it waits
191         # for the other server to connect.
192         # There may be more than one server block, one for each server.
193         #
194         # Server Groups:
195         # The ngIRCd allows "server groups": You can assign an "ID" to every
196         # server with which you want this ngIRCd to link. If a server of a
197         # group won't answer, the ngIRCd tries to connect to the next server
198         # in the given group. But the ngircd never tries to connect to two
199         # servers with the same group ID.
200
201         # IRC name of the remote server, must match the "Name" variable in
202         # the [Global] section of the other server (when using ngIRCd).
203         ;Name = irc2.the.net
204
205         # Internet host name or IP address of the peer (only required when
206         # this server should establish the connection).
207         ;Host = connect-to-host.the.net
208
209         # IP address to use as _source_ address for the connection. if
210         # unspecified, ngircd will let the operating system pick an address.
211         ;Bind = 10.0.0.1
212
213         # Port of the server to which the ngIRCd should connect. If you
214         # assign no port the ngIRCd waits for incoming connections.
215         ;Port = 6667
216
217         # Own password for the connection. This password has to be configured
218         # as "PeerPassword" on the other server.
219         ;MyPassword = MySecret
220
221         # Foreign password for this connection. This password has to be
222         # configured as "MyPassword" on the other server.
223         ;PeerPassword = PeerSecret
224
225         # Group of this server (optional)
226         ;Group = 123
227
228         # Set the "Passive" option to "yes" if you don't want this ngIRCd to
229         # connect to the configured peer (same as leaving the "Port" variable
230         # empty). The advantage of this option is that you can actually
231         # configure a port an use the IRC command CONNECT more easily to
232         # manually connect this specific server later.
233         ;Passive = no
234
235         # Connect to the remote server using TLS/SSL (Default: false)
236         ;SSLConnect = yes
237
238         # Define a (case insensitive) mask matching nick names that should be
239         # treated as IRC services when introduced via this remote server.
240         # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
241         # (which is the default).
242         # When you are connecting IRC services which mask as a IRC server
243         # and which use "virtual users" to communicate with, for example
244         # "NickServ" and "ChanServ", you should set this parameter to
245         # something like "*Serv".
246         ;ServiceMask = *Serv
247
248 [Server]
249         # More [Server] sections, if you like ...
250
251 [Channel]
252         # Pre-defined channels can be configured in [Channel] sections.
253         # Such channels are created by the server when starting up and even
254         # persist when there are no more members left.
255         # Persistent channels are marked with the mode 'P', which can be set
256         # and unset by IRC operators like other modes on the fly.
257         # There may be more than one [Channel] block, one for each channel.
258
259         # Name of the channel
260         ;Name = #TheName
261
262         # Topic for this channel
263         ;Topic = a great topic
264
265         # Initial channel modes
266         ;Modes = tnk
267
268         # initial channel password (mode k)
269         ;Key = Secret
270
271         # Key file, syntax for each line: "<user>:<nick>:<key>".
272         # Default: none.
273         ;KeyFile = /etc/ngircd/#chan.key
274
275         # maximum users per channel (mode l)
276         ;MaxUsers = 23
277
278 [Channel]
279         # More [Channel] sections, if you like ...
280
281 # -eof-