Having fulfilled the prerequisites (Perl 5.002 or higher and Wais.pm
2.108 or higher) you have to unpack the distribution. Then you can run the
make script which determines some system properties, and
asks you some questions about the installation. After this the
executable can be made, tested and installed. Your last step is to
configure your HTTP server, so that it can call SFgate.
Since SFgate is written in Perl the first thing you need is a perl interpreter, version 5.002 or higher (see section 2.2 Perl). You don't have it already? So what are you waiting for, it's a really nice and usefull piece of software;-)
Next thing is to install the Perl module Wais.pm (see section 2.4 The Perl Module Wais.pm). Installation really is straightforward, but notice that you need the freeWAIS-sf source tree to link this Perl extension. Look at the README of Wais.pm for installation instructions.
`SFgate-5.1.tar.gz' is a tar archiv compressed with
GNU gzip. Unpack it with the following command:
gunzip -c SFgate-5.1.tar.gz | tar xvf -
The distribution will unpack to the directory `./SFgate-5.1'.
The first think you might want to do is to set the perl binary to be
used from SFgate. If the correct one is on your path you needn't to do
anything. Else you should edit the `Makefile' and set the
PERL variable to the correct value.
Then, typing
make
the first time starts the configuration for SFgate. First some system properties are determined. Following are a few questions concerning installation directories, HTTP virtual directories and so on. Default values are given in braces.
You might want to reuse your `config.sh' from older revisions of SFgate to avoid the question section. To do that just copy the old configuration file to the SFgate directory and issue a
make show
to have a reinitialization of some values. After this you can proceed with
make make test make install
SFgate comes with some libraries which have to be installed in a directory where Perl can find them. Usually this is determined by Perl itself so it might be a good choice to use the default. But if you can't do installation within the Perl installation tree you can specify another directory.
Where should the Perl libraries go [/usr/local/ls6/perl/lib/site_perl]?
With SFgate comes SFproxy (see section `Overview' in The SFproxy Manual). Perhaps there will be some more utilities in future SFgate releases. Now you're asked to specify a directory where these utilities should be installed. As in the case of the libraries SFgate makes a good proposition. But you can specify another directory.
Where should the Perl utilities go [/usr/local/ls6/perl/bin]?
Using the Wais extension, you can make use of the local search facility (see section 5.4 Databases). To search databases locally, SFgate needs to know the name of the database with the complete path. Here you can enter the default directory of your WAIS databases so that you can specify your databases by name only within your SFgate applications.
To simplify the specification of (local) databases in your SFgate application forms enter the default directory where SFgate can find the local wais databases. If you don't want to use a default directory answer with 'none'. What is the default path to the local wais databases [/home/robots/wais/wais-sources]?
SFgate has a build in HTTP client (see section 5.7.4 Direct WWW URLs) which can use a proxy.
The next question is about your desired http proxy. SFgate has a buildin http client, which can use a proxy. If you don't have a proxy server or you don't want to use it, answer 'none'. What is your http proxy [none]?
If you want to use a HTTP proxy, specify the port:
What's the port of your HTTP proxy [80]?
Should be set to the directory where your HTML pages reside.
Where do your html pages reside [/home/robots/www/pages]?
Specify the document directory for SFgate. The real Installation directory for the demos, the documentation and some icons will be the concatenation of your HTML page directory and this document directory.
Where - relative to /home/bib2/goevert/pages/ - should the documentation go [SFgate]?
Specify the virtual name of your document directory for SFgate. The virtual name is used within URLs to specify HTML documents, e.g. `http://your.http.server/SFgate/demo.html'.
Virtual name means the name you want to use in URLs, for example in 'http://somehost/SFgate/demo.html' the virtual name of the document directory is '/SFgate' What is the virtual name of /home/robots/www/pages/SFgate [/SFgate]?
Set this to the directory where your CGI scripts reside and where the executable SFgate should be installed. Later in the installation section you have to announce this directory to your HTTP server as a directory containing executable scripts (if not done already for other CGIs).
Where is your real CGI dir [/home/robots/www/pages/cgi-bin]?
As with the virtual name of your SFgate document directory the virtual name for your CGI directory is used in URLs to call CGI Scripts, e.g. `http://your.http.server/htbin/SFgate'.
What is the virtual name of /home/robots/www/pages/cgi-bin [/htbin]?
For layout purposes you can specify pieces of html code which are inserted in the header respectivly in the footer of every html page created by SFgate (see section 5.6.1.1 Page Headers and Footers). SFgate searches these pieces of html in files residing in the application files directory.
Configuration for attribute mapping in context with heterogeneous databases (see section 6 Heterogeneous Databases) is done in this directory, too.
In which directory should the application files go [/home/robots/www/etc/SFgate]?
Specify the directory in which the logfile `SFgate.log' will go (see section 5.7.2 Obtain Logging Information). Take into consideration that your HTTP server should have write permission in that directory.
In which directory should the logfile SFgate.log go [/home/robots/www/log]?
After having answered all questions concerning the SFgate configuration you are asked to register yourself as an SFgate user. You are prompted to send us a mail, which includes you SFgate configuration. Registration is done just because of our curiosity. A second reason is that we can better do support if you have problems with SFgate and we've already your configuration.
To get an idea of how often and where SFgate is used we would like you to send us a registration mail. Note that this will *never* become a licensing scheme or some crazy thing like that. It's just our curiosity. Send registration mail to sfgate@ls6.informatik.uni-dortmund.de (y/n)[y]?
If you like SFgate you may want to flood us with gifts. The first thing you could do is to send us a picture postcard of your city. We collect and exhibit them on:
`http://ls6-www.informatik.uni-dortmund.de/ir/projects/SFgate/album/'
Send your card to the following address:
Norbert Gövert, Ulrich Pfeifer
University of Dortmund
Computer Science Department, LS VI
August-Schmidt-Straße 12
D-44221 Dortmund
After you have answered the questions, a `config.sh' is created which holds all of the configurations. If you want to change anything of the configuration just edit the file or go through the question section once again:
make configure
Then all your inputs from the prior configuration are shown as defaults to the questions.
If you just want to see your configuration you should do a
make show
To make the SFgate executable, just type another
make
Type
make test
to do some little tests on your SFgate. They connect to the freeWAIS-sf server on `ls6-www.informatik.uni-dortmund.de'. If these tests fail, consider that there can be many reasons, e.g. the connected database (`wais-docs') could have changed or your machine has not full internet access. If the test output looks adequat (see the files `test/is.1' and `test/is.2'), you may proceed and do your own tests with `demo.html'.
If the tests suceeded, install the software:
make install
The software and demo files are copied to the directories you specified within the configure run.
At this point you just have to configure your HTTP server to make him execute SFgate. Then you can start using SFgate.
If you are running CERN HTTPD, announce SFgate to your server by editing
the config file (called `httpd.conf' in most installations). If you
had set your real CGI directory to `/example/real/dir/cgi-bin' and
your virtual CGI directory to `/example/virtual/dir/htbin' within
Makefile.PL, the following lines should be in your configuration
file:
exec /example/virtual/dir/htbin/* /example/real/dir/cgi-bin/*
This annouces the `/example/real/dir/cgi-bin' directory to your server.
You can get more info from the WWW Consortium (`http://www.w3c.org/').
If you are running the NCSA Server, announce SFgate to your server by
editing the config file (called `srm.conf' in most
installations). If you had set your real CGI directory to
`/example/real/dir/cgi-bin' and your virtual CGI directory
to `/example/virtual/dir/htbin' within Makefile.PL, the following line
should be in your configuration file:
ScriptAlias /example/virtual/dir/htbin /example/real/dir/cgi-bin
This annouces the `/example/real/dir/cgi-bin' directory to your server.
Get more info from NCSA (`http://www.ncsa.uiuc.edu/Indices/WebTech/').