1 927e626f 2003-04-27 alex # $Id: sample-ngircd.conf,v 1.21 2003/04/27 11:45:27 alex Exp $
4 10bb43c6 2003-03-10 alex # This is a sample configuration file for the ngIRCd, which must adept to
5 10bb43c6 2003-03-10 alex # the local preferences and needs.
7 5b333085 2003-01-04 alex # Comments are started with "#" or ";".
9 5b333085 2003-01-04 alex # Author: Alexander Barton, <alex@barton.de>
10 5b333085 2003-01-04 alex # Initial translation by Ilja Osthoff, <ilja@glide.ath.cx>
15 10bb43c6 2003-03-10 alex # The [Global] section of this file is used to define the main
16 10bb43c6 2003-03-10 alex # configuration of the server, like the server name and the ports
17 10bb43c6 2003-03-10 alex # on which the server should be listening.
19 5b333085 2003-01-04 alex # Server name in the IRC-network
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 10bb43c6 2003-03-10 alex # ADMIN command.
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 5b333085 2003-01-04 alex # one port, separated with ";". (Default: 6667)
37 5b333085 2003-01-04 alex ;Ports = 6667, 6668, 66694
39 10bb43c6 2003-03-10 alex # Text file with the "message of the day" (MOTD). This message will
40 10bb43c6 2003-03-10 alex # be shown to all users connecting to the server:
41 7efefd30 2002-03-29 alex ;MotdFile = /usr/local/etc/ngircd.motd
43 10bb43c6 2003-03-10 alex # User ID under which the server should run; you can use the name
44 10bb43c6 2003-03-10 alex # of the user or the numerical ID. ATTENTION: For this to work the
45 10bb43c6 2003-03-10 alex # server must have been started with root privileges! In addition,
46 10bb43c6 2003-03-10 alex # the configuration and MOTD files must be readable by this user,
47 10bb43c6 2003-03-10 alex # otherwise RESTART and REHASH won't work!
48 5b333085 2003-01-04 alex ;ServerUID = 65534
50 10bb43c6 2003-03-10 alex # Group ID under which the ngircd should run; you can use the name
51 10bb43c6 2003-03-10 alex # of the group or the numerical ID. ATTENTION: For this to work the
52 10bb43c6 2003-03-10 alex # server must have been started with root privileges!
53 5b333085 2003-01-04 alex ;ServerGID = 65534
55 10bb43c6 2003-03-10 alex # After <PingTimeout> seconds of inactivity the server will send a
56 10bb43c6 2003-03-10 alex # PING to the peer to test whether it is alive or not.
57 7efefd30 2002-03-29 alex ;PingTimeout = 120
59 10bb43c6 2003-03-10 alex # If a client fails to answer a PING with a PONG within <PongTimeout>
60 10bb43c6 2003-03-10 alex # seconds, it will be disconnected by the server.
61 7efefd30 2002-03-29 alex ;PongTimeout = 20
63 10bb43c6 2003-03-10 alex # The server tries every <ConnectRetry> seconds to establish a link
64 10bb43c6 2003-03-10 alex # to not yet (or no longer) connected servers.
65 7efefd30 2002-03-29 alex ;ConnectRetry = 60
67 10bb43c6 2003-03-10 alex # Should IRC Operators be allowed to use the MODE command even if
68 5b333085 2003-01-04 alex # they are not(!) channel-operators?
69 efeba4a7 2002-09-16 alex ;OperCanUseMode = no
71 a84b9d99 2003-03-09 alex # Maximum number of simultaneous connection the server is allowed
72 5b333085 2003-01-04 alex # to accept (<=0: unlimited):
73 aabe013d 2002-11-02 alex ;MaxConnections = -1
75 5b333085 2003-01-04 alex # Maximum number of channels a user can be member of (<=0: no limit):
76 e65ab4a3 2002-12-14 alex ;MaxJoins = 10
79 10bb43c6 2003-03-10 alex # [Operator] sections are used to define IRC Operators. There may be
80 10bb43c6 2003-03-10 alex # more than one [Operator] block, one for each local operator.
82 10bb43c6 2003-03-10 alex # ID of the operator (may be different of the nick name)
83 a8aab6bf 2002-03-10 alex ;Name = TheOper
85 10bb43c6 2003-03-10 alex # Password of the IRC operator
86 a8aab6bf 2002-03-10 alex ;Password = ThePwd
89 10bb43c6 2003-03-10 alex # Other servers are configured in [Server] sections. If you
90 10bb43c6 2003-03-10 alex # configure a port for the connection, then this ngircd tries to
91 10bb43c6 2003-03-10 alex # connect to to the other server on the given port; if not it waits
92 10bb43c6 2003-03-10 alex # for the other server to connect.
93 10bb43c6 2003-03-10 alex # There may be more than one server block.
95 10bb43c6 2003-03-10 alex # Server Groups:
96 10bb43c6 2003-03-10 alex # The ngIRCd allows "server groups": You can assign an "ID" to every
97 10bb43c6 2003-03-10 alex # server with which you want this ngIRCd to link. If a server of a
98 10bb43c6 2003-03-10 alex # group won't answer, the ngIRCd tries to connect to the next server
99 10bb43c6 2003-03-10 alex # in the given group. But the ngircd never tries to connect to two
100 10bb43c6 2003-03-10 alex # servers with the same group ID.
102 10bb43c6 2003-03-10 alex # IRC name of the server
103 a8aab6bf 2002-03-10 alex ;Name = irc2.the.net
105 10bb43c6 2003-03-10 alex # Internet host name of the peer
106 03d5fd6c 2002-12-18 alex ;Host = connect-to-host.the.net
108 10bb43c6 2003-03-10 alex # Port of the server to which the ngIRCd should connect. If you
109 10bb43c6 2003-03-10 alex # assign no port the ngIRCd waits for incoming connections.
110 a8aab6bf 2002-03-10 alex ;Port = 6666
112 5b333085 2003-01-04 alex # Own password for the connection. This password has to be configured
113 5b333085 2003-01-04 alex # as "PeerPassword" on the other server.
114 caa7049e 2002-11-19 alex ;MyPassword = MySecret
116 5b333085 2003-01-04 alex # Foreign password for this connection. This password has to be
117 5b333085 2003-01-04 alex # configured as "MyPassword" on the other server.
118 caa7049e 2002-11-19 alex ;PeerPassword = PeerSecret
120 10bb43c6 2003-03-10 alex # Group of this server (optional)
121 a8aab6bf 2002-03-10 alex ;Group = 123
124 10bb43c6 2003-03-10 alex # Pre-defined channels can be configured in [Channel] sections.
125 10bb43c6 2003-03-10 alex # Such channels are created by the server when starting up and even
126 10bb43c6 2003-03-10 alex # persist when there are no more members left.
127 10bb43c6 2003-03-10 alex # Persistent channels are marked with the mode 'P', which can be set
128 10bb43c6 2003-03-10 alex # and unset by IRC operators like other modes on the fly.
129 10bb43c6 2003-03-10 alex # There may be more than one [Channel] block.
131 5b333085 2003-01-04 alex # Name of the channel
132 c3aac8dd 2002-05-21 alex ;Name = #TheName
134 10bb43c6 2003-03-10 alex # Topic for this channel
135 5b333085 2003-01-04 alex ;Topic = a great topic
137 10bb43c6 2003-03-10 alex # Initial channel modes
138 c3aac8dd 2002-05-21 alex ;Modes = tn
