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