EZFAQMKR - easy smartfaq page maker, by manny juan 9/13/2001

EZFAQMKR INSTALLATION INSTRUCTIONS
----------------------------------

ASSUMPTIONS
        your home base directory is
                path=   /home/htdocs/your.isp.com/website
                URL=    http://www.isp.com/website

        your cgi url is:
                URL=    http://www.isp.com/website/cgi-bin

        you want to store the smartfaq pages in a subdirectory called 'smartfaq'.
        note: each smartfaq page will be a subdirectory beneath 'smartfaq'.

then you should do the following:

SETUP
        1. create the subdirectory 'smartfaq' under the home base directory and chmod to 777
        2. unzip ezfaqmkr into this directory
        3. move the pl and cgi files to your cgi-bin directory and chmoded to 755

INDEX.HTML
        1. supply correct URL for the logo 
                (ie. IMG SRC=http://www.isp.com/website/smartfaq/mjmall.jpg)
        2. supply correct URL for the cgi script.  for example:
                <form action="http://www.isp.com/website/cgi-bin/ezfaqmkr.pl" method="POST">
        3. do above two more times for the 'edit smartfaq page' and 'delete smartfaq page'
        buttons.
        4. keep the <!--begin--> line in the page. DO NOT REMOVE!
        5. chmod to 777

DATA.TXT (list of users) 
        1. (initially empty)
        2. install in subdirectory 'smartfaq' and chmod to 777

EZPALETTE.GIF   - keep in 'smartfaq', color scheme selection graphic
MJMALL.JPG      - keep in 'smartfaq', logo for ez smartfaq page maker

EZFAQMKR.PL (easy smartfaq page maker script)
        (you might have to change the extension to .cgi depending on your server)
        1. make sure first line of script points to location of perl program
                #!/usr/bin/perl
        2. come with four random letters and/or numbers to become the "gSalt" for the 
        crypt function. you will also need this in vars.cgi
                $gSalt = "a1Mj";
        3. you might not need to change this: is your server win95? (my win95 server
        cannot handle file locking, so i set this to 1)
                $win95 = 0;
        4. supply value of $cgiurl (URL of the directory where cgi scripts reside)
                $cgiurl = "http://www.isp.com/website/cgi-bin";
        5. supply the full path to the directory where the smartfaq pages will reside
                $basedir = "/home/htdocs/your.isp.com/website/smartfaq";
        6. URL of the directory where the smartfaq pages will be stored
                $baseurl = "http://www.isp.com/website/smartfaq";
        7. what is the complete path of the index list of smartfaq pages? (not normally changed)
                $indexpage = "$basedir/index.html";
        8. what is the complete path of the user list? (see note below)
               $data = "$basedir/data.txt";
        9. where is your email program
                $sendmail = '/usr/sbin/sendmail';
        10. your email - email-id of the person giving this service - (duh, you!)
        (use apostrophe not quote)
                $myemail = 'email@isp.com';
        11. install this script in cgi-bin and chmod to 755

VARS.CGI (common variables and routines)
        1. make sure first line of script points to location of perl program
        2. you might not need to change this: is your server win95? (my win95 server
        cannot handle file locking, so i set this to 1)
                $win95 = 0;
        3. supply the full path to the directory where the smartfaq pages will reside
                $basedir = "/home/htdocs/your.isp.com/website/smartfaq";
        4. supply value of $cgiurl (URL of the directory where cgi scripts reside)
                $cgiurl = "http://www.isp.com/website/cgi-bin";
        5. supply the URL to the view-faq script
                $faqvuepl="$cgiurl/smartfaq.cgi";
        6. supply the URL to the faq-admin script
                $faqadmpl="$cgiurl/faqadmin.cgi";
        7. set the randomizer "salt" (ie. seed) that was defined in ezfaqmkr.pl
                $gSalt = "a1Mj";
        8. install this script in cgi-bin and chmod to 755

SMARTFAQ.CGI (the smartfaq page engine)
        1. no change required
        2. install in cgi-bin and chmod to 755

FAQADMIN.CGI (the smartfaq administration script)
        1. no change required
        2. install in cgi-bin and chmod to 755

RANDOM.CGI (script for displaying random smartfaq question/answer)
        1. no change required
        2. install in cgi-bin and chmod to 755

EZPWFAQ.PL (the smartfaq password reminder script)
        1. make sure first line of script points to location of perl program
                #!/usr/bin/perl
        2. what is the name of the EZ page generator?
                $ezpgm='EZFAQMKR';
        3. what is the name of the password reminder script (ie. THIS script)
                $pwscript='ezpwfaq.pl';
        4. what is the user directory (where smartfaq sites will be created)
                $userdir='smartfaq';
        5. what is your name?
                $myname='your name here';
        6. what is the URL to the directory containing the smartfaq sites?
                $mysiteurl = ""http://www.isp.com/website/$userdir";
        7. where is your sendmail located?
                $sendmail = '/usr/sbin/sendmail';
        8. what is the complete path of the user list? (see note below)
               $data = "$basedir/data.txt";
        9. install this script in cgi-bin and chmod to 755

ADMINISTRATION
--------------
after the smartfaq page is created, the owner can administer it by clicking on the 
Edit button from the index listing then by supplying the correct password and
clicking on the Admin option at the bottom.

NOTE: the file DATA.TXT contains fields used for validating the identity of the user.  you
may want to rename this file to a name that cannot be guessed easily.  if you do, make sure
you also change the ezfaqmkr.pl and ezgiftvu.pl scripts.

CREDITS
-------
NOTE: EZFAQMKR was written by "Jimmy" (webmaster@smartcgis.com) from www.smartcgis.com
and he retains full copyrights to faqadmin.cgi, random.cgi, smartfaq.cgi and vars.cgi
please respect these copyrights.  please do not remove any name and/or links to 
smartcgis.com and/or the name SmartFAQ

thank you.

----------
manny@jps.net
http://mannyjuan.com
9/13/2001
