FileGate release notes
======================

What is this?
-------------

FileGate is a simple Web application that allows browsers to interact
with an FTP server, for uploading and downloading files. This may be
useful in places where direct FTP access is not allowed. 

FileGate is intended to be used with the Tomcat servlet engine, although
any J2EE-compliant JSP/servlet-enabled Web browser should work.

Installation
------------

With Tomcat, installation has three steps

1. Copy the application archive, filegate.war, to the Tomcat `webapps'
directory.

3. Check the settings in the configuration file filegate.props and
copy it to Tomcat's current directory (note that FileGate reads this
file by doing a straight file read, and it will not prepend
any path. Typically it needs to be installed in whatever directory
you run Tomcat from).

2. Re-start Tomcat


Configuration file
------------------

The config file has the following entries.

USER_ROLE=some_role
J2EE role that the user must be in to use this application at all.
If this entry is not given, this check is not enforced. This
is provided primarily to allow this application to be used in
single-sign-on mode with other applications. 

ADVANCED_USER_ROLE=some_role
A user in this role is allowed to set the FTP server to which the
utility connects. If not given, any user can do this.

VERBOSITY=1
Can be 0 (only fatal errors logged), 1 (serious errors logged), or
2 (lots of logging)

DEFAULT_METHOD=FTP
File transfer method. Currently only FTP is supported

DEFAULT_HOST=lars
Should be self-explanatory

MAX_UPLOAD=100000
Maximum upload size in bytes. This should be small compared with 
the maximum memory available to the servlet engine.


Notes
-----

1. Some FTP servers provide `.' and `..' as directories when doing a directory
listing, while others don't. FileGate always provides an `up' link where the
current directory is not the root of the filesystem, as it can't rely on the
underlying server to do so. However, if the FTP server does provide, for example, a `..', then there will be _two_ uplinks.

2. At present, only the default FTP port (21) can be used.