HELIOS WebShare User manual


6 WebShare WebObjects Server
6.1 About
The WebShare WebObjects Server ("webshare.woa") is a Java program running on a server with an Internet connection. It can be installed on the same machine where the WebShare File Server is installed, in which case it is called a "single server solution". To increase the level of file system security, the WebShare WebObjects Server should be installed on a separate server, in a "two-tier server solution".
Ideally no other applications or services would be running on the WebShare WebObjects Server. This allows the blocking of all ports and services (by software and/or hardware firewalls), except for those required by WebShare.
Due to the fact that no data files are stored or cached on the WebShare WebObjects Server, a high level of WebShare File Server security is ensured. The WebShare WebObjects Server uses one dedicated TCP/IP port for all Web clients, by default 2009.
During the installation of HELIOS WebShare the packed file "websharewoa.tar" is installed in the directory "HELIOSDIR/etc/webshare". The "start-helios" command then extracts the file to the directory "HELIOSDIR/var/run" to the "webshare.woa" folder.
6.2 WebShare WebObjects License information
The WebShare product includes two server components. The WebShare File Server which is licensed on a given HELIOS machine ID (machID) and a WebShare WebObjects Server which may run on a separate server machine. The WebShare WebObjects Server belongs to the WebShare server product and will not require a separate WebShare activation key.
The complete HELIOS software license terms must be accepted during the installation and can be found on the product CD-ROM.
The WebShare WebObjects Server requires an Apple Computer Inc. software product called WebObjects. The WebObjects product needs to be acquired separately and includes its own license terms.
6.3 WebShare WebObjects Server files
The "HELIOSDIR/var/run/webshare.woa" folder contains the following files:
6.3.1 "Contents/Resources/"
Name Function
Accounting.wo/ Accounting HTML page component
AdmLabels.wo/ Label administration HTML page component
AdmPrefs.wo/ Preferences administration HTML page
component
AdmShares.wo/ Sharepoint administration HTML page
component
AdmUsers.wo/ User administration HTML page component
Admin.wo/ Main administration HTML page component
FileBrowser.wo/ HTML component for browsing files and
directories
FilePreview.wo/ HTML component for document and image
previews
Goodbye.wo/ Logout HTML page component
Main.wo/ Login HTML page component
Sharepoints.wo/ Sharepoint listing HTML page component
Upload.wo/ HTML component for uploading files
UserPrefs.wo/ User preferences HTML page component
WebShareStats.wo/ Server statistics HTML page component
Each "*.wo" directory contains the "*.html", "*.wod" and "*.woo" files for the corresponding Web page. They may be localized to the desired GUI (Graphical User Interface) language. 6.4 "Customization/Localization" describes how to localize/customize the WebShare GUI.
The script "sbin/start-websharewoa" starts the WebShare WebObjects Server daemon. Usually, it is started by the "srvutil start websharewoa" command during "start-helios". In case that there should occur some startup problems, it can be started manually to monitor the error messages in a terminal window via:
cd /usr/local/helios
sbin/start-websharewoa
Additional logging is reported to the WebObjects log files. They are located in "HELIOSDIR/var/adm/" and are called "websharewoa.log", with the appendices ".0" (yesterday), to ".6" (seven days ago). All internal WebObjects messages are reported to "websharewoa.log". All HELIOS generated WebShare WebObjects Server messages are reported to the system messages file.
6.4 Customization/Localization

Note: This section is about customizing the "webshare.woa" folder. If no customizing is done, then this section can be ignored.

In order to customize the WebShare WebObjects Server first copy the "webshare.woa" folder from
"HELIOSDIR/var/run" to "HELIOSDIR/var/webshare".
Everytime WebShare is started it looks for "webshare.woa" in "HELIOSDIR/var/webshare". If it cannot be retrieved from there, it is taken from "HELIOSDIR/var/run".
The idea is that "webshare.woa" is replaced en bloque in "HELIOSDIR/var/run", e.g. in case of a software update. Being in "var/webshare", localizations and other adjustments are preserved, when "start-helios" extracts "websharewoa.tar" anew to "HELIOSDIR/var/run".

