From: Steve Sheppard Date: Mon, 20 Dec 2010 17:10:19 +0000 (-0500) Subject: updates to Staff Client Installation; X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=56e6a3aeaeb43a99d3b0579faa82f80173200d4e;p=evergreen%2Fpines.git updates to Staff Client Installation; --- diff --git a/1.6/admin/serversideinstallation.xml b/1.6/admin/serversideinstallation.xml index 4753e265e1..8f0c12cd89 100644 --- a/1.6/admin/serversideinstallation.xml +++ b/1.6/admin/serversideinstallation.xml @@ -1037,10 +1037,8 @@ make STAFF_CLIENT_BUILD_ID=rel_1_6_1_2 install The Staff Client will also be automatically built, but you must remember - to set the variable STAFF_CLIENT_BUILD_ID to match the version of the Staff - Client you will use to connect to the Evergreen server. For further information on manually - building the Staff Client, see - . + to set the variable STAFF_CLIENT_BUILD_ID to match the version of the + Staff Client you will use to connect to the Evergreen server. The above commands will create a new subdirectory /openils/var/web/xul/rel_1_6_1_2 containing the Staff Client. @@ -1063,7 +1061,7 @@ tested OpenSRF. You must copy several example OpenSRF configuration files into place after first creating backup copies for troubleshooting purposes, then change all the file ownerships - to opensrf. + to opensrf. As the root user, execute the following commands: @@ -1270,7 +1268,7 @@ Comment out the line Listen 443, since it conflicts with the same declaration in the configuration file: - /etc/apache2/ports.conf. Note that + /etc/apache2/ports.conf. Note that Debian users should not do this since the conflict does not apply to that operating system. @@ -1463,26 +1461,40 @@ Modify the OpenSRF Environment - As the opensrf user, - modify the shell configuration file ~/.bashrc for - user opensrf by adding a Perl environmental - variable, then execute the shell configuration file to load the new variables into - your current environment. - - - In a multi-server environment, you must add any - modifications to ~/.bashrc to the top of - the file before the line - [ -z "$PS1" ] && return . - This will allow headless (scripted) logins to load the correct - environment. - - - - # as the opensrf user: - echo "export PERL5LIB=/openils/lib/perl5:\$PERL5LIB" >> ~/.bashrc - . ~/.bashrc - + In this step you will make some minor modifications to the OpenSRF environment: + + + Modify the permissions in the directory + /openils/var/cgi-bin + to make the files executable: + + # as the opensrf user: + chmod 755 /openils/var/cgi-bin/*.cgi + + + + As the opensrf user, + modify the shell configuration file ~/.bashrc for + user opensrf by adding a Perl + environmental variable, then execute the shell configuration file to load + the new variables into your current environment. + + + In a multi-server environment, you must add any + modifications to ~/.bashrc to the top of + the file before the line + [ -z "$PS1" ] && return . + This will allow headless (scripted) logins to load the correct + environment. + + + + # as the opensrf user: + echo "export PERL5LIB=/openils/lib/perl5:\$PERL5LIB" >> ~/.bashrc + . ~/.bashrc + + + (OPTIONAL) Enable and Disable Language Localizations @@ -1495,6 +1507,9 @@
Starting Evergreen + In this section you will learn how to start the Evergreen services. + For completeness, instructions for stopping Evergreen can be found later in + . As the root @@ -1553,11 +1568,12 @@ In this step you will generate the Web files needed by the Staff Client - and catalog, and calculate the proximity of locations in the Organizational Unit - tree (which allows Holds to work properly). You must do - this the first time you start Evergreen and after making any changes to the - library hierarchy. As the opensrf - user, execute the following command and review the results: + and catalog, and update the proximity of locations in the Organizational Unit + tree (which allows Holds to work properly). + You must do this the first time you start Evergreen and after making any + changes to the library hierarchy. + As the opensrf user, execute the + following command and review the results: # as the opensrf user: cd /openils/bin @@ -1677,32 +1693,41 @@ # as the root user: xulrunner /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build/application.ini - The login screen for the Staff Client should appear. - Log in using the username admin and the password - open-ils : + The login screen for the Staff Client should appear: Logging into the Staff Client - If the login is successful, you will see the following screen: + First, add the name of your Evergreen server to the field + Hostname in the Server section. You will probably + want to use 127.0.0.1. After adding the server name, click Re-Test + Server. You should now see the messages 200:OK in the fields + Status and Version. + Because this is the initial run of the Staff Client, you will see a warning in the + upper-right saying: Not yet configured for the specified + server. To continue, you must assign a workstation name. Refer to + for further details. + Try to log into the Staff Client with the username admin and + the password open-ils. If the login is successful, you will see the + following screen: Logging into the Staff Client - Otherwise, you may need to click Add SSL Exception in the - main window. You will see a popup window labeled "Add Security Exception": + Otherwise, you may need to click 'Add SSL Exception' in the + main window. You should see a popup window titled Add Security Exception: - Logging into the Staff Client + Adding an SSL Exception in the Staff Client - Click Get Certificate, then click Confirm - Security Exception, then click Re-Test Server in the + Click 'Get Certificate', then click 'Confirm + Security Exception', then click 'Re-Test Server' in the main window and try to log in again. @@ -1718,6 +1743,27 @@ apache2ctl configtest && /etc/init.d/apache2 restart + + Stopping Evergreen + In you learned how to start the + Evergreen services. For completeness, following are instructions for stopping the + Evergreen services. + As the opensrf user, stop all Evergreen + services by using the following command: + + # as the opensrf user + # stop the server; use "-l" to force hostname to be "localhost" + osrf_ctl.sh -l -a stop_all + + + You can also stop Evergreen services + without the flag, but the + osrf_ctl.sh utility must know the fully qualified domain name + for the system on which it will execute. That hostname may have been specified + in the configuration file opensrf.xml, which you configured + in a previous step. + +
Post-Installation Chores @@ -1735,7 +1781,7 @@ This temporary network update was done to expedite - testing. You must correct + testing. You must correct this for a public production system. @@ -1776,7 +1822,7 @@
- Set Up Support For Reports + (OPTIONAL) Set Up Support For Reports Evergreen reports are extremely powerful but require some simple configuration. This section describes starting and stopping the Reporter daemon processes. @@ -1974,30 +2020,30 @@ C:\temp). - After selecting the file, click Open to import it. + After selecting the file, click 'Open' to import it. - Then click OK to save the selection + Then click 'OK' to save the selection and return to the VirtualBox Media Manager - Click New, then Next to continue - and create a new virtual machine (VM). + Click 'New', then 'Next' + to continue and create a new virtual machine (VM). Create a new name for the VM and set the operating system - type, then click Next. + type, then click 'Next'. Set the memory size (at least 512Mb), - then click Next. + then click 'Next'. Edit the Virtual Hard Disk configuration settings; click the radio boxes Boot Hard Disk and Use existing hard disk and ensure that the disk name Evergreen1601_DebianLenny.vmdk - is selected. Click Finish to finish the + is selected. Click 'Finish' to finish the setup. @@ -2007,13 +2053,13 @@ Return to VirtualBox and see the summary of the VM just - created. Click Start to boot the new VM. + created. Click 'Start' to boot the new VM. See the start of the Linux boot sequence. Choose Debian Gnu/Linux, kernel 2.6.26-2-686 from the startup menu and click - Enter to start + 'Enter' to start Linux and Evergreen. After some delay you should see the command line prompt debian-lenny login:. Log in with username diff --git a/1.6/admin/staffclientinstallation.xml b/1.6/admin/staffclientinstallation.xml index de727ac132..d183325aad 100644 --- a/1.6/admin/staffclientinstallation.xml +++ b/1.6/admin/staffclientinstallation.xml @@ -1,1019 +1,1318 @@ - - - - Installation of Evergreen Staff Client Software - - This section describes installation of the Evergreen Staff Client software. - - -
- Installing the Staff Client - staff clientinstalling - - Installing a Pre-Built Staff Client - You can install the pre-built Staff Client available for Windows, MAC or Linux. - - Installing on Windows - staff clientinstallingWindows - A standard Microsoft 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. - A screen that looks similar to this should appear: - - - - - - Running the Staff Client installer - - - 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: - - - - - - Running the Staff Client for the first time - - - First, add the name of your Evergreen server to the field Hostname in the Server section. - For example, the PINES demo system is http://demo.gapines.org. After adding the server name, click Re-Test - Server. - Because this is the initial run of the Staff Client, you will see a warning in the upper-right indicating that the Workstation is - Not yet configured for the specified server. The first thing you must do to the Staff Client on every workstation is to assign - it a workstation name. This is covered in . - - - Installing on Mac OS - staff clientinstallingMac OS - A Mac 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. Release notes 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 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 build directory 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 - Resources folder 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. - - - When you run the Staff Client installer, a screen will appear that looks similar to this: - - - - - - Running the Staff Client installer - - - 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. - - - - - - Finishing the installation - - - - - Running directly using XULRunner - staff clientXULRunner - XULRunner - You must install an apropriate version of XULRunner to match the Evergreen version. See the following table for the recommended version of XULRunner: - - Evergreen / XULRunner Dependencies - - - - - - Evergreen 1.6.x.x - XULrunner 1.9 - - - Evergreen 1.4.x.x - XULrunner 1.8.0.4 or XULrunner 1.8.0.3 - - - Evergreen 1.2.x.x - XULrunner 1.8.0.4 or XULrunner 1.8.0.3 - - - -
- If you have issues removing previously installed XULRunner versions see for further information. - - 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_Client - - This command should exit quietly. The folder /Applications/OpenILS will be created, containing a launcher - named open_ils_staff_client. - - - Removing previously installed XULRunner versions - XULRunnerremoving previous versions - If 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 file /Library/Receipts/xulrunner-ver-mak.pkg does not exist (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 are changed to the newer one. - - Flush Receiptdb file: - First, get the package identifier, then purge/forget the build that was initially installed: - -sudo pkgutil --pkgs > /tmp/pkgs.txt -sudo pkgutil --forget org.mozilla.xulrunner - - It may not be necessary to edit the file /Library/Receipts/InstallHistory.plist after deleting the folder - XUL.framework. - See - http://lists.apple.com/archives/Installer-dev/2009/Jul/msg00008.html for more information. - - - - Creating an APP file: Staff Client & XULRunner Bundled - An APP file is basically a folder. Start with a folder stucture like this: - - * Evergreen.app - * Contents - * Frameworks - * Resources - * MacOS - - Create an APP folder structure with the following commands: - -mkdir -p Evergreen.app/Contents/Frameworks -mkdir -p Evergreen.app/Contents/Resources -mkdir -p Evergreen.app/Contents/MacOS - - - - - Create a new file in the folder Evergreen.app/Contents/Info.plist containing the following data - (adjust for your version of Evergreen): - - - - - CFBundleExecutable - xulrunner - CFBundleGetInfoString - OpenILS open_ils_staff_client rel_1_6_0_7 - CFBundleInfoDictionaryVersion - 6.0 - CFBundleName - Evergreen Staff Client - CFBundlePackageType - APPL - CFBundleShortVersionString - rel_1_6_0_7 - CFBundleVersion - rel_1_6_0_7.rel_1_6_0_7 - NSAppleScriptEnabled - - CFBundleTypeIconFile - Evergreen.icns - - -]]> - - Download and install an appropriate Mac OS package of XULRunner from the Mozilla website (see above for recommendations). - - Make a copy of the folder /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 the folder 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 Linux - - Quick Upgrade of the Staff Client - A 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: - -su - opensrf -cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client -scp -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: - -su - opensrf -xulrunner ~/eg-client-x.x.x.x/build/application.ini - - - - Building the Staff Client on the Server - staff clientbuilding on the server - A Linux Staff Client is automatically built on the server as part of the normal make install process for Evergreen server-side - software, using a procedure similar to this: - -cd ~/ILS/Open-ILS/xul/staff_client -make STAFF_CLIENT_BUILD_ID='12345' -mkdir /openils/var/web/xul/ -mkdir /openils/var/web/xul/12345/ -cd build/ -cp -R server/ /openils/var/web/xul/12345/ - - The Staff Client can be run from the build directory using this command: - -su - opensrf -xulrunner application.ini - - 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. - -su - root -cd /openils/var/web/xul -ln -s SERVER_BUILD_ID/ CLIENT_BUILD_ID - - - - Building the Staff Client on the client Machine - This 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 Ubuntu derivatives). - - - Prerequisites - Both 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 subversion -sudo apt-get install xulrunner - - - - Download the Source Code - - - Determine which version is needed - For most end-users, a specific version is required to communicate properly with the Evergreen server. Check with your - system admininstrator, 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.6.1.2, 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_6_1_2'. This is the tag you need; make a note of it for the next step. - - - Download the Code - As 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: - -su - opensrf -cd /YOUR/DOWNLOAD/DIRECTORY -svn co rel_1_2_1_4/ - - Remember to change "rel_1_6_1_2" to the appropriate tag for your installation. - - - - - Build the Staff Client - - - Evergreen 1.2.x - In 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: - -su - opensrf -cd /YOUR/DOWNLOAD/DIRECTORY -cd Open-ILS/xul/staff_client -make STAFF_CLIENT_BUILD_ID='rel_1_6_1_2' - - - - - - Run the Staff Client (from the command line) - As the opensrf user, navigate to the build/ subdirectory - (not staff_client/) and run the following command: - -su - opensrf -xulrunner application.ini - - - - Cleaning Up / Creating Shortcuts - The 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. As - the opensrf user, issue the following commands to create a clean "staging" directory in which to place - the finished Staff Client, and to copy into it the "staff_client" directory: - -su - opensrf -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/build -xulrunner application.ini - - If there were no problems, then finish the cleanup by removing the original download directory and all subdirectories: - -rm -r -f ~/<Download Directory> - - You may wish to create DesktopStart MenuK-Menu - shortcuts for the Staff Client using the command xulrunner ~/<Destination Directory>/staff_client/build/application.ini - as the target. - - - - - Using Wine to Install on Linux - staff clientusing wine to install on Linux - The Linux application Wine is another alternative if you 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 wine - - - - Download Windows installer for the Staff Client - As 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: - -su - opensrf -cd /YOUR/DOWNLOAD/DIRECTORY -wget http://open-ils.org/downloads/evergreen-setup-rel_version-number.exe - - - - Run the downloaded Windows installer - As the opensrf user, navigate to the directory where you downloaded the Windows executable - file, then execute it: - -su - opensrf -cd /YOUR/DOWNLOAD/DIRECTORY -wine evergreen-setup-rel_version-number.exe - - If this step fails, you may need to configure Wine first to properly emulate Windows XP. To do so, type "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 Client - A 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 "Wine->Program - Files->Evergreen Staff Client->Evergreen Staff Client", or else launch the Staff Client from the desktop shortcut. - - - - - Assigning Workstation Names - staff clientassigning workstation names - The 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. - - - - - - Example of unconfigured Staff Client - - - 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 their 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: - - - - - - Example of configured Staff Client - - - 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 - click Register. - Once you have registered your workstation with the server, your screen will look like this: - - - - - - Example of registered Staff Client - - - You are now ready to log into the Staff Client for the first time. Type in your password again, and click Login. - - - - Building the Staff Client - staff clientbuilding - You 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.x/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_ID - During 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: - -su - root -cd /home/opensrf/[Evergreen Install Directory] -make STAFF_CLIENT_BUILD_ID=[version ID] install - - The 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: - -su - opensrf -cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client -make STAFF_CLIENT_BUILD_ID=my_test_id build - - - - Option STAFF_CLIENT_VERSION - During 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: - -su - root -cd /home/opensrf/[Evergreen Install Directory] -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: - -su - opensrf -cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client -make STAFF_CLIENT_VERSION=0mytest.200 build - - - - Option STAFF_CLIENT_STAMP_ID variable - During 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: - -su - root -cd /home/opensrf/[Evergreen Install Directory] -make STAFF_CLIENT_STAMP_ID=my_test_stamp install - - The 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: - -su - opensrf -cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client -make STAFF_CLIENT_STAMP_ID=my_test_stamp build - - - - - Advanced Build Options - staff clientbuildingadvanced build options - In 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" Command - - - - - - Keyword - Description - - - - - clients - Runs "make win-client", "make linux-client", and "make generic-client" individually - - - client_dir - Builds a client directory from the build directory, without doing a rebuild. The same as "copy everything but server/". - - - client_app - Prerequisite "client_dir"; removes "install.rdf" from client directory so an APP bundle can't be installed as an extension - - - client_ext - Prerequisite "client_dir"; remove "application.ini", "autoupdate.js", "standalone_xul_app.js" from client directory so an - extension won't break Firefox - - - extension - Prerequisite "client_ext"; rewritten to use "client_ext" - - - generic-client - Prerequisite "client_app"; makes an XPI file suitable for use with "xulrunner --install-app"" - - - win-xulrunner - Prerequisite "client_app"; adds Windows xulrunner to client build - - - linux-xulrunner - Prerequisite "client_app"; adds Linux xulrunner to client build - - - win-client - Prerequisite "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-client - Prerequisite "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 builds clients and copies them to a subdirectory of the - updates directory as well; - doesn't exist. - - - -
- Descriptions of other special build options follow: - - - Developer Build - You can create a so-called developer build of the Staff Client by substituting for 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: - -su - opensrf -cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client -make devbuild - - - - Compressed Javascript - You can execute the Google Closure Compiler utility to automatically review and compress - Javascript code after the build process completes, - by substituting 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: - -su - opensrf -cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client -make compress-javascript - - You 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: - In the following make below, the order of options is important! - -su - opensrf -cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client -make devbuild compress-javascript - - - - Automatic Update Host - The host used to check for automatic Staff Client updates can be overridden by specifying the option. The - following commands could have been used during the normal build process: - -su - root -cd /home/opensrf/[Evergreen Install Directory] -make AUTOUPDATE_HOST=localhost install - - You can manually set to set up automatic update checking. The following commands will manually build the Staff - Client using a different . - As the opensrf user, change directory to the Staff Client source directory, then set the variable and - build the Staff Client: - -su - opensrf -cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client -make AUTOUPDATE_HOST=localhost build - - For more information on Automatic Updates, see . - - - - - Installing and Activating a Manually Built Staff Client - The Staff Client is automatically built, installed and activated as part of the normal make 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: - -su - opensrf -cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client -mkdir -p "/openils/var/web/xul/$(cat build/BUILD_ID)" -cp -R build/server "/openils/var/web/xul/$(cat build/BUILD_ID)" - - - - Packaging the Staff Client - Once the Staff Client has been built, you can create several forms of client packages by using some targetted make commands in the Staff - Client source directory. - - - Packaging a Generic Client - This 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 parameter >. - As the opensrf user, change directory to the Staff Client source directory, then execute the - following commands: - -su - opensrf -cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client -make generic-client - - - - Packaging a Windows Client - This 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". - 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. - 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 strings - - - - - - IDI_APPICON - Tray icon - - - 32512 - Default window icon - - - -
- As the opensrf user, change directory to the Staff Client source directory, then execute the - following commands: - -su - opensrf -cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client -make win-client - - - - Packaging a Linux Client - This 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: - -su - opensrf -cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client -make linux-client - - - - Packaging a Firefox Extension - This 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: - -su - opensrf -cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client -make extension - - - - - - Staff Client Automatic Updates - staff clientautomatic updates - It 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. - - Automatic 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, or - It 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 Host - The 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, or - During a manual Staff Client build process. - - - - - At configuration time for the normal build of Evergreen server-side software - This must be done when the Evergreen server-side software is first configured (see ). As - the opensrf user, use the utility "configure" as shown: - -su - opensrf -cd /home/opensrf/[Evergreen Install Directory] -./configure --prefix=/openils --sysconfdir=/openils/conf --with-updateshost=hostname -make - - - - During a manual Staff Client build process - You 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 hostname 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 Updates - staff clientautomatic updatesbuilding - Similar to building clients, the targets , , , and - 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 . - A full update will be built for each specified target (or for all if you use the target ). 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 currentlysupport partial updates. - As the opensrf user, change directory to the Staff Client source directory, then execute the following - commands: - - -su - opensrf -cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client - - - Command to build all updates at once: - -make updates - - commands to build updates individually: - -make generic-updates -... -make win-updates -... -make linux-updates -... -make extension-updates -... - - - - Building updates with clients - staff clientautomatic updatesbuilding with clients - To save time and effort you can build updates and manual download clients at the same time by adding to each target - name. For instance, you can specify . You can also specify to build all the targets at once. - This does not work for . - The clients will be installed alongside the updates and listed on the manualupdate.html page, 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: - -su - opensrf -cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client - - - Command to build all updates at once: - -make updates-client - - - Command to build updates individually: - -make generic-updates-client -... -make win-updates-client -... -make linux-updates-client - - - - - Activating the Update Server - staff clientautomatic updatesactivating the update server - This section reviews scripts associated with the update server, and requires some final adjustments to file permissions. - The Apache example configuration creates an "updates" directory that, by default, points to the directory - /openils/var/updates/pub. This directory contains one HTML file and several specially-named script files. - The updatedetails.html file 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 file 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. Execute the following commands: - -su - root -cd /openils/var/updates/pub -chmod +x check download manualupdate.html update.rdf - - - - - Other tips - - Multiple workstations on one install - Multiple 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 "-profilemanager" or "-P" (uppercase "P") to force the Profile Manager to start. Unchecking the "Don't ask at startup" 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 , , or , you can - specify 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: - - su - opensrf - cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client - make NSIS_EXTRAOPTS=-DPROFILES win-client - - - - Multiple Staff Clients - This 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 neeeded). 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 Client - staff clientrunninglinux - Run 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 Install Directory]/, start - the Staff Client as shown in the following example: - - su - opensrf - xulrunner /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client/build/application.ini - - - Running the Staff Client over an SSH Tunnel - staff clientrunning through an SSH tunnel - The Staff Client can use an SSH tunnel as a SOCKS 5 proxy. - - Configuring 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. - - - - - Setting Up an SSH Tunnel - You will need a server that allows you to log in via SSH and has network access to the Evergreen server you want to reach. You will 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]]. When setting up a PuTTY session: - - - - - - Setting up an SSH tunnel in PuTTY - - - - Use the menu on the left to go to Connection > SSH > Tunnels. - 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. - - See How to set up SSH (for the beginner) - for information on setting up SSH for other client operating systems, - - - Configuring the Staff Client to Use the <systemitem class="protocal">SSH</systemitem> Tunnel - In 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. - - - - - - The SOCKS section of "all.js" before 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. - - - - - - - The SOCKS section of "all.js" after changes - - - 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. - - -
- + + + + Installation of Evergreen Staff Client Software + + This section describes installation of the Evergreen Staff Client software. + + +
+ Installing the Staff Client + + staff client + installing + +
+ Installing a Pre-Built Staff Client + A pre-built Staff Client is available for Windows, Mac or Linux systems. Installing the + Staff Client in each of these environments is described in the following sections. +
+ Installing on Windows + + staff client + installing + Windows + + In this section we describe the process of installing the Staff Client on the + Microsoft Windows operating + system. + Visit the downloads section of the Evergreen website at + http://www.evergreen-ils.org/downloads.php + and find the standard Microsoft Windows Installer that contains the current version of + the Staff Client. Download the Installer, then run it. A screen that looks similar to + this should appear: + + + Running the Staff Client installer + + + + + + 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 automatically + install the software on your workstation. + When you run the Staff Client for the first time, a screen similar to this should + appear: + + + Running the Staff Client for the first time + + + + + + First, add the name of your Evergreen server to the field + Hostname in the Server + section. For example, the PINES demo system is + http://demo.gapines.org. + After adding the server name, click 'Re-Test Server'. + Because this is the initial run of the Staff Client, you will see a warning in the + upper-right saying: Not yet configured for the specified + server. The first thing you must do to the Staff Client on every workstation + is to assign it a workstation name. This is covered in + . +
+
+ Installing on Mac OS + + staff client + installing + Mac OS + + In this section, we describe Mac packages and related versions of XULRunner + that can be used to run the Staff Client in a Mac OS environment. + + Evergreen Version 1.2.3.0 + + + A Mac package that contains an early version of the Staff Client + (version 1.2.3.0) for use with XULRunner is available. Current releases + of XULRunner can be found here: + + http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases . + Download and install the latest version. Further information about + XULRunner can be found here: + + https://developer.mozilla.org/en/xulrunner + Note that later versions of XULRunner (e.g., version 1.9.2.13) have + replaced version 1.8.0.4, which has known security holes and is not + recommended for applications that deal with public web content. + + + A Mac OS Installation package for Staff Client version 1.2.3.0 + is available from Evergreen Indiana. Download and install it from here: + + evergreen_osx_staff_client_1_2_3.zip . + + + + To upgrade to a more recent version of the Staff Client, you can + copy the build directory 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 to the Resources + folder within the Open-ILS package in your + Applications directory on the Mac, + overwriting files with the same names. + + Drag the application's icon to your toolbar for easier + access. + + When you run the Staff Client installer, a screen will appear that looks + similar to this: + + + Running the Staff Client installer for Mac OS + + + + + + 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. + + + Finishing the installation + + + + + + + + Running directly using XULRunner + + staff client + XULRunner + + You must install an apropriate version of XULRunner to match the Evergreen + version. See the following table for the recommended version of + XULRunner: + + Evergreen / XULRunner Dependencies + + + + + + Evergreen 1.6.x.x + XULrunner 1.9 + + + Evergreen 1.4.x.x + XULrunner 1.8.0.4 or XULrunner 1.8.0.3 + + + Evergreen 1.2.x.x + XULrunner 1.8.0.4 or XULrunner 1.8.0.3 + + + +
+ If you have issues removing previously installed XULRunner versions see + for further + information. + + 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: + + # as the root user + /Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_Client + + This command should exit quietly. The folder + /Applications/OpenILS will be created, + containing a launcher named open_ils_staff_client. + + + Removing previously installed XULRunner versions + + XULRunner + removing previous versions + + If 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 file /Library/Receipts/xulrunner-ver-mak.pkg does + not exist (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 are changed to the newer one. + + + Flush Receiptdb file: + First, get the package identifier, then purge/forget the build that was + initially installed: + + # as the root user + sudo pkgutil --pkgs > /tmp/pkgs.txt + sudo pkgutil --forget org.mozilla.xulrunner + + It may not be necessary to edit the file + /Library/Receipts/InstallHistory.plist after deleting the + folder XUL.framework. See + + http://lists.apple.com/archives/Installer-dev/2009/Jul/msg00008.html + for more information. + + + Creating an APP file: Staff Client & XULRunner Bundled + An APP file is basically a folder. Start with a folder stucture like this: + + * Evergreen.app + * Contents + * Frameworks + * Resources + * MacOS + + Create an APP folder structure with the following commands: + + # as the root user + mkdir -p Evergreen.app/Contents/Frameworks + mkdir -p Evergreen.app/Contents/Resources + mkdir -p Evergreen.app/Contents/MacOS + + + + + Create a new file in the folder + Evergreen.app/Contents/Info.plist + containing the following data (adjust for your version of + Evergreen): + + + + + CFBundleExecutable + xulrunner + CFBundleGetInfoString + OpenILS open_ils_staff_client rel_1_6_0_7 + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + Evergreen Staff Client + CFBundlePackageType + APPL + CFBundleShortVersionString + rel_1_6_0_7 + CFBundleVersion + rel_1_6_0_7.rel_1_6_0_7 + NSAppleScriptEnabled + + CFBundleTypeIconFile + Evergreen.icns + + +]]> + + Download and install an appropriate Mac OS package of + XULRunner from the Mozilla website (see above for + recommendations). + + Make a copy of the folder + /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 the + folder 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 Linux + + Quick Upgrade of the Staff Client + A 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 Linux 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. Replace USER, + LINUX_MACHINE, and HOME_DIRECTORY + with appropriate values. + As the opensrf user, execute the + following commands: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + scp -r ./build USER@LINUX_MACHINE:~/HOME_DIRECTORY/ + + You must now test the newly copied Staff Client. + As the opensrf user, log into the + remote workstation and execute the following command: + + # as the opensrf user + xulrunner ~/HOME_DIRECTORY/build/application.ini + + + + Building the Staff Client on the Server + + staff client + building on the server + + A Linux Staff Client is automatically built on the server as part of the + normal make install process for Evergreen server-side + software. See for details of + the build process. + In order to install a compatible Staff Client on another Linux system, you + can copy the appropriate files from the Staff Client build directory on the + server to the new Linux system, or just manually build it on the new + system. Ensure that the BUILD_ID you choose on the new system matches the + BUILD_ID for each Staff Client you use on other systems. + If you wish to use 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 used in an existing + Staff Client installation, execute the Staff Client and click + 'About this 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. + + # as the root user + cd /openils/var/web/xul + ln -s SERVER_BUILD_ID/ CLIENT_BUILD_ID + + + + Building the Staff Client on a client Machine + This 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 Ubuntu + derivatives). + + + Prerequisites + Both 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. + + # as the root user + sudo apt-get install subversion + sudo apt-get install xulrunner + + + + Download the Source Code + + + Determine which version is needed + For most end-users, a specific version is required + to communicate properly with the Evergreen server. Check + with your system admininstrator, 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.6.1.2, 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_6_1_2'. This is the tag + you need; make a note of it for the next step. + + + Download the Code + As 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: + + # as the opensrf user + cd /DOWNLOAD/DIRECTORY + svn co rel_1_6_1_2/ + + Remember to change "rel_1_6_1_2" to the appropriate + tag for your installation. + + + + + Build the Staff Client + In 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: + + # as the opensrf user + cd /YOUR/DOWNLOAD/DIRECTORY + cd Open-ILS/xul/staff_client + make STAFF_CLIENT_BUILD_ID='rel_1_6_1_2' + + + + Run the Staff Client (from the command line) + As the opensrf + user, navigate to the build/ + subdirectory (not staff_client/) + and run the following command: + + # as the opensrf user + xulrunner application.ini + + + + (OPTIONAL) Cleaning Up / Creating Shortcuts + The 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 then + be copied to other machines. + To create a clean "staging" directory in which to place + the finished Staff Client, execute the following commands + (remember to replace DESTINATION_DIRECTORY + with the appropriate path): + + # as the opensrf user + mkdir ~/DESTINATION_DIRECTORY + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/ + cp -r staff_client ~/DESTINATION_DIRECTORY + + Finally, test the Staff Client to verify that all necessary + files were moved to the destination directory: + + # as the opensrf user + cd ~/DESTINATION_DIRECTORY/staff_client/build + xulrunner application.ini + + If there were no problems, then finish the cleanup by removing the + original download directory and all subdirectories as shown: + + # as the opensrf user + rm -r -f ~/DOWNLOAD_DIRECTORY + + You may wish to create a shortcut for the Staff Client: + + Desktop + StartMenu + K-Menu + + Use the command: xulrunner + ~/DESTINATION_DIRECTORY/staff_client/build/application.ini + as the target for the shortcut. + + + + + Using Wine to Install on Linux + + staff client + using wine to install on Linux + + The Linux application Wine is another alternative if you + 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: + + # as the root user + sudo apt-get install wine + + + + Download Windows installer for the Staff Client + As 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: + + # as the opensrf user + cd /YOUR/DOWNLOAD/DIRECTORY + wget http://open-ils.org/downloads/evergreen-setup-rel_version-number.exe + + + + Run the downloaded Windows installer + As the opensrf user, + navigate to the directory where you downloaded the Windows executable + file, then execute it: + + # as the opensrf user + cd /YOUR/DOWNLOAD/DIRECTORY + wine evergreen-setup-rel_version-number.exe + + If this step fails, you may need to configure Wine first to properly + emulate Windows XP. To do so, type "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 Client + A 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 "Wine->Program + Files->Evergreen Staff Client->Evergreen Staff Client", or else launch the + Staff Client from the desktop shortcut. + + + + + Assigning Workstation Names + + staff client + assigning workstation names + + The 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. + + + Example of unconfigured Staff Client + + + + + + 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 their 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: + + + Example of configured Staff Client + + + + + + 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 click + 'Register'. + Once you have registered your workstation + with the server, your screen will look like this: + + + Example of registered Staff Client + + + + + + You are now ready to log into the Staff Client for the first time. Type in your + password again, and click 'Login'. + +
+
+ Building the Staff Client + + staff client + building + + You 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.x/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_ID + During 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: + + # as the root user + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + make STAFF_CLIENT_BUILD_ID=1.6.1.2 install + + The 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: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + make STAFF_CLIENT_BUILD_ID=my_test_id build + + + + Option STAFF_CLIENT_VERSION + During 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: + + # as the root user + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + 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: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + make STAFF_CLIENT_VERSION=0mytest.200 build + + + + Option STAFF_CLIENT_STAMP_ID variable + During 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: + + # as the root user + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + make STAFF_CLIENT_STAMP_ID=my_test_stamp install + + The 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: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + make STAFF_CLIENT_STAMP_ID=my_test_stamp build + + +
+
+ Advanced Build Options + + staff client + building + advanced build options + + In 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" Command + + + + + + Keyword + Description + + + + + clients + Runs "make win-client", "make linux-client", and "make + generic-client" individually + + + client_dir + Builds a client directory from the build directory, without + doing a rebuild. The same as "copy everything but + server/". + + + client_app + Prerequisite "client_dir"; removes "install.rdf" from + client directory so an APP bundle can't be installed as an + extension + + + client_ext + Prerequisite "client_dir"; remove "application.ini", + "autoupdate.js", "standalone_xul_app.js" from client directory so + an extension won't break Firefox + + + extension + Prerequisite "client_ext"; rewritten to use "client_ext" + + + generic-client + Prerequisite "client_app"; makes an XPI file suitable for + use with "xulrunner --install-app"" + + + win-xulrunner + Prerequisite "client_app"; adds Windows xulrunner to client build + + + linux-xulrunner + Prerequisite "client_app"; adds Linux xulrunner to client build + + + win-client + Prerequisite "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-client + Prerequisite "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 builds clients and + copies them to a subdirectory of the + updates directory as well; + doesn't exist. + + + +
+ Descriptions of other special build options follow: + + + Developer Build + You can create a so-called developer build of the Staff + Client by substituting for 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: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + make devbuild + + + + Compressed Javascript + You can execute the Google Closure + Compiler utility to automatically review and compress Javascript code + after the build process completes, by substituting + 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: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + make compress-javascript + + You 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: + In the following make below, the order of options is + important! + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + make devbuild compress-javascript + + + + Automatic Update Host + The host used to check for automatic Staff Client updates can be overridden + by specifying the option. The following commands + could have been used during the normal build process: + + # as the root user + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + make AUTOUPDATE_HOST=localhost install + + You can manually set to set up automatic + update checking. The following commands will manually build the Staff Client using + a different . + As the opensrf user, change + directory to the Staff Client source directory, then set the variable and build + the Staff Client: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + make AUTOUPDATE_HOST=localhost build + + For more information on Automatic Updates, see + . + + +
+
+ Installing and Activating a Manually Built Staff Client + The Staff Client is automatically built, installed and activated as part of the normal + make 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: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + mkdir -p "/openils/var/web/xul/$(cat build/BUILD_ID)" + cp -R build/server "/openils/var/web/xul/$(cat build/BUILD_ID)" + +
+
+ Packaging the Staff Client + Once the Staff Client has been built, you can create several forms of client packages by + using some targetted make commands in the Staff Client source directory. + + + Packaging a Generic Client + This 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 parameter + >. + As the opensrf user, change + directory to the Staff Client source directory, then execute the following + commands: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + make generic-client + + + + Packaging a Windows Client + This 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". + 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. + 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 strings + + + + + + IDI_APPICON + Tray icon + + + 32512 + Default window icon + + + +
+ As the opensrf user, change + directory to the Staff Client source directory, then execute the following + commands: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + make win-client + + + + Packaging a Linux Client + This 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: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + make linux-client + + + + Packaging a Firefox Extension + This 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: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + make extension + + + +
+
+ Staff Client Automatic Updates + + staff client + automatic updates + + It 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. + + Automatic 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, or + It 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 Host + The 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, or + During a manual Staff Client build process. + + + + + At configuration time for the normal build of Evergreen server-side + software + This must be done when the Evergreen server-side software is first + configured (see ). As + the opensrf user, use the + utility "configure" as shown: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + ./configure --prefix=/openils --sysconfdir=/openils/conf --with-updateshost=hostname + make + + + + During a manual Staff Client build process + You 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 hostname 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 Updates + + staff client + automatic updates + building + + Similar to building clients, the targets , + , , and + 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 . + A full update will be built for each specified target (or for all if you use the + target ). 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 currentlysupport partial updates. + As the opensrf user, change directory to + the Staff Client source directory, then execute the following commands: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + + Command to build all updates at once: + + # as the opensrf user + make updates + + commands to build updates individually: + + # as the opensrf user + make generic-updates + make win-updates + make linux-updates + make extension-updates + + + + Building updates with clients + + staff client + automatic updates + building with clients + + To save time and effort you can build updates and manual download clients at the + same time by adding to each target name. For instance, you can + specify . You can also specify + to build all the targets at once. This does not work for + . + The clients will be installed alongside the updates and listed on the + manualupdate.html page, 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: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + + Command to build all updates at once: + + # as the opensrf user + make updates-client + + Command to build updates individually: + + # as the opensrf user + make generic-updates-client + make win-updates-client + make linux-updates-client + + + + Activating the Update Server + + staff client + automatic updates + activating the update server + + This section reviews scripts associated with the update server, and requires some + final adjustments to file permissions. + The Apache example configuration creates an "updates" directory that, by default, + points to the directory /openils/var/updates/pub. + This directory contains one HTML file and several specially-named script files. + The updatedetails.html file 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 file 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. Execute the following commands: + + # as the root user + cd /openils/var/updates/pub + chmod +x check download manualupdate.html update.rdf + + +
+
+ Other tips + + Multiple workstations on one install + Multiple 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 "-profilemanager" or "-P" + (uppercase "P") to force the Profile Manager to start. Unchecking the "Don't ask at + startup" 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 , + , or , you can specify + 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: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + make NSIS_EXTRAOPTS=-DPROFILES win-client + + + + Multiple Staff Clients + This 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 neeeded). 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 Client + + staff client + running + linux + + Run 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.1.2/, start the Staff + Client as shown in the following example: + + # as the opensrf user + xulrunner /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build/application.ini + + + Running the Staff Client over an SSH Tunnel + + staff client + running through an SSH tunnel + + The Staff Client can use an SSH tunnel as a SOCKS 5 proxy. + + Configuring 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. + + + + + Setting Up an SSH Tunnel + You will need a server that allows you to log in via SSH and has network access to + the Evergreen server you want to reach. You will 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. When setting up a PuTTY + session: + + + Setting up an SSH tunnel in PuTTY + + + + + + + Use the menu on the left to go to Connection > SSH > Tunnels. + 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. + + See How to set up + SSH (for the beginner) for information on + setting up SSH for other client operating + systems, + + + Configuring the Staff Client to Use the <systemitem class="protocal">SSH</systemitem> Tunnel + In 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. + + + The SOCKS section of "all.js" before 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. + + + + The SOCKS section of "all.js" after changes + + + + + + 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. + + +
+ diff --git a/1.6/media/serversideinstallation-staffclient-running-2.png b/1.6/media/serversideinstallation-staffclient-running-2.png index a532686454..33abe1371a 100644 Binary files a/1.6/media/serversideinstallation-staffclient-running-2.png and b/1.6/media/serversideinstallation-staffclient-running-2.png differ diff --git a/1.6/media/staffclientinstallation-staffclient-1.png b/1.6/media/staffclientinstallation-staffclient-1.png index 8e821c9f3c..b47a033370 100644 Binary files a/1.6/media/staffclientinstallation-staffclient-1.png and b/1.6/media/staffclientinstallation-staffclient-1.png differ diff --git a/1.6/media/staffclientinstallation-staffclient-2.png b/1.6/media/staffclientinstallation-staffclient-2.png index 8c4adca68d..dd224ab0d2 100644 Binary files a/1.6/media/staffclientinstallation-staffclient-2.png and b/1.6/media/staffclientinstallation-staffclient-2.png differ