[srvx-commits] CVS: services srvx.conf.example,1.34,1.35

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/srvx/services
In directory sc8-pr-cvs1:/tmp/cvs-serv24887

Modified Files:
	srvx.conf.example 
Log Message:
update srvx.conf.example documentation


Index: srvx.conf.example
===================================================================
RCS file: /cvsroot/srvx/services/srvx.conf.example,v
retrieving revision 1.34
retrieving revision 1.35
diff -C2 -r1.34 -r1.35
*** srvx.conf.example	14 Nov 2002 00:51:07 -0000	1.34
--- srvx.conf.example	5 Jan 2003 23:55:00 -0000	1.35
***************
*** 6,17 ****
   */
  
  "uplinks" {
      "private-network" {
          "address"        "10.0.0.3";
          "port"           "6660";
          "password"       "passwordtoconnect";
          "their_password" "passwordtorequire";
          "enabled"        "1";
!         "max_tries"      "3"; // tries before giving up on this uplink
          // "bind_address"   "192.168.0.10"; // use this ip to link
      };
--- 6,26 ----
   */
  
+ // The "uplinks" section describes what servers we can possibly link
+ // to.  Each subsection describes one server.
  "uplinks" {
      "private-network" {
+         // IP address and port the server listens on
          "address"        "10.0.0.3";
          "port"           "6660";
+         // What password should we send when we connect?
          "password"       "passwordtoconnect";
+         // What password should we require our peer to send?
+         // (If it is blank, we do not require a specific password.)
          "their_password" "passwordtorequire";
          "enabled"        "1";
!         // How many times should we try to connect before giving up?
!         "max_tries"      "3";
!         // What IP should we bind to?
!         // If you do not specify bind_address, the default is used.
          // "bind_address"   "192.168.0.10"; // use this ip to link
      };
***************
*** 25,48 ****
          "password"       "passwordtoconnect";
          "their_password" "passwordtorequire";
          "enabled"        "0";
!         "max_tries"      "3"; // tries before giving up on this uplink
!         // "bind_address"   "192.168.0.10"; // use this ip to link
      };
  };
  
  "services" {
      "nickserv" {
          "nick" "NickServ";
!         // If you want to by default have a hostmask like *@*,
!         // you may list it here.  For security reasons, this is
!         // strongly discouraged.
!         // "default_hostmask" "*@*";
!         // one account may only have this many nicks
!         "nicks_per_account" "4";
!         // do we warn users when someone new auths to the user's account?
          "warn_clone_auth" "1";
!         // this can be a file that contains easily guessed passwords
          "dict_file" "/usr/share/dict/words";
!         // minimum number of various types of characters for a password
          "password_min_length" "4";
          "password_min_digits" "1";
--- 34,58 ----
          "password"       "passwordtoconnect";
          "their_password" "passwordtorequire";
+         // If "enabled" is 0, we will not try to use this uplink.
          "enabled"        "0";
!         "max_tries"      "3";
      };
  };
  
+ // The "services" section configures the services that make up srvx.
  "services" {
      "nickserv" {
          "nick" "NickServ";
!         // If you want to by have *@* as the default hostmask, set
!         // default_hostmask.  This is discouraged for security reasons.
!         // "default_hostmask" "1";
!         // do we warn users when someone new auths to their account?
          "warn_clone_auth" "1";
!         // This names a file that contains easily guessed passwords.
!         // It always contains "password", "<password>" and the user's
!         // account name.
          "dict_file" "/usr/share/dict/words";
!         // Minimum number of various types of characters permitted in
!         // a password.
          "password_min_length" "4";
          "password_min_digits" "1";
***************
*** 50,55 ****
          "password_min_lower" "0";
          // What should valid account and nicks look like?
!         // (If valid_nick_regex is omitted, valid_account_regex is used
!         // for both nicks and accounts.)
          // These look funny because "[][-]" is the only way to write the
          // character class containing the characters ']', '[' and '-'.
--- 60,65 ----
          "password_min_lower" "0";
          // What should valid account and nicks look like?
!         // If valid_nick_regex is omitted, valid_account_regex is used
!         // for both nicks and accounts.
          // These look funny because "[][-]" is the only way to write the
          // character class containing the characters ']', '[' and '-'.
***************
*** 57,75 ****
          "valid_nick_regex" "^[-_a-z][-_a-z0-9]*$";
  
!         // should nick ownership be disabled?
          "disable_nicks" "0";
!         // what to do when someone uses the NickServ "reclaim" command?
!         // this can be one of "none", "warn", "svsnick", or "kill", but
          // stock ircu does not support svsnick -- you need Bahamut or a
          // patch for ircu.  no, don't ask srvx developers for the patch.
          "reclaim_action" "none";
!         // send a warning when someone uses a registered nick?
!         "warn_nick_owned" "0";
!         // what (else) to do when someone uses a registered nick?
!         // this can be anything "reclaim_action" can be, but it makes
          // more sense to use the "warn_nick_owned" instead of "warn".
          "auto_reclaim_action" "none";
!         // and how long to wait before doing it?
!         // this is ignored if "auto_reclaim_action" is "none".
          "auto_reclaim_delay" "0";
  
--- 67,87 ----
          "valid_nick_regex" "^[-_a-z][-_a-z0-9]*$";
  
!         // Should nick ownership be disabled?
          "disable_nicks" "0";
!         // One account may only own this many nicks.
!         "nicks_per_account" "4";
!         // Send a warning when someone uses a registered nick?
!         "warn_nick_owned" "0";
!         // What to do when someone uses the NickServ "reclaim" command?
!         // This can be one of "none", "warn", "svsnick", or "kill", but
          // stock ircu does not support svsnick -- you need Bahamut or a
          // patch for ircu.  no, don't ask srvx developers for the patch.
          "reclaim_action" "none";
!         // What (else) to do when someone uses a registered nick?
!         // This can be anything "reclaim_action" can be, but it makes
          // more sense to use the "warn_nick_owned" instead of "warn".
          "auto_reclaim_action" "none";
!         // How long to wait before doing the auto_reclaim_action?
!         // This is ignored if "auto_reclaim_action" is "none".
          "auto_reclaim_delay" "0";
  
***************
*** 106,111 ****
          // How to integrate with email cookies?
          "email_enabled" "0"; // if set, /mail/enable MUST be set too
!         "email_required" "0";
!         "cookie_timeout" "1d";
          "accounts_per_email" "1"; // you may want to increase this; or not
          "email_visible_level" "800"; // minimum OpServ level to see somebody's email address
--- 118,123 ----
          // How to integrate with email cookies?
          "email_enabled" "0"; // if set, /mail/enable MUST be set too
!         "email_required" "0"; // ignored unless email_enabled is non-zero
!         "cookie_timeout" "1d"; // how long before we expire cookies?
          "accounts_per_email" "1"; // you may want to increase this; or not
          "email_visible_level" "800"; // minimum OpServ level to see somebody's email address