New "chroot" feature (from Benjamin Pineau), introducing new configuration
[ngircd-alex.git] / doc / sample-ngircd.conf
1 # $Id: sample-ngircd.conf,v 1.26 2004/05/07 11:19:20 alex 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 # Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
10 # server interpreted the configuration file as expected!
11 #
12
13 [Global]
14
15         # The [Global] section of this file is used to define the main
16         # configuration of the server, like the server name and the ports
17         # on which the server should be listening.
18         
19         # Server name in the IRC network, must contain at least one dot
20         # (".") and be unique in the IRC network. Required!
21         Name = irc.the.net
22         
23         # Info text of the server. This will be shown by WHOIS and
24         # LINKS requests for example.
25         Info = Server Info Text
26
27         # Global password for all users needed to connect to the server
28         ;Password = abc
29         
30         # Information about the server and the administrator, used by the
31         # ADMIN command. Not required by server but by RFC!
32         ;AdminInfo1 = Description
33         ;AdminInfo2 = Location
34         ;AdminEMail = admin@irc.server
35  
36         # Ports on which the server should listen. There may be more than
37         # one port, separated with ";". (Default: 6667)
38         ;Ports = 6667, 6668, 66694
39
40         # IP address on which the server should listen. (Default: empty,
41         # so the server listens on all IP addresses of the system)
42         ;Listen = 1.2.3.4
43         
44         # Text file with the "message of the day" (MOTD). This message will
45         # be shown to all users connecting to the server:
46         ;MotdFile = /usr/local/etc/ngircd.motd
47
48         # A simple Phrase (<256 chars) if you don't want to use a motd file.
49         # If it is set no MotdFile will be read at all.
50         ;MotdPhrase = "Hello world!"
51
52         # User ID under which the server should run; you can use the name
53         # of the user or the numerical ID. ATTENTION: For this to work the
54         # server must have been started with root privileges! In addition,
55         # the configuration and MOTD files must be readable by this user,
56         # otherwise RESTART and REHASH won't work!
57         ;ServerUID = 65534
58
59         # Group ID under which the ngircd should run; you can use the name
60         # of the group or the numerical ID. ATTENTION: For this to work the
61         # server must have been started with root privileges!
62         ;ServerGID = 65534
63
64         # A directory to chroot in when everything is initialized. It
65         # doesn't need to be populated if ngIRCd is compiled as a static
66         # binary. By default ngIRCd won't use the chroot() feature.
67         # ATTENTION: For this to work the server must have been started
68         # with root privileges!
69         ;ChrootDir = /var/empty
70
71         # After <PingTimeout> seconds of inactivity the server will send a
72         # PING to the peer to test whether it is alive or not.
73         ;PingTimeout = 120
74
75         # If a client fails to answer a PING with a PONG within <PongTimeout>
76         # seconds, it will be disconnected by the server.
77         ;PongTimeout = 20
78
79         # The server tries every <ConnectRetry> seconds to establish a link
80         # to not yet (or no longer) connected servers.
81         ;ConnectRetry = 60
82
83         # Should IRC Operators be allowed to use the MODE command even if
84         # they are not(!) channel-operators?
85         ;OperCanUseMode = no
86
87         # Maximum number of simultaneous connection the server is allowed
88         # to accept (<=0: unlimited):
89         ;MaxConnections = -1
90         
91         # Maximum number of simultaneous connections from a single IP address
92         # the server will accept (<=0: unlimited):
93         ;MaxConnectionsIP = 5
94
95         # Maximum number of channels a user can be member of (<=0: no limit):
96         ;MaxJoins = 10
97
98 [Operator]
99         # [Operator] sections are used to define IRC Operators. There may be
100         # more than one [Operator] block, one for each local operator.
101         
102         # ID of the operator (may be different of the nick name)
103         ;Name = TheOper
104
105         # Password of the IRC operator
106         ;Password = ThePwd
107
108 [Server]
109         # Other servers are configured in [Server] sections. If you
110         # configure a port for the connection, then this ngircd tries to
111         # connect to to the other server on the given port; if not it waits
112         # for the other server to connect.
113         # There may be more than one server block.
114         #
115         # Server Groups:
116         # The ngIRCd allows "server groups": You can assign an "ID" to every
117         # server with which you want this ngIRCd to link. If a server of a
118         # group won't answer, the ngIRCd tries to connect to the next server
119         # in the given group. But the ngircd never tries to connect to two
120         # servers with the same group ID.
121         
122         # IRC name of the server
123         ;Name = irc2.the.net
124    
125         # Internet host name of the peer
126         ;Host = connect-to-host.the.net
127
128         # Port of the server to which the ngIRCd should connect. If you
129         # assign no port the ngIRCd waits for incoming connections.
130         ;Port = 6666
131
132         # Own password for the connection. This password has to be configured
133         # as "PeerPassword" on the other server.
134         ;MyPassword = MySecret
135
136         # Foreign password for this connection. This password has to be
137         # configured as "MyPassword" on the other server.
138         ;PeerPassword = PeerSecret
139         
140         # Group of this server (optional)
141         ;Group = 123
142
143 [Channel]
144         # Pre-defined channels can be configured in [Channel] sections.
145         # Such channels are created by the server when starting up and even
146         # persist when there are no more members left.
147         # Persistent channels are marked with the mode 'P', which can be set
148         # and unset by IRC operators like other modes on the fly.
149         # There may be more than one [Channel] block.
150         
151         # Name of the channel
152         ;Name = #TheName
153
154         # Topic for this channel
155         ;Topic = a great topic
156         
157         # Initial channel modes
158         ;Modes = tn
159
160 # -eof-