1 35b6f399 2008-01-07 alex # $Id: sample-ngircd.conf,v 1.44 2008/01/07 23:02:29 alex Exp $
4 05170bc9 2003-12-19 alex # This is a sample configuration file for the ngIRCd, which must be adepted
5 05170bc9 2003-12-19 alex # to the local preferences and needs.
7 5b333085 2003-01-04 alex # Comments are started with "#" or ";".
9 9021ea20 2007-10-04 alex # A lot of configuration options in this file start with a ";". You have
10 9021ea20 2007-10-04 alex # to remove the ";" in front of each variable to actually set a value!
11 9021ea20 2007-10-04 alex # The disabled variables are shown with example values for completeness.
13 05170bc9 2003-12-19 alex # Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
14 c7bd9da4 2006-04-09 alex # server interprets the configuration file as expected!
16 ebf5edfd 2008-09-13 fw # Please see ngircd.conf(5) for a complete list of configuration options.
20 10bb43c6 2003-03-10 alex # The [Global] section of this file is used to define the main
21 10bb43c6 2003-03-10 alex # configuration of the server, like the server name and the ports
22 10bb43c6 2003-03-10 alex # on which the server should be listening.
24 e541da2a 2003-04-29 alex # Server name in the IRC network, must contain at least one dot
25 05170bc9 2003-12-19 alex # (".") and be unique in the IRC network. Required!
26 969e5f1c 2002-01-06 alex Name = irc.the.net
28 10bb43c6 2003-03-10 alex # Info text of the server. This will be shown by WHOIS and
29 10bb43c6 2003-03-10 alex # LINKS requests for example.
30 969e5f1c 2002-01-06 alex Info = Server Info Text
32 927e626f 2003-04-27 alex # Global password for all users needed to connect to the server
33 927e626f 2003-04-27 alex ;Password = abc
35 10bb43c6 2003-03-10 alex # Information about the server and the administrator, used by the
36 05170bc9 2003-12-19 alex # ADMIN command. Not required by server but by RFC!
37 5b333085 2003-01-04 alex ;AdminInfo1 = Description
38 5b333085 2003-01-04 alex ;AdminInfo2 = Location
39 efeba4a7 2002-09-16 alex ;AdminEMail = admin@irc.server
41 10bb43c6 2003-03-10 alex # Ports on which the server should listen. There may be more than
42 6dacec7d 2005-01-17 alex # one port, separated with ",". (Default: 6667)
43 386d3b9e 2004-12-27 alex ;Ports = 6667, 6668, 6669
45 ebf5edfd 2008-09-13 fw # Additional Listen Ports that expect SSL/TLS encrypted connections
46 ebf5edfd 2008-09-13 fw ;SSLPorts = 9999,6668
48 ebf5edfd 2008-09-13 fw # SSL Server Key
49 ebf5edfd 2008-09-13 fw ;SSLKeyFile = /usr/local/etc/ngircd/ssl/server-key.pem
51 ebf5edfd 2008-09-13 fw # password to decrypt SSLKeyFile (OpenSSL only)
52 ebf5edfd 2008-09-13 fw ;SSLKeyFilePassword = secret
54 ebf5edfd 2008-09-13 fw # SSL Server Key Certificate
55 ebf5edfd 2008-09-13 fw ;SSLCertFile = /usr/local/etc/ngircd/ssl/server-cert.pem
57 ebf5edfd 2008-09-13 fw # Diffie-Hellman parameters
58 ebf5edfd 2008-09-13 fw ;SSLDHFile = /usr/local/etc/ngircd/ssl/dhparams.pem
60 4ed2cb1a 2008-05-19 fw # comma seperated list of IP addresses on which the server should
61 4ed2cb1a 2008-05-19 fw # listen. Default values are:
62 4ed2cb1a 2008-05-19 fw # "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0"
63 4ed2cb1a 2008-05-19 fw # so the server listens on all IP addresses of the system by default.
64 4ed2cb1a 2008-05-19 fw ;Listen = 127.0.0.1,192.168.0.1
66 10bb43c6 2003-03-10 alex # Text file with the "message of the day" (MOTD). This message will
67 10bb43c6 2003-03-10 alex # be shown to all users connecting to the server:
68 7efefd30 2002-03-29 alex ;MotdFile = /usr/local/etc/ngircd.motd
70 7281b8dd 2004-05-07 alex # A simple Phrase (<256 chars) if you don't want to use a motd file.
71 7281b8dd 2004-05-07 alex # If it is set no MotdFile will be read at all.
72 7281b8dd 2004-05-07 alex ;MotdPhrase = "Hello world!"
74 10bb43c6 2003-03-10 alex # User ID under which the server should run; you can use the name
75 10bb43c6 2003-03-10 alex # of the user or the numerical ID. ATTENTION: For this to work the
76 10bb43c6 2003-03-10 alex # server must have been started with root privileges! In addition,
77 10bb43c6 2003-03-10 alex # the configuration and MOTD files must be readable by this user,
78 10bb43c6 2003-03-10 alex # otherwise RESTART and REHASH won't work!
79 5b333085 2003-01-04 alex ;ServerUID = 65534
81 10bb43c6 2003-03-10 alex # Group ID under which the ngircd should run; you can use the name
82 10bb43c6 2003-03-10 alex # of the group or the numerical ID. ATTENTION: For this to work the
83 10bb43c6 2003-03-10 alex # server must have been started with root privileges!
84 5b333085 2003-01-04 alex ;ServerGID = 65534
86 7281b8dd 2004-05-07 alex # A directory to chroot in when everything is initialized. It
87 7281b8dd 2004-05-07 alex # doesn't need to be populated if ngIRCd is compiled as a static
88 7281b8dd 2004-05-07 alex # binary. By default ngIRCd won't use the chroot() feature.
89 7281b8dd 2004-05-07 alex # ATTENTION: For this to work the server must have been started
90 7281b8dd 2004-05-07 alex # with root privileges!
91 7281b8dd 2004-05-07 alex ;ChrootDir = /var/empty
93 112102b1 2005-02-04 alex # This tells ngircd to write its current process id to a file.
94 18697663 2005-03-15 alex # Note that the pidfile is written AFTER chroot and switching uid,
95 18697663 2005-03-15 alex # i. e. the Directory the pidfile resides in must be writeable by
96 18697663 2005-03-15 alex # the ngircd user and exist in the chroot directory.
97 112102b1 2005-02-04 alex ;PidFile = /var/run/ngircd/ngircd.pid
99 10bb43c6 2003-03-10 alex # After <PingTimeout> seconds of inactivity the server will send a
100 10bb43c6 2003-03-10 alex # PING to the peer to test whether it is alive or not.
101 7efefd30 2002-03-29 alex ;PingTimeout = 120
103 10bb43c6 2003-03-10 alex # If a client fails to answer a PING with a PONG within <PongTimeout>
104 10bb43c6 2003-03-10 alex # seconds, it will be disconnected by the server.
105 7efefd30 2002-03-29 alex ;PongTimeout = 20
107 10bb43c6 2003-03-10 alex # The server tries every <ConnectRetry> seconds to establish a link
108 10bb43c6 2003-03-10 alex # to not yet (or no longer) connected servers.
109 7efefd30 2002-03-29 alex ;ConnectRetry = 60
111 10bb43c6 2003-03-10 alex # Should IRC Operators be allowed to use the MODE command even if
112 5b333085 2003-01-04 alex # they are not(!) channel-operators?
113 efeba4a7 2002-09-16 alex ;OperCanUseMode = no
115 18697663 2005-03-15 alex # Mask IRC Operator mode requests as if they were coming from the
116 18697663 2005-03-15 alex # server? (This is a compatibility hack for ircd-irc2 servers)
117 1d08d51e 2005-03-15 alex ;OperServerMode = no
119 058d3085 2006-11-05 fw # Allow Pre-Defined Channels only (see Section [Channels])
120 058d3085 2006-11-05 fw ;PredefChannelsOnly = no
122 35b6f399 2008-01-07 alex # Don't do any DNS lookups when a client connects to the server.
123 35b6f399 2008-01-07 alex ;NoDNS = no
125 bb6ee468 2008-04-29 alex # try to connect to other irc servers using ipv4 and ipv6, if possible
126 bb6ee468 2008-04-29 alex ;ConnectIPv6 = yes
127 bb6ee468 2008-04-29 alex ;ConnectIPv4 = yes
129 a84b9d99 2003-03-09 alex # Maximum number of simultaneous connection the server is allowed
130 b160f574 2007-10-13 fw # to accept (0: unlimited):
131 b160f574 2007-10-13 fw ;MaxConnections = 0
133 2981fe9e 2003-11-05 alex # Maximum number of simultaneous connections from a single IP address
134 b160f574 2007-10-13 fw # the server will accept (0: unlimited):
135 2981fe9e 2003-11-05 alex ;MaxConnectionsIP = 5
137 b160f574 2007-10-13 fw # Maximum number of channels a user can be member of (0: no limit):
138 e65ab4a3 2002-12-14 alex ;MaxJoins = 10
140 47ca178a 2007-11-21 alex # Maximum length of an user nick name (Default: 9, as in RFC 2812).
141 47ca178a 2007-11-21 alex # Please note that all servers in an IRC network MUST use the same
142 47ca178a 2007-11-21 alex # maximum nick name length!
143 47ca178a 2007-11-21 alex ;MaxNickLength = 9
146 10bb43c6 2003-03-10 alex # [Operator] sections are used to define IRC Operators. There may be
147 10bb43c6 2003-03-10 alex # more than one [Operator] block, one for each local operator.
149 10bb43c6 2003-03-10 alex # ID of the operator (may be different of the nick name)
150 a8aab6bf 2002-03-10 alex ;Name = TheOper
152 10bb43c6 2003-03-10 alex # Password of the IRC operator
153 a8aab6bf 2002-03-10 alex ;Password = ThePwd
155 490c9d04 2005-03-02 alex # Optional Mask from which /OPER will be accepted
156 490c9d04 2005-03-02 alex ;Mask = *!ident@somewhere.example.com
159 7b61b34c 2004-12-27 alex # More [Operator] sections, if you like ...
162 10bb43c6 2003-03-10 alex # Other servers are configured in [Server] sections. If you
163 10bb43c6 2003-03-10 alex # configure a port for the connection, then this ngircd tries to
164 10bb43c6 2003-03-10 alex # connect to to the other server on the given port; if not it waits
165 10bb43c6 2003-03-10 alex # for the other server to connect.
166 c7bd9da4 2006-04-09 alex # There may be more than one server block, one for each server.
168 10bb43c6 2003-03-10 alex # Server Groups:
169 10bb43c6 2003-03-10 alex # The ngIRCd allows "server groups": You can assign an "ID" to every
170 10bb43c6 2003-03-10 alex # server with which you want this ngIRCd to link. If a server of a
171 10bb43c6 2003-03-10 alex # group won't answer, the ngIRCd tries to connect to the next server
172 10bb43c6 2003-03-10 alex # in the given group. But the ngircd never tries to connect to two
173 10bb43c6 2003-03-10 alex # servers with the same group ID.
175 72157370 2006-01-09 alex # IRC name of the remote server, must match the "Name" variable in
176 72157370 2006-01-09 alex # the [Global] section of the other server (when using ngIRCd).
177 a8aab6bf 2002-03-10 alex ;Name = irc2.the.net
179 72157370 2006-01-09 alex # Internet host name or IP address of the peer (only required when
180 72157370 2006-01-09 alex # this server should establish the connection).
181 03d5fd6c 2002-12-18 alex ;Host = connect-to-host.the.net
183 82d32ffb 2007-11-23 fw # IP address to use as _source_ address for the connection. if unspecified,
184 82d32ffb 2007-11-23 fw # ngircd will let the operating system pick an address.
185 82d32ffb 2007-11-23 fw ;Bind = 10.0.0.1
187 10bb43c6 2003-03-10 alex # Port of the server to which the ngIRCd should connect. If you
188 10bb43c6 2003-03-10 alex # assign no port the ngIRCd waits for incoming connections.
189 72157370 2006-01-09 alex ;Port = 6667
191 5b333085 2003-01-04 alex # Own password for the connection. This password has to be configured
192 0dd0015d 2005-09-02 fw # as "PeerPassword" on the other server.
193 caa7049e 2002-11-19 alex ;MyPassword = MySecret
195 5b333085 2003-01-04 alex # Foreign password for this connection. This password has to be
196 5b333085 2003-01-04 alex # configured as "MyPassword" on the other server.
197 caa7049e 2002-11-19 alex ;PeerPassword = PeerSecret
199 10bb43c6 2003-03-10 alex # Group of this server (optional)
200 a8aab6bf 2002-03-10 alex ;Group = 123
202 9021ea20 2007-10-04 alex # Set the "Passive" option to "yes" if you don't want this ngIRCd to
203 9021ea20 2007-10-04 alex # connect to the configured peer (same as leaving the "Port" variable
204 9021ea20 2007-10-04 alex # empty). The advantage of this option is that you can actually configure
205 9021ea20 2007-10-04 alex # a port an use the IRC command CONNECT more easily to manually connect
206 9021ea20 2007-10-04 alex # this specific server later.
207 9021ea20 2007-10-04 alex ;Passive = no
209 ebf5edfd 2008-09-13 fw # Connect to the remote server using TLS/SSL (Default: false)
210 ebf5edfd 2008-09-13 fw ; SSLConnect = yes
213 7b61b34c 2004-12-27 alex # More [Server] sections, if you like ...
216 10bb43c6 2003-03-10 alex # Pre-defined channels can be configured in [Channel] sections.
217 10bb43c6 2003-03-10 alex # Such channels are created by the server when starting up and even
218 10bb43c6 2003-03-10 alex # persist when there are no more members left.
219 10bb43c6 2003-03-10 alex # Persistent channels are marked with the mode 'P', which can be set
220 10bb43c6 2003-03-10 alex # and unset by IRC operators like other modes on the fly.
221 c7bd9da4 2006-04-09 alex # There may be more than one [Channel] block, one for each channel.
223 5b333085 2003-01-04 alex # Name of the channel
224 c3aac8dd 2002-05-21 alex ;Name = #TheName
226 10bb43c6 2003-03-10 alex # Topic for this channel
227 5b333085 2003-01-04 alex ;Topic = a great topic
229 10bb43c6 2003-03-10 alex # Initial channel modes
232 1b852fce 2006-12-29 fw # initial channel password (mode k)
233 1b852fce 2006-12-29 fw ;Key = Secret
235 1b852fce 2006-12-29 fw # maximum users per channel (mode l)
236 1b852fce 2006-12-29 fw ;MaxUsers = 23
239 7b61b34c 2004-12-27 alex # More [Channel] sections, if you like ...
