home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 25 / CDROM25.iso / Share / linux / swish-e / README-AutoSwish < prev    next >
Encoding:
Text File  |  1998-06-06  |  5.1 KB  |  146 lines
  1. THE AUTOSWISH README
  2.  
  3. AUTOSWISH?
  4.  
  5.    AutoSwish is a CGI script that works in conjunction with SWISH-E, and 
  6.    allows you or your users to index a Web site by simply filling out a 
  7.    form. AutoSwish will then automatically write a SWISH-E configuration 
  8.    file, index the directories and files that have been specified, create 
  9.    a cgi script for searching the index, and generate a fully functional 
  10.    search form, which can be used immediately. In just minutes your users 
  11.    can make their WebPages fully searchable and they didn't have to come 
  12.    running to you!
  13.  
  14. SYSTEM REQUIREMENTS
  15.  
  16.    So far AutoSwish has only been tested on the Solaris 2.5.1 and Dec 
  17.    Alpha 3.2 platforms, both using the NCSA HTTPD server. The only specific 
  18.    requirement is that Perl 4 or above be available on your system. 
  19.  
  20. SECURITY
  21.  
  22.    AutoSwish has only the most basic security features. As of this version, 
  23.    these consist of a simple check of submitted form data for unknown variable 
  24.    names or shell metacharacters. In the future I plan to write a perl 5 
  25.    version of AutoSwish which will incorporate the -T tainting option to 
  26.    further decrease the likelihood of anyone trying to issue system commands 
  27.    using the form. 
  28.  
  29.    The installation of AutoSwish requires that you give a number of directories 
  30.    universal permissions (777). This is so that the CGI script, which will run 
  31.    as "nobody" on most systems, can write to them. Because of this, it is essential 
  32.    that you set up an AutoSwish users group and restrict use of the script to 
  33.    members of that group. I have included instructions for doing this with an 
  34.    .htaccess file at the end of the readme.
  35.  
  36. INSTALLATION
  37.  
  38. NOTE: INSTALLATION SHOULD ONLY BE DONE BY THE SYSTEM ADMINISTRATOR!
  39.  
  40. 1. Download and uncompress the AutoSwish files to a temporary directory:
  41.  
  42.       % uncompress autoswish.tar.Z
  43.       % tar -xvf autoswish.tar
  44.  
  45.    You should see the following directory and file names:
  46.  
  47.    SWISH-E/
  48.       AutoSwish/
  49.          index.html
  50.          stopwords.txt
  51.       Images/
  52.          powered.gif
  53.          powered+.gif
  54.          swish-e.gif
  55.          swish-e+.gif
  56.          swishbullet.gif
  57.          swishrule.gif
  58.       SwishForms/
  59.       SwishTest/
  60.    swish_create.pl
  61.    swish_cgi_sub
  62.  
  63. 2. Install the SWISH-E Executable
  64.  
  65.    Follow the instructions in the SWISH-E README for installing the executable. 
  66.    Once this is done create the following two directories in the same directory 
  67.    where SWISH-E resides:
  68.  
  69.       % mkdir -m 777 ConfigFiles SwishIndexes
  70.  
  71. 3. Install the CGI Script
  72.  
  73.    A sub-directory of your CGI directory (usually /usr/local/etc/httpd/cgi-bin/) 
  74.    must be created (swish-bin) and the AutoSwish script installed in its own 
  75.    directory there (SwishCreate):
  76.  
  77.       % mkdir -p swish-bin/SwishCreate
  78.  
  79.    Change swish-bin's permissions so the that script can write to it:   
  80.  
  81.       % chmod 777 swish-bin
  82.  
  83.    Move swish_create.pl & swish_cgi_sub into SwishCreate and make the 
  84.    perl script executable:   
  85.  
  86.       % chmod +x swish_create.pl
  87.  
  88. 4. Install the Web Files
  89.  
  90.    The AutoSwish form and a number of other files must be installed on your 
  91.    Web server. Move the entire SWISH-E directory there from your temporary 
  92.    directory:
  93.  
  94.       %  mv SWISH-E webpath
  95.  
  96.    Where webpath is the path to you principal Web directory. Now change the 
  97.    permissions on the SwishForms sub-directory so that the CGI script can 
  98.    write to it:
  99.  
  100.       % chmod 777 SwishForms
  101.  
  102. 5. Configuration
  103.  
  104.    A number of configuration variables need to be changed in the header of 
  105.    the swish_create.pl script to reflect you particular environment. There 
  106.    are comments there to guide you.
  107.  
  108.    Also two changes must be made to SWISH-E/AutoSwish/index.html. In the 
  109.    editor of your choice change the path of swish_create.pl in all <FORM> tags 
  110.    and change the replace rule paths in the hidden fields on lines 46 and 111 
  111.    to reflect the those on your system.
  112.  
  113. 6. User Access
  114.  
  115.    Create an .htaccess file for the .../swish-bin/SwishCreate directory and 
  116.    limit access to a group named something like "swish-users". The accompanying 
  117.    .htpasswd and .htgroup files should be placed in a SECURE area on your server 
  118.    to avoid security problems. Be sure to create a user ID and password for each 
  119.    individual user or unit so they will only have access to their files. Also, 
  120.    if you would like  to make the SwishTest directory available to guests for 
  121.    demonstration purposes, add a "guest" ID with "test" for a password. For more 
  122.    information on user authentication see: 
  123.  
  124.    http://hoohoo.ncsa.uiuc.edu/docs/tutorials/user.html
  125.  
  126. A FINAL NOTE
  127.  
  128.    AutoSwish is still in the very earliest stages of its development. In it's 
  129.    present form the script is less than streamlined but seems to work just fine. 
  130.    I would, however, appreciate any reports of bugs, installation difficulties, 
  131.    or needed improvements. I can be contacted at khasting@library.berkeley.edu.
  132.    We have also started a discussion list. Subscription information available at:
  133.  
  134.    http://sunsite.berkeley.edu/Discussion/
  135.  
  136. AUTHOR
  137.  
  138.    Kirk V. Hastings
  139.    Library Systems Office
  140.    UC Berkeley Libraries
  141.  
  142.    khasting@library.berkeley.edu
  143.  
  144.    8/12/97
  145.    12/23/97, last update
  146.