updated example configuration

diff --git a/neonserv.example.conf b/neonserv.example.conf
index ded933c179bd62a859320beb944ef718f3ef1901..9bab950f9756f0bf283c697bf1d64c44ffdac200 100644 (file)
--- a/neonserv.example.conf
+++ b/neonserv.example.conf
@@ -26,22 +26,22 @@
 };
 "General" {
     "worker_threads" = 5; //threads
-    "alertchan" = "";
+    "alertchan" = ""; //internal channel for important notifications
     "have_halfop" = 0;
     //unregister NeonSpam channels together with NeonServ?
     "sync_neonspam_unreg" = 1;
-    "CheckAuths" {
+    "CheckAuths" { //check all AuthNames in the database for existence (AuthServ querys)
         "enabled" = 1;
-        "start_time" = 3; //24h format
-        "duration" = 180; //minutes
-        "interval" = 2; //seconds
+        "start_time" = 3; //24h format - 3 means 3am
+        "duration" = 180; //minutes - query till start_time + duration o'clock ;)
+        "interval" = 2; //seconds - query every x seconds
         "min_unckecked" = 172800; //check auth only if unchecked for x seconds
         //180 miutes, every 2 seconds: 5400 auth checks
-        "alertchan" = "#krypton.intern";
+        "alertchan" = "#krypton.intern"; // notifications about deleted users
     };
     "UserBots" {
         "OtherServ" {
-            "enabled" = 1;
+            "enabled" = 0; //enable, if you want to use ;)
             "nick" = "OtherServ,OtherServ2"; //optional check (mask)
             "sourcebot" = "NeonServ"; //send messages through a bot of this botclass
             "opless_part" = "PRIVMSG %s :part %s"; //args: botnick, channel
@@ -49,8 +49,8 @@
         };
     };
 };
-"QServer" {
-    "enabled" = 0;
+"QServer" { //QServer is an unused 
+    "enabled" = 0; //leave this disabled if you don't know what you're doing!
     "port" = 7499;
     "pass" = "blaa";
 };
@@ -85,6 +85,10 @@
     "libNeonHelp" {
         "enabled" = 1;
         "protected" = 0;
+        //require users to be authenticated when opening a request
+        "need_auth" = 0;
+        //custom error message - if commented out "You need to be authenticated with AuthServ to use this command." will be used
+        //"need_auth_message" = "Sorry, we require you to be authenticated against AuthServ to use our Services. Please log in or register an account on http://xyz.de/register.php";
     };
     "libNeonServ" {
         "enabled" = 1;