implement IAUTH client code to query a separate server before allowing
[ircu2.10.12-pk.git] / doc / example.conf
index c3cabf2ea9b202443d7f69f0cdedfb8814607818..d6132afdc936ab79806883003724deab82d146eb 100644 (file)
@@ -161,7 +161,57 @@ Class {
  sendq = 160000;
  maxlinks = 400;
 };
+Class {
+ name = "Opers";
+ pingfreq = 1 minutes 30 seconds;
+ sendq = 160000;
+ maxlinks = 10;
+
+ # For connection classes intended for operator use, you can specify
+ # privileges used when the Operator block (see below) names this
+ # class.  The local (aka globally_opered) privilege MUST be defined
+ # by either the Class or Operator block.  The following privileges
+ # exist:
+ #
+ # local (or propagate, with the opposite sense)
+ # whox  (can use x flag with /WHO)
+ # display (oper status visible to lusers)
+ # chan_limit (can join local channels when in
+ #                              MAXCHANNELSPERUSER channels)
+ # mode_lchan (can /MODE &channel without chanops)
+ # deop_lchan (cannot be deopped or kicked on local channels)
+ # walk_lchan (can forcibly /JOIN &channel OVERRIDE)
+ # show_invis (see +i users in /WHO x)
+ # show_all_invis (see +i users in /WHO x)
+ # unlimit_query (show more results from /WHO)
+ # local_kill (can kill clients on this server)
+ # rehash (can use /REHASH)
+ # die (can use /DIE)
+ # local_jupe_server (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)
+ # 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)
+ # jupe_server (not used)
+ # opmode (can use /OPMODE)
+ # badchan (can issue Gchans to other servers)
+ # force_opmode (can use OPMODE/CLEARMODE on quarantined global channels)
+ #
+ # 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:
+ #  chan_limit, mode_lchan, show_invis, show_all_invis, local_kill,
+ #  rehash, local_gline, local_jupe, local_opmode, whox, display,
+ #  force_local_opmode
+ # Any privileges listed in a Class block override the defaults.
 
+ local = no;
+};
 # [Client]
 #
 # To allow clients to connect, they need authorization. This can be
@@ -565,18 +615,25 @@ CRULE
 # can squit, connect and kill - but only locally: their +o user mode
 # is not not passed along to other servers. On Undernet, this prevents
 # them from using Uworld as well.
-# Depending on some defines in include/config.h, local operators are also
-# not allowed to /DIE and /RESTART the server.
+#
 # Operator {
-#  local = no;
 #  host = "host/IP mask";
 #  name = "opername";
 #  password = "encryptedpass";
 #  class = "classname";
+#  # You can also set any operator privilege; see the Class block
+#  # documentation for details.  A privilege defined for a single
+#  # Operator will override the privilege settings for the Class
+#  # 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.  
+# 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.
+# 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
+# find.
 Operator {
  local = no;
  host = "*@*.cs.vu.nl";
@@ -585,11 +642,10 @@ Operator {
  class = "Local";
 };
 Operator {
- local = yes;
  host = "*@*.uu.net";
  password = "notencryptedpass";
  name = "Niels";
- class = "Local";
+ class = "Opers";
 };
 
 # Note that the <connection class> is optional, but leaving it away
@@ -682,6 +738,15 @@ Pseudo "LOGIN" {
  nick = "X@channels.undernet.org";
 };
 
+# 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;
+};
+
 # [features]
 # IRC servers have a large number of options and features.  Most of these
 # are set at compile time through the use of #define's--see "make config"
@@ -722,7 +787,7 @@ features
 #  "HIDDEN_IP"="127.0.0.1";
 #  "KILLCHASETIMELIMIT"="30";
 #  "MAXCHANNELSPERUSER"="10";
-#  "NICKLEN" = "9";
+#  "NICKLEN" = "12";
 #  "AVBANLEN"="40";
 #  "MAXBANS"="30";
 #  "MAXSILES"="15";
@@ -742,44 +807,14 @@ features
 # "TOS_SERVER" = "0x08";
 # "TOS_CLIENT" = "0x08";
 # "POLLS_PER_LOOP" = "200";
+# "IRCD_RES_TIMEOUTS" = "4";
+# "IRCD_RES_RETRIES" = "2";
+# "AUTH_TIMEOUT" = "9";
+# "IPCHECK_CLONE_LIMIT" = "4";
+# "IPCHECK_CLONE_PERIOD" = "40";
+# "IPCHECK_CLONE_DELAY" = "600";
 # "CRYPT_OPER_PASSWORD" = "TRUE";
-# "OPER_NO_CHAN_LIMIT" = "TRUE";
-# "OPER_MODE_LCHAN" = "TRUE";
-# "OPER_WALK_THROUGH_LMODES" = "FALSE";
-# "NO_OPER_DEOP_LCHAN" = "FALSE";
-# "SHOW_INVISIBLE_USERS" = "TRUE";
-# "SHOW_ALL_INVISIBLE_USERS" = "TRUE";
-# "UNLIMIT_OPER_QUERY" = "FALSE";
-# "LOCAL_KILL_ONLY" = "FALSE";
 # "CONFIG_OPERCMDS" = "FALSE";
-# "OPER_KILL" = "TRUE";
-# "OPER_REHASH" = "TRUE";
-# "OPER_RESTART" = "TRUE";
-# "OPER_DIE" = "TRUE";
-# "OPER_GLINE" = "TRUE";
-# "OPER_LGLINE" = "TRUE";
-# "OPER_JUPE" = "TRUE";
-# "OPER_LJUPE" = "TRUE";
-# "OPER_OPMODE" = "TRUE";
-# "OPER_LOPMODE" = "TRUE";
-# "OPER_BADCHAN" = "FALSE";
-# "OPER_LBADCHAN" = "FALSE";
-# "OPER_SET" = "FALSE";
-# "OPERS_SEE_IN_SECRET_CHANNELS" = "TRUE";
-# "OPER_WIDE_GLINE" = "TRUE";
-# "OPER_LIST_CHAN" = "TRUE";
-# "LOCOP_KILL" = "TRUE";
-# "LOCOP_REHASH" = "TRUE";
-# "LOCOP_RESTART" = "FALSE";
-# "LOCOP_DIE" = "FALSE";
-# "LOCOP_LGLINE" = "TRUE";
-# "LOCOP_LJUPE" = "TRUE";
-# "LOCOP_LOPMODE" = "TRUE";
-# "LOCOP_LBADCHAN" = "FALSE";
-# "LOCOP_SET" = "FALSE";
-# "LOCOP_SEE_IN_SECRET_CHANNELS" = "FALSE";
-# "LOCOP_WIDE_GLINE" = "FALSE";
-# "LOCOP_LIST_CHAN" = "FALSE";
 # "OPLEVELS" = "TRUE";
 # "LOCAL_CHANNELS" = "TRUE";
 };