Fix Admin block documentation and behavior (SF bug#1477672).
[ircu2.10.12-pk.git] / doc / example.conf
index 3f389240006207c92a37d492ab53433eb4362bf2..2833ca09a4f93b4ba45d6c7ab3a3d843decf712c 100644 (file)
 # First some information about the server.
 # General {
 #         name = "servername";
-#         vhost = "virtualhost";
+#         vhost = "ipv4vhost";
+#         vhost = "ipv6vhost";
 #         description = "description";
 #         numeric = numericnumber;
 # };
 #
-# <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 Port{} 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.
+# If present, <virtual host> must contain a valid address in dotted
+# quad or IPv6 numeric notation (127.0.0.1 or ::1).  The address MUST
+# 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 -- 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
+# of the respective type.
 #
 # 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.
@@ -78,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>";
 };
 
@@ -88,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>";
@@ -155,11 +158,6 @@ Class {
  maxlinks = 100;
  usermode = "+iw";
 };
-Client
-{
- class = "Other";
- username = "*";
-};
 Class {
  name = "America";
  pingfreq = 1 minutes 30 seconds;
@@ -185,7 +183,7 @@ Class {
  # exist:
  #
  # local (or propagate, with the opposite sense)
- # whox  (can use x flag with /WHO)
+ # whox  (log oper's use of x flag with /WHO)
  # display (oper status visible to lusers)
  # chan_limit (can join local channels when in
  #                              MAXCHANNELSPERUSER channels)
@@ -197,14 +195,16 @@ Class {
  # unlimit_query (show more results from /WHO)
  # local_kill (can kill clients on this server)
  # rehash (can use /REHASH)
+ # restart (can use /RESTART)
  # die (can use /DIE)
- # local_jupe_server (not used)
+ # local_jupe (not used)
  # set (can use /SET)
  # 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)
  # 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)
  # force_local_opmode (can use OPMODE/CLEARMODE on quarantined local channels)
  # kill (can kill clients on other servers)
  # gline (can issue G-lines to other servers)
@@ -212,10 +212,13 @@ Class {
  # opmode (can use /OPMODE)
  # badchan (can issue Gchans to other servers)
  # force_opmode (can use OPMODE/CLEARMODE on quarantined global channels)
+ # 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.  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
@@ -389,6 +392,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
@@ -402,57 +407,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";
 };
-Server {
- name = "Amsterdam.NL.Eu.UnderNet.org";
- mask = "*";
- hub = yes;
-};
-# An example just to make sure IRCnet doesn't get on undernet...
-Server {
- name = "*";
- mask = "eris.berkeley.edu";
- hub = yes;
-};
 
-# 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]
@@ -478,16 +457,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";
@@ -505,7 +488,7 @@ Kill
 # The realname field lets you ban by realname...
 Kill
 {
host = "*sub7*";
realname = "*sub7*";
  reason = "You are infected with a Trojan";
 };
 
@@ -533,12 +516,15 @@ Kill
 #  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.
 #
 # The maxhops field causes an SQUIT if a hub tries to introduce
 # servers farther away than that; the element 'leaf;' is an alias for
@@ -552,7 +538,7 @@ Connect {
  host = "1.2.3.4";
  password = "passwd";
  port = 4400;
- class = "Servers";
+ class = "Server";
  hub;
 };
 
@@ -613,9 +599,11 @@ CRULE
 #  # and the default setting.
 # };
 #
-# The encrypted password is optional.  If you wish to encrypt your
-# password, there is a utility in the ircd.  Please read the file
-# tools/README.
+# 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.
+#
 # All privileges are shown with their default values; if you wish to
 # override defaults, you should set only those privileges for the
 # operator.  Listing defaulted privileges just makes things harder to
@@ -629,7 +617,7 @@ Operator {
 };
 Operator {
  host = "*@*.uu.net";
- password = "notencryptedpass";
+ password = "$PLAIN$notencryptedpass";
  name = "Niels";
  class = "Opers";
 };
@@ -696,18 +684,28 @@ Port {
 Port { port = 6667; };
 Port { port = 6668; };
 Port {
+ # This only accepts clients with IPs like 192.168.*.
  mask = "192.168.*";
  port = 6666;
 };
 
-# This is a hidden client port, listening on the interface associated
-# with the IP address 168.8.21.107
+# This is a hidden client port, listening on 168.8.21.107.
 Port {
mask = "168.8.21.107";
vhost = "168.8.21.107";
  hidden = yes;
  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
@@ -725,13 +723,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
@@ -752,6 +747,11 @@ IAuth {
 #
 features
 {
+# These log features are the only way to get certain error messages
+# (such as when the server dies from being out of memory).  For more
+# explanation of how they work, see doc/readme.log.
+ "LOG" = "SYSTEM" "FILE" "ircd.log";
+ "LOG" = "SYSTEM" "LEVEL" "CRIT";
 #  "DOMAINNAME"="<obtained from /etc/resolv.conf by ./configure>";
 #  "RELIABLE_CLOCK"="FALSE";
 #  "BUFFERPOOL"="27000000";
@@ -798,8 +798,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)
@@ -817,9 +819,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";
@@ -839,11 +841,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";