home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / srev13g.zip / READ.ME < prev    next >
Text File  |  1999-06-26  |  13KB  |  286 lines
  1. 27 June 1999.  The SRE-http 1.3g WWW server 
  2.  
  3. Synopsis:
  4.    SRE-http is a highly configurable, http/1.1 compliant, web server for OS/2.  
  5.    With advanced features such as remote configuration, caching, and SSI; 
  6.    SRE-http is powerful enough for technically proficient administrators, 
  7.    yet simple enough to be maintained by non-technical users. 
  8.    In addition, the Rexx based GoServe API (as augmented by SRE-http's
  9.    numerous extensions) offers significant development advantages when
  10.    creating web aware applications, and when otherwise crafting a
  11.    customized and enhanced web site.
  12.  
  13.                         ************************
  14.  
  15. I. Introduction.                        
  16.  
  17. At it's heart, SRE-http is a "filter" for GoServe. SRE-http is designed to
  18. work with GoServe 2.52 (and above), and will run under OS/2 3.0 (and above). 
  19. It will run under OS/2 2.11, but it uses the Warp version of the 
  20. REXXUTIL library (which contains some routines not in the OS/2 2.1x version). 
  21. In other words:
  22.     If you use GoServe under OS/2 2.11, or with earlier versions
  23.     of GoServe (prior to 2.52),you might have sporadic problems.
  24.  
  25. Notes: 
  26.    * if you are using OS/2 Warp Server; you may need to install
  27.      the latest fix packs
  28.    * If you are using Warp 4.0, you should be using the latest fix packs
  29.      for TCP/IP (INETVER should report 4.02t or above).
  30.    * If you are using Object Rexx (under OS/2 4.0), you will NOT be 
  31.      able to use SRE-http.
  32.    * GoServe is a free IBM EWS Internet Server -- you can get it from 
  33.      http://www2.hursley.ibm.com/goserve.
  34.    * SRE-http comes with the standard freeware dislaimer -- use it 
  35.      at your own risk (see the bottom of this document for a more  
  36.      complete disclaimer).  That said, we want to know when you run
  37.      into problems, and are always willing to help.
  38.    * Questions? Contact Daniel Hellerstein : DANIELH@ECON.AG.GOV
  39.      Or visit the SRE-http home page at http://www.srehttp.org
  40.  
  41.                         ************************
  42.  
  43. II. Installation instuctions:
  44.  
  45. 1) Obtain and install the latest version (2.52 or above) of GoServe.
  46. 2) Unzip SREV13F.ZIP to an empty, temporary directory...
  47.    (you can use UNZIP, a recent copy of which is on the SRE-http home page)
  48. 3) Open an os/2 window
  49. 4) CD to this temporary directory
  50. 5) Run INSTALL.CMD. 
  51.     i) You will be asked to provide a few directory names.
  52.    ii) You will also be asked for your IP address (it's optional).
  53.   iii) You will be given the opportunity to set a few parameters -- 
  54.        which you can modify later.
  55.    iv) You will be given the opportunity to set up a username with
  56.        SUPERUSER privileges. We recommend that you do this (it's required 
  57.        for remote configuration). Of course, you can always create 
  58.        such a SUPERUSER later.
  59.  
  60. 6)If you are reinstallating SRE-http:
  61.  
  62.    * INSTALL will ask if you want to archive the (potentially) user-
  63.      configurable files.  We recommend selecting this option. 
  64.  
  65.    * If INSTALL detects a pre-existing file, it will ask you if
  66.      you want to overwrite it.  For some "configuration" files
  67.      if will ask you twice!
  68.  
  69.    * Several of the program files (such as COUNTER.RXX)
  70.      contain "advanced" user-configurable parameters. If you had changed
  71.      them, you'll need to change them again (in the new versions 
  72.      you just installed). That is, INSTALL does NOT retain these values;
  73.      it just creates backup files, and then overwrites.
  74.      HINT: SRE-http's EDITSREF.CMD utility makes it easy to change 
  75.            parameters in ADDON\COUNTER.RXX.
  76.  
  77.    * Occassionally, GoServe/SRE will not properly restart after an
  78.      installation (it seems to have something to do with corrupted
  79.      macrospace). Should this happen, rebooting your machine (and
  80.      then starting GoServe/SRE) will often solve the problem.
  81.            
  82. 7) If this is a first time install, you must change your default filter 
  83.    (in GoServe) to be SREFILTR.80
  84.    Alternatively, in many cases the SREPROXY.80 "simple proxy" can be used
  85.    to improve performance.
  86.  
  87. 8)  Start GoServe.  But first:
  88.      *  Are you using GoServe 2.52?  If not, you'll need to download it
  89.         (see notes below).
  90.      *  You must set the Options-Limit-Connection_maintain to some positive
  91.         number (say, 15).
  92.      *  You must have a properly defined TZ variable in your CONFIG.SYS
  93.         file (TZ defines your time zone, relative to Greenwich Mean Time).   
  94.      Advanced Users Note:
  95.         If you are willing to sacrfice full compliance with http/1.1, you
  96.         can force SRE-http to ignore some of these prerequisites by
  97.         setting the CHECK_COMPLIANCE parameter in SREFMON.CMD.
  98.  
  99.  
  100. 9) Assuming you were able to choose the
  101.    default parameters (in step 5.iii), point your browser at 
  102.        http://your.server.whereever/index.sht
  103.  
  104.    This SRE-http home page contains a number of useful links
  105.    to documentation, demos, and configuration tools. Of particular
  106.    interest is the users-guide, and the configurator.
  107.  
  108.    The users guide (GUIDE.HTM) outlines the capabilites of SRE-http, and
  109.    points to further help.  It's a good place to start. In addition,
  110.    the DOCGUIDE.HTM, the frames/javascript enabled "documentation guide",
  111.    is a useful front end to SRE-http's various documentation files.
  112.  
  113.    The configurator can be accessed via
  114.           http://your.server.whereever/CONFIGUR.HTM
  115.    It has three modes: simple, intermediate, and expert.
  116.    New users will probably be most comfortable with the simple mode.
  117.  
  118.                         ************************
  119.  
  120. III. Miscellaneous notes
  121.  
  122.  
  123.   *  For the latest version of SRE-http, demos, and addons --
  124.      visit the SRE-http home page at http://www.srehttp.org/
  125.  
  126.   *  SRE-http's configuration files will be written to the CFGS\ subdirectory of
  127.      the GoServe working directory.
  128.  
  129.   *  SRE-http ver 1.3g will work with GoServe 2.50. However, several http/1.1
  130.      features require 2.52 -- thus, we highly recommend obtaining GoServe 2.52.
  131.  
  132.   *  You can get the latest copy of GoServe (currently 2.52) from:
  133.          http://www2.hursley.ibm.com/goserve/
  134.      (or, you can find a copy of it on the SRE-http home page).
  135.  
  136.   *  If GoServe won't let you in (because it can't find a filter), you can
  137.      add "FILTER SREFILTR.80 " (without the quotes) to the
  138.      GoServe WPS object (the icon's) "parameters" option.
  139.  
  140.   *  SRE-http will NOT run under Object Rexx.  There
  141.      is a (ever aging) version of ver 1.2g that will run under Object Rexx
  142.      (see the SRE-http home page for details).
  143.  
  144.   *  WARP 4.0 users: If response time is very slow (more then a few seconds 
  145.      for simple documents) you might need to upgrade your version of 
  146.      TCP/IP (to at least 4.02t).
  147.  
  148.   *  If your needs are not very complicated, you might find sreLite, 
  149.      a smaller-faster-less_feature_rich version of SRE-http, to be worth
  150.      investigating; look for it at http://www.srehttp.org/server/
  151.  
  152.   *  If you have relatively simple demands, the simple mode configurator
  153.      may be adequate for all your needs. Conversely, if you want to
  154.      optimize SRE-http's performance, you will probably want to
  155.      use the intermediate, or expert, mode. 
  156.  
  157.   *  INTRO.DOC contains a 1 page summary of SRE-http's capabilites.
  158.  
  159.   *  Upgraders from prior versions of SRE-http should read HISTORY.TXT
  160.      .
  161.   *  SREhttp.FAQ contains answers to some frequently asked questions.
  162.  
  163.   *  The SRE-http "web-accessible manual" is SREhttp.HTM.
  164.  
  165.   *  For optimization hints, and a complete description of the user
  166.      configurable parameters, see INITFILT.DOC
  167.  
  168.   *  The various .IN and .CTL files that come with SRE-http contain
  169.      descriptons, and examples, of how to set up these "username,
  170.      URL access control, etc." files.
  171.  
  172.   *  SRE-http uses "OS/2 macro space" to store frequently
  173.      used routines, and uses queues and semaphores for inter-thread
  174.      communication.  To do this, the REXXLIB  library is used.
  175.      Although you have free rights to use REXXLIB with SRE-http,
  176.      if you intend to use REXXLIB for something other then SRE-http,
  177.      you should obtain the REXXLIB package  from
  178.      http://www.quercus-sys.com/rexxlib.htm.
  179.  
  180.   *  Several of the functions used by SRE-http are part of RxSock.DLL --
  181.      the Rexx Sockets Support library.  It should be in your LIBPATH
  182.      (it is usually in your \TCPIP\DLL directory).
  183.  
  184.   *  Several other freely available dynamic link libraries are distributed
  185.      with, and installed by, SRE-http. See the basic copyright at the 
  186.      bottom of this document for details.
  187.  
  188.                         ************************
  189.  
  190.  
  191. IV. Acknowledgements
  192.  
  193.  > Steve Ryckman and the people at SimsWare for providing great help, good suggestions, 
  194.    bug finds, and for hosting the SRE-http home page!
  195.   
  196.  > Don Meyer, author of the GoHTTP filter, was very gracious
  197.    in allowing me to "build on his work".  In particular,
  198.    much of the source code for HTACCESS file access-controls,
  199.    CGI-BIN script processing,  and image map processing was adapted
  200.    from his code.
  201.  
  202.  > Juho Risku for more great help, some nice graphics.
  203.  
  204.  > Derek Sims (author of the IntrFilt filter) for helpful advice
  205.    regarding multi-host servers.
  206.  
  207.  > Charles Daney for providing the REXXLIB library at a very reasonable
  208.    price.
  209.  
  210.  > Dave Briccetti for providing the "SMTP using socket calls" code.
  211.  
  212.  > Ariel L. Szczupak for advice on working with queues and semaphores.
  213.  
  214.  > Richard Hughes for useful thoughts on discussion group software
  215.  
  216.  > The people at the INFO-ZIP project, for providing the UNZIPAPI
  217.    dynamic link library.
  218.  
  219.  > several individuals (mm, dr,  et al) for good suggestions that
  220.    are now realities
  221.  
  222.  > .... and (of course) Mike Cowlishaw for creating GoServe, and always
  223.    finding time to try and answer.
  224.  
  225.  
  226.                         ************************
  227.  
  228.  
  229. V. Basic copyright and it's never our fault disclaimer:
  230.  
  231.   Copyright 1996,1997,1998, 1999 by Daniel Hellerstein. 
  232.   Permission to use this program for any purpose is hereby granted 
  233.   without fee, provided that the author's name not be used in
  234.   advertising or publicity pertaining to distribution of the software 
  235.   without specific written prior permision.
  236.   With some provisos, this includes the right to subset and reuse the code,
  237.   with proper attribution.
  238.   The provisos are  several fold:
  239.    1)  Portions of the code are adapted from other authors' work
  240.        (these are noted where appropriate); you'll need to contact these other
  241.        authors for appropriate permissions.
  242.    2)  SRE-http uses serveral 3rd party dynamic libraries and executables:
  243.        i) Quercus System's REXXLIB procedure library.  The
  244.           license for REXXLIB gives the author the right to distribute REXXLIB
  245.           without charge.  This right may NOT extend to redistributors.
  246.           Please contact Quercus Systems for details.
  247.       ii) Info-Zip's UNZIPAPI.  Although this is freely
  248.           available software, you may wish to contact Info-Zip for details.
  249.      iii) Jeff Glatt's FILEREXX, which is freely available software
  250.           (a 1995 address is 6 Sycamore Drive East, New Hartford, 
  251.            NY 13413, 315-735-5350).
  252.       iv) Jean-loup Gailly <jloup@chorus.fr> OS/2 port of the GZIP
  253.           file compression utility, which is free GNUware (see
  254.           GZIP.TXT for details)
  255.        v) Ralf G. R. Bergs <rabe@pool.informatik.rwth-aachen.de> provided
  256.           the MD5 program (see README.MD5 for the details).
  257.  
  258.  
  259.   3)  We, the authors of SRE-http and any potenially affiliated institutions,
  260.       disclaim any and all liability for damages due to the use, misuse, or
  261.       failure of the product or subsets of the product.
  262.  
  263.   Furthermore you may also charge a reasonable re-distribution fee for
  264.   SRE-http; with the understanding that this does not remove the
  265.   work from the public domain and that the above provisos remain in effect.
  266.  
  267.     THIS SOFTWARE PACKAGE IS PROVIDED "AS IS" WITHOUT EXPRESS
  268.     OR IMPLIED WARRANTY.
  269.     THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE PACKAGE,
  270.     INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS.
  271.     IN NO  EVENT SHALL THE AUTHOR (Daniel Hellerstein) OR ANY PERSON OR
  272.     INSTITUTION ASSOCIATED WITH THIS PRODUCT BE LIABLE FOR ANY
  273.     SPECIAL,INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
  274.     RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
  275.     OF CONTRACT,NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
  276.     IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE PACKAGE.
  277.  
  278.  
  279.    SRE-http was developed on the personal time of Daniel Hellerstein,
  280.    and is not supported, approved, or in any way an official product
  281.    of my employer (USDA/ERS).
  282.  
  283.  
  284.  
  285.  
  286.