Life would be interesting if we accepted host@ip syntax.. but we don't.
[ircu2.10.12-pk.git] / doc / example.conf
index 92eedc72c68fc9ab2bdea0655f6649ca7c3c1d09..99ab66288a5e5b2c70ea23f66ea6122bc289b458 100644 (file)
@@ -63,7 +63,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
@@ -82,9 +82,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,9 +92,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
+# clients or servers.
 # Recommended client classes:
-# for Martians (yet?); they will have to register as normal users. ;-)
 # Take the following class blocks only as a guide.
 # Class {
 #  name = "<class>";
@@ -159,11 +158,6 @@ Class {
  maxlinks = 100;
  usermode = "+iw";
 };
-Client
-{
- class = "Other";
- username = "*";
-};
 Class {
  name = "America";
  pingfreq = 1 minutes 30 seconds;
@@ -208,6 +202,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 +216,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 +237,7 @@ Class {
 # Kill block".
 # Client {
 #  host = "user@host";
-#  ip = "ip@host";
+#  ip = "user@ip";
 #  password = "password";
 #  class = "classname";
 # };
@@ -396,6 +393,8 @@ motd {
 #  name = "relservername";
 # };
 #
+# You may have have more than one name listed in each block.
+#
 # Note: (1) These lines are agreed on by every server admin on Undernet;
 # (2) These lines must be the same on every single server, or results
 # will be disasterous; (3) This is a useful feature, not something that
@@ -409,46 +408,31 @@ motd {
 # assigned one or two uplinks to which your server can connect.
 # If your uplink(s) also connect to other servers than yours (which is
 # probable), you need to define your uplink as being allowed to "hub".
-# To do this, set "hub = yes;"
-# You can also force a server(even one that doesn't connect to you)
-# to be a leaf with "leaf = yes;"
+# See the Connect block documentation for details on how to do that.
 
 UWorld {
  name = "uworld.eu.undernet.org";
-};
-UWorld {
  name = "uworld2.undernet.org";
-};
-UWorld {
  name = "uworld.undernet.org";
-};
-UWorld {
  name = "channels.undernet.org";
-};
-UWorld {
  name = "channels2.undernet.org";
-};
-UWorld {
  name = "channels3.undernet.org";
-};
-UWorld {
  name = "channels4.undernet.org";
-};
-UWorld {
  name = "channels5.undernet.org";
-};
-UWorld {
  name = "channels6.undernet.org";
 };
 
-# As of ircu2.10.05 is it possible to Jupe nicks. As per CFV-0095, the
-# following nicks must be juped, it is not allowed to jupe others as well.
+# As of ircu2.10.05 is it possible to Jupe nicks. As per CFV-0095 and
+# CFV-0255, the following nicks must be juped, it is not allowed to
+# jupe others as well.
 Jupe {
- nick = "EuWorld,E,StatServ,NoteServ";
- nick = "UWorld2,ChanSvr,ChanSaver,ChanServ";
- nick = "Uworld,NickSvr,NickSaver,NickServ";
- nick = "LPT1,X,login,LPT2,W,Undernet,COM1,V,protocol,COM2";
- nick = "U,pass,COM3,Y,AUX,COM4,Z,newpass";
+ nick = "A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z,{,|,},~,-,_,`";
+ nick = "EuWorld,UWorld,UWorld2";
+ nick = "login,undernet,protocol,pass,newpass,org";
+ nick = "StatServ,NoteServ";
+ nick = "ChanSvr,ChanSaver,ChanServ";
+ nick = "NickSvr,NickSaver,NickServ";
+ nick = "LPT1,LPT2,COM1,COM2,COM3,COM4,AUX";
 };
 
 # [Kill]
@@ -474,16 +458,20 @@ 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"; };
 Kill { host = "*.edu"; reason = "Please use a nearer server"; };
 
+# You can also kill based on username.
+Kill { username = "sub7"; realname = "s*7*"; reason = "You are infected with a Trojan"; };
+
 # The file can contain for example, a reason, a link to the
-# server rules and a contact address.
+# server rules and a contact address.  Note the combination
+# of username and host in the host field.
 Kill
 {
  host = "*luser@unixbox.flooder.co.uk";
@@ -524,17 +512,25 @@ Kill
 # Connect {
 #  name = "servername";
 #  host = "hostnameORip";
+#  vhost = "localIP";
 #  password = "passwd";
 #  port = portno;
 #  class = "classname";
 #  maxhops = 2;
 #  hub = "*.eu.undernet.org";
+#  autoconnect = no;
 # };
 #
 # The "port" field defines the default port the server tries to connect
 # to if an operator uses /connect without specifying a port. This is also
 # the port used when the server attempts to auto-connect to the remote
 # server. (See Class blocks for more informationa about auto-connects).
+# 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
@@ -627,7 +623,7 @@ Operator {
 };
 Operator {
  host = "*@*.uu.net";
- password = "notencryptedpass";
+ password = "$PLAIN$notencryptedpass";
  name = "Niels";
  class = "Opers";
 };
@@ -654,16 +650,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
@@ -683,11 +683,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
@@ -706,6 +706,16 @@ Port {
  port = 7000;
 };
 
+# Quarantine blocks disallow operators from using OPMODE and CLEARMODE
+# on certain channels.  Opers with the force_opmode (for local
+# channels, force_local_opmode) privilege may override the quarantine
+# by prefixing the channel name with an exclamation point ('!').
+# Wildcards are NOT supported; the channel name must match exactly.
+Quarantine {
+  "#shells" = "Thou shalt not support the h4><0rz";
+  "&kiddies" = "They can take care of themselves";
+};
+
 # This is a server-implemented alias to send a message to a service.
 # The string after Pseudo is the command name; the name entry inside
 # is the service name, used for error messages.  More than one nick
@@ -723,13 +733,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
@@ -801,8 +808,10 @@ features
 # "IPCHECK_CLONE_LIMIT" = "4";
 # "IPCHECK_CLONE_PERIOD" = "40";
 # "IPCHECK_CLONE_DELAY" = "600";
+# "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)
@@ -820,9 +829,9 @@ features
 #  "HIS_STATS_e" = "TRUE";
 #  "HIS_STATS_f" = "TRUE";
 #  "HIS_STATS_g" = "TRUE";
-#  "HIS_STATS_h" = "TRUE";
 #  "HIS_STATS_i" = "TRUE";
 #  "HIS_STATS_j" = "TRUE";
+#  "HIS_STATS_J" = "TRUE";
 #  "HIS_STATS_k" = "TRUE";
 #  "HIS_STATS_l" = "TRUE";
 #  "HIS_STATS_L" = "TRUE";
@@ -842,11 +851,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";