Merge branch 'development'

[NeonServV5.git] / neonserv.example.conf

diff --git a/neonserv.example.conf b/neonserv.example.conf
index afa81c01de00b796ca245b5fcb01319709f51833..b10eca7b2557175fd368f57e2b991d7186e3cb5e 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,19 +49,25 @@
         };
     };
 };
-"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";
 };
-"log" { //neonserv.log
+"logs" {
     /*
-     1 - INFO
-     2 - ERROR
-     4 - RAW
-     8 - MYSQL
+    module:section = target_type:target
+    possible sections:
+        "info","debug","raw","mysql","override","warning","error","fatal"
+    possible targets:
+        file:log.log
+        irc:#channel
+        std:out
+        std:err
     */
-    "loglevel" = 3;
+    "*:info,warning,error,fatal" = "file:neonserv.log";
+    // "*:override,error,fatal" = "irc:#neonserv";
+    "*:info" = "std:out";
 };
 "modules" {
     "libglobalcmd" {
@@ -79,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;
@@ -115,6 +125,7 @@
         "protected" = 0;
         "hide_networkname" = 0; //hide network name
         "hide_botnick" = 0; //hide bot nick, ident, host
+        // "use_bot" = "BotNick"; //use this bot for the statistics
         "hide_chancount" = 0; //hide joined channel count
         "hide_usercount" = 0; //hide number of users the bot can see
     };