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