]> jfr.im git - irc/rqf/shadowircd.git/blobdiff - doc/reference.conf
Update refrence.conf's explanation of invex/except with warnings about disabling...
[irc/rqf/shadowircd.git] / doc / reference.conf
index 53297d1178aaca3c7581636703654a04fb8b8cce..8764ddb5ac3a393598006bde611b29dd113485b1 100755 (executable)
@@ -41,8 +41,9 @@
 
 /* Extensions:
  *
- * Charybdis contains several extensions that are not enabled by default.
- * To use them, uncomment the lines below.
+ * ShadowIRCd contains several extensions that are not enabled by default.
+ * To use them, uncomment the lines below. More information on each extension
+ * can be found in extensions/README
  *
  * Channel mode +-A (admin only)                     -- chm_adminonly.so
  * Channel mode +-O (oper only)                      -- chm_operonly.so
  * Server bans (+b $s:mask)                          -- extb_server.so
  * SSL bans (+b $z)                                  -- extb_ssl.so
  * HURT system                                       -- hurt.so
- * Host mangling (umode +h)                          -- ip_cloaking.so
+ * New host mangling (umode +x)                      -- ip_cloaking.so
  * Find channel forwards                             -- m_findforwards.so
  * /identify support                                 -- m_identify.so
+ * /mkpassword support                               -- m_mkpasswd.so
+ * Send message to all admins network-wide           -- m_adminwall.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
+ * /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
  * Remote k/d/x line active notices                  -- sno_globalkline.so
  * /whois notifications (snomask +W)                 -- sno_whois.so
  */
 #loadmodule "extensions/chm_adminonly.so";
-#loadmodule "extensions/chm_operonly.so";
+loadmodule "extensions/chm_operonly.so";
 #loadmodule "extensions/chm_sslonly.so";
 #loadmodule "extensions/chm_operonly_compat.so";
 #loadmodule "extensions/chm_quietunreg_compat.so";
 #loadmodule "extensions/chm_sslonly_compat.so";
 #loadmodule "extensions/createauthonly.so";
-#loadmodule "extensions/extb_account.so";
-#loadmodule "extensions/extb_canjoin.so";
-#loadmodule "extensions/extb_channel.so";
-#loadmodule "extensions/extb_extgecos.so";
-#loadmodule "extensions/extb_oper.so";
-#loadmodule "extensions/extb_realname.so";
+loadmodule "extensions/extb_account.so";
+loadmodule "extensions/extb_canjoin.so";
+loadmodule "extensions/extb_channel.so";
+loadmodule "extensions/extb_extgecos.so";
+loadmodule "extensions/extb_oper.so";
+loadmodule "extensions/extb_realname.so";
 #loadmodule "extensions/extb_server.so";
 #loadmodule "extensions/extb_ssl.so";
 #loadmodule "extensions/hurt.so";
-#loadmodule "extensions/ip_cloaking.so";
+loadmodule "extensions/ip_cloaking.so";
 #loadmodule "extensions/m_findforwards.so";
-#loadmodule "extensions/m_identify.so";
+loadmodule "extensions/m_identify.so";
+loadmodule "extensions/m_mkpasswd.so";
+#loadmodule "extensions/m_adminwall.so";
+#loadmodule "extensions/m_opme.so";
+#loadmodule "extensions/m_ojoin.so";
+#loadmodule "extensions/m_omode.so";
+#loadmodule "extensions/m_olist.so";
+#loadmodule "extensions/m_force.so";
 #loadmodule "extensions/no_oper_invis.so";
-#loadmodule "extensions/sno_farconnect.so";
-#loadmodule "extensions/sno_globalkline.so";
-#loadmodule "extensions/sno_globaloper.so";
+loadmodule "extensions/sno_farconnect.so";
+loadmodule "extensions/sno_globalkline.so";
+loadmodule "extensions/sno_globaloper.so";
 #loadmodule "extensions/sno_whois.so";
