doc/sample-ngircd.conf

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