doc/sample-ngircd.conf

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