edde4a99449253990a2bbf76095cba2b9d5bf7b3
[ngircd-alex.git] / doc / en / sample-ngircd.conf
1 # $Id: sample-ngircd.conf,v 1.2 2002/11/19 12:50:48 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 # 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 [Operator]
73         # In this [operator]-section, there will be the configuration of
74         # the name and password of an IRC operator. There may be more than
75         # one operator-block (for each operator one).
76         
77         # ID of the operator (may be different of the nick)
78         ;Name = TheOper
79
80         # Password of the operator
81         ;Password = ThePwd
82
83 [Server]
84         # In this [Server] section, there is the configuration of the
85         # servers, which are allowed to connect to your own server.
86         # There may be more than one server-block.
87         # If you configured a port for the connection, then the ngIRCd
88         # tries to connect to this port. If not, it waits for the other
89         # server.
90         #
91         # Server-groups:
92         # The ngIRCd allows "server-groups": that means, that you can assign
93         # server-groups for every server, to which you want the ngIRCd to
94         # connect to. If one server of a server-group won't answer, the
95         # ngIRCd tries the next one of this group.
96         # ATTENTION: Server-groups will only work if you defined a port!
97         
98         # Hostname of the server
99         ;Host = connect-to-host.the.net
100
101         # IRC-name of the server
102         ;Name = irc2.the.net
103    
104         # Port of the server, to which the ngIRCd should connect. If you
105         # assign no port, the ngIRCd waits for an answer of that server.
106         ;Port = 6666
107
108         # Own password for the connection. This password has to be configured
109         # as "PeerPassword" on the other server.
110         ;MyPassword = MySecret
111
112         # Foreign password for this connection. This password has to be
113         # configured as "MyPassword" on the other server.
114         ;PeerPassword = PeerSecret
115         
116         # Group of that server (optional)
117         ;Group = 123
118
119 [Channel]
120         # In the [Channel] there can be defined "persistent channels". This
121         # means, that the server creates the channel and even if all users
122         # left this channel, it will persist. There may be more than one
123         # block. Signed with the mode "P", which  can be set or unset, like
124         # normal modes.
125         
126         # Name of the channel
127         ;Name = #TheName
128
129         # Topic for the channel
130         ;Topic = a great topic
131         
132         # Channel-modes
133         ;Modes = tn
134
135 # -eof-