1 <?xml version="1.0" encoding="UTF-8"?>
2 <chapter xml:id="staffclientinstallation" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xl="http://www.w3.org/1999/xlink">
4 <title>Installation of Evergreen Staff Client Software</title>
6 <para>This section describes installation of the Evergreen Staff Client software.</para>
9 <section xml:id="staffclientinstallation-installing-staffclient">
10 <title>Installing the Staff Client</title>
12 <primary>staff client</primary>
13 <secondary>installing</secondary>
15 <section xml:id="staffclientinstallation-installing-prebuilt">
16 <title>Installing a Pre-Built Staff Client</title>
17 <para>A pre-built Staff Client is available for <systemitem class="osname">Windows</systemitem>,
18 <systemitem class="osname">Mac</systemitem> or Linux systems. Installing the Staff Client in
19 each of these environments is described in the following sections.</para>
20 <section xml:id="staffclientinstallation-installing-windows">
21 <title>Installing on <systemitem class="osname">Windows</systemitem></title>
23 <primary>staff client</primary>
24 <secondary>installing</secondary>
25 <tertiary>Windows</tertiary>
27 <para>In this section we describe the process of installing the Staff Client on the
28 <systemitem class="osname">Microsoft Windows</systemitem> operating system.</para>
29 <para>Visit the downloads section of the Evergreen website at
30 <ulink url="http://www.evergreen-ils.org/downloads.php">http://www.evergreen-ils.org/downloads.php</ulink>
31 and find the standard <systemitem class="osname">Microsoft Windows</systemitem> Installer
32 that contains the current version of the Staff Client. Download the Installer, then run
33 it. A screen that looks similar to this should appear:</para>
36 <phrase>Running the Staff Client installer</phrase>
39 <imagedata fileref="../media/staffclientinstallation-staffclient-1.png" format="PNG" scalefit="1" width="60%"/>
42 <para>Click <guibutton>'Next'</guibutton> to continue through the guided install
43 process. The Install Wizard will ask you to agree to the end-user license, ask you where
44 to install the software, ask about where to place icons, and then will automatically
45 install the software on your workstation.</para>
46 <para>When you run the Staff Client for the first time, a screen similar to this should
50 <phrase>Running the Staff Client for the first time</phrase>
53 <imagedata fileref="../media/staffclientinstallation-staffclient-2.png" format="PNG" scalefit="1" width="60%"/>
56 <para>First, add the name of your Evergreen server to the field
57 <emphasis role="bold">Hostname</emphasis> in the <emphasis role="bold">Server</emphasis>
58 section. For example, the PINES demo system is
59 <ulink url="http://demo.gapines.org">http://demo.gapines.org</ulink>.
60 After adding the server name, click <guibutton>'Re-Test Server'</guibutton>.</para>
61 <para>Because this is the initial run of the Staff Client, you will see a warning in the
62 upper-right saying: <emphasis role="bold">Not yet configured for the specified
63 server</emphasis>. The first thing you must do to the Staff Client on every workstation
64 is to assign it a workstation name. This is covered in
65 <xref linkend="staffclientinstallation-workstationnames"/>.</para>
67 <section xml:id="staffclientinstallation-installing-macos">
68 <title>Installing on <systemitem class="osname">Mac OS</systemitem></title>
70 <primary>staff client</primary>
71 <secondary>installing</secondary>
72 <tertiary>Mac OS</tertiary>
74 <para>This section describes <systemitem class="osname">Mac OS</systemitem>
75 packages and related versions of <application>XULrunner</application> that can
76 be used to run the Staff Client in a <systemitem class="osname">Mac OS</systemitem>
79 <title>Evergreen Version 1.2.3.0</title>
82 <para>A <systemitem class="osname">Mac OS</systemitem> package that
83 contains an early version of the Staff Client (version 1.2.3.0) for use
84 with <application>XULrunner</application> is available. You can find
85 current releases of <application>XULrunner</application> here:
86 <ulink url="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases">
87 http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases</ulink> .
88 Download and install the latest version. You can find further information
89 about <application>XULrunner</application> here:
90 <ulink url="https://developer.mozilla.org/en/xulrunner">
91 https://developer.mozilla.org/en/xulrunner</ulink>.</para>
92 <para>Note that later versions of <application>XULrunner</application>
93 (e.g., version 1.9.2.13) have replaced version 1.8.0.4, which has known
94 security holes and is not recommended for applications that deal with
95 public web content.</para>
98 <para>A <systemitem class="osname">Mac OS</systemitem>
99 Installation package for Staff Client version 1.2.3.0 is
100 available from Evergreen Indiana. Download and install it from
102 <ulink url="http://evergreen.lib.in.us/opac/extras/files/evergreen_osx_staff_client_1_2_3.zip">
103 evergreen_osx_staff_client_1_2_3.zip</ulink> .
107 <para>To upgrade to a more recent version of the Staff Client, you can
108 copy the <filename class="directory">build</filename> directory from a
109 working <systemitem class="osname">Windows</systemitem> installation of
110 the desired version of the Staff Client to your
111 <systemitem class="osname">Mac</systemitem>.
112 The required files may be located in a directory like this on the
113 <systemitem class="osname">Windows</systemitem> machine:
114 <filename class="directory">C:\Program Files\Evergreen Staff Client\build</filename>.
115 Copy these files to the <filename class="directory">Resources</filename>
116 folder within the <package>Open-ILS</package> package in your
117 <filename class="directory">Applications</filename> directory on the Mac,
118 overwriting files with the same names.</para>
120 <listitem>Drag the application's icon to your toolbar for easier
123 <para>When you run the Staff Client installer, a screen will appear that looks
124 similar to this:</para>
127 <phrase>Running the Staff Client installer for
128 <systemitem class="osname">Mac OS</systemitem></phrase>
131 <imagedata fileref="../media/staffclientinstallation-staffclient-3.png" format="PNG" scalefit="1" width="20%"/>
134 <para>Click <guibutton>'Continue'</guibutton>, accept the license, then finish the
135 installation. The application will be located at the destination you selected
136 during installation. You will then be able to drag the application into your
137 toolbar for easier access.</para>
140 <phrase>Finishing the installation</phrase>
143 <imagedata fileref="../media/staffclientinstallation-staffclient-4.png" format="PNG" scalefit="1" width="20%"/>
148 <title>Running directly using <application>XULrunner</application></title>
150 <primary>staff client</primary>
151 <secondary>XULRunner</secondary>
153 <para>You must install an appropriate version of <application>XULrunner</application>
154 to match the Evergreen version. See the following table for the recommended version of
155 <application>XULrunner</application>:</para>
156 <table xml:id="staffclientinstallation-table-1">
157 <?dbfo keep-together="always" ?>
158 <title>Evergreen / <application>XULrunner</application> Dependencies</title>
159 <tgroup cols="2" align="left" colsep="1" rowsep="1">
160 <colspec colnum="1" colname="evergreen_version" colwidth="1.0*"/>
161 <colspec colnum="2" colname="xulrunner_version" colwidth="1.0*"/>
164 <entry>Evergreen Version</entry>
165 <entry>XULRunner Version</entry>
170 <entry>Evergreen 1.6.x.x</entry>
171 <entry>XULrunner 1.9.x.x</entry>
174 <entry>Evergreen 1.4.x.x</entry>
175 <entry>XULrunner 1.8.0.4 or XULrunner 1.8.0.3</entry>
178 <entry>Evergreen 1.2.x.x</entry>
179 <entry>XULrunner 1.8.0.4 or XULrunner 1.8.0.3</entry>
184 <note>If you have issues removing previously installed
185 <application>XULrunner</application> versions see
186 <xref linkend="staffclientinstallation-remove-xulrunner"/>
187 for further information.</note>
188 <para>The Staff Client data from the directory
189 <filename class="directory">./staff_client/build</filename> must be placed
190 somewhere on the machine (e.g.
191 <filename class="directory">~/Desktop/Evergreen_Staff_Client</filename>).</para>
192 <para>Remember to call <application>XULrunner</application> with the full path to the
193 binary, followed by the install command and the path to the client data:</para>
196 /Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_Client
199 <para>The command should exit quietly and will create the folder
200 <filename class="directory">/Applications/OpenILS</filename>,
201 containing a launcher named <application>open_ils_staff_client</application>.</para>
203 <simplesect xml:id="staffclientinstallation-remove-xulrunner">
204 <title>(OPTIONAL) Removing previously installed XULRunner versions</title>
206 <primary>XULRunner</primary>
207 <secondary>removing previous versions</secondary>
209 <para>If you already have a newer version of
210 <application>XULrunner</application> installed, per the release notes,
211 you will need to remove the entire directory
212 <filename class="directory">/Library/Frameworks/XUL.framework</filename>
213 before downgrading.</para>
214 <para>In addition, you may also need to remove the previous file
215 <filename>/Library/Receipts/xulrunner-ver-mak.pkg</filename> .</para>
216 <para>If file <filename>/Library/Receipts/xulrunner-ver-mak.pkg</filename> does
217 not exist (possibly in newer <systemitem class="osname">Mac OS</systemitem>
218 releases), you need to flush the file <filename>receiptdb</filename>.</para>
219 <note>If you install a newer version of <application>XULrunner</application>
220 over a previous (older) install, the older install is not removed but the
221 symlinks are changed to the newer one.</note>
224 <title>(OPTIONAL) Flush Receiptdb file:</title>
225 <para>First, get the package identifier, then purge/forget the build that was
226 initially installed:</para>
229 sudo pkgutil --pkgs > /tmp/pkgs.txt
230 sudo pkgutil --forget org.mozilla.xulrunner
233 <note>It may not be necessary to edit the file
234 <filename>/Library/Receipts/InstallHistory.plist</filename> after deleting the
235 folder <filename class="directory">XUL.framework</filename>. See
236 <ulink url="http://lists.apple.com/archives/Installer-dev/2009/Jul/msg00008.html">
237 http://lists.apple.com/archives/Installer-dev/2009/Jul/msg00008.html</ulink>
238 for more information.</note>
241 <title>Creating an APP file: Staff Client and <application>XULrunner</application> Bundled</title>
242 <para>An APP file is basically a folder. Start with a folder stucture like this:</para>
252 <para>Create an APP folder structure with the following commands:</para>
255 mkdir -p Evergreen.app/Contents/Frameworks
256 mkdir -p Evergreen.app/Contents/Resources
257 mkdir -p Evergreen.app/Contents/MacOS
262 <para>Create a new file in the folder
263 <filename class="directory">Evergreen.app/Contents/Info.plist</filename>
264 containing the following data (adjust for your version of
266 <programlisting language="xml"><![CDATA[
267 <?xml version="1.0" encoding="UTF-8"?>
268 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
269 <plist version="1.0">
271 <key>CFBundleExecutable</key>
272 <string>xulrunner</string>
273 <key>CFBundleGetInfoString</key>
274 <string>OpenILS open_ils_staff_client rel_1_6_1_2</string>
275 <key>CFBundleInfoDictionaryVersion</key>
277 <key>CFBundleName</key>
278 <string>Evergreen Staff Client</string>
279 <key>CFBundlePackageType</key>
280 <string>APPL</string>
281 <key>CFBundleShortVersionString</key>
282 <string>rel_1_6_1_2</string>
283 <key>CFBundleVersion</key>
284 <string>rel_1_6_1_2.rel_1_6_1_2</string>
285 <key>NSAppleScriptEnabled</key>
287 <key>CFBundleTypeIconFile</key>
288 <string>Evergreen.icns</string>
293 <listitem>Download and install an appropriate
294 <systemitem class="osname">Mac OS</systemitem> package of
295 <application>XULrunner</application> from the Mozilla website
296 <ulink url="https://developer.mozilla.org/en/xulrunner">
297 https://developer.mozilla.org/en/xulrunner</ulink> (see
298 <xref linkend="staffclientinstallation-table-1"/> for recommendations).</listitem>
300 <para>Make a copy of the folder
301 <filename class="directory">/Library/Frameworks/XUL.Framework</filename>
302 inside your APP file. It should look something like this:</para>
310 ________Current -> 1.9.1.3 (symlink)
312 ______XUL -> Versions/Current/XUL
313 ______libxpcom.dylib -> Versions/Current/libxpcom.dylib
314 ______xulrunner-bin -> Versions/Current/xulrunner-bin
319 <filename>XUL.Framework/Versions/Current/xulrunner</filename> into the
320 folder <filename class="directory">Evergreen.app/MacOS</filename>
321 (do not symlink; copy the file).</listitem>
323 <para>Make <filename>Evergreen.app/Resources</filename> the root
324 of your Evergreen application files like this:</para>
331 ______application.ini
338 <listitem>Put a <systemitem class="osname">Mac</systemitem>
339 format icon file named <filename>Evergreen.icns</filename> in
340 <filename class="resources">Resources</filename>.</listitem>
344 <section xml:id="staffclientinstallation-installing-linux">
345 <title>Installing on Linux</title>
347 <title>Quick Upgrade of the Staff Client</title>
348 <para>A Linux Staff Client is automatically built on the server as part of the
349 normal <emphasis>make install</emphasis> process for Evergreen server-side
350 software. To upgrade the Staff Client on a remote Linux workstation with a new
351 version, just copy the directory tree containing the Staff Client from your
352 server to the remote workstation.</para>
353 <para>Execute the following commands, replacing <literal>USER</literal>,
354 <literal>WORKSTATION</literal>, and <literal>SOME_PATH</literal> with
355 appropriate values:</para>
358 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
359 scp -r ./build USER@WORKSTATION:/SOME_PATH/
362 <para>You should test the newly copied Staff Client on the remote workstation.
363 Log into the workstation and execute the following command:</para>
366 xulrunner /SOME_PATH/build/application.ini
371 <title>Building the Staff Client on the Server</title>
373 <primary>staff client</primary>
374 <secondary>building on the server</secondary>
376 <para>A Linux Staff Client is automatically built on the server as part of the
377 normal <emphasis>make install</emphasis> process for Evergreen server-side
378 software. See <xref linkend="serversideinstallation-compile"/> for details of
379 the build process.</para>
380 <para>In order to install a compatible Staff Client on another Linux system, you
381 can copy the appropriate files from the Staff Client build directory on your
382 server to the new Linux system. You could manually build the Staff Client on the
383 new system, but you must ensure that the <envar>BUILD_ID</envar> you chose on
384 the server matches the <envar>BUILD_ID</envar> for each Staff Client you use on
385 other systems.</para>
386 <para>If you wish to use a pre-packaged <systemitem class="osname">Windows</systemitem>
387 version on some systems, you may want to choose the <envar>BUILD_ID</envar> on
388 both server and other versions to match that of the
389 <systemitem class="osname">Windows</systemitem> Staff Client. To determine which
390 <envar>BUILD_ID</envar> was used for existing Staff Client installations,
391 execute each Staff Client and click the <guibutton>'About this Client'</guibutton>
393 <para>If you are allowed to make changes on the Evergreen server, another option
394 is to create a symbolic link. In order for a copy of the Staff Client and server
395 to work together, the <envar>BUILD_ID</envar> must match the name of the
396 directory containing the server components of the Staff Client, or the name of a
397 symbolic link to that directory. As the
398 <systemitem class="username">root</systemitem> user, make the changes as follows:</para>
401 # as the root user:</prompt>
403 cd /openils/var/web/xul
404 ln -s SERVER_BUILD_ID/ CLIENT_BUILD_ID
409 <title>Building the Staff Client on a Client Machine</title>
410 <para>This section is directed toward end-users who wish to use Linux rather than
411 <systemitem class="osname">Windows</systemitem> for client machines, but have limited
412 Linux experience. You can build the Staff Client on a Linux system without installing the
413 Evergreen Server component. This is a relatively simple process compared to server
414 installation, but does require some command-line work. The following instructions are
415 for building Staff Client version 1.2.1.4 on
416 <systemitem class="osname">Kubuntu 7.10</systemitem>; modify them as needed for
417 other distributions (the instructions should work as-is for
418 <systemitem class="osname">Ubuntu</systemitem> or
419 <systemitem class="osname">Ubuntu</systemitem> derivatives).</para>
422 <title>Prerequisites</title>
423 <para>Both <application>subversion</application> and
424 <application>XULrunner</application> are required to build the Staff
425 Client. As the <systemitem class="username">root</systemitem> user,
426 use <command>apt-get</command> to install packages for
427 <application>subversion</application> and
428 <application>XULrunner</application>. You can also use
429 <command>synaptic</command>, the graphical user interface for
430 <command>apt-get</command>. For <application>subversion</application>,
431 select the latest version; for <application>XULrunner</application>,
432 select version <emphasis>1.8.1.4-2ubuntu5</emphasis>.</para>
435 # as the root user:</prompt>
437 sudo apt-get install subversion
438 sudo apt-get install xulrunner
443 <title>Download the Source Code</title>
446 <para>Determine which version is needed</para>
447 <para>For most end-users, a specific version is required
448 to communicate properly with the Evergreen server. Check
449 with your system administrator, IT person, or HelpDesk to
450 determine which Staff Client versions are
452 <para>Next, you need to determine which
453 <emphasis>tag</emphasis> to use when downloading the
454 source code. Tags are markers in the source code to create
455 a snapshot of the code as it existed at a certain time;
456 tags usually point to tested and stable code, or at least
457 a community-recognized release version.</para>
458 <para>To determine which tag to use, browse to
459 <ulink url="http://svn.open-ils.org/trac/ILS/browser">
460 http://svn.open-ils.org/trac/ILS/browser</ulink>.
461 Look in the <guilabel>Visit</guilabel> drop-down box; see
462 the list of <guilabel>Branches</guilabel> and, further
463 down, a list of <guilabel>Tags</guilabel>. You may have
464 to do some guesswork, but it is fairly straightforward to
465 determine which tag to use. If the server is version
466 1.6.1.2, you will want to use the tag that looks most
467 appropriate. For example, as you look through the tag
468 list, notice the tag named 'rel_1_6_1_2'. This is the tag
469 you need; make a note of it for the next step.</para>
472 <para>Download the Code</para>
474 <systemitem class="username">opensrf</systemitem>
475 user, open a terminal (command-line prompt) and navigate
476 to the directory in which you wish to download the Staff
477 Client. Use the following commands to download the proper
478 version of the source code by tag name:</para>
481 # as the opensrf user:</prompt>
483 cd /DOWNLOAD/DIRECTORY
487 <para>Remember to change "rel_1_6_1_2" to the appropriate
488 tag for your installation.</para>
493 <title>Build the Staff Client</title>
494 <para>In the following example, navigate to the directory in
495 which the source code was downloaded, then navigate to the
496 proper subdirectory and run the "make" utility to actually build
497 the Staff Client. Remember to check with your system
498 administrator about which Staff Client <envar>BUILD_ID</envar>
499 to use. The server checks the Staff Client
500 <envar>BUILD_ID</envar> against itself to determine whether or
501 not a connecting client is supported. For instance, for the
502 PINES installation (version 1.6.1.2) the supported
503 <envar>BUILD_ID</envar> is "rel_1_6_1_2". Modify the following
504 commands accordingly.</para>
505 <para>As the <systemitem class="username">opensrf</systemitem>
506 user, run the following commands to build the Staff Client:</para>
509 # as the opensrf user:</prompt>
511 wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.1.2.tar.gz
512 tar xfz Evergreen-ILS-1.6.1.2.tar.gz
513 cd /home/opensrf/Evergreen-ILS-1.6.1.2
514 ./configure --prefix=/openils --sysconfdir=/openils/conf
515 cd ./Open-ILS/xul/staff_client/
516 make STAFF_CLIENT_BUILD_ID='rel_1_6_1_2' install
521 <title>Run the Staff Client</title>
522 <para>As the <systemitem class="username">opensrf</systemitem>
523 user, navigate to the <filename class="directory">build/</filename>
524 subdirectory and run the following command:</para>
527 # as the opensrf user:</prompt>
529 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build
530 xulrunner application.ini
535 <title>(OPTIONAL) Clean Up / Create Shortcuts</title>
536 <para>The source code download included many files that are
537 needed to build the Staff Client but are not necessary to run
538 it. You may wish to remove them to save space, or to create a
539 clean <literal>staging</literal> directory containing the
540 finished Staff Client that can then be copied to other
541 machines. To do this, execute the following commands (remember
542 to replace <literal>DOWNLOAD_DIRECTORY</literal> and
543 <literal>STAGING_DIRECTORY</literal> with the appropriate
547 # as the opensrf user:</prompt>
549 mkdir ~/STAGING_DIRECTORY
550 cd ~/DOWNLOAD_DIRECTORY/Open-ILS/xul/
551 cp -r staff_client ~/STAGING_DIRECTORY
554 <para>Test the Staff Client to verify that all necessary files
555 were copied to the staging directory:</para>
558 # as the opensrf user:</prompt>
560 cd ~/STAGING_DIRECTORY/staff_client/build
561 xulrunner application.ini
564 <para>If there were no problems, then finish the cleanup by
565 removing the original download directory as shown:</para>
568 # as the opensrf user:</prompt>
570 rm -r -f ~/DOWNLOAD_DIRECTORY
573 <para>Finally, the command:</para>
576 # as the opensrf user:</prompt>
578 xulrunner ~/STAGING_DIRECTORY/staff_client/build/application.ini
581 <para>will now run the Staff Client. You may wish to create a
582 shortcut for the Staff Client. To do so, use the previous
583 command as the target for the shortcut:
584 <menuchoice><guimenu>Desktop</guimenu>
585 <guimenuitem>StartMenu</guimenuitem>
586 <guimenuitem>K-Menu</guimenuitem>
592 <title>Using Wine to Install on Linux</title>
594 <primary>staff client</primary>
595 <secondary>using wine to install on Linux</secondary>
597 <para>The Linux application <application>Wine</application> is another
598 alternative if you wish to install the packaged
599 <systemitem class="osname">Windows</systemitem> versions rather than manually
600 building the Staff Client. <application>Wine</application> is a Linux
601 application that allows users to directly run
602 <systemitem class="osname">Windows</systemitem> executables, and is a simple
603 way for casual Linux users to use the Staff Client. You can find more information
604 about <application>Wine</application> at
605 <ulink url="http://www.winehq.org/site/docs/wineusr-guide/getting-wine">
606 http://www.winehq.org/site/docs/wineusr-guide/getting-wine</ulink>.</para>
607 <para>As the <systemitem class="username">root</systemitem> user, use
608 <command>apt-get</command> to install the package for <application>Wine</application>.
609 You can also use <command>synaptic</command>, the graphical user interface.</para>
612 <para>Install wine:</para>
615 # as the root user:</prompt>
617 sudo apt-get install wine
622 <para>Visit the downloads section of the Evergreen website at
623 <ulink url="http://www.evergreen-ils.org/downloads.php">
624 http://www.evergreen-ils.org/downloads.php</ulink> and find the
625 <systemitem class="osname">Microsoft Windows</systemitem> Installer
626 that contains the desired version of the Staff Client. Download
627 the installer and place it in a temporary directory.</para>
630 <para>As the <systemitem class="username">opensrf</systemitem>
631 user, navigate to the temporary directory where you downloaded
632 the <systemitem class="osname">Windows</systemitem> installer
633 file, then execute it with the <application>wine</application>
634 application (remember to replace <literal>VERSION</literal> with
635 the release number of the Staff Client you downloaded):</para>
638 # as the opensrf user:</prompt>
641 wine evergreen-setup-rel_VERSION.exe
644 <para>If this step fails, you may need to configure
645 <application>Wine</application> first to properly emulate
646 <systemitem class="osname">Windows XP</systemitem>. To do so,
647 type <command>winecfg</command> from the command line; in the
648 <literal>Applications</literal> tab of the window that pops up,
649 select <literal>Default Settings</literal> and choose
650 <literal>Windows XP</literal> from the drop-down menu, then
651 click <guibutton>'Apply'</guibutton>.</para>
654 <para>Launch the Staff Client</para>
655 <para>A new entry for the Staff Client should now appear
656 somewhere in the <literal>All Applications</literal> menu of
657 your Linux desktop. You may also find a new desktop shortcut for
658 the Staff Client. To launch the Staff Client, visit the
659 <literal>All Applications</literal> menu on your desktop and
660 find the section similar to:</para>
663 <guimenu>Wine</guimenu>
664 <guimenuitem>Program Files</guimenuitem>
665 <guimenuitem>Evergreen Staff Client</guimenuitem>
666 <guimenuitem>Evergreen Staff Client</guimenuitem>
669 <para>or else launch the Staff Client from the new desktop shortcut.</para>
676 <title>Building the Staff Client</title>
678 <primary>staff client</primary>
679 <secondary>building</secondary>
681 <para>You can also manually build the Staff Client by using the <command>make</command>
682 utility in the Staff Client source directory (e.g., the directory
683 <filename class="directory">/home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</filename>
684 for the current Evergreen version). There are a number of possible options to manually
685 build special versions of the Staff Client on a Linux system. Following is a list of
686 variables that you can pass to <command>make</command> to influence the manual build
690 <envar>STAFF_CLIENT_BUILD_ID</envar>
692 <para>During the normal <emphasis>make install</emphasis> Evergreen server-side
693 software build process, the variable defaults to an automatically generated
694 date/time string, but you can also override the value of <envar>BUILD_ID</envar>.</para>
695 <para>You could use the following commands during the normal install process:</para>
698 # as the root user:</prompt>
700 cd /home/opensrf/Evergreen-ILS-1.6.1.2
701 make STAFF_CLIENT_BUILD_ID=1_6_1_2 install
704 <para>You can also manually build the Staff Client in the Staff Client
705 source directory with a different <envar>BUILD_ID</envar>.</para>
706 <para>As the <systemitem class="username">opensrf</systemitem> user,
707 execute the following commands to build the Staff Client (remember to replace
708 <literal>NEW_VERSION</literal> with an appropriate value):</para>
711 # as the opensrf user:</prompt>
713 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
714 make STAFF_CLIENT_BUILD_ID=NEWVERSION build
720 <envar>STAFF_CLIENT_VERSION</envar>
722 <para>During the normal <emphasis>make install</emphasis> Evergreen server-side
723 software build process, the variable is pulled automatically from a README file
724 in the Evergreen source root. The variable defaults to
725 <emphasis>0trunk.revision</emphasis>, where the value of "revision" is
726 automatically generated. You can override the value of <envar>VERSION</envar>
727 similarly to the <envar>BUILD_ID</envar>.</para>
728 <para>You could use the following commands during the normal install process:</para>
731 # as the root user:</prompt>
733 cd /home/opensrf/Evergreen-ILS-1.6.1.2
734 make STAFF_CLIENT_VERSION=0mytest.200 install
737 <para>You can also manually build the Staff Client in the Staff Client
738 source directory with a different <envar>VERSION</envar>.</para>
739 <para>If you plan to make extensions update automatically, the
740 <envar>VERSION</envar> needs to conform to the format recommended in
741 <ulink url="https://developer.mozilla.org/en/Toolkit_version_format">
742 Toolkit Version Format</ulink> and newer versions need to be "higher" than older
744 <para>As the <systemitem class="username">opensrf</systemitem> user,
745 execute the following commands to build the Staff Client:</para>
748 # as the opensrf user:</prompt>
750 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
751 make STAFF_CLIENT_VERSION=0mytest.200 build
757 <envar>STAFF_CLIENT_STAMP_ID</envar>
759 <para>During the normal <emphasis>make install</emphasis> Evergreen
760 server-side software build process, the variable is generated from
761 <envar>STAFF_CLIENT_VERSION</envar>. You may want to have multiple versions
762 of the Staff Client with different stamps, possibly for different uses or
763 client-side customizations. You can override the value of
764 <envar>STAMP_ID</envar> similarly to the <envar>BUILD_ID</envar>.</para>
765 <para>You could use the following commands during the normal install process:</para>
768 # as the root user:</prompt>
770 cd /home/opensrf/Evergreen-ILS-1.6.1.2
771 make STAFF_CLIENT_STAMP_ID=my_test_stamp install
774 <para>You can also manually build the Staff Client in the Staff Client
775 source directory with a different <envar>STAMP_ID</envar>.</para>
776 <para>As the <systemitem class="username">opensrf</systemitem> user,
777 execute the following commands to build the Staff Client:</para>
780 # as the opensrf user:</prompt>
782 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
783 make STAFF_CLIENT_STAMP_ID=my_test_stamp build
789 <title>Advanced Build Options</title>
791 <primary>staff client</primary>
792 <secondary>building</secondary>
793 <tertiary>advanced build options</tertiary>
795 <para>In addition to the basic options listed above, there are a number of advanced
796 options for building the Staff Client. Most are target names for the
797 <command>make</command> utility and require that you build the Staff Client from the
798 <literal>staff_client</literal> directory. See the following table for a list of
799 possible <command>make</command> target keywords:</para>
801 <title>Keywords Targets for "make" Command</title>
802 <?dbfo keep-together="always" ?>
803 <tgroup align="left" cols="2" colsep="1" rowsep="1">
804 <colspec colnum="1" colname="keyword" colwidth="1.0*"/>
805 <colspec colnum="2" colname="description" colwidth="3.0*"/>
808 <entry>Keyword</entry>
809 <entry>Description</entry>
814 <entry>clients</entry>
815 <entry>Runs "make win-client", "make linux-client", and "make
816 generic-client" individually</entry>
819 <entry>client_dir</entry>
820 <entry>Builds a client directory from the build directory, without
821 doing a rebuild. The same as "copy everything but
825 <entry>client_app</entry>
826 <entry>Prerequisite "client_dir"; removes "install.rdf" from
827 client directory so an APP bundle can't be installed as an
831 <entry>client_ext</entry>
832 <entry>Prerequisite "client_dir"; remove "application.ini",
833 "autoupdate.js", "standalone_xul_app.js" from client directory so
834 an extension won't break Firefox</entry>
837 <entry>extension</entry>
838 <entry>Prerequisite "client_ext"; rewritten to use "client_ext"</entry>
841 <entry>generic-client</entry>
842 <entry>Prerequisite "client_app"; makes an XPI file suitable for
843 use with "xulrunner --install-app""</entry>
846 <entry>win-xulrunner</entry>
847 <entry>Prerequisite "client_app"; adds Windows xulrunner to client build</entry>
850 <entry>linux-xulrunner</entry>
851 <entry>Prerequisite "client_app"; adds Linux xulrunner to client build</entry>
854 <entry>win-client</entry>
855 <entry>Prerequisite "win-xulrunner"; builds "setup exe" (requires
856 that "nsis" package be installed, will add options for automatic
857 update if configured and developer options if client build was a
858 "make devbuild")</entry>
861 <entry>linux-client</entry>
862 <entry>Prerequisite "linux_xulrunner"; builds a "tar.bz2" bundle
863 of the Linux client</entry>
866 <entry>[generic-|win-|linux-|extension-]updates[-client]</entry>
867 <entry>Calls external/make_updates.sh to build full and partial
868 updates generic/win/linux/extension prefix limit to that
869 distribution; Adding <option>-client</option> builds clients and
870 copies them to a subdirectory of the
871 <filename class="directory">updates</filename> directory as well;
872 <option>extension-updates-client</option> doesn't exist.</entry>
877 <para>Following are descriptions of other special build options:</para>
879 <title>Developer Build</title>
880 <para>You can create a so-called <emphasis>developer build</emphasis>
881 of the Staff Client by substituting <option>devbuild</option> for
882 <option>build</option> when running <command>make</command> from the
883 <literal>staff_client</literal> directory. The build will contain an
884 extra configuration file that enables some developer options.</para>
885 <para>As the <systemitem class="username">opensrf</systemitem> user, run
886 the following commands from the Staff Client source directory:</para>
889 # as the opensrf user:</prompt>
891 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
897 <title>Compressed Javascript</title>
898 <para>You can execute the Google <systemitem class="resource">Closure Compiler</systemitem>
899 utility to automatically review and compress Javascript code after the build
900 process completes, by substituting <option>compress-javascript</option> for
901 <option>build</option> when running <command>make</command>.
902 For more information on the Google Closure Compiler, see
903 <ulink url="http://code.google.com/closure/compiler/">
904 http://code.google.com/closure/compiler</ulink>.</para>
905 <para>As the <systemitem class="username">opensrf</systemitem> user, run
906 the following commands from the Staff Client source directory:</para>
909 # as the opensrf user:</prompt>
911 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
912 make compress-javascript
915 <para>You can also combine Javascript review and compression, and also perform a
916 <emphasis>developer build</emphasis>.</para>
917 <para>As the <systemitem class="username">opensrf</systemitem> user, run the
918 following commands from the Staff Client source directory:</para>
919 <note>In the following <command>make</command> below, the order of options is
923 # as the opensrf user:</prompt>
925 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
926 make devbuild compress-javascript
930 <simplesect xml:id="staffclientinstallation-autoupdatehost">
931 <title>Automatic Update Host</title>
932 <para>You can override the host used to check for automatic Staff Client updates
933 by specifying the <option>AUTOUPDATE_HOST</option> option.</para>
934 <para>You could use the following commands during the normal install process:</para>
937 # as the root user:</prompt>
939 cd /home/opensrf/Evergreen-ILS-1.6.1.2
940 make AUTOUPDATE_HOST=localhost install
943 <para>You can manually build the Staff Client in the Staff Client
944 source directory and set <option>AUTOUPDATE_HOST</option> to enable automatic
945 update checking.</para>
946 <para>As the <systemitem class="username">opensrf</systemitem> user,
947 execute the following commands to build the Staff Client:</para>
950 # as the opensrf user:</prompt>
952 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
953 make AUTOUPDATE_HOST=localhost build
956 <para>For more information on Automatic Updates, see
957 <xref linkend="staffclientinstallation-autoupdate"/>.</para>
961 <title>Installing and Activating a Manually Built Staff Client</title>
962 <para>The Staff Client is automatically built, installed and activated as part of the
963 normal <command>make<option>install</option></command> process for Evergreen
964 server-side software. However, if you manually build the Staff Client from the
965 <literal>staff_client</literal> directory, then you need to take additional steps to
966 properly install and activate it. You also have the option of installing the Staff
967 Client on the same machine it was built on, or on a different machine.</para>
968 <para>Assuming you have already built the Staff Client, and that your installation is
969 in the directory <filename class="directory">/openils/var/web/xul</filename>, as the
970 <systemitem class="username">opensrf</systemitem> user execute the following
974 # as the opensrf user:</prompt>
976 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
977 mkdir -p "/openils/var/web/xul/$(cat build/BUILD_ID)"
978 cp -R build/server "/openils/var/web/xul/$(cat build/BUILD_ID)"
983 <title>Packaging the Staff Client</title>
984 <para>Once you have built the Staff Client, you can create several forms of special client
985 packages by using a modified <command>make</command> command in the <literal>staff_client</literal>
988 <title>Packaging a Generic Client</title>
989 <para>This build creates a Staff Client packaged as an XPI file suitable for use with
990 the <option>--install-app</option> parameter of <application>XULrunner</application>.
991 It requires that you already have the <systemitem>zip</systemitem> utility
992 installed on your system.</para>
993 <para>As the <systemitem class="username">opensrf</systemitem> user, execute
994 the following commands:</para>
997 # as the opensrf user:</prompt>
999 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
1003 <para>The output file <filename>evergreen_staff_client.xpi</filename> will be created.</para>
1006 <title>Packaging a <systemitem class="osname">Windows</systemitem> Client</title>
1007 <para>This build creates a Staff Client packaged as a
1008 <systemitem class="osname">Windows</systemitem> executable. It requires that
1009 you already have the <application>unzip</application> utility installed on
1010 your system. It also requires that you install
1011 <ulink url="http://nsis.sourceforge.net/">NSIS (Nullsoft Scriptable Install System)</ulink>,
1012 a professional open source utility package used to create
1013 <systemitem class="osname">Windows</systemitem> installers (the
1014 <application>"makensis"</application> utility is installed as part of the
1015 <application>"nsis"</application> package). You should use Version 2.45 or
1017 <para>If you wish for the Staff Client to have a link icon/tray icon by
1018 default, you may wish to provide a pre-modified
1019 <application>xulrunner-stub.exe</application>. Place it in the Staff Client
1020 source directory and <command>make</command> will automatically use it instead
1021 of the one that comes with the downloaded <application>XULrunner</application>
1022 release. The version of <application>xulrunner-stub.exe</application> need not
1023 match exactly.</para>
1024 <para>You can also use a tool such as
1025 <ulink url="http://www.angusj.com/resourcehacker/">Resource Hacker</ulink>
1026 to embed icons. <application>Resource Hacker</application> is an open-source
1027 utility used to modify resources within 32-bit
1028 <systemitem class="osname">Windows</systemitem> executables.
1029 Some useful icon ID strings include the following:</para>
1031 <?dbfo keep-together="always" ?>
1032 <title>Useful icon ID strings</title>
1033 <tgroup align="left" cols="2" colsep="1" rowsep="1">
1034 <colspec colnum="1" colname="keyword" colwidth="1.0*"/>
1035 <colspec colnum="2" colname="icon" colwidth="1.0*"/>
1038 <entry>IDI_APPICON</entry>
1039 <entry>Tray icon</entry>
1042 <entry>32512</entry>
1043 <entry>Default window icon</entry>
1048 <para>As the <systemitem class="username">opensrf</systemitem> user
1049 execute the following commands:</para>
1052 # as the opensrf user:</prompt>
1054 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
1058 <para>The output file <filename>evergreen_staff_client_setup.exe</filename> will be created.</para>
1061 <title>Packaging a Linux Client</title>
1062 <para>This build creates a Staff Client packaged as a compressed
1063 <literal>tar</literal> archive file with <application>XULrunner</application>
1064 already bundled with it. It requires that you already have the
1065 <application>bzip2</application> utility installed on your system.</para>
1066 <para>As the <systemitem class="username">opensrf</systemitem> user,
1067 execute the following commands:</para>
1070 # as the opensrf user:</prompt>
1072 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
1076 <para>The output file <filename>evergreen_staff_client.tar.bz2</filename> will be created.</para>
1079 <title>Packaging a <application>Firefox</application> Extension</title>
1080 <para>This build creates a Staff Client packaged as a <application>Firefox</application>
1081 extension. It requires that you already have the <systemitem>zip</systemitem>
1082 utility installed on your system.</para>
1083 <para>As the <systemitem class="username">opensrf</systemitem> user,
1084 execute the following commands:</para>
1087 # as the opensrf user:</prompt>
1089 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
1093 <para>The output file <filename>evergreen.xpi</filename> will be created.</para>
1096 <section xml:id="staffclientinstallation-autoupdate">
1097 <title>Staff Client Automatic Updates</title>
1099 <primary>staff client</primary>
1100 <secondary>automatic updates</secondary>
1102 <para>It is possible to set up support for automatic Staff Client updates, either during
1103 the normal Evergreen server-side build process, or by manually building the Staff Client
1104 with certain special options.</para>
1106 <para>Automatic update server certificate requirements are more strict than
1107 normal server requirements. <application>Firefox</application> and
1108 <application>XULrunner</application> will both ignore any automatic update
1109 server that is not validated by a trusted certificate authority. Servers with
1110 exceptions added to force the Staff Client to accept them <emphasis>WILL NOT
1111 WORK</emphasis>.</para>
1112 <para>In addition, automatic updates have special requirements for the file
1113 <filename>update.rdf</filename>:</para>
1115 <listitem>It must be served from an SSL server, or</listitem>
1116 <listitem>It must be signed with the <ulink url="https://developer.mozilla.org/en/McCoy">
1117 https://developer.mozilla.org/en/McCoy</ulink> tool.</listitem>
1119 <para>You can pre-install the signing key into the file
1120 <filename>install.rdf</filename> directly, or install it into a copy as
1121 <filename>install.mccoy.rdf</filename>. If the latter exists it will be copied
1122 into the build instead of the original file
1123 <filename>install.rdf</filename>.</para>
1126 <title>Autoupdate Host</title>
1127 <para>You can manually set the name of the automatic update host. If you do
1128 not set the name then, by default, the Staff Client will not include an
1129 automatic update preference. You can set the autoupdate host name as
1133 <para>At configuration time during the normal <emphasis>make install</emphasis>
1134 process for Evergreen server-side software.</para>
1135 <para>You can do this when you first configure the Evergreen server-side
1136 software (see <xref linkend="serversideinstallation-configure"/>).
1137 As the <systemitem class="username">opensrf</systemitem> user, execute
1138 the following commands:</para>
1141 # as the opensrf user:</prompt>
1143 cd /home/opensrf/Evergreen-ILS-1.6.1.2
1144 ./configure --prefix=/openils --sysconfdir=/openils/conf --with-updateshost=hostname
1150 <para>During a manual Staff Client build process.</para>
1151 <para>You can override the variable
1152 <envar>AUTOUPDATE_HOST=hostname</envar> and manually build the
1153 Staff Client from the <literal>staff_client</literal>
1154 directory (see <xref linkend="staffclientinstallation-autoupdatehost"/>
1155 for details). If you specify only a bare hostname (for example,
1156 <systemitem class="domainname">example.com</systemitem>) then
1157 the Staff Client will automatically use the secure URL
1158 <systemitem class="domainname">https://example.com</systemitem>.
1159 If you wish to use a non-https URL, then you must explicitly
1160 specify the full URL (for example,
1161 <systemitem class="domainname">http://example.com</systemitem>).</para>
1162 <para>As the <systemitem class="username">opensrf</systemitem> user,
1163 execute the following commands to build the Staff Client (remember to
1164 replace <literal>SOME_URL</literal> with an appropriate value)
1168 # as the opensrf user:</prompt>
1170 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
1171 make AUTOUPDATE_HOST=http://SOME_URL build
1178 <title>Building Updates</title>
1180 <primary>staff client</primary>
1181 <secondary>automatic updates</secondary>
1182 <tertiary>building</tertiary>
1184 <para>Similar to building clients, you can use the targets
1185 <option>generic-updates</option>, <option>win-updates</option>,
1186 <option>linux-updates</option>, and <option>extension-updates</option>
1187 individually with <command>make</command> to build the update files for the
1188 Staff Client. To build all the targets at once, simply use the target
1189 <option>updates</option>.</para>
1190 <para>A full update will be built for each specified target (or for all if you
1191 use the target <option>updates</option>). For all but extensions any previous
1192 full updates (archived by default in the directory
1193 <filename class="directory">/openils/var/updates/archives</filename>) will be
1194 used to make partial updates. Partial updates tend to be much smaller and will
1195 thus download more quickly, but if something goes wrong with a partial update
1196 the full update will be used as a fallback. Extensions do not currently support
1197 partial updates.</para>
1198 <para>As the <systemitem class="username">opensrf</systemitem> user, change
1199 directory to the Staff Client source directory, then execute the following
1203 # as the opensrf user:</prompt>
1205 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
1208 <para>Command to build all updates at once:</para>
1211 # as the opensrf user:</prompt>
1216 <para>commands to build updates individually:</para>
1219 # as the opensrf user:</prompt>
1221 make generic-updates
1224 make extension-updates
1229 <title>Building updates with clients</title>
1231 <primary>staff client</primary>
1232 <secondary>automatic updates</secondary>
1233 <tertiary>building with clients</tertiary>
1235 <para>To save time and effort you can build updates and manual download
1236 clients at the same time by adding the phrase <literal>"-client"</literal> to each
1237 target name (for example, you could specify <option>updates-client</option> to build
1238 all the targets at once, or you could specify <option>win-updates-client</option>
1239 to build updates individually). This process will not work for the option
1240 <option>extension-updates</option>.</para>
1241 <para>The clients will be installed alongside the updates and listed on the
1242 <filename>manualupdate.html</filename> page, instead of being left in the
1243 <literal>staff_client</literal> directory.</para>
1244 <para>As the <systemitem class="username">opensrf</systemitem> user, execute
1245 one of the following commands:</para>
1246 <para>To build all updates at once:</para>
1249 # as the opensrf user:</prompt>
1251 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
1255 <para>To build updates individually:</para>
1258 # as the opensrf user:</prompt>
1260 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
1261 make generic-updates-client
1262 make win-updates-client
1263 make linux-updates-client
1268 <title>Activating the Update Server</title>
1270 <primary>staff client</primary>
1271 <secondary>automatic updates</secondary>
1272 <tertiary>activating the update server</tertiary>
1274 <para>This section reviews scripts associated with the update server, and
1275 requires some final adjustments to file permissions.</para>
1276 <para>The Apache example configuration creates an <literal>updates</literal>
1277 directory that, by default, points to the directory
1278 <filename class="directory">/openils/var/updates/pub</filename>. This
1279 directory contains one HTML file and several specially-named script files.</para>
1280 <para>The <filename>updatedetails.html</filename> file is the fallback web
1281 page for the update details. The <filename>check</filename> script is used for
1282 <application>XULrunner</application> updates. The
1283 <filename>update.rdf</filename> script is used for extension updates.
1284 The <filename>manualupdate.html</filename> file checks for clients to provide
1285 download links when automatic updates have failed and uses the download script
1286 to force a download of the generic client XPI (compared to
1287 <application>Firefox</application> trying to install it as an
1289 <para>To change the permissions for the scripts
1290 <filename>check</filename>, <filename>download</filename>,
1291 <filename>manualupdate.html</filename>, and
1292 <filename>update.rdf</filename>, as the root user execute the following
1296 # as the root user:</prompt>
1298 cd /openils/var/updates/pub
1299 chmod +x check download manualupdate.html update.rdf
1305 <title>Other tips</title>
1306 <simplesect xml:id="staffclientinstallation-othertips">
1307 <title>Multiple workstations on one install</title>
1308 <para>Multiple workstation registrations for the same server can be accomplished
1309 with a single Staff Client install by using multiple profiles. When running
1310 <application>XULrunner</application> you can specify the option
1311 <literal>"-profilemanager"</literal> or <literal>"-P"</literal> (uppercase "P")
1312 to force the Profile Manager to start. Unchecking the <literal>"Don't ask at startup"</literal>
1313 option will make this the default.</para>
1314 <para>Once you have opened the Profile Manager you can create additional
1315 profiles, one for each workstation you wish to register. You may need to install
1316 SSL exceptions for each profile.</para>
1317 <para>When building any of the targets <option>win-client</option>,
1318 <option>win-updates-client</option>, or <option>updates-client</option>, you can
1319 specify <option>NSIS_EXTRAOPTS=-DPROFILES</option> to add an option
1320 <guimenuitem>"Evergreen Staff Client Profile Manager"</guimenuitem> to the
1322 <para>As the <systemitem class="username">opensrf</systemitem> user,
1323 execute the following commands:</para>
1326 # as the opensrf user:</prompt>
1328 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client
1329 make NSIS_EXTRAOPTS=-DPROFILES win-client
1334 <title> Multiple Staff Clients</title>
1335 <para>It may be confusing if you are not careful, but you can log in to
1336 multiple Evergreen servers at the same time, or a single Evergreen server
1337 multiple times. In either case you will need to create an additional profile for
1338 each additional server or workstation you want to log in as (see the previous
1339 tip in <xref linkend="staffclientinstallation-othertips"/>).</para>
1340 <para>Once you have created the profiles, run
1341 <application>XULrunner</application> with the option <option>-no-remote</option>
1342 (in addition to <option>"-profilemanger"</option> or <option>"-P"</option> if
1343 needed). Instead of <application>XULrunner</application> opening a new login
1344 window on your existing session it will start a new session instead, which can
1345 then be logged in to a different server or workstation ID.</para>
1349 <section xml:id="staffclientinstallation-running-staffclient">
1350 <title>Running the Staff Client</title>
1352 <primary>staff client</primary>
1353 <secondary>running</secondary>
1354 <tertiary>linux</tertiary>
1356 <para>You can run the Staff Client on a Linux system by using the
1357 <application>XULrunner</application> application (installed automatically and by default
1358 with <application>Firefox</application> <literal>Version 3.0</literal> and later on
1359 <systemitem class="osname">Ubuntu</systemitem> and
1360 <systemitem class="osname">Debian</systemitem> distributions).</para>
1361 <para>For example, if the source files for the Evergreen installation are in the directory
1362 <filename class="directory">/home/opensrf/Evergreen-ILS-1.6.1.2/</filename> you can start the
1363 Staff Client as shown in the following example:</para>
1366 # as the opensrf user:</prompt>
1368 cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build
1369 xulrunner application.ini
1372 <section xml:id="staffclientinstallation-workstationnames">
1373 <title>Assigning Workstation Names</title>
1375 <primary>staff client</primary>
1376 <secondary>assigning workstation names</secondary>
1378 <para>The Staff Client must be assigned to a library and given a unique name before it
1379 will connect fully to the Evergreen server. The only restriction is that the workstation's
1380 name must be unique within the assigned library. Make sure to select a workstation name
1381 that you will remember later, and reflects the role, purpose, and/or location of a
1382 particular computer. These names will come up later in statistical reporting, and can also
1383 be handy when troubleshooting.</para>
1386 <phrase>Example of unconfigured Staff Client</phrase>
1389 <imagedata fileref="../media/staffclientinstallation-staffclient-workstationnames-1.png" format="PNG" scalefit="1" width="60%"/>
1392 <para>In order to assign a workstation a name, a user with appropriate
1393 permissions must login to the Staff Client. In PINES, the local system
1394 administrator (OPSM) has the ability to assign workstation names in their
1395 library system. Library managers (LIBM's) have the ability within their
1396 branch. To assign a workstation a name, login to the system. You will be
1397 prompted to assign the workstation a library and a name:</para>
1400 <phrase>Example of configured Staff Client</phrase>
1403 <imagedata fileref="../media/staffclientinstallation-staffclient-workstationnames-2.png" format="PNG" scalefit="1" width="60%"/>
1406 <para>Select the library this workstation physically operates in from the drop
1407 down menu. In this example, we have selected "MGRL-MA". Type in a friendly name
1408 for the workstation. In this example, we are installing the Staff Client on the
1409 director's personal system, and have named it as such. Then click
1410 <guibutton>'Register'</guibutton>.</para>
1411 <para>Once you have registered your workstation
1412 with the server, your screen will look like this:</para>
1415 <phrase>Example of registered Staff Client</phrase>
1418 <imagedata fileref="../media/staffclientinstallation-staffclient-workstationnames-3.png" format="PNG" scalefit="1" width="60%"/>
1421 <para>You are now ready to log into the Staff Client for the first time. Type in
1422 your password again, and click <guibutton>'Login'</guibutton>.</para>
1424 <section xml:id="staffclientinstallation-proxy">
1425 <title>Running the Staff Client Over An <systemitem class="protocal">SSH</systemitem> Tunnel</title>
1427 <primary>staff client</primary>
1428 <secondary>running through an SSH tunnel</secondary>
1430 <para>You can configure the Staff Client to communicate with the Evergreen server over
1431 an <systemitem class="protocal">SSH</systemitem> tunnel using a SOCKS 5 proxy
1432 server. There are several reasons for sending network traffic for the Staff Client
1433 through an <systemitem class="protocal">SSH</systemitem> proxy:</para>
1436 <para>Firewalls may prevent you from reaching the Evergreen
1437 server. This may happen when you are connecting the Staff
1438 Client to a test server that should not be available
1439 generally, or it may be the result of network design
1440 priorities other than ease of use.</para>
1443 <para>You may wish to improve security in situations where
1444 Staff Client traffic may be susceptible to network
1445 eavesdropping. This is especially true when staff machines
1446 connect via wireless links to the network.</para>
1450 <title>Setting Up an <systemitem class="protocal">SSH</systemitem> Tunnel</title>
1451 <para>You will need a server that allows you to log in via
1452 <systemitem class="protocal">SSH</systemitem> and has network access to the
1453 Evergreen server you want to reach. You will use your username and password
1454 for that <systemitem class="protocal">SSH</systemitem> server to set up a
1456 <para>For <systemitem class="osname">Windows</systemitem> users, one good
1457 solution is the open-source utility
1458 <ulink url="http://www.chiark.greenend.org.uk/~sgtatham/putty/">PuTTY</ulink>,
1459 a free <systemitem class="protocal">telnet/SSH</systemitem> client.
1460 Following are instructions for setting up an <application>SSH</application>
1461 session using the <application>PuTTY</application> utility:</para>
1464 <phrase>Setting up an <systemitem class="protocal">SSH</systemitem>
1465 tunnel in <application>PuTTY</application></phrase>
1468 <imagedata fileref="../media/staffclientinstallation-proxy-putty-1.png" format="PNG" scalefit="1" width="60%"/>
1473 <para>Using the menu on the left, find the section:</para>
1476 <guimenu>Connection</guimenu>
1477 <guimenuitem>SSH</guimenuitem>
1478 <guimenuitem>Tunnels</guimenuitem>
1483 <para>In the section on the right labeled <literal>"Source
1484 port"</literal>, enter <literal>9999</literal>.</para>
1487 <para>Set the checkbox <literal>"Dynamic"</literal>. Do not
1488 enter anything in the <literal>"Destination"</literal> text
1492 <para>Click <guibutton>'Add'</guibutton> and notice that
1493 <literal>"D9999"</literal> now appears in the section
1494 labeled <literal>"Forwarded ports"</literal>.</para>
1497 <para>Use the menu on the left, find the
1498 <literal>"Session"</literal> section, then enter the host name
1499 of the <systemitem class="protocal">SSH</systemitem>
1503 <para>A pop-up window will open to allow you to enter your
1504 username and password. Once you are logged in, the tunnel is
1508 <para>See <ulink url="http://inside.mines.edu/~gmurray/HowTo/sshNotes.html">How to set up
1509 <systemitem class="protocal">SSH</systemitem> (for the beginner)</ulink> for information on
1510 setting up <systemitem class="protocal">SSH</systemitem> for other client operating
1514 <title>Configuring the Staff Client to Use the <systemitem class="protocal">SSH</systemitem> Tunnel</title>
1515 <para>In order to tell the Staff Client that all traffic should be sent
1516 through the <systemitem class="protocal">SSH</systemitem> tunnel just configured,
1517 you must find edit the file <filename>all.js</filename>, usually located at
1518 <filename>C:\Program Files\Evergreen Staff Client\greprefs\all.js</filename>
1519 on a <systemitem class="osname">Windows</systemitem> system.
1520 Search this file for the word <literal>socks</literal> to find the appropriate
1521 section for the following changes.</para>
1524 <phrase>The SOCKS section of "all.js" before changes</phrase>
1527 <imagedata fileref="../media/staffclientinstallation-proxy-socks-1.png" format="PNG" scalefit="1" width="70%"/>
1530 <para>Make the following changes:</para>
1533 <para>Change the value of <literal>network.proxy.socks</literal>
1534 from <literal>""</literal> to <literal>localhost</literal>.</para>
1537 <para>Change the value of <literal>network.proxy.socks_port</literal>
1538 from <literal>0</literal> to <literal>9999</literal>.</para>
1543 <phrase>The SOCKS section of "all.js" after changes</phrase>
1546 <imagedata fileref="../media/staffclientinstallation-proxy-socks-2.png" format="PNG" scalefit="1" width="70%"/>
1549 <para>If everything is working correctly, you should now be able to run
1550 the Staff Client and all its data will be sent encrypted through the
1551 <systemitem class="protocal">SSH</systemitem> tunnel you have just configured.</para>
1555 <title>Navigating a Tabbed Interface</title>
1556 <para>Like many popular current web browsers and other applications, the Staff Client
1557 uses a "tabbed" interface. Tabs allow you to have several pages open at the same time
1558 in a single window. This is easier to manage on your computer screen than multiple
1559 windows, since you can easily switch between tabs in the same window.</para>
1562 <phrase>Tabs in the Staff Client window</phrase>
1565 <imagedata fileref="../media/staffclientinstallation-tabbed-1.png" format="PNG" scalefit="1" width="70%"/>
1568 <para>The "tabs" appear below the menu bar in the Staff Client with a descriptive
1569 title. Simply select a tab to bring it to the front and view the page displayed in the
1570 tab. You can use tabs to have access to multiple things all at the same time: patron
1571 records and searches, bibliographic records and searches, circulation or cataloging
1572 interfaces - anything at all in the Staff Client.</para>
1574 <listitem>Create a new tab by pressing
1576 <keycap>Ctrl</keycap>
1579 on the keyboard or selecting:
1581 <guimenu>File</guimenu>
1582 <guimenuitem>New Tab</guimenuitem>
1584 from the menu.</listitem>
1585 <listitem>Close a tab by pressing
1587 <keycap>Ctrl</keycap>
1589 </keycombo> on the keyboard or selecting
1591 <guimenu>File</guimenu>
1592 <guimenuitem>Close Tab</guimenuitem>
1594 from the menu.</listitem>
1595 <listitem>Switch tabs by pressing
1597 <keycap>Ctrl</keycap>
1598 <keycap>Tab</keycap>
1600 on the keyboard or selecting the tab in the tab bar.</listitem>
projects / working / Evergreen.git / blob