1 <?xml version="1.0" encoding="UTF-8"?>
2 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xl="http://www.w3.org/1999/xlink">
3 <section xml:id="serversideinstallation-staffclient">
4 <title>Installing the Staff Client</title>
5 <para>The Staff Client is automatically built by default as part of the normal <emphasis>make install</emphasis> process for Evergreen server-side software. See the section <xref linkend="serversideinstallation-compilingevergreen"/> to review details related to building the Staff Client in the final compile/link/install phase of the default Evergreen build process. See the section <xref linkend="serversideinstallation-building-staffclient"/> for help on manually building the Staff Client. Otherwise, continue with the following sections to install a pre-built Staff Client.</para>
6 <simplesect xml:id="serversideinstallation-prebuilt-staffclient">
7 <title>Installing a Pre-Built Staff Client</title>
8 <para>You can install the Staff Client from pre-built images and packages without actually having to first build it. Pre-built packages are currently available for Windows, MAC OS X, and Linux. If you need to manually build the Staff Client, see the section <xref linkend="serversideinstallation-building-staffclient"/>.</para>
10 <title>Installing on Windows</title>
11 <para>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 <ulink url="http://www.evergreen-ils.org/downloads.php">http://www.evergreen-ils.org/downloads.php</ulink>. Download the staff client installer, then run it. A screen that looks similar to this should appear:</para>
13 <title>Running the Staff Client installer</title>
16 <imagedata fileref="../media/serversideinstallation-staffclient-1.png" scalefit="1" width="70%"/>
20 <para>Click the <emphasis>Next</emphasis> button 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.</para>
21 <para>When you run the staff client for the first time, a screen similar to this should appear:</para>
23 <title>Running the Staff Client for the first time</title>
26 <imagedata fileref="../media/serversideinstallation-staffclient-2.png" scalefit="1" width="70%"/>
30 <para>First, configure the server you would like to connect to in the <emphasis role="bold">Server</emphasis> section. For example, the PINES demo system is <emphasis role="bold">demo.gapines.org</emphasis>. After selecting a server, click the <emphasis role="bold">Re-Test Server</emphasis> button.</para>
31 <para>Because this is the initial run of the staff client, the <emphasis role="bold">Workstation</emphasis> section in the upper-right states: <emphasis role="bold">Not yet configured for the specified server</emphasis>. The first thing that must be done to the Staff Client on every workstation is to assign it a workstation name. This is covered in the section <xref linkend="serversideinstallation-workstationnames"/>.</para>
34 <title>Installing on Mac OS X</title>
35 <para>A Mac package that contains the current version of the Staff Client is available for use with XULRunner.</para>
38 <para>Evergreen Indiana Pkg file [Evergreen v1.2.3.0]</para>
40 <listitem>Download and install the latest version of XULRunner for Mac OS. Release notes for the latest version can be found here: <ulink url="http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes">http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes</ulink>. Note, later versions may not work correctly.</listitem>
41 <listitem>Download and install the Mac Installation package for the 1_2_3_0 Version Staff Client from <ulink url="http://evergreen.lib.in.us/opac/extras/files/evergreen_osx_staff_client_1_2_3.zip">http://evergreen.lib.in.us/opac/extras/files/evergreen_osx_staff_client_1_2_3.zip</ulink>.</listitem>
42 <listitem>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: <emphasis>C:\Program Files\Evergreen Staff Client\build</emphasis>. 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.</listitem>
43 <listitem>Drag the application's icon into your toolbar for easier access.</listitem>
46 <para>When you run the staff client installer, a screen will appear that looks similar to this:</para>
48 <title>Running the Staff Client installer</title>
51 <imagedata fileref="../media/serversideinstallation-staffclient-3.png" scalefit="1" width="20%"/>
55 <caution> FIX BAD LINK: http://es.zionsville.lib.in.us/atheos/eg_osx_a.gif </caution>
56 <para>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.</para>
58 <title>Finishing the installation</title>
61 <imagedata fileref="../media/serversideinstallation-staffclient-4.png" scalefit="1" width="20%"/>
65 <caution> FIX BAD LINK: http://es.zionsville.lib.in.us/atheos/eg_osx_a.gif </caution>
68 <para>Running directly using XULRunner</para>
69 <para>You must install an apropriate version of XULRunner to match the Evergreen version. See the following table for the recommended version of XULRunner:</para>
71 <title>Evergreen / XULRunner Dependencies</title>
72 <tgroup align="left" cols="2" colsep="1" rowsep="1">
73 <colspec colnum="1" colwidth="1*"/>
74 <colspec colnum="2" colwidth="3*"/>
77 <entry>Evergreen 1.6.x.x</entry>
78 <entry>XULrunner 1.9</entry>
81 <entry>Evergreen 1.4.x.x</entry>
82 <entry>XULrunner 1.8.0.4 or XULrunner 1.8.0.3</entry>
85 <entry>Evergreen 1.2.x.x</entry>
86 <entry>XULrunner 1.8.0.4 or XULrunner 1.8.0.3</entry>
91 <note>If you have issues removing previously installed XULRunner versions see <xref linkend="serversideinstallation-staffclient-remove-xulrunner"/> for information on removing previous XULRunner versions.</note>
92 <para>The staff client data from the <emphasis>./staff_client/build</emphasis> directory must be placed somewhere on the machine (e.g. <emphasis>~/Desktop/Evergreen_Staff_Client</emphasis>). Remember to call XULRunner with the full path to the binary, followed by the install command and the path to the client data. See the following command:</para>
94 <title>Executing XULRunner</title>
96 /Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_Client
99 <para>This command should exit quietly. A folder will be created, named <emphasis>/Applications/OpenILS</emphasis>, containing a launcher named <emphasis>open_ils_staff_client</emphasis>.</para>
101 <listitem xml:id="serversideinstallation-staffclient-remove-xulrunner">
102 <para>Removing previously installed XULRunner versions</para>
103 <para>If you already have a newer version installed, per the release notes, you will need to remove the entire directory <emphasis>/Library/Frameworks/XUL.framework</emphasis> before downgrading.</para>
104 <para>In addition, you may also need to remove the previous file <emphasis>/Library/Receipts/xulrunner-ver-mak.pkg</emphasis>.</para>
105 <para>If there is no file <emphasis>/Library/Receipts/xulrunner-ver-mak.pkg</emphasis> (possibly in newer OSX releases) you need to flush the <emphasis>receiptdb</emphasis> file.</para>
106 <note>If you install a newer version over a previous (older) install, the older one is not removed but the symlinks get changed to the newer one.</note>
107 <para>First, get the package identifier, then purge/forget the build that was initially installed:</para>
109 <title>Purging previous build</title>
111 sudo pkgutil --pkgs > /tmp/pkgs.txt
112 sudo pkgutil --forget org.mozilla.xulrunner
115 <note>It may not be necessary to edit the file <emphasis>/Library/Receipts/InstallHistory.plist</emphasis> after deleting the folder <emphasis>XUL.framework</emphasis>.</note>
118 <para>Creating an APP file: Staff Client & XULRunner Bundled</para>
119 <para>An APP file is basically a folder. Start with a folder stucture like this:</para>
121 <title>Sample APP file folder structure</title>
130 <para>Create an APP folder structure with the following commands:</para>
132 <title>Creating a folder structure</title>
134 mkdir -p Evergreen.app/Contents/Frameworks
135 mkdir -p Evergreen.app/Contents/Resources
136 mkdir -p Evergreen.app/Contents/MacOS
142 <para>Create a new file in the folder <emphasis>Evergreen.app/Contents/Info.plist</emphasis> containing the following data (adjust for your version of Evergreen):</para>
144 <title>Creating a new file</title>
146 <?xml version="1.0" encoding="UTF-8"?>
147 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
148 <plist version="1.0">
150 <key>CFBundleExecutable</key>
151 <string>xulrunner</string>
152 <key>CFBundleGetInfoString</key>
153 <string>OpenILS open_ils_staff_client rel_1_6_0_7</string>
154 <key>CFBundleInfoDictionaryVersion</key>
155 <string>6.0</string>
156 <key>CFBundleName</key>
157 <string>Evergreen Staff Client</string>
158 <key>CFBundlePackageType</key>
159 <string>APPL</string>
160 <key>CFBundleShortVersionString</key>
161 <string>rel_1_6_0_7</string>
162 <key>CFBundleVersion</key>
163 <string>rel_1_6_0_7.rel_1_6_0_7</string>
164 <key>NSAppleScriptEnabled</key>
166 <key>CFBundleTypeIconFile</key>
167 <string>Evergreen.icns</string>
173 <listitem>Download and install an appropriate Mac OS package of XULRunner from the Mozilla website (see above for recommendations).</listitem>
175 <para>Make a copy of <emphasis>/Library/Frameworks/XUL.Framework</emphasis> inside your APP file. It should look something like this:</para>
177 <title>Example of APP file framework</title>
182 ______* XUL.Framework/
184 ________* Current -> 1.9.1.3 (symlink)
186 ______* XUL -> Versions/Current/XUL
187 ______* libxpcom.dylib -> Versions/Current/libxpcom.dylib
188 ______* xulrunner-bin -> Versions/Current/xulrunner-bin
192 <listitem>Copy <emphasis>XUL.Framework/Versions/Current/xulrunner</emphasis> into <emphasis>Evergreen.app/MacOS</emphasis> (do not symlink; copy the file).</listitem>
194 <para>Make <emphasis>Evergreen.app/Resources</emphasis> the root of your Evergreen application files like this:</para>
196 <title>Example APP file</title>
202 ______* application.ini
209 <listitem>Put a Mac format icon file named <emphasis>Evergreen.icns</emphasis> in Resources.</listitem>
214 <simplesect xml:id="serversideinstallation-staffclient-linux">
215 <title>Installing on Linux</title>
217 <title>Quick Upgrade of the Staff Client</title>
218 <para>A Linux Staff Client is automatically built on the server as part of the normal <emphasis>make install</emphasis> 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.</para>
219 <para>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.</para>
220 <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then recursively copy the entire directory tree to the remote workstation:</para>
222 <title>Copying the Staff Client to a remote workstation</title>
225 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
226 $ scp -r build user@client.linux.machine:~/eg-client-x.x.x.x/
229 <para>To test the newly copied Staff Client, as the <emphasis role="bold">opensrf</emphasis> user log into the remote workstation and execute it as shown:</para>
231 <title>Testing the copied Staff Client</title>
234 $ xulrunner ~/eg-client-x.x.x.x/build/application.ini
239 <title>Building the Staff Client on the Server</title>
240 <para>A Linux Staff Client is automatically built on the server as part of the normal <emphasis>make install</emphasis> process for Evergreen server-side software.</para>
241 <para>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.</para>
242 <para>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.</para>
243 <para>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.</para>
245 <title>Creating a symbolic link</title>
248 $ cd /openils/var/web/xul
249 $ ln -s SERVER_BUILD_ID/ CLIENT_BUILD_ID
254 <title>Building the Staff Client on the client Machine</title>
255 <para>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).</para>
258 <para>Prerequisites</para>
259 <para>Both "subversion" and "xulrunner" are required to build the Staff Client. As the <emphasis role="bold">root</emphasis> 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 <emphasis>1.8.1.4-2ubuntu5</emphasis>.</para>
261 <title>Installing subversion and xulrunner</title>
263 $ sudo apt-get install subversion
264 $ sudo apt-get install xulrunner
269 <para>Download the Source Code</para>
272 <para>Determine which version is needed</para>
273 <para>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.</para>
274 <para>Next, you need to determine which <emphasis>tag</emphasis> 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.</para>
275 <para>To determine which tag to use, browse to <ulink url="http://svn.open-ils.org/trac/ILS/browser">http://svn.open-ils.org/trac/ILS/browser</ulink>. Look in the "Visit" drop-down box; see the list of Branches and, further down, a list of Tags. You may have to do some guesswork, but it is fairly straightforward to determine which tag to use. If the server is version 1.2.1.4, you will want to use the tag that looks most appropriate. For example, as you look through the tag list, notice the tag named 'rel_1_2_1_4'. This is the tag you need; make a note of it for the next step.</para>
278 <para>Download the Code</para>
279 <para>As the <emphasis role="bold">opensrf</emphasis> 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:</para>
281 <title>Downloading the source code</title>
284 $ cd /YOUR/DOWNLOAD/DIRECTORY
285 $ svn co svn://svn.open-ils.org/ILS/tags/rel_1_2_1_4/
288 <para>Remember to change "rel_1_2_1_4" to the appropriate tag for your installation.</para>
293 <para>Build the Staff Client</para>
296 <para>Evergreen 1.2.x</para>
297 <para>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.</para>
298 <para>As the <emphasis role="bold">opensrf</emphasis> user, run the following commands to build the Staff Client:</para>
300 <title>Finding the downloaded source code</title>
303 $ cd /YOUR/DOWNLOAD/DIRECTORY
304 $ cd Open-ILS/xul/staff_client
305 $ make STAFF_CLIENT_BUILD_ID='rel_1_2_1_4'
311 <para>Evergreen 1.4.x</para>
312 <para>The 1.4 series of Evergreen has complicated the build process for the Staff Client a bit. If you downloaded a .tar.gz (compressed tar archive) of Evergreen, then your steps will resemble the following:</para>
313 <caution>FIXME -- Need instructions for getting certain Javascript files from OpenSRF, preferably without actually installing OpenSRF.
316 <title>Building 1.4.x</title>
319 $ wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.4.0.4.tar.gz
320 $ tar xfz Evergreen-ILS-1.4.0.4.tar.gz
321 $ cd Evergreen-ILS-1.4.0.4/
322 $ ./configure --prefix=/openils --sysconfdir=/openils/conf
323 $ cd Open-ILS/xul/staff_client/
324 $ make STAFF_CLIENT_BUILD_ID='rel_1_4_0_4' install
328 <para>If you're installing from a Subversion checkout:</para>
330 <title>Building from a "subversion" checkout</title>
333 $ svn co svn://svn.open-ils.org/ILS/tags/rel_1_4_0_4/
335 $ ./autogen.sh # If you downloaded a .tar.gz of Evergreen, you may skip this step
336 $ ./configure --prefix=/openils --sysconfdir=/openils/conf
337 $ cd Open-ILS/xul/staff_client/
338 $ make STAFF_CLIENT_BUILD_ID='rel_1_4_0_4' install
345 <para>Run the Staff Client (from the command line)</para>
346 <para>As the <emphasis role="bold">opensrf</emphasis> user, navigate to the <emphasis>build/</emphasis> subdirectory (not <emphasis>staff_client/</emphasis>) and run the following command:</para>
348 <title>Running the Staff Client</title>
351 $ xulrunner application.ini
356 <para>(OPTIONAL) Cleaning Up / Creating Shortcuts</para>
357 <para>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. To create a clean "staging" directory in which to place the finished staff client, issue the following commands:</para>
359 <title>Creating a "staging" directory</title>
361 $ mkdir ~/<Destination Directory>
362 $ cd ~/<Download Directory>/Open-ILS/xul/
363 $ cp -r staff_client ~/<Destination Directory>
366 <para>Finally, test the Staff Client to verify that all the necessary files were moved to the destination directory:</para>
368 <title>Testing the copied Staff Client</title>
370 $ cd ~/<Destination Directory>/staff_client/build
371 $ xulrunner application.ini
374 <para>If there were no problems, then finish the cleanup by removing the original download directory and all subdirectories:</para>
376 <title>Cleaning up</title>
378 $ rm -r -f ~/<Download Directory>
381 <para>Finally, test the copied Staff Client. You can create "Desktop / Start Menu / K-Menu" shortcuts for the Staff Client by using the following command as the target:</para>
383 <title>Running the copied Staff Client</title>
385 $ xulrunner ~/<Destination Directory>/staff_client/build/application.ini
392 <title>Using Wine to Install On Linux</title>
393 <para>The Linux application <emphasis>Wine</emphasis> is another alternative for those who wish to install the packaged Windows versions rather than building the Staff Client manually. Wine is a Linux application that allows users to directly run Windows executables, and is a simple way for casual Linux users to use the Staff Client. More information about Wine can be found at <ulink url="http://www.winehq.org/site/docs/wineusr-guide/getting-wine">http://www.winehq.org/site/docs/wineusr-guide/getting-wine</ulink>.</para>
394 <para>As the <emphasis role="bold">root</emphasis> user, use "apt-get" to install the package for "wine". You can also use "synaptic", the graphical user interface.</para>
397 <para>Install wine</para>
399 <title>Installing "wine"</title>
401 $ sudo apt-get install wine
406 <para>Download Windows installer for the Staff Client</para>
407 <para>As the <emphasis role="bold">opensrf</emphasis> user, run the following commands to download the Windows installer for the proper Staff Client from the <emphasis>open-ils.org</emphasis> website and place it in a temporary directory:</para>
409 <title>Downloading the Staff Client installer</title>
412 $ cd /YOUR/DOWNLOAD/DIRECTORY
413 $ wget http://open-ils.org/downloads/evergreen-setup-rel_version-number.exe
418 <para>Run the downloaded Windows installer</para>
419 <para>As the <emphasis role="bold">opensrf</emphasis> user, navigate to the directory where you downloaded the Windows executable file, then execute it:</para>
421 <title>Using Wine to run the Windows installer</title>
424 $ cd /YOUR/DOWNLOAD/DIRECTORY
425 $ wine evergreen-setup-rel_version-number.exe
428 <para>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".</para>
431 <para>Launch the Staff Client</para>
432 <para>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.</para>
437 <title>Running the Staff Client over an SSH Tunnel</title>
438 <para>The Staff Client can use an SSH tunnel as a SOCKS 5 proxy. For more details, see the section <xref linkend="serversideinstallation-proxy"/>.</para>
440 <section xml:id="serversideinstallation-workstationnames">
441 <title>Assigning Workstation Names</title>
442 <para>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.</para>
444 <title>Example of unconfigured Staff Client</title>
447 <imagedata fileref="../media/serversideinstallation-staffclient-workstationnames-1.png" scalefit="1" width="70%"/>
451 <para>In order to assign a workstation a name, a user with appropriate permissions must login to the Staff Client. In PINES, the local system administrator (OPSM) has the ability to assign workstation names in his or her library system. Library managers (LIBM's) have the ability within their branch. To assign a workstation a name, login to the system. You will be prompted to assign the workstation a library and a name:</para>
453 <title>Example of configured Staff Client</title>
456 <imagedata fileref="../media/serversideinstallation-staffclient-workstationnames-2.png" scalefit="1" width="70%"/>
460 <para>Select the library this workstation physically operates in from the drop down menu. In this example, we have selected "MGRL-MA". Type in a friendly name for the workstation. In this example, we are installing the Staff Client on the director's personal system, and have named it as such. Then hit <emphasis role="bold">Register</emphasis>.</para>
461 <para>Once you have registered your workstation with the server, your screen will look like this:</para>
463 <title>Example of registered Staff Client</title>
466 <imagedata fileref="../media/serversideinstallation-staffclient-workstationnames-3.png" scalefit="1" width="70%"/>
470 <para>You are now ready to log into the Staff Client for the first time. Type in your password again, and hit <emphasis role="bold">Login</emphasis>.</para>
474 <simplesect xml:id="serversideinstallation-building-staffclient">
475 <title>Manually Building the Staff Client</title>
476 <para>The Staff Client is automatically built by default as part of the normal <emphasis>make install</emphasis> process for Evergreen server-side software. See the section <xref linkend="serversideinstallation-compilingevergreen"/> to review details related to building the Staff Client in the final compile/link/install phase of the default Evergreen build process.</para>
478 <title>Building the Staff Client</title>
479 <para>You can also manually build the Staff Client by using the <emphasis>make</emphasis> utility in the Staff Client source directory (e.g., the directory <emphasis>/home/opensrf/Evergreen-ILS-1.6.0.x/Open-ILS/xul/staff_client</emphasis> 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 <emphasis>make</emphasis> to influence the manual build process:</para>
481 <title>Option STAFF_CLIENT_BUILD_ID</title>
482 <para>During the normal <emphasis>make install</emphasis> 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.</para>
483 <para>The following commands could be used during the normal build process:</para>
485 <title>Commands used during normal Evergreen build</title>
488 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
489 $ make STAFF_CLIENT_BUILD_ID=rel_1_6_0_7 install
493 <para>The following commands will manually build the Staff Client using a different BUILD_ID.</para>
494 <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then set the variable and build the Staff Client:</para>
496 <title>Commands to manually build the Staff Client</title>
499 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
500 $ make STAFF_CLIENT_BUILD_ID=my_test_id build
506 <title>Option STAFF_CLIENT_VERSION</title>
507 <para>During the normal <emphasis>make install</emphasis> Evergreen server-side software build process, the variable is pulled automatically from a README file in the Evergreen source root. The variable defaults to <emphasis>0trunk.revision</emphasis>, where the value of "revision" is automatically generated. You can override the value of VERSION similarly to the BUILD_ID.</para>
508 <para>The following commands could be used during the normal build process:</para>
510 <title>Commands used during normal Evergreen build</title>
513 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
514 $ make STAFF_CLIENT_VERSION=0mytest.200 install
518 <para>The following commands will manually build the Staff Client using a different VERSION.</para>
519 <para>If you plan to make extensions update automatically, the VERSION needs to conform to the format recommended in <ulink url="https://developer.mozilla.org/en/Toolkit_version_format">Toolkit Version Format</ulink> and newer versions need to be "higher" than older versions.</para>
520 <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then set the variable and build the Staff Client:</para>
522 <title>Commands to manually build the Staff Client</title>
525 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
526 $ make STAFF_CLIENT_VERSION=0mytest.200 build
532 <title>Option STAFF_CLIENT_STAMP_ID variable</title>
533 <para>During the normal <emphasis>make install</emphasis> 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.</para>
534 <para>The following commands could be used during the normal build process:</para>
536 <title>Commands used during normal Evergreen build</title>
539 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
540 $ make STAFF_CLIENT_STAMP_ID=my_test_stamp install
544 <para>The following commands will manually build the Staff Client using a different STAMP_ID.</para>
545 <para>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.</para>
546 <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then set the variable and build the Staff Client:</para>
548 <title>Commands to manually build the Staff Client</title>
551 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
552 $ make STAFF_CLIENT_STAMP_ID=my_test_stamp build
559 <title>Advanced Build Options</title>
560 <para>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 <emphasis>make</emphasis> utility and require that you build the Staff Client from its source directory. See the following table for a list of possible <emphasis>make</emphasis> target keywords:</para>
562 <title>Keywords Targets for "make" Command</title>
563 <tgroup align="left" cols="2" colsep="1" rowsep="1">
564 <colspec colnum="1" colwidth="1*"/>
565 <colspec colnum="2" colwidth="3*"/>
568 <entry>Keyword</entry>
569 <entry>Description</entry>
574 <entry>clients</entry>
575 <entry>Runs "make win-client", "make linux-client", and "make generic-client" individually</entry>
578 <entry>client_dir</entry>
579 <entry>Builds a client directory from the build directory, without doing a rebuild. The same as "copy everything but server/".</entry>
582 <entry>client_app</entry>
583 <entry>Prerequisite "client_dir"; removes "install.rdf" from client directory so an APP bundle can't be installed as an extension</entry>
586 <entry>client_ext</entry>
587 <entry>Prerequisite "client_dir"; remove "application.ini", "autoupdate.js", "standalone_xul_app.js" from client directory so an extension won't break Firefox</entry>
590 <entry>extension</entry>
591 <entry>Prerequisite "client_ext"; rewritten to use "client_ext"</entry>
594 <entry>generic-client</entry>
595 <entry>Prerequisite "client_app"; makes an XPI file suitable for use with "xulrunner --install-app""</entry>
598 <entry>win-xulrunner</entry>
599 <entry>Prerequisite "client_app"; adds Windows xulrunner to client build</entry>
602 <entry>linux-xulrunner</entry>
603 <entry>Prerequisite "client_app"; adds Linux xulrunner to client build</entry>
606 <entry>win-client</entry>
607 <entry>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")</entry>
610 <entry>linux-client</entry>
611 <entry>Prerequisite "linux_xulrunner"; builds a "tar.bz2" bundle of the Linux client</entry>
614 <entry>[generic-|win-|linux-|extension-]updates[-client]</entry>
615 <entry>Calls external/make_updates.sh to build full and partial updates generic/win/linux/extension prefix limit to that distribution; Adding "-client" builds clients and copies them to a subdirectory of the "updates" directory as well; "extension-updates-client" doesn't exist.</entry>
620 <para>Descriptions of other special build options follow:</para>
623 <para>Developer Build</para>
624 <para>You can create a so-called "developer build" of the Staff Client by substituting "devbuild" for "build" when running <emphasis>make</emphasis>. The build will contain an extra configuration file that enables some developer options.</para>
625 <para>As the <emphasis role="bold">opensrf</emphasis> user, run <emphasis>make</emphasis> from the Staff Client source directory:</para>
627 <title>Commands to do a "developer build"</title>
630 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
637 <para>Compressed Javascript</para>
638 <para>You can execute the Google "Closure Compiler" utility to automatically review and compress Javascript code after the build process completes, by substituting "compress-javascript" for "build" when running <emphasis>make</emphasis>. For more information see <ulink url="http://code.google.com/closure/compiler/">Google "Closure Compiler"</ulink>.</para>
639 <para>As the <emphasis role="bold">opensrf</emphasis> user, run the following commands from the Staff Client source directory:</para>
641 <title>Commands to compress Javascript</title>
644 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
645 $ make compress-javascript
649 <para>You can also combine Javascript review and compression, and also perform a "developer build".</para>
650 <para>As the <emphasis role="bold">opensrf</emphasis> user, run the following commands from the Staff Client source directory:</para>
652 <title>Commands to compress Javascript and do a "developer build"</title>
655 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
657 # order of options is important!
658 $ make devbuild compress-javascript
664 <para>Automatic Update Host</para>
665 <para>The host used to check for automatic Staff Client updates can be overridden by specifying the AUTOUPDATE_HOST option. The following commands could have been used during the normal build process:</para>
667 <title>Commands to set AUTOUPDATE_HOST for normal Evergreen build</title>
670 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
671 $ make AUTOUPDATE_HOST=localhost install
675 <para>You can manually set AUTOUPDATE_HOST to set up automatic update checking. The following commands will manually build the Staff Client using a different AUTOUPDATE_HOST.</para>
676 <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then set the variable and build the Staff Client:</para>
678 <title>Commands to manually specify AUTOUPDATE_HOST</title>
681 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
682 $ make AUTOUPDATE_HOST=localhost build
686 <para>For more information on Automatic Updates, see the section <xref linkend="serversideinstallation-staffclient-autoupdate"/>.</para>
691 <title>Installing and Activating a Manually Built Staff Client</title>
692 <para>The Staff Client is automatically built, installed and activated as part of the normal <emphasis>make install</emphasis> 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.</para>
693 <para>Assuming you have already built the Staff Client, and that your installation is in the directory <emphasis>/openils/var/web/xul</emphasis>, as the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then execute the following commands:</para>
695 <title>Commands to install the Staff Client on the same machine</title>
698 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
699 $ mkdir -p "/openils/var/web/xul/$(cat build/BUILD_ID)"
700 $ cp -R build/server "/openils/var/web/xul/$(cat build/BUILD_ID)"
705 <title>Packaging the Staff Client</title>
706 <para>Once the Staff Client has been built, you can create several forms of client packages by using some targetted <emphasis>make</emphasis> commands in the Staff Client source directory.</para>
709 <para>Packaging a Generic Client</para>
710 <para>This build creates a Staff Client packaged as an XPI file to use with <emphasis>XULRunner</emphasis>. 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 <emphasis>XULRunner</emphasis> parameter <emphasis>--install-app</emphasis>.</para>
711 <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then execute the following commands:</para>
713 <title>Commands to package a "generic" client</title>
716 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
717 $ make generic-client
723 <para>Packaging a Windows Client</para>
724 <para>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 <ulink url="http://nsis.sourceforge.net/">NSIS (Nullsoft Scriptable Install System)</ulink>, 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".</para>
725 <para>(OPTIONAL) If you wish for the Staff Client to have a link icon/tray icon by default, you may wish to provide a pre-modified <emphasis>xulrunner-stub.exe</emphasis>. Place it in the Staff Client source directory and <emphasis>make</emphasis> will automatically use it instead of the one that comes with the downloaded <emphasis>XULRunner</emphasis> release. The version of <emphasis>xulrunner-stub.exe</emphasis> need not match exactly.</para>
726 <para>(OPTIONAL) You can also use a tool such as <ulink url="http://www.angusj.com/resourcehacker/">Resource Hacker</ulink> 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:</para>
728 <title>Useful icon ID strings</title>
729 <tgroup align="left" cols="2" colsep="1" rowsep="1">
730 <colspec colnum="1" colwidth="1*"/>
731 <colspec colnum="2" colwidth="1*"/>
734 <entry>IDI_APPICON</entry>
735 <entry>Tray icon</entry>
739 <entry>Default window icon</entry>
744 <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then execute the following commands:</para>
746 <title>Commands to build a Windows client</title>
749 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
756 <para>Packaging a Linux Client</para>
757 <para>This build creates a Staff Client package for Linux as a "tar.bz2" file with <emphasis>XULRunner</emphasis> already bundled with it. It creates the output file "evergreen_staff_client.tar.bz2".</para>
758 <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then execute the following commands:</para>
760 <title>Commands to build a Linux client</title>
763 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
770 <para>Packaging a Firefox Extension</para>
771 <para>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".</para>
772 <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then execute the following commands:</para>
774 <title>Commands to build a Firefox extension</title>
777 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
785 <section xml:id="serversideinstallation-staffclient-autoupdate">
786 <title>Staff Client Automatic Updates</title>
787 <para>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.</para>
789 <title>WARNINGS</title>
790 <para>Automatic update server certificate requirements are more strict than normal server requirements. Firefox and <emphasis>XULRunner</emphasis> 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 <emphasis>WILL NOT WORK</emphasis>.</para>
791 <para>In addition, automatic updates have special requirements for the file <emphasis>update.rdf</emphasis>:</para>
793 <listitem>It must be served from an SSL server, or</listitem>
794 <listitem>It must be signed with the <ulink url="https://developer.mozilla.org/en/McCoy">McCoy</ulink> tool.</listitem>
796 <para>You can pre-install the signing key into the file <emphasis>install.rdf</emphasis> directly, or install it into a copy as <emphasis>install.mccoy.rdf</emphasis>. If the latter exists it will be copied into the build instead of the original file <emphasis>install.rdf</emphasis>.</para>
799 <title>Autoupdate Host</title>
800 <para>The name of the automatic update host can be provided in either of two ways:</para>
802 <listitem>At configuration time for the normal build of the Evergreen server-side software, or</listitem>
803 <listitem>During a manual Staff Client build process.</listitem>
808 <para>At configuration time for the normal build of Evergreen server-side software</para>
809 <para>This must be done when the Evergreen server-side software is first configured (see the section <xref linkend="serversideinstallation-configure"/>). As the <emphasis role="bold">opensrf</emphasis> user, use the utility "configure" as shown:</para>
811 <title>Commands to configure Evergreen</title>
814 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
815 $ ./configure --prefix=/openils --sysconfdir=/openils/conf --with-updateshost=hostname
822 <para>During a manual Staff Client build process</para>
823 <para>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").</para>
824 <para>If neither option is used then, by default, the Staff Client will not include the automatic update preferences.</para>
829 <title>Building Updates</title>
830 <para>Similar to building clients, the targets "generic-updates", "win-updates", "linux-updates", and "extension-updates" can be used individually with <emphasis>make</emphasis> to build the update files for the Staff Client. To build all the targets at once, simply use the target "updates".</para>
831 <para>A "full" update will be built for each specified target (or for all if you use the target "updates"). For all but extensions any previous "full" updates (archived by default in the directory <emphasis>/openils/var/updates/archives</emphasis>) 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.</para>
832 <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then execute the following commands:</para>
834 <title>Commands for building updates</title>
837 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
839 # command to build all updates at once:
843 # commands to build updates individually:
844 $ make generic-updates
850 $ make extension-updates
856 <title>Building updates with clients</title>
857 <para>To save time and effort you can build updates and manual download clients at the same time by adding the string "-client" to each target name. For instance, you can specify "win-updates-client". You can also specify "updates-client" to build all the targets at once. This does not work for extension-updates.</para>
858 <para>The clients will be installed alongside the updates and listed on the "manualupdate.html" page, rather than left in the Staff Client directory.</para>
859 <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then execute the following commands:</para>
861 <title>Commands for building updates</title>
864 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
866 # command to build all updates at once:
867 $ make updates-client
870 # commands to build updates individually:
871 $ make generic-updates-client
873 $ make win-updates-client
875 $ make linux-updates-client
881 <title>Activating the Update Server</title>
882 <para>This section reviews scripts associated with the update server, and requires some final adjustments to file permissions.</para>
883 <para>The Apache example configuration creates an "updates" directory that, by default, points to the directory <emphasis>/openils/var/updates/pub</emphasis>. This directory contains one HTML file and several specially-named script files.</para>
884 <para>The "updatedetails.html" file is the fallback web page for the update details. The "check" script is used for <emphasis>XULRunner</emphasis> updates. The "update.rdf" script is used for extension updates. The "manualupdate.html" script checks for clients to provide download links when automatic updates have failed and uses the download script to force a download of the generic client XPI (compared to Firefox trying to install it as an extension).</para>
885 <para>The following scripts should be marked as executable: <emphasis>check, download, manualupdate.html, update.rdf</emphasis>. As the <emphasis role="bold">root</emphasis> user, change directory to the updates directory, then execute the following commands:</para>
887 <title>Changing file permissions of scripts</title>
890 $ cd /openils/var/updates/pub
891 $ chmod +x check download manualupdate.html update.rdf
897 <title>Other tips</title>
899 <title>Multiple workstations on one install</title>
900 <para>Multiple workstation registrations for the same server can be accomplished with a single Staff Client install by using multiple profiles. When running <emphasis>XULRunner</emphasis> 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.</para>
901 <para>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.</para>
902 <para>When building targets "win-client", "win-updates-client", or "updates-client", you can specify "NSIS_EXTRAOPTS=-DPROFILES" to add an "Evergreen Staff Client Profile Manager" option to the start menu.</para>
903 <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then execute the following commands:</para>
905 <title>Command to add start menu option</title>
908 $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
909 $ make NSIS_EXTRAOPTS=-DPROFILES win-client
915 <title> Multiple Staff Clients</title>
916 <para>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).</para>
917 <para>Once you have created the profiles, run <emphasis>XULRunner</emphasis> with the option "-no-remote" (in addition to "-profilemanger" or "-P" if neeeded). Instead of <emphasis>XULRunner</emphasis> 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.</para>
922 <section xml:id="serversideinstallation-running-staffclient">
923 <title>Running the Staff Client</title>
924 <para>Run the Staff Client on a Linux system by using the application <emphasis>XULRunner</emphasis> (installed automatically and by default with Firefox version 3.0 and later on Ubuntu and Debian distributions).</para>
925 <para>For example, if the source files for the Evergreen installation are in the directory <emphasis>/home/opensrf/Evergreen-ILS-1.6.0.7/</emphasis>, start the Staff Client as shown in the following command example:</para>
927 <title>Commands to run the Staff Client</title>
930 $ xulrunner /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client/build/application.ini
934 <section xml:id="serversideinstallation-proxy">
935 <title>Configuring a Proxy for the Staff Client</title>
937 <title>Why Use a Proxy for the Staff Client?</title>
938 <para>There are several reasons for sending network traffic for the Staff Client through an SSH proxy:</para>
941 <para><emphasis role="bold">Firewalls</emphasis> 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.</para>
944 <para>You may wish to <emphasis role="bold">improve security</emphasis> 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.</para>
949 <title>Setting Up an SSH Tunnel</title>
950 <para>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.</para>
951 <para>For Windows users, one good solution is the open-source utility <ulink url="http://www.chiark.greenend.org.uk/~sgtatham/putty/">PuTTY</ulink>, a free telnet/SSH client]]. When setting up a PuTTY session:</para>
953 <title>Setting up an SSH tunnel in PuTTY</title>
956 <imagedata fileref="../media/serversideinstallation-proxy-putty.png" scalefit="1" width="70%"/>
961 <listitem>Use the menu on the left to go to Connection > SSH > Tunnels.</listitem>
962 <listitem>Enter ''9999'' in the "Source port".</listitem>
963 <listitem>Choose "Dynamic". Do not enter anything in the Destination text entry box.</listitem>
964 <listitem>Click the "Add" button. "D9999" will now appear in the "Forwarded ports" list.</listitem>
965 <listitem>Use the menu on the left to go back to "Session", and enter the host name of the SSH server.</listitem>
966 <listitem>A window will open up so that you can enter your username and password. Once you are logged in, the tunnel is open.</listitem>
970 <title>Configuring the Staff Client to Use the SSH Tunnel</title>
971 <para>In order to tell the Staff Client that all traffic should be sent through the SSH tunnel just configured, you must edit the file <emphasis>C:\Program Files\Evergreen Staff Client\greprefs\all.js</emphasis>. Search this file for the word <emphasis role="bold">socks</emphasis> to find the appropriate section for the following changes.</para>
973 <title>The SOCKS section of "all.js" before changes</title>
976 <imagedata fileref="../media/serversideinstallation-proxy-socks-1.png" scalefit="1" width="70%"/>
980 <para>Make the following changes:</para>
982 <listitem>Change the value of <emphasis>network.proxy.socks</emphasis> from <emphasis role="bold">""</emphasis> to <emphasis role="bold">"localhost"</emphasis>.</listitem>
983 <listitem>Change the value of <emphasis>network.proxy.socks_port</emphasis> from <emphasis role="bold">"0"</emphasis> to <emphasis role="bold">9999</emphasis>.</listitem>
985 <figure xml:id="serversideinstallation-socks-figure">
986 <title>The SOCKS section of "all.js" after changes</title>
989 <imagedata fileref="../media/serversideinstallation-proxy-socks-2.png" scalefit="1" width="70%"/>
993 <para>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.</para>
projects / working / Evergreen.git / blob