+
  
 /* serverinfo {}:  Contains information about the server. (OLD M:) */
 serverinfo {
@@ -110,7 +126,7 @@ serverinfo {
        /* description: the description of our server.  '[' and ']' may not
         * be used here for compatibility with older servers.
         */
-       description = "charybdis test server";
+       description = "shadowircd test server";
 
        /* network info: the name and description of the network this server
         * is on.  Shown in the 005 reply and used with serverhiding.
@@ -322,6 +338,17 @@ auth {
         */
         spoof = "I.still.hate.packets";
 
+       /* autojoin: Channel (or channels, comma-seperated) to join users
+        * in this auth block to on connect. Note that this won't join
+        * the user through any bans or otherwise restrictive chmodes.
+        */
+       autojoin = "#shadowircd,#test";
+
+       /* autojoin_opers : Channel (or channels, comma-seperated) to join
+        * opers to on oper-up.
+        */
+       autojoin_opers = "#opers,#help";
+
        /* Possible flags in auth:
         * 
         * encrypted                  | password is encrypted with mkpasswd
@@ -441,6 +468,12 @@ operator "god" {
         */
        #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
 
+       /* fingerprint: if specified, the oper's client certificate
+        * fingerprint will be checked against the specified fingerprint
+        * below.
+        */
+       #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
+
        /* umodes: the specific umodes this oper gets when they oper.
         * If this is specified an oper will not be given oper_umodes
         * These are described above oper_only_umodes in general {};
@@ -653,13 +686,44 @@ exempt {
 
 /* The channel block contains options pertaining to channels */
 channel {
+       /* autochanmodes: Modes that will be set on a unregistered channel
+        * when the first user joins it.
+        */
+       autochanmodes = "nt";
+
+       /* halfop: Enable/disable channel mode +h, which adds halfop,
+        * a channel status below op that has op powers (kick, ban, mode, etc.)
+        * halfops can only kick/devoice/etc people who are +v or
+        * do not have any channel status. 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_halfop = yes;
+
+       /* owner: Enable/disable channel mode +a, which adds owner,
+        * 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.
+        */
+       use_owner = yes;
+
        /* invex: Enable/disable channel mode +I, a n!u@h list of masks
-        * that can join a +i channel without an invite.
+        * 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).
+        * 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;
 
@@ -742,11 +806,28 @@ channel {
         * or non-ASCII).
         */
        only_ascii_channels = no;
+
+       /* cycle_host_change: Should a user be cycled in the channels
+        * they're in when their host changes. If set to no, this may
+        * cause client desyncs.
+        */
+       cycle_host_change = yes;
+
+       /* host_in_topic: Defines whether or not the topicsetter's
+        * host is shown when users request the TOPIC. If this option
+        * is set to no, it will only show the nick of the topicsetter.
+        */
+       host_in_topic = yes;
  
        /* resv_forcepart: force any local users to part a channel
         * when a RESV is issued.
         */
        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.
+        */
+       kick_no_rejoin_time = 30 seconds;
 };
 
 
@@ -836,6 +917,14 @@ alias "MemoServ" {
        target = "MemoServ";
 };
 
+alias "HostServ" {
+       target = "HostServ";
+};
+
+alias "BotServ" {
+       target = "BotServ";
+};
+
 alias "NS" {
        target = "NickServ";
 };
@@ -852,6 +941,14 @@ alias "MS" {
        target = "MemoServ";
 };
 
+alias "HS" {
+       target = "HostServ";
+};
+
+alias "BS" {
+       target = "BotServ";
+};
+
 /* 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.
  */
@@ -878,10 +975,10 @@ general {
 
        /* default umodes: umodes to set upon connection
         * If you have enabled the ip_cloaking extension, and you wish for
-        * incoming clients to be set +h upon connection, add +h to the umode
-        * string below.
+        * incoming clients to be cloaked upon connection, +x must be in
+        * the umode string below.
         */
-       default_umodes = "+i";
+       default_umodes = "+ix";
 
        /* default operstring: defines the default oper response
         * in /whois queries, eg "is an IRC Operator".
@@ -1071,6 +1168,12 @@ general {
         * protected. */
        operspy_dont_care_user_info = no;
 
+       /* secret channels in whois: display secret channels in /whois
+        * even if operspy was not used, as long as the oper doing the
+        * whois has the oper:spy priv. this will not send any kind of
+        * server notice. */
+       secret_channels_in_whois = no;
+
        /* caller id wait: time between notifying a +g user that somebody
         * is messaging them.
         */
@@ -1137,6 +1240,9 @@ general {
         * +s - servnotice - See server notices
         * +w - wallop     - See oper and server generated WALLOPS
         * +z - operwall   - See operwalls
+        * +C - noctcp     - Block CTCPs to user.
+        * +V - noinvite   - Block INVITE to user.
+        * +B - bot        - Marks as a bot.
         */
         
        /* oper only umodes: usermodes only opers may set */