]> jfr.im git - irc/rqf/shadowircd.git/blobdiff - doc/reference.conf
Clarify that serverhide::flatten_links disables /map for non-opers.
[irc/rqf/shadowircd.git] / doc / reference.conf
index 101ef3e42a095d8373e1a0d764a93e3a763e5216..5e2e061fdccb89b9acfe4de0075494cacbb4e95b 100755 (executable)
@@ -4,7 +4,7 @@
  * Copyright (C) 2002-2005 ircd-ratbox development team
  * Copyright (C) 2005-2006 charybdis development team
  *
- * Written by ejb, wcampbel, db, leeh and others
+ * Written by ejb, wcampbel, db, leeh, Taros, jdhore and others
  *
  * $Id: reference.conf 3582 2007-11-17 21:55:48Z jilles $
  */
@@ -140,6 +140,14 @@ serverinfo {
        network_name = "MyNet";
        network_desc = "This is My Network";
 
+       /* helpchan/helpurl: These 2 items are shown when a user does
+        * /quote help with no additional parameters to direct them
+        * to a channel/URL where they can get more or network-specific help.
+        * They can be commented out and will not show to users if they are.
+        */
+       helpchan = "#help";
+       helpurl = "http://www.mynet.net/help";
+
        /* hub: allow this server to act as a hub and have multiple servers
         * connected to it.  
         */
@@ -382,20 +390,20 @@ auth {
 
 /* Example WEBIRC authblock */
 auth {
-    /* user: webirc@IP.OF.YOUR.WEBIRC . the webirc@ part is required */
-    user = "webirc@192.168.1.1";
-
-    /* password: password the webirc client sends in the WEBIRC command.
-     * You can use a encrypted password here (see above auth block).
-     */
-    password = "<password>";
-
-    /* spoof: This is required to keep it what it is currently if you
-     * want the webirc client to show the users' real host as their
-     * host on IRC.
-     */
-    spoof = "webirc.";
-    class = "users";
+       /* user: webirc@IP.OF.YOUR.WEBIRC . the webirc@ part is required */
+       user = "webirc@192.168.1.1";
+
+       /* password: password the webirc client sends in the WEBIRC command.
+       * You can use a encrypted password here (see above auth block).
+       */
+       password = "<password>";
+
+       /* spoof: This is required to keep it what it is currently if you
+       * want the webirc client to show the users' real host as their
+       * host on IRC.
+       */
+       spoof = "webirc.";
+       class = "users";
 };
 
 auth {
@@ -692,10 +700,11 @@ shared {
         *    resv    - allow setting perm/temp resvs
         *    tresv   - allow setting temp resvs
         *    unresv  - allow removing xlines
+        *    rehash  - allow rehashing
         *    all     - allow oper/server to do all of above.
         *    locops  - allow locops - only used for servers who cluster
         *    die     - allow restarting/dying of servers
-        *    rehash  - allow rehashing
+        *    modules - allow loading/unloading/reloading of modules
         *    dline   - allow setting perm/temp dlines
         *    tdline  - allow setting temp dlines
         *    undline - allow removing dlines
@@ -731,11 +740,27 @@ exempt {
 
 /* The channel block contains options pertaining to channels */
 channel {
+       /* disabledmodes: Modes that will be disabled, users will not be
+        * able to set them. This is only read on startup, you need to 
+        * restart the ircd for this to have any effect. This only prevents 
+        * local users/opers from setting these modes. This does not prevent 
+        * remote servers/users (ex: services) from setting them. Make sure 
+        * your services and remote servers are properly configured when 
+        * using this option!
+        * Valid parameters are: CLPFQITDENGJKMrczgqefj
+        */
+       #disabledmodes = "ME";
+
        /* autochanmodes: Modes that will be set on a unregistered channel
         * when the first user joins it.
         */
        autochanmodes = "nt";
 
+       /* admin_on_channel_create: If set to yes, users joining new channels
+        * will be given +ao instead of just +o. Requires use_admin.
+        */
+       admin_on_channel_create = no;
+
        /* exemptchanops: Channel modes that any form of channel ops (+aoh) 
         * will be exempt from. Even if the mode is set, it will not apply to the
         * channel ops if it is listed in this option. Valid modes are cCDTNGK.
@@ -762,27 +787,6 @@ channel {
         */
        use_admin = yes;
 
-       /* invex: Enable/disable channel mode +I, a n!u@h list of masks
-        * that can join a +i channel without an invite. Disabling this option
-        * via rehash will leave all previously set invexes hanging around,
-        * though they will not do anything. For this reason, you may want to
-        * restart to disable this option.
-        */
-       use_invex = yes;
-
-       /* except: Enable/disable channel mode +e, a n!u@h list of masks
-        * that can join a channel through a ban (+b). Disabling this option
-        * via rehash will leave all previously set excepts hanging around,
-        * though they will not do anything. For this reason, you may want to
-        * restart to disable this option.
-        */
-       use_except = yes;
-
-       /* forward: Enable/disable channel mode +f, a channel to forward
-        * users to if they can't join because of +i etc.
-        */
-       use_forward = yes;
-
        /* knock: Allows users to request an invite to a channel that
         * is locked somehow (+ikl).  If the channel is +p or you are banned
         * the knock will not be sent.
@@ -881,10 +885,11 @@ channel {
         */
        resv_forcepart = yes;
 
-       /* kick_no_rejoin_time: the amount of time that a user cannot
-        * rejoin for after being kicked out of a +J channel.
+       /* channel target change: restrict how many channels users can
+        * message per unit of time. IRC operators, channel operators and
+        * voiced users are exempt.
         */
-       kick_no_rejoin_time = 30 seconds;
+       channel_target_change = yes;
 };
 
 
@@ -892,7 +897,7 @@ channel {
 serverhide {
        /* flatten links: this option will hide various routing information
         * and make all servers in /links appear that they are linked to
-        * this server.
+        * this server. This option also disallows non-opers from using /map
         */
        flatten_links = no;
 
@@ -936,6 +941,9 @@ serverhide {
  * See <http://www.ahbl.org/services.php> for more information.
  */
 blacklist {
+       host = "rbl.efnetrbl.org";
+       reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
+       
        host = "dnsbl.dronebl.org";
        reject_reason = "${nick}, your IP (${ip}) is listed in DroneBL. For assistance, see http://dronebl.org/lookup_branded.do?ip=${ip}&network=${network-name}";
 
@@ -982,6 +990,14 @@ alias "BotServ" {
        target = "BotServ";
 };
 
+alias "InfoServ" {
+       target = "InfoServ";
+};
+
+alias "GroupServ" {
+       target = "GroupServ";
+};
+
 alias "NS" {
        target = "NickServ";
 };
@@ -1006,6 +1022,14 @@ alias "BS" {
        target = "BotServ";
 };
 
+alias "IS" {
+       target = "InfoServ";
+};
+
+alias "GS" {
+       target = "GroupServ";
+};
+
 /* The general block contains many of the options that were once compiled
  * in options in config.h.  The general block is read at start time.
  */
@@ -1073,6 +1097,12 @@ general {
         */
        disable_fake_channels = no;
 
+       /* hide_channel_below_users: Amount of users a channel must have in it
+        * before it is shown in a standard LIST. This can be overridden by
+        * invoking LIST like: /LIST <3
+        */
+       hide_channel_below_users = 3;
+
         /* tkline_expire_notices: give a notice to opers when a tkline
          * expires
          */
@@ -1106,7 +1136,7 @@ general {
         */
        min_nonwildcard_simple = 3;
 
-        /* max accept: maximum allowed /accept's for +g usermode */
+        /* max accept: maximum allowed /accept's for +gGR usermodes */
         max_accept = 20;
 
        /* max monitor: the maximum amount of nicknames a client may have in
@@ -1194,6 +1224,13 @@ general {
         */
        warn_no_nline = yes;
 
+       /* use propagated bans: KLINE, XLINE and RESV set fully propagated bans.
+        * That means the bans are part of the netburst and restarted/split
+        * servers will get them, but they will not apply to 3.2 and older
+        * servers at all.
+        */
+       use_propagated_bans = yes;
+
        /* stats e disabled: disable stats e.  useful if server ips are
         * exempted and you dont want them listing on irc.
         */
@@ -1279,16 +1316,25 @@ general {
         */
        connect_timeout = 30 seconds;
 
+       /* ident timeout: Amount of time (in seconds) that the IRCd will
+        * wait for a user to respond to an ident request.
+        */
+       default_ident_timeout = 5;
+
        /* disable auth: disables identd checking */
        disable_auth = no;
 
-       /* no oper flood: increase flood limits for opers. */
+       /* no oper flood: increase flood limits for opers.
+        * This option quadruples the user command flood limits, it
+        * DOES NOT affect PRIVMSG/NOTICE usage.
+        */
        no_oper_flood = yes;
 
        /* true no oper flood: Allow opers to NEVER hit flood limits.
         * With the above setting, flood limits are set to 4x what they
         * are for normal users. With this setting, they're removed entirely.
         * For this setting to work, you need to have no_oper_flood enabled as well.
+        * This option DOES allow PRIVMSG/NOTICE flooding.
         * ENABLE THIS SETTING WITH CAUTION.
         */
        true_no_oper_flood = no;
@@ -1327,7 +1373,7 @@ general {
         * +V - noinvite   - Block INVITE to user.
         * +B - bot        - Marks as a bot.
         * +p - override   - Implicit operator access in all channels.
-        *                   This is oper-only and requires the oper:override privledge.
+        *                   This is oper-only and requires the oper:override priv.
         */
         
        /* oper only umodes: usermodes only opers may set */