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