]> jfr.im git - irc/evilnet/x3.git/blobdiff - x3.conf.example
more python: x3 logging, callback reg hook filters, install py scripts
[irc/evilnet/x3.git] / x3.conf.example
index c30c774c21e289a4ddd8e42224271690345347b7..72ce42d1de9fb1b1160548807e6e3b1dfeb8eeb8 100644 (file)
@@ -15,7 +15,7 @@
  */
 "uplinks" {
     // This first entry connects to an ircd on teh same server an X3..
-    "Hub" {  // This can be any string, just used here for your conveniance
+    "Hub" {  // This can be any string, just used here for your convenience
         "address"        "127.0.0.1";  // The IP address of the server
         "port"           "8888";       // What TCP port to connect to
         "password"       "laoo,rpe";  // Both of these passwords must match 
     "key1" "45432"; // Set these key values to the network KEY values you use
     "key2" "76934"; // for host hiding style 2.
     "key3" "98336";
+    "prefix" "AfterNET"; // If you use style 2 then this is the name that is prefixed to hosts.
     "numeric" "51"; // hint: If you get collisions on link, CHANGE THIS.
     /* Type handles some changes in nefarious 1.0 (was 0.5.0)
      * 4 - nefarious 0.4.x and other ircds
-     * 5 - nefarious 1.0.x and higher (Branch Revision)
-     * 6 - nefarious 1.0.x and higher (Trunk Revision)
+     * 5 - nefarious 1.0.x and higher (Obselete)
+     * 6 - nefarious 1.1.0 and higher (Branch Revision)
+     * 7 - nefarious 1.2.0 and higher (Trunk Revsions)
      */
-    "type" "5";
+    "type" "6";
     "host_in_topic" "1"; //Set to 1 if your Nefarious server have the HOST_IN_TOPIC F:line set to TRUE.
     "max_users" "256"; // You can save a little memory by setting this to a lower value.
     "force_n2k" "1"; // Use extended (5-digit) numnick for self, even if 3 are possible.
         // Whats a valid hostname look like for fakehosts?
         "valid_fakehost_regex" "^[-_a-zA-Z0-9.]+$";
 
+        // Force account names to lowercase? 1=yes 0=no
+        //   WARNING: this will convert when reading them from the db, too.
+        "force_handles_lowercase" "0";
+
         // "Nickserv" networks, set this to 0. "Authserv" networks,
         // set it to 1.
         "disable_nicks" "1"; 
             "lc_h" "800"; // support helper (lower case h)
             "uc_H" "800"; // net helper (upper case H)
             "S" "999";    // O3 access suspended
-            "b" "1";      // Bot (not sure what it does tho)
+            "b" "1";      // Bot (Hidden from !staff etc)
         };
 
         // and for who can change epithets for staff
 
         // Nickserv 'style' setting affects .userlist and other outputs.
         "default_style" "n"; // can be: n = normal, c = clean, or a = advanced.
+
+
+        // LDAP configuration(s)
+        // THIS IS EXPERIMENTAL! DO NOT USE IT IF YOU ARNT'T A DEVELOPER!!
+        // LDAP stands for light directory access protocol. its what many larger orgs use for central user/password management. Its also the core technology behind windows active directory.
+        // If you have an ldap server, you can configure X3 to use it instead of saving passwords locally.
+
+        //"ldap_enable" "0";
+        //"ldap_uri"  "ldaps://ldap.yournetwork.server:636";
+        //"ldap_base" "ou=Users,dc=afternet,dc=org";
+        //"ldap_dn_fmt" "uid=%s,ou=Users,dc=afternet,dc=org";
+        //"ldap_autocreate" "1"; // automatically create accounts if they exist in ldap but not x3
+        //// If you will be allowing users to register on IRC you need these:
+        //"ldap_admin_dn" "cn=Admin,dc=afternet,dc=org";
+        //"ldap_admin_pass" "xxxxxxxxxxx";
+        //"ldap_object_classes" ( "top", "inetOrgAnonAccount" );
+        ////      NOTE: inetOrgAnon is something I made up. its schema
+        ////      can be found in the tools/ directory. ldap servers wont
+        ////      know what that is by default.
+        //// These configure what I store, and where.
+        //"ldap_field_account" "uid";
+        //"ldap_field_password" "userPassword";
+        //"ldap_field_email" "mail";
+        //// This bit is needed if you want to put ircops into a group:
+        //"ldap_oper_group_dn" "cn=Opers,ou=Groups,dc=afternet,dc=org";
+        //"ldap_oper_group_level" "99";  // must be above this level to be added to oper ldap group
+        //"ldap_field_group_member" "memberUid"; // what field group members are in
+        //"ldap_timeout" "10"; // seconds
+
     };
 
     /* 
         //   1 = use a registered channel mode, have services op themselves
         //   2 = all of the above, and a channel setting to have ChanServ not
         //       idle in the channel
-        // NOTE: +z mode, needed for this to work,  is inharently flawed and 
-        //       will cause desynch, so don't use it IMO -Rubin.
+        // NOTE: +z mode, needed for this to work. X3 contains modifications to
+       // try and prevent desynchs. If you use this mode do not use any other service
+       // that uses this mode.
         "off_channel" "no";
 
         // Infolines are sent when channel users join the channel. Users set them with USET INFO in X3.
         // maximum bans on a channel banlist
         "max_chan_bans" "512";
         // maximum length of a user's infoline
-        "max_userinfo_length" "400";  // for god sake lower this. 80 seems good.
+        "max_userinfo_length" "400";  // hard limit for infolines. This is also the default value.
 
         // If SET DynLimit is on and there are N users in the channel, ChanServ will
         // try to keep the limit at N+<adjust_threshold>. This makes the channel
                 "No.",
                 "Maybe.");
 
+        // This is a list of wheel-of-misfortune results. Remove them to disable.
+        // You must make sure your ircd supports, and has enabled, the features needed
+        // for these.
+        "wheel" ( 
+             "peer", 
+            // "partall",  // needs svspart
+             "gline", 
+            // "shun",     // needs shun
+             "nothing", 
+            // "randjoin", // needs svsjoin and svspart
+            // "abusewhois",  // needs epitaph in /whois support
+             "kickall", 
+            // "nickchange",  // needs svsnick
+             "kill", 
+             "svsignore", 
+             "kickbanall" );
+
         // channel(s) that support helpers must be in to be helping
         // if this is a list, any one by itself will do
         "support_channel" ("#Operations", "#Help");
 
         // when does god mode time out?
         "god_timeout" "30m";
+
+        // What should valid registered channels look like?
+        // Be very carefull changing these. This default is 
+        // basically limited to letters, numbers, dash and underscore.
+        "valid_channel_regex" "#^[-_a-z][-_a-z0-9]*$";
     };
 
     /* Global is a service bot that can send out network-wide messages for you. I
         // How long should a helpserv be inactive (no requests assigned)
         // before it can be unregistered by the expire command?
         "expiration" "60d";
+
+        // If a user prefix's this before their helpserv commands then instead
+        // of a request being opened, they will be able to use helpserv commands.
+        "user_escape" "@";
     };
     /* SockCheck reads sockcheck.conf and can do configurable scans
      * to probe for open relays in an attempt to stop drones from using
                                 // to 0 to disable message expiration
         "limit" "30"; // Max amount of messages a person can get.
     };
+    /* WebTV allows webtv clients to use common IRC commands.
+     */
+    "webtv" {
+        "bot" "IRC";
+       "modes" "+k";
+
+       // Should clients need to be marked to use this service? 
+       "required_mark" "1";
+       // which marks are valid webtv marks?
+       "valid_marks" ("webtv", "msntv", "msntv2");
+    };
 };
 
 "policers" {