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