Note: Please note that Mac OS X may hide the contents of ".wo" folders. In such cases you need to use Ctrl-Open (Show Package Contents) to show the contents of the "webshare.woa" folder, and subsequently of the ".wo" files in the contained Contents > Resources folder, to make the ".wod", ".html" and ".woo" files visible.

6.4.1 Localizing "*.html" files
Localize all "*.html" files, using UTF-8 characters. The WebObjects Builder application can do this by showing the correct layout. You may also use BBEdit, GoLive or any other HTML tool.
6.4.2 Localizing "*.wod" files
Localize all "*.wod" files, using UTF-8 strings. You may localize the strings with any UTF-8 compatible text editor, e.g. BBEdit 7.
6.4.3 Localizing names in the "Actions" pop-up menu
The Color Label items can be localized directly in the "WebShare Color Label Preferences" window. The built-in action names Create Dir, Rename, Permissions can be localized via the preference WSActionNames (6.5 "Preference keys"), using UTF-8 strings.
6.4.4 Localizing action scripts
Custom action scripts are localized by putting #Title=UTFname into the script within the first 5 lines. Refer to 7.4 "WebShare scripts" for details on creating or customizing WebShare custom scripts and action scripts.
6.5 Preference keys
This section lists all the preference keys that are pertinent to the WebShare WebObjects Server. Find a description of how to set, view, change or delete preferences, with the HELIOS "prefdump", "prefvalue", and "prefrestore" utility programs in the HELIOS Base manual, chapter 6, "HELIOS utility programs".

Important: Make sure that preference keys DO NOT start or end with a slash ("/") character, and note that they are case-sensitive!

Key: Programs/websharewoa/<key>
The following keys require a service restart to take effect:
Preference
Type Default (""=no preference stored)
WOPort
int 2009
Specifies the WebShare WebObjects Server port number. Compare TcpPort in 7.8 "Preference keys".
WSHostName
str localhost
Specifies the WebShare File Server default host name prompt for the login dialog. It corresponds to the WebShare File Server entry in the WebShare login menu.
WSAllowedHostNames
str (see text)
List of WebShare File Server host names or IP addresses which are allowed to be used on the WebShare WebObjects Server. The string must be comma-separated if more than one "allowed" host name or IP address is specified. If not set, all host names are allowed.
WSHostPort
int 2010
Specifies the WebShare File Server port number. If more than one WebShare File Server is used, they all have to use the same port.

Note: The value of this preference needs to be identical with the WebShare File Server preference TcpPort (7.8 "Preference keys"). If there should be the need to change a value, then make sure that both preference keys are assigned the same value.

WSTableColor1
WSTableColor2
str #EEEEEE for color 1
str #CCCCCC for color 2
Specifies the WebShare color used for the alternating lines in a table listing, e.g. the "Sharepoint" window. The color is defined by the HTML hexadecimal values of red, green and blue, e.g. #FFFF00 is yellow, #FF000 is red, #00FF00 is green. See Fig. 16 in 5.1 "WebShare File Server login".
WSToolbarColor
str #EEEEEE
Specifies the WebShare toolbar color. The color is defined by the HTML hexadecimal values of red, green and blue, e.g. #FFFF00 is yellow, #FF000 is red, #00FF00 is green. See Fig. 17 in 5.2 "Work in a sharepoint".
WSEventDisplayPassword
str ""
This preference allows specifying a password for a protected HTML page, which allows monitoring the WebShare WebObjects Server and the events it is processing. By default, the page is unavailable until a password is set. For security reasons, this preference should not be used unless you are an WebObjects deployment specialist and you know how the WebShare WebObjects Server and WebObjects work internally.
WSUpDownloadTimeOut
int 86400
The default time-out value for uploads and downloads of the WebShare WebObjects Server is 24 h (=86400 s). If more time is needed, e.g. due to a slow Internet connection, this preference may be set to a higher value.
WSActionNames
str "None,Create Dir,Rename,
Permissions"
Allows localizing the action item names. See 7.3 "WebShare utility programs" for the corresponding scripts.
WOSessionTimeOut
int 3600
Specifies that, after a user has been idle for a time, i.e. no web activity has occurred, the session will automatically be closed after one hour (=3600 s).


© 2004 HELIOS Software GmbH