Author: Bleep <tomh@inxpress.net>
[ircu2.10.12-pk.git] / doc / example.conf
index 8d8d023027c998b2e58d882917a10f707142797e..77da1d5036d9f4fe37e1a124077c91542db9d321 100644 (file)
 
 #
 # First some information about the server.
-# M:<server name>:<virtual ip>:<description>:<server port>:<server numeric>
+# M:<server name>:<virtual host>:<description>:<server port>:<server numeric>
 #
-# The <virtual ip> must be either be empty, contain a "*", or contain
-# the IP address of an interface on your system. If it contains an address,
-# the address will be bound to if you have specified virtual hosting.
+# <virtual host> must contain either a * or a valid IPv4 address in
+# dotted quad notation. (127.0.0.1) The address MUST be the address
+# of a physical interface on the host. This address is used for outgoing
+# connections only, see P:lines for listener virtual hosting.
+# If in doubt put a * or the IP of your primary interface here.
+# The server must be compiled with virtual hosting turned on to get this
+# to work correctly.
 #
-# The <server port> is the port that other servers can connect to.
-# Client ports need to be specified with a P: line, see below.
+# The <server port> is no longer used.
+# Ports need to be specified with a P: line, see below.
+# At some point in the future we may want to use the port value for
+# server capacity. --Bleep
 #
 # Note that <server numeric> has to be unique on the network your server
 # is running on, must be between 1 and 64, and is not updated on a rehash.
 
-# M:London.UK.Eu.UnderNet.org:127.0.0.1:University of London, England:4400:1
-M:London.UK.Eu.UnderNet.org:*:University of London, England:4400:1
+M:London.UK.Eu.UnderNet.org:*:University of London, England:0:1
 
 #
 # This sets information that can be retrieved with the /ADMIN command.
@@ -225,16 +230,6 @@ K:unixbox.flooder.co.uk:!kline/youflooded.txt:*luser
 # even if an IP address has a properly resolving host name.
 k:192.168.*:!klines/martians:*
 
-#
-# A more flexible way of restricting access to your server is the use
-# of "restriction lines". These tell the server to start up an (external)
-# program, upon whose output is decided whether the client is allowed
-# access. The program should print "Y" or "N <reason>" on its stdout.
-# Note that the use of R: lines is discouraged and deprecated, needs a
-# compile-time define, eats CPU cycles and may well be taken out in
-# future releases of ircd.
-# R:<host/IP mask>:<program name>:<username mask>
-
 #
 # You probably want your server connected to other servers, so your users
 # have other users to chat with.
@@ -247,28 +242,16 @@ k:192.168.*:!klines/martians:*
 # server links is provided for ircd to decide what links to allow, what
 # to let humans do themselves, and what links to (forcefully) disallow.
 #
-# The Connection and Allowing connection lines (also known as C/N lines)
+# The Connection lines (also known as C lines)
 # define what servers the server connect to, and which servers are
-# allowed to connect. Note that they come in pairs; they do not work if
-# one if present and the other is absent.
+# allowed to connect.
 # C:<remote hostname or IP>:<password>:<remote server name>:<port>:<class>
-# N:<remote hostname or IP>:<password>:<remote server name>:<hostmask>:<class>
 #
-# If you wish to use ident, prepend "username@" to the hostname or IP
-# address (the first field).
 # If the "port" field is omitted, the server will not attempt to
 # establish a link with that server ("not autoconnecting").
-# The (optional) "host mask" field tells the server to represent itself
-# with "hostmask" dot-seperateed fields stripped from its servername
-# and replace it with "*.".
-# For example, if hostmask == 2 and the local server name is
-# "irc.sub.domain.com" it would be sent as "*.domain.com". This allows
-# for easier routing and linking of new servers.
-# This feature is not used on Undernet.
 
 # Our primary uplink.
 C:1.2.3.4:passwd:Amsterdam.NL.Eu.UnderNet.org:4400:90
-N:1.2.3.4:passwd:Amsterdam.NL.Eu.UnderNet.org::90
 
 #
 # If your server starts on a bit larger network, you'll probably get
@@ -289,11 +272,11 @@ H:*.*::Amsterdam.NL.Eu.UnderNet.org
 # you can use Disallow lines. For more information, see doc/readme.crules.
 # D:<server mask that ircd will refuse to connect to>::<rule>
 # d:<server mask that ircd will not autoconnect to>::<rule>
-D:*.US.UnderNet.org::connected(*.US.UnderNet.org)
-d:*.EU.UnderNet.org::connected(Amsterdam.NL.EU.*)
+D:*.US.UnderNet.org::connected(*.US.UnderNet.org)
+d:*.EU.UnderNet.org::connected(Amsterdam.NL.EU.*)
 
 # The following line is recommended for leaf servers:
-d:*::directcon(*)
+d:*::directcon(*)
 
 #
 # Inevitably, you have reached the part about "IRC Operators". Oper status
@@ -323,31 +306,48 @@ O:*@*.cs.vu.nl:VRKLKuGKn0jLs:Niels::10
 # then use a connection class that allows more then one connection,
 # for example (using class 10 as in the example above):
 # Y:10:90:0:100:160000
-#
+
+# [P:lines]
 # When your server gets fuller, you will notice delays when trying to
 # connect to your server's primary listening port. Via the Port lines
-# it is possible to specify additional ports (both AF_UNIX and AF_INET)
-# for ircd to listen to.
+# it is possible to specify additional ports for ircd to listen to.
 # De facto ports are: 6667 - standard; 6660-6669 - additional client
 # ports;
-#
+# Undernet uses 4400 for server listener ports.
 # These are just hints, they are in no way official IANA or IETF policies.
 #
-# On a side note, the /UPING command uses port 7007/udp. If your server
-# is located behind a firewall, you may want to make another hole in it
-# for this port.
+# The interface setting allows multiply homed hosts to specify which
+# interface to use on a port by port basis, if an interface is not specified
+# the default interface will be used. The interface MUST be the complete
+# IP address for a real hardware interface on the machine running ircd.
+#
+# The [CS][H] field is an optional field to specify that a port is a
+# server port or a client port and whether it's hidden or not.
+# If used the first character MUST be either a C or S.
+# If you want to hide a port from /stats p from non-opers follow the C
+# or S with an H
 #
-# P:<hostmask, or path>:::<client port number>
+# P:<hostmask>:<interface>:<[CS][H]>:<client port number>
+#
+# This is a normal server port, you need to have at least one server
+# port defined if you want to connect your server to other servers.
+P:::S:4400
+# This is a Server port that is Hidden
+#P:::SH:4401
 
-P::::6667
+# The following are normal client ports
+P:::C:6667
 P::::6668
 P:*.nl:::6666
-P:/tmp/.ircd:::6667
+
+# This is a hidden client port, listening on the interface associated
+# with the IP address 168.8.21.107
+#P:*:168.8.21.107:CH:7000
 
 #
 # Well, you have now reached the end of this sample configuration file
 # If you have any questions, feel free to mail <doco-com@undernet.org>
-# or <wastelanders@undernet.org>.
+# or <coder-com@undernet.org>.
 # If you are interested in linking your server to the Undernet IRC network
 # visit http://www.routing-com.undernet.org/, and if there are any problems
 # then contact <routing-com@undernet.org> asking for information.