]> jfr.im git - irc/rqf/shadowircd.git/blobdiff - doc/reference.conf
struct Channel: add mode_lock structure to the channel object.
[irc/rqf/shadowircd.git] / doc / reference.conf
index bc1262f1119278bf128e218b8b53b6732a9af38d..122fa78eceddb341b051f1487f8419d9fbd5e9d9 100755 (executable)
@@ -115,6 +115,31 @@ loadmodule "extensions/sno_globalkline.so";
 loadmodule "extensions/sno_globaloper.so";
 #loadmodule "extensions/sno_whois.so";
 
+/* modesets: Modesets are modules that enable various user and channel
+ * modes. When enabled, they enable usermodes and channel modes equivalent
+ * to the named ircd. This is useful for linking to other TS6 IRCds. 
+ * If you do not know what this does or do not know if you need it
+ * then you should just load modes/shadowircd.so for full functionality.
+ * Without any modeset loaded, you will only have the modes that are included
+ * in ircd-ratbox. Unloading a modeset while the ircd is running is possible,
+ * but will be confusing for users, as it will leave all existent unloaded
+ * modes in place without users being able to remove them. Said modes will, 
+ * however, not function. You should be able to load a module that provides 
+ * more modes than your current (say, going from charybdis to shadowircd) 
+ * on the fly without any problems. The slight exception to this is unloading
+ * a module that provides quiets (cmode +q). Users affected by quiets will
+ * have to part and rejoin the channel before the quiet will cease affecting
+ * them. In addition, unloaded modes will remain in the IRCd's VERSION reply
+ * until restart. For these reasons, it is highly recommended to restart if you wish
+ * to change modeset.
+ * Modesets currently only affect cmodes. 
+ * You should only load one of these at a time.
+ * Modules are listed in order of highest functionality to least,
+ * while no module provides the least functionality of all. */
+loadmodule "modes/shadowircd.so";
+#loadmodule "modes/charybdis.so";
+
  
 /* serverinfo {}:  Contains information about the server. (OLD M:) */
 serverinfo {
@@ -140,6 +165,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.  
         */
@@ -692,9 +725,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
-        *    rehash  - allow rehashing
+        *    die     - allow restarting/dying of servers
+        *    modules - allow loading/unloading/reloading of modules
         *    dline   - allow setting perm/temp dlines
         *    tdline  - allow setting temp dlines
         *    undline - allow removing dlines
@@ -735,6 +770,11 @@ channel {
         */
        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.
@@ -777,11 +817,6 @@ channel {
         */
        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.
@@ -880,10 +915,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;
 };
 
 
@@ -935,6 +971,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}";
 
@@ -981,6 +1020,14 @@ alias "BotServ" {
        target = "BotServ";
 };
 
+alias "InfoServ" {
+       target = "InfoServ";
+};
+
+alias "GroupServ" {
+       target = "GroupServ";
+};
+
 alias "NS" {
        target = "NickServ";
 };
@@ -1005,6 +1052,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.
  */
@@ -1072,6 +1127,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
          */
@@ -1105,7 +1166,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
@@ -1193,6 +1254,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.
         */
@@ -1278,15 +1346,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;
@@ -1325,7 +1403,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 */