--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter xml:id="ServersideInstallation" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xl="http://www.w3.org/1999/xlink">
+ <info>
+ <title>Server-side Installation of Evergreen Software</title>
+ <abstract>
+ <para>This section describes installation of the Evergreen server-side software and its associated components. Installation, configuration, testing and verification
+ of the software is straightforward if you follow some simple directions.</para>
+ </abstract>
+ </info>
+ <para>Installing, configuring and testing the Evergreen server-side software is straightforward with the current stable software release. See
+ <xref linkend="serversideinstallation-all"/> for instructions tailored to installing on some particular distributions of the <systemitem class="osname">Linux</systemitem>
+ operating system.</para>
+ <para>The current version of the Evergreen server-side software runs as a native application on any of several well-known <systemitem class="osname">Linux</systemitem>
+ distributions (e.g., <systemitem class="osname">Ubuntu</systemitem> and <systemitem class="osname">Debian</systemitem>). It does not currently run as a native application
+ on the <systemitem class="osname">Microsoft Windows</systemitem> operating system (e.g., <systemitem class="osname">WindowsXP</systemitem>,
+ <systemitem class="osname">WindowsXP Professional</systemitem>, <systemitem class="osname">Windows7</systemitem>), but the software can still be installed and run on
+ <systemitem class="osname">Windows</systemitem> via a so-called <emphasis>virtualized</emphasis> Linux-guest Operating System (using, for example,
+ <application>"VirtualBox"</application>, or <application>"VMware"</application>, or <application>"VirtualPC"</application> to emulate a
+ <systemitem class="osname">Linux</systemitem> environment). It can also be installed to run on other <systemitem class="osname">Linux</systemitem> systems via virtualized
+ environments (using, for example, <application>"VirtualBox"</application> or <application>"VMware"</application>). More information on virtualized environments can be
+ found in <xref linkend="serversideinstallation-virtual"/>.</para>
+ <para>Installation of the Evergreen Staff Client software is reviewed in <xref linkend="serversideinstallation-staffclient"/>. </para>
+ <para>The Evergreen server-side software has dependencies on particular versions of certain major software sub-components. Successful installation of Evergreen
+ software requires that software versions agree with those listed here:</para>
+ <table xml:id="serversideinstall-software-dependencies">
+ <title>Evergreen Software Dependencies</title>
+ <tgroup align="left" cols="3" colsep="1" rowsep="1">
+ <colspec colname="Evergreen" colnum="1" colwidth="1.0*"/>
+ <colspec colname="OpenSRF" colnum="2" colwidth="1.0*"/>
+ <colspec colname="PostgreSQL" colnum="3" colwidth="1.0*"/>
+ <thead>
+ <row>
+ <entry>Evergreen</entry>
+ <entry>OpenSRF</entry>
+ <entry>PostgreSQL</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>1.6.x</entry>
+ <entry>1.2</entry>
+ <entry>8.2 / 8.3</entry>
+ </row>
+ <row>
+ <entry>1.4.x</entry>
+ <entry>1.0</entry>
+ <entry>8.1 / 8.2</entry>
+ </row>
+ <row>
+ <entry>1.2.x</entry>
+ <entry>0.9</entry>
+ <entry>8.1 / 8.2</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <section xml:id="serversideinstallation-all">
+ <title>Installing Server-Side Software</title>
+ <para>This section describes the installation of the major components of Evergreen server-side software.</para>
+ <para>As far as possible, you should perform the following steps in the exact order given since the success of many steps relies on the successful completion of earlier steps. You
+ should make backup copies of files and environments when you are instructed to do so. In the event of installation problems those copies can allow you to back out of a step gracefully
+ and resume the installation from a known state. See <xref linkend="backingup"/> for further information.</para>
+ <para>Of course, after you successfully complete and test the entire Evergreen installation you should take a final snapshot backup of your system(s). This can be the first in
+ the series of regularly scheduled system backups that you should probably also begin.</para>
+ <section xml:id="serversideinstallation-opensrf">
+ <title>Installing OpenSRF 1.2.2 On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem></title>
+ <para>This section describes the installation of the latest version of the Open Service Request Framework (OpenSRF), a major component of the Evergreen server-side software,
+ on <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> systems. Evergreen software is integrated with and depends on the
+ OpenSRF software system.</para>
+ <para>Follow the steps outlined here and run the specified tests to ensure that OpenSRF is properly installed and configured. Do not continue with any further
+ Evergreen installation steps until you have verified that OpenSRF has been successfully installed.</para>
+ <note>
+ <para>The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) platforms. OpenSRF 1.2.2 has been tested on <systemitem class="osname">Debian Etch
+ (4.0)</systemitem>, <systemitem class="osname">Debian Lenny</systemitem>, <systemitem class="osname">Ubuntu Hardy Heron (8.04)</systemitem>, and
+ <systemitem class="osname">Ubuntu Intrepid Ibex (8.10)</systemitem>.</para>
+ <para>In the following instructions, you are asked to perform certain steps as either the <systemitem class="username">root</systemitem> user, the
+ <systemitem class="username">opensrf</systemitem> user, or the <systemitem class="username">postgres</systemitem> user.</para>
+ <itemizedlist>
+ <listitem><systemitem class="osname">Debian</systemitem> -- To become the <systemitem class="username">root</systemitem> user, issue the command
+ <command>su -</command> and enter the password of the <systemitem class="username">root</systemitem> user.</listitem>
+ <listitem><systemitem class="osname">Ubuntu</systemitem> -- To become the <systemitem class="username">root</systemitem> user, issue the command
+ <command>sudo su -</command> and enter the password of the <systemitem class="username">root</systemitem> user.</listitem>
+ </itemizedlist>
+ <para>To switch from the <systemitem class="username">root</systemitem> user to a different user, issue the command <command>su - USERNAME</command>. For example, to
+ switch from the <systemitem class="username">root</systemitem> user to the <systemitem class="username">opensrf</systemitem> user, issue the command
+ <command>su - opensrf</command>. Once you have become a non-root user, to become the <systemitem class="username">root</systemitem> user again, simply issue
+ the command <command>exit"</command>.</para>
+ </note>
+ <procedure>
+ <step>
+ <title>Add the OpenSRF User</title>
+ <para>As the <systemitem class="username">root</systemitem> user, add the opensrf user to the system. The default shell for the new user is automatically set to
+ <command>/bin/bash</command> to inherit a reasonable environment:</para>
+ <screen>
+ <userinput>useradd -m -s /bin/bash opensrf</userinput>
+ <userinput>passwd opensrf</userinput>
+ </screen>
+ </step>
+ <step>
+ <title>Download and Unpack Latest OpenSRF Version</title>
+ <para>As the <systemitem class="username">opensrf</systemitem> user, download and extract the latest version of OpenSRF. The latest version can be found here:
+ <ulink url="http://evergreen-ils.org/downloads/OpenSRF-1.2.2.tar.gz"></ulink></para>
+ <screen>
+ <userinput>wget http://evergreen-ils.org/downloads/OpenSRF-1.2.2.tar.gz</userinput>
+ <userinput>tar zxf OpenSRF-1.2.2.tar.gz</userinput>
+ </screen>
+ <para>The new directory <filename class="directory">/home/opensrf/OpenSRF-1.2.2</filename> will be created.</para>
+ </step>
+ <step>
+ <title>Install Prerequisites to Build OpenSRF</title>
+ <para>In this section you will install and configure a set of prerequisites that will be used to build OpenSRF. In a following step you will actually build the
+ software using the <command>make</command> utility.</para>
+ <para>As the <systemitem class="username">root</systemitem> user, enter the commands show below to build the prerequisites from the software distribution that
+ you just downloaded and unpacked. Remember to replace <emphasis>[DISTRIBUTION]</emphasis> in the example with the keyword corresponding to the actual
+ <systemitem class="osname">Linux</systemitem> distribution listed in the <link linkend="serversideinstallation-keywords-opensrf">distribution
+ keywords</link>table.</para>
+ <screen>
+ <userinput>cd /home/opensrf/OpenSRF-1.2.2</userinput>
+ <userinput>make -f src/extras/Makefile.install [DISTRIBUTION]</userinput>
+ </screen>
+ <table xml:id="serversideinstallation-keywords-opensrf">
+ <title>Keywords Targets for <application>"make"</application> Command</title>
+ <tgroup align="left" cols="2" colsep="1" rowsep="1">
+ <colspec colnum="1" colwidth="1.0*"/>
+ <colspec colnum="2" colwidth="3.0*"/>
+ <thead>
+ <row>
+ <entry>Keyword</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>debian-lenny</entry>
+ <entry>for Debian Lenny (5.0)</entry>
+ </row>
+ <row>
+ <entry>debian-etch</entry>
+ <entry>for Debian Etch (4.0)</entry>
+ </row>
+ <row>
+ <entry>ubuntu-karmic</entry>
+ <entry>for Ubuntu Karmic (9.10)</entry>
+ </row>
+ <row>
+ <entry>ubuntu-intrepid</entry>
+ <entry>for Ubuntu Jaunty (9.04) or Intrepid (8.10)</entry>
+ </row>
+ <row>
+ <entry>ubuntu-hardy</entry>
+ <entry>for Ubuntu Hardy (8.04)</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <indexterm>
+ <primary>ZZZ-REVIEW</primary>
+ <secondary>ADD INFO FOR OTHER LINUX DISTRIBUTIONS </secondary>
+ </indexterm>
+ <caution>ADD INFO FOR OTHER LINUX DISTRIBUTIONS </caution>
+ <para>This will install a number of packages on the system that are required by OpenSRF, including some Perl modules from CPAN. You can say <literal>No</literal> to
+ the initial CPAN configuration prompt to allow it to automatically configure itself to download and install Perl modules from CPAN. The CPAN installer will
+ ask you a number of times whether it should install prerequisite modules - say <literal>Yes</literal>.</para>
+ </step>
+ <step>
+ <title>Configure OpenSRF</title>
+ <para>As the <systemitem class="username">opensrf</systemitem> user, return to the OpenSRF build directory and use the <command>configure</command>
+ utility to prepare for the next step of compiling and linking the software. You can include the <option>--enable-python</option> and
+ <option>--enable-java</option> configuration options if you wish to include support for Python and Java, respectively:</para>
+ <screen>
+ <userinput>cd /home/opensrf/OpenSRF-1.2.2</userinput>
+ <userinput>./configure --prefix=/openils --sysconfdir=/openils/conf</userinput>
+ <userinput>make</userinput>
+ </screen>
+ </step>
+ <step>
+ <title>Compile, Link and Install OpenSRF</title>
+ <para>As the <systemitem class="username">root</systemitem> user, return to the OpenSRF build directory and use the <command>make</command> utility to compile,
+ link and install OpenSRF:</para>
+ <screen>
+ <userinput>cd /home/opensrf/OpenSRF-1.2.2</userinput>
+ <userinput>make install</userinput>
+ </screen>
+ </step>
+ <step>
+ <title>Update the System Dynamic Library Path</title>
+ <para>As the <systemitem class="username">root</systemitem> user, you must update the system dynamic library path to make your system recognize the newly
+ installed libraries. Do this by creating the new file <filename>/etc/ld.so.conf.d/osrf.conf</filename> containing a new library path, then run the
+ command <command>ldconfig</command> to automatically read the file and modify the system dynamic library path:</para>
+ <screen>
+ <userinput>echo "/openils/lib" > /etc/ld.so.conf.d/osrf.conf</userinput>
+ <userinput>ldconfig</userinput>
+ </screen>
+ </step>
+ <step>
+ <title>Define Public and Private OpenSRF Domains</title>
+ <para>Define your public and private OpenSRF domains. For security purposes, OpenSRF uses Jabber domains to separate services into public and private realms.
+ Throughout these instructions, we will use the example domains <systemitem class="domainname">public.localhost</systemitem> for the public domain and
+ <systemitem class="domainname">private.localhost</systemitem> for the private domain. On a single-server system, the easiest way to define public and
+ private domains is to define separate host names by adding entries to the file <filename>/etc/hosts</filename>.</para>
+ <para>As the <systemitem class="username">root</systemitem> user, edit the file <filename>/etc/hosts</filename> and add the following entries for
+ our example domains:</para>
+ <screen>
+127.0.1.2 public.localhost public
+127.0.1.3 private.localhost private
+</screen>
+ </step>
+ <step>
+ <title>Change File Ownerships</title>
+ <para>As the <systemitem class="username">root</systemitem> user, change the ownership of files installed in the directory
+ <filename class="directory">/openils</filename> to the <systemitem class="username">opensrf</systemitem> user:</para>
+ <screen>
+ <userinput>chown -R opensrf:opensrf /openils</userinput>
+ </screen>
+ </step>
+ <step>
+ <title>Stop the <systemitem class="service">ejabberd</systemitem> Service</title>
+ <para>As the <systemitem class="username">root</systemitem> user, stop the <systemitem class="service">ejabberd</systemitem> service:</para>
+ <screen>
+$ /etc/init.d/ejabberd stop
+</screen>
+ <para>If <systemitem class="service">ejabberd</systemitem> eeports that it is already stopped, it may have run into a problem starting back at the
+ installation stage. One possible fix is to kill any remaining <systemitem class="daemon">beam</systemitem> and
+ <systemitem class="daemon">epmd</systemitem> processes, then edit the configuration file <filename>/etc/ejabberd/ejabberd.cfg</filename> to hardcode a
+ domain:</para>
+ <screen>
+ <userinput>epmd -kill</userinput>
+ <userinput>killall beam; killall beam.smp</userinput>
+ <userinput>rm /var/lib/ejabberd/*</userinput>
+ <userinput>echo 'ERLANG_NODE=ejabberd@localhost' >> /etc/default/ejabberd</userinput>
+ </screen>
+ </step>
+ <step>
+ <title>Edit the <systemitem class="service">ejabberd</systemitem> configuration</title>
+ <para>As the <systemitem class="username">root</systemitem> user, edit the file <filename>/etc/ejabberd/ejabberd.cfg</filename> and make the following
+ changes:</para>
+ <itemizedlist>
+ <listitem>Change <literal>{hosts, ["localhost"]}.</literal> to <literal>{hosts, ["localhost", "private.localhost", "public.localhost"]}.</literal></listitem>
+ <listitem>Change <literal>{max_user_sessions, 10}.</literal> to <literal>{max_user_sessions, 10000}.</literal> If you see something like this instead:
+ <literal>{access, max_user_sessions, [{10, all}]}.</literal>, then change it to <literal>{access, max_user_sessions, [{10000, all}]}.</literal></listitem>
+ <listitem>Change all three occurrences of <literal>max_stanza_size</literal> to <literal>2000000</literal>.</listitem>
+ <listitem>Change both occurrences of <literal>maxrate</literal> to <literal>500000</literal>.</listitem>
+ <listitem>Comment out the line <literal>{mod_offline, []}</literal> by placing two <literal>%</literal> comment signs in front.</listitem>
+ </itemizedlist>
+ </step>
+ <step xml:id="serversideinstallation-opensrf-continued">
+ <title>Restart the <systemitem class="service">ejabberd</systemitem> service</title>
+ <para>As the <systemitem class="username">root</systemitem> user, restart the <systemitem class="service">ejabberd</systemitem> service to test the configuration
+ changes and to register your users:</para>
+ <screen>
+ <userinput>/etc/init.d/ejabberd start</userinput>
+ </screen>
+ </step>
+ <step>
+ <title>Register <systemitem class="username">router</systemitem> and <systemitem class="username">ejabberd</systemitem> users</title>
+ <para>On each domain, you need two <systemitem class="service">ejabberd</systemitem> users to manage the OpenSRF communications:</para>
+ <itemizedlist>
+ <listitem>a <systemitem class="username">router</systemitem> user, to whom all requests to connect to an OpenSRF service will be routed; this
+ <systemitem class="service">ejabberd</systemitem> user must be named <systemitem class="username">router</systemitem></listitem>
+ <listitem>an <systemitem class="username">opensrf</systemitem> user, which clients use to connect to OpenSRF services; this user can be named anything you
+ like, but we will use <literal>opensrf</literal> in our examples</listitem>
+ </itemizedlist>
+ <para>As the <systemitem class="username">root</systemitem> user, use the <command>ejabberdctl</command> utility to register your ejabber users
+ <emphasis>router</emphasis> and <emphasis>opensrf</emphasis> for the OpenSRF router service on each domain. The users should have different passwords on
+ each domain. The syntax for registering a user with ejabberdctl is <command>ejabberdctl register <user> <domain> <password></command>
+ These users will correspond to those configured in the file <filename>/openils/conf/opensrf_core.xml</filename>:</para>
+ <screen>
+ <userinput>ejabberdctl register router private.localhost <password></userinput>
+ <userinput>ejabberdctl register opensrf private.localhost <password></userinput>
+ <userinput>ejabberdctl register router public.localhost <password></userinput>
+ <userinput>ejabberdctl register opensrf public.localhost <password></userinput>
+ </screen>
+ </step>
+ <step>
+ <title>Create configuration files</title>
+ <para>As the <systemitem class="username">opensrf</systemitem> user, use the example templates to create the configuration files
+ <filename>/openils/conf/opensrf_core.xml</filename> and <filename>/openils/conf/opensrf.xml</filename>:</para>
+ <screen>
+ <userinput>cd /openils/conf</userinput>
+ <userinput>cp opensrf.xml.example opensrf.xml</userinput>
+ <userinput>cp opensrf_core.xml.example opensrf_core.xml</userinput>
+ </screen>
+ </step>
+ <step>
+ <title>Edit opensrf_core.xml</title>
+ <para>Edit the file <filename>/openils/conf/opensrf_core.xml</filename> to change the <systemitem class="service">ejabberd</systemitem> usernames and passwords as
+ follows.</para>
+ <note>
+ <para>
+ <emphasis>The following example uses common XPath syntax on the left-hand side to indicate the approximate position needing changes within the XML
+ file.</emphasis>
+ </para>
+ </note>
+ <para>/config/opensrf/username = <systemitem class="username">opensrf</systemitem></para>
+ <para>/config/opensrf/passwd = password for <systemitem class="domainname">private.localhost</systemitem><systemitem class="username">opensrf</systemitem> user</para>
+ <para>/config/opensrf/passwd = password for <systemitem class="domainname">private.localhost</systemitem><systemitem class="username">opensrf</systemitem> user</para>
+ <para>/config/gateway/username = <systemitem class="username">opensrf</systemitem></para>
+ <para>/config/gateway/passwd = password for <systemitem class="domainname">public.localhost</systemitem><systemitem class="username">opensrf</systemitem> user</para>
+ <para>/config/routers/router/transport (first entry, where
+ <quote>transport/server</quote> ==<systemitem class="domainname">public.localhost</systemitem>)</para>
+ <itemizedlist>
+ <listitem>username = <systemitem class="username">router</systemitem></listitem>
+ <listitem>password = password for <systemitem class="domainname">public.localhost</systemitem><systemitem class="username">router</systemitem>
+ user</listitem>
+ </itemizedlist>
+ <para>/config/routers/router/transport (second entry, where
+ <quote>transport/server</quote> == <systemitem class="domainname">private.localhost</systemitem>) </para>
+ <itemizedlist>
+ <listitem>username = <systemitem class="username">router</systemitem></listitem>
+ <listitem>password = password for <systemitem class="domainname">private.localhost</systemitem><systemitem class="username">router</systemitem>
+ user</listitem>
+ </itemizedlist>
+ <para>You also need to specify the domains from which <systemitem class="service">OpenSRF</systemitem> will accept and to which
+ <systemitem class="service">OpenSRF</systemitem> will make connections. If you are installing <application>OpenSRF</application> on a single server and using the
+ <systemitem class="domainname">private.localhost</systemitem> / <systemitem class="domainname">public.localhost</systemitem> domains, these will already be set to
+ the correct values. Otherwise, search and replace to match your values.</para>
+ </step>
+ <step>
+ <title>Modify the file <filename>opensrf.xml</filename></title>
+ <para>As the <systemitem class="username">opensrf</systemitem> user, edit the file <filename>/openils/conf/opensrf.xml</filename> to set the location of the
+ persistent database in the <literal>dbfile</literal> element near the end of the file:</para>
+ <programlisting language="xml"><![CDATA[
+<!-- Example of an app-specific setting override -->
+<opensrf.persist>
+ <app_settings>
+ <dbfile>/tmp/persist.db</dbfile>
+ </app_settings>
+</opensrf.persist>
+]]></programlisting>
+ </step>
+ <step>
+ <title>Create Configuration Files for Users Needing <command>srfsh</command></title>
+ <para>In this section you will set up a special configuration file for each user who will need to run the <command>srfsh</command>
+ (pronounced <emphasis>surf shell</emphasis>) utility.</para>
+ <para>The software installation will automatically create <command>srfsh</command>. This is a command line diagnostic tool for testing and interacting with
+ <application>OpenSRF</application>. It will be used in a future step to complete and test the Evergreen installation.
+ See <xref linkend="serversideinstallation-testing"/> for further information.</para>
+ <para>As the <systemitem class="username">root</systemitem> user, copy the short sample configuration file <filename>/openils/conf/srfsh.xml.example</filename>
+ to the file <filename>.srfsh.xml</filename> (note the leading dot!) in the home directory of each user who will use <command>srfsh</command>. Finally,
+ edit each file <filename>.srfsh.xml</filename> and make the following changes. When you finish, remember to change the owner of the file to match the owner of the
+ home directory.</para>
+ <itemizedlist>
+ <listitem>Modify <literal>domain</literal> to be the router hostname (following our domain examples,
+ <systemitem class="domainname">private.localhost</systemitem> will give <command>srfsh</command> access to all OpenSRF services,
+ while <systemitem class="domainname">public.localhost</systemitem> will only allow access to those OpenSRF services that are publicly exposed).</listitem>
+ <listitem>Modify <literal>username</literal> and <literal>password</literal> to match the <literal>opensrf</literal> Jabber user for the chosen
+ domain</listitem>
+ <listitem>Modify <literal>logfile</literal> to be the full path for a log file to which the user has write access</listitem>
+ <listitem>Modify <literal>loglevel</literal> as needed for testing</listitem>
+ </itemizedlist>
+ <programlisting language="xml"><![CDATA[
+<?xml version="1.0"?>
+<!-- This file follows the standard bootstrap config file layout -->
+<!-- found in opensrf_core.xml -->
+<srfsh>
+<router_name>router</router_name>
+<domain>private.localhost</domain>
+<username>opensrf</username>
+<passwd>privsrf</passwd>
+<port>5222</port>
+<logfile>/tmp/srfsh.log</logfile>
+<!-- 0 None, 1 Error, 2 Warning, 3 Info, 4 debug, 5 Internal (Nasty) -->
+<loglevel>4</loglevel>
+</srfsh>
+]]></programlisting>
+ </step>
+ <step>
+ <title>Modify Environmental Variable PATH for <systemitem class="username">opensrf</systemitem> User</title>
+ <para>As the <systemitem class="username">opensrf</systemitem> user, modify the environmental variable <envar>PATH</envar> by adding a new file path to
+ the <systemitem class="username">opensrf</systemitem> user's shell configuration file <filename>.bashrc</filename>:</para>
+ <screen>
+ <userinput>echo "export PATH=/openils/bin:\$PATH" >> ~/.bashrc</userinput>
+ </screen>
+ </step>
+ <step>
+ <title>Start OpenSRF</title>
+ <para>As the <systemitem class="username">root</systemitem> user, start the <systemitem class="service">ejabberd</systemitem> and
+ <systemitem class="service">memcached</systemitem> services:</para>
+ <screen>
+ <userinput>/etc/init.d/ejabberd start</userinput>
+ <userinput>/etc/init.d/memcached start</userinput>
+ </screen>
+ <para>Finally, as the <systemitem class="username">opensrf</systemitem> user, start OpenSRF:</para>
+ <screen>
+ <userinput>start the OpenSRF service:</userinput>
+ <userinput>use "-l" to force hostname to be "localhost"</userinput>
+ <userinput>osrf_ctl.sh -l -a start_all</userinput>
+ </screen>
+ <note>
+ <para>If you receive the error message <errortext>bash: osrf_ctl.sh: command not found</errortext>, then your environment variable <envar>PATH</envar> does
+ not include the <filename class="directory">/openils/bin</filename> directory;
+ this should have been set by <filename>.bashrc</filename> when you logged in as the <systemitem class="username">opensrf</systemitem> user, but you
+ can manually set it using the following command:</para>
+ <screen>
+ <userinput>export PATH=$PATH:/openils/bin</userinput>
+ </screen>
+ </note>
+ <para>You can also start Evergreen <emphasis role="bold">without</emphasis> the <option>-l</option> flag, but <command>osrf_ctl.sh</command> must know the
+ fully qualified domain name for the system on which it will execute. That hostname may have been specified in the configuration file
+ <filename>opensrf.xml</filename>,
+ which you configured in a previous step.</para>
+ </step>
+ <step>
+ <title>Test connections to OpenSRF</title>
+ <para>Once you have installed and started OpenSRF, as the <systemitem class="username">root</systemitem> user, test your connection to
+ <systemitem class="service">OpenSRF</systemitem>
+ using the <command>srfsh</command> utility and trying to call the <command>add</command> method on the OpenSRF
+ <systemitem class="service">math</systemitem> service:</para>
+ <screen><userinput>/openils/bin/srfsh</userinput><prompt>srfsh#</prompt> <userinput>request opensrf.math add 2 2</userinput>
+Received Data: 4
+------------------------------------
+Request Completed Successfully
+Request Time in seconds: 0.007519
+------------------------------------
+<prompt>srfsh#</prompt></screen>
+ <para>For other <command>srfsh</command> commands, type <userinput>help</userinput> in at the prompt.</para>
+ </step>
+ <step>
+ <title>Stopping OpenSRF</title>
+ <para>As the <systemitem class="username">opensrf</systemitem> user, stop OpenSRF:</para>
+ <screen>
+ <userinput>osrf_ctl.sh -l -a stop_all</userinput>
+ </screen>
+ </step>
+ </procedure>
+ </section>
+ <section xml:id="serversideinstallation-ubuntudebian">
+ <title>Installing Evergreen 1.6.0.7 On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem></title>
+ <para>This section outlines the installation process for the latest stable version of Evergreen.</para>
+ <para>In this section you will download, unpack, install, configure and test the Evergreen system, including the Evergreen server and the PostgreSQL database system. You
+ will make several configuration changes and adjustments to the software, including updates to configure the system for your own locale, and some updates needed to work
+ around a few known issues.</para>
+ <note>
+ <para>The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) architectures. There may be differences between the Desktop and Server editions
+ of <systemitem class="osname">Ubuntu</systemitem>. These instructions assume the Server edition.</para>
+ <para>In the following instructions, you are asked to perform certain steps as either the <systemitem class="username">root</systemitem> user, the
+ <systemitem class="username">opensrf</systemitem> user, or the <systemitem class="username">postgres</systemitem> user.</para>
+ <itemizedlist>
+ <listitem><systemitem class="osname">Debian</systemitem> -- To become the <systemitem class="username">root</systemitem> user, issue the command
+ <command>su -</command> and enter the password of the <systemitem class="username">root</systemitem> user.</listitem>
+ <listitem><systemitem class="osname">Ubuntu</systemitem> -- To become the <systemitem class="username">root</systemitem> user, issue the command <command>sudo
+ su -</command> and enter the password of the <systemitem class="username">root</systemitem> user.</listitem>
+ </itemizedlist>
+ <para>To switch from the <systemitem class="username">root</systemitem> user to a different user, issue the command <command>su - USERNAME</command>. For example, to
+ switch from the <systemitem class="username">root</systemitem> user to the <systemitem class="username">opensrf</systemitem> user, issue the command
+ <command>su - opensrf</command>. Once you have become a non-root user, to become the <systemitem class="username">root</systemitem> user again, simply issue the
+ command <command>exit</command>.</para>
+ </note>
+ <procedure>
+ <step>
+ <title>Install OpenSRF</title>
+ <para>Evergreen software is integrated with and depends on the Open Service Request Framework (OpenSRF) software system. For further information on installing,
+ configuring and testing OpenSRF, see <xref linkend="serversideinstallation-opensrf"/>.</para>
+ <para>Follow the steps outlined in that section and run the specified tests to ensure that OpenSRF is properly installed and configured. Do not continue with any
+ further Evergreen installation steps until you have verified that OpenSRF has been successfully installed.</para>
+ </step>
+ <step>
+ <title>Download and Unpack Latest Evergreen Version</title>
+ <para>As the <systemitem class="username">opensrf</systemitem> user, download and extract the latest version of Evergreen. The latest version can be found here:
+ <ulink url="http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.0.7.tar.gz"></ulink></para>
+ <screen>
+ <userinput>wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.0.7.tar.gz</userinput>
+ <userinput>tar zxf Evergreen-ILS-1.6.0.7.tar.gz</userinput>
+ </screen>
+ <para>The new directory <filename class="directory">/home/opensrf/Evergreen-ILS-1.6.0.7</filename> will be created.</para>
+ </step>
+ <step>
+ <title>Install Prerequisites to Build Evergreen</title>
+ <para>In this section you will install and configure a set of prerequisites that will be used to build Evergreen. In a following step you will actually build
+ the software using the <command>make</command> utility.</para>
+ <para>As the <systemitem class="username">root</systemitem> user, enter the commands show below to build the prerequisites from the software distribution that you
+ just downloaded and unpacked. Remember to replace <emphasis>[distribution]</emphasis> in the example with the keyword corresponding to the actual
+ <systemitem class="osname">Linux</systemitem> distribution listed in the
+ <link linkend="serversideinstallation-keywords-evergreen">distribution keywords</link> table.</para>
+ <screen>
+ <userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7</userinput>
+ <userinput>make -f Open-ILS/src/extras/Makefile.install [distribution]</userinput>
+ </screen>
+ <table xml:id="serversideinstallation-keywords-evergreen">
+ <tgroup align="left" cols="2" colsep="1" rowsep="1">
+ <colspec colnum="1" colwidth="1.0*"/>
+ <colspec colnum="2" colwidth="3.0*"/>
+ <thead>
+ <row>
+ <entry>Keyword</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>debian-lenny</entry>
+ <entry>for Debian Lenny (5.0), the most recent version</entry>
+ </row>
+ <row>
+ <entry>debian-etch</entry>
+ <entry>for Debian Etch (4.0)</entry>
+ </row>
+ <row>
+ <entry>ubuntu-karmic</entry>
+ <entry>for Ubuntu Lucid (10.04) [same as for Karmic]</entry>
+ </row>
+ <row>
+ <entry>ubuntu-karmic</entry>
+ <entry>for Ubuntu Karmic (9.10)</entry>
+ </row>
+ <row>
+ <entry>ubuntu-intrepid</entry>
+ <entry>for Ubuntu Intrepid (8.10)</entry>
+ </row>
+ <row>
+ <entry>ubuntu-hardy</entry>
+ <entry>for Ubuntu Hardy (8.04)</entry>
+ </row>
+ <row>
+ <entry>ubuntu-gutsy</entry>
+ <entry>for Ubuntu Gutsy (7.10)</entry>
+ </row>
+ <row>
+ <entry>gentoo</entry>
+ <entry>generic for Gentoo versions</entry>
+ </row>
+ <row>
+ <entry>centos</entry>
+ <entry>generic for Centos versions</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <indexterm>
+ <primary>ZZZ-REVIEW</primary>
+ <secondary>ADD INFO FOR OTHER LINUX DISTRIBUTIONS </secondary>
+ </indexterm>
+ <caution>ADD INFO FOR OTHER LINUX DISTRIBUTIONS </caution>
+ </step>
+ <step xml:id="serversideinstallation-postgresql-default">
+ <title>(OPTIONAL) Install the PostgreSQL Server</title>
+ <para>Since the PostgreSQL server is usually a standalone server in multi-server production systems, the prerequisite installer Makefile in the previous step
+ does not automatically install PostgreSQL. If your PostgreSQL server is on a different system, just skip this step.</para>
+ <para>For further information on manually installing PostgreSQL, visit the <link xl:href="http://www.postgresql.org/">PostgreSQL Site</link>.</para>
+ <para>If your PostgreSQL server will be on the same system as your Evergreen software, then as the <systemitem class="username">root</systemitem> user install the
+ required PostgreSQL server packages:</para>
+ <screen>
+ <userinput>su - root</userinput>
+ </screen>
+ <para>For <systemitem class="osname">Debian Lenny</systemitem> and <systemitem class="osname">Ubuntu Hardy (8.04)</systemitem>:</para>
+ <screen>
+ <userinput>make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_83</userinput>
+ </screen>
+ <para>For <systemitem class="osname">Ubuntu Karmic (9.10)</systemitem> and <systemitem class="osname">Ubuntu Lucid (10.04)</systemitem>:</para>
+ <screen>
+ <userinput>make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_84</userinput>
+ </screen>
+ <note>
+ <para>Postgresql 8.3 or 8.4 are the recommended versions to work with Evergreen 1.6. If you have an older version of PostgreSQL, you should upgrade before
+ installing Evergreen. To find the running version of PostgreSQL, switch to the <systemitem class="username">postgres</systemitem> user and run the
+ <command>psql</command>. Then type <userinput>SELECT version();</userinput> to get detailed information of your version of PostgreSQL.</para>
+ </note>
+ </step>
+ <step performance="optional">
+ <title>Install Perl Modules on PostgreSQL Server</title>
+ <para>If PostgreSQL is running on the same system as your Evergreen software, then the Perl modules will automatically be available. Just skip this step.</para>
+ <para>Otherwise, if your PostgreSQL server is running on another system, then as the <systemitem class="username">root</systemitem> user install the following Perl
+ modules on that system:</para>
+ <para>ensure the gcc compiler is installed:</para>
+ <screen>
+ <userinput>apt-get install gcc</userinput>
+ </screen>
+ <para>install the Perl modules</para>
+ <screen><userinput>perl -MCPAN -e shell</userinput><prompt>cpan></prompt> <userinput>install JSON::XS</userinput><prompt>cpan></prompt> <userinput>install MARC::Record</userinput><prompt>cpan></prompt> <userinput>install MARC::File::XML</userinput></screen>
+ <para>For more information on installing Perl Modules vist the <link xl:href="http://www.cpan.org/">CPAN</link> site.</para>
+ </step>
+ <step>
+ <title>Update the System Dynamic Library Path</title>
+ <para>As the <systemitem class="username">root</systemitem> user, you must update the system dynamic library path to make your system recognize the newly
+ installed libraries. Do this by creating the new file <filename>/etc/ld.so.conf.d/eg.conf</filename> containing two new library path.</para>
+ <para>Create a file named /etc/ld.so.conf.d/eg.conf containing the following lines:</para>
+ <programlisting>
+/usr/local/lib
+/usr/local/lib/dbd
+</programlisting>
+ <para>Then run the command <command>ldconfig</command> to automatically read the file and modify the system dynamic library path:</para>
+ <screen>
+ <userinput>ldconfig</userinput>
+ </screen>
+ </step>
+ <step preformance="optional">
+ <title>Restart the PostgreSQL Server</title>
+ <para>If PostgreSQL is running on the same system as the rest of Evergreen, as the <systemitem class="username">root</systemitem> user you must restart
+ PostgreSQL. If PostgreSQL is running on another system, you may skip this step.</para>
+ <screen>
+ <userinput>/etc/init.d/postgresql-[PGSQL_VERSION] restart</userinput>
+ </screen>
+ <para>Where <literal>PGSQL_VERSION</literal> is your installed PostgreSQL version (e.g. <literal>8.3</literal>).</para>
+ </step>
+ <step xml:id="serversideinstallation-configure">
+ <title>Configure Evergreen</title>
+ <para>As the <systemitem class="username">opensrf</systemitem> user, return to the Evergreen build directory and use the <command>configure</command> utility to
+ prepare for the next step of compiling and linking the software:</para>
+ <screen>
+ <userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7</userinput>
+ <userinput>./configure --prefix=/openils --sysconfdir=/openils/conf</userinput>
+ <userinput>make</userinput>
+ </screen>
+ </step>
+ <step xml:id="serversideinstallation-compilingevergreen">
+ <title>Compile, Link and Install Evergreen</title>
+ <para>In this step you will actually compile, link and install Evergreen and the default Evergreen Staff Client.</para>
+ <para>As the <systemitem class="username">root</systemitem> user, return to the Evergreen build directory and use the <command>make</command> utility as
+ shown below. The Staff Client will also be automatically built, but you must remember to set the variable <envar>STAFF_CLIENT_BUILD_ID</envar> to match the version of the Staff Client you will use to connect to the Evergreen server.</para>
+ <para>For further information on manually building the Staff Client, see <xref linkend="serversideinstallation-building-staffclient"/>.</para>
+ <screen>
+ <userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7</userinput>
+ <userinput>make STAFF_CLIENT_BUILD_ID=rel_1_6_0_7 install</userinput>
+ </screen>
+ <para>The above commands will create a new subdirectory <filename class="directory">/openils/var/web/xul/rel_1_6_0_7</filename> containing the Staff Client.</para>
+ <para>To complete the Staff Client installation, as the <systemitem class="username">root</systemitem> user create a symbolic link named <emphasis>server</emphasis>
+ in the head of the Staff Client directory <filename class="directory">/openils/var/web/xul</filename> that points to the subdirectory
+ <filename class="directory">/server</filename> of the new Staff Client build:</para>
+ <screen>
+ <userinput>cd /openils/var/web/xul</userinput>
+ <userinput>ln -sf rel_1_6_0_7/server server</userinput>
+ </screen>
+ </step>
+ <step>
+ <title>Copy the OpenSRF Configuration Files</title>
+ <para>As the <systemitem class="username">root</systemitem> user, copy the example OpenSRF configuration files into place. This replaces the configuration
+ files that you set up in a previous step when you installed and tested OpenSRF. You should also create backup copies of the old files for troubleshooting
+ purposes. Finally, change the ownership on the installed files to the <systemitem class="username">opensrf</systemitem> user:</para>
+ <screen>
+ <userinput>cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml</userinput>
+ <userinput>cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml</userinput>
+ <userinput>cp /openils/conf/oils_web.xml.example /openils/conf/oils_web.xml</userinput>
+ <userinput>chown -R opensrf:opensrf /openils/</userinput>
+ </screen>
+ </step>
+ <step>
+ <title>Create and Configure PostgreSQL Database</title>
+ <para>As the <systemitem class="username">postgres</systemitem> user on your PostgreSQL server, create the Evergreen database.</para>
+ <para>In the commands below, remember to adjust the path of the <emphasis role="bold">contrib</emphasis> repository to match your PostgreSQL server layout. For
+ example, if you built PostgreSQL from source the path would be <filename class="directory">/usr/local/share/contrib</filename>; if you installed the PostgreSQL 8.3
+ server packages on <systemitem class="osname">Ubuntu 8.04</systemitem>, the path would be
+ <filename class="directory">/usr/share/postgresql/8.3/contrib/</filename>.</para>
+ <substeps>
+ <step>
+ <para>
+ <emphasis role="bold">Create and configure the database</emphasis>
+ </para>
+ <para>As the <systemitem class="username">postgres</systemitem> user on the PostgreSQL system create the PostgreSQL database, then set some internal
+ paths:</para>
+ <para>Create the database:</para>
+ <screen>
+ <userinput>createdb -E UNICODE evergreen</userinput>
+ <userinput>createlang plperl evergreen</userinput>
+ <userinput>createlang plperlu evergreen</userinput>
+ <userinput>createlang plpgsql evergreen</userinput>
+ </screen>
+ <para>Adjust the paths:</para>
+ <screen>
+ <userinput>psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tablefunc.sql evergreen</userinput>
+ <userinput>psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tsearch2.sql evergreen</userinput>
+ <userinput>psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/pgxml.sql evergreen</userinput>
+ </screen>
+ <para>Where <literal>PGSQL_VERSION</literal> is your installed PostgreSQL version (e.g. <literal>8.3</literal>).</para>
+ </step>
+ <step>
+ <title>Create a new Evergreen superuser</title>
+ <para>As the <systemitem class="username">postgres</systemitem> user on the PostgreSQL system, create the new database
+ <systemitem class="username">evergreen</systemitem> user and assign a password:</para>
+ <screen>
+ <userinput>createuser -P -s evergreen</userinput>
+ </screen>
+ <para>Enter the password twice for new role when prompted.</para>
+ </step>
+ <step>
+ <title>Create Database Schema</title>
+ <para>As the <systemitem class="username">root</systemitem> user, create the database schema and configure your system with the corresponding
+ database authentication details for the <emphasis>evergreen</emphasis> database user that you created in the previous step.</para>
+ <para>Enter the following commands and replace <emphasis>HOSTNAME, PORT, PASSWORD</emphasis> and <emphasis>DATABASENAME</emphasis> with appropriate
+ values.</para>
+ <screen>
+ <userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7</userinput>
+ <userinput>perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \
+ --service all --create-schema --create-bootstrap --create-offline \
+ --hostname HOSTNAME --port PORT \
+ --user evergreen --password PASSWORD --database DATABASENAME</userinput>
+ </screen>
+ <para>On most systems, <emphasis>HOSTNAME</emphasis> will be <emphasis role="bold">localhost</emphasis>, <emphasis>PORT</emphasis> will be
+ <emphasis role="bold">5432</emphasis>, and <emphasis>PASSWORD</emphasis> and <emphasis>DATABASENAME</emphasis> will be
+ <emphasis role="bold">evergreen</emphasis>.</para>
+ <note>
+ <para>If you are entering the above command on a single line, do not include the <literal>\</literal> (backslash) characters.
+ If you are using the <command>bash</command> shell, these should only be used at the end of a line at a bash prompt to indicate
+ that the command is continued on the next line.</para>
+ </note>
+ </step>
+ <step>
+ <title>Modify the Apache configuration files for the Evergreen site.</title>
+ <substeps>
+ <step>
+ <para>Enable some built-in Apache modules with the utility <command>a2enmod</command>, and install some additional Apache
+ configuration files. As the <systemitem class="username">root</systemitem> user, enable some modules in the Apache server, then copy
+ the new configuration files to the Apache server directories:</para>
+ <para>Enable the required Apache Modules:</para>
+ <screen>
+ <userinput>a2enmod ssl # enable mod_ssl</userinput>
+ <userinput>a2enmod rewrite # enable mod_rewrite</userinput>
+ <userinput>a2enmod expires # enable mod_expires</userinput>
+ <userinput>cd /home/opensrf/Evergreen-ILS-1.x.x.x</userinput>
+ </screen>
+ </step>
+ <step>
+ <para>Copy the Apache configuration files from the Evergreen installation dierectory:</para>
+ <screen>
+ <userinput>cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/</userinput>
+ <userinput>cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/</userinput>
+ <userinput>cp Open-ILS/examples/apache/startup.pl /etc/apache2/</userinput>
+ </screen>
+ </step>
+ <step xml:id="serversideinstallation-createsslkey">
+ <para>Create a new Security Certificate (SSL Key) for the Apache server with the command <command>openssl</command>. For a
+ public production server you should configure or purchase a signed SSL certificate, but for now you can just use a
+ self-signed certificate and accept the warnings in the Staff Client and browser during testing and development:</para>
+ <screen>
+ <userinput>mkdir /etc/apache2/ssl</userinput>
+ <userinput>cd /etc/apache2/ssl</userinput>
+ <userinput>openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key</userinput>
+ </screen>
+ <note>
+ <para>This generates a self-signed SSL certificate. You should acquire a proper SSL certificate for a public
+ production system to avoid warning messages when users login to their account through the OPAC or when staff
+ login through the staff client.</para>
+ <para>For further information on getting a proper SSL certificate, see <xref linkend="serversideinstallation-ssl"/>.</para>
+ </note>
+ </step>
+ <step>
+ <para>Several changes are needed in the new Apache configuration file <filename>/etc/apache2/sites-available/eg.conf</filename>.
+ As the <systemitem class="username">root</systemitem> user, edit the file and make the following changes:</para>
+ <substeps>
+ <step>
+ <para>Comment out the line <literal>Listen 443</literal>, since it conflicts with the same declaration in the configuration
+ file: <filename>/etc/apache2/ports.conf</filename>. <systemitem class="osname">Debian Etch</systemitem> users should not
+ do this since the conflict does not apply to that OS.</para>
+ </step>
+ <step>
+ <para>For the <systemitem class="osname">Linux</systemitem> distributions
+ <systemitem class="osname">Ubuntu Hardy</systemitem>
+ or <systemitem class="osname">Debian Etch</systemitem>, as the <systemitem class="username">root</systemitem> user, edit the
+ Apache configuration file <filename>/etc/apache2/apache2.conf</filename> and change <literal>User www-data</literal> to
+ <literal>User opensrf</literal>.</para>
+ <para>For the <systemitem class="osname">Linux</systemitem> distributions <systemitem class="osname">Ubuntu
+ Karmic</systemitem> or <systemitem class="osname">Ubuntu Lucid</systemitem> or
+ <systemitem class="osname">Debian Lenny</systemitem>, as the <systemitem class="username">root</systemitem> user,
+ edit the Apache configuration file <filename>/etc/apache2/envvars</filename> and
+ change the line <literal>export APACHE_RUN_USER=www-data</literal> to <literal>export APACHE_RUN_USER=opensrf</literal>.
+ </para>
+ <para>The following updates are needed to allow the logs to function properly, but it may break other Apache applications
+ on your server.</para>
+ </step>
+ </substeps>
+ </step>
+ <step>
+ <para>As the <systemitem class="username">root</systemitem> user, edit the Apache configuration file
+ <filename>/etc/apache2/apache2.conf</filename> and add the lines <literal>KeepAliveTimeout 1</literal> and
+ <literal>MaxKeepAliveRequests 100</literal>, or modify any existing lines.</para>
+ </step>
+ </substeps>
+ </step>
+ <step performance="optional">
+ <title>Performance Modifications for Apache</title>
+ <para>Some further configuration changes to Apache may be necessary for busy systems. These changes increase the number of Apache server processes that are
+ started to support additional browser connections.</para>
+ <para>As the <systemitem class="username">root</systemitem> user, edit the Apache configuration file <filename>/etc/apache2/apache2.conf</filename>,
+ locate and modify the section related to <emphasis>prefork configuration</emphasis> to suit the load on your system.</para>
+ <programlisting language="xml"><![CDATA[
+<IfModule mpm_prefork_module>
+ StartServers 20
+ MinSpareServers 5
+ MaxSpareServers 15
+ MaxClients 150
+ MaxRequestsPerChild 10000
+</IfModule>
+]]></programlisting>
+ </step>
+ <step>
+ <para>Finally, as the <systemitem class="username">root</systemitem> user, execute the following Apache configuration commands to disable the default
+ <emphasis>It Works</emphasis> web page and to enable the Evergreen web site:</para>
+ <screen>
+ <userinput>a2dissite default</userinput>
+ <userinput>a2ensite eg.conf</userinput>
+ </screen>
+ </step>
+ </substeps>
+ </step>
+ <step xml:id="serversideinstallation-opensrf-config">
+ <title>Modify the OpenSRF Configuration File</title>
+ <para>As the <systemitem class="username">opensrf</systemitem> user, edit the OpenSRF configuration file <filename>/openils/conf/opensrf_core.xml</filename> to
+ update the Jabber usernames and passwords, and to specify the domain from which we will accept and to which we will make connections.</para>
+ <para>If you are installing Evergreen on a single server and using the <systemitem class="domainname">private.localhost</systemitem> /
+ <systemitem class="domainname">public.localhost</systemitem> domains, these will already be set to the correct values. Otherwise, search and replace to match
+ your customized values.</para>
+ <para>The following example uses common XPath syntax on the left-hand side to indicate the approximate position needing changes within the XML file:</para>
+ <para>/config/opensrf/username = <systemitem class="username">opensrf</systemitem></para>
+ <para>/config/opensrf/passwd = password for <systemitem class="domainname">private.localhost</systemitem><systemitem class="username">opensrf</systemitem> user</para>
+ <para>/config/gateway/username = <systemitem class="username">opensrf</systemitem></para>
+ <para>/config/gateway/passwd = password for <systemitem class="domainname">public.localhost</systemitem><systemitem class="username">opensrf</systemitem> user</para>
+ <para>/config/routers/router/transport (first entry, where <quote>transport/server</quote> == <systemitem class="domainname">public.localhost</systemitem>)</para>
+ <itemizedlist>
+ <listitem>username = <systemitem class="username">router</systemitem></listitem>
+ <listitem>password = password for <systemitem class="domainname">public.localhost</systemitem> <systemitem class="username">router</systemitem>
+ user</listitem>
+ </itemizedlist>
+ <para>/config/routers/router/transport (second entry, where <quote>transport/server</quote> == <systemitem class="domainname">private.localhost</systemitem>) </para>
+ <itemizedlist>
+ <listitem>username = <systemitem class="username">router</systemitem></listitem>
+ <listitem>password = password for <systemitem class="domainname">private.localhost</systemitem> <systemitem class="username">router</systemitem>
+ user</listitem>
+ </itemizedlist>
+ </step>
+ <step xml:id="serversideinstallation-srfsh">
+ <title>Create Configuration Files for Users Needing <command>srfsh</command></title>
+ <para>The software installation will automatically create a utility named <command>srfsh</command> (surf shell). This is a command line diagnostic tool for
+ testing and interacting with the OpenSRF network software. It will be used in a future step to complete and test the Evergreen installation.
+ See <xref linkend="serversideinstallation-testing"/> for further information.</para>
+ <para>In this section you will set up a special configuration file for each user who will need to run the utility. Copy the short sample configuration
+ file <filename>/openils/conf/srfsh.xml.example</filename> to the file <filename>.srfsh.xml</filename> (note the leading dot!) in the home directory of
+ each user who will use <command>srfsh</command>. Finally, edit each users' <filename>.srfsh.xml</filename> file and make the following changes:</para>
+ <substeps>
+ <step>
+ <para>Modify <emphasis role="bold">domain</emphasis> to be the router hostname (following our domain examples,
+ <systemitem class="domainname">private.localhost</systemitem>> will give <command>srfsh</command> access to all OpenSRF services,
+ while <systemitem class="domainname">public.localhost</systemitem> will only allow access to those OpenSRF services that are publicly exposed).</para>
+ </step>
+ <step>
+ <para>Modify <emphasis role="bold">username</emphasis> and <emphasis role="bold">password</emphasis> to match the
+ <systemitem class="username">opensrf</systemitem> Jabber user for the chosen domain.</para>
+ </step>
+ <step>
+ <para>Modify <emphasis role="bold">logfile</emphasis> to be the full path for a log file to which the user has write access.</para>
+ </step>
+ <step>
+ <para>Modify <emphasis role="bold">loglevel</emphasis> as needed for testing.</para>
+ </step>
+ </substeps>
+ <programlisting language="xml"><![CDATA[
+<?xml version="1.0"?>
+<!-- This file follows the standard bootstrap config file layout -->
+<!-- found in opensrf_core.xml -->
+<srfsh>
+<router_name>router</router_name>
+<domain>private.localhost</domain>
+<username>opensrf</username>
+<passwd>evergreen</passwd>
+<port>5222</port>
+<logfile>/tmp/srfsh.log</logfile>
+<!-- 0 None, 1 Error, 2 Warning, 3 Info, 4 debug, 5 Internal (Nasty) -->
+<loglevel>4</loglevel>
+</srfsh>
+]]></programlisting>
+ </step>
+ <step xml:id="serversideinstallation-opensrf-env">
+ <title>Modify the OpenSRF Environment</title>
+ <para>Modify the shell configuration file <filename>~/.bashrc</filename> for <systemitem class="username">opensrf</systemitem> by adding a Perl environmental
+ variable and execute the shell configuration file to load the new variables into your current environment.</para>
+ <note>
+ <para>
+ <emphasis>In a multi-server environment, you must add any modifications to <filename>~/.bashrc</filename> to the top of the file
+ <emphasis>before</emphasis> the line <literal>[ -z "$PS1" ] && return </literal>. This will allow headless (scripted) logins to
+ load the correct environment.</emphasis>
+ </para>
+ </note>
+ <screen>
+ <userinput>echo "export PERL5LIB=/openils/lib/perl5:\$PERL5LIB" >> ~/.bashrc</userinput>
+ <userinput>. ~/.bashrc</userinput>
+ </screen>
+ </step>
+ <step xml:id="serversideinstallation-starting">
+ <title>Start Evergreen</title>
+ <substeps>
+ <step>
+ <para>As the <systemitem class="username">root</systemitem> user, start the <systemitem class="service">ejabberd</systemitem> and
+ <systemitem class="service">memcached</systemitem> services (if they are not already running):</para>
+ <screen>
+ <userinput>/etc/init.d/ejabberd start</userinput>
+ <userinput>/etc/init.d/memcached start</userinput>
+ </screen>
+ </step>
+ <step>
+ <para>As the <systemitem class="username">opensrf</systemitem> user, start Evergreen.</para>
+ <para>Use the flag <option>-l</option> to force Evergreen to use <systemitem class="domainname">localhost</systemitem>
+ (your current system) as the hostname.
+ Using the <option>start_all</option> option will start the OpenSRF <systemitem class="service">router</systemitem> ,
+ <systemitem class="service">Perl</systemitem> , and <systemitem class="service">C</systemitem> services:</para>
+ <screen>$ osrf_ctl.sh -l -a start_all</screen>
+ <note>
+ <para>
+ <emphasis>You can also start Evergreen <emphasis role="bold">without</emphasis> the <option>-l</option> flag, but the
+ <command>osrf_ctl.sh</command> utility must know the fully qualified domain name for the system on which it will execute.
+ That hostname may have been specified in the configuration file <filename>opensrf.xml</filename>, which you configured in a
+ previous step.</emphasis>
+ </para>
+ <para>Use the <command>hostname</command> command to determine the fully qualified domain name of your system.</para>
+ </note>
+ <itemizedlist>
+ <listitem>
+ <para>If you receive an error message similar to <emphasis>osrf_ctl.sh: command not found</emphasis>, then your environment
+ variable <envar>PATH</envar> does not include the directory <filename class="directory">/openils/bin</filename>.
+ As the <systemitem class="username">opensrf</systemitem> user, edit the configuration file <filename>/home/opensrf/.bashrc</filename>
+ and add the following line: <literal>export PATH=$PATH:/openils/bin</literal></para>
+ </listitem>
+ <listitem>
+ <para>If you receive an error message similar to <errortext>Can't locate OpenSRF/System.pm in @INC ...
+ BEGIN failed--compilation aborted</errortext>, then your environment variable <emphasis role="bold">PERL5LIB</emphasis> does not
+ include the directory <filename class="directory">/openils/lib/perl5</filename>. As the
+ <systemitem class="username">opensrf</systemitem> user, edit the configuration file <filename>/home/opensrf/.bashrc</filename>
+ and add the following line: <literal>export PERL5LIB=$PERL5LIB:/openils/lib/perl5</literal></para>
+ </listitem>
+ </itemizedlist>
+ </step>
+ <step>
+ <para>As the <systemitem class="username">opensrf</systemitem> user, generate the Web files needed by the Staff Client and catalog,
+ and calculate the proximity of locations in the Organizational Unit tree (which allows <emphasis>Holds</emphasis> to work properly).</para>
+ <para>You must do this the first time you start Evergreen, and after making any changes to the library hierarchy.</para>
+ <screen><userinput>cd /openils/bin</userinput><userinput>./autogen.sh -c /openils/conf/opensrf_core.xml -u</userinput>
+Updating Evergreen organization tree and IDL using '/openils/conf/opensrf_core.xml'
+Updating fieldmapper
+</screen>
+ </step>
+ <step>
+ <para>As the <systemitem class="username">root</systemitem> user, restart the Apache Web server:</para>
+ <screen>/etc/init.d/apache2 restart</screen>
+ <note>
+ <para>If the Apache Web server was running when you started the OpenSRF services, you might not be able to successfully log in to the OPAC or Staff
+ Client until the Apache Web server is restarted.</para>
+ </note>
+ </step>
+ </substeps>
+ </step>
+ </procedure>
+ </section>
+ <section xml:id="serversideinstallation-testing">
+ <title>Testing the Installation</title>
+ <para>This section describes several simple tests you can perform to verify that the Evergreen server-side software has been installed and configured properly
+ and is running as expected.</para>
+ <simplesect xml:id="serversideinstallation-testing-connections">
+ <title>Testing Connections to Evergreen</title>
+ <para>Once you have installed and started Evergreen, test your connection to Evergreen. As the <systemitem class="username">opensrf</systemitem> user start
+ the <command>srfsh</command> application and try logging onto the Evergreen server using the default administrator username and password. Following
+ is sample output generated by executing that script after a successful Evergreen installation:</para>
+ <screen><userinput>/openils/bin/srfsh</userinput><prompt>srfsh%</prompt> <userinput>login admin open-ils</userinput>
+Received Data: "250bf1518c7527a03249858687714376"
+------------------------------------
+Request Completed Successfully
+Request Time in seconds: 0.045286
+------------------------------------
+Received Data: {
+ "ilsevent":0,
+ "textcode":"SUCCESS",
+ "desc":" ",
+ "pid":21616,
+ "stacktrace":"oils_auth.c:304",
+ "payload":{
+ "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
+ "authtime":420
+ }
+}
+------------------------------------
+Request Completed Successfully
+Request Time in seconds: 1.336568
+------------------------------------
+</screen>
+ <para>The first argument is how many sets of 4 queries (+ - * /) are sent to <systemitem class="service">opensrf.math</systemitem>. When the response is
+ successful, you will see the string of <literal>+</literal> symbols. If the system is not running correctly, you will either get an exception or no result at
+ all.</para>
+ <para>For other <command>srfsh</command> commands, type <userinput>help</userinput> in at the prompt.</para>
+ <para/>
+ <para>If this test fails or you have any other problems during installation, refer to the <xref linkend="troubleshooting"/> chapter.</para>
+ </simplesect>
+ </section>
+ <section xml:id="serversideinstallation-virtual">
+ <title>Installing In Virtualized <systemitem class="osname">Linux</systemitem> Environments</title>
+ <para>This section describes the installation of Evergreen software in so-called "virtualized" software environments. Evergreen software runs as a native application on any of several well-known x86 (32-bit) and x86-64 (64-bit) <systemitem class="osname">Linux</systemitem> distributions including <systemitem class="osname">Ubuntu</systemitem> and <systemitem class="osname">Debian</systemitem> but it does not run as a native application on the <systemitem class="osname">Microsoft Windows</systemitem> operating system. However, it is possible to execute Evergreen on a <systemitem class="osname">Windows</systemitem> host system by running it within a virtual Linux-guest installation, which itself executes on the <systemitem class="osname">Windows</systemitem> system. The <systemitem class="osname">Linux</systemitem> environment is fully emulated and acts (within limits) just as if it were executing on a real standalone system.</para>
+ <para>This technique of emulating a <systemitem class="osname">Linux</systemitem> environment on a <systemitem class="osname">Windows</systemitem> host is a practical way to install and run an Evergreen system if it is not possible to dedicate a physical machine solely as a <systemitem class="osname">Linux</systemitem> host for Evergreen. This architecture is not recommended for large scale systems since there are performance limitations to running Evergreen in a virtualized environment. However, it is a reasonable architecture for smaller experimental systems, as a proof of concept, or as a conference-room pilot.</para>
+ <simplesect>
+ <title>Installing Virtualization Software</title>
+ <para>As described above, Evergreen can be installed on top of an emulated <systemitem class="osname">Linux</systemitem> environment. The <systemitem class="osname">Linux</systemitem> environment, in turn, is installed on top of a software application such as <application>"VirtualBox"</application>, <application>"VMware"</application> or <application>"VirtualPC"</application> which must first be installed on the <systemitem class="osname">Windows</systemitem> system. This section contains step-by-step examples that show installing popular virtualization applications on a <systemitem class="osname">Windows</systemitem> host system. Following this section are further descriptions of installing <systemitem class="osname">Linux</systemitem> and Evergreen systems using that virtualization software.</para>
+ <section xml:id="serversideinstallation-virtual-vbox-install">
+ <title>Installing <application>"VirtualBox"</application> Virtualization Software</title>
+ <para>This section reviews installation of the <application>"VirtualBox"</application> application on <systemitem class="osname">WindowsXP Professional (SP2)</systemitem>. Download <application>VirtualBox</application> from their official website: <ulink url="http://download.virtualbox.org/virtualbox/3.2.8/VirtualBox-3.2.8-64453-Win.exe">http://download.virtualbox.org/virtualbox/3.2.8/VirtualBox-3.2.8-64453-Win.exe</ulink>, then run the executable file. Continue with the steps shown in the next five figures until the software has been successfully installed:</para>
+ <figure>
+ <title>Starting the Windows installation file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vbox-install-1.png" scalefit="1" width="70%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure>
+ <title>Welcome to <application>VirtualBox</application> setup wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vbox-install-2.png" scalefit="1" width="70%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure>
+ <title>Accept the license agreement</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vbox-install-3.png" scalefit="1" width="70%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure>
+ <title>Waiting for files to be copied</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vbox-install-4.png" scalefit="1" width="70%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure>
+ <title>Installation is complete</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vbox-install-5.png" scalefit="1" width="70%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section>
+ <title>Installing <application>"VMware"</application> Virtualization Software</title>
+ <para>This section reviews installation of the <application>"VMware"</application> application on <systemitem class="osname">WindowsXP Professional (SP2)</systemitem>. Download <application>VMware</application> from their official website: <ulink url="">link</ulink>, then run the executable file. Continue with the steps shown in the figures until the software has been successfully installed:</para>
+ <figure>
+ <title>Starting the Windows installation file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vbox-install-1.png" scalefit="1" width="75%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <indexterm>
+ <primary>ZZZ-REVIEW</primary>
+ <secondary>ADD INFO ON VMWARE</secondary>
+ </indexterm>
+ <caution>ADD INFO ON VMWARE</caution>
+ <para>At this point, <application>VirtualBox</application> has been installed, started for the first time, and a new virtual machine (VM) has been created. This VM is the environment in which the <systemitem class="osname">Linux</systemitem> / Evergreen installation will execute. Please continue in <xref linkend="serversideinstallation-virtual-install-linux-ev"/> with the installation of the <systemitem class="osname">Linux</systemitem> / Evergreen distribution.</para>
+ </section>
+ <section>
+ <title>Installing <application>"VirtualPC"</application> Virtualization Software</title>
+ <para>This section reviews installation of the <application>"VirtualPC"</application> application on <systemitem class="osname">WindowsXP Professional (SP2)</systemitem>. Download <application>VMware</application> from their official website: <ulink url="">link</ulink>, then run the executable file. Continue with the steps shown in the figures until the software has been successfully installed:</para>
+ <figure>
+ <title>Starting the Windows installation file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vbox-install-1.png" scalefit="1" width="75%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <indexterm>
+ <primary>ZZZ-REVIEW</primary>
+ <secondary>ADD INFO ON VIRTUALPC</secondary>
+ </indexterm>
+ <caution>ADD INFO ON VIRTUALPC</caution>
+ <para>At this point, <application>VirtualBox</application> has been installed, started for the first time, and a new virtual machine (VM) has been created. This VM is the environment in which the <systemitem class="osname">Linux</systemitem> / Evergreen installation will execute. Please continue in <xref linkend="serversideinstallation-virtual-install-linux-ev"/> with the installation of the <systemitem class="osname">Linux</systemitem> / Evergreen distribution.</para>
+ </section>
+ </simplesect>
+ <simplesect xml:id="serversideinstallation-virtual-install-linux-ev">
+ <title>Installing <systemitem class="osname">Linux</systemitem> / Evergreen on Virtualization Software</title>
+ <para>After the virtualization software is installed and running, there are two ways to continue with installing <systemitem class="osname">Linux</systemitem> and Evergreen software in the new virtualized environment:</para>
+ <orderedlist>
+ <listitem>
+ <para>Download and install a prebuilt software image that contains a working <systemitem class="osname">Linux</systemitem> / Evergreen system (see <xref linkend="serversideinstall-virtual-prebuilt"/> for details)</para>
+ </listitem>
+ <listitem>
+ <para>Manually install a <systemitem class="osname">Linux</systemitem> guest system, then manually install Evergreen on it (see <xref linkend="serversideinstall-virtual-manual"/> for details)</para>
+ </listitem>
+ </orderedlist>
+ <para>We review each method in the following sections.</para>
+ <section xml:id="serversideinstall-virtual-prebuilt">
+ <title>Download and install a prebuilt software image</title>
+ <para>You can download a prebuilt software image that, when installed with your virtualization software, emulates a <systemitem class="osname">Linux</systemitem> guest system containing a running Evergreen distribution. The image is essentially a snapshot of a hard disk from a fully configured, functional <systemitem class="osname">Linux</systemitem> system with Evergreen already installed.</para>
+ <para>We recommend this approach if you wish to get Evergreen running quickly with minimal attention to configuration. After reviewing only a few configuration details you can have a working Evergreen system that integrates smoothly with the rest of your network. See <xref linkend="serversideinstall-virtual-versions"/> for a list of prebuilt software images that are currently available to download and install</para>
+ <note>DISCLAIMER: The following virtual images have been contributed by members of the Evergreen community for the purposes of testing, evaluation, training, and development.</note>
+ <table xml:id="serversideinstall-virtual-versions">
+ <title>Linux / Evergreen Virtual Images</title>
+ <tgroup align="left" cols="4" colsep="1" rowsep="1">
+ <thead>
+ <row>
+ <entry>Linux Version</entry>
+ <entry>Evergreen Version</entry>
+ <entry>Image</entry>
+ <entry>Comments</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Debian lenny (5.0)</entry>
+ <entry>1.6.0.1</entry>
+ <entry>
+ <ulink url="http://www.open-ils.org/~denials/Evergreen1601_DebianLenny.zip"> download </ulink>
+ </entry>
+ <entry>VirtualBox image</entry>
+ </row>
+ <row>
+ <entry>Ubuntu karmic koala (9.10)</entry>
+ <entry>1.6.0.0</entry>
+ <entry>
+ <ulink url="http://www.open-ils.org/~denials/Evergreen-1600-Karmic.zip"> download </ulink>
+ </entry>
+ <entry>VirtualBox image</entry>
+ </row>
+ <row>
+ <entry>Ubuntu hardy heron (8.04)</entry>
+ <entry>1.2.3.1</entry>
+ <entry>
+ <ulink url="http://open-ils.org/dokuwiki/doku.php?id=server:1.2:ubuntu804:readme"> download </ulink>
+ </entry>
+ <entry>VirtualBox image; no preloaded data</entry>
+ </row>
+ <row>
+ <entry>Debian etch (4.0)</entry>
+ <entry>1.2.2.3</entry>
+ <entry>
+ <ulink url="http://open-ils.org/dokuwiki/doku.php?id=vmware:debian"> download </ulink>
+ </entry>
+ <entry>VMware image; preloaded with 13,000 Gutenberg records</entry>
+ </row>
+ <row>
+ <entry>Ubuntu gutsy gibbon (7.10)</entry>
+ <entry>1.2.1.4</entry>
+ <entry>
+ <ulink url="http://www.open-ils.org/downloads/vmware/Evergreen_1.2.1.4_on_Ubuntu_7.10.zip"> download </ulink>
+ </entry>
+ <entry>VMware image</entry>
+ </row>
+ <row>
+ <entry>Gentoo</entry>
+ <entry>1.1.5</entry>
+ <entry>
+ <ulink url="http://www.open-ils.org/~denials/Evergreen_1.1.5_Gentoo_x86.zip"> download </ulink>
+ </entry>
+ <entry>VMware image</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <indexterm>
+ <primary>ZZZ-REVIEW</primary>
+ <secondary>EXPAND LIST OF OTHER PREBUILT IMAGES</secondary>
+ </indexterm>
+ <caution>EXPAND LIST OF OTHER PREBUILT IMAGES</caution>
+ <para>For the following example, we have already installed the <application>VirtualBox</application> application (see <xref linkend="serversideinstallation-virtual-vbox-install"/> for details). Continue with the steps as shown; refer to the accompanying figures for further information:</para>
+ <procedure>
+ <step>Start VirtualBox for the first time and select <menuchoice><guimenu>File</guimenu><guimenuitem>VirtualBox Media Manager</guimenuitem><guimenuitem>Add</guimenuitem></menuchoice> to locate the prebuilt software image just downloaded (the example shows it was extracted from the original <literal>.ZIP</literal> file into a temporary directory <literal>C:\temp</literal>). See <xref linkend="serversideinstallation-virtual-vm-install-2"/> for details.</step>
+ <step>After selecting the file, click <guibutton>Open</guibutton> to import it (see <xref linkend="serversideinstallation-virtual-vm-install-3"/> for details).</step>
+ <step>Then click <guibutton>OK</guibutton> to save the selection and return to the VirtualBox Media Manager (see <xref linkend="serversideinstallation-virtual-vm-install-4"/> for details).</step>
+ <step>Click <guibutton>New</guibutton> to start the "Virtual Machine Wizard", then <guibutton>Next</guibutton> to continue and create a new virtual machine (VM) <xref linkend="serversideinstallation-virtual-vm-install-5"/>).</step>
+ <step>Create a new name for the VM and set the operating system type, then click <guibutton>Next</guibutton> (see <xref linkend="serversideinstallation-virtual-vm-install-6"/>).</step>
+ <step>Set the memory size (we chose the default value of 512Mb), then click <guibutton>Next</guibutton> (see <xref linkend="serversideinstallation-virtual-vm-install-7"/>).</step>
+ <step>Edit the Virtual Hard Disk configuration settings; click the radio boxes "Boot Hard Disk" and "Use existing hard disk" and ensure that the disk name "Evergreen1601_DebianLenny.vmdk" is selected. Click <guibutton>Finish</guibutton> to finish the setup (see <xref linkend="serversideinstallation-virtual-vm-install-8"/>).</step>
+ <step>
+ <para>Install the <application>VirtualBox Guest Additions</application> (really a required upgrade to VirtualBox)</para>
+ <indexterm>
+ <primary>ZZZ-REVIEW</primary>
+ <secondary>ADD INFO ON INSTALLING VIRTUALBOX GUEST ADDITIONS</secondary>
+ </indexterm>
+ <caution>ADD INFO ON INSTALLING VIRTUALBOX GUEST ADDITIONS</caution>
+ </step>
+ <step>Return to VirtualBox and see the summary of the VM just created. Click <guibutton>Start</guibutton> to boot the new VM (see <xref linkend="serversideinstallation-virtual-vm-install-9"/>).</step>
+ <step>See the start of the <systemitem class="osname">Linux</systemitem> boot sequence. Choose "Debian Gnu/Linux, kernel 2.6.26-2-686" from the startup menu and type <guibutton>Enter</guibutton> to start <systemitem class="osname">Linux</systemitem> and Evergreen (see <xref linkend="serversideinstallation-virtual-vm-install-11"/>). After some delay you should see the command line prompt: <literal>debian-lenny login:</literal> . Log in with username <literal>root</literal> and password <literal>evergreen</literal> to continue (see <xref linkend="serversideinstallation-virtual-vm-install-14"/>).</step>
+ </procedure>
+ <para>At this point you have a running <systemitem class="osname">Linux</systemitem> / Evergreen system. If you need to modify the Evergreen configuration in any way, review the sectons of the standard Evergreen installation instructions in <xref linkend="serversideinstallation-ubuntudebian"/> that deal with configuration.</para>
+ <figure xml:id="serversideinstallation-virtual-vm-install-2">
+ <title>Starting <application>VirtualBox</application> for the first time</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vm-install-2.png" scalefit="1" width="70%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure xml:id="serversideinstallation-virtual-vm-install-3">
+ <title>Selecting the software image in Virtual Media Manager</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vm-install-3.png" scalefit="1" width="70%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure xml:id="serversideinstallation-virtual-vm-install-4">
+ <title>New software image added to <application>VirtualBox</application></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vm-install-4.png" scalefit="1" width="75%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure xml:id="serversideinstallation-virtual-vm-install-5">
+ <title>Creating a new VM</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vm-install-5.png" scalefit="1" width="75%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure xml:id="serversideinstallation-virtual-vm-install-6">
+ <title>Setting the VM name and OS type</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vm-install-6.png" scalefit="1" width="75%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure xml:id="serversideinstallation-virtual-vm-install-7">
+ <title>Setting memory size</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vm-install-7.png" scalefit="1" width="75%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure xml:id="serversideinstallation-virtual-vm-install-8">
+ <title>Setting up the Virtual Hard Disk</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vm-install-8.png" scalefit="1" width="75%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure xml:id="serversideinstallation-virtual-vm-install-9">
+ <title>Finishing definition of new VM</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vm-install-9.png" scalefit="1" width="75%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure xml:id="serversideinstallation-virtual-vm-install-10">
+ <title>Summary of the new VM</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vm-install-10.png" scalefit="1" width="75%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure xml:id="serversideinstallation-virtual-vm-install-11">
+ <title>Selecting VM from startup menu</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vm-install-11.png" scalefit="1" width="75%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure xml:id="serversideinstallation-virtual-vm-install-12">
+ <title>Starting the new VM</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vm-install-12.png" scalefit="1" width="75%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure xml:id="serversideinstallation-virtual-vm-install-13">
+ <title>Starting the new VM (continued)</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vm-install-13.png" scalefit="1" width="75%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure xml:id="serversideinstallation-virtual-vm-install-14">
+ <title>Logging into the new VM</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-virtual-vm-install-14.png" scalefit="1" width="75%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section xml:id="serversideinstall-virtual-manual">
+ <title>Manually install <systemitem class="osname">Linux</systemitem> and Evergreen</title>
+ <para>You can manually install a <systemitem class="osname">Linux</systemitem> guest system and Evergreen on your virtualization software.</para>
+ <para>We recommend this approach if you need to specially configure either the <systemitem class="osname">Linux</systemitem> system or Evergreen itself. This will require a detailed review of both <systemitem class="osname">Linux</systemitem> and Evergreen configuration details. You are essentially doing a normal Evergreen installation on a <systemitem class="osname">Linux</systemitem> system; it just happens that <systemitem class="osname">Linux</systemitem> is running within a virtualized environment. Refer to <xref linkend="serversideinstallation-ubuntudebian"/> for information on the normal Evergreen installation, then continue with this section.</para>
+ <para>For the following example, we have already installed the <application>VirtualBox</application> application (see <xref linkend="serversideinstallation-virtual-vbox-install"/> for details). Continue with the steps as shown; refer to the accompanying figures for further information:</para>
+ <procedure>
+ <step>
+ <para>Download and install a standard <systemitem class="osname">Ubuntu</systemitem> distribution in <application>"VirtualBox"</application>.</para>
+ <para>You can download a software image of a prebuilt <systemitem class="osname">Ubuntu</systemitem> distribution and immediately import it into <application>"VirtualBox"</application> , or you can download and install
+</para>
+ <indexterm>
+ <primary>ZZZ-REVIEW</primary>
+ <secondary>ADD DETAILS ON MANUAL INSTALLATION OF LINUX</secondary>
+ </indexterm>
+ <caution>ADD DETAILS ON MANUAL INSTALLATION OF LINUX</caution>
+ </step>
+ <step>
+ <para>Start (boot) <systemitem class="osname">Ubuntu</systemitem>.</para>
+ <indexterm>
+ <primary>ZZZ-REVIEW</primary>
+ <secondary>ADD DETAILS ON VM LINUX BOOT SEQUENCE</secondary>
+ </indexterm>
+ <caution>ADD DETAILS ON VM LINUX BOOT SEQUENCE</caution>
+ </step>
+ <step>
+ <para>Install Evergreen on <systemitem class="osname">Ubuntu</systemitem>.</para>
+ <indexterm>
+ <primary>ZZZ-REVIEW</primary>
+ <secondary>ADD DETAILS ON MANUAL INSTALLATION OF EVERGREEN</secondary>
+ </indexterm>
+ <caution>ADD DETAILS ON MANUAL INSTALLATION OF EVERGREEN</caution>
+ </step>
+ </procedure>
+ <para>At this point, the <systemitem class="osname">Windows</systemitem> system is hosting an <systemitem class="osname">Ubuntu</systemitem> system, which itself is hosting the Evergreen distribution. So far as Evergreen is concerned, it is happily executing in a standard <systemitem class="osname">Ubuntu</systemitem> environment and behaves exactly as if it were executing on a standalone <systemitem class="osname">Ubuntu</systemitem> system.</para>
+ <para>Of course, there are limitations to how well a virtualized <systemitem class="osname">Ubuntu</systemitem> system emulates a real one. The <application>"VirtualBox"</application> application itself consumes memory, and it contributes to the CPU load on the <systemitem class="osname">Windows</systemitem> host system. The emulated <systemitem class="osname">Ubuntu</systemitem> system will have less available memory and will execute more slowly than if it were a standalone system, therefore Evergreen itself will inherit some limitations from this overall environment.</para>
+ <para>However, this technique of using a <systemitem class="osname">Windows</systemitem> host to emulate a <systemitem class="osname">Linux</systemitem> environment is a practical way to install and run an Evergreen system even if it isn't possible to dedicate a real machine solely as a <systemitem class="osname">Linux</systemitem> host for testing. This is a reasonable architecture for simple experiments, or as a proof of concept, or as a conference-room pilot.</para>
+ </section>
+ </simplesect>
+ </section>
+ <section xml:id="serversideinstallation-ssl">
+ <title>Getting a Signed SSL Certificate</title>
+ <para>This section describes how to get a properly signed SSL certificate.</para>
+ <para>For temporary testing purposes, you can use the command <command>openssl</command> to create a new SSL key for your Apache server. This is just a self-signed certificate and will generate warnings in the Staff Client and browser during testing and development. For a public production server you should configure or purchase a properly signed SSL certificate.</para>
+ <indexterm>
+ <primary>ZZZ-REVIEW</primary>
+ <secondary>ADD INFO ON HOW TO GET A SIGNED SSL CERTIFICATE </secondary>
+ </indexterm>
+ <caution>ADD INFO ON HOW TO GET A SIGNED SSL CERTIFICATE </caution>
+ </section>
+ </section>
+</chapter>
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter xml:id="serversideinstallation-staffclient" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xl="http://www.w3.org/1999/xlink">
+ <info>
+ <title>Installation of Evergreen Staff Client Software</title>
+ <abstract>
+ <para>This section describes installation of the Evergreen Staff Client software.</para>
+ </abstract>
+ </info>
+ <section xml:id="serversideinstallation-installing-staffclient">
+ <title>Installing the Staff Client</title>
+ <para>The Staff Client is automatically built by default as part of the normal <emphasis>make install</emphasis> process for Evergreen server-side software. See the section <xref linkend="serversideinstallation-compilingevergreen"/> to review details related to building the Staff Client in the final compile/link/install phase of the default Evergreen build process. See the section <xref linkend="serversideinstallation-building-staffclient"/> for help on manually building the Staff Client. Otherwise, continue with the following sections to install a pre-built Staff Client.</para>
+ <simplesect xml:id="serversideinstallation-prebuilt-staffclient">
+ <title>Installing a Pre-Built Staff Client</title>
+ <para>You can install the Staff Client from pre-built images and packages without actually having to first build it. Pre-built packages are currently available for Windows, MAC OS X, and Linux. If you need to manually build the Staff Client, see the section <xref linkend="serversideinstallation-building-staffclient"/>.</para>
+ <section>
+ <title>Installing on Windows</title>
+ <para>A standard Microsoft Windows installer that contains the current version of the Staff Client is available from the downloads section of the Evergreen website at <ulink url="http://www.evergreen-ils.org/downloads.php">http://www.evergreen-ils.org/downloads.php</ulink>. Download the staff client installer, then run it. A screen that looks similar to this should appear:</para>
+ <figure>
+ <title>Running the Staff Client installer</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-staffclient-1.png" scalefit="1" width="70%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click the <emphasis>Next</emphasis> button to continue through the guided install process. The install wizard will ask you to agree to the end-user license, ask you where to install the software, ask about where to place icons, and then will install the software on your workstation.</para>
+ <para>When you run the staff client for the first time, a screen similar to this should appear:</para>
+ <figure>
+ <title>Running the Staff Client for the first time</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-staffclient-2.png" scalefit="1" width="70%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>First, configure the server you would like to connect to in the <emphasis role="bold">Server</emphasis> section. For example, the PINES demo system is <emphasis role="bold">demo.gapines.org</emphasis>. After selecting a server, click the <emphasis role="bold">Re-Test Server</emphasis> button.</para>
+ <para>Because this is the initial run of the staff client, the <emphasis role="bold">Workstation</emphasis> section in the upper-right states: <emphasis role="bold">Not yet configured for the specified server</emphasis>. The first thing that must be done to the Staff Client on every workstation is to assign it a workstation name. This is covered in the section <xref linkend="serversideinstallation-workstationnames"/>.</para>
+ </section>
+ <section>
+ <title>Installing on Mac OS X</title>
+ <para>A Mac package that contains the current version of the Staff Client is available for use with XULRunner.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Evergreen Indiana Pkg file [Evergreen v1.2.3.0]</para>
+ <orderedlist>
+ <listitem>Download and install the latest version of XULRunner for Mac OS. Release notes for the latest version can be found here: <ulink url="http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes">http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes</ulink>. Note, later versions may not work correctly.</listitem>
+ <listitem>Download and install the Mac Installation package for the 1_2_3_0 Version Staff Client from <ulink url="http://evergreen.lib.in.us/opac/extras/files/evergreen_osx_staff_client_1_2_3.zip">http://evergreen.lib.in.us/opac/extras/files/evergreen_osx_staff_client_1_2_3.zip</ulink>.</listitem>
+ <listitem>To upgrade to a more recent version of the staff client, you can copy the "build" directory from a working Windows installation of the desired version of the staff client to your Mac. The required files may be located in a directory like this on the Windows machine: <emphasis>C:\Program Files\Evergreen Staff Client\build</emphasis>. Copy these files into the "Resources" folder within the Open-ILS package in your Applications directory on the Mac, overwriting files with the same names.</listitem>
+ <listitem>Drag the application's icon into your toolbar for easier access.</listitem>
+ </orderedlist>
+ <para/>
+ <para>When you run the staff client installer, a screen will appear that looks similar to this:</para>
+ <figure>
+ <title>Running the Staff Client installer</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-staffclient-3.png" scalefit="1" width="20%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <caution> FIX BAD LINK: http://es.zionsville.lib.in.us/atheos/eg_osx_a.gif </caution>
+ <para>Click continue, accept the license, then finish the installation. The application will be located at the destination you selected during installation. You will then be able to drag the application into your toolbar for easier access.</para>
+ <figure>
+ <title>Finishing the installation</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-staffclient-4.png" scalefit="1" width="20%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <caution> FIX BAD LINK: http://es.zionsville.lib.in.us/atheos/eg_osx_a.gif </caution>
+ </listitem>
+ <listitem>
+ <para>Running directly using XULRunner</para>
+ <para>You must install an apropriate version of XULRunner to match the Evergreen version. See the following table for the recommended version of XULRunner:</para>
+ <table>
+ <title>Evergreen / XULRunner Dependencies</title>
+ <tgroup align="left" cols="2" colsep="1" rowsep="1">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+ <tbody>
+ <row>
+ <entry>Evergreen 1.6.x.x</entry>
+ <entry>XULrunner 1.9</entry>
+ </row>
+ <row>
+ <entry>Evergreen 1.4.x.x</entry>
+ <entry>XULrunner 1.8.0.4 or XULrunner 1.8.0.3</entry>
+ </row>
+ <row>
+ <entry>Evergreen 1.2.x.x</entry>
+ <entry>XULrunner 1.8.0.4 or XULrunner 1.8.0.3</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <note>If you have issues removing previously installed XULRunner versions see <xref linkend="serversideinstallation-staffclient-remove-xulrunner"/> for information on removing previous XULRunner versions.</note>
+ <para>The staff client data from the <emphasis>./staff_client/build</emphasis> directory must be placed somewhere on the machine (e.g. <emphasis>~/Desktop/Evergreen_Staff_Client</emphasis>). Remember to call XULRunner with the full path to the binary, followed by the install command and the path to the client data. See the following command:</para>
+ <figure>
+ <title>Executing XULRunner</title>
+ <screen>
+ /Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_Client
+ </screen>
+ </figure>
+ <para>This command should exit quietly. A folder will be created, named <emphasis>/Applications/OpenILS</emphasis>, containing a launcher named <emphasis>open_ils_staff_client</emphasis>.</para>
+ </listitem>
+ <listitem>
+ <para>Removing previously installed XULRunner versions</para>
+ <section xml:id="serversideinstallation-staffclient-remove-xulrunner">
+ <para>If you already have a newer version installed, per the release notes, you will need to remove the entire directory <emphasis>/Library/Frameworks/XUL.framework</emphasis> before downgrading.</para>
+ <para>In addition, you may also need to remove the previous file <emphasis>/Library/Receipts/xulrunner-ver-mak.pkg</emphasis>.</para>
+ <para>If there is no file <emphasis>/Library/Receipts/xulrunner-ver-mak.pkg</emphasis> (possibly in newer OSX releases) you need to flush the <emphasis>receiptdb</emphasis> file.</para>
+ <note>If you install a newer version over a previous (older) install, the older one is not removed but the symlinks get changed to the newer one.</note>
+ <para>First, get the package identifier, then purge/forget the build that was initially installed:</para>
+ <figure>
+ <title>Purging previous build</title>
+ <screen>
+ sudo pkgutil --pkgs > /tmp/pkgs.txt
+ sudo pkgutil --forget org.mozilla.xulrunner
+ </screen>
+ </figure>
+ <note>It may not be necessary to edit the file <emphasis>/Library/Receipts/InstallHistory.plist</emphasis> after deleting the folder <emphasis>XUL.framework</emphasis>.</note>
+ </section>
+ </listitem>
+ <listitem>
+ <para>Creating an APP file: Staff Client & XULRunner Bundled</para>
+ <para>An APP file is basically a folder. Start with a folder stucture like this:</para>
+ <figure>
+ <title>Sample APP file folder structure</title>
+ <screen>
+ * Evergreen.app
+ * Contents
+ * Frameworks
+ * Resources
+ * MacOS
+ </screen>
+ </figure>
+ <para>Create an APP folder structure with the following commands:</para>
+ <figure>
+ <title>Creating a folder structure</title>
+ <screen>
+ mkdir -p Evergreen.app/Contents/Frameworks
+ mkdir -p Evergreen.app/Contents/Resources
+ mkdir -p Evergreen.app/Contents/MacOS
+ </screen>
+ </figure>
+ <para/>
+ <orderedlist>
+ <listitem>
+ <para>Create a new file in the folder <emphasis>Evergreen.app/Contents/Info.plist</emphasis> containing the following data (adjust for your version of Evergreen):</para>
+ <figure>
+ <title>Creating a new file</title>
+ <screen>
+ <?xml version="1.0" encoding="UTF-8"?>
+ <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+ <plist version="1.0">
+ <dict>
+ <key>CFBundleExecutable</key>
+ <string>xulrunner</string>
+ <key>CFBundleGetInfoString</key>
+ <string>OpenILS open_ils_staff_client rel_1_6_0_7</string>
+ <key>CFBundleInfoDictionaryVersion</key>
+ <string>6.0</string>
+ <key>CFBundleName</key>
+ <string>Evergreen Staff Client</string>
+ <key>CFBundlePackageType</key>
+ <string>APPL</string>
+ <key>CFBundleShortVersionString</key>
+ <string>rel_1_6_0_7</string>
+ <key>CFBundleVersion</key>
+ <string>rel_1_6_0_7.rel_1_6_0_7</string>
+ <key>NSAppleScriptEnabled</key>
+ <true/>
+ <key>CFBundleTypeIconFile</key>
+ <string>Evergreen.icns</string>
+ </dict>
+ </plist>
+ </screen>
+ </figure>
+ </listitem>
+ <listitem>Download and install an appropriate Mac OS package of XULRunner from the Mozilla website (see above for recommendations).</listitem>
+ <listitem>
+ <para>Make a copy of <emphasis>/Library/Frameworks/XUL.Framework</emphasis> inside your APP file. It should look something like this:</para>
+ <figure>
+ <title>Example of APP file framework</title>
+ <screen>
+ * Evergreen.app/
+ __* Contents/
+ ____* Frameworks/
+ ______* XUL.Framework/
+ ______* Versions/
+ ________* Current -> 1.9.1.3 (symlink)
+ ________* 1.9.1.3/
+ ______* XUL -> Versions/Current/XUL
+ ______* libxpcom.dylib -> Versions/Current/libxpcom.dylib
+ ______* xulrunner-bin -> Versions/Current/xulrunner-bin
+ </screen>
+ </figure>
+ </listitem>
+ <listitem>Copy <emphasis>XUL.Framework/Versions/Current/xulrunner</emphasis> into <emphasis>Evergreen.app/MacOS</emphasis> (do not symlink; copy the file).</listitem>
+ <listitem>
+ <para>Make <emphasis>Evergreen.app/Resources</emphasis> the root of your Evergreen application files like this:</para>
+ <figure>
+ <title>Example APP file</title>
+ <screen>
+ * Evergreen.app/
+ __* Contents/
+ ____* Resources/
+ ______* BUILD_ID
+ ______* application.ini
+ ______* chrome/
+ ______* components/
+ ______* etc.
+ </screen>
+ </figure>
+ </listitem>
+ <listitem>Put a Mac format icon file named <emphasis>Evergreen.icns</emphasis> in Resources.</listitem>
+ </orderedlist>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section xml:id="serversideinstallation-staffclient-linux">
+ <title>Installing on Linux</title>
+ <section>
+ <title>Quick Upgrade of the Staff Client</title>
+ <para>A Linux Staff Client is automatically built on the server as part of the normal <emphasis>make install</emphasis> process for Evergreen server-side software. To upgrade the Staff Client on a remote workstation with a new version, just copy the directory tree containing the Staff Client from the server to the remote workstation.</para>
+ <para>The following example assumes you already have an "opensrf" user account on both the server and the remote workstation. Remember to replace "user", "client.linux.machine" and "eg-client-x.x.x.x" with the proper user name, client machine name, and version number in the following example.</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then recursively copy the entire directory tree to the remote workstation:</para>
+ <figure>
+ <title>Copying the Staff Client to a remote workstation</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
+ $ scp -r build user@client.linux.machine:~/eg-client-x.x.x.x/
+ </screen>
+ </figure>
+ <para>To test the newly copied Staff Client, as the <emphasis role="bold">opensrf</emphasis> user log into the remote workstation and execute it as shown:</para>
+ <figure>
+ <title>Testing the copied Staff Client</title>
+ <screen>
+ $ su - opensrf
+ $ xulrunner ~/eg-client-x.x.x.x/build/application.ini
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>Building the Staff Client on the Server</title>
+ <para>A Linux Staff Client is automatically built on the server as part of the normal <emphasis>make install</emphasis> process for Evergreen server-side software.</para>
+ <para>In order to install a compatible Staff Client on another Linux system, just copy the applicable files from the server to that system, or even manually build it on that system. Ensure that the BUILD_ID you choose on the server matches the BUILD_ID for each staff client you use on other systems.</para>
+ <para>If you will be using a pre-packaged Windows version on some systems, you may want to choose the BUILD_ID on both server and other versions to match that of the Windows Staff Client. To determine which BUILD_ID is used in an existing Staff Client installation, just click "About this Client" on the running Staff Client.</para>
+ <para>If you are allowed to make changes on the Evergreen server, another option is to create a symbolic link. In order for a copy of the Staff Client and server to work together, the BUILD_ID must match the name of the directory containing the server components of the Staff Client, or the name of a symbolic link to that directory.</para>
+ <figure>
+ <title>Creating a symbolic link</title>
+ <screen>
+ $ su - root
+ $ cd /openils/var/web/xul
+ $ ln -s SERVER_BUILD_ID/ CLIENT_BUILD_ID
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>Building the Staff Client on the client Machine</title>
+ <para>This section is directed toward end-users who wish to use Linux rather than Windows for client machines, but have limited Linux experience. You can build the Staff Client on a Linux system without installing the Evergreen Server component. This is a relatively simple process compared to server installation, but does require some command-line work. The following directions are for building Staff Client version 1.2.1.4 on Kubuntu 7.10; you must modify them for other distributions (the instructions should work as-is for Ubuntu or Ubuntu derivatives).</para>
+ <procedure>
+ <step>
+ <para>Prerequisites</para>
+ <para>Both "subversion" and "xulrunner" are required to build the Staff Client. As the <emphasis role="bold">root</emphasis> user, use "apt-get" to install packages for "subversion" and "xulrunner". You can also use "synaptic", the graphical user interface for "apt-get". For "subversion", select the latest version; for "xulrunner", select version <emphasis>1.8.1.4-2ubuntu5</emphasis>.</para>
+ <figure>
+ <title>Installing subversion and xulrunner</title>
+ <screen>
+ $ sudo apt-get install subversion
+ $ sudo apt-get install xulrunner
+ </screen>
+ </figure>
+ </step>
+ <step>
+ <para>Download the Source Code</para>
+ <itemizedlist>
+ <listitem>
+ <para>Determine which version is needed</para>
+ <para>For most end-users, a specific version is required to communicate properly with the Evergreen server. Check with your system admininstrator, IT person, or HelpDesk to determine which Staff Client versions are supported.</para>
+ <para>Next, you need to determine which <emphasis>tag</emphasis> to use when downloading the source code. Tags are markers in the source code to create a snapshot of the code as it existed at a certain time; tags usually point to tested and stable code, or at least a community-recognized release version.</para>
+ <para>To determine which tag to use, browse to <ulink url="http://svn.open-ils.org/trac/ILS/browser">http://svn.open-ils.org/trac/ILS/browser</ulink>. Look in the "Visit" drop-down box; see the list of Branches and, further down, a list of Tags. You may have to do some guesswork, but it is fairly straightforward to determine which tag to use. If the server is version 1.2.1.4, you will want to use the tag that looks most appropriate. For example, as you look through the tag list, notice the tag named 'rel_1_2_1_4'. This is the tag you need; make a note of it for the next step.</para>
+ </listitem>
+ <listitem>
+ <para>Download the Code</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, open a terminal (command-line prompt) and navigate to the directory in which you wish to download the Staff Client. Use the following commands to download the proper version of the source code by tag name:</para>
+ <figure>
+ <title>Downloading the source code</title>
+ <screen>
+ $ su - opensrf
+ $ cd /YOUR/DOWNLOAD/DIRECTORY
+ $ svn co svn://svn.open-ils.org/ILS/tags/rel_1_2_1_4/
+ </screen>
+ </figure>
+ <para>Remember to change "rel_1_2_1_4" to the appropriate tag for your installation.</para>
+ </listitem>
+ </itemizedlist>
+ </step>
+ <step>
+ <para>Build the Staff Client</para>
+ <itemizedlist>
+ <listitem>
+ <para>Evergreen 1.2.x</para>
+ <para>In the following example, navigate to the directory in which the source code was downloaded, then navigate to the proper subdirectory and run the "make" utility to actually build the Staff Client. Remember to check with your system administrator about which Staff Client BUILD_ID to use. The server checks the Staff Client BUILD_ID against itself to determine whether or not a connecting client is supported. For instance, for the PINES installation (version 1.2.1.4) the supported BUILD_ID is "rel_1_2_1_4". Modify the following commands accordingly.</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, run the following commands to build the Staff Client:</para>
+ <figure>
+ <title>Finding the downloaded source code</title>
+ <screen>
+ $ su - opensrf
+ $ cd /YOUR/DOWNLOAD/DIRECTORY
+ $ cd Open-ILS/xul/staff_client
+ $ make STAFF_CLIENT_BUILD_ID='rel_1_2_1_4'
+ ...
+ </screen>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Evergreen 1.4.x</para>
+ <para>The 1.4 series of Evergreen has complicated the build process for the Staff Client a bit. If you downloaded a .tar.gz (compressed tar archive) of Evergreen, then your steps will resemble the following:</para>
+ <caution>FIXME -- Need instructions for getting certain Javascript files from OpenSRF, preferably without actually installing OpenSRF.
+</caution>
+ <figure>
+ <title>Building 1.4.x</title>
+ <screen>
+ $ su - opensrf
+ $ wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.4.0.4.tar.gz
+ $ tar xfz Evergreen-ILS-1.4.0.4.tar.gz
+ $ cd Evergreen-ILS-1.4.0.4/
+ $ ./configure --prefix=/openils --sysconfdir=/openils/conf
+ $ cd Open-ILS/xul/staff_client/
+ $ make STAFF_CLIENT_BUILD_ID='rel_1_4_0_4' install
+ </screen>
+ </figure>
+ <para/>
+ <para>If you're installing from a Subversion checkout:</para>
+ <figure>
+ <title>Building from a "subversion" checkout</title>
+ <screen>
+ $ su - opensrf
+ $ svn co svn://svn.open-ils.org/ILS/tags/rel_1_4_0_4/
+ $ cd rel_1_4_0_4
+ $ ./autogen.sh # If you downloaded a .tar.gz of Evergreen, you may skip this step
+ $ ./configure --prefix=/openils --sysconfdir=/openils/conf
+ $ cd Open-ILS/xul/staff_client/
+ $ make STAFF_CLIENT_BUILD_ID='rel_1_4_0_4' install
+ </screen>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ </step>
+ <step>
+ <para>Run the Staff Client (from the command line)</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, navigate to the <emphasis>build/</emphasis> subdirectory (not <emphasis>staff_client/</emphasis>) and run the following command:</para>
+ <figure>
+ <title>Running the Staff Client</title>
+ <screen>
+ $ su - opensrf
+ $ xulrunner application.ini
+ </screen>
+ </figure>
+ </step>
+ <step>
+ <para>(OPTIONAL) Cleaning Up / Creating Shortcuts</para>
+ <para>The source code download included many files that are needed to build the Staff Client, but are not necessary to run it. You may wish to remove them to save space, or to create a clean directory containing the built staff client that can be copied to other machines. To create a clean "staging" directory in which to place the finished staff client, issue the following commands:</para>
+ <figure>
+ <title>Creating a "staging" directory</title>
+ <screen>
+ $ mkdir ~/<Destination Directory>
+ $ cd ~/<Download Directory>/Open-ILS/xul/
+ $ cp -r staff_client ~/<Destination Directory>
+ </screen>
+ </figure>
+ <para>Finally, test the Staff Client to verify that all the necessary files were moved to the destination directory:</para>
+ <figure>
+ <title>Testing the copied Staff Client</title>
+ <screen>
+ $ cd ~/<Destination Directory>/staff_client/build
+ $ xulrunner application.ini
+ </screen>
+ </figure>
+ <para>If there were no problems, then finish the cleanup by removing the original download directory and all subdirectories:</para>
+ <figure>
+ <title>Cleaning up</title>
+ <screen>
+ $ rm -r -f ~/<Download Directory>
+ </screen>
+ </figure>
+ <para>Finally, test the copied Staff Client. You can create "Desktop / Start Menu / K-Menu" shortcuts for the Staff Client by using the following command as the target:</para>
+ <figure>
+ <title>Running the copied Staff Client</title>
+ <screen>
+ $ xulrunner ~/<Destination Directory>/staff_client/build/application.ini
+ </screen>
+ </figure>
+ </step>
+ </procedure>
+ </section>
+ <section>
+ <title>Using Wine to Install On Linux</title>
+ <para>The Linux application <emphasis>Wine</emphasis> is another alternative for those who wish to install the packaged Windows versions rather than building the Staff Client manually. Wine is a Linux application that allows users to directly run Windows executables, and is a simple way for casual Linux users to use the Staff Client. More information about Wine can be found at <ulink url="http://www.winehq.org/site/docs/wineusr-guide/getting-wine">http://www.winehq.org/site/docs/wineusr-guide/getting-wine</ulink>.</para>
+ <para>As the <emphasis role="bold">root</emphasis> user, use "apt-get" to install the package for "wine". You can also use "synaptic", the graphical user interface.</para>
+ <orderedlist>
+ <listitem>
+ <para>Install wine</para>
+ <figure>
+ <title>Installing "wine"</title>
+ <screen>
+ $ sudo apt-get install wine
+ </screen>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Download Windows installer for the Staff Client</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, run the following commands to download the Windows installer for the proper Staff Client from the <emphasis>open-ils.org</emphasis> website and place it in a temporary directory:</para>
+ <figure>
+ <title>Downloading the Staff Client installer</title>
+ <screen>
+ $ su - opensrf
+ $ cd /YOUR/DOWNLOAD/DIRECTORY
+ $ wget http://open-ils.org/downloads/evergreen-setup-rel_version-number.exe
+ </screen>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Run the downloaded Windows installer</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, navigate to the directory where you downloaded the Windows executable file, then execute it:</para>
+ <figure>
+ <title>Using Wine to run the Windows installer</title>
+ <screen>
+ $ su - opensrf
+ $ cd /YOUR/DOWNLOAD/DIRECTORY
+ $ wine evergreen-setup-rel_version-number.exe
+ </screen>
+ </figure>
+ <para>If this step fails, you may need to configure Wine first to properly emulate Windows XP. To do so, type "winecfg" from the command line; in the "Applications" tab of the window that pops up, select "Default Settings" and choose "Windows XP" from the drop-down menu, then click "Apply".</para>
+ </listitem>
+ <listitem>
+ <para>Launch the Staff Client</para>
+ <para>A new entry for the Staff Client should now appear somewhere in the "All Applications" menu of your Linux desktop. Also, find a new desktop shortcut for the Staff Client. To launch the Staff Client, visit the "All Applications" menu, find a section similar to "Wine->Program Files->Evergreen Staff Client->Evergreen Staff Client", or else launch the Staff Client from the desktop shortcut.</para>
+ </listitem>
+ </orderedlist>
+ </section>
+ <section xml:id="serversideinstallation-workstationnames">
+ <title>Assigning Workstation Names</title>
+ <para>The Staff Client must be assigned to a library and given a unique name before it will connect fully to the Evergreen server. The only restriction is that the workstation's name must be unique within the assigned library. Make sure to select a workstation name that you will remember later, and reflects the role, purpose, and/or location of a particular computer. These names will come up later in statistical reporting, and can also be handy when troubleshooting.</para>
+ <figure>
+ <title>Example of unconfigured Staff Client</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-staffclient-workstationnames-1.png" scalefit="1" width="70%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>In order to assign a workstation a name, a user with appropriate permissions must login to the Staff Client. In PINES, the local system administrator (OPSM) has the ability to assign workstation names in his or her library system. Library managers (LIBM's) have the ability within their branch. To assign a workstation a name, login to the system. You will be prompted to assign the workstation a library and a name:</para>
+ <figure>
+ <title>Example of configured Staff Client</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-staffclient-workstationnames-2.png" scalefit="1" width="70%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Select the library this workstation physically operates in from the drop down menu. In this example, we have selected "MGRL-MA". Type in a friendly name for the workstation. In this example, we are installing the Staff Client on the director's personal system, and have named it as such. Then hit <emphasis role="bold">Register</emphasis>.</para>
+ <para>Once you have registered your workstation with the server, your screen will look like this:</para>
+ <figure>
+ <title>Example of registered Staff Client</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-staffclient-workstationnames-3.png" scalefit="1" width="70%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>You are now ready to log into the Staff Client for the first time. Type in your password again, and hit <emphasis role="bold">Login</emphasis>.</para>
+ </section>
+ </section>
+ </simplesect>
+ <simplesect xml:id="serversideinstallation-building-staffclient">
+ <title>Manually Building the Staff Client</title>
+ <para>The Staff Client is automatically built by default as part of the normal <emphasis>make install</emphasis> process for Evergreen server-side software. See the section <xref linkend="serversideinstallation-compilingevergreen"/> to review details related to building the Staff Client in the final compile/link/install phase of the default Evergreen build process.</para>
+ <section>
+ <title>Building the Staff Client</title>
+ <para>You can also manually build the Staff Client by using the <emphasis>make</emphasis> utility in the Staff Client source directory (e.g., the directory <emphasis>/home/opensrf/Evergreen-ILS-1.6.0.x/Open-ILS/xul/staff_client</emphasis> for the current Evergreen version). There are a number of possible options to manually build special versions of the Staff Client on a Linux system. Following is a list of environment variables that can be passed to <emphasis>make</emphasis> to influence the manual build process:</para>
+ <section>
+ <title>Option STAFF_CLIENT_BUILD_ID</title>
+ <para>During the normal <emphasis>make install</emphasis> Evergreen server-side software build process, the variable defaults to an automatically generated date/time string, but you can also override the value of BUILD_ID.</para>
+ <para>The following commands could be used during the normal build process:</para>
+ <figure>
+ <title>Commands used during normal Evergreen build</title>
+ <screen>
+ $ su - root
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
+ $ make STAFF_CLIENT_BUILD_ID=rel_1_6_0_7 install
+ ...
+ </screen>
+ </figure>
+ <para>The following commands will manually build the Staff Client using a different BUILD_ID.</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then set the variable and build the Staff Client:</para>
+ <figure>
+ <title>Commands to manually build the Staff Client</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
+ $ make STAFF_CLIENT_BUILD_ID=my_test_id build
+ ...
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>Option STAFF_CLIENT_VERSION</title>
+ <para>During the normal <emphasis>make install</emphasis> Evergreen server-side software build process, the variable is pulled automatically from a README file in the Evergreen source root. The variable defaults to <emphasis>0trunk.revision</emphasis>, where the value of "revision" is automatically generated. You can override the value of VERSION similarly to the BUILD_ID.</para>
+ <para>The following commands could be used during the normal build process:</para>
+ <figure>
+ <title>Commands used during normal Evergreen build</title>
+ <screen>
+ $ su - root
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
+ $ make STAFF_CLIENT_VERSION=0mytest.200 install
+ ...
+ </screen>
+ </figure>
+ <para>The following commands will manually build the Staff Client using a different VERSION.</para>
+ <para>If you plan to make extensions update automatically, the VERSION needs to conform to the format recommended in <ulink url="https://developer.mozilla.org/en/Toolkit_version_format">Toolkit Version Format</ulink> and newer versions need to be "higher" than older versions.</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then set the variable and build the Staff Client:</para>
+ <figure>
+ <title>Commands to manually build the Staff Client</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
+ $ make STAFF_CLIENT_VERSION=0mytest.200 build
+ ...
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>Option STAFF_CLIENT_STAMP_ID variable</title>
+ <para>During the normal <emphasis>make install</emphasis> Evergreen server-side software build process, this variable is generated from STAFF_CLIENT_VERSION. You can override the value of STAMP_ID similarly to the BUILD_ID.</para>
+ <para>The following commands could be used during the normal build process:</para>
+ <figure>
+ <title>Commands used during normal Evergreen build</title>
+ <screen>
+ $ su - root
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
+ $ make STAFF_CLIENT_STAMP_ID=my_test_stamp install
+ ...
+ </screen>
+ </figure>
+ <para>The following commands will manually build the Staff Client using a different STAMP_ID.</para>
+ <para>It is possible to have multiple versions of the Staff Client by specifying a different STAMP_ID for each, possibly for different uses or client-side customizations.</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then set the variable and build the Staff Client:</para>
+ <figure>
+ <title>Commands to manually build the Staff Client</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
+ $ make STAFF_CLIENT_STAMP_ID=my_test_stamp build
+ ...
+ </screen>
+ </figure>
+ </section>
+ </section>
+ <section>
+ <title>Advanced Build Options</title>
+ <para>In addition to the basic options listed above, there are a number of advanced options for building the Staff Client. Most are target names for the <emphasis>make</emphasis> utility and require that you build the Staff Client from its source directory. See the following table for a list of possible <emphasis>make</emphasis> target keywords:</para>
+ <table>
+ <title>Keywords Targets for "make" Command</title>
+ <tgroup align="left" cols="2" colsep="1" rowsep="1">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+ <thead>
+ <row>
+ <entry>Keyword</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>clients</entry>
+ <entry>Runs "make win-client", "make linux-client", and "make generic-client" individually</entry>
+ </row>
+ <row>
+ <entry>client_dir</entry>
+ <entry>Builds a client directory from the build directory, without doing a rebuild. The same as "copy everything but server/".</entry>
+ </row>
+ <row>
+ <entry>client_app</entry>
+ <entry>Prerequisite "client_dir"; removes "install.rdf" from client directory so an APP bundle can't be installed as an extension</entry>
+ </row>
+ <row>
+ <entry>client_ext</entry>
+ <entry>Prerequisite "client_dir"; remove "application.ini", "autoupdate.js", "standalone_xul_app.js" from client directory so an extension won't break Firefox</entry>
+ </row>
+ <row>
+ <entry>extension</entry>
+ <entry>Prerequisite "client_ext"; rewritten to use "client_ext"</entry>
+ </row>
+ <row>
+ <entry>generic-client</entry>
+ <entry>Prerequisite "client_app"; makes an XPI file suitable for use with "xulrunner --install-app""</entry>
+ </row>
+ <row>
+ <entry>win-xulrunner</entry>
+ <entry>Prerequisite "client_app"; adds Windows xulrunner to client build</entry>
+ </row>
+ <row>
+ <entry>linux-xulrunner</entry>
+ <entry>Prerequisite "client_app"; adds Linux xulrunner to client build</entry>
+ </row>
+ <row>
+ <entry>win-client</entry>
+ <entry>Prerequisite "win-xulrunner"; builds "setup exe" (requires that "nsis" package be installed, will add options for automatic update if configured and developer options if client build was a "make devbuild")</entry>
+ </row>
+ <row>
+ <entry>linux-client</entry>
+ <entry>Prerequisite "linux_xulrunner"; builds a "tar.bz2" bundle of the Linux client</entry>
+ </row>
+ <row>
+ <entry>[generic-|win-|linux-|extension-]updates[-client]</entry>
+ <entry>Calls external/make_updates.sh to build full and partial updates generic/win/linux/extension prefix limit to that distribution; Adding "-client" builds clients and copies them to a subdirectory of the "updates" directory as well; "extension-updates-client" doesn't exist.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>Descriptions of other special build options follow:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Developer Build</para>
+ <para>You can create a so-called "developer build" of the Staff Client by substituting "devbuild" for "build" when running <emphasis>make</emphasis>. The build will contain an extra configuration file that enables some developer options.</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, run <emphasis>make</emphasis> from the Staff Client source directory:</para>
+ <figure>
+ <title>Commands to do a "developer build"</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
+ $ make devbuild
+ ...
+ </screen>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Compressed Javascript</para>
+ <para>You can execute the Google "Closure Compiler" utility to automatically review and compress Javascript code after the build process completes, by substituting "compress-javascript" for "build" when running <emphasis>make</emphasis>. For more information see <ulink url="http://code.google.com/closure/compiler/">Google "Closure Compiler"</ulink>.</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, run the following commands from the Staff Client source directory:</para>
+ <figure>
+ <title>Commands to compress Javascript</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
+ $ make compress-javascript
+ ...
+ </screen>
+ </figure>
+ <para>You can also combine Javascript review and compression, and also perform a "developer build".</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, run the following commands from the Staff Client source directory:</para>
+ <figure>
+ <title>Commands to compress Javascript and do a "developer build"</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
+
+ # order of options is important!
+ $ make devbuild compress-javascript
+ ...
+ </screen>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Automatic Update Host</para>
+ <para>The host used to check for automatic Staff Client updates can be overridden by specifying the AUTOUPDATE_HOST option. The following commands could have been used during the normal build process:</para>
+ <figure>
+ <title>Commands to set AUTOUPDATE_HOST for normal Evergreen build</title>
+ <screen>
+ $ su - root
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
+ $ make AUTOUPDATE_HOST=localhost install
+ ...
+ </screen>
+ </figure>
+ <para>You can manually set AUTOUPDATE_HOST to set up automatic update checking. The following commands will manually build the Staff Client using a different AUTOUPDATE_HOST.</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then set the variable and build the Staff Client:</para>
+ <figure>
+ <title>Commands to manually specify AUTOUPDATE_HOST</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
+ $ make AUTOUPDATE_HOST=localhost build
+ ...
+ </screen>
+ </figure>
+ <para>For more information on Automatic Updates, see the section <xref linkend="serversideinstallation-staffclient-autoupdate"/>.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section>
+ <title>Installing and Activating a Manually Built Staff Client</title>
+ <para>The Staff Client is automatically built, installed and activated as part of the normal <emphasis>make install</emphasis> process for Evergreen server-side software. However, if you manually build the Staff Client, then you need to take additional steps to properly install and activate it. You also have the option of installing the Staff Client on the same machine it was built on, or on a different machine.</para>
+ <para>Assuming you have already built the Staff Client, and that your installation is in the directory <emphasis>/openils/var/web/xul</emphasis>, as the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then execute the following commands:</para>
+ <figure>
+ <title>Commands to install the Staff Client on the same machine</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
+ $ mkdir -p "/openils/var/web/xul/$(cat build/BUILD_ID)"
+ $ cp -R build/server "/openils/var/web/xul/$(cat build/BUILD_ID)"
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>Packaging the Staff Client</title>
+ <para>Once the Staff Client has been built, you can create several forms of client packages by using some targetted <emphasis>make</emphasis> commands in the Staff Client source directory.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Packaging a Generic Client</para>
+ <para>This build creates a Staff Client packaged as an XPI file to use with <emphasis>XULRunner</emphasis>. It requires that you already have the "zip" utility installed on your system. It will create the output file "evergreen_staff_client.xpi", suitable for use with the <emphasis>XULRunner</emphasis> parameter <emphasis>--install-app</emphasis>.</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then execute the following commands:</para>
+ <figure>
+ <title>Commands to package a "generic" client</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
+ $ make generic-client
+ ...
+ </screen>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Packaging a Windows Client</para>
+ <para>This build creates a Staff Client packaged as a Windows executable. It requires that you already have the "unzip" utility installed on your system. It also requires that you install <ulink url="http://nsis.sourceforge.net/">NSIS (Nullsoft Scriptable Install System)</ulink>, a professional open source utility package used to create Windows installers (the "makensis" utility is installed as part of the "nsis" package). We recommend using Version 2.45 or later. This build will create the output file "evergreen_staff_client_setup.exe".</para>
+ <para>(OPTIONAL) If you wish for the Staff Client to have a link icon/tray icon by default, you may wish to provide a pre-modified <emphasis>xulrunner-stub.exe</emphasis>. Place it in the Staff Client source directory and <emphasis>make</emphasis> will automatically use it instead of the one that comes with the downloaded <emphasis>XULRunner</emphasis> release. The version of <emphasis>xulrunner-stub.exe</emphasis> need not match exactly.</para>
+ <para>(OPTIONAL) You can also use a tool such as <ulink url="http://www.angusj.com/resourcehacker/">Resource Hacker</ulink> to embed icons. "Resource Hacker" is an open-source utility used to view, modify, rename, add, delete and extract resources in 32bit Windows executables. See the following table for some useful icon ID strings:</para>
+ <table>
+ <title>Useful icon ID strings</title>
+ <tgroup align="left" cols="2" colsep="1" rowsep="1">
+ <colspec colnum="1" colwidth="1*"/>
+ <colspec colnum="2" colwidth="1*"/>
+ <tbody>
+ <row>
+ <entry>IDI_APPICON</entry>
+ <entry>Tray icon</entry>
+ </row>
+ <row>
+ <entry>32512</entry>
+ <entry>Default window icon</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then execute the following commands:</para>
+ <figure>
+ <title>Commands to build a Windows client</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
+ $ make win-client
+ ...
+ </screen>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Packaging a Linux Client</para>
+ <para>This build creates a Staff Client package for Linux as a "tar.bz2" file with <emphasis>XULRunner</emphasis> already bundled with it. It creates the output file "evergreen_staff_client.tar.bz2".</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then execute the following commands:</para>
+ <figure>
+ <title>Commands to build a Linux client</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
+ $ make linux-client
+ ...
+ </screen>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Packaging a Firefox Extension</para>
+ <para>This build requires that you already have the "zip" utility installed on your system. It creates a Staff Client packaged as a Firefox extension and creates the output file "evergreen.xpi".</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then execute the following commands:</para>
+ <figure>
+ <title>Commands to build a Firefox extension</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
+ $ make extension
+ ...
+ </screen>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section xml:id="serversideinstallation-staffclient-autoupdate">
+ <title>Staff Client Automatic Updates</title>
+ <para>It is possible to set up support for automatic Staff Client updates, either during the normal Evergreen server-side build process, or by manually building the Staff Client with certain special options.</para>
+ <section>
+ <title>WARNINGS</title>
+ <para>Automatic update server certificate requirements are more strict than normal server requirements. Firefox and <emphasis>XULRunner</emphasis> will both ignore any automatic update server that is not validated by a trusted certificate authority. Servers with exceptions added to force the Staff Client to accept them <emphasis>WILL NOT WORK</emphasis>.</para>
+ <para>In addition, automatic updates have special requirements for the file <emphasis>update.rdf</emphasis>:</para>
+ <orderedlist>
+ <listitem>It must be served from an SSL server, or</listitem>
+ <listitem>It must be signed with the <ulink url="https://developer.mozilla.org/en/McCoy">McCoy</ulink> tool.</listitem>
+ </orderedlist>
+ <para>You can pre-install the signing key into the file <emphasis>install.rdf</emphasis> directly, or install it into a copy as <emphasis>install.mccoy.rdf</emphasis>. If the latter exists it will be copied into the build instead of the original file <emphasis>install.rdf</emphasis>.</para>
+ </section>
+ <section>
+ <title>Autoupdate Host</title>
+ <para>The name of the automatic update host can be provided in either of two ways:</para>
+ <orderedlist>
+ <listitem>At configuration time for the normal build of the Evergreen server-side software, or</listitem>
+ <listitem>During a manual Staff Client build process.</listitem>
+ </orderedlist>
+ <para/>
+ <itemizedlist>
+ <listitem>
+ <para>At configuration time for the normal build of Evergreen server-side software</para>
+ <para>This must be done when the Evergreen server-side software is first configured (see the section <xref linkend="serversideinstallation-configure"/>). As the <emphasis role="bold">opensrf</emphasis> user, use the utility "configure" as shown:</para>
+ <figure>
+ <title>Commands to configure Evergreen</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
+ $ ./configure --prefix=/openils --sysconfdir=/openils/conf --with-updateshost=hostname
+ $ make
+ ...
+ </screen>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>During a manual Staff Client build process</para>
+ <para>You will used the variable AUTOUPDATE_HOST=hostname (see above). If you specify just a hostname (such as "example.com") then the URL will be a secure URL (such as "https://example.com". If you wish to use a non-HTTPS URL then prefix the hostname with "http://" (such as "http://example.com").</para>
+ <para>If neither option is used then, by default, the Staff Client will not include the automatic update preferences.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section>
+ <title>Building Updates</title>
+ <para>Similar to building clients, the targets "generic-updates", "win-updates", "linux-updates", and "extension-updates" can be used individually with <emphasis>make</emphasis> to build the update files for the Staff Client. To build all the targets at once, simply use the target "updates".</para>
+ <para>A "full" update will be built for each specified target (or for all if you use the target "updates"). For all but extensions any previous "full" updates (archived by default in the directory <emphasis>/openils/var/updates/archives</emphasis>) will be used to make "partial" updates. Partial updates tend to be much smaller and will thus download more quickly, but if something goes wrong with a partial update the full update will be used as a fallback. Extensions do not currently support partial updates.</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then execute the following commands:</para>
+ <figure>
+ <title>Commands for building updates</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
+
+ # command to build all updates at once:
+ $ make updates
+ ...
+
+ # commands to build updates individually:
+ $ make generic-updates
+ ...
+ $ make win-updates
+ ...
+ $ make linux-updates
+ ...
+ $ make extension-updates
+ ...
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>Building updates with clients</title>
+ <para>To save time and effort you can build updates and manual download clients at the same time by adding the string "-client" to each target name. For instance, you can specify "win-updates-client". You can also specify "updates-client" to build all the targets at once. This does not work for extension-updates.</para>
+ <para>The clients will be installed alongside the updates and listed on the "manualupdate.html" page, rather than left in the Staff Client directory.</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then execute the following commands:</para>
+ <figure>
+ <title>Commands for building updates with clients</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
+
+ # command to build all updates at once:
+ $ make updates-client
+ ...
+
+ # commands to build updates individually:
+ $ make generic-updates-client
+ ...
+ $ make win-updates-client
+ ...
+ $ make linux-updates-client
+ ...
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>Activating the Update Server</title>
+ <para>This section reviews scripts associated with the update server, and requires some final adjustments to file permissions.</para>
+ <para>The Apache example configuration creates an "updates" directory that, by default, points to the directory <emphasis>/openils/var/updates/pub</emphasis>. This directory contains one HTML file and several specially-named script files.</para>
+ <para>The "updatedetails.html" file is the fallback web page for the update details. The "check" script is used for <emphasis>XULRunner</emphasis> updates. The "update.rdf" script is used for extension updates. The "manualupdate.html" script checks for clients to provide download links when automatic updates have failed and uses the download script to force a download of the generic client XPI (compared to Firefox trying to install it as an extension).</para>
+ <para>The following scripts should be marked as executable: <emphasis>check, download, manualupdate.html, update.rdf</emphasis>. As the <emphasis role="bold">root</emphasis> user, change directory to the updates directory, then execute the following commands:</para>
+ <figure>
+ <title>Changing file permissions of scripts</title>
+ <screen>
+ $ su - root
+ $ cd /openils/var/updates/pub
+ $ chmod +x check download manualupdate.html update.rdf
+ </screen>
+ </figure>
+ </section>
+ </section>
+ <section>
+ <title>Other tips</title>
+ <section>
+ <title>Multiple workstations on one install</title>
+ <para>Multiple workstation registrations for the same server can be accomplished with a single Staff Client install by using multiple profiles. When running <emphasis>XULRunner</emphasis> you can specify the option "-profilemanager" or "-P" (uppercase "P") to force the Profile Manager to start. Unchecking the "Don't ask at startup" option will make this the default.</para>
+ <para>Once you have opened the Profile Manager you can create additional profiles, one for each workstation you wish to register. You may need to install SSL exceptions for each profile.</para>
+ <para>When building targets "win-client", "win-updates-client", or "updates-client", you can specify "NSIS_EXTRAOPTS=-DPROFILES" to add an "Evergreen Staff Client Profile Manager" option to the start menu.</para>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, change directory to the Staff Client source directory, then execute the following commands:</para>
+ <figure>
+ <title>Command to add start menu option</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client
+ $ make NSIS_EXTRAOPTS=-DPROFILES win-client
+ ...
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title> Multiple Staff Clients</title>
+ <para>This may be confusing if you are not careful, but you can log in to multiple Evergreen servers at the same time, or a single Evergreen server multiple times. In either case you will need to create an additional profile for each additional server or workstation you want to log in as (see previous tip).</para>
+ <para>Once you have created the profiles, run <emphasis>XULRunner</emphasis> with the option "-no-remote" (in addition to "-profilemanger" or "-P" if neeeded). Instead of <emphasis>XULRunner</emphasis> opening a new login window on your existing session it will start a new session instead, which can then be logged in to a different server or workstation ID.</para>
+ </section>
+ </section>
+ </simplesect>
+ </section>
+ <section xml:id="serversideinstallation-running-staffclient">
+ <title>Running the Staff Client</title>
+ <para>Run the Staff Client on a Linux system by using the application <emphasis>XULRunner</emphasis> (installed automatically and by default with Firefox version 3.0 and later on Ubuntu and Debian distributions).</para>
+ <para>For example, if the source files for the Evergreen installation are in the directory <emphasis>/home/opensrf/Evergreen-ILS-1.6.0.7/</emphasis>, start the Staff Client as shown in the following command example:</para>
+ <figure>
+ <title>Commands to run the Staff Client</title>
+ <screen>
+ $ su - opensrf
+ $ xulrunner /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client/build/application.ini
+ </screen>
+ </figure>
+ <simplesect xml:id="serversideinstallation-proxy">
+ <title>Running the Staff Client over an SSH Tunnel</title>
+ <para>The Staff Client can use an SSH tunnel as a SOCKS 5 proxy.</para>
+ <section>
+ <title>Configuring a Proxy for the Staff Client</title>
+ <para>There are several reasons for sending network traffic for the Staff Client through an SSH proxy:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Firewalls</emphasis> may prevent you from reaching the server. This may happen when you are connecting the Staff Client to a test server that should not be available generally, or it may be the result of network design priorities other than ease of use.</para>
+ </listitem>
+ <listitem>
+ <para>You may wish to <emphasis role="bold">improve security</emphasis> where Staff Client traffic may be susceptible to network eavesdropping. This is especially true when wireless is otherwise the best option for connecting a staff machine to the network.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section>
+ <title>Setting Up an SSH Tunnel</title>
+ <para>You will need a server that allows you to log in via SSH and has network access to the Evergreen server you want to reach. You will use your username and password for that SSH server to set up a tunnel.</para>
+ <para>For Windows users, one good solution is the open-source utility <ulink url="http://www.chiark.greenend.org.uk/~sgtatham/putty/">PuTTY</ulink>, a free telnet/SSH client]]. When setting up a PuTTY session:</para>
+ <figure>
+ <title>Setting up an SSH tunnel in PuTTY</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-proxy-putty.png" scalefit="1" width="70%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <orderedlist>
+ <listitem>Use the menu on the left to go to Connection > SSH > Tunnels.</listitem>
+ <listitem>Enter ''9999'' in the "Source port".</listitem>
+ <listitem>Choose "Dynamic". Do not enter anything in the Destination text entry box.</listitem>
+ <listitem>Click the "Add" button. "D9999" will now appear in the "Forwarded ports" list.</listitem>
+ <listitem>Use the menu on the left to go back to "Session", and enter the host name of the SSH server.</listitem>
+ <listitem>A window will open up so that you can enter your username and password. Once you are logged in, the tunnel is open.</listitem>
+ </orderedlist>
+ <para>See <ulink url="http://inside.mines.edu/~gmurray/HowTo/sshNotes.html">How to set up SSH (for the beginner)</ulink> for information on setting up SSH for other client operating systems,</para>
+ </section>
+ <section>
+ <title>Configuring the Staff Client to Use the SSH Tunnel</title>
+ <para>In order to tell the Staff Client that all traffic should be sent through the SSH tunnel just configured, you must edit the file <emphasis>C:\Program Files\Evergreen Staff Client\greprefs\all.js</emphasis>. Search this file for the word <emphasis role="bold">socks</emphasis> to find the appropriate section for the following changes.</para>
+ <figure>
+ <title>The SOCKS section of "all.js" before changes</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-proxy-socks-1.png" scalefit="1" width="70%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Make the following changes:</para>
+ <itemizedlist>
+ <listitem>Change the value of <emphasis>network.proxy.socks</emphasis> from <emphasis role="bold">""</emphasis> to <emphasis role="bold">"localhost"</emphasis>.</listitem>
+ <listitem>Change the value of <emphasis>network.proxy.socks_port</emphasis> from <emphasis role="bold">"0"</emphasis> to <emphasis role="bold">9999</emphasis>.</listitem>
+ </itemizedlist>
+ <figure xml:id="serversideinstallation-socks-figure">
+ <title>The SOCKS section of "all.js" after changes</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../media/serversideinstallation-proxy-socks-2.png" scalefit="1" width="70%"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>If everything is working correctly, you should now be able to run the Staff Client and all its data will be sent encrypted through the SSH tunnel you have just configured.</para>
+ </section>
+ </simplesect>
+ </section>
+</chapter>
projects / Evergreen-DocBook.git / commitdiff