From f7486521d3cf0b1f52c4dc2a18a12682b435116c Mon Sep 17 00:00:00 2001 From: Steve Sheppard Date: Thu, 23 Dec 2010 12:56:04 -0500 Subject: [PATCH] updates to Staff Client Installation to bring into line with a real installation attempt; --- 1.6/admin/staffclientinstallation.xml | 1688 +++++++++++++------------ 1 file changed, 871 insertions(+), 817 deletions(-) diff --git a/1.6/admin/staffclientinstallation.xml b/1.6/admin/staffclientinstallation.xml index d183325aad..f1b5d356f2 100644 --- a/1.6/admin/staffclientinstallation.xml +++ b/1.6/admin/staffclientinstallation.xml @@ -14,23 +14,23 @@
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. + 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 + Installing on <systemitem class="osname">Windows</systemitem> 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 + 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: + 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 @@ -65,34 +65,40 @@ .
- Installing on Mac OS + Installing on <systemitem class="osname">Mac OS</systemitem> 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. + This section describes Mac OS + 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: + A Mac OS package that + contains an early version of the Staff Client (version 1.2.3.0) for use + with XULrunner is available. You can find + current releases of XULrunner here: http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases . - Download and install the latest version. Further information about - XULRunner can be found here: + Download and install the latest version. You can find further information + about XULrunner 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. + 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: + 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 . @@ -100,10 +106,12 @@ 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. + 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, @@ -116,7 +124,8 @@ similar to this: - Running the Staff Client installer for Mac OS + Running the Staff Client installer for + Mac OS @@ -136,23 +145,23 @@ - Running directly using XULRunner + Running directly using <application>XULrunner</application> 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 + You must install an appropriate version of XULrunner + to match the Evergreen version. See the following table for the recommended version of + XULrunner: +
+ Evergreen / <application>XULrunner</application> Dependencies Evergreen 1.6.x.x - XULrunner 1.9 + XULrunner 1.9.x.x Evergreen 1.4.x.x @@ -165,48 +174,48 @@
- If you have issues removing previously installed XULRunner versions see - for further - information. - + 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: + 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, + The command should exit quietly and will create the folder + /Applications/OpenILS, containing a launcher named open_ils_staff_client. - Removing previously installed XULRunner versions + (OPTIONAL) 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 + If you already have a newer version of + XULrunner 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 . + 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. + not exist (possibly in newer Mac OS + releases), you need to flush the file receiptdb. + If you install a newer version of XULrunner + over a previous (older) install, the older install is not removed but the + symlinks are changed to the newer one. - Flush Receiptdb file: + (OPTIONAL) 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 @@ -218,23 +227,21 @@ for more information. - Creating an APP file: Staff Client & XULRunner Bundled + Creating an APP file: Staff Client and <application>XULrunner</application> Bundled An APP file is basically a folder. Start with a folder stucture like this: - * Evergreen.app - * Contents - * Frameworks - * Resources - * MacOS + 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 @@ -249,7 +256,7 @@ CFBundleExecutable xulrunner CFBundleGetInfoString - OpenILS open_ils_staff_client rel_1_6_0_7 + OpenILS open_ils_staff_client rel_1_6_1_2 CFBundleInfoDictionaryVersion 6.0 CFBundleName @@ -257,9 +264,9 @@ CFBundlePackageType APPL CFBundleShortVersionString - rel_1_6_0_7 + rel_1_6_1_2 CFBundleVersion - rel_1_6_0_7.rel_1_6_0_7 + rel_1_6_1_2.rel_1_6_1_2 NSAppleScriptEnabled CFBundleTypeIconFile @@ -268,24 +275,27 @@ ]]> - Download and install an appropriate Mac OS package of - XULRunner from the Mozilla website (see above for - recommendations). + Download and install an appropriate + Mac OS package of + XULrunner from the Mozilla website + + https://developer.mozilla.org/en/xulrunner (see + 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 + 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 @@ -296,17 +306,18 @@ Make Evergreen.app/Resources the root of your Evergreen application files like this: - * Evergreen.app/ - __* Contents/ - ____* Resources/ - ______* BUILD_ID - ______* application.ini - ______* chrome/ - ______* components/ - ______* etc. + Evergreen.app/ + __Contents/ + ____Resources/ + ______BUILD_ID + ______application.ini + ______chrome/ + ______components/ + ______etc. - Put a Mac format icon file named Evergreen.icns in + Put a Mac + format icon file named Evergreen.icns in Resources. @@ -318,26 +329,19 @@ 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 + version, just copy the directory tree containing the Staff Client from your 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: + Execute the following commands, replacing USER, + WORKSTATION, and SOME_PATH with + appropriate values: - # 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/ + scp -r ./build USER@WORKSTATION:/SOME_PATH/ - You must now test the newly copied Staff Client. - As the opensrf user, log into the - remote workstation and execute the following command: + You should test the newly copied Staff Client on the remote workstation. + Log into the workstation and execute the following command: - # as the opensrf user - xulrunner ~/HOME_DIRECTORY/build/application.ini + xulrunner /SOME_PATH/build/application.ini @@ -351,20 +355,24 @@ 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'. + can copy the appropriate files from the Staff Client build directory on your + server to the new Linux system. You could manually build the Staff Client on the + new system, but you must ensure that the BUILD_ID you chose on + the server 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 was used for existing Staff Client installations, + execute each Staff Client and click the 'About this Client' + button. 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. + 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, make the changes as follows: # as the root user cd /openils/var/web/xul @@ -372,27 +380,29 @@ - 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). + 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 instructions are + for building Staff Client version 1.2.1.4 on + Kubuntu 7.10; modify them as needed 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 + 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 + XULrunner. You can also use synaptic, the graphical user interface for apt-get. For subversion, - select the latest version; for xulrunner, + select the latest version; for XULrunner, select version 1.8.1.4-2ubuntu5. # as the root user @@ -449,75 +459,79 @@ 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. + 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.6.1.2) the supported + BUILD_ID is "rel_1_6_1_2". 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' + wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.1.2.tar.gz + tar xfz Evergreen-ILS-1.6.1.2.tar.gz + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + ./configure --prefix=/openils --sysconfdir=/openils/conf + cd ./Open-ILS/xul/staff_client/ + make STAFF_CLIENT_BUILD_ID='rel_1_6_1_2' install - Run the Staff Client (from the command line) + Run the Staff Client As the opensrf user, navigate to the build/ - subdirectory (not staff_client/) - and run the following command: + subdirectory and run the following command: # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build xulrunner application.ini - (OPTIONAL) Cleaning Up / Creating Shortcuts + (OPTIONAL) Clean Up / Create 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): + it. You may wish to remove them to save space, or to create a + clean staging directory containing the + finished Staff Client that can then be copied to other + machines. To do this, execute the following commands (remember + to replace DOWNLOAD_DIRECTORY and + STAGING_DIRECTORY with the appropriate + paths): # 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 + mkdir ~/STAGING_DIRECTORY + cd ~/DOWNLOAD_DIRECTORY/Open-ILS/xul/ + cp -r staff_client ~/STAGING_DIRECTORY - Finally, test the Staff Client to verify that all necessary - files were moved to the destination directory: + Test the Staff Client to verify that all necessary files + were copied to the staging directory: # as the opensrf user - cd ~/DESTINATION_DIRECTORY/staff_client/build + cd ~/STAGING_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: + If there were no problems, then finish the cleanup by + removing the original download directory 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. + Finally, the command: + + # as the opensrf user + xulrunner ~/STAGING_DIRECTORY/staff_client/build/application.ini + + will now run the Staff Client. You may wish to create a + shortcut for the Staff Client. To do so, use the previous + command as the target for the shortcut: + DesktopStartMenuK-Menu @@ -527,11 +541,14 @@ 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 + The Linux application Wine is another + alternative if you wish to install the packaged + Windows versions rather than manually + building the Staff Client. 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. You can find more information + about Wine at http://www.winehq.org/site/docs/wineusr-guide/getting-wine. As the root user, use @@ -546,661 +563,641 @@ - 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 - + Visit the downloads section of the Evergreen website at + + http://www.evergreen-ils.org/downloads.php and find the + Microsoft Windows Installer + that contains the desired version of the Staff Client. Download + the installer and place it in a temporary directory. - 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, navigate to the temporary directory where you downloaded + the Windows installer + file, then execute it with the wine + application (remember to replace VERSION with + the release number of the Staff Client you downloaded): # as the opensrf user - cd /YOUR/DOWNLOAD/DIRECTORY - wine evergreen-setup-rel_version-number.exe + cd /TEMP_DIRECTORY + wine evergreen-setup-rel_VERSION.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. + 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. You may also + find a new desktop shortcut for the Staff Client. To launch the + Staff Client, visit the your desktop's All + Applications menu and find the section similar to + WineProgram FilesEvergreen Staff ClientEvergreen Staff Client + or else launch the Staff Client from the new 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: +
+
+ 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.1.2/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 + variables that you can pass to make to influence the manual build + process: + + + <envar>STAFF_CLIENT_BUILD_ID</envar> + + 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. + You could use the following commands during the normal install process: + + # as the root user + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + make STAFF_CLIENT_BUILD_ID=1_6_1_2 install + + You can also manually build the Staff Client in the Staff Client + source directory with a different BUILD_ID. + As the opensrf user, + execute the following commands to build the Staff Client (remember to replace + NEW_VERSION with an appropriate value): + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + make STAFF_CLIENT_BUILD_ID=NEWVERSION build + + + + + <envar>STAFF_CLIENT_VERSION</envar> + + 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. + You could use the following commands during the normal install process: + + # as the root user + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + make STAFF_CLIENT_VERSION=0mytest.200 install + + You can also manually build the Staff Client in the Staff Client + source directory with 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, + execute the following commands to 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 + + + + + <envar>STAFF_CLIENT_STAMP_ID</envar> + + During the normal make install Evergreen + server-side software build process, the variable is generated from + STAFF_CLIENT_VERSION. You may want to have multiple versions + of the Staff Client with different stamps, possibly for different uses or + client-side customizations. You can override the value of + STAMP_ID similarly to the BUILD_ID. + You could use the following commands during the normal install process: + + # as the root user + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + make STAFF_CLIENT_STAMP_ID=my_test_stamp install + + You can also manually build the Staff Client in the Staff Client + source directory with a different STAMP_ID. + As the opensrf user, + execute the following commands to 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 the + staff_client 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. + + + +
+ Following are descriptions of other special build options: + + Developer Build + You can create a so-called developer build + of the Staff Client by substituting for + when running make from the + staff_client directory. The build will contain an + extra configuration file that enables some developer options. + 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 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 + when running make. + For more information on the Google Closure Compiler, see + + http://code.google.com/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 + You can override the host used to check for automatic Staff Client updates + by specifying the option. + You could use the following commands during the normal install process: + + # as the root user + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + make AUTOUPDATE_HOST=localhost install + + You can manually build the Staff Client in the Staff Client + source directory and set to enable automatic + update checking. + As the opensrf user, + execute the following commands to 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 from the + staff_client directory, 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 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 you have built the Staff Client, you can create several forms of special client + packages by using a modified make command in the staff_client + directory. + + Packaging a Generic Client + This build creates a Staff Client packaged as an XPI file suitable for use with + the parameter of XULrunner. + It requires that you already have the zip utility + installed on your system. + 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 + make generic-client + + The output file evergreen_staff_client.xpi will be created. + + + Packaging a <systemitem class="osname">Windows</systemitem> 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). You should use Version 2.45 or + later. + 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 modify resources within 32-bit + Windows executables. + Some useful icon ID strings include the following: - Keywords Targets for "make" Command + Useful icon ID strings - - - - 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" + IDI_APPICON + Tray icon - 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. + 32512 + Default window icon
- 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 + 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)" + make win-client -
-
- 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. + The output file evergreen_staff_client_setup.exe will be created. + + + Packaging a Linux Client + This build creates a Staff Client packaged as a compressed + tar archive file with XULrunner + already bundled with it. It requires that you already have the + bzip2 utility installed on your system. + 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 + make linux-client + + The output file evergreen_staff_client.tar.bz2 will be created. + + + Packaging a <application>Firefox</application> Extension + This build creates a Staff Client packaged as a Firefox + extension. It requires that you already have the zip + utility installed on your system. + 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 + make extension + + The output file evergreen.xpi will be created. + +
+
+ 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 + https://developer.mozilla.org/en/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 + You can manually set the name of the automatic update host. If you do + not set the name then, by default, the Staff Client will not include an + automatic update preference. You can set the autoupdate host name as + follows: - 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: + At configuration time during the normal make install + process for Evergreen server-side software. + You can do this when you first configure the Evergreen server-side + software (see ). + 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 - 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 + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + ./configure --prefix=/openils --sysconfdir=/openils/conf --with-updateshost=hostname + make - 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: + During a manual Staff Client build process. + You can override the variable + AUTOUPDATE_HOST=hostname and manually build the + Staff Client from the staff_client + directory (see + for details). If you specify only a bare hostname (for example, + example.com) then + the Staff Client will automatically use the secure URL + https://example.com. + If you wish to use a non-https URL, then you must explicitly + specify the full URL (for example, + http://example.com). + As the opensrf user, + execute the following commands to build the Staff Client (remember to + replace SOME_URL with an appropriate value) + : # as the opensrf user cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client - make extension + make AUTOUPDATE_HOST=http://SOME_URL build -
-
- Staff Client Automatic Updates + + + Building Updates staff client automatic updates + building - 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. - -
+ Similar to building clients, you can use the targets + , , + , and + 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 currently support + 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 the phrase "-client" to each + target name (for example, you could specify to build + all the targets at once, or you could specify + to build updates individually). This process will not work for the option + . + The clients will be installed alongside the updates and listed on the + manualupdate.html page, instead of being left in the + staff_client directory. + As the opensrf user, execute + one of the following commands: + To build all updates at once: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + make updates-client + + To build updates individually: + + # as the opensrf user + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client + 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). + To change the permissions for the scripts + check, download, + manualupdate.html, and + update.rdf, as the root user 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 any of the targets , + , or , you can + specify to add an option + "Evergreen Staff Client Profile Manager" to the + start menu. + 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 + make NSIS_EXTRAOPTS=-DPROFILES win-client + + + + Multiple Staff Clients + It 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 the previous + tip in ). + 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. +
@@ -1210,27 +1207,83 @@ 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: + You can run the Staff Client on a Linux system by using the + XULrunner application (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/ you can 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 + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build + xulrunner application.ini - - Running the Staff Client over an SSH Tunnel +
+ 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'. +
+
+ Running the Staff Client Over An <systemitem class="protocal">SSH</systemitem> Tunnel staff client running through an SSH tunnel - The Staff Client can use an SSH tunnel as a SOCKS 5 proxy. + 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: + 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 @@ -1246,17 +1299,19 @@ - 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 + Setting Up an <systemitem class="protocal">SSH</systemitem> 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: + 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 + Setting up an SSH + tunnel in PuTTY @@ -1282,10 +1337,9 @@ 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. + 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 @@ -1309,10 +1363,10 @@ - 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. + 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. - +
-- 2.43.2