]> jfr.im git - irc/rqf/shadowircd.git/blobdiff - doc/reference.conf
Added m_cycle and added it to all the appropriate locations.
[irc/rqf/shadowircd.git] / doc / reference.conf
index 0286bf6b08e9d56dbb00012bbf005619c102272e..c121af99f22b9da770fdf6fbfe42baf01b0eb554 100755 (executable)
@@ -1,4 +1,4 @@
-/* doc/reference.conf - charybdis Example configuration file
+/* doc/reference.conf - shadowircd Example configuration file
  *
  * Copyright (C) 2000-2002 Hybrid Development Team
  * Copyright (C) 2002-2005 ircd-ratbox development team
  * Find channel forwards                             -- m_findforwards.so
  * /identify support                                 -- m_identify.so
  * /mkpassword support                               -- m_mkpasswd.so
+ * WEBIRC support                                    -- m_webirc.so
  * Send message to all admins network-wide           -- m_adminwall.so
+ * Server-side /CYCLE                                -- m_cycle.so
+ * /oaccept - add to target's accept list, oper only -- m_oaccept.so
  * /opme - op self in opless channels, admin only    -- m_opme.so
  * /ojoin - join despite restrictions, admin only    -- m_ojoin.so
  * /omode - force modes in channels, admin only      -- m_omode.so
  * /olist - see all channels in /list, oper only     -- m_olist.so
+ * /okick - kick users without having ops, oper only -- m_okick.so
  * /forcejoin - force join users, admin only         -- m_force.so
  * Opers cannot be invisible (umode +i)              -- no_oper_invis.so
  * Far connection notices (snomask +F)               -- sno_farconnect.so
@@ -97,11 +101,15 @@ loadmodule "extensions/ip_cloaking.so";
 #loadmodule "extensions/m_findforwards.so";
 loadmodule "extensions/m_identify.so";
 loadmodule "extensions/m_mkpasswd.so";
+loadmodule "extensions/m_webirc.so";
 #loadmodule "extensions/m_adminwall.so";
+#loadmodule "extensions/m_cycle.so";
+#loadmodule "extensions/m_oaccept.so";
 #loadmodule "extensions/m_opme.so";
 #loadmodule "extensions/m_ojoin.so";
 #loadmodule "extensions/m_omode.so";
 #loadmodule "extensions/m_olist.so";
+#loadmodule "extensions/m_okick.so";
 #loadmodule "extensions/m_force.so";
 #loadmodule "extensions/no_oper_invis.so";
 loadmodule "extensions/sno_farconnect.so";
@@ -374,6 +382,24 @@ auth {
        class = "opers";
 };
 
+/* 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";
+};
+
 auth {
        /* redirect: the server and port to redirect a user to.  A user does
         * not have to obey the redirection, the ircd just suggests to them
@@ -486,7 +512,7 @@ operator "god" {
        /* snomask: specific server notice mask on oper up.
         * If this is specified an oper will not be given oper_snomask.
         */
-       snomask = "+Zbfkrsuy";
+       snomask = "+FZbcfkrsuy";
 
        /* vhost: defines the vhost that this oper will get on oper up.
         * this must be a valid hostmask. If this is specified the oper
@@ -497,13 +523,13 @@ operator "god" {
        /* swhois: defines an additional line that will be displayed
         * whenever someone does /whois on the oper in question.
         */
-       swhois = "is wearing pants."
+       swhois = "is wearing pants.";
 
        /* operstring: defines a custom operstring for this oper,
         * which will be shown in whois instead of default_operstring
         * or default_adminstring.
         */
-       operstring = "is a lazy IRC Operator"
+       operstring = "is a lazy IRC Operator";
 
        /* flags: misc options for the operator.  You may prefix an option
         * with ~ to disable it, e.g. ~encrypted.
@@ -727,15 +753,15 @@ channel {
         */
        use_halfop = yes;
 
-       /* owner: Enable/disable channel mode +a, which adds owner,
+       /* admin: Enable/disable channel mode +a, which adds admin,
         * a channel status above op that has op powers (kick, ban, mode, etc.)
-        * owners can only be kicked/deownered by other owners, and may kick
-        * or deop ops and halfops. Disabling this via rehash will
-        * cause things which are rather confusing to occur, it is highly
-        * recommended to restart if you wish to disable this option, though
-        * it may be enabled by rehash with no problems.
+        * admins can only be kicked/deadmined by other admins, and may kick
+        * or deop anyone. Disabling this via rehash will cause things which
+        * are rather confusing to occur, it is highly recommended to restart
+        * if you wish to disable this option, though it may be enabled 
+        * by rehash with no problems.
         */
-       use_owner = yes;
+       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
@@ -1031,6 +1057,11 @@ general {
         */
        default_operhost = "staff.testnet.net";
 
+       /* static quit: Quit message to display for all users (not opers)
+        * on QUIT.
+        */
+       #static_quit = "I like turtles!";
+
        /* servicestring: defines the response for opered services (+S)
         * in /whois queries, eg "is a Network Service".
         * This is updated on rehash.
@@ -1091,10 +1122,16 @@ general {
        max_nick_time = 20 seconds;
        max_nick_changes = 5;
 
-        /* anti spam time: the minimum time a user must be connected before
+       /* anti spam time: the minimum time a user must be connected before
         * custom quit messages are allowed.
         */
-        anti_spam_exit_message_time = 5 minutes;
+       anti_spam_exit_message_time = 5 minutes;
+
+       /* use part messages: This option controls whether users should be
+        * allowed to send PART messages to channels. It should probably
+        * be set to no if static_quit is set.
+        */
+       use_part_messages = yes;
 
        /* ts delta: the time delta allowed between server clocks before
         * a warning is given, or before the link is dropped.  all servers
@@ -1139,7 +1176,7 @@ general {
        /* kline reason: make the users quit message on channels this
         * reason instead of the oper's reason.
         */
-       kline_reason = "Connection closed";
+       kline_reason = "K-Lined";
 
        /* identify to services via server password
         * if auth{} block had no password but the user specified a
@@ -1282,6 +1319,8 @@ general {
         * +C - noctcp     - Block CTCPs to user.
         * +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.
         */
         
        /* oper only umodes: usermodes only opers may set */