]> jfr.im git - solanum.git/blobdiff - doc/reference.conf
modules/m_challenge.c: log correct mechanism
[solanum.git] / doc / reference.conf
index b28a3f0f31313b3145c4b5bd77eda88ac97778ab..58b5fed1f8696045e9d96af192c3cd6367e82893 100644 (file)
  *        .include "filename"
  *        .include <filename>
  *
+ * Flags variables are comma-separated sets of predefined values,
+ * specific to each block. For example in operator {} blocks:
+ *        flags = encrypted, encrypted;
+ *
  * Times/durations are written as:
  *        12 hours 30 minutes 1 second
  *
@@ -72,9 +76,9 @@
  * Far connection notices (snomask +F)               -- sno_farconnect
  * Remote oper up notices                            -- sno_globaloper
  * Global nick-change notices                        -- sno_globalnickchange
- * /whois notifications (snomask +W)                 -- sno_whois
  * Oper-override (modehacking only)                  -- override
  * Stop services kills                               -- no_kill_services
+ * Allows you to hide your idle time (umode +I)      -- umode_hide_idle_time
  */
 #loadmodule "extensions/chm_adminonly";
 #loadmodule "extensions/chm_nonotice";
 #loadmodule "extensions/sno_farconnect";
 #loadmodule "extensions/sno_globalnickchange";
 #loadmodule "extensions/sno_globaloper";
-#loadmodule "extensions/sno_whois";
 #loadmodule "extensions/override";
 #loadmodule "extensions/no_kill_services";
+#loadmodule "extensions/umode_hide_idle_time";
 
 /* serverinfo {}:  Contains information about the server. (OLD M:) */
 serverinfo {
@@ -342,6 +346,11 @@ listen {
 
 /* auth {}: allow users to connect to the ircd (OLD I:) */
 auth {
+       /* description: descriptive text to help recognize this auth block in
+        * stats i output.
+        */
+       description = "example oper";
+
        /* user: the user@host allowed to connect.  Multiple IPv4/IPv6 user
         * lines are permitted per auth block.  This is matched against the
         * hostname and IP address (using :: shortening for IPv6 and
@@ -459,6 +468,7 @@ privset "local_op" {
         * oper:grant:           allows using the GRANT command
         * usermode:servnotice:  allows setting +s
         * oper:message:         allows opers to bypass CALLERID (usermode +g)
+        * oper:free_target:     messages to the oper bypass flood controls
         *
         * Privileges provided by extensions include:
         *
@@ -467,6 +477,9 @@ privset "local_op" {
         * oper:receive_immunity:
         *   confers the benefits of chmode +M (operpeace) (from extensions/chm_operpeace)
         * usermode:helpops      allows setting +h (from extensions/helpops)
+        * auspex:usertimes:
+        *   allows viewing user idle/connect times even when +I is set (from extensions/umode_hide_idle_time)
+        * oper:shedding:       allows the SHEDDING command (from extensions/m_shedding)
         */
        privs = oper:general, oper:privs, oper:testline, oper:kill, oper:operwall, oper:message,
                usermode:servnotice, auspex:oper, auspex:hostname, auspex:umodes, auspex:cmodes;
@@ -546,14 +559,21 @@ operator "god" {
        privset = "admin";
 };
 
-/* connect {}: controls servers we connect to (OLD C:, N:, H:, L:) */
+/* connect {}: controls servers we connect with (OLD C:, N:, H:, L:).
+ *
+ * This configuration is used whether connections are incoming or
+ * outgoing.
+ */
 connect "irc.uplink.com" {
        /* the name of the other server must go above. It should match the
         * other server's name in its serverinfo {} block, and does not
-        * need to be an actual hostname. */
+        * need to be an actual hostname.
+        */
 
-       /* host: the host or IP to connect to.  If a hostname is used it
-        * must match the reverse dns of the server.
+       /* host: the host or IP to connect to.
+        *
+        * It is also used to validate incoming connections. If a hostname
+        * is used, it must match the reverse dns of the server.
         */
        host = "203.0.113.3";
 
@@ -1151,7 +1171,7 @@ general {
        /* SASL access only client message: give users a message that
         * informs them
         */
-       sasl_only_client_message = "You need to identify via SASL to use to use this server.";
+       sasl_only_client_message = "You need to identify via SASL to use this server.";
 
        /* Identd access only client message: give users a message that
         * informs them
@@ -1186,8 +1206,7 @@ general {
        /* illegal name long client message: long-form explanation that their username
         * contains illegal characters
         */
-       illegal_name_long_client_message = "Your username is invalid. Please make sure that your username contains "
-                                                                          "only alphanumeric characters.";
+       illegal_name_long_client_message = "Your username is invalid. Please make sure that your username contains only alphanumeric characters.";
 
        /* illegal name short client message: short-form notification that their username
         * contains illegal characters; will be followed by ": their_username"
@@ -1296,6 +1315,13 @@ general {
         */
        ping_cookie = no;
 
+       /* ping warn time: how long to wait after pinging a server before starting
+        * to complain it is unresponsive. Note that the ping check interval is 30 
+        * seconds, so the first complaint will come at the next check after this 
+        * time has passed.
+        */
+       ping_warn_time = 15 seconds;
+
        /* connect timeout: sets how long we should wait for a connection
         * request to succeed
         */
@@ -1436,6 +1462,9 @@ general {
 
        /* hide_opers_in_whois: if set to YES, then oper status will be hidden in /WHOIS output. */
        hide_opers_in_whois = no;
+       
+       /* hide_opers: Hide all opers from unprivileged users */
+       hide_opers = no;
 
        /* tls_ciphers_oper_only: show the TLS cipher string in /WHOIS only to opers and self */
        tls_ciphers_oper_only = no;