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!
18 10bb43c6 2003-03-10 alex # The [Global] section of this file is used to define the main
19 10bb43c6 2003-03-10 alex # configuration of the server, like the server name and the ports
20 10bb43c6 2003-03-10 alex # on which the server should be listening.
22 e541da2a 2003-04-29 alex # Server name in the IRC network, must contain at least one dot
23 05170bc9 2003-12-19 alex # (".") and be unique in the IRC network. Required!
24 969e5f1c 2002-01-06 alex Name = irc.the.net
26 10bb43c6 2003-03-10 alex # Info text of the server. This will be shown by WHOIS and
27 10bb43c6 2003-03-10 alex # LINKS requests for example.
28 969e5f1c 2002-01-06 alex Info = Server Info Text
30 927e626f 2003-04-27 alex # Global password for all users needed to connect to the server
31 927e626f 2003-04-27 alex ;Password = abc
33 10bb43c6 2003-03-10 alex # Information about the server and the administrator, used by the
34 05170bc9 2003-12-19 alex # ADMIN command. Not required by server but by RFC!
35 5b333085 2003-01-04 alex ;AdminInfo1 = Description
36 5b333085 2003-01-04 alex ;AdminInfo2 = Location
37 efeba4a7 2002-09-16 alex ;AdminEMail = admin@irc.server
39 10bb43c6 2003-03-10 alex # Ports on which the server should listen. There may be more than
40 6dacec7d 2005-01-17 alex # one port, separated with ",". (Default: 6667)
41 386d3b9e 2004-12-27 alex ;Ports = 6667, 6668, 6669
43 e33ab903 2003-09-11 alex # IP address on which the server should listen. (Default: empty,
44 e33ab903 2003-09-11 alex # so the server listens on all IP addresses of the system)
45 e33ab903 2003-09-11 alex ;Listen = 1.2.3.4
47 10bb43c6 2003-03-10 alex # Text file with the "message of the day" (MOTD). This message will
48 10bb43c6 2003-03-10 alex # be shown to all users connecting to the server:
49 7efefd30 2002-03-29 alex ;MotdFile = /usr/local/etc/ngircd.motd
51 7281b8dd 2004-05-07 alex # A simple Phrase (<256 chars) if you don't want to use a motd file.
52 7281b8dd 2004-05-07 alex # If it is set no MotdFile will be read at all.
53 7281b8dd 2004-05-07 alex ;MotdPhrase = "Hello world!"
55 10bb43c6 2003-03-10 alex # User ID under which the server should run; you can use the name
56 10bb43c6 2003-03-10 alex # of the user or the numerical ID. ATTENTION: For this to work the
57 10bb43c6 2003-03-10 alex # server must have been started with root privileges! In addition,
58 10bb43c6 2003-03-10 alex # the configuration and MOTD files must be readable by this user,
59 10bb43c6 2003-03-10 alex # otherwise RESTART and REHASH won't work!
60 5b333085 2003-01-04 alex ;ServerUID = 65534
62 10bb43c6 2003-03-10 alex # Group ID under which the ngircd should run; you can use the name
63 10bb43c6 2003-03-10 alex # of the group or the numerical ID. ATTENTION: For this to work the
64 10bb43c6 2003-03-10 alex # server must have been started with root privileges!
65 5b333085 2003-01-04 alex ;ServerGID = 65534
67 7281b8dd 2004-05-07 alex # A directory to chroot in when everything is initialized. It
68 7281b8dd 2004-05-07 alex # doesn't need to be populated if ngIRCd is compiled as a static
69 7281b8dd 2004-05-07 alex # binary. By default ngIRCd won't use the chroot() feature.
70 7281b8dd 2004-05-07 alex # ATTENTION: For this to work the server must have been started
71 7281b8dd 2004-05-07 alex # with root privileges!
72 7281b8dd 2004-05-07 alex ;ChrootDir = /var/empty
74 112102b1 2005-02-04 alex # This tells ngircd to write its current process id to a file.
75 18697663 2005-03-15 alex # Note that the pidfile is written AFTER chroot and switching uid,
76 18697663 2005-03-15 alex # i. e. the Directory the pidfile resides in must be writeable by
77 18697663 2005-03-15 alex # the ngircd user and exist in the chroot directory.
78 112102b1 2005-02-04 alex ;PidFile = /var/run/ngircd/ngircd.pid
80 10bb43c6 2003-03-10 alex # After <PingTimeout> seconds of inactivity the server will send a
81 10bb43c6 2003-03-10 alex # PING to the peer to test whether it is alive or not.
82 7efefd30 2002-03-29 alex ;PingTimeout = 120
84 10bb43c6 2003-03-10 alex # If a client fails to answer a PING with a PONG within <PongTimeout>
85 10bb43c6 2003-03-10 alex # seconds, it will be disconnected by the server.
86 7efefd30 2002-03-29 alex ;PongTimeout = 20
88 10bb43c6 2003-03-10 alex # The server tries every <ConnectRetry> seconds to establish a link
89 10bb43c6 2003-03-10 alex # to not yet (or no longer) connected servers.
90 7efefd30 2002-03-29 alex ;ConnectRetry = 60
92 10bb43c6 2003-03-10 alex # Should IRC Operators be allowed to use the MODE command even if
93 5b333085 2003-01-04 alex # they are not(!) channel-operators?
94 efeba4a7 2002-09-16 alex ;OperCanUseMode = no
96 18697663 2005-03-15 alex # Mask IRC Operator mode requests as if they were coming from the
97 18697663 2005-03-15 alex # server? (This is a compatibility hack for ircd-irc2 servers)
98 1d08d51e 2005-03-15 alex ;OperServerMode = no
100 058d3085 2006-11-05 fw # Allow Pre-Defined Channels only (see Section [Channels])
101 058d3085 2006-11-05 fw ;PredefChannelsOnly = no
103 35b6f399 2008-01-07 alex # Don't do any DNS lookups when a client connects to the server.
104 35b6f399 2008-01-07 alex ;NoDNS = no
106 a84b9d99 2003-03-09 alex # Maximum number of simultaneous connection the server is allowed
107 b160f574 2007-10-13 fw # to accept (0: unlimited):
108 b160f574 2007-10-13 fw ;MaxConnections = 0
110 2981fe9e 2003-11-05 alex # Maximum number of simultaneous connections from a single IP address
111 b160f574 2007-10-13 fw # the server will accept (0: unlimited):
112 2981fe9e 2003-11-05 alex ;MaxConnectionsIP = 5
114 b160f574 2007-10-13 fw # Maximum number of channels a user can be member of (0: no limit):
115 e65ab4a3 2002-12-14 alex ;MaxJoins = 10
117 47ca178a 2007-11-21 alex # Maximum length of an user nick name (Default: 9, as in RFC 2812).
118 47ca178a 2007-11-21 alex # Please note that all servers in an IRC network MUST use the same
119 47ca178a 2007-11-21 alex # maximum nick name length!
120 47ca178a 2007-11-21 alex ;MaxNickLength = 9
123 10bb43c6 2003-03-10 alex # [Operator] sections are used to define IRC Operators. There may be
124 10bb43c6 2003-03-10 alex # more than one [Operator] block, one for each local operator.
126 10bb43c6 2003-03-10 alex # ID of the operator (may be different of the nick name)
127 a8aab6bf 2002-03-10 alex ;Name = TheOper
129 10bb43c6 2003-03-10 alex # Password of the IRC operator
130 a8aab6bf 2002-03-10 alex ;Password = ThePwd
132 490c9d04 2005-03-02 alex # Optional Mask from which /OPER will be accepted
133 490c9d04 2005-03-02 alex ;Mask = *!ident@somewhere.example.com
136 7b61b34c 2004-12-27 alex # More [Operator] sections, if you like ...
139 10bb43c6 2003-03-10 alex # Other servers are configured in [Server] sections. If you
140 10bb43c6 2003-03-10 alex # configure a port for the connection, then this ngircd tries to
141 10bb43c6 2003-03-10 alex # connect to to the other server on the given port; if not it waits
142 10bb43c6 2003-03-10 alex # for the other server to connect.
143 c7bd9da4 2006-04-09 alex # There may be more than one server block, one for each server.
145 10bb43c6 2003-03-10 alex # Server Groups:
146 10bb43c6 2003-03-10 alex # The ngIRCd allows "server groups": You can assign an "ID" to every
147 10bb43c6 2003-03-10 alex # server with which you want this ngIRCd to link. If a server of a
148 10bb43c6 2003-03-10 alex # group won't answer, the ngIRCd tries to connect to the next server
149 10bb43c6 2003-03-10 alex # in the given group. But the ngircd never tries to connect to two
150 10bb43c6 2003-03-10 alex # servers with the same group ID.
152 72157370 2006-01-09 alex # IRC name of the remote server, must match the "Name" variable in
153 72157370 2006-01-09 alex # the [Global] section of the other server (when using ngIRCd).
154 a8aab6bf 2002-03-10 alex ;Name = irc2.the.net
156 72157370 2006-01-09 alex # Internet host name or IP address of the peer (only required when
157 72157370 2006-01-09 alex # this server should establish the connection).
158 03d5fd6c 2002-12-18 alex ;Host = connect-to-host.the.net
160 82d32ffb 2007-11-23 fw # IP address to use as _source_ address for the connection. if unspecified,
161 82d32ffb 2007-11-23 fw # ngircd will let the operating system pick an address.
162 82d32ffb 2007-11-23 fw ;Bind = 10.0.0.1
164 10bb43c6 2003-03-10 alex # Port of the server to which the ngIRCd should connect. If you
165 10bb43c6 2003-03-10 alex # assign no port the ngIRCd waits for incoming connections.
166 72157370 2006-01-09 alex ;Port = 6667
168 5b333085 2003-01-04 alex # Own password for the connection. This password has to be configured
169 0dd0015d 2005-09-02 fw # as "PeerPassword" on the other server.
170 caa7049e 2002-11-19 alex ;MyPassword = MySecret
172 5b333085 2003-01-04 alex # Foreign password for this connection. This password has to be
173 5b333085 2003-01-04 alex # configured as "MyPassword" on the other server.
174 caa7049e 2002-11-19 alex ;PeerPassword = PeerSecret
176 10bb43c6 2003-03-10 alex # Group of this server (optional)
177 a8aab6bf 2002-03-10 alex ;Group = 123
179 9021ea20 2007-10-04 alex # Set the "Passive" option to "yes" if you don't want this ngIRCd to
180 9021ea20 2007-10-04 alex # connect to the configured peer (same as leaving the "Port" variable
181 9021ea20 2007-10-04 alex # empty). The advantage of this option is that you can actually configure
182 9021ea20 2007-10-04 alex # a port an use the IRC command CONNECT more easily to manually connect
183 9021ea20 2007-10-04 alex # this specific server later.
184 9021ea20 2007-10-04 alex ;Passive = no
187 7b61b34c 2004-12-27 alex # More [Server] sections, if you like ...
190 10bb43c6 2003-03-10 alex # Pre-defined channels can be configured in [Channel] sections.
191 10bb43c6 2003-03-10 alex # Such channels are created by the server when starting up and even
192 10bb43c6 2003-03-10 alex # persist when there are no more members left.
193 10bb43c6 2003-03-10 alex # Persistent channels are marked with the mode 'P', which can be set
194 10bb43c6 2003-03-10 alex # and unset by IRC operators like other modes on the fly.
195 c7bd9da4 2006-04-09 alex # There may be more than one [Channel] block, one for each channel.
197 5b333085 2003-01-04 alex # Name of the channel
198 c3aac8dd 2002-05-21 alex ;Name = #TheName
200 10bb43c6 2003-03-10 alex # Topic for this channel
201 5b333085 2003-01-04 alex ;Topic = a great topic
203 10bb43c6 2003-03-10 alex # Initial channel modes
206 1b852fce 2006-12-29 fw # initial channel password (mode k)
207 1b852fce 2006-12-29 fw ;Key = Secret
209 1b852fce 2006-12-29 fw # maximum users per channel (mode l)
210 1b852fce 2006-12-29 fw ;MaxUsers = 23
213 7b61b34c 2004-12-27 alex # More [Channel] sections, if you like ...
