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 <title>Evergreen / <application>XULrunner</application> Dependencies</title>
158 <tgroup align="left" cols="2" colsep="1" rowsep="1">
159 <colspec colnum="1" colwidth="1.0*"/>
160 <colspec colnum="2" colwidth="3.0*"/>
163 <entry>Evergreen 1.6.x.x</entry>
164 <entry>XULrunner 1.9.x.x</entry>
167 <entry>Evergreen 1.4.x.x</entry>
168 <entry>XULrunner 1.8.0.4 or XULrunner 1.8.0.3</entry>
171 <entry>Evergreen 1.2.x.x</entry>
172 <entry>XULrunner 1.8.0.4 or XULrunner 1.8.0.3</entry>
177 <note>If you have issues removing previously installed
178 <application>XULrunner</application> versions see
179 <xref linkend="staffclientinstallation-remove-xulrunner"/>
180 for further information.</note>
181 <para>The Staff Client data from the directory
182 <filename class="directory">./staff_client/build</filename> must be placed
183 somewhere on the machine (e.g.
184 <filename class="directory">~/Desktop/Evergreen_Staff_Client</filename>).</para>
185 <para>Remember to call <application>XULrunner</application> with the full path to the
186 binary, followed by the install command and the path to the client data:</para>
188 <userinput>/Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_Client</userinput>
190 <para>The command should exit quietly and will create the folder
191 <filename class="directory">/Applications/OpenILS</filename>,
192 containing a launcher named <application>open_ils_staff_client</application>.</para>
194 <simplesect xml:id="staffclientinstallation-remove-xulrunner">
195 <title>(OPTIONAL) Removing previously installed XULRunner versions</title>
197 <primary>XULRunner</primary>
198 <secondary>removing previous versions</secondary>
200 <para>If you already have a newer version of
201 <application>XULrunner</application> installed, per the release notes,
202 you will need to remove the entire directory
203 <filename class="directory">/Library/Frameworks/XUL.framework</filename>
204 before downgrading.</para>
205 <para>In addition, you may also need to remove the previous file
206 <filename>/Library/Receipts/xulrunner-ver-mak.pkg</filename> .</para>
207 <para>If file <filename>/Library/Receipts/xulrunner-ver-mak.pkg</filename> does
208 not exist (possibly in newer <systemitem class="osname">Mac OS</systemitem>
209 releases), you need to flush the file <filename>receiptdb</filename>.</para>
210 <note>If you install a newer version of <application>XULrunner</application>
211 over a previous (older) install, the older install is not removed but the
212 symlinks are changed to the newer one.</note>
215 <title>(OPTIONAL) Flush Receiptdb file:</title>
216 <para>First, get the package identifier, then purge/forget the build that was
217 initially installed:</para>
219 <userinput>sudo pkgutil --pkgs > /tmp/pkgs.txt</userinput>
220 <userinput>sudo pkgutil --forget org.mozilla.xulrunner</userinput>
222 <note>It may not be necessary to edit the file
223 <filename>/Library/Receipts/InstallHistory.plist</filename> after deleting the
224 folder <filename class="directory">XUL.framework</filename>. See
225 <ulink url="http://lists.apple.com/archives/Installer-dev/2009/Jul/msg00008.html">
226 http://lists.apple.com/archives/Installer-dev/2009/Jul/msg00008.html</ulink>
227 for more information.</note>
230 <title>Creating an APP file: Staff Client and <application>XULrunner</application> Bundled</title>
231 <para>An APP file is basically a folder. Start with a folder stucture like this:</para>
233 <prompt>Evergreen.app</prompt>
234 <prompt>__Contents</prompt>
235 <prompt>____Frameworks</prompt>
236 <prompt>____Resources</prompt>
237 <prompt>____MacOS</prompt>
239 <para>Create an APP folder structure with the following commands:</para>
241 <userinput>mkdir -p Evergreen.app/Contents/Frameworks</userinput>
242 <userinput>mkdir -p Evergreen.app/Contents/Resources</userinput>
243 <userinput>mkdir -p Evergreen.app/Contents/MacOS</userinput>
247 <para>Create a new file in the folder
248 <filename class="directory">Evergreen.app/Contents/Info.plist</filename>
249 containing the following data (adjust for your version of
251 <programlisting language="xml"><![CDATA[
252 <?xml version="1.0" encoding="UTF-8"?>
253 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
254 <plist version="1.0">
256 <key>CFBundleExecutable</key>
257 <string>xulrunner</string>
258 <key>CFBundleGetInfoString</key>
259 <string>OpenILS open_ils_staff_client rel_1_6_1_2</string>
260 <key>CFBundleInfoDictionaryVersion</key>
262 <key>CFBundleName</key>
263 <string>Evergreen Staff Client</string>
264 <key>CFBundlePackageType</key>
265 <string>APPL</string>
266 <key>CFBundleShortVersionString</key>
267 <string>rel_1_6_1_2</string>
268 <key>CFBundleVersion</key>
269 <string>rel_1_6_1_2.rel_1_6_1_2</string>
270 <key>NSAppleScriptEnabled</key>
272 <key>CFBundleTypeIconFile</key>
273 <string>Evergreen.icns</string>
278 <listitem>Download and install an appropriate
279 <systemitem class="osname">Mac OS</systemitem> package of
280 <application>XULrunner</application> from the Mozilla website
281 <ulink url="https://developer.mozilla.org/en/xulrunner">
282 https://developer.mozilla.org/en/xulrunner</ulink> (see
283 <xref linkend="staffclientinstallation-table-1"/> for recommendations).</listitem>
285 <para>Make a copy of the folder
286 <filename class="directory">/Library/Frameworks/XUL.Framework</filename>
287 inside your APP file. It should look something like this:</para>
289 <prompt>Evergreen.app/</prompt>
290 <prompt>__Contents/</prompt>
291 <prompt>____Frameworks/</prompt>
292 <prompt>______XUL.Framework/</prompt>
293 <prompt>______Versions/</prompt>
294 <prompt>________Current -> 1.9.1.3 (symlink)</prompt>
295 <prompt>________1.9.1.3/</prompt>
296 <prompt>______XUL -> Versions/Current/XUL</prompt>
297 <prompt>______libxpcom.dylib -> Versions/Current/libxpcom.dylib</prompt>
298 <prompt>______xulrunner-bin -> Versions/Current/xulrunner-bin</prompt>
302 <filename>XUL.Framework/Versions/Current/xulrunner</filename> into the
303 folder <filename class="directory">Evergreen.app/MacOS</filename>
304 (do not symlink; copy the file).</listitem>
306 <para>Make <filename>Evergreen.app/Resources</filename> the root
307 of your Evergreen application files like this:</para>
309 <prompt>Evergreen.app/</prompt>
310 <prompt>__Contents/</prompt>
311 <prompt>____Resources/</prompt>
312 <prompt>______BUILD_ID</prompt>
313 <prompt>______application.ini</prompt>
314 <prompt>______chrome/</prompt>
315 <prompt>______components/</prompt>
316 <prompt>______etc.</prompt>
319 <listitem>Put a <systemitem class="osname">Mac</systemitem>
320 format icon file named <filename>Evergreen.icns</filename> in
321 <filename class="resources">Resources</filename>.</listitem>
325 <section xml:id="staffclientinstallation-installing-linux">
326 <title>Installing on Linux</title>
328 <title>Quick Upgrade of the Staff Client</title>
329 <para>A Linux Staff Client is automatically built on the server as part of the
330 normal <emphasis>make install</emphasis> process for Evergreen server-side
331 software. To upgrade the Staff Client on a remote Linux workstation with a new
332 version, just copy the directory tree containing the Staff Client from your
333 server to the remote workstation.</para>
334 <para>Execute the following commands, replacing <literal>USER</literal>,
335 <literal>WORKSTATION</literal>, and <literal>SOME_PATH</literal> with
336 appropriate values:</para>
338 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
339 <userinput>scp -r ./build USER@WORKSTATION:/SOME_PATH/</userinput>
341 <para>You should test the newly copied Staff Client on the remote workstation.
342 Log into the workstation and execute the following command:</para>
344 <userinput>xulrunner /SOME_PATH/build/application.ini</userinput>
348 <title>Building the Staff Client on the Server</title>
350 <primary>staff client</primary>
351 <secondary>building on the server</secondary>
353 <para>A Linux Staff Client is automatically built on the server as part of the
354 normal <emphasis>make install</emphasis> process for Evergreen server-side
355 software. See <xref linkend="serversideinstallation-compile"/> for details of
356 the build process.</para>
357 <para>In order to install a compatible Staff Client on another Linux system, you
358 can copy the appropriate files from the Staff Client build directory on your
359 server to the new Linux system. You could manually build the Staff Client on the
360 new system, but you must ensure that the <envar>BUILD_ID</envar> you chose on
361 the server matches the <envar>BUILD_ID</envar> for each Staff Client you use on
362 other systems.</para>
363 <para>If you wish to use a pre-packaged <systemitem class="osname">Windows</systemitem>
364 version on some systems, you may want to choose the <envar>BUILD_ID</envar> on
365 both server and other versions to match that of the
366 <systemitem class="osname">Windows</systemitem> Staff Client. To determine which
367 <envar>BUILD_ID</envar> was used for existing Staff Client installations,
368 execute each Staff Client and click the <guibutton>'About this Client'</guibutton>
370 <para>If you are allowed to make changes on the Evergreen server, another option
371 is to create a symbolic link. In order for a copy of the Staff Client and server
372 to work together, the <envar>BUILD_ID</envar> must match the name of the
373 directory containing the server components of the Staff Client, or the name of a
374 symbolic link to that directory. As the
375 <systemitem class="username">root</systemitem> user, make the changes as follows:</para>
377 <prompt># as the root user</prompt>
378 <userinput>cd /openils/var/web/xul</userinput>
379 <userinput>ln -s SERVER_BUILD_ID/ CLIENT_BUILD_ID</userinput>
383 <title>Building the Staff Client on a Client Machine</title>
384 <para>This section is directed toward end-users who wish to use Linux rather than
385 <systemitem class="osname">Windows</systemitem> for client machines, but have limited
386 Linux experience. You can build the Staff Client on a Linux system without installing the
387 Evergreen Server component. This is a relatively simple process compared to server
388 installation, but does require some command-line work. The following instructions are
389 for building Staff Client version 1.2.1.4 on
390 <systemitem class="osname">Kubuntu 7.10</systemitem>; modify them as needed for
391 other distributions (the instructions should work as-is for
392 <systemitem class="osname">Ubuntu</systemitem> or
393 <systemitem class="osname">Ubuntu</systemitem> derivatives).</para>
396 <title>Prerequisites</title>
397 <para>Both <application>subversion</application> and
398 <application>XULrunner</application> are required to build the Staff
399 Client. As the <systemitem class="username">root</systemitem> user,
400 use <command>apt-get</command> to install packages for
401 <application>subversion</application> and
402 <application>XULrunner</application>. You can also use
403 <command>synaptic</command>, the graphical user interface for
404 <command>apt-get</command>. For <application>subversion</application>,
405 select the latest version; for <application>XULrunner</application>,
406 select version <emphasis>1.8.1.4-2ubuntu5</emphasis>.</para>
408 <prompt># as the root user</prompt>
409 <userinput>sudo apt-get install subversion</userinput>
410 <userinput>sudo apt-get install xulrunner</userinput>
414 <title>Download the Source Code</title>
417 <para>Determine which version is needed</para>
418 <para>For most end-users, a specific version is required
419 to communicate properly with the Evergreen server. Check
420 with your system administrator, IT person, or HelpDesk to
421 determine which Staff Client versions are
423 <para>Next, you need to determine which
424 <emphasis>tag</emphasis> to use when downloading the
425 source code. Tags are markers in the source code to create
426 a snapshot of the code as it existed at a certain time;
427 tags usually point to tested and stable code, or at least
428 a community-recognized release version.</para>
429 <para>To determine which tag to use, browse to
430 <ulink url="http://svn.open-ils.org/trac/ILS/browser">
431 http://svn.open-ils.org/trac/ILS/browser</ulink>.
432 Look in the <guilabel>Visit</guilabel> drop-down box; see
433 the list of <guilabel>Branches</guilabel> and, further
434 down, a list of <guilabel>Tags</guilabel>. You may have
435 to do some guesswork, but it is fairly straightforward to
436 determine which tag to use. If the server is version
437 1.6.1.2, you will want to use the tag that looks most
438 appropriate. For example, as you look through the tag
439 list, notice the tag named 'rel_1_6_1_2'. This is the tag
440 you need; make a note of it for the next step.</para>
443 <para>Download the Code</para>
445 <systemitem class="username">opensrf</systemitem>
446 user, open a terminal (command-line prompt) and navigate
447 to the directory in which you wish to download the Staff
448 Client. Use the following commands to download the proper
449 version of the source code by tag name:</para>
451 <prompt># as the opensrf user</prompt>
452 <userinput>cd /DOWNLOAD/DIRECTORY</userinput>
453 <userinput>svn co rel_1_6_1_2/</userinput>
455 <para>Remember to change "rel_1_6_1_2" to the appropriate
456 tag for your installation.</para>
461 <title>Build the Staff Client</title>
462 <para>In the following example, navigate to the directory in
463 which the source code was downloaded, then navigate to the
464 proper subdirectory and run the "make" utility to actually build
465 the Staff Client. Remember to check with your system
466 administrator about which Staff Client <envar>BUILD_ID</envar>
467 to use. The server checks the Staff Client
468 <envar>BUILD_ID</envar> against itself to determine whether or
469 not a connecting client is supported. For instance, for the
470 PINES installation (version 1.6.1.2) the supported
471 <envar>BUILD_ID</envar> is "rel_1_6_1_2". Modify the following
472 commands accordingly.</para>
473 <para>As the <systemitem class="username">opensrf</systemitem>
474 user, run the following commands to build the Staff Client:</para>
476 <prompt># as the opensrf user</prompt>
477 <userinput>wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.1.2.tar.gz</userinput>
478 <userinput>tar xfz Evergreen-ILS-1.6.1.2.tar.gz</userinput>
479 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2</userinput>
480 <userinput>./configure --prefix=/openils --sysconfdir=/openils/conf</userinput>
481 <userinput>cd ./Open-ILS/xul/staff_client/</userinput>
482 <userinput>make STAFF_CLIENT_BUILD_ID='rel_1_6_1_2' install</userinput>
486 <title>Run the Staff Client</title>
487 <para>As the <systemitem class="username">opensrf</systemitem>
488 user, navigate to the <filename class="directory">build/</filename>
489 subdirectory and run the following command:</para>
491 <prompt># as the opensrf user</prompt>
492 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build</userinput>
493 <userinput>xulrunner application.ini</userinput>
497 <title>(OPTIONAL) Clean Up / Create Shortcuts</title>
498 <para>The source code download included many files that are
499 needed to build the Staff Client but are not necessary to run
500 it. You may wish to remove them to save space, or to create a
501 clean <literal>staging</literal> directory containing the
502 finished Staff Client that can then be copied to other
503 machines. To do this, execute the following commands (remember
504 to replace <literal>DOWNLOAD_DIRECTORY</literal> and
505 <literal>STAGING_DIRECTORY</literal> with the appropriate
508 <prompt># as the opensrf user</prompt>
509 <userinput>mkdir ~/STAGING_DIRECTORY</userinput>
510 <userinput>cd ~/DOWNLOAD_DIRECTORY/Open-ILS/xul/</userinput>
511 <userinput>cp -r staff_client ~/STAGING_DIRECTORY</userinput>
513 <para>Test the Staff Client to verify that all necessary files
514 were copied to the staging directory:</para>
516 <prompt># as the opensrf user</prompt>
517 <userinput>cd ~/STAGING_DIRECTORY/staff_client/build</userinput>
518 <userinput>xulrunner application.ini</userinput>
520 <para>If there were no problems, then finish the cleanup by
521 removing the original download directory as shown:</para>
523 <prompt># as the opensrf user</prompt>
524 <userinput>rm -r -f ~/DOWNLOAD_DIRECTORY</userinput>
526 <para>Finally, the command:</para>
528 <prompt># as the opensrf user</prompt>
529 <userinput>xulrunner ~/STAGING_DIRECTORY/staff_client/build/application.ini</userinput>
531 <para>will now run the Staff Client. You may wish to create a
532 shortcut for the Staff Client. To do so, use the previous
533 command as the target for the shortcut:
535 <guimenu>Desktop</guimenu>
536 <guimenuitem>StartMenu</guimenuitem>
537 <guimenuitem>K-Menu</guimenuitem>
544 <title>Using Wine to Install on Linux</title>
546 <primary>staff client</primary>
547 <secondary>using wine to install on Linux</secondary>
549 <para>The Linux application <application>Wine</application> is another
550 alternative if you wish to install the packaged
551 <systemitem class="osname">Windows</systemitem> versions rather than manually
552 building the Staff Client. <application>Wine</application> is a Linux
553 application that allows users to directly run
554 <systemitem class="osname">Windows</systemitem> executables, and is a simple
555 way for casual Linux users to use the Staff Client. You can find more information
556 about <application>Wine</application> at
557 <ulink url="http://www.winehq.org/site/docs/wineusr-guide/getting-wine">
558 http://www.winehq.org/site/docs/wineusr-guide/getting-wine</ulink>.</para>
559 <para>As the <systemitem class="username">root</systemitem> user, use
560 <command>apt-get</command> to install the package for <application>Wine</application>.
561 You can also use <command>synaptic</command>, the graphical user interface.</para>
564 <para>Install wine:</para>
566 <prompt># as the root user</prompt>
567 <userinput>sudo apt-get install wine</userinput>
571 <para>Visit the downloads section of the Evergreen website at
572 <ulink url="http://www.evergreen-ils.org/downloads.php">
573 http://www.evergreen-ils.org/downloads.php</ulink> and find the
574 <systemitem class="osname">Microsoft Windows</systemitem> Installer
575 that contains the desired version of the Staff Client. Download
576 the installer and place it in a temporary directory.</para>
579 <para>As the <systemitem class="username">opensrf</systemitem>
580 user, navigate to the temporary directory where you downloaded
581 the <systemitem class="osname">Windows</systemitem> installer
582 file, then execute it with the <application>wine</application>
583 application (remember to replace <literal>VERSION</literal> with
584 the release number of the Staff Client you downloaded):</para>
586 <prompt># as the opensrf user</prompt>
587 <userinput>cd /TEMP_DIRECTORY</userinput>
588 <userinput>wine evergreen-setup-rel_VERSION.exe</userinput>
590 <para>If this step fails, you may need to configure
591 <application>Wine</application> first to properly emulate
592 <systemitem class="osname">Windows XP</systemitem>. To do so,
593 type <command>winecfg</command> from the command line; in the
594 <literal>Applications</literal> tab of the window that pops up,
595 select <literal>Default Settings</literal> and choose
596 <literal>Windows XP</literal> from the drop-down menu, then
597 click <guibutton>'Apply'</guibutton>.</para>
600 <para>Launch the Staff Client</para>
601 <para>A new entry for the Staff Client should now appear
602 somewhere in the <literal>All Applications</literal> menu of
603 your Linux desktop. You may also find a new desktop shortcut for
604 the Staff Client. To launch the Staff Client, visit the
605 <literal>All Applications</literal> menu on your desktop and
606 find the section similar to
608 <guimenu>Wine</guimenu>
609 <guimenuitem>Program Files</guimenuitem>
610 <guimenuitem>Evergreen Staff Client</guimenuitem>
611 <guimenuitem>Evergreen Staff Client</guimenuitem>
613 or else launch the Staff Client from the new desktop shortcut.</para>
620 <title>Building the Staff Client</title>
622 <primary>staff client</primary>
623 <secondary>building</secondary>
625 <para>You can also manually build the Staff Client by using the <command>make</command>
626 utility in the Staff Client source directory (e.g., the directory
627 <filename class="directory">/home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</filename>
628 for the current Evergreen version). There are a number of possible options to manually
629 build special versions of the Staff Client on a Linux system. Following is a list of
630 variables that you can pass to <command>make</command> to influence the manual build
633 <title><envar>STAFF_CLIENT_BUILD_ID</envar></title>
634 <para>During the normal <emphasis>make install</emphasis> Evergreen server-side
635 software build process, the variable defaults to an automatically generated
636 date/time string, but you can also override the value of <envar>BUILD_ID</envar>.</para>
637 <para>You could use the following commands during the normal install process:</para>
639 <prompt># as the root user</prompt>
640 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2</userinput>
641 <userinput>make STAFF_CLIENT_BUILD_ID=1_6_1_2 install</userinput>
643 <para>You can also manually build the Staff Client in the Staff Client
644 source directory with a different <envar>BUILD_ID</envar>.</para>
645 <para>As the <systemitem class="username">opensrf</systemitem> user,
646 execute the following commands to build the Staff Client (remember to replace
647 <literal>NEW_VERSION</literal> with an appropriate value):</para>
649 <prompt># as the opensrf user</prompt>
650 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
651 <userinput>make STAFF_CLIENT_BUILD_ID=NEWVERSION build</userinput>
655 <title><envar>STAFF_CLIENT_VERSION</envar></title>
656 <para>During the normal <emphasis>make install</emphasis> Evergreen server-side
657 software build process, the variable is pulled automatically from a README file
658 in the Evergreen source root. The variable defaults to
659 <emphasis>0trunk.revision</emphasis>, where the value of "revision" is
660 automatically generated. You can override the value of <envar>VERSION</envar>
661 similarly to the <envar>BUILD_ID</envar>.</para>
662 <para>You could use the following commands during the normal install process:</para>
664 <prompt># as the root user</prompt>
665 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2</userinput>
666 <userinput>make STAFF_CLIENT_VERSION=0mytest.200 install</userinput>
668 <para>You can also manually build the Staff Client in the Staff Client
669 source directory with a different <envar>VERSION</envar>.</para>
670 <para>If you plan to make extensions update automatically, the
671 <envar>VERSION</envar> needs to conform to the format recommended in
672 <ulink url="https://developer.mozilla.org/en/Toolkit_version_format">
673 Toolkit Version Format</ulink> and newer versions need to be "higher" than older
675 <para>As the <systemitem class="username">opensrf</systemitem> user,
676 execute the following commands to build the Staff Client:</para>
678 <prompt># as the opensrf user</prompt>
679 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
680 <userinput>make STAFF_CLIENT_VERSION=0mytest.200 build</userinput>
684 <title><envar>STAFF_CLIENT_STAMP_ID</envar></title>
685 <para>During the normal <emphasis>make install</emphasis> Evergreen
686 server-side software build process, the variable is generated from
687 <envar>STAFF_CLIENT_VERSION</envar>. You may want to have multiple versions
688 of the Staff Client with different stamps, possibly for different uses or
689 client-side customizations. You can override the value of
690 <envar>STAMP_ID</envar> similarly to the <envar>BUILD_ID</envar>.</para>
691 <para>You could use the following commands during the normal install process:</para>
693 <prompt># as the root user</prompt>
694 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2</userinput>
695 <userinput>make STAFF_CLIENT_STAMP_ID=my_test_stamp install</userinput>
697 <para>You can also manually build the Staff Client in the Staff Client
698 source directory with a different <envar>STAMP_ID</envar>.</para>
699 <para>As the <systemitem class="username">opensrf</systemitem> user,
700 execute the following commands to build the Staff Client:</para>
702 <prompt># as the opensrf user</prompt>
703 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
704 <userinput>make STAFF_CLIENT_STAMP_ID=my_test_stamp build</userinput>
709 <title>Advanced Build Options</title>
711 <primary>staff client</primary>
712 <secondary>building</secondary>
713 <tertiary>advanced build options</tertiary>
715 <para>In addition to the basic options listed above, there are a number of advanced
716 options for building the Staff Client. Most are target names for the
717 <command>make</command> utility and require that you build the Staff Client from the
718 <literal>staff_client</literal> directory. See the following table for a list of
719 possible <command>make</command> target keywords:</para>
721 <title>Keywords Targets for "make" Command</title>
722 <tgroup align="left" cols="2" colsep="1" rowsep="1">
723 <colspec colnum="1" colwidth="1.0*"/>
724 <colspec colnum="2" colwidth="3.0*"/>
727 <entry>Keyword</entry>
728 <entry>Description</entry>
733 <entry>clients</entry>
734 <entry>Runs "make win-client", "make linux-client", and "make
735 generic-client" individually</entry>
738 <entry>client_dir</entry>
739 <entry>Builds a client directory from the build directory, without
740 doing a rebuild. The same as "copy everything but
744 <entry>client_app</entry>
745 <entry>Prerequisite "client_dir"; removes "install.rdf" from
746 client directory so an APP bundle can't be installed as an
750 <entry>client_ext</entry>
751 <entry>Prerequisite "client_dir"; remove "application.ini",
752 "autoupdate.js", "standalone_xul_app.js" from client directory so
753 an extension won't break Firefox</entry>
756 <entry>extension</entry>
757 <entry>Prerequisite "client_ext"; rewritten to use "client_ext"</entry>
760 <entry>generic-client</entry>
761 <entry>Prerequisite "client_app"; makes an XPI file suitable for
762 use with "xulrunner --install-app""</entry>
765 <entry>win-xulrunner</entry>
766 <entry>Prerequisite "client_app"; adds Windows xulrunner to client build</entry>
769 <entry>linux-xulrunner</entry>
770 <entry>Prerequisite "client_app"; adds Linux xulrunner to client build</entry>
773 <entry>win-client</entry>
774 <entry>Prerequisite "win-xulrunner"; builds "setup exe" (requires
775 that "nsis" package be installed, will add options for automatic
776 update if configured and developer options if client build was a
777 "make devbuild")</entry>
780 <entry>linux-client</entry>
781 <entry>Prerequisite "linux_xulrunner"; builds a "tar.bz2" bundle
782 of the Linux client</entry>
785 <entry>[generic-|win-|linux-|extension-]updates[-client]</entry>
786 <entry>Calls external/make_updates.sh to build full and partial
787 updates generic/win/linux/extension prefix limit to that
788 distribution; Adding <option>-client</option> builds clients and
789 copies them to a subdirectory of the
790 <filename class="directory">updates</filename> directory as well;
791 <option>extension-updates-client</option> doesn't exist.</entry>
796 <para>Following are descriptions of other special build options:</para>
798 <title>Developer Build</title>
799 <para>You can create a so-called <emphasis>developer build</emphasis>
800 of the Staff Client by substituting <option>devbuild</option> for
801 <option>build</option> when running <command>make</command> from the
802 <literal>staff_client</literal> directory. The build will contain an
803 extra configuration file that enables some developer options.</para>
804 <para>As the <systemitem class="username">opensrf</systemitem> user, run
805 the following commands from the Staff Client source directory:</para>
807 <prompt># as the opensrf user</prompt>
808 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
809 <userinput>make devbuild</userinput>
813 <title>Compressed Javascript</title>
814 <para>You can execute the Google <systemitem class="resource">Closure Compiler</systemitem>
815 utility to automatically review and compress Javascript code after the build
816 process completes, by substituting <option>compress-javascript</option> for
817 <option>build</option> when running <command>make</command>.
818 For more information on the Google Closure Compiler, see
819 <ulink url="http://code.google.com/closure/compiler/">
820 http://code.google.com/closure/compiler</ulink>.</para>
821 <para>As the <systemitem class="username">opensrf</systemitem> user, run
822 the following commands from the Staff Client source directory:</para>
824 <prompt># as the opensrf user</prompt>
825 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
826 <userinput>make compress-javascript</userinput>
828 <para>You can also combine Javascript review and compression, and also perform a
829 <emphasis>developer build</emphasis>.</para>
830 <para>As the <systemitem class="username">opensrf</systemitem> user, run the
831 following commands from the Staff Client source directory:</para>
832 <note>In the following <command>make</command> below, the order of options is
835 <prompt># as the opensrf user</prompt>
836 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
837 <userinput>make devbuild compress-javascript</userinput>
840 <simplesect xml:id="staffclientinstallation-autoupdatehost">
841 <title>Automatic Update Host</title>
842 <para>You can override the host used to check for automatic Staff Client updates
843 by specifying the <option>AUTOUPDATE_HOST</option> option.</para>
844 <para>You could use the following commands during the normal install process:</para>
846 <prompt># as the root user</prompt>
847 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2</userinput>
848 <userinput>make AUTOUPDATE_HOST=localhost install</userinput>
850 <para>You can manually build the Staff Client in the Staff Client
851 source directory and set <option>AUTOUPDATE_HOST</option> to enable automatic
852 update checking.</para>
853 <para>As the <systemitem class="username">opensrf</systemitem> user,
854 execute the following commands to build the Staff Client:</para>
856 <prompt># as the opensrf user</prompt>
857 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
858 <userinput>make AUTOUPDATE_HOST=localhost build</userinput>
860 <para>For more information on Automatic Updates, see
861 <xref linkend="staffclientinstallation-autoupdate"/>.</para>
865 <title>Installing and Activating a Manually Built Staff Client</title>
866 <para>The Staff Client is automatically built, installed and activated as part of the
867 normal <command>make<option>install</option></command> process for Evergreen
868 server-side software. However, if you manually build the Staff Client from the
869 <literal>staff_client</literal> directory, then you need to take additional steps to
870 properly install and activate it. You also have the option of installing the Staff
871 Client on the same machine it was built on, or on a different machine.</para>
872 <para>Assuming you have already built the Staff Client, and that your installation is
873 in the directory <filename class="directory">/openils/var/web/xul</filename>, as the
874 <systemitem class="username">opensrf</systemitem> user execute the following
877 <prompt># as the opensrf user</prompt>
878 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
879 <userinput>mkdir -p "/openils/var/web/xul/$(cat build/BUILD_ID)"</userinput>
880 <userinput>cp -R build/server "/openils/var/web/xul/$(cat build/BUILD_ID)"</userinput>
884 <title>Packaging the Staff Client</title>
885 <para>Once you have built the Staff Client, you can create several forms of special client
886 packages by using a modified <command>make</command> command in the <literal>staff_client</literal>
889 <title>Packaging a Generic Client</title>
890 <para>This build creates a Staff Client packaged as an XPI file suitable for use with
891 the <option>--install-app</option> parameter of <application>XULrunner</application>.
892 It requires that you already have the <systemitem>zip</systemitem> utility
893 installed on your system.</para>
894 <para>As the <systemitem class="username">opensrf</systemitem> user, execute
895 the following commands:</para>
897 <prompt># as the opensrf user</prompt>
898 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
899 <userinput>make generic-client</userinput>
901 <para>The output file <filename>evergreen_staff_client.xpi</filename> will be created.</para>
905 <title>Packaging a <systemitem class="osname">Windows</systemitem> Client</title>
906 <para>This build creates a Staff Client packaged as a
907 <systemitem class="osname">Windows</systemitem> executable. It requires that
908 you already have the <application>unzip</application> utility installed on
909 your system. It also requires that you install
910 <ulink url="http://nsis.sourceforge.net/">NSIS (Nullsoft Scriptable Install System)</ulink>,
911 a professional open source utility package used to create
912 <systemitem class="osname">Windows</systemitem> installers (the
913 <application>"makensis"</application> utility is installed as part of the
914 <application>"nsis"</application> package). You should use Version 2.45 or
916 <para>If you wish for the Staff Client to have a link icon/tray icon by
917 default, you may wish to provide a pre-modified
918 <application>xulrunner-stub.exe</application>. Place it in the Staff Client
919 source directory and <command>make</command> will automatically use it instead
920 of the one that comes with the downloaded <application>XULrunner</application>
921 release. The version of <application>xulrunner-stub.exe</application> need not
922 match exactly.</para>
923 <para>You can also use a tool such as
924 <ulink url="http://www.angusj.com/resourcehacker/">Resource Hacker</ulink>
925 to embed icons. <application>Resource Hacker</application> is an open-source
926 utility used to modify resources within 32-bit
927 <systemitem class="osname">Windows</systemitem> executables.
928 Some useful icon ID strings include the following:</para>
930 <title>Useful icon ID strings</title>
931 <tgroup align="left" cols="2" colsep="1" rowsep="1">
932 <colspec colnum="1" colwidth="1.0*"/>
933 <colspec colnum="2" colwidth="1.0*"/>
936 <entry>IDI_APPICON</entry>
937 <entry>Tray icon</entry>
941 <entry>Default window icon</entry>
946 <para>As the <systemitem class="username">opensrf</systemitem> user
947 execute the following commands:</para>
949 <prompt># as the opensrf user</prompt>
950 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
951 <userinput>make win-client</userinput>
953 <para>The output file <filename>evergreen_staff_client_setup.exe</filename> will be created.</para>
956 <title>Packaging a Linux Client</title>
957 <para>This build creates a Staff Client packaged as a compressed
958 <literal>tar</literal> archive file with <application>XULrunner</application>
959 already bundled with it. It requires that you already have the
960 <application>bzip2</application> utility installed on your system.</para>
961 <para>As the <systemitem class="username">opensrf</systemitem> user,
962 execute the following commands:</para>
964 <prompt># as the opensrf user</prompt>
965 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
966 <userinput>make linux-client</userinput>
968 <para>The output file <filename>evergreen_staff_client.tar.bz2</filename> will be created.</para>
971 <title>Packaging a <application>Firefox</application> Extension</title>
972 <para>This build creates a Staff Client packaged as a <application>Firefox</application>
973 extension. It requires that you already have the <systemitem>zip</systemitem>
974 utility installed on your system.</para>
975 <para>As the <systemitem class="username">opensrf</systemitem> user,
976 execute the following commands:</para>
978 <prompt># as the opensrf user</prompt>
979 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
980 <userinput>make extension</userinput>
982 <para>The output file <filename>evergreen.xpi</filename> will be created.</para>
985 <section xml:id="staffclientinstallation-autoupdate">
986 <title>Staff Client Automatic Updates</title>
988 <primary>staff client</primary>
989 <secondary>automatic updates</secondary>
991 <para>It is possible to set up support for automatic Staff Client updates, either during
992 the normal Evergreen server-side build process, or by manually building the Staff Client
993 with certain special options.</para>
995 <para>Automatic update server certificate requirements are more strict than
996 normal server requirements. <application>Firefox</application> and
997 <application>XULrunner</application> will both ignore any automatic update
998 server that is not validated by a trusted certificate authority. Servers with
999 exceptions added to force the Staff Client to accept them <emphasis>WILL NOT
1000 WORK</emphasis>.</para>
1001 <para>In addition, automatic updates have special requirements for the file
1002 <filename>update.rdf</filename>:</para>
1004 <listitem>It must be served from an SSL server, or</listitem>
1005 <listitem>It must be signed with the <ulink url="https://developer.mozilla.org/en/McCoy">
1006 https://developer.mozilla.org/en/McCoy</ulink> tool.</listitem>
1008 <para>You can pre-install the signing key into the file
1009 <filename>install.rdf</filename> directly, or install it into a copy as
1010 <filename>install.mccoy.rdf</filename>. If the latter exists it will be copied
1011 into the build instead of the original file
1012 <filename>install.rdf</filename>.</para>
1015 <title>Autoupdate Host</title>
1016 <para>You can manually set the name of the automatic update host. If you do
1017 not set the name then, by default, the Staff Client will not include an
1018 automatic update preference. You can set the autoupdate host name as
1022 <para>At configuration time during the normal <emphasis>make install</emphasis>
1023 process for Evergreen server-side software.</para>
1024 <para>You can do this when you first configure the Evergreen server-side
1025 software (see <xref linkend="serversideinstallation-configure"/>).
1026 As the <systemitem class="username">opensrf</systemitem> user, execute
1027 the following commands:</para>
1029 <prompt># as the opensrf user</prompt>
1030 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2</userinput>
1031 <userinput>./configure --prefix=/openils --sysconfdir=/openils/conf --with-updateshost=hostname</userinput>
1032 <userinput>make</userinput>
1036 <para>During a manual Staff Client build process.</para>
1037 <para>You can override the variable
1038 <envar>AUTOUPDATE_HOST=hostname</envar> and manually build the
1039 Staff Client from the <literal>staff_client</literal>
1040 directory (see <xref linkend="staffclientinstallation-autoupdatehost"/>
1041 for details). If you specify only a bare hostname (for example,
1042 <systemitem class="domainname">example.com</systemitem>) then
1043 the Staff Client will automatically use the secure URL
1044 <systemitem class="domainname">https://example.com</systemitem>.
1045 If you wish to use a non-https URL, then you must explicitly
1046 specify the full URL (for example,
1047 <systemitem class="domainname">http://example.com</systemitem>).</para>
1048 <para>As the <systemitem class="username">opensrf</systemitem> user,
1049 execute the following commands to build the Staff Client (remember to
1050 replace <literal>SOME_URL</literal> with an appropriate value)
1053 <prompt># as the opensrf user</prompt>
1054 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
1055 <userinput>make AUTOUPDATE_HOST=http://SOME_URL build</userinput>
1061 <title>Building Updates</title>
1063 <primary>staff client</primary>
1064 <secondary>automatic updates</secondary>
1065 <tertiary>building</tertiary>
1067 <para>Similar to building clients, you can use the targets
1068 <option>generic-updates</option>, <option>win-updates</option>,
1069 <option>linux-updates</option>, and <option>extension-updates</option>
1070 individually with <command>make</command> to build the update files for the
1071 Staff Client. To build all the targets at once, simply use the target
1072 <option>updates</option>.</para>
1073 <para>A full update will be built for each specified target (or for all if you
1074 use the target <option>updates</option>). For all but extensions any previous
1075 full updates (archived by default in the directory
1076 <filename class="directory">/openils/var/updates/archives</filename>) will be
1077 used to make partial updates. Partial updates tend to be much smaller and will
1078 thus download more quickly, but if something goes wrong with a partial update
1079 the full update will be used as a fallback. Extensions do not currently support
1080 partial updates.</para>
1081 <para>As the <systemitem class="username">opensrf</systemitem> user, change
1082 directory to the Staff Client source directory, then execute the following
1085 <prompt># as the opensrf user</prompt>
1086 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
1088 <para>Command to build all updates at once:</para>
1090 <prompt># as the opensrf user</prompt>
1091 <userinput>make updates</userinput>
1093 <para>commands to build updates individually:</para>
1095 <prompt># as the opensrf user</prompt>
1096 <userinput>make generic-updates</userinput>
1097 <userinput>make win-updates</userinput>
1098 <userinput>make linux-updates</userinput>
1099 <userinput>make extension-updates</userinput>
1103 <title>Building updates with clients</title>
1105 <primary>staff client</primary>
1106 <secondary>automatic updates</secondary>
1107 <tertiary>building with clients</tertiary>
1109 <para>To save time and effort you can build updates and manual download
1110 clients at the same time by adding the phrase <literal>"-client"</literal> to each
1111 target name (for example, you could specify <option>updates-client</option> to build
1112 all the targets at once, or you could specify <option>win-updates-client</option>
1113 to build updates individually). This process will not work for the option
1114 <option>extension-updates</option>.</para>
1115 <para>The clients will be installed alongside the updates and listed on the
1116 <filename>manualupdate.html</filename> page, instead of being left in the
1117 <literal>staff_client</literal> directory.</para>
1118 <para>As the <systemitem class="username">opensrf</systemitem> user, execute
1119 one of the following commands:</para>
1120 <para>To build all updates at once:</para>
1122 <prompt># as the opensrf user</prompt>
1123 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
1124 <userinput>make updates-client</userinput>
1126 <para>To build updates individually:</para>
1128 <prompt># as the opensrf user</prompt>
1129 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
1130 <userinput>make generic-updates-client</userinput>
1131 <userinput>make win-updates-client</userinput>
1132 <userinput>make linux-updates-client</userinput>
1136 <title>Activating the Update Server</title>
1138 <primary>staff client</primary>
1139 <secondary>automatic updates</secondary>
1140 <tertiary>activating the update server</tertiary>
1142 <para>This section reviews scripts associated with the update server, and
1143 requires some final adjustments to file permissions.</para>
1144 <para>The Apache example configuration creates an <literal>updates</literal>
1145 directory that, by default, points to the directory
1146 <filename class="directory">/openils/var/updates/pub</filename>. This
1147 directory contains one HTML file and several specially-named script files.</para>
1148 <para>The <filename>updatedetails.html</filename> file is the fallback web
1149 page for the update details. The <filename>check</filename> script is used for
1150 <application>XULrunner</application> updates. The
1151 <filename>update.rdf</filename> script is used for extension updates.
1152 The <filename>manualupdate.html</filename> file checks for clients to provide
1153 download links when automatic updates have failed and uses the download script
1154 to force a download of the generic client XPI (compared to
1155 <application>Firefox</application> trying to install it as an
1157 <para>To change the permissions for the scripts
1158 <filename>check</filename>, <filename>download</filename>,
1159 <filename>manualupdate.html</filename>, and
1160 <filename>update.rdf</filename>, as the root user execute the following
1163 <prompt># as the root user</prompt>
1164 <userinput>cd /openils/var/updates/pub</userinput>
1165 <userinput>chmod +x check download manualupdate.html update.rdf</userinput>
1170 <title>Other tips</title>
1171 <simplesect xml:id="staffclientinstallation-othertips">
1172 <title>Multiple workstations on one install</title>
1173 <para>Multiple workstation registrations for the same server can be accomplished
1174 with a single Staff Client install by using multiple profiles. When running
1175 <application>XULrunner</application> you can specify the option
1176 <literal>"-profilemanager"</literal> or <literal>"-P"</literal> (uppercase "P")
1177 to force the Profile Manager to start. Unchecking the <literal>"Don't ask at startup"</literal>
1178 option will make this the default.</para>
1179 <para>Once you have opened the Profile Manager you can create additional
1180 profiles, one for each workstation you wish to register. You may need to install
1181 SSL exceptions for each profile.</para>
1182 <para>When building any of the targets <option>win-client</option>,
1183 <option>win-updates-client</option>, or <option>updates-client</option>, you can
1184 specify <option>NSIS_EXTRAOPTS=-DPROFILES</option> to add an option
1185 <guimenuitem>"Evergreen Staff Client Profile Manager"</guimenuitem> to the
1187 <para>As the <systemitem class="username">opensrf</systemitem> user,
1188 execute the following commands:</para>
1190 <prompt># as the opensrf user</prompt>
1191 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client</userinput>
1192 <userinput>make NSIS_EXTRAOPTS=-DPROFILES win-client</userinput>
1196 <title> Multiple Staff Clients</title>
1197 <para>It may be confusing if you are not careful, but you can log in to
1198 multiple Evergreen servers at the same time, or a single Evergreen server
1199 multiple times. In either case you will need to create an additional profile for
1200 each additional server or workstation you want to log in as (see the previous
1201 tip in <xref linkend="staffclientinstallation-othertips"/>).</para>
1202 <para>Once you have created the profiles, run
1203 <application>XULrunner</application> with the option <option>-no-remote</option>
1204 (in addition to <option>"-profilemanger"</option> or <option>"-P"</option> if
1205 needed). Instead of <application>XULrunner</application> opening a new login
1206 window on your existing session it will start a new session instead, which can
1207 then be logged in to a different server or workstation ID.</para>
1211 <section xml:id="staffclientinstallation-running-staffclient">
1212 <title>Running the Staff Client</title>
1214 <primary>staff client</primary>
1215 <secondary>running</secondary>
1216 <tertiary>linux</tertiary>
1218 <para>You can run the Staff Client on a Linux system by using the
1219 <application>XULrunner</application> application (installed automatically and by default
1220 with <application>Firefox</application> <literal>Version 3.0</literal> and later on
1221 <systemitem class="osname">Ubuntu</systemitem> and
1222 <systemitem class="osname">Debian</systemitem> distributions).</para>
1223 <para>For example, if the source files for the Evergreen installation are in the directory
1224 <filename class="directory">/home/opensrf/Evergreen-ILS-1.6.1.2/</filename> you can start the
1225 Staff Client as shown in the following example:</para>
1227 <prompt># as the opensrf user</prompt>
1228 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build</userinput>
1229 <userinput>xulrunner application.ini</userinput>
1231 <section xml:id="staffclientinstallation-workstationnames">
1232 <title>Assigning Workstation Names</title>
1234 <primary>staff client</primary>
1235 <secondary>assigning workstation names</secondary>
1237 <para>The Staff Client must be assigned to a library and given a unique name before it
1238 will connect fully to the Evergreen server. The only restriction is that the workstation's
1239 name must be unique within the assigned library. Make sure to select a workstation name
1240 that you will remember later, and reflects the role, purpose, and/or location of a
1241 particular computer. These names will come up later in statistical reporting, and can also
1242 be handy when troubleshooting.</para>
1245 <phrase>Example of unconfigured Staff Client</phrase>
1248 <imagedata fileref="../media/staffclientinstallation-staffclient-workstationnames-1.png" format="PNG" scalefit="1" width="60%"/>
1251 <para>In order to assign a workstation a name, a user with appropriate
1252 permissions must login to the Staff Client. In PINES, the local system
1253 administrator (OPSM) has the ability to assign workstation names in their
1254 library system. Library managers (LIBM's) have the ability within their
1255 branch. To assign a workstation a name, login to the system. You will be
1256 prompted to assign the workstation a library and a name:</para>
1259 <phrase>Example of configured Staff Client</phrase>
1262 <imagedata fileref="../media/staffclientinstallation-staffclient-workstationnames-2.png" format="PNG" scalefit="1" width="60%"/>
1265 <para>Select the library this workstation physically operates in from the drop
1266 down menu. In this example, we have selected "MGRL-MA". Type in a friendly name
1267 for the workstation. In this example, we are installing the Staff Client on the
1268 director's personal system, and have named it as such. Then click
1269 <guibutton>'Register'</guibutton>.</para>
1270 <para>Once you have registered your workstation
1271 with the server, your screen will look like this:</para>
1274 <phrase>Example of registered Staff Client</phrase>
1277 <imagedata fileref="../media/staffclientinstallation-staffclient-workstationnames-3.png" format="PNG" scalefit="1" width="60%"/>
1280 <para>You are now ready to log into the Staff Client for the first time. Type in
1281 your password again, and click <guibutton>'Login'</guibutton>.</para>
1283 <section xml:id="staffclientinstallation-proxy">
1284 <title>Running the Staff Client Over An <systemitem class="protocal">SSH</systemitem> Tunnel</title>
1286 <primary>staff client</primary>
1287 <secondary>running through an SSH tunnel</secondary>
1289 <para>You can configure the Staff Client to communicate with the Evergreen server over
1290 an <systemitem class="protocal">SSH</systemitem> tunnel using a SOCKS 5 proxy
1291 server. There are several reasons for sending network traffic for the Staff Client
1292 through an <systemitem class="protocal">SSH</systemitem> proxy:</para>
1295 <para>Firewalls may prevent you from reaching the Evergreen
1296 server. This may happen when you are connecting the Staff
1297 Client to a test server that should not be available
1298 generally, or it may be the result of network design
1299 priorities other than ease of use.</para>
1302 <para>You may wish to improve security in situations where
1303 Staff Client traffic may be susceptible to network
1304 eavesdropping. This is especially true when staff machines
1305 connect via wireless links to the network.</para>
1309 <title>Setting Up an <systemitem class="protocal">SSH</systemitem> Tunnel</title>
1310 <para>You will need a server that allows you to log in via
1311 <systemitem class="protocal">SSH</systemitem> and has network access to the
1312 Evergreen server you want to reach. You will use your username and password
1313 for that <systemitem class="protocal">SSH</systemitem> server to set up a
1315 <para>For <systemitem class="osname">Windows</systemitem> users, one good
1316 solution is the open-source utility
1317 <ulink url="http://www.chiark.greenend.org.uk/~sgtatham/putty/">PuTTY</ulink>,
1318 a free <systemitem class="protocal">telnet/SSH</systemitem> client.
1319 Following are instructions for setting up an <application>SSH</application>
1320 session using the <application>PuTTY</application> utility:</para>
1323 <phrase>Setting up an <systemitem class="protocal">SSH</systemitem>
1324 tunnel in <application>PuTTY</application></phrase>
1327 <imagedata fileref="../media/staffclientinstallation-proxy-putty.png" format="PNG" scalefit="1" width="60%"/>
1332 <para>Using the menu on the left, find the section
1334 <guimenu>Connection</guimenu>
1335 <guimenuitem>SSH</guimenuitem>
1336 <guimenuitem>Tunnels</guimenuitem>
1341 <para>In the section on the right labeled <literal>"Source
1342 port"</literal>, enter <literal>9999</literal>.</para>
1345 <para>Set the checkbox <literal>"Dynamic"</literal>. Do not
1346 enter anything in the <literal>"Destination"</literal> text
1350 <para>Click <guibutton>'Add'</guibutton> and notice that
1351 <literal>"D9999"</literal> now appears in the section
1352 labeled <literal>"Forwarded ports"</literal>.</para>
1355 <para>Use the menu on the left, find the
1356 <literal>"Session"</literal> section, then enter the host name
1357 of the <systemitem class="protocal">SSH</systemitem>
1361 <para>A pop-up window will open to allow you to enter your
1362 username and password. Once you are logged in, the tunnel is
1366 <para>See <ulink url="http://inside.mines.edu/~gmurray/HowTo/sshNotes.html">How to set up
1367 <systemitem class="protocal">SSH</systemitem> (for the beginner)</ulink> for information on
1368 setting up <systemitem class="protocal">SSH</systemitem> for other client operating
1372 <title>Configuring the Staff Client to Use the <systemitem class="protocal">SSH</systemitem> Tunnel</title>
1373 <para>In order to tell the Staff Client that all traffic should be sent
1374 through the <systemitem class="protocal">SSH</systemitem> tunnel just configured,
1375 you must find edit the file <filename>all.js</filename>, usually located at
1376 <filename>C:\Program Files\Evergreen Staff Client\greprefs\all.js</filename>
1377 on a <systemitem class="osname">Windows</systemitem> system.
1378 Search this file for the word <literal>socks</literal> to find the appropriate
1379 section for the following changes.</para>
1382 <phrase>The SOCKS section of "all.js" before changes</phrase>
1385 <imagedata fileref="../media/staffclientinstallation-proxy-socks-1.png" format="PNG" scalefit="1" width="70%"/>
1388 <para>Make the following changes:</para>
1391 <para>Change the value of <literal>network.proxy.socks</literal>
1392 from <literal>""</literal> to <literal>localhost</literal>.</para>
1395 <para>Change the value of <literal>network.proxy.socks_port</literal>
1396 from <literal>0</literal> to <literal>9999</literal>.</para>
1401 <phrase>The SOCKS section of "all.js" after changes</phrase>
1404 <imagedata fileref="../media/staffclientinstallation-proxy-socks-2.png" format="PNG" scalefit="1" width="70%"/>
1407 <para>If everything is working correctly, you should now be able to run
1408 the Staff Client and all its data will be sent encrypted through the
1409 <systemitem class="protocal">SSH</systemitem> tunnel you have just configured.</para>
1413 <title>Navigating a Tabbed Interface</title>
1414 <para>Like many popular current web browsers and other applications, the Staff Client
1415 uses a "tabbed" interface. Tabs allow you to have several pages open at the same time
1416 in a single window. This is easier to manage on your computer screen than multiple
1417 windows, since you can easily switch between tabs in the same window.</para>
1420 <phrase>Tabs in the Staff Client window</phrase>
1423 <imagedata fileref="../media/staffclientinstallation-tabbed-1.png" format="PNG" scalefit="1" width="70%"/>
1426 <para>The "tabs" appear below the menu bar in the Staff Client with a descriptive
1427 title. Simply select a tab to bring it to the front and view the page displayed in the
1428 tab. You can use tabs to have access to multiple things all at the same time: patron
1429 records and searches, bibliographic records and searches, circulation or cataloging
1430 interfaces - anything at all in the Staff Client.</para>
1432 <listitem>Create a new tab by pressing
1434 <keycap>Ctrl</keycap>
1437 on the keyboard or selecting
1439 <guimenu>File</guimenu>
1440 <guimenuitem>New Tab</guimenuitem>
1442 from the menu.</listitem>
1443 <listitem>Close a tab by pressing
1445 <keycap>Ctrl</keycap>
1447 </keycombo> on the keyboard or selecting
1449 <guimenu>File</guimenu>
1450 <guimenuitem>Close Tab</guimenuitem>
1452 from the menu.</listitem>
1453 <listitem>Switch tabs by pressing
1455 <keycap>Ctrl</keycap>
1456 <keycap>Tab</keycap>
1457 </keycombo> on the keyboard or selecting the tab in the tab bar.</listitem>
projects / working / Evergreen.git / blob