1 # $Id: sample-ngircd.conf,v 1.44 2008/01/07 23:02:29 alex 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 # 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.
13 # Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
14 # server interprets the configuration file as expected!
18 # The [Global] section of this file is used to define the main
19 # configuration of the server, like the server name and the ports
20 # on which the server should be listening.
22 # Server name in the IRC network, must contain at least one dot
23 # (".") and be unique in the IRC network. Required!
26 # Info text of the server. This will be shown by WHOIS and
27 # LINKS requests for example.
28 Info = Server Info Text
30 # Global password for all users needed to connect to the server
33 # Information about the server and the administrator, used by the
34 # ADMIN command. Not required by server but by RFC!
35 ;AdminInfo1 = Description
36 ;AdminInfo2 = Location
37 ;AdminEMail = admin@irc.server
39 # Ports on which the server should listen. There may be more than
40 # one port, separated with ",". (Default: 6667)
41 ;Ports = 6667, 6668, 6669
43 # comma seperated list of IP addresses on which the server should
44 # listen. Default values are:
45 # "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0"
46 # so the server listens on all IP addresses of the system by default.
47 ;Listen = 127.0.0.1,192.168.0.1
49 # Text file with the "message of the day" (MOTD). This message will
50 # be shown to all users connecting to the server:
51 ;MotdFile = /usr/local/etc/ngircd.motd
53 # A simple Phrase (<256 chars) if you don't want to use a motd file.
54 # If it is set no MotdFile will be read at all.
55 ;MotdPhrase = "Hello world!"
57 # User ID under which the server should run; you can use the name
58 # of the user or the numerical ID. ATTENTION: For this to work the
59 # server must have been started with root privileges! In addition,
60 # the configuration and MOTD files must be readable by this user,
61 # otherwise RESTART and REHASH won't work!
64 # Group ID under which the ngircd should run; you can use the name
65 # of the group or the numerical ID. ATTENTION: For this to work the
66 # server must have been started with root privileges!
69 # A directory to chroot in when everything is initialized. It
70 # doesn't need to be populated if ngIRCd is compiled as a static
71 # binary. By default ngIRCd won't use the chroot() feature.
72 # ATTENTION: For this to work the server must have been started
73 # with root privileges!
74 ;ChrootDir = /var/empty
76 # This tells ngircd to write its current process id to a file.
77 # Note that the pidfile is written AFTER chroot and switching uid,
78 # i. e. the Directory the pidfile resides in must be writeable by
79 # the ngircd user and exist in the chroot directory.
80 ;PidFile = /var/run/ngircd/ngircd.pid
82 # After <PingTimeout> seconds of inactivity the server will send a
83 # PING to the peer to test whether it is alive or not.
86 # If a client fails to answer a PING with a PONG within <PongTimeout>
87 # seconds, it will be disconnected by the server.
90 # The server tries every <ConnectRetry> seconds to establish a link
91 # to not yet (or no longer) connected servers.
94 # Should IRC Operators be allowed to use the MODE command even if
95 # they are not(!) channel-operators?
98 # Mask IRC Operator mode requests as if they were coming from the
99 # server? (This is a compatibility hack for ircd-irc2 servers)
102 # Allow Pre-Defined Channels only (see Section [Channels])
103 ;PredefChannelsOnly = no
105 # Don't do any DNS lookups when a client connects to the server.
108 # try to connect to other irc servers using ipv4 and ipv6, if possible
112 # Maximum number of simultaneous connection the server is allowed
113 # to accept (0: unlimited):
116 # Maximum number of simultaneous connections from a single IP address
117 # the server will accept (0: unlimited):
118 ;MaxConnectionsIP = 5
120 # Maximum number of channels a user can be member of (0: no limit):
123 # Maximum length of an user nick name (Default: 9, as in RFC 2812).
124 # Please note that all servers in an IRC network MUST use the same
125 # maximum nick name length!
129 # [Operator] sections are used to define IRC Operators. There may be
130 # more than one [Operator] block, one for each local operator.
132 # ID of the operator (may be different of the nick name)
135 # Password of the IRC operator
138 # Optional Mask from which /OPER will be accepted
139 ;Mask = *!ident@somewhere.example.com
142 # More [Operator] sections, if you like ...
145 # Other servers are configured in [Server] sections. If you
146 # configure a port for the connection, then this ngircd tries to
147 # connect to to the other server on the given port; if not it waits
148 # for the other server to connect.
149 # There may be more than one server block, one for each server.
152 # The ngIRCd allows "server groups": You can assign an "ID" to every
153 # server with which you want this ngIRCd to link. If a server of a
154 # group won't answer, the ngIRCd tries to connect to the next server
155 # in the given group. But the ngircd never tries to connect to two
156 # servers with the same group ID.
158 # IRC name of the remote server, must match the "Name" variable in
159 # the [Global] section of the other server (when using ngIRCd).
162 # Internet host name or IP address of the peer (only required when
163 # this server should establish the connection).
164 ;Host = connect-to-host.the.net
166 # IP address to use as _source_ address for the connection. if unspecified,
167 # ngircd will let the operating system pick an address.
170 # Port of the server to which the ngIRCd should connect. If you
171 # assign no port the ngIRCd waits for incoming connections.
174 # Own password for the connection. This password has to be configured
175 # as "PeerPassword" on the other server.
176 ;MyPassword = MySecret
178 # Foreign password for this connection. This password has to be
179 # configured as "MyPassword" on the other server.
180 ;PeerPassword = PeerSecret
182 # Group of this server (optional)
185 # Set the "Passive" option to "yes" if you don't want this ngIRCd to
186 # connect to the configured peer (same as leaving the "Port" variable
187 # empty). The advantage of this option is that you can actually configure
188 # a port an use the IRC command CONNECT more easily to manually connect
189 # this specific server later.
193 # More [Server] sections, if you like ...
196 # Pre-defined channels can be configured in [Channel] sections.
197 # Such channels are created by the server when starting up and even
198 # persist when there are no more members left.
199 # Persistent channels are marked with the mode 'P', which can be set
200 # and unset by IRC operators like other modes on the fly.
201 # There may be more than one [Channel] block, one for each channel.
203 # Name of the channel
206 # Topic for this channel
207 ;Topic = a great topic
209 # Initial channel modes
212 # initial channel password (mode k)
215 # maximum users per channel (mode l)
219 # More [Channel] sections, if you like ...
