>
WebRSH: Help: Options: Directories:
While the main WebRSH script itself can be freely moved and
be executed from any CGI-enabled directory, WebRSH relies on a
certain directory structure which is expected to exist, and is required
for its proper operation. This includes a number of directories where
WebRSH expects to find files that are required for its operation and a
temporary directory where WebRSH writes temporary files. WebRSH also relies
on the availability of certain files (such as images) directly through the
web server. These files reside in a special 'File Sending Directory' which
should be mapped as part of the web server's content space. WebRSH must know
the URL of this directory in order to create links to files that reside in it.
Below we describe the various directories required by WebRSH, and the
permissions WebRSH needs in these directories. Note that when we talk
about WebRSH needing permissions, we mean, of course, that the user
context in which it is running should have these permissions. (This
is not relevant to operating systems lacking a security structure, such
as Windows 95.) Also, note that WebRSH should have write permission to
the main WebRSH script itself since all configuration data is stored in
this script, and that in multi-user installations of WebRSH each user
should be running his own copy of the main WebRSH script.
- Main Program Directory (value of $ProgDir)
- This is the most important directory for WebRSH. It's where most
of WebRSH actually resides and WebRSH can't work at all without having
the correct path to this directory. The 'Main Program Directory' must
have the following subdirectories: 'lib', 'htm', and 'bin'. (In the
current version 'bin' is only used on Win32 platforms.) WebRSH must
have read permission to all of them (and to the files in them) and
execute permission to the 'bin' directory and the files in it. Other
WebRSH directories may also reside as subdirectories
of the 'Main Program Directory', and are so by default (in the shipping
WebRSH archive). However, these directories may also be moved elsewhere
if needed or desired. At least some of them must
be moved elsewhere in multi-user installations of WebRSH, since, at the
minimum, each user must have his own 'Configuration Directory'.
- File Sending Directory (value of $SendFilesDir)
- This is a directory that can be accessed directly through the web server
(namely, it should be mapped as part of the web server's content space),
and is used to place files (such as images) that constitute parts of WebRSH's
output. In the current version the core WebRSH does not need any access
permission to this directory. However, such access may be needed in future
versions and may be needed by some plugins. It is thus recommended for
WebRSH to have both read and write permission to this directory and to
the files in it.
- File Sending URL (value of $SendFilesUrl)
- This is the URL (or URI) of the above 'File Sending Directory', namely,
the path by which it is recognized by the web server. It is recommended
to set it up as a URI relative to the web server root (namely, something
that starts with a '/' like '/sfdir'). However, it can also be an absolute
URL of the form http://server.name.domain/sfdir, as may be needed if WebRSH
itself is being served by a different server.
- Home Directory (value of $HomeDir)
- This is the default working directory for WebRSH. It must be set to a
valid directory, and WebRSH must have sufficient permissions to make it a
working directory (On UNIX platforms this essentially means execute permission).
- Configuration Directory (value of $CfgDir)
- This is the directory in which WebRSH configuration and 'state'
files are stored. In multi-user installations of WebRSH each user
must have his own 'Configuration Directory'. In the
current version this directory contains two files. The 'mimetable.txt'
file which contains WebRSH's MIME table, and the 'rshinidat.txt' file
which stores the WebRSH counter and clipboard information. WebRSH
must have both read and write permissions to this directory and to
the files in it.
- Temporary Directory (value of $TempDir)
- This is the directory to which WebRSH writes temporary files. Such
temporary files get written whenever files are being uploaded and whenever
'Save As' is used in the Text Editor. It is strongly recommended for this
directory to reside on the same disk partition to which files are most
likely to be written. It is also recommended that, in multi-user installations
of WebRSH, each user will have his own 'Temporary Directory'. WebRSH
must have both read and write permissions to this directory.
- PlugIn Directory (value of $PlugInDir)
- This is the directory where 'user plugins' should reside.
WebRSH needs read permission to this directory and to the files in it, as well
as the permission to make this directory a working directory (namely, on UNIX
platforms, WebRSH needs execute permission to the directory). More permissions
may be required in the event that any of the plugins requires them.