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