doc/sample-ngircd.conf

   1 # $Id: sample-ngircd.conf,v 1.28 2004/12/27 00:55:06 alex Exp $
   2
   3 #
   4 # This is a sample configuration file for the ngIRCd, which must be adepted
   5 # to the local preferences and needs.
   6 #
   7 # Comments are started with "#" or ";".
   8 #
   9 # Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
  10 # server interpreted the configuration file as expected!
  11 #
  12
  13 [Global]
  14         # The [Global] section of this file is used to define the main
  15         # configuration of the server, like the server name and the ports
  16         # on which the server should be listening.
  17
  18         # Server name in the IRC network, must contain at least one dot
  19         # (".") and be unique in the IRC network. Required!
  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. Not required by server but by RFC!
  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, 6669
  38
  39         # IP address on which the server should listen. (Default: empty,
  40         # so the server listens on all IP addresses of the system)
  41         ;Listen = 1.2.3.4
  42
  43         # Text file with the "message of the day" (MOTD). This message will
  44         # be shown to all users connecting to the server:
  45         ;MotdFile = /usr/local/etc/ngircd.motd
  46
  47         # A simple Phrase (<256 chars) if you don't want to use a motd file.
  48         # If it is set no MotdFile will be read at all.
  49         ;MotdPhrase = "Hello world!"
  50
  51         # User ID under which the server should run; you can use the name
  52         # of the user or the numerical ID. ATTENTION: For this to work the
  53         # server must have been started with root privileges! In addition,
  54         # the configuration and MOTD files must be readable by this user,
  55         # otherwise RESTART and REHASH won't work!
  56         ;ServerUID = 65534
  57
  58         # Group ID under which the ngircd should run; you can use the name
  59         # of the group or the numerical ID. ATTENTION: For this to work the
  60         # server must have been started with root privileges!
  61         ;ServerGID = 65534
  62
  63         # A directory to chroot in when everything is initialized. It
  64         # doesn't need to be populated if ngIRCd is compiled as a static
  65         # binary. By default ngIRCd won't use the chroot() feature.
  66         # ATTENTION: For this to work the server must have been started
  67         # with root privileges!
  68         ;ChrootDir = /var/empty
  69
  70         # After <PingTimeout> seconds of inactivity the server will send a
  71         # PING to the peer to test whether it is alive or not.
  72         ;PingTimeout = 120
  73
  74         # If a client fails to answer a PING with a PONG within <PongTimeout>
  75         # seconds, it will be disconnected by the server.
  76         ;PongTimeout = 20
  77
  78         # The server tries every <ConnectRetry> seconds to establish a link
  79         # to not yet (or no longer) connected servers.
  80         ;ConnectRetry = 60
  81
  82         # Should IRC Operators be allowed to use the MODE command even if
  83         # they are not(!) channel-operators?
  84         ;OperCanUseMode = no
  85
  86         # Maximum number of simultaneous connection the server is allowed
  87         # to accept (<=0: unlimited):
  88         ;MaxConnections = -1
  89
  90         # Maximum number of simultaneous connections from a single IP address
  91         # the server will accept (<=0: unlimited):
  92         ;MaxConnectionsIP = 5
  93
  94         # Maximum number of channels a user can be member of (<=0: no limit):
  95         ;MaxJoins = 10
  96
  97 [Operator]
  98         # [Operator] sections are used to define IRC Operators. There may be
  99         # more than one [Operator] block, one for each local operator.
 100
 101         # ID of the operator (may be different of the nick name)
 102         ;Name = TheOper
 103
 104         # Password of the IRC operator
 105         ;Password = ThePwd
 106
 107 [Operator]
 108         # More [Operator] sections, if you like ...
 109
 110 [Server]
 111         # Other servers are configured in [Server] sections. If you
 112         # configure a port for the connection, then this ngircd tries to
 113         # connect to to the other server on the given port; if not it waits
 114         # for the other server to connect.
 115         # There may be more than one server block.
 116         #
 117         # Server Groups:
 118         # The ngIRCd allows "server groups": You can assign an "ID" to every
 119         # server with which you want this ngIRCd to link. If a server of a
 120         # group won't answer, the ngIRCd tries to connect to the next server
 121         # in the given group. But the ngircd never tries to connect to two
 122         # servers with the same group ID.
 123
 124         # IRC name of the server
 125         ;Name = irc2.the.net
 126
 127         # Internet host name of the peer
 128         ;Host = connect-to-host.the.net
 129
 130         # Port of the server to which the ngIRCd should connect. If you
 131         # assign no port the ngIRCd waits for incoming connections.
 132         ;Port = 6666
 133
 134         # Own password for the connection. This password has to be configured
 135         # as "PeerPassword" on the other server.
 136         ;MyPassword = MySecret
 137
 138         # Foreign password for this connection. This password has to be
 139         # configured as "MyPassword" on the other server.
 140         ;PeerPassword = PeerSecret
 141
 142         # Group of this server (optional)
 143         ;Group = 123
 144
 145 [Server]
 146         # More [Server] sections, if you like ...
 147
 148 [Channel]
 149         # Pre-defined channels can be configured in [Channel] sections.
 150         # Such channels are created by the server when starting up and even
 151         # persist when there are no more members left.
 152         # Persistent channels are marked with the mode 'P', which can be set
 153         # and unset by IRC operators like other modes on the fly.
 154         # There may be more than one [Channel] block.
 155
 156         # Name of the channel
 157         ;Name = #TheName
 158
 159         # Topic for this channel
 160         ;Topic = a great topic
 161
 162         # Initial channel modes
 163         ;Modes = tn
 164
 165 [Channel]
 166         # More [Channel] sections, if you like ...
 167
 168 # -eof-