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