home *** CD-ROM | disk | FTP | other *** search
/ HomeWare 14 / HOMEWARE14.bin / bbsutils / wkly1092.arj / INSTALL.DOC < prev    next >
Text File  |  1992-10-25  |  21KB  |  482 lines
  1. 10-25-92  Note from the author:
  2.  
  3.     As of this date, I am making this program totally shareware, with
  4.     no crippling, no registration keys, and no hassles.  Feel free to
  5.     use this software for up to 30 days to evaluate it, if you continue
  6.     to use it past the 30 day evaluation period, you must register it.
  7.  
  8.     There are no extra features that registration enables, nor will you
  9.     need to call my BBS to get the latest versions - future versions will
  10.     be released just as this one has.  If you like this software, then
  11.     please register it - it will allow me to continue improving the
  12.     product.  I have a number of other PCBoard related projects in the
  13.     works, and the registration response to this product will determine
  14.     how future products are released.
  15.  
  16.     The registration fee for Weekly Limits is $25 (US). 
  17.     
  18.     Registration fees, suggestions, or comments should be addressed to:
  19.  
  20.                Robert Briggs
  21.                c/o Bob and Kathey's BBS
  22.                P.O. Box 571241
  23.                Murray, UT   84107
  24.     
  25.  
  26. -----------  Robert Briggs    25 October 92 ----------------------------
  27.  
  28.  
  29.     ******************************************************************
  30.     *                                                                *
  31.     *                          Weekly_Limits                         *
  32.     *                       REGISTERED VERSION                       *
  33.     *                                                                *
  34.     *                        Copyright (c) 1992                      *
  35.     *                       Robert Briggs / Info-Tech                *
  36.     *                                                                *
  37.     *                                                                *
  38.     *    Software designed to allow the PCBoard version 14.5a        *
  39.     *    sysop to implement WEEKLY time and byte ratios.  This       *
  40.     *    is NOT shareware - do not re-distribute !!  Thank you       *
  41.     *    for supporting this product by purchasing it !!             *
  42.     *                                                                *
  43.     *                           Support BBS:                         *
  44.     *                                                                *
  45.     *                       Bob and Kathey's BBS                     *
  46.     *                          (801) 262-3822                        *
  47.     *                         2400 - 16800 HST                       *
  48.     *                         FidoNet 1:311/11                       *
  49.     ******************************************************************
  50.  
  51.  
  52.  
  53.    -------------------------------------------------------------------
  54.  
  55.                        Upgrade installation
  56.                        --------------------
  57.  
  58.    Be careful NOT to overwrite your current executables or config file
  59.    just yet, since logon.exe, logoff.exe and weekly.cfg (or whatever
  60.    you are calling it) need to be replaced simultaneously, and with
  61.    no callers on-line...
  62.  
  63.    NOTE: These upgrade instructions ASSUME that you have the evaluation 
  64.    copy installed and functioning.
  65.  
  66.  
  67.    ■ Copy your current logon.exe, logoff.exe and weekly.cfg files off
  68.      to a safe place.
  69.  
  70.  
  71.    ■ Extract the program wkconfig.exe from this archive.  Place it into
  72.      a directory that does NOT contain your current weekly.cfg file.
  73.  
  74.    ■ Run the wkconfig program.  It SHOULD ask if it needs to create a
  75.      new configuration file for you.  If it doesn't you are in the 
  76.      subdirectory where your old config or some other file named
  77.      weekly.cfg is located.  If you DON'T get prompted to create a
  78.      new file - hit ESCAPE and exit the config program.  Move to a 
  79.      different subdirectory - you need to both create a NEW config
  80.      file and NOT overwrite your old one yet.
  81.    
  82.      Select PATHS, and enter the fully path qualified filenames to your:
  83.  
  84.        -  users file, 
  85.        -  users.inf file, 
  86.        -  log file,
  87.        -  reset report file, and
  88.        -  PCBDOOR.TXT (NO path qualifier) for the door text file name.
  89.  
  90.      
  91.      Select SECLEVEL and set up the single security level that your
  92.      current evaluation copy uses (it was set to 81 in the demo...) 
  93.  
  94.      You need to set up that security level as:
  95.      
  96.      W (weekly), 
  97.  
  98.      Answer "Yes" to preserve callers upload credits, 
  99.  
  100.      Set the minimum baud rate for weekly limits to 0,
  101.  
  102.      Set the logging level to 8 (maximum verbose mode), and 
  103.  
  104.      Enter the number of BYTES that the caller is allowed weekly.
  105.  
  106.    ■ At this point, you should take all nodes down, or have no callers
  107.      on-line - DON'T change over the software with a caller on line 
  108.      using a security level that the evaluation copy handled - it MIGHT
  109.      be harmless, but no sense in deliberately courting trouble....
  110.  
  111.    ■ Copy your new weekly.cfg over the old evaluation copy
  112.  
  113.    ■ Extract the two files logon.exe and logoff.exe from this 
  114.      archive, and overwrite your old copies.
  115.  
  116.    ■ You may now bring your system back up.  Operationally you are at
  117.      exactly the same point with the registered version that you were
  118.      with the evaluation copy.  You can now change things around at
  119.      your leisure.....  (Snuck the logging level down to zero before
  120.      you even tried it this way, didn't you Ray?)
  121.  
  122.  
  123.    -------------------------------------------------------------------
  124.  
  125.                          Recent additions
  126.                          ----------------
  127.  
  128. ■  The logon.exe file CAN be run in $$logon.bat rather than as an
  129.    auto log-on door, if you prefer.  The only problem with this is
  130.    that the caller does not get the settings display with his period 
  131.    expiration date and some other info.  If you don't care about
  132.    that, then feel free to run logon.exe in $$logon.bat.  A config
  133.    option is provided for the name of the info display file that is
  134.    created - this allows you to display it to the caller in some
  135.    alternate manner if you decide to go the $$logon.bat route. The
  136.    text is normally output to the file PCBDOOR.txt (when run as an
  137.    auto log-on door) and automatically displayed to the caller by
  138.    PCBoard when it returns from executing the door. If you go the
  139.    $$logon.bat route, it is up to you to display this text file 
  140.    to the caller, if you so desire, in some alternate manner.
  141.  
  142.    Running in $$logon.bat can be easier than setting up several 
  143.    auto log-on doors, and are no problems with a caller that
  144.    discovers the name of the door executing it and getting his 
  145.    time limits and download byte limits reset....
  146.  
  147.  
  148. ■  According to several message on SaltAir, you may have a single
  149.    $$logon.bat and $$logoff.bat file somewhere on the search path.
  150.    It is not necessary to have separate files in each node sub-
  151.    directory.
  152.  
  153.    -------------------------------------------------------------------
  154.  
  155.    The balance of this document is the same as the installation guide
  156.    contained in the evaluation copy.  See the file config.doc for more
  157.    information about various configuration options that are available
  158.    to you using wkconfig.exe......
  159.  
  160.    -------------------------------------------------------------------
  161.  
  162.  
  163.  
  164. This document is little more than the notes I used during the development
  165. of weekly_limits.  It presumes that the SYSOP reading it has great deal
  166. of knowledge about the workings of PCBoard in general - it is NOT for
  167. the novice.  In places it pre-supposes knowledge of PCBoard utilities, 
  168. like PCBSM or PCBSETUP.  In any event setting up weekly_limts is NOT like 
  169. setting up a game door - bang, bang, quick batch file, and two minutes 
  170. later it is set up and running.  If you know your way around a PCBoard
  171. system, you can probably set the entire thing up in 5 minutes........
  172.  
  173. PLEASE print out this file so that you have it available while you are
  174. going through the installation process...
  175.  
  176. You may or not know that good documentation takes longer to write than the 
  177. program it describes.  I have been investing my efforts into the program 
  178. rather than the documentation.  I'll clean up my act in the near future, 
  179. honest ! <sigh>
  180.  
  181.  
  182. Both logon.exe and logoff.exe are fairly small and load quickly - they
  183. are written in fairly optimized C code (I don't write anything else) and
  184. are optimized for SPEED. 
  185.  
  186.  
  187.    -------------------------------------------------------------------
  188.  
  189.  
  190.  
  191. INSTALLING WEEKLY_LIMITS
  192. ------------------------
  193.  
  194.  
  195. 1. This step must be done with all nodes down.  
  196.  
  197.    Execute PCBSM from any convenient spot.  
  198.    Select option D - User Info File Maintenance, then from that menu,
  199.    Select option C - Add/Update Third Party Application
  200.  
  201.    Add the following TPA :
  202.  
  203.    Name        : WEEKLY_LIMITS
  204.    Version     :  1
  205.    Static Size : 80
  206.    Dynamic Size:  0
  207.    Keyword     : - leave blank -
  208.  
  209.    Press page down to have PCBSM install the TPA area in your users.inf
  210.    file.  Please check your spelling - the name must be exactly as
  211.    show above, the two words "weekly" and "limits", with an underscore
  212.    character between them.....
  213.  
  214.    Do not fill in a key-word......
  215.  
  216.  
  217. 2. Back up your USERS and USERS.INF files (as long as you have everything
  218.    down anyway, might as well - How long HAS it been since you did ???)
  219.    
  220.    At this point the system can be brought back on-line, but you may 
  221.    want to keep it down for just a few more minutes - you have to set 
  222.    up an auto log-on door and fix up your $$logoff.bat files for all 
  223.    your nodes at the same time before any callers use the system.
  224.  
  225.  
  226. 3. I personally like to keep all of my files in separate directories, 
  227.    so....  Create a directory to hold the weekly_limits files.  Put
  228.    the archive file there, change to it, and unzip the archive.
  229.  
  230.    Remeber where you put it - you will need to specify the path to
  231.    the files logon.exe, logoff.exe, and your config file later on in
  232.    the installation process.
  233.  
  234. 4. Edit the file weekly.cfg with any convenient ASCII editor.  As an 
  235.    attempt to save some time when the weekly_limits software is running,
  236.    you have to specify the full location of your USERS file and 
  237.    USERS.INF file.
  238.  
  239.    Edit the item following the keyword USERS so that it points to 
  240.    your USERS file.  Edit the item following the keyword USERSINF so
  241.    that it points to your users.inf file.  Both of these are typically
  242.    located in a directory called MAIN
  243.  
  244.    Edit the item following the keyword LOG, so that it points to a 
  245.    fully "path qualified" file name.  Weekly_limts will keep its
  246.    operation log there.  At the current time this log is somwhat
  247.    verbose - you may want to check and delete this file from time
  248.    to time.....
  249.  
  250.    Edit the item following the keyword REPORT so that it points to a 
  251.    fully "path qualified" file name.  When callers set up using 
  252.    weekly limits "roll over" to a new week, a report of their
  253.    previous weeks time used, bytes uploaded, and bytes downloaded
  254.    is entered into this file.
  255.  
  256.    Edit the item following the keyword SEC.  
  257.  
  258.  
  259.    There are three fields following the SEC keyword - edit them to suit
  260.    your needs.  The first field is the security level that is to be
  261.    done with weekly limits.  (You will also need to set up an auto log-on
  262.    door for this security level, later)...
  263.  
  264.    The second field is a number between 0 and 6, and specifies the day
  265.    of the week that weekly limts are to be reset.  I personally use
  266.    Monday (1)....  
  267.  
  268.    The third field is the number of bytes a caller at that security level
  269.    is allowed to download in a week.  Do not use any commas in this number.
  270.  
  271.    Save your edited file.  Remember where it is, you will have to specify
  272.    a path to it later.
  273.     
  274.  
  275. 5. Set up a SHELLED auto log-on door for the security level you specified
  276.    in the weekly.cfg file - it does not need users.sys or door.sys.
  277.    
  278.    (I use the name WEEKLY for mine, which means that the file I need to 
  279.    edit in the next step is named "q:\doors\batch\weekly".  I also hide 
  280.    that door from the caller - none of my auto log-on doors appear in 
  281.    my doors menu.
  282.   
  283.  
  284. 6. Edit the batch file that the auto log-on door will be executing.  It 
  285.    will NOT have a .BAT extension, and will consist of a SINGLE LINE:
  286.  
  287.    path_to_where_the_file_is\LOGON.EXE   name_and_path_of_config_file.
  288.  
  289.    The "name_and_path_of_config_file" is the fully "path qualified" name
  290.    of the file that you edited in step # 4 - weekly.cfg.  If you place the
  291.    config file in a directory that appears on your path, such as \pcb\main,
  292.    it isn't NECESSARY to specify the path to it, but DOS will spend some
  293.    time searching the path for the file.  Weekly limits will run a bit
  294.    faster if you specify the full "path qualified" name of the config file.
  295.  
  296.    The "path_to_where_the_file_is" is the directory that you unzipped the
  297.    weekly_limts software into back in step # 3.  On my system, the file
  298.    WEEKLY, stored where I have my door batch files, q:\doors\batch, looks
  299.    like this:
  300.  
  301.           q:\doors\weekly\logon.exe q:\doors\weekly\weekly.cfg
  302.  
  303.    THIS IS ALL that need to be contained in the batch file, but you can
  304.    end it with a line that says EXIT if you like.  This is a shelled door
  305.    so you MUST NOT re-invoke your board.bat batch file!
  306.  
  307.    Same note as for the config file - if you place the files logon.exe and
  308.    logoff.exe in your "search path", you don't NEED to specify a path to 
  309.    them.  DOS will search the path for them - but this can be a slower 
  310.    process than if you specify the entire path to the file, especially 
  311.    if you have lots of directories in your search path....
  312.  
  313. 7. OK - almost done.   This last step depends a great deal on how you have
  314.    your system configured.  I personally have each node in a separate 
  315.    directory on drive q: - so on that drive I have a set of directories 
  316.    called "q:\node1", "q:\node2", "q:\node3", etc.
  317.  
  318.    Each node subdirectory contains a PCBOARD.SYS file and an EVENT.SYS
  319.    file.  Some of them have REMOTE.SYS files in them, and they ALL should
  320.    all have a PCBOARD.DAT file in them if you run multiple nodes.
  321.  
  322.    In each of these node directories create a file called $$logoff.bat (if
  323.    you don't already have one). 
  324.    
  325.    The way that PCBoard operates:
  326.    
  327.    It will only look for a $$logoff.bat file in the directory that it finds
  328.    itself in when it attempts to execute the $$logoff.bat file. It is not 
  329.    possible to have just a single $$logoff.bat file somewhere on the search
  330.    path and have it execute, because PCBoard will NOT search the path looking
  331.    for it.  
  332.  
  333.    If you already have a $$logoff.bat file set up for each node, fine, 
  334.    if none at all, you can create a single one and copy it to each
  335.    node directory.  The $$logoff.bat file, if you are creating a new
  336.    one, will look just like the batch file that you invoked when you
  337.    set up the shelled door, EXCEPT that, instead of LOGON.exe, you will
  338.    be running the file LOGOFF.exe.  My $$logoff.bat file looks like:
  339.  
  340.           q:\doors\weekly\logoff.exe q:\doors\weekly\weekly.cfg
  341.  
  342.                           ^^^^^^^^^^
  343.  Note the difference from the file "weekly" created in step 6 above.
  344.  
  345.  
  346.  
  347. 8.  Last step...  You have to enter the security level you specified in
  348.     the weekly.cfg file above into your PWRD file. (Rr files if you have
  349.     different security levels for each node...) 
  350.     
  351.     Do this using PCBsetup, selection B - File locations 1 - name of 
  352.     PWRD file.  Add the level with the following "twists":
  353.  
  354.     In the TIME field, put the number of minutes that the caller is
  355.     allowed PER WEEK.  (I use 500 minutes in mine).  This field has
  356.     a maximum of 999 minutes - meaning you can allow your callers up
  357.     to 16.7 hours per week on your system.
  358.  
  359.     In the K Bytes field, put 0.  Yes - that IS correct - zero.  The
  360.     weekly_limits software will handle allowing callers the correct
  361.     number of bytes according to what you entered in the weekly.cfg file.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367. >>                   NOW FOR THE HARD PART :
  368. >>                   _____________________
  369.  
  370.  
  371.                        (just kidding)
  372.  
  373.  
  374.  
  375. 9. If you had your system down, you can now bring it back up.
  376.  
  377.    That is it.  Everything from this point on is automatic.  Check your
  378.    log file for operational info....
  379.  
  380.  
  381. A couple of last minute notes:
  382. ------------------------------
  383.  
  384.  
  385. ■  To make sure that callers on my system don't go hog crazy when they
  386.    first get set up,  weekly_limts may cheat the caller out of two days
  387.    maximum the first time that they log on using weekly_limts.
  388.    
  389.    If you have things set up to reset on MONDAY, for example, and the 
  390.    caller first uses his security level on Saturday or Sunday, 
  391.    weekly_limits may stretch their first expriation period out to 
  392.    "a week from the coming Monday".  Follow that?  
  393.    
  394.    If I upgrade a caller on Sunday, and things are set up to reset on 
  395.    Monday, I don't want them using an entire weeks allowance on Sunday 
  396.    and then end up getting another full weeks allowance the very next 
  397.    day.  If a new caller  gets initialized one or two days prior to the 
  398.    reset day, they get "stretched" out to 8 or 9 days - the first time only.  After that
  399.  
  400.  
  401.  
  402. ■  If you messed up one of the batch files, so that either logon or logoff
  403.    can't find the configuration file, a file called either logon.err or
  404.    logoff.err will be created in the current directory.  Keep an eye
  405.    out for these files - it will indicate that something is seriously
  406.    mis-configured somewhere.  DUE TO A BUG IN QMAIL, if a caller exits
  407.    the qmail door by typing BYE, QMAIL executes the $$logoff.bat file 
  408.    with most of the PCBOARD.SYS file cleared out.  Weekly_limits will
  409.    leave an error message in the logon.err file complaining that the
  410.    user record number could not be found.  This is harmless, but 
  411.    somwehat annoying.
  412.  
  413.  
  414. ■  When the auto log-on door returns, it will display a screen similar
  415.    to the VIEW USER SETTINGs display to the caller.  If you have that
  416.    option (display user settings) on, you probably want to turn it off
  417.    using PCBSETUP.
  418.  
  419.    The display shown to the user is currently "hardwired" - and looks 
  420.    similar to what you would see on R&E....  It will be made a bit more
  421.    sysop configurable in the near future.
  422.  
  423. ■  If you have some catastrophe happen, and have to remove the auto log-on
  424.    door, you need to remove the line (executing logoff.exe) from your 
  425.    $$logoff.bat files as well.
  426.  
  427.    Logoff.exe will be VERY UNHAPPY if it gets executed, finds the config
  428.    file, gets a security level match with the SEC option in the config
  429.    file for this caller, and finds that LOGON.exe hasn't been executed
  430.    when this caller logged on. (as happens when a caller types BYE in
  431.    the QMAIL door, and QMAIL executes $$logoff.bat with a cleared out
  432.    PCBOARD.SYS file).  You will find the complaints in the LOGON.ERR
  433.    file if they occur.  In the case of QMAIL, the error messages generated
  434.    are harmless, but somewhat annoying.....
  435.  
  436. ■  I have been running and tweaking this software on my system for
  437.    some time now, but still consider it BETA test software.  Back up
  438.    your users file from time to time!
  439.  
  440. ■  The binary config file will also allow you to set "file limits" -
  441.    allowing a user to download "nn" files in a set period of time (say
  442.    a year) and expiring the user once that level is reached.
  443.  
  444. ------------------------------------------------------------------------
  445.  
  446. Both logon.exe and logoff.exe are fairly small and load quickly - they
  447. are written in highly optimized C code (I don't write anything else <g>)
  448. and are optimized for SPEED.  The whole design philosophy has been to
  449. assure that they execute quickly enough to be thought of as part of 
  450. PCBoard, rather than external utilities, by your callers.....
  451.  
  452. I do both custom programming and door writing at reasonable hourly rates..
  453.  
  454. ===Bob Briggs   30 March 1992
  455.  
  456. ------------------------------------------------------------------------
  457.  
  458.  
  459.  
  460.  
  461.  
  462.     THE LEGAL STUFF
  463.     ---------------
  464.  
  465.     Unfortunately in these "sue crazy" days, it is necessary to include
  466.     the following statements:  
  467.  
  468.     There are no warranties, expressed or implied,  for the use of this
  469.     program.  Neither the author, Robert Briggs, nor Info-Tech will be
  470.     held liable for any direct, indirect, incidental, or consequential  
  471.     damages resulting from the use of this program.   
  472.     
  473.     Your use of this program constitutes your AGREEMENT to this disclaimer 
  474.     and your release of the author and Info-Tech from any form of liability 
  475.     or litigation, regardless of cause...
  476.  
  477.  
  478.  
  479.  
  480.  
  481.                                  ### END ###
  482.