ZNCAdmin Installation Instructions

Introduction:
----------
If you encounter any problems compiling/running ZNCAdmin, please make 
sure you have followed the directions in this file correctly and that 
all of the requirements listed below are met.

If the problem persists, report it to one (or all) of the coders
listed in the AUTHORS file. Please try to include ALL relevant
information about the error/bug, including anything out of the
ordinary reported from make and the appropriate entries from the log
files.

Script files:
----------
The ZNCAdmin Project only consists of a few PHP Classes and a management script.
ZNCAdmin is not an own IRC Bot and can't be connected to an IRC Server by itself.

ZNCAdmin is made to be used as external scripts from NeonServV5.

  1) Install and run NeonServV5

  2) Copy the files into the scripts folder of NeonServ

  3) Bind the functions provided by the script:
       +bind znc_add NeonServ.extscript php scripts/zncadmin.php add $1 $2 %1+
       +bind znc_del NeonServ.extscript php scripts/zncadmin.php del $1 $2 %1+
       +bind znc_resetpass NeonServ.extscript php scripts/zncadmin.php resetpass $1 $2 %1+
       +bind znc_whois NeonServ.extscript php scripts/zncadmin.php search $1 $2- %1+
       +bind znc_seen NeonServ.extscript php scripts/zncadmin.php seen $1 $2 %1+
       +bind znc_simul NeonServ.extscript php scripts/zncadmin.php simul $1 $2 $3- %1+
       +bind znc_block NeonServ.extscript php scripts/zncadmin.php block $1 $2 %1+
       +bind znc_unblock NeonServ.extscript php scripts/zncadmin.php unblock $1 $2 %1+
       +bind znc_stats NeonServ.extscript php scripts/zncadmin.php stats $1 %1+

     You may also bind the "admin commands" (override the protected option)
       +bind znc_admin_add NeonServ.extscript php scripts/zncadmin.php force add $1 $2 %1+
       +bind znc_admin_del NeonServ.extscript php scripts/zncadmin.php force del $1 $2 %1+
       +bind znc_admin_resetpass NeonServ.extscript php scripts/zncadmin.php force resetpass $1 $2 %1+
       +bind znc_admin_simul NeonServ.extscript php scripts/zncadmin.php force simul $1 $2 $3- %1+
       +bind znc_admin_block NeonServ.extscript php scripts/zncadmin.php force block $1 $2 %1+
       +bind znc_admin_unblock NeonServ.extscript php scripts/zncadmin.php force unblock $1 $2 %1+

  4) DO NOT FORGET TO SET THE PERMISSIONS!
     External Scripts do not have own permission requirements. You need to set them manually using +modcmd
     see '+modcmd znc_add' for all available options - and set them for ALL commands

End of file, INSTALL.

-pk910 (zncadmin@pk910.de)