1 5b333085 2003-01-04 alex # $Id: sample-ngircd.conf,v 1.18 2003/01/04 13:07:54 alex Exp $
4 5b333085 2003-01-04 alex # This is a sample configuration for the ngIRCd, which must adept to the
5 5b333085 2003-01-04 alex # 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 5b333085 2003-01-04 alex # In the [global] section of this file, there is the place of the
16 5b333085 2003-01-04 alex # main server configuration. Needed is only the variable "Name",
17 5b333085 2003-01-04 alex # Info you can adjust, if you like to. For all the others variables,
18 5b333085 2003-01-04 alex # you can use the defaults, this means you can leave it by default.
20 5b333085 2003-01-04 alex # Server name in the IRC-network
21 969e5f1c 2002-01-06 alex Name = irc.the.net
23 5b333085 2003-01-04 alex # Info-text of the server. This will be shown i.e. by a WHOIS- or
24 5b333085 2003-01-04 alex # LINKS-request.
25 969e5f1c 2002-01-06 alex Info = Server Info Text
27 5b333085 2003-01-04 alex # Information about the server and administrator in the ADMIN-request
28 5b333085 2003-01-04 alex ;AdminInfo1 = Description
29 5b333085 2003-01-04 alex ;AdminInfo2 = Location
30 efeba4a7 2002-09-16 alex ;AdminEMail = admin@irc.server
32 5b333085 2003-01-04 alex # Ports, on which the server will listen. There may be more than
33 5b333085 2003-01-04 alex # one port, separated with ";". (Default: 6667)
34 5b333085 2003-01-04 alex ;Ports = 6667, 6668, 66694
36 5b333085 2003-01-04 alex # Textfile with the "message of the day" (MOTD). This will be shown
37 5b333085 2003-01-04 alex # on a user connection with the server.
38 7efefd30 2002-03-29 alex ;MotdFile = /usr/local/etc/ngircd.motd
40 5b333085 2003-01-04 alex # User-ID, under which the server is started (for that the server
41 5b333085 2003-01-04 alex # must be started with root-rights). You can use the name of the
42 5b333085 2003-01-04 alex # user or the numerical ID.
43 5b333085 2003-01-04 alex # ATTENTION: the configuration and the MOTD file must be readable
44 5b333085 2003-01-04 alex # by this user, otherwise RESTART won't work!
45 5b333085 2003-01-04 alex ;ServerUID = 65534
47 5b333085 2003-01-04 alex # Group-ID, under which the server is running (for that the server
48 5b333085 2003-01-04 alex # must be started with root-rights). You can use the name of the
49 5b333085 2003-01-04 alex # group or the numerical ID.
50 5b333085 2003-01-04 alex ;ServerGID = 65534
52 5b333085 2003-01-04 alex # After <PingTimeout> seconds, the server will send a ping after
53 5b333085 2003-01-04 alex # inactivity of this client.
54 7efefd30 2002-03-29 alex ;PingTimeout = 120
56 5b333085 2003-01-04 alex # If there is an answer of a client, to which the ping was sended,
57 5b333085 2003-01-04 alex # not after <PongTimeout> seconds, it will be disconnected.
58 7efefd30 2002-03-29 alex ;PongTimeout = 20
60 5b333085 2003-01-04 alex # The server tries every <ConnectRetry> seconds, not yet connected
61 5b333085 2003-01-04 alex # or not anymore connected servers to connect.
62 7efefd30 2002-03-29 alex ;ConnectRetry = 60
64 5b333085 2003-01-04 alex # Should IRC-operators be allowed to use the MODE command even if
65 5b333085 2003-01-04 alex # they are not(!) channel-operators?
66 efeba4a7 2002-09-16 alex ;OperCanUseMode = no
68 5b333085 2003-01-04 alex # Maximum number of simultanous connection the server is allowed
69 5b333085 2003-01-04 alex # to accept (<=0: unlimited):
70 aabe013d 2002-11-02 alex ;MaxConnections = -1
72 5b333085 2003-01-04 alex # Maximum number of channels a user can be member of (<=0: no limit):
73 e65ab4a3 2002-12-14 alex ;MaxJoins = 10
76 5b333085 2003-01-04 alex # In this [operator]-section, there will be the configuration of
77 5b333085 2003-01-04 alex # the name and password of an IRC operator. There may be more than
78 5b333085 2003-01-04 alex # one operator-block (for each operator one).
80 5b333085 2003-01-04 alex # ID of the operator (may be different of the nick)
81 a8aab6bf 2002-03-10 alex ;Name = TheOper
83 5b333085 2003-01-04 alex # Password of the operator
84 a8aab6bf 2002-03-10 alex ;Password = ThePwd
87 5b333085 2003-01-04 alex # In this [Server] section, there is the configuration of the
88 5b333085 2003-01-04 alex # servers, which are allowed to connect to your own server.
89 5b333085 2003-01-04 alex # There may be more than one server-block.
90 5b333085 2003-01-04 alex # If you configured a port for the connection, then the ngIRCd
91 5b333085 2003-01-04 alex # tries to connect to this port. If not, it waits for the other
94 5b333085 2003-01-04 alex # Server-groups:
95 5b333085 2003-01-04 alex # The ngIRCd allows "server-groups": that means, that you can assign
96 5b333085 2003-01-04 alex # server-groups for every server, to which you want the ngIRCd to
97 5b333085 2003-01-04 alex # connect to. If one server of a server-group won't answer, the
98 5b333085 2003-01-04 alex # ngIRCd tries the next one of this group.
99 5b333085 2003-01-04 alex # ATTENTION: Server-groups will only work if you defined a port!
101 5b333085 2003-01-04 alex # IRC-name of the server
102 a8aab6bf 2002-03-10 alex ;Name = irc2.the.net
104 5b333085 2003-01-04 alex # Hostname of the server
105 03d5fd6c 2002-12-18 alex ;Host = connect-to-host.the.net
107 5b333085 2003-01-04 alex # Port of the server, to which the ngIRCd should connect. If you
108 5b333085 2003-01-04 alex # assign no port, the ngIRCd waits for an answer of that server.
109 a8aab6bf 2002-03-10 alex ;Port = 6666
111 5b333085 2003-01-04 alex # Own password for the connection. This password has to be configured
112 5b333085 2003-01-04 alex # as "PeerPassword" on the other server.
113 caa7049e 2002-11-19 alex ;MyPassword = MySecret
115 5b333085 2003-01-04 alex # Foreign password for this connection. This password has to be
116 5b333085 2003-01-04 alex # configured as "MyPassword" on the other server.
117 caa7049e 2002-11-19 alex ;PeerPassword = PeerSecret
119 5b333085 2003-01-04 alex # Group of that server (optional)
120 a8aab6bf 2002-03-10 alex ;Group = 123
123 5b333085 2003-01-04 alex # In the [Channel] there can be defined "persistent channels". This
124 5b333085 2003-01-04 alex # means, that the server creates the channel and even if all users
125 5b333085 2003-01-04 alex # left this channel, it will persist. There may be more than one
126 5b333085 2003-01-04 alex # block. Signed with the mode "P", which can be set or unset, like
127 5b333085 2003-01-04 alex # normal modes.
129 5b333085 2003-01-04 alex # Name of the channel
130 c3aac8dd 2002-05-21 alex ;Name = #TheName
132 5b333085 2003-01-04 alex # Topic for the channel
133 5b333085 2003-01-04 alex ;Topic = a great topic
135 5b333085 2003-01-04 alex # Channel-modes
136 c3aac8dd 2002-05-21 alex ;Modes = tn
