Clarify example.conf maxlinks, example Class blocks and Operator password.
[ircu2.10.12-pk.git] / doc / example.conf
index da47f13aa134556d3bcb612ff8741126ce9a9e91..ade236ec13beda91d6f781729129fed28497740d 100644 (file)
 #         vhost = "ipv6vhost";
 #         description = "description";
 #         numeric = numericnumber;
+#         dns vhost = "ipv4vhost";
+#         dns vhost = "ipv6vhost";
+#         dns server = "ipaddress";
+#         dns server = "ipaddress2";
 # };
 #
 # If present, <virtual host> must contain a valid address in dotted
@@ -63,7 +67,7 @@
 # be the address of a physical interface on the host.  This address is
 # used for outgoing connections if the Connect{} block does not
 # override it.  See Port{} for listener virtual hosting.  If in doubt,
-# leave it out.
+# leave it out -- or use "*", which has the same meaning as no vhost.
 #
 # You may specify both an IPv4 virtual host and an IPv6 virtual host,
 # to indicate which address should be used for outbound connections
 #
 # Note that <server numeric> has to be unique on the network your server
 # is running on, must be between 0 and 4095, and is not updated on a rehash.
+#
+# The two DNS lines allow you to specify the local IP address to use
+# for DNS lookups ("dns vhost") and one or more DNS server addresses
+# to use.  If the vhost is ambiguous for some reason, you may list
+# IPV4 and/or IPV6 between the equals sign and the address string.
+# The default DNS vhost is to let the operating system assign the
+# address, and the default DNS servers are read from /etc/resolv.conf.
+# In most cases, you do not need to specify either the dns vhost or
+# the dns server.
 General {
          name = "London.UK.Eu.UnderNet.org";
          description = "University of London, England";
@@ -82,9 +95,9 @@ General {
 # This sets information that can be retrieved with the /ADMIN command.
 # It should contain at least an admin Email contact address.
 Admin {
+  # At most two location lines are allowed...
   Location = "The University of London";
-  # At most two contact lines are allowed...
-  Contact = "Undernet IRC server";
+  Location = "Undernet IRC server";
   Contact = "IRC Admins <irc@london.ac.uk>";
 };
 
@@ -92,10 +105,8 @@ Admin {
 #
 # All connections to the server are associated with a certain "connection
 # class", be they incoming or outgoing (initiated by the server), be they
-# clients, servers or Martians. (Note that ircd doesn't have direct support
-# Recommended client classes:
-# for Martians (yet?); they will have to register as normal users. ;-)
-# Take the following class blocks only as a guide.
+# clients or servers.
+#
 # Class {
 #  name = "<class>";
 #  pingfreq = time;
@@ -105,8 +116,12 @@ Admin {
 #  usermode = "+i";
 # };
 #
-# maxlinks should be set at either 0 or 1.
-#
+# For connection classes used on server links, maxlinks should be set
+# to either 0 (for hubs) or 1 (for leaf servers).  Client connection
+# classes may use maxlinks between 0 and approximately 4,000,000,000.
+# maxlinks = 0 means there is no limit on the number of connections
+# using the class.
+# 
 # <connect freq> applies only to servers, and specifies the frequency 
 # that the server tries to autoconnect. setting this to 0 will cause
 # the server to attempt to connect repeatedly with no delay until the 
@@ -149,9 +164,7 @@ Class {
 # limits the number of matching clients allowed from a particular IP
 # address.
 #
-# Recommended client classes:
-# Client classes. 10 = locals; 2 = for all .net and .com that are not
-# in Europe; 1 = for everybody.
+# Take the following class blocks only as a guide.
 Class {
  name = "Local";
  pingfreq = 1 minutes 30 seconds;
@@ -159,11 +172,6 @@ Class {
  maxlinks = 100;
  usermode = "+iw";
 };
-Client
-{
- class = "Other";
- username = "*";
-};
 Class {
  name = "America";
  pingfreq = 1 minutes 30 seconds;
@@ -208,6 +216,7 @@ Class {
  # local_gline (can set a G-line for this server only)
  # local_badchan (can set a Gchan for this server only)
  # see_chan (can see users in +s channels in /WHO)
+ # list_chan (can see +s channels with /LIST S)
  # wide_gline (can use ! to force a wide G-line)
  # see_opers (can see opers without DISPLAY privilege)
  # local_opmode (can use OPMODE/CLEARMODE on local channels)
@@ -221,8 +230,10 @@ Class {
  # apass_opmode (can use OPMODE/CLEARMODE on +A and +U keys)
  #
  # For global opers (with propagate = yes or local = no), the default
- # is to grant all of the above privileges EXCEPT apass_opmode.  For
- # local opers, the default is to grant ONLY the following privileges:
+ # is to grant all of the above privileges EXCEPT walk_lchan,
+ # unlimit_query, set, badchan, local_badchan and apass_opmode.
+ # For local opers, the default is to grant ONLY the following
+ # privileges:
  #  chan_limit, mode_lchan, show_invis, show_all_invis, local_kill,
  #  rehash, local_gline, local_jupe, local_opmode, whox, display,
  #  force_local_opmode
@@ -240,7 +251,7 @@ Class {
 # Kill block".
 # Client {
 #  host = "user@host";
-#  ip = "ip@host";
+#  ip = "user@ip";
 #  password = "password";
 #  class = "classname";
 # };
@@ -461,9 +472,9 @@ Jupe {
 #
 #
 # The default reason is: "You are banned from this server"
-# Note that K-lines are local to the server; if you ban a person or a
+# Note that Kill blocks are local to the server; if you ban a person or a
 # whole domain from your server, they can get on IRC via any other server
-# that doesn't have them K-lined (yet).
+# that doesn't have them Killed (yet).
 #
 # With a simple comment, using quotes:
 Kill { host = "*.au"; reason = "Please use a nearer server"; };
@@ -515,6 +526,7 @@ Kill
 # Connect {
 #  name = "servername";
 #  host = "hostnameORip";
+#  vhost = "localIP";
 #  password = "passwd";
 #  port = portno;
 #  class = "classname";
@@ -530,6 +542,10 @@ Kill
 # You may tell ircu to not automatically connect to a server by adding
 # "autoconnect = no;"; the default is to autoconnect.
 #
+# If the vhost field is present, the server will use that IP as the
+# local end of connections that it initiates to this server.  This
+# overrides the vhost value from the General block.
+#
 # The maxhops field causes an SQUIT if a hub tries to introduce
 # servers farther away than that; the element 'leaf;' is an alias for
 # 'maxhops = 0;'.  The hub field limits the names of servers that may
@@ -606,7 +622,8 @@ CRULE
 # By default, the password is hashed using the system's native crypt()
 # function.  Other password mechanisms are available; the umkpasswd
 # utility from the ircd directory can hash passwords using those
-# mechanisms.
+# mechanisms.  If you use a password format that is NOT generated by
+# umkpasswd, ircu will not recognize the oper's password.
 #
 # All privileges are shown with their default values; if you wish to
 # override defaults, you should set only those privileges for the
@@ -648,16 +665,20 @@ Operator {
 # so we don't do that.
 #
 # Port {
-#  port = number;
+#  port = [ipv4] [ipv6] number;
 #  mask = "ipmask";
 #  # Use this to control the interface you bind to.
-#  vhost = "virtualhostip";
+#  vhost = [ipv4] [ipv6] "virtualhostip";
 #  # Setting to yes makes this server only.
 #  server = yes;
 #  # Setting to yes makes the port "hidden" from stats.
 #  hidden = yes;
 # };
 #
+# The port and vhost lines allow you to specify one or both of "ipv4"
+# and "ipv6" as address families to use for the port.  The default is
+# to listen on both IPv4 and IPv6.
+#
 # The mask setting allows you to specify a range of IP addresses that
 # you will allow connections from. This should only contain IP addresses
 # and '*' if used. This field only uses IP addresses. This does not use
@@ -677,11 +698,11 @@ Port {
  port = 4400;
 };
 
-# This is a Server port that is Hidden
+# This is an IPv4-only Server port that is Hidden
 Port {
  server = yes;
  hidden = yes;
- port = 4401;
+ port = ipv4 4401;
 };
 
 # The following are normal client ports
@@ -727,13 +748,10 @@ Pseudo "LOGIN" {
 };
 
 # You can ask a separate server whether to allow users to connect.
-IAuth {
- pass = "ircd-iauth";
- host = "127.0.0.1";
- port = 7700;
- connectfreq = 30;
- timeout = 60;
-};
+# Uncomment this ONLY if you have an iauth helper program.
+# IAuth {
+#  program = "../path/to/iauth" "-n" "options go here";
+# };
 
 # [features]
 # IRC servers have a large number of options and features.  Most of these
@@ -808,6 +826,7 @@ features
 # "CHANNELLEN" = "200";
 # "CONFIG_OPERCMDS" = "FALSE";
 # "OPLEVELS" = "TRUE";
+# "ZANNELS" = "TRUE";
 # "LOCAL_CHANNELS" = "TRUE";
 # "ANNOUNCE_INVITES" = "FALSE";
 #  These were introduced by Undernet CFV-165 to add "Head-In-Sand" (HIS)
@@ -847,11 +866,13 @@ features
 #  "HIS_STATS_x" = "TRUE";
 #  "HIS_STATS_y" = "TRUE";
 #  "HIS_STATS_z" = "TRUE";
+#  "HIS_STATS_IAUTH" = "TRUE";
 #  "HIS_WHOIS_SERVERNAME" = "TRUE";
 #  "HIS_WHOIS_IDLETIME" = "TRUE";
 #  "HIS_WHOIS_LOCALCHAN" = "TRUE";
 #  "HIS_WHO_SERVERNAME" = "TRUE";
 #  "HIS_WHO_HOPCOUNT" = "TRUE";
+#  "HIS_MODEWHO" = "TRUE";
 #  "HIS_BANWHO" = "TRUE";
 #  "HIS_KILLWHO" = "TRUE";
 #  "HIS_REWRITE" = "TRUE";
@@ -860,6 +881,7 @@ features
 #  "HIS_SERVERNAME" = "*.undernet.org";
 #  "HIS_SERVERINFO" = "The Undernet Underworld";
 #  "HIS_URLSERVERS" = "http://www.undernet.org/servers.php";
+#  "URLREG" = "http://cservice.undernet.org/live/";
 };
 
 # Well, you have now reached the end of this sample configuration