e17b0e60690dd5b46a886985391acc7a083c3b9d
[ngircd-alex.git] / doc / sample-ngircd.conf
1 # $Id: sample-ngircd.conf,v 1.41 2007/10/13 20:45:11 fw Exp $
2
3 #
4 # This is a sample configuration file for the ngIRCd, which must be adepted
5 # to the local preferences and needs.
6 #
7 # Comments are started with "#" or ";".
8 #
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.
12 #
13 # Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
14 # server interprets the configuration file as expected!
15 #
16
17 [Global]
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.
21
22         # Server name in the IRC network, must contain at least one dot
23         # (".") and be unique in the IRC network. Required!
24         Name = irc.the.net
25
26         # Info text of the server. This will be shown by WHOIS and
27         # LINKS requests for example.
28         Info = Server Info Text
29
30         # Global password for all users needed to connect to the server
31         ;Password = abc
32
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
38  
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
42
43         # IP address on which the server should listen. (Default: empty,
44         # so the server listens on all IP addresses of the system)
45         ;Listen = 1.2.3.4
46
47         # Text file with the "message of the day" (MOTD). This message will
48         # be shown to all users connecting to the server:
49         ;MotdFile = /usr/local/etc/ngircd.motd
50
51         # A simple Phrase (<256 chars) if you don't want to use a motd file.
52         # If it is set no MotdFile will be read at all.
53         ;MotdPhrase = "Hello world!"
54
55         # User ID under which the server should run; you can use the name
56         # of the user or the numerical ID. ATTENTION: For this to work the
57         # server must have been started with root privileges! In addition,
58         # the configuration and MOTD files must be readable by this user,
59         # otherwise RESTART and REHASH won't work!
60         ;ServerUID = 65534
61
62         # Group ID under which the ngircd should run; you can use the name
63         # of the group or the numerical ID. ATTENTION: For this to work the
64         # server must have been started with root privileges!
65         ;ServerGID = 65534
66
67         # A directory to chroot in when everything is initialized. It
68         # doesn't need to be populated if ngIRCd is compiled as a static
69         # binary. By default ngIRCd won't use the chroot() feature.
70         # ATTENTION: For this to work the server must have been started
71         # with root privileges!
72         ;ChrootDir = /var/empty
73
74         # This tells ngircd to write its current process id to a file.
75         # Note that the pidfile is written AFTER chroot and switching uid,
76         # i. e. the Directory the pidfile resides in must be writeable by
77         # the ngircd user and exist in the chroot directory.
78         ;PidFile = /var/run/ngircd/ngircd.pid
79
80         # After <PingTimeout> seconds of inactivity the server will send a
81         # PING to the peer to test whether it is alive or not.
82         ;PingTimeout = 120
83
84         # If a client fails to answer a PING with a PONG within <PongTimeout>
85         # seconds, it will be disconnected by the server.
86         ;PongTimeout = 20
87
88         # The server tries every <ConnectRetry> seconds to establish a link
89         # to not yet (or no longer) connected servers.
90         ;ConnectRetry = 60
91
92         # Should IRC Operators be allowed to use the MODE command even if
93         # they are not(!) channel-operators?
94         ;OperCanUseMode = no
95
96         # Mask IRC Operator mode requests as if they were coming from the
97         # server? (This is a compatibility hack for ircd-irc2 servers)
98         ;OperServerMode = no
99
100         # Allow Pre-Defined Channels only (see Section [Channels])
101         ;PredefChannelsOnly = no
102
103         # Maximum number of simultaneous connection the server is allowed
104         # to accept (0: unlimited):
105         ;MaxConnections = 0
106
107         # Maximum number of simultaneous connections from a single IP address
108         # the server will accept (0: unlimited):
109         ;MaxConnectionsIP = 5
110
111         # Maximum number of channels a user can be member of (0: no limit):
112         ;MaxJoins = 10
113
114 [Operator]
115         # [Operator] sections are used to define IRC Operators. There may be
116         # more than one [Operator] block, one for each local operator.
117
118         # ID of the operator (may be different of the nick name)
119         ;Name = TheOper
120
121         # Password of the IRC operator
122         ;Password = ThePwd
123
124         # Optional Mask from which /OPER will be accepted
125         ;Mask = *!ident@somewhere.example.com
126
127 [Operator]
128         # More [Operator] sections, if you like ...
129
130 [Server]
131         # Other servers are configured in [Server] sections. If you
132         # configure a port for the connection, then this ngircd tries to
133         # connect to to the other server on the given port; if not it waits
134         # for the other server to connect.
135         # There may be more than one server block, one for each server.
136         #
137         # Server Groups:
138         # The ngIRCd allows "server groups": You can assign an "ID" to every
139         # server with which you want this ngIRCd to link. If a server of a
140         # group won't answer, the ngIRCd tries to connect to the next server
141         # in the given group. But the ngircd never tries to connect to two
142         # servers with the same group ID.
143
144         # IRC name of the remote server, must match the "Name" variable in
145         # the [Global] section of the other server (when using ngIRCd).
146         ;Name = irc2.the.net
147   
148         # Internet host name or IP address of the peer (only required when
149         # this server should establish the connection).
150         ;Host = connect-to-host.the.net
151
152         # Port of the server to which the ngIRCd should connect. If you
153         # assign no port the ngIRCd waits for incoming connections.
154         ;Port = 6667
155
156         # Own password for the connection. This password has to be configured
157         # as "PeerPassword" on the other server.
158         ;MyPassword = MySecret
159
160         # Foreign password for this connection. This password has to be
161         # configured as "MyPassword" on the other server.
162         ;PeerPassword = PeerSecret
163
164         # Group of this server (optional)
165         ;Group = 123
166
167         # Set the "Passive" option to "yes" if you don't want this ngIRCd to
168         # connect to the configured peer (same as leaving the "Port" variable
169         # empty). The advantage of this option is that you can actually configure
170         # a port an use the IRC command CONNECT more easily to manually connect
171         # this specific server later.
172         ;Passive = no
173
174 [Server]
175         # More [Server] sections, if you like ...
176
177 [Channel]
178         # Pre-defined channels can be configured in [Channel] sections.
179         # Such channels are created by the server when starting up and even
180         # persist when there are no more members left.
181         # Persistent channels are marked with the mode 'P', which can be set
182         # and unset by IRC operators like other modes on the fly.
183         # There may be more than one [Channel] block, one for each channel.
184
185         # Name of the channel
186         ;Name = #TheName
187
188         # Topic for this channel
189         ;Topic = a great topic
190
191         # Initial channel modes
192         ;Modes = tnk
193
194         # initial channel password (mode k)
195         ;Key = Secret
196
197         # maximum users per channel (mode l)
198         ;MaxUsers = 23
199
200 [Channel]
201         # More [Channel] sections, if you like ...
202
203 # -eof-