Installing the Staff ClientYou can install the Staff Client from pre-built images and packages without actually having to first build it. Pre-built packages are currently available
for Windows, Mac OS X, and Linux. If you need to manually build
the Staff Client, see .Installing a Pre-Built Staff ClientThis section reviews the process of installing pre-built versions of the Staff Client in various environments.Installing on WindowsA standard Windows installer that contains the current version of the Staff Client is available from the downloads section
of the Evergreen website at http://www.evergreen-ils.org/downloads.php. Download the Staff Client installer,
then run it.Click Next to continue through the guided install process. The install wizard will ask you to agree to the end-user license, ask you where to
install the software, ask about where to place icons, and then will install the software on your workstation.When you run the Staff Client for the first time, a screen similar to this should appear:First, configure the server you would like to connect to in the Server section. For example, the PINES demo system is
demo.gapines.org. After selecting a server, click Re-Test Server.Because this is the initial run of the Staff Client, the Workstation section in the upper-right states: Not
yet configured for the specified server. The first thing that must be done to the Staff Client on every workstation is to assign it a workstation name. This is
covered in .Installing on Mac OS XA Mac OS X package that contains the current version of the Staff Client is available for use with
"xulrunner".Evergreen Indiana Pkg file [Evergreen v1.2.3.0]Download and install the latest version of "xulrunner" for Mac OS X. Release notes
for the latest version can be found here:
http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes.
Note, later versions may not work correctly.Download and install the Mac OS X Installation package for the 1_2_3_0 Version Staff Client from
http://evergreen.lib.in.us/opac/extras/files/evergreen_osx_staff_client_1_2_3.zip.To upgrade to a more recent version of the Staff Client, you can copy the directory build from a working
Windows installation of the desired version of the Staff Client to your Mac. The required files may be located in
a directory like this on the Windows machine: C:\Program Files\Evergreen Staff Client\build
. Copy these files into the folder Resources within the Open-ILS package in your Applications directory on
the Mac, overwriting files with the same names.Drag the application's icon into your toolbar for easier access.Click Continue, accept the license, then finish the installation. The application will be located at the destination you selected
during installation. You will then be able to drag the application into your toolbar for easier access.Running directly using "xulrunner"You must install an appropriate version of "xulrunner" to match the Evergreen version. See the following table for the recommended
version of xulrunner:
Evergreen / XULRunner DependenciesEvergreen 1.6.x.xXULrunner 1.9Evergreen 1.4.x.xXULrunner 1.8.0.4 or XULrunner 1.8.0.3Evergreen 1.2.x.xXULrunner 1.8.0.4 or XULrunner 1.8.0.3
If you have issues removing previously installed xulrunner versions see
for information on removing previous "XULRunner" versions.The Staff Client data from the directory ./staff_client/build must be placed somewhere on the machine (e.g.
~/Desktop/Evergreen_Staff_Client). Remember to call XULRunner with the full path to the binary, followed by
the install command and the path to the client data:/Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_ClientThis command should exit quietly. A folder will be created, named /Applications/OpenILS, containing a launcher
named open_ils_staff_client.Removing previously installed xulrunner versionsIf you already have a newer version installed, per the release notes, you will need to remove the entire directory
/Library/Frameworks/XUL.framework before downgrading.In addition, you may also need to remove the previous file /Library/Receipts/xulrunner-ver-mak.pkg.If there is no file /Library/Receipts/xulrunner-ver-mak.pkg (possibly in newer OSX releases) you need to flush the file
receiptdb.If you install a newer version over a previous (older) install, the older one is not removed but the symlinks get changed to the newer one.First, get the package identifier, then purge/forget the build that was initially installed:sudo pkgutil --pkgs > /tmp/pkgs.txtsudo pkgutil --forget org.mozilla.xulrunnerIt may not be necessary to edit the file /Library/Receipts/InstallHistory.plist after deleting the folder
XUL.framework.Creating an APP file: Staff Client & "xulrunner" BundledAn APP file is basically a folder. Start with a folder structure like this:
* Evergreen.app
* Contents
* Frameworks
* Resources
* MacOS
Create an APP folder structure with the following commands:mkdir -p Evergreen.app/Contents/Frameworksmkdir -p Evergreen.app/Contents/Resourcesmkdir -p Evergreen.app/Contents/MacOSCreate a new file in the folder Evergreen.app/Contents/Info.plist containing the following data (adjust for your
version of Evergreen):CFBundleExecutablexulrunnerCFBundleGetInfoStringOpenILS open_ils_staff_client rel_1_6_0_7CFBundleInfoDictionaryVersion6.0CFBundleNameEvergreen Staff ClientCFBundlePackageTypeAPPLCFBundleShortVersionStringrel_1_6_0_7CFBundleVersionrel_1_6_0_7.rel_1_6_0_7NSAppleScriptEnabledCFBundleTypeIconFileEvergreen.icns
]]>Download and install an appropriate Mac OS Xpackage of "XULRunner" from
the Mozilla website (see above for recommendations).Make a copy of /Library/Frameworks/XUL.Framework inside your APP file. It should look something like this:
* Evergreen.app/
__* Contents/
____* Frameworks/
______* XUL.Framework/
______* Versions/
________* Current -> 1.9.1.3 (symlink)
________* 1.9.1.3/
______* XUL -> Versions/Current/XUL
______* libxpcom.dylib -> Versions/Current/libxpcom.dylib
______* xulrunner-bin -> Versions/Current/xulrunner-bin
Copy XUL.Framework/Versions/Current/xulrunner into Evergreen.app/MacOS
(do not symlink; copy the file).Make Evergreen.app/Resources the root of your Evergreen application files like this:
* Evergreen.app/
__* Contents/
____* Resources/
______* BUILD_ID
______* application.ini
______* chrome/
______* components/
______* etc.
Put a Mac format icon file named Evergreen.icns in Resources.Installing on LinuxQuick Upgrade of the Staff ClientA Linux Staff Client is automatically built on the server as part of the normal
make install process for Evergreen server-side software. To upgrade the Staff Client on a remote workstation with a new version,
just copy the directory tree containing the Staff Client from the server to the remote workstation.The following example assumes you already have an opensrf user account on both the server and the
remote workstation. Remember to replace user, client.linux.machine and eg-client-x.x.x.x with
the proper user name, client machine name, and
version number in the following example.As the opensrf user, change directory to the Staff Client source directory, then recursively copy
the entire directory tree to the remote workstation:cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_clientscp -r build user@client.linux.machine:~/eg-client-x.x.x.x/To test the newly copied Staff Client, as the opensrf user log into the remote workstation and execute
it as shown:xulrunner ~/eg-client-x.x.x.x/build/application.iniBuilding the Staff Client on the ServerA Linux Staff Client is automatically built on the server as part of the normal
make install process for Evergreen server-side software.In order to install a compatible Staff Client on another Linux system, just copy the applicable files from
the server to that system, or even manually build it on that system. Ensure that the BUILD_ID you choose on the server matches the BUILD_ID for each Staff
Client you use on other systems.If you will be using a pre-packaged Windows version on some systems, you may want to choose the BUILD_ID
on both server and other versions to match that of the Windows Staff Client. To determine which BUILD_ID is used
in an existing Staff Client installation, just click About this Client on the running Staff Client.If you are allowed to make changes on the Evergreen server, another option is to create a symbolic link. In order for a copy of the Staff Client and
server to work together, the BUILD_ID must match the name of the directory containing the server components of the Staff Client, or the name of a symbolic
link to that directory.cd /openils/var/web/xulln -s SERVER_BUILD_ID/ CLIENT_BUILD_IDBuilding the Staff Client on the client MachineThis section is directed toward end-users who wish to use Linux rather than
Windows for client machines, but have limited Linux experience. You can
build the Staff Client on a Linux system without installing the Evergreen Server component. This is a relatively
simple process compared to server installation, but does require some command-line work. The following directions are for building Staff Client version
1.2.1.4 on Kubuntu 7.10; you must modify them for other distributions (the instructions should work as-is for
Ubuntu or Debian derivatives).PrerequisitesBoth "subversion" and "xulrunner" are required to build the Staff Client.
As the root user, use "apt-get" to install packages
for "subversion" and "xulrunner". You can also use "synaptic",
the graphical user interface for "apt-get". For "subversion", select the latest
version; for "xulrunner", select version 1.8.1.4-2ubuntu5.sudo apt-get install subversionsudo apt-get install xulrunnerDownload the Source CodeDetermine which version is neededFor most end-users, a specific version is required to communicate properly with the Evergreen server. Check with your
system administrator, IT person, or HelpDesk to determine which Staff Client versions are supported.Next, you need to determine which tag to use when downloading the source code. Tags are markers in the
source code to create a snapshot of the code as it existed at a certain time; tags usually point to tested and stable code, or at
least a community-recognized release version.To determine which tag to use, browse to
http://svn.open-ils.org/trac/ILS/browser. Look in the
Visit drop-down box; see the list of Branches and, further down, a list of Tags. You may have to do some
guesswork, but it is fairly straightforward to determine which tag to use. If the server is version 1.2.1.4, you will want to use the
tag that looks most appropriate. For example, as you look through the tag list, notice the tag named 'rel_1_2_1_4'. This is the
tag you need; make a note of it for the next step.Download the CodeAs the opensrf user, open a terminal (command-line prompt) and navigate to the directory
in which you wish to download the Staff Client. Use the following commands to download the proper version of the source code by tag
name:cd /YOUR/DOWNLOAD/DIRECTORYsvn co svn://svn.open-ils.org/ILS/tags/rel_1_2_1_4/Remember to change rel_1_2_1_4 to the appropriate tag for your installation.Build the Staff ClientEvergreen 1.2.xIn the following example, navigate to the directory in which the source code was downloaded, then navigate to the proper subdirectory and
run the make utility to actually build the Staff Client. Remember to check with your system administrator about which
Staff Client BUILD_ID to use. The server checks the Staff Client BUILD_ID against itself to determine whether or not a connecting client
is supported. For instance, for the PINES installation (version 1.2.1.4) the supported BUILD_ID is rel_1_2_1_4. Modify
the following commands accordingly.As the opensrf user, run the following commands to build the Staff
Client:cd /YOUR/DOWNLOAD/DIRECTORYcd Open-ILS/xul/staff_clientmake STAFF_CLIENT_BUILD_ID='rel_1_2_1_4'
...
Evergreen 1.4.xThe 1.4 series of Evergreen has complicated the build process for the Staff Client a bit. If you downloaded a .tar.gz (compressed
tar archive) of Evergreen, then your steps will resemble the following:FIXME -- Need instructions for getting certain Javascript files from OpenSRF, preferably without actually installing OpenSRF.
wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.4.0.4.tar.gztar xfz Evergreen-ILS-1.4.0.4.tar.gzcd Evergreen-ILS-1.4.0.4/./configure --prefix=/openils --sysconfdir=/openils/confcd Open-ILS/xul/staff_client/make STAFF_CLIENT_BUILD_ID='rel_1_4_0_4' installIf you're installing from a Subversion checkout:svn co svn://svn.open-ils.org/ILS/tags/rel_1_4_0_4/cd rel_1_4_0_4./autogen.sh # If you downloaded a .tar.gz of Evergreen, you may skip this step
./configure --prefix=/openils --sysconfdir=/openils/confcd Open-ILS/xul/staff_client/make STAFF_CLIENT_BUILD_ID='rel_1_4_0_4' installRun the Staff Client (from the command line)As the opensrf user, navigate to the directory build/
(not staff_client/) and run the following command:xulrunner application.ini(OPTIONAL) Cleaning Up / Creating ShortcutsThe source code download included many files that are needed to build the Staff Client, but are not necessary to run it. You may
wish to remove them to save space, or to create a clean directory containing the built Staff Client that can be copied to other machines. To
create a clean "staging" directory in which to place the finished Staff Client, issue the following commands:mkdir ~/<Destination Directory>cd ~/<Download Directory>/Open-ILS/xul/cp -r staff_client ~/<Destination Directory~/>Finally, test the Staff Client to verify that all the necessary files were moved to the destination directory:cd ~/<Destination Directory>/staff_client/buildxulrunner application.iniIf there were no problems, then finish the cleanup by removing the original download directory and all subdirectories:rm -r -f ~/<Download Directory>Finally, test the copied Staff Client. You can create "Desktop / Start Menu / K-Menu" shortcuts for the Staff Client by using the following command as the target:xulrunner ~/<Destination Directory>/staff_client/build/application.iniUsing "Wine" to Install On LinuxThe Linux application "Wine" is another alternative for those who wish to install the
packaged Windows versions rather than building the Staff Client manually. "Wine" is a
Linux application that allows users to directly run Windows executables, and is a simple
way for casual Linux users to use the Staff Client. More information about "Wine" can be found at
http://www.winehq.org/site/docs/wineusr-guide/getting-wine.As the root user, use "apt-get" to install the package for "Wine".
You can also use "synaptic", the graphical user interface.Install "Wine"sudo apt-get install wineDownload Windows installer for the Staff ClientAs the opensrf user, run the following commands to download the Windows installer for the proper Staff Client from the open-ils.org website and place it in a temporary directory:cd /YOUR/DOWNLOAD/DIRECTORYwget http://open-ils.org/downloads/evergreen-setup-rel_version-number.exeRun the downloaded Windows installerAs the opensrf user, navigate to the directory where you downloaded the
Windows executable file, then execute it:cd /YOUR/DOWNLOAD/DIRECTORYwine evergreen-setup-rel_version-number.exeIf this step fails, you may need to configure Wine first to properly emulate WindowsXP. To do so, type
the command winecfg from the command line; in the Applications tab of the window that pops up,
select Default Settings and choose Windows XP from the drop-down menu, then click
Apply.Launch the Staff ClientA new entry for the Staff Client should now appear somewhere in the All Applications menu of your
Linux desktop. Also, find a new desktop shortcut for the Staff Client. To launch the Staff Client, visit
the All Applications menu, find a section similar to WineProgram FilesEvergreen Staff ClientEvergreen Staff Client, or else launch the Staff Client from the desktop shortcut.Running the Staff Client over an SSH TunnelThe Staff Client can use an SSH tunnel as a SOCKS 5 proxy. For more details, see .Assigning Workstation NamesThe Staff Client must be assigned to a library and given a unique name before it will connect fully to the Evergreen server. The only restriction is that the
workstation's name must be unique within the assigned library. Make sure to select a workstation name that you will remember later, and reflects the role, purpose, and/or
location of a particular computer. These names will come up later in statistical reporting, and can also be handy when troubleshooting.In order to assign a workstation a name, a user with appropriate permissions must login to the Staff Client. In PINES, the local system administrator (OPSM) has the
ability to assign workstation names in his or her library system. Library managers (LIBM's) have the ability within their branch. To assign a workstation a name, login to
the system. You will be prompted to assign the workstation a library and a name:Select the library this workstation physically operates in from the drop down menu. In this example, we have selected MGRL-MA. Type in a friendly name
for the workstation. In this example, we are installing the Staff Client on the director's personal system, and have named it as such. Then hit
Register.Once you have registered your workstation with the server, your screen will look like this:You are now ready to log into the Staff Client for the first time. Type in your password again, and hit Login.Manually Building the Staff ClientThis section reviews the process of manually building the Staff Client in various environments.The Staff Client is automatically built by default as part of the normal make install process for Evergreen server-side software. See
to review details related to building the Staff Client in the final compile/link/install phase of the default Evergreen
build process.Building the Staff ClientYou can also manually build the Staff Client by using the make utility in the Staff Client source directory (e.g., the directory
/home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client for the current Evergreen version). There are a number of possible options
to manually build special versions of the Staff Client on a Linux system. Following is a list of environment variables that can be passed
to make to influence the manual build process:Option STAFF_CLIENT_BUILD_IDDuring the normal make install Evergreen server-side software build process, the variable defaults to an automatically generated
date/time string, but you can also override the value of BUILD_ID.The following commands could be used during the normal build process:cd /home/opensrf/Evergreen-ILS-1.6.0.7make STAFF_CLIENT_BUILD_ID=rel_1_6_0_7 installThe following commands will manually build the Staff Client using a different BUILD_ID.As the opensrf user, change directory to the Staff Client source directory, then set the variable and
build the Staff Client:cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_clientmake STAFF_CLIENT_BUILD_ID=my_test_id build
...
Option STAFF_CLIENT_VERSIONDuring the normal make install Evergreen server-side software build process, the variable is pulled automatically from a README file in
the Evergreen source root. The variable defaults to 0trunk.revision, where the value of revision is automatically generated. You
can override the value of VERSION similarly to the BUILD_ID.The following commands could be used during the normal build process:$ cd /home/opensrf/Evergreen-ILS-1.6.0.7$ make STAFF_CLIENT_VERSION=0mytest.200 install
...
The following commands will manually build the Staff Client using a different VERSION.If you plan to make extensions update automatically, the VERSION needs to conform to the format recommended in
Toolkit Version Format and newer versions need to be higher
than older versions.As the opensrf user, change directory to the Staff Client source directory, then set the variable and build the
Staff Client:cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_clientmake STAFF_CLIENT_VERSION=0mytest.200 buildOption STAFF_CLIENT_STAMP_ID variableDuring the normal make install Evergreen server-side software build process, this variable is generated from STAFF_CLIENT_VERSION.
You can override the value of STAMP_ID similarly to the BUILD_ID.The following commands could be used during the normal build process:cd /home/opensrf/Evergreen-ILS-1.6.0.7make STAFF_CLIENT_STAMP_ID=my_test_stamp installThe following commands will manually build the Staff Client using a different STAMP_ID.It is possible to have multiple versions of the Staff Client by specifying a different STAMP_ID for each, possibly for different uses or
client-side customizations.As the opensrf user, change directory to the Staff Client source directory, then set the variable and
build the Staff Client:cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_clientmake STAFF_CLIENT_STAMP_ID=my_test_stamp buildAdvanced Build OptionsIn addition to the basic options listed above, there are a number of advanced options for building the Staff Client. Most are target names for
the make utility and require that you build the Staff Client from its source directory. See the following table for a list of possible
make target keywords:
Keywords Targets for "make" CommandKeywordDescriptionclientsRuns "make win-client", "make linux-client", and "make generic-client" individuallyclient_dirBuilds a client directory from the build directory, without doing a rebuild. The same as "copy everything but server/".client_appPrerequisite "client_dir"; removes "install.rdf" from client directory so an APP bundle can't be installed as an extensionclient_extPrerequisite "client_dir"; remove "application.ini", "autoupdate.js", "standalone_xul_app.js" from client directory so an
extension won't break FirefoxextensionPrerequisite "client_ext"; rewritten to use "client_ext"generic-clientPrerequisite "client_app"; makes an XPI file suitable for use with "xulrunner --install-app""win-xulrunnerPrerequisite "client_app"; adds Windows xulrunner to client buildlinux-xulrunnerPrerequisite "client_app"; adds Linux xulrunner to client buildwin-clientPrerequisite "win-xulrunner"; builds "setup exe" (requires that "nsis" package be installed, will add options for
automatic update if configured and developer options if client build was a "make devbuild")linux-clientPrerequisite "linux_xulrunner"; builds a "tar.bz2" bundle of the Linux client[generic-|win-|linux-|extension-]updates[-client]Calls external/make_updates.sh to build full and partial updates generic/win/linux/extension prefix limit to
that distribution; Adding the string "-client" builds clients and copies them to a subdirectory of the directory
updates as well; the target "extension-updates-client" doesn't exist.
Descriptions of other special build options follow:Developer BuildYou can create a so-called "developer build" of the Staff Client by substituting devbuild for build
when running make. The build will contain an extra configuration file that enables some developer options.As the opensrf user, run make from the Staff Client source directory:Commands to do a "developer build"cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_clientmake devbuildCompressed JavascriptYou can execute the Google application "Closure Compiler" to automatically review and compress Javascript code after the
build process completes, by substituting compress-javascript for build when running make.
For more information see Google "Closure Compiler".As the opensrf user, run the following commands from the Staff Client source directory:cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_clientmake compress-javascriptYou can also combine Javascript review and compression, and also perform a "developer build".As the opensrf user, run the following commands from the Staff Client source directory:cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
# order of options is important!
make devbuild compress-javascriptAutomatic Update HostThe host used to check for automatic Staff Client updates can be overridden by specifying the AUTOUPDATE_HOST option.
The following commands could have been used during the normal build process:cd /home/opensrf/Evergreen-ILS-1.6.0.7make AUTOUPDATE_HOST=localhost installYou can manually set AUTOUPDATE_HOST to set up automatic update checking. The following commands will manually build the Staff
Client using a different AUTOUPDATE_HOST.As the opensrf user, change directory to the Staff Client source directory, then set the
variable and build the Staff Client:cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_clientmake AUTOUPDATE_HOST=localhost buildFor more information on Automatic Updates, see .Installing and Activating a Manually Built Staff ClientThe Staff Client is automatically built, installed and activated as part of the normal make install process for Evergreen server-side
software. However, if you manually build the Staff Client, then you need to take additional steps to properly install and activate it. You also have the option
of installing the Staff Client on the same machine it was built on, or on a different machine.Assuming you have already built the Staff Client, and that your installation is in the directory /openils/var/web/xul,
as the opensrf user, change directory to the Staff Client source directory, then execute the following commands:cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_clientmkdir -p "/openils/var/web/xul/$(cat build/BUILD_ID)"cp -R build/server "/openils/var/web/xul/$(cat build/BUILD_ID)"Packaging the Staff ClientOnce the Staff Client has been built, you can create several forms of client packages by using some targeted make commands in the Staff
Client source directory.Packaging a Generic ClientThis build creates a Staff Client packaged as an XPI file to use with XULRunner. It requires that you already have
the "zip" utility installed on your system. It will create the output file evergreen_staff_client.xpi,
suitable for use with the XULRunner option .As the opensrf user, change directory to the Staff Client source directory,
then execute the following commands:cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_clientmake generic-clientPackaging a Windows ClientThis build creates a Staff Client packaged as a Windows executable. It requires that you already have
the "unzip" utility installed on your system. It also requires that you install NSIS
(Nullsoft Scriptable Install System), a professional open source utility package used to create Windows
installers (the "makensis" utility is installed as part of the "nsis" package). We recommend using
Version 2.45 or later. This build will create the output file evergreen_staff_client_setup.exe.(OPTIONAL) If you wish for the Staff Client to have a link icon/tray icon by default, you may wish to provide a pre-modified
xulrunner-stub.exe. Place it in the Staff Client source directory and "make" will automatically use it instead
of the one that comes with the downloaded XULRunner release. The version of xulrunner-stub.exe need not match
exactly.(OPTIONAL) You can also use a tool such as Resource Hacker to embed icons.
Resource Hacker is an open-source utility used to view, modify, rename, add, delete and extract resources in 32bit
Windows executables. See the following table for some useful icon ID strings:
Useful icon ID stringsIDI_APPICONTray icon32512Default window icon
As the opensrf user, change directory to the Staff Client source directory, then execute the following commands:cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_clientmake win-clientPackaging a Linux ClientThis build creates a Staff Client package for Linux as a "tar.bz2" file with
XULRunner already bundled with it. It creates the output file evergreen_staff_client.tar.bz2.As the opensrf user, change directory to the Staff Client source directory, then execute the
following commands:cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_clientmake linux-clientPackaging a Firefox ExtensionThis build requires that you already have the "zip" utility installed on your system. It creates a
Staff Client packaged as a Firefox extension and creates the output file evergreen.xpi.As the opensrf user, change directory to the Staff Client source directory, then
execute the following commands:cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_clientmake extensionStaff Client Automatic UpdatesIt is possible to set up support for automatic Staff Client updates, either during the normal Evergreen server-side build process, or by manually
building the Staff Client with certain special options.WARNINGSAutomatic update server certificate requirements are more strict than normal server requirements. Firefox and
XULRunner will both ignore any automatic update server that is not validated by a trusted certificate authority.
Servers with exceptions added to force the Staff Client to accept them WILL NOT WORK.In addition, automatic updates have special requirements for the file update.rdf:It must be served from an SSL server, orIt must be signed with the McCoy tool.You can pre-install the signing key into the file install.rdf directly, or install it into a copy as
install.mccoy.rdf. If the latter exists it will be copied into the build instead of the original file
install.rdf.Autoupdate HostThe name of the automatic update host can be provided in either of two ways:At configuration time for the normal build of the Evergreen server-side software, orDuring a manual Staff Client build process.At configuration time for the normal build of Evergreen server-side softwareThis must be done when the Evergreen server-side software is first configured (see ).
As the opensrf user, use the configure utility as shown:cd /home/opensrf/Evergreen-ILS-1.6.0.7./configure --prefix=/openils --sysconfdir=/openils/conf --with-updateshost=hostnamemakeDuring a manual Staff Client build processYou will used the variable AUTOUPDATE_HOST=hostname (see above). If you specify just a hostname (such as example.com)
then the URL will be a secure URL (such as https://example.com. If you wish to use a non-HTTPS URL then prefix the host
name with "http://" (such as http://example.com).If neither option is used then, by default, the Staff Client will not include the automatic update preferences.Building UpdatesSimilar to building clients, the targets generic-updates, win-updates, linux-updates,
and extension-updates can be used individually with make to build the update files for the Staff Client. To build
all the targets at once, simply use the target updates.A "full" update will be built for each specified target (or for all if you use the target updates). For all but extensions
any previous full updates (archived by default in the directory /openils/var/updates/archives) will be used to
make partial updates. Partial updates tend to be much smaller and will thus download more quickly, but if something goes wrong with a partial update the
full update will be used as a fallback. Extensions do not currently support partial updates.As the opensrf user, change directory to the Staff Client source directory, then execute the
following commands:cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_clientCommand to build all updates at once:make updatesCommands to build updates individually:make generic-updatesmake win-updatesmake linux-updatesmake extension-updatesBuilding updates with clientsTo save time and effort you can build updates and manual download clients at the same time by adding the string "-client" to each target name. For instance, you
can specify win-updates-client. You can also specify updates-client to build all the targets at once. This does not work for
extension-updates.The clients will be installed alongside the updates and listed on the web page manualupdate.html, rather than left in the Staff Client directory.As the opensrf user, change directory to the Staff Client source directory, then execute the following commands:cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_clientCommand to build all updates at once:make updates-clientCommands to build updates individually:make generic-updates-clientmake win-updates-clientmake linux-updates-clientActivating the Update ServerThis section reviews scripts associated with the update server, and requires some final adjustments to file permissions.The Apache example configuration creates a directory updates that, by default, points to the directory
/openils/var/updates/pub. This directory contains one HTML file and several specially-named script files.The file updatedetails.html is the fallback web page for the update details. The "check"
script is used for XULRunner updates. The "update.rdf" script is used for extension updates.
The "manualupdate.html" script checks for clients to provide download links when automatic updates have failed and uses the
download script to force a download of the generic client XPI (compared to Firefox trying to install it as an extension).The following scripts should be marked as executable: check, download, manualupdate.html, update.rdf. As the
root user, change directory to the updates directory, then execute the following commands:cd /openils/var/updates/pubchmod +x check download manualupdate.html update.rdfOther tipsMultiple workstations on one installMultiple workstation registrations for the same server can be accomplished with a single Staff Client install by using multiple profiles. When
running XULRunner you can specify the option or (uppercase "P") to force the Profile Manager
to start. Unchecking the option will make this the default.Once you have opened the Profile Manager you can create additional profiles, one for each workstation you wish to register. You may need to install SSL exceptions
for each profile.When building targets win-client, win-updates-client, or updates-client, you can
specify NSIS_EXTRAOPTS=-DPROFILES to add an "Evergreen Staff Client Profile Manager" option to the start menu.As the opensrf user, change directory to the Staff Client source directory, then execute the following commands:cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_clientmake NSIS_EXTRAOPTS=-DPROFILES win-client Multiple Staff ClientsThis may be confusing if you are not careful, but you can log in to multiple Evergreen servers at the same time, or a single Evergreen server multiple
times. In either case you will need to create an additional profile for each additional server or workstation you want to log in as (see previous tip).Once you have created the profiles, run XULRunner with the option (in addition to
or if needed). Instead of XULRunner opening a new login window on your existing
session it will start a new session instead, which can then be logged in to a different server or workstation ID.Running the Staff ClientRun the Staff Client on a Linux system by using the application XULRunner (installed automatically and by
default with Firefox version 3.0 and later on Ubuntu and Debian distributions).For example, if the source files for the Evergreen installation are in the directory /home/opensrf/Evergreen-ILS-1.6.0.7/,
start the Staff Client as shown in the following command example:xulrunner /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client/build/application.iniConfiguring a Proxy for the Staff ClientBy using an SSH proxy and an SSH tunnel, it is possible to provide secure (encrypted) network communications between the Staff Client and one or more Evergreen
servers. In addition to providing excellent data security, this method also buffers and caches data traveling to and from the Staff Client and can speed up access to resources
on remote Evergreen servers. This is important if your system architecture includes many Staff Clients and Evergreen servers in a busy environment, through network firewalls,
or must operate over insecure networks.Why Use a Proxy for the Staff Client?There are several reasons for sending network traffic for the Staff Client through an SSH proxy:Firewalls may prevent you from reaching the server. This may happen when you are connecting the Staff Client
to a test server that should not be available generally, or it may be the result of network design priorities other than ease of use.You may wish to improve security where Staff Client traffic may be susceptible to network eavesdropping.
This is especially true when wireless is otherwise the best option for connecting a staff machine to the network.You may wish to buffer and cache data from remote Evergreen servers to speed up access from Staff Clients.Setting Up an SSH TunnelYou will need a server that has network access to the Evergreen server you want to reach, and allows you to log in there via SSH. Use your username and
password for that SSH server to set up a tunnel.For Windows users, one good solution is the open-source utility
PuTTY, a free telnet/SSH client. An example of setting up a
"PuTTY" session follows:Use the menu on the left to go to ConnectionSSHTunnels.Enter 9999 in the "Source port".Choose Dynamic. Do not enter anything in the Destination text entry box.Click Add. "D9999" will now appear in the "Forwarded ports" list.Use the menu on the left to go back to "Session", and enter the host name of the SSH server.A window will open up so that you can enter your username and password. Once you are logged in, the tunnel is open.Configuring the Staff Client to Use the SSH TunnelIn order to tell the Staff Client that all traffic should be sent through the SSH tunnel just configured, you must edit the file
C:\Program Files\Evergreen Staff Client\greprefs\all.js. Search this file for the word socks to
find the appropriate section for the following changes.Make the following changes:Change the value of network.proxy.socks from "" to
"localhost".Change the value of network.proxy.socks_port from "0" to
9999.If everything is working correctly, you should now be able to run the Staff Client and all its data will be sent encrypted through the SSH
tunnel you have just configured.