Fix spelling in some documents.
[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         ;Password = abc
33
34         # Information about the server and the administrator, used by the
35         # ADMIN command. Not required by server but by RFC!
36         ;AdminInfo1 = Description
37         ;AdminInfo2 = Location
38         ;AdminEMail = admin@irc.server
39  
40         # Ports on which the server should listen. There may be more than
41         # one port, separated with ",". (Default: 6667)
42         ;Ports = 6667, 6668, 6669
43
44         # Additional Listen Ports that expect SSL/TLS encrypted connections
45         ;SSLPorts = 9999,6668
46
47         # SSL Server Key
48         ;SSLKeyFile = /usr/local/etc/ngircd/ssl/server-key.pem
49
50         # password to decrypt SSLKeyFile (OpenSSL only)
51         ;SSLKeyFilePassword = secret
52
53         # SSL Server Key Certificate
54         ;SSLCertFile = /usr/local/etc/ngircd/ssl/server-cert.pem
55
56         # Diffie-Hellman parameters
57         ;SSLDHFile = /usr/local/etc/ngircd/ssl/dhparams.pem
58
59         # comma separated list of IP addresses on which the server should
60         # listen. Default values are:
61         # "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0"
62         # so the server listens on all IP addresses of the system by default.
63         ;Listen = 127.0.0.1,192.168.0.1
64
65         # Text file with the "message of the day" (MOTD). This message will
66         # be shown to all users connecting to the server:
67         ;MotdFile = /usr/local/etc/ngircd.motd
68
69         # A simple Phrase (<256 chars) if you don't want to use a motd file.
70         # If it is set no MotdFile will be read at all.
71         ;MotdPhrase = "Hello world!"
72
73         # User ID under which the server should run; you can use the name
74         # of the user or the numerical ID. ATTENTION: For this to work the
75         # server must have been started with root privileges! In addition,
76         # the configuration and MOTD files must be readable by this user,
77         # otherwise RESTART and REHASH won't work!
78         ;ServerUID = 65534
79
80         # Group ID under which the ngircd should run; you can use the name
81         # of the group or the numerical ID. ATTENTION: For this to work the
82         # server must have been started with root privileges!
83         ;ServerGID = 65534
84
85         # A directory to chroot in when everything is initialized. It
86         # doesn't need to be populated if ngIRCd is compiled as a static
87         # binary. By default ngIRCd won't use the chroot() feature.
88         # ATTENTION: For this to work the server must have been started
89         # with root privileges!
90         ;ChrootDir = /var/empty
91
92         # This tells ngircd to write its current process id to a file.
93         # Note that the pidfile is written AFTER chroot and switching uid,
94         # i. e. the Directory the pidfile resides in must be writeable by
95         # the ngircd user and exist in the chroot directory.
96         ;PidFile = /var/run/ngircd/ngircd.pid
97
98         # After <PingTimeout> seconds of inactivity the server will send a
99         # PING to the peer to test whether it is alive or not.
100         ;PingTimeout = 120
101
102         # If a client fails to answer a PING with a PONG within <PongTimeout>
103         # seconds, it will be disconnected by the server.
104         ;PongTimeout = 20
105
106         # The server tries every <ConnectRetry> seconds to establish a link
107         # to not yet (or no longer) connected servers.
108         ;ConnectRetry = 60
109
110         # Should IRC Operators be allowed to use the MODE command even if
111         # they are not(!) channel-operators?
112         ;OperCanUseMode = no
113
114         # Mask IRC Operator mode requests as if they were coming from the
115         # server? (This is a compatibility hack for ircd-irc2 servers)
116         ;OperServerMode = no
117
118         # Allow Pre-Defined Channels only (see Section [Channels])
119         ;PredefChannelsOnly = no
120
121         # Don't do any DNS lookups when a client connects to the server.
122         ;NoDNS = no
123
124         # Don't do any IDENT lookups, even if ngIRCd has been compiled
125         # with support for it.
126         ;NoIdent = no
127
128         # try to connect to other irc servers using ipv4 and ipv6, if possible
129         ;ConnectIPv6 = yes
130         ;ConnectIPv4 = yes
131
132         # Maximum number of simultaneous in- and outbound connections the
133         # server is allowed to accept (0: unlimited):
134         ;MaxConnections = 0
135
136         # Maximum number of simultaneous connections from a single IP address
137         # the server will accept (0: unlimited):
138         ;MaxConnectionsIP = 5
139
140         # Maximum number of channels a user can be member of (0: no limit):
141         ;MaxJoins = 10
142
143         # Maximum length of an user nick name (Default: 9, as in RFC 2812).
144         # Please note that all servers in an IRC network MUST use the same
145         # maximum nick name length!
146         ;MaxNickLength = 9
147
148 [Operator]
149         # [Operator] sections are used to define IRC Operators. There may be
150         # more than one [Operator] block, one for each local operator.
151
152         # ID of the operator (may be different of the nick name)
153         ;Name = TheOper
154
155         # Password of the IRC operator
156         ;Password = ThePwd
157
158         # Optional Mask from which /OPER will be accepted
159         ;Mask = *!ident@somewhere.example.com
160
161 [Operator]
162         # More [Operator] sections, if you like ...
163
164 [Server]
165         # Other servers are configured in [Server] sections. If you
166         # configure a port for the connection, then this ngircd tries to
167         # connect to to the other server on the given port; if not it waits
168         # for the other server to connect.
169         # There may be more than one server block, one for each server.
170         #
171         # Server Groups:
172         # The ngIRCd allows "server groups": You can assign an "ID" to every
173         # server with which you want this ngIRCd to link. If a server of a
174         # group won't answer, the ngIRCd tries to connect to the next server
175         # in the given group. But the ngircd never tries to connect to two
176         # servers with the same group ID.
177
178         # IRC name of the remote server, must match the "Name" variable in
179         # the [Global] section of the other server (when using ngIRCd).
180         ;Name = irc2.the.net
181
182         # Internet host name or IP address of the peer (only required when
183         # this server should establish the connection).
184         ;Host = connect-to-host.the.net
185
186         # IP address to use as _source_ address for the connection. if
187         # unspecified, ngircd will let the operating system pick an address.
188         ;Bind = 10.0.0.1
189
190         # Port of the server to which the ngIRCd should connect. If you
191         # assign no port the ngIRCd waits for incoming connections.
192         ;Port = 6667
193
194         # Own password for the connection. This password has to be configured
195         # as "PeerPassword" on the other server.
196         ;MyPassword = MySecret
197
198         # Foreign password for this connection. This password has to be
199         # configured as "MyPassword" on the other server.
200         ;PeerPassword = PeerSecret
201
202         # Group of this server (optional)
203         ;Group = 123
204
205         # Set the "Passive" option to "yes" if you don't want this ngIRCd to
206         # connect to the configured peer (same as leaving the "Port" variable
207         # empty). The advantage of this option is that you can actually
208         # configure a port an use the IRC command CONNECT more easily to
209         # manually connect this specific server later.
210         ;Passive = no
211
212         # Connect to the remote server using TLS/SSL (Default: false)
213         ;SSLConnect = yes
214
215         # Define a (case insensitive) mask matching nick names that should be
216         # treated as IRC services when introduced via this remote server.
217         # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
218         # (which is the default).
219         # When you are connecting IRC services which mask as a IRC server
220         # and which use "virtual users" to communicate with, for example
221         # "NickServ" and "ChanServ", you should set this parameter to
222         # something like "*Serv".
223         ;ServiceMask = *Serv
224
225 [Server]
226         # More [Server] sections, if you like ...
227
228 [Channel]
229         # Pre-defined channels can be configured in [Channel] sections.
230         # Such channels are created by the server when starting up and even
231         # persist when there are no more members left.
232         # Persistent channels are marked with the mode 'P', which can be set
233         # and unset by IRC operators like other modes on the fly.
234         # There may be more than one [Channel] block, one for each channel.
235
236         # Name of the channel
237         ;Name = #TheName
238
239         # Topic for this channel
240         ;Topic = a great topic
241
242         # Initial channel modes
243         ;Modes = tnk
244
245         # initial channel password (mode k)
246         ;Key = Secret
247
248         # maximum users per channel (mode l)
249         ;MaxUsers = 23
250
251 [Channel]
252         # More [Channel] sections, if you like ...
253
254 # -eof-