ngircd: change MOTD file handling
[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         # 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
74
75         # A simple Phrase (<256 chars) if you don't want to use a motd file.
76         ;MotdPhrase = "Hello world!"
77
78         # User ID under which the server should run; you can use the name
79         # of the user or the numerical ID. ATTENTION: For this to work the
80         # server must have been started with root privileges! In addition,
81         # the configuration and MOTD files must be readable by this user,
82         # otherwise RESTART and REHASH won't work!
83         ;ServerUID = 65534
84
85         # Group ID under which the ngircd should run; you can use the name
86         # of the group or the numerical ID. ATTENTION: For this to work the
87         # server must have been started with root privileges!
88         ;ServerGID = 65534
89
90         # A directory to chroot in when everything is initialized. It
91         # doesn't need to be populated if ngIRCd is compiled as a static
92         # binary. By default ngIRCd won't use the chroot() feature.
93         # ATTENTION: For this to work the server must have been started
94         # with root privileges!
95         ;ChrootDir = /var/empty
96
97         # This tells ngircd to write its current process id to a file.
98         # Note that the pidfile is written AFTER chroot and switching uid,
99         # i. e. the Directory the pidfile resides in must be writeable by
100         # the ngircd user and exist in the chroot directory.
101         ;PidFile = /var/run/ngircd/ngircd.pid
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         # The server tries every <ConnectRetry> seconds to establish a link
112         # to not yet (or no longer) connected servers.
113         ;ConnectRetry = 60
114
115         # Should IRC Operators be allowed to use the MODE command even if
116         # they are not(!) channel-operators?
117         ;OperCanUseMode = no
118
119         # Mask IRC Operator mode requests as if they were coming from the
120         # server? (This is a compatibility hack for ircd-irc2 servers)
121         ;OperServerMode = no
122
123         # Are remote IRC operators allowed to control this server, e. g.
124         # use commands like CONNECT, SQUIT, DIE, ...?
125         ;AllowRemoteOper = no
126
127         # Allow Pre-Defined Channels only (see Section [Channels])
128         ;PredefChannelsOnly = no
129
130         # Don't do any DNS lookups when a client connects to the server.
131         ;NoDNS = no
132
133         # Don't do any IDENT lookups, even if ngIRCd has been compiled
134         # with support for it.
135         ;NoIdent = no
136
137         # Don't use PAM, even if ngIRCd has been compiled with support for it.
138         ;NoPAM = no
139
140         # try to connect to other irc servers using ipv4 and ipv6, if possible
141         ;ConnectIPv6 = yes
142         ;ConnectIPv4 = yes
143
144         # Maximum number of simultaneous in- and outbound connections the
145         # server is allowed to accept (0: unlimited):
146         ;MaxConnections = 0
147
148         # Maximum number of simultaneous connections from a single IP address
149         # the server will accept (0: unlimited):
150         ;MaxConnectionsIP = 5
151
152         # Maximum number of channels a user can be member of (0: no limit):
153         ;MaxJoins = 10
154
155         # Maximum length of an user nick name (Default: 9, as in RFC 2812).
156         # Please note that all servers in an IRC network MUST use the same
157         # maximum nick name length!
158         ;MaxNickLength = 9
159
160 [Operator]
161         # [Operator] sections are used to define IRC Operators. There may be
162         # more than one [Operator] block, one for each local operator.
163
164         # ID of the operator (may be different of the nick name)
165         ;Name = TheOper
166
167         # Password of the IRC operator
168         ;Password = ThePwd
169
170         # Optional Mask from which /OPER will be accepted
171         ;Mask = *!ident@somewhere.example.com
172
173 [Operator]
174         # More [Operator] sections, if you like ...
175
176 [Server]
177         # Other servers are configured in [Server] sections. If you
178         # configure a port for the connection, then this ngircd tries to
179         # connect to to the other server on the given port; if not it waits
180         # for the other server to connect.
181         # There may be more than one server block, one for each server.
182         #
183         # Server Groups:
184         # The ngIRCd allows "server groups": You can assign an "ID" to every
185         # server with which you want this ngIRCd to link. If a server of a
186         # group won't answer, the ngIRCd tries to connect to the next server
187         # in the given group. But the ngircd never tries to connect to two
188         # servers with the same group ID.
189
190         # IRC name of the remote server, must match the "Name" variable in
191         # the [Global] section of the other server (when using ngIRCd).
192         ;Name = irc2.the.net
193
194         # Internet host name or IP address of the peer (only required when
195         # this server should establish the connection).
196         ;Host = connect-to-host.the.net
197
198         # IP address to use as _source_ address for the connection. if
199         # unspecified, ngircd will let the operating system pick an address.
200         ;Bind = 10.0.0.1
201
202         # Port of the server to which the ngIRCd should connect. If you
203         # assign no port the ngIRCd waits for incoming connections.
204         ;Port = 6667
205
206         # Own password for the connection. This password has to be configured
207         # as "PeerPassword" on the other server.
208         ;MyPassword = MySecret
209
210         # Foreign password for this connection. This password has to be
211         # configured as "MyPassword" on the other server.
212         ;PeerPassword = PeerSecret
213
214         # Group of this server (optional)
215         ;Group = 123
216
217         # Set the "Passive" option to "yes" if you don't want this ngIRCd to
218         # connect to the configured peer (same as leaving the "Port" variable
219         # empty). The advantage of this option is that you can actually
220         # configure a port an use the IRC command CONNECT more easily to
221         # manually connect this specific server later.
222         ;Passive = no
223
224         # Connect to the remote server using TLS/SSL (Default: false)
225         ;SSLConnect = yes
226
227         # Define a (case insensitive) mask matching nick names that should be
228         # treated as IRC services when introduced via this remote server.
229         # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
230         # (which is the default).
231         # When you are connecting IRC services which mask as a IRC server
232         # and which use "virtual users" to communicate with, for example
233         # "NickServ" and "ChanServ", you should set this parameter to
234         # something like "*Serv".
235         ;ServiceMask = *Serv
236
237 [Server]
238         # More [Server] sections, if you like ...
239
240 [Channel]
241         # Pre-defined channels can be configured in [Channel] sections.
242         # Such channels are created by the server when starting up and even
243         # persist when there are no more members left.
244         # Persistent channels are marked with the mode 'P', which can be set
245         # and unset by IRC operators like other modes on the fly.
246         # There may be more than one [Channel] block, one for each channel.
247
248         # Name of the channel
249         ;Name = #TheName
250
251         # Topic for this channel
252         ;Topic = a great topic
253
254         # Initial channel modes
255         ;Modes = tnk
256
257         # initial channel password (mode k)
258         ;Key = Secret
259
260         # Key file, syntax for each line: "<user>:<nick>:<key>".
261         # Default: none.
262         ;KeyFile = /etc/ngircd/#chan.key
263
264         # maximum users per channel (mode l)
265         ;MaxUsers = 23
266
267 [Channel]
268         # More [Channel] sections, if you like ...
269
270 # -eof-