A Little Technology Shoppe - SWISH Configuration File

SWISH-E Configuration File

Last Updated: January 20, 2000

SWISH has the capability to use configuration files to specify all sorts of options for indexing. These options are shown in the sample configuration file below.

PLEASE NOTE:
You should be very familiar with the FileRules section of the configuration file. By default, SWISH will not index files in directories containing a ".htaccess" file. If you have a directory that contains a ".htaccess" file, and would like it indexed- comment out that FileRules line by place a "#" as the first character in the line.

# Sample SWISH configuration file
IndexDir /usr/home/company/usr/local/etc/httpd/htdocs/
# This is a space-separated list of files and
# directories you want indexed. You can specify
# more than one of these directives.
# Be sure to change company to be your Virtual Server login name.

IndexFile /usr/home/company/usr/bin/swish/index.swish
# This is what the generated index file will be.

IndexName "Company Web Page Index"
IndexDescription "This is a full index of the company web site."
IndexPointer "http://www.company.com/cgi-bin/library/searchindex/query.pl"
IndexAdmin "Technical Support (support@company.com)"
# Extra information you can include in the index file.
# You probably want to change the company references.

IndexOnly .html .htm .txt .gif .xbm .au .mov .mpg
# Only files with these suffixes will be indexed.

IndexReport 3
# This is how detailed you want reporting. You can specify numbers
# 0 to 3 - 0 is totally silent, 3 is the most verbose.

FollowSymLinks yes
# Put "yes" to follow symbolic links in indexing, else "no".

NoContents .gif .xbm .au .mov .mpg
# Files with these suffixes will not have their contents indexed -
# only their file names will be indexed.

ReplaceRules replace "/usr/home/company/usr/local/etc/httpd/htdocs" "http://www.company.com"
# ReplaceRules allow you to make changes to file pathnames
# before they're indexed.
# Be sure to change company to be your Virtual Server login name.

FileRules pathname contains admin testing demo trash construction confidential
FileRules filename is index.html
FileRules filename contains # % ~ .bak .orig .old old.
FileRules title contains construction example pointers
FileRules directory contains .htaccess
# Files matching the above criteria will *not* be indexed.

IgnoreLimit 50 100
# This automatically omits words that appear too often in the files
# (these words are called stopwords). Specify a whole percentage
# and a number, such as "80 256". This omits words that occur in
# over 80% of the files and appear in over 256 files. Comment out
# to turn of auto-stopwording.

IgnoreWords SwishDefault
# The IgnoreWords option allows you to specify words to ignore.
# Comment out for no stopwords; the word "SwishDefault" will
# include a list of default stopwords. Words should be separated by spaces
# and may span multiple directives.