doc/sample-ngircd.conf

   1 # $Id: sample-ngircd.conf,v 1.20 2003/03/10 00:23:34 alex Exp $
   2
   3 #
   4 # This is a sample configuration file for the ngIRCd, which must adept to
   5 # the 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         # 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
  20         Name = irc.the.net
  21
  22         # Info text of the server. This will be shown by WHOIS and
  23         # LINKS requests for example.
  24         Info = Server Info Text
  25
  26         # Information about the server and the administrator, used by the
  27         # ADMIN command.
  28         ;AdminInfo1 = Description
  29         ;AdminInfo2 = Location
  30         ;AdminEMail = admin@irc.server
  31
  32         # Ports on which the server should listen. There may be more than
  33         # one port, separated with ";". (Default: 6667)
  34         ;Ports = 6667, 6668, 66694
  35
  36         # Text file with the "message of the day" (MOTD). This message will
  37         # be shown to all users connecting to the server:
  38         ;MotdFile = /usr/local/etc/ngircd.motd
  39
  40         # User ID under which the server should run; you can use the name
  41         # of the user or the numerical ID. ATTENTION: For this to work the
  42         # server must have been started with root privileges! In addition,
  43         # the configuration and MOTD files must be readable by this user,
  44         # otherwise RESTART and REHASH won't work!
  45         ;ServerUID = 65534
  46
  47         # Group ID under which the ngircd should run; you can use the name
  48         # of the group or the numerical ID. ATTENTION: For this to work the
  49         # server must have been started with root privileges!
  50         ;ServerGID = 65534
  51
  52         # After <PingTimeout> seconds of inactivity the server will send a
  53         # PING to the peer to test whether it is alive or not.
  54         ;PingTimeout = 120
  55
  56         # If a client fails to answer a PING with a PONG within <PongTimeout>
  57         # seconds, it will be disconnected by the server.
  58         ;PongTimeout = 20
  59
  60         # The server tries every <ConnectRetry> seconds to establish a link
  61         # to not yet (or no longer) connected servers.
  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 simultaneous 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         # [Operator] sections are used to define IRC Operators. There may be
  77         # more than one [Operator] block, one for each local operator.
  78
  79         # ID of the operator (may be different of the nick name)
  80         ;Name = TheOper
  81
  82         # Password of the IRC operator
  83         ;Password = ThePwd
  84
  85 [Server]
  86         # Other servers are configured in [Server] sections. If you
  87         # configure a port for the connection, then this ngircd tries to
  88         # connect to to the other server on the given port; if not it waits
  89         # for the other server to connect.
  90         # There may be more than one server block.
  91         #
  92         # Server Groups:
  93         # The ngIRCd allows "server groups": You can assign an "ID" to every
  94         # server with which you want this ngIRCd to link. If a server of a
  95         # group won't answer, the ngIRCd tries to connect to the next server
  96         # in the given group. But the ngircd never tries to connect to two
  97         # servers with the same group ID.
  98
  99         # IRC name of the server
 100         ;Name = irc2.the.net
 101
 102         # Internet host name of the peer
 103         ;Host = connect-to-host.the.net
 104
 105         # Port of the server to which the ngIRCd should connect. If you
 106         # assign no port the ngIRCd waits for incoming connections.
 107         ;Port = 6666
 108
 109         # Own password for the connection. This password has to be configured
 110         # as "PeerPassword" on the other server.
 111         ;MyPassword = MySecret
 112
 113         # Foreign password for this connection. This password has to be
 114         # configured as "MyPassword" on the other server.
 115         ;PeerPassword = PeerSecret
 116
 117         # Group of this server (optional)
 118         ;Group = 123
 119
 120 [Channel]
 121         # Pre-defined channels can be configured in [Channel] sections.
 122         # Such channels are created by the server when starting up and even
 123         # persist when there are no more members left.
 124         # Persistent channels are marked with the mode 'P', which can be set
 125         # and unset by IRC operators like other modes on the fly.
 126         # There may be more than one [Channel] block.
 127
 128         # Name of the channel
 129         ;Name = #TheName
 130
 131         # Topic for this channel
 132         ;Topic = a great topic
 133
 134         # Initial channel modes
 135         ;Modes = tn
 136
 137 # -eof-