and errors.</para>\r
</simplesect>\r
</section>\r
+ <section xml:id="InstallingPostgreSQL">\r
+ <title>Installing PostgreSQL from Source</title>\r
+ <para>Some <systemitem class="osname">Linux</systemitem> distributions, such as <systemitem class="osname">Debian Etch (4.0)</systemitem>, do not offer PostgreSQL \r
+ version 8.2 as an installable package. Before you continue, examine the software dependencies listed in <xref linkend="serversideinstall-software-dependencies"/> \r
+ to ensure that your Linux distribution supports the required version of PostgreSQL.</para>\r
+\r
+ <note>\r
+ <para>Some <systemitem class="osname">Linux</systemitem> distributions, such as <systemitem class="osname">Debian Etch (4.0)</systemitem>, do not offer PostgreSQL \r
+ version 8.2 as an installable package. Before you continue, examine the software dependencies listed in <xref linkend="serversideinstall-software-dependencies"/> \r
+ to ensure that your Linux distribution supports the required version of PostgreSQL.</para>\r
+ </note>\r
+ \r
+ <procedure>\r
+ <step>\r
+ <para>Install the application <application>stow</application> on your system if it is not already installed. Issue the following command as \r
+ the <systemitem class="username">root</systemitem> user:</para>\r
+ \r
+ <title>Installing <application>stow</application></title>\r
+ <screen>\r
+ $ apt-get install stow\r
+ ...\r
+ </screen>\r
+ </step>\r
+ <step>\r
+ <para>Download, compile, and install the latest release for PostgreSQL 8.2 (which was version <literal>8.2.12</literal> at the time of this writing). \r
+ As the <systemitem class="username">root</systemitem> user, follow these steps:</para>\r
+ <figure>\r
+ <title>Installing PostgreSQL</title>\r
+ <screen>\r
+ $ wget http://wwwmaster.postgresql.org/redir/198/h/source/v8.2.17/postgresql-8.2.17.tar.bz2\r
+ $ tar xzf postgresql-8.2.17.tar.gz\r
+ $ cd postgresql-8.2.17\r
+ $ ./configure --with-perl --enable-integer-datetimes --with-openssl --prefix=/usr/local/stow/pgsql\r
+ ...\r
+ $ make\r
+ ...\r
+ $ make install\r
+ ...\r
+ $ cd contrib\r
+ $ make\r
+ ...\r
+ $ make install\r
+ $ cd xml2\r
+ $ make\r
+ ...\r
+ $ make install\r
+ $ cd /usr/local/stow\r
+ $ stow pgsql\r
+ </screen>\r
+ </figure>\r
+ </step>\r
+ <step>\r
+ <para>Create the new user <systemitem class="username">postgres</systemitem> to run the PostgreSQL processes. \r
+ As the <systemitem class="username">root</systemitem> user, execute this command:</para>\r
+ <figure>\r
+ <title>Adding <systemitem class="username">postgres</systemitem></title>\r
+ <screen>\r
+ $ adduser postgres\r
+ </screen>\r
+ </figure>\r
+ </step>\r
+ <step>\r
+ <para>Initialize the database directory and start up PostgreSQL. As the <systemitem class="username">root</systemitem> user, follow these steps:</para>\r
+ <figure>\r
+ <title>Adding <systemitem class="username">postgres</systemitem></title>\r
+ <screen>\r
+ $ mkdir -p /usr/local/pgsql/data\r
+ $ chown postgres /usr/local/pgsql/data\r
+ $ su - postgres\r
+ $ initdb -D /usr/local/pgsql/data -E UNICODE --locale=C\r
+ $ pg_ctl -D /usr/local/pgsql/data -l /home/postgres/logfile start\r
+ </screen>\r
+ </figure>\r
+ <note>\r
+ <para>If an error occurs during the final step above, review the path of the home directory for the \r
+ <systemitem class="username">postgres</systemitem> user. It may be <literal>/var/lib/postresql</literal> instead of <literal>/home/postres</literal>.</para>\r
+ </note>\r
+ </step>\r
+ </procedure>\r
+ </section>\r
+ <section xml:id="configuringPostgreSQL">\r
+ <title>Configuring PostgreSQL</title>\r
+ <para>The values of several PostreSQL configuration parameters may be changed for enhanced performance. The following table lists the default values \r
+ and some suggested updates for several useful parameters:</para>\r
+ <table>\r
+ <title>Suggested configuration values</title>\r
+ <tgroup align="left" cols="3" colsep="1" rowsep="1">\r
+ <colspec colnum="1" colwidth="1.0*"/>\r
+ <colspec colnum="2" colwidth="1.0*"/>\r
+ <colspec colnum="3" colwidth="1.0*"/>\r
+ <thead>\r
+ <row>\r
+ <entry>Parameter</entry>\r
+ <entry>Default</entry>\r
+ <entry>Suggested</entry>\r
+ </row>\r
+ </thead>\r
+ <tbody>\r
+ <row>\r
+ <entry>default_statistics_target</entry>\r
+ <entry>10</entry>\r
+ <entry>100</entry>\r
+ </row>\r
+ <row>\r
+ <entry>work_mem</entry>\r
+ <entry>4Mb</entry>\r
+ <entry>128Mb</entry>\r
+ </row>\r
+ <row>\r
+ <entry>shared_buffers</entry>\r
+ <entry>8Mb</entry>\r
+ <entry>512Mb</entry>\r
+ </row>\r
+ <row>\r
+ <entry>effective_cache_size</entry>\r
+ <entry>128Mb</entry>\r
+ <entry>4Gb</entry>\r
+ </row>\r
+ </tbody>\r
+ </tgroup>\r
+ </table>\r
+ </section>\r
</chapter>\r
--- /dev/null
+<?xml version='1.0' encoding='UTF-8'?>\r
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"\r
+ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serversideinstallation-previousversions">\r
+\r
+ <title>Installing Previous Versions of Evergreen</title>\r
+ <para>Earlier releases of Evergreen are available. Instructions for installing, configuring and testing earlier versions are found below.</para>\r
+ <para>The next most recent previous release of Evergreen is version <emphasis><emphasis role="bold">1.4.0.6</emphasis></emphasis>. The accompanying previous release of OpenSRF \r
+ is version <emphasis><emphasis role="bold">1.0.7</emphasis></emphasis>.</para>\r
+ <section xml:id="serversideinstallation-evergreen-previous">\r
+ <title>Installing Evergreen 1.4.0.6 On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem></title>\r
+ <para>This section outlines the installation process for the previous version 1.4.0.6 of Evergreen.</para>\r
+ <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>\r
+ <note>\r
+ <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>\r
+ <para>If you are starting with a clean install of <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem>, you are strongly recommended <emphasis role="bold">not</emphasis> to install the packaged PostgreSQL server. This can confuse port numbers and system configuration. Evergreen 1.4 requires PostgreSQL 8.2.</para>\r
+ </note>\r
+ <section>\r
+ <title>Installing OpenSRF 1.0.7</title>\r
+ <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-previous"/>.</para>\r
+ <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>\r
+ </section>\r
+ <section>\r
+ <title>Download and Unpack Evergreen Version 1.4.0.6</title>\r
+ <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.4.0.6.tar.gz"></ulink></para>\r
+ <figure>\r
+ <title>Commands to download and unpack Evergreen</title>\r
+ <screen>\r
+ $ su - opensrf\r
+ $ wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.4.0.6.tar.gz\r
+ $ tar zxf Evergreen-ILS-1.4.0.6.tar.gz\r
+ </screen>\r
+ </figure>\r
+ <para>The new directory <filename class="directory">/home/opensrf/Evergreen-ILS-1.4.0.6</filename> will be created.</para>\r
+ </section>\r
+ <section>\r
+ <title>Install Prerequisites to Build Evergreen</title>\r
+ <para>In this section you will install and configure a set of prerequisites that will be used to build Evergreen. In a following step you will actually build the software using the <command>make</command> utility.</para>\r
+ <para>As the <systemitem class="username">root</systemitem> user, enter the commands show below to build the prerequisites from the software distribution that you just downloaded and unpacked. Remember to replace <emphasis>[distribution]</emphasis> in the example with the keyword corresponding to the actual <systemitem class="osname">Linux</systemitem> distribution listed in the <link linkend="serversideinstallation-keywords-figure-2-a">"Keywords"</link> figure below.</para>\r
+ <figure>\r
+ <title>Commands to install prerequisites for Evergreen</title>\r
+ <screen>\r
+ $ su - root\r
+ $ cd /home/opensrf/Evergreen-ILS-1.4.0.6\r
+ $ make -f Open-ILS/src/extras/Makefile.install [distribution]\r
+ ...\r
+ </screen>\r
+ </figure>\r
+ <table xml:id="serversideinstallation-keywords-figure-2-a">\r
+ <title>Keywords Targets for <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-lenny</entry>\r
+ <entry>for Debian Lenny (5.0)</entry>\r
+ </row>\r
+ <row>\r
+ <entry>debian-etch</entry>\r
+ <entry>for Debian Etch (4.0)</entry>\r
+ </row>\r
+ <row>\r
+ <entry>ubuntu-intrepid</entry>\r
+ <entry>for Ubuntu Intrepid (8.10)</entry>\r
+ </row>\r
+ <row>\r
+ <entry>ubuntu-hardy</entry>\r
+ <entry>for Ubuntu Hardy (8.04)</entry>\r
+ </row>\r
+ </tbody>\r
+ </tgroup>\r
+ </table>\r
+ </section>\r
+ <section>\r
+ <title>Update the System Dynamic Library Path</title>\r
+ <para>As the <systemitem class="username">root</systemitem> user, you must update the system dynamic library path to make your system recognize the newly installed libraries. Do this by creating the new file <filename>/etc/ld.so.conf.d/eg.conf</filename> containing two new library paths, then run the command <command>ldconfig</command> to automatically read the file and modify the system dynamic library path:</para>\r
+ <figure>\r
+ <title>Commands to modify system dynamic library path</title>\r
+ <screen>\r
+ $ su - root\r
+ $ cat > /etc/ld.so.conf.d/eg.conf << ENDOFFILE\r
+ /usr/local/lib\r
+ /usr/local/lib/dbd\r
+ ENDOFFILE\r
+ $ ldconfig\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Restart the PostgreSQL Server</title>\r
+ <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 the PostgreSQL server to avoid a problem where the library <filename>plperl.so</filename> cannot be found. If your PostgreSQL server is running on another system, just skip this step.</para>\r
+ <figure>\r
+ <title>Commands to restart PostgreSQL server</title>\r
+ <screen>\r
+ $ su - root\r
+ $ /etc/init.d/postgresql-8.2 restart\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Configure Evergreen</title>\r
+ <para>As the <systemitem class="username">opensrf</systemitem> user, return to the Evergreen build directory and use the <command>configure</command> utility to prepare for the next step of compiling and linking the software:</para>\r
+ <figure>\r
+ <title>Commands to configure Evergreen</title>\r
+ <screen>\r
+ $ su - opensrf\r
+ $ cd /home/opensrf/Evergreen-ILS-1.4.0.6\r
+ $ ./configure --prefix=/openils --sysconfdir=/openils/conf\r
+ $ make\r
+ ...\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Compile, Link and Install Evergreen</title>\r
+ <para>In this step you will actually compile, link and install Evergreen and the default Evergreen Staff Client.</para>\r
+ <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>\r
+ <para>For further information on manually building the Staff Client, see <xref linkend="serversideinstallation-building-staffclient"/>.</para>\r
+ <figure>\r
+ <title>Commands to build, link and install Evergreen</title>\r
+ <screen>\r
+ $ su - root\r
+ $ cd /home/opensrf/Evergreen-ILS-1.4.0.6\r
+ $ make STAFF_CLIENT_BUILD_ID=rel_1_4_0_6 install\r
+ ...\r
+ </screen>\r
+ <para>The above commands will create a new subdirectory <filename class="directory">/openils/var/web/xul/rel_1_4_0_6</filename> containing the Staff Client.</para>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Copy the OpenSRF Configuration Files</title>\r
+ <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>\r
+ <figure>\r
+ <title>Commands to copy OpenSRF configuration files</title>\r
+ <screen>\r
+ $ su - root\r
+ $ cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml\r
+ $ cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml\r
+ $ chown -R opensrf:opensrf /openils/\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Create and Configure PostgreSQL Database</title>\r
+ <para>As the <systemitem class="username">postgres</systemitem> user on your PostgreSQL server, create the Evergreen database.</para>\r
+ <para>In the commands below, remember to adjust the path of the <emphasis role="bold">contrib</emphasis> repository to match your PostgreSQL server layout. For example, if you built PostgreSQL from source the path would be <filename class="directory">/usr/local/share/contrib</filename>; if you installed the PostgreSQL 8.2 server packages on <systemitem class="osname">Ubuntu 8.04</systemitem>, the path would be <filename class="directory">/usr/share/postgresql/8.2/contrib/</filename>.</para>\r
+ <procedure>\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> user on the PostgreSQL system create the PostgreSQL database, then set some internal paths:</para>\r
+ <figure>\r
+ <title>Commands to create database and adjust the path</title>\r
+ <screen>\r
+ # create the database\r
+ $ su - postgres\r
+ $ createdb -E UNICODE evergreen\r
+ $ createlang plperl evergreen\r
+ $ createlang plperlu evergreen\r
+ $ createlang plpgsql evergreen\r
+ \r
+ # adjust the paths\r
+ $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tablefunc.sql evergreen\r
+ $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tsearch2.sql evergreen\r
+ $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/pgxml.sql evergreen\r
+ </screen>\r
+ </figure>\r
+ <emphasis>Where <literal>PGSQL_VERSION</literal> is your installed PostgreSQL version (e.g. <literal>8.2</literal>).</emphasis>\r
+ </step>\r
+ <step>\r
+ <para>\r
+ <emphasis role="bold">Create new Evergreen superuser</emphasis>\r
+ </para>\r
+ <para>As the <systemitem class="username">postgres</systemitem> user on the PostgreSQL system, create the \r
+ new database <systemitem class="username">evergreen</systemitem> user and assign a password:</para>\r
+<screen>\r
+# create superuser 'evergreen' and set the password\r
+<userinput>su - postgres</userinput>\r
+<userinput>createuser -P -s evergreen</userinput>\r
+<prompt>Enter password for new role:</prompt> <userinput>MYNEWPASSWORD</userinput>\r
+<prompt>Enter it again:</prompt><userinput>MYNEWPASSWORD</userinput>\r
+</screen>\r
+ <emphasis>Where <literal>MYNEWPASSWORD</literal> is the password chosen.</emphasis>\r
+ </step>\r
+ </procedure>\r
+ </section>\r
+ <section>\r
+ <title>Create Database Schema</title>\r
+ <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>\r
+ <para>Enter the following commands and replace <emphasis>HOSTNAME, PORT, PASSWORD</emphasis> and <emphasis>DATABASENAME</emphasis> with appropriate values.</para>\r
+ <figure>\r
+ <title>Commands to create Evergreen database schema</title>\r
+ <screen>\r
+ $ su - root\r
+ $ cd /home/opensrf/Evergreen-ILS-1.4.0.6\r
+ $ perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \\r
+ --service all --create-schema --create-bootstrap --create-offline \\r
+ --hostname HOSTNAME --port PORT \\r
+ --user evergreen --password PASSWORD --database DATABASENAME\r
+ </screen>\r
+ </figure>\r
+ <emphasis>Where, 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 those assigned when PostgreSQL was installed in the previous step.</emphasis>\r
+ <note>\r
+ <para>\r
+ <emphasis>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.</emphasis>\r
+ </para>\r
+ </note>\r
+ </section>\r
+ <section>\r
+ <title>Evergreen installation - (continued)</title>\r
+ <para><emphasis>The remainder of the Evergreen installation procedure is identical to that for installing the latest version of Evergreen. Continue with the instructions found in</emphasis> <xref linkend="serversideinstallation-modify-apache"/>.</para>\r
+ </section>\r
+ </section>\r
+ <section xml:id="serversideinstallation-opensrf-previous">\r
+ <title>Installing OpenSRF 1.0.7 On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem></title>\r
+ <para>This section describes the installation of the previous 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>\r
+ <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>\r
+ <note>\r
+ <para>The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) platforms. OpenSRF 1.0.7 has been tested on <systemitem class="osname">Debian Etch (4.0)</systemitem>, <systemitem class="osname">Debian Lenny</systemitem>, <systemitem class="osname">Ubuntu Hardy Heron (8.04)</systemitem>, and <systemitem class="osname">Ubuntu Intrepid Ibex (8.10)</systemitem>.</para>\r
+ <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>\r
+ <itemizedlist>\r
+ <listitem><systemitem class="osname">Debian</systemitem> -- To become the <systemitem class="username">root</systemitem> user, issue the command <command>su -</command> and enter the password of the <systemitem class="username">root</systemitem> user.</listitem>\r
+ <listitem><systemitem class="osname">Ubuntu</systemitem> -- To become the <systemitem class="username">root</systemitem> user, issue the command <command>sudo su -</command> and enter the password of the <systemitem class="username">root</systemitem> user.</listitem>\r
+ </itemizedlist>\r
+ <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>\r
+ </note>\r
+ <section>\r
+ <title>Add the OpenSRF User</title>\r
+ <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>\r
+ <figure>\r
+ <title>Commands to add <systemitem class="username">opensrf</systemitem> user</title>\r
+ <screen>\r
+ $ su - opensrf\r
+ $ useradd -m -s /bin/bash opensrf\r
+ $ passwd opensrf\r
+ Enter new UNIX password: ******\r
+ Retype new UNIX password: ******\r
+ passwd: password updated successfully\r
+ $\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Download and Unpack Latest OpenSRF Version</title>\r
+ <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.0.7.tar.gz"></ulink></para>\r
+ <figure>\r
+ <title>Commands to download and unpack OpenSRF</title>\r
+ <screen>\r
+ $ su - opensrf\r
+ $ wget http://evergreen-ils.org/downloads/OpenSRF-1.0.7.tar.gz\r
+ $ tar zxf OpenSRF-1.0.7.tar.gz\r
+ </screen>\r
+ </figure>\r
+ <para>The new directory <filename class="directory">/home/opensrf/OpenSRF-1.0.7</filename> will be created.</para>\r
+ </section>\r
+ <section>\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 used to build OpenSRF. In a following step you will actually build the software using the <command>make</command> utility.</para>\r
+ <para>As the <systemitem class="username">root</systemitem> user, enter the commands show below to build the prerequisites from the software distribution that you just downloaded and unpacked. Remember to replace <emphasis>[DISTRIBUTION]</emphasis> in the example with the keyword corresponding to the actual <systemitem class="osname">Linux</systemitem> distribution listed in the <link linkend="serversideinstallation-keywords-figure-1a">"Keywords"</link> figure below.</para>\r
+ <figure>\r
+ <title>Commands to install prerequisites for OpenSRF</title>\r
+ <screen>\r
+ $ su - root\r
+ $ cd /home/opensrf/OpenSRF-1.0.7\r
+ $ make -f src/extras/Makefile.install [DISTRIBUTION]\r
+ ...\r
+ </screen>\r
+ </figure>\r
+ <table xml:id="serversideinstallation-keywords-figure-1a">\r
+ <title>Keywords Targets for <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-lenny</entry>\r
+ <entry>for Debian Lenny (5.0)</entry>\r
+ </row>\r
+ <row>\r
+ <entry>debian-etch</entry>\r
+ <entry>for Debian Etch (4.0)</entry>\r
+ </row>\r
+ <row>\r
+ <entry>ubuntu-intrepid</entry>\r
+ <entry>for Intrepid (8.10)</entry>\r
+ </row>\r
+ <row>\r
+ <entry>ubuntu-hardy</entry>\r
+ <entry>for Ubuntu Hardy (8.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, 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>\r
+ </section>\r
+ <section>\r
+ <title>Configure OpenSRF</title>\r
+ <para>As the <systemitem class="username">opensrf</systemitem> user, return to the OpenSRF build directory and use the <command>configure</command> utility to prepare for the next step of compiling and linking the software. You can include the <option>--enable-python</option> and <option>--enable-java</option> configuration options if you wish to include support for Python and Java, respectively:</para>\r
+ <figure>\r
+ <title>Commands to configure OpenSRF</title>\r
+ <screen>\r
+ $ su - opensrf\r
+ $ cd /home/opensrf/OpenSRF-1.0.7\r
+ $ ./configure --prefix=/openils --sysconfdir=/openils/conf\r
+ $ make\r
+ ...\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Compile, Link and Install OpenSRF</title>\r
+ <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>\r
+ <figure>\r
+ <title>Commands to build, link and install OpenSRF</title>\r
+ <screen>\r
+ $ su - opensrf\r
+ $ cd /home/opensrf/OpenSRF-1.0.7\r
+ $ make install\r
+ ...\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Update the System Dynamic Library Path</title>\r
+ <para>As the <systemitem class="username">root</systemitem> user, you must update the system dynamic library path to make your system recognize the newly installed libraries. Do this by creating the new file <filename>/etc/ld.so.conf.d/osrf.conf</filename> containing a new library path, then run the command <command>ldconfig</command> to automatically read the file and modify the system dynamic library path:</para>\r
+ <figure>\r
+ <title>Commands to modify system dynamic library path</title>\r
+ <screen>\r
+ $ su - root\r
+ $ echo "/openils/lib" > /etc/ld.so.conf.d/osrf.conf\r
+ $ ldconfig\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Define Public and Private OpenSRF Domains</title>\r
+ <para>Define your public and private OpenSRF domains. For security purposes, OpenSRF uses Jabber domains to separate services into public and private realms. Throughout these instructions, we will use the example domains <systemitem class="domainname">public.localhost</systemitem> for the public domain and <systemitem class="domainname">private.localhost</systemitem> for the private domain. On a single-server system, the easiest way to define public and private domains is to define separate host names by adding entries to the file <filename>/etc/hosts</filename>.</para>\r
+ <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>\r
+ <figure>\r
+ <title>Example public and private domains in /etc/hosts</title>\r
+ <screen>\r
+ 127.0.1.2 public.localhost public\r
+ 127.0.1.3 private.localhost private\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Change File Ownerships</title>\r
+ <para>As the <systemitem class="username">root</systemitem> user, change the ownership of files installed in the directory <filename class="directory">/openils</filename> to the <systemitem class="username">opensrf</systemitem> user:</para>\r
+ <figure>\r
+ <title>Commands to change file ownerships</title>\r
+ <screen>\r
+ $ chown -R opensrf:opensrf /openils\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Stop the <systemitem class="service">ejabberd</systemitem> Service</title>\r
+ <para>As the <systemitem class="username">root</systemitem> user, stop the <systemitem class="service">ejabberd</systemitem> service:</para>\r
+ <figure>\r
+ <title>Commands to stop the <systemitem class="service">ejabberd</systemitem> service</title>\r
+ <screen>\r
+ $ /etc/init.d/ejabberd stop\r
+ </screen>\r
+ </figure>\r
+ <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>\r
+ <figure>\r
+ <title>Commands to recover from <systemitem class="service">ejabberd</systemitem> errors</title>\r
+ <screen>\r
+ $ su - root\r
+ $ epmd -kill\r
+ $ killall beam; killall beam.smp\r
+ $ rm /var/lib/ejabberd/*\r
+ $ echo 'ERLANG_NODE=ejabberd@localhost' >> /etc/default/ejabberd\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Edit the <systemitem class="service">ejabberd</systemitem> configuration</title>\r
+ <para>As the <systemitem class="username">root</systemitem> user, edit the file <filename>/etc/ejabberd/ejabberd.cfg</filename> and make the following changes:</para>\r
+ <itemizedlist>\r
+ <listitem>Change <literal>{hosts, ["localhost"]}.</literal> to <literal>{hosts, ["localhost", "private.localhost", "public.localhost"]}.</literal></listitem>\r
+ <listitem>Change <literal>{max_user_sessions, 10}.</literal> to <literal>{max_user_sessions, 1000}.</literal> If you see something like this instead: <literal>{access, max_user_sessions, [{10, all}]}.</literal>, then change it to <literal>{access, max_user_sessions, [{1000, all}]}.</literal></listitem>\r
+ <listitem>Change all three occurrences of <literal>max_stanza_size</literal> to <literal>2000000</literal>.</listitem>\r
+ <listitem>Change both occurrences of <literal>maxrate</literal> to <literal>500000</literal>.</listitem>\r
+ <listitem>Comment out the line <literal>{mod_offline, []}</literal> by placing two <literal>%</literal> comment signs in front.</listitem>\r
+ </itemizedlist>\r
+ </section>\r
+ <section>\r
+ <title>OpenSRF installation - (continued)</title>\r
+ <para>\r
+ <emphasis>The remainder of the OpenSRF installation procedure is identical to that for installing the latest version of OpenSRF. Continue with the instructions found in <xref linkend="serversideinstallation-opensrf-continued"/>.</emphasis>\r
+ </para>\r
+ </section>\r
+ </section>\r
+ </section>\r
+ <section xml:id="serversideinstallation-postgresql">\r
+ <title>Installing PostgreSQL</title>\r
+ <para>In production Evergreen systems, the PostgreSQL database server may reside on the same system on which Evergreen is installed or on another standalone system so, by default, PostgreSQL is not automatically installed along with Evergreen. This section details the steps needed to manually install PostgreSQL on a <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> system.</para>\r
+ <para>If your PostgreSQL server will be on the same system as your Evergreen software, return to the previous section <xref linkend="serversideinstallation-postgresql-default"/> and follow those instructions. Otherwise, to manually install PostgreSQL on a system, continue with the instructions below.</para>\r
+ <note>\r
+ <para>Some <systemitem class="osname">Linux</systemitem> distributions, such as <systemitem class="osname">Debian Etch (4.0)</systemitem>, do not offer PostgreSQL version 8.2 as an installable package. Before you continue, examine the software dependencies listed in <xref linkend="serversideinstall-software-dependencies"/> to ensure that your Linux distribution supports the required version of PostgreSQL.</para>\r
+ </note>\r
+ <procedure>\r
+ <step>\r
+ <para>Install the application <application>"stow"</application> on your system if it is not already installed. Issue the following command as the <systemitem class="username">root</systemitem> user:</para>\r
+ <figure>\r
+ <title>Installing <application>"stow"</application></title>\r
+ <screen>\r
+ $ apt-get install stow\r
+ ...\r
+ </screen>\r
+ </figure>\r
+ </step>\r
+ <step>\r
+ <para>Download, compile, and install the latest release for PostgreSQL 8.2 (which was version <literal>8.2.12</literal> at the time of this writing). As the <systemitem class="username">root</systemitem> user, follow these steps:</para>\r
+ <figure>\r
+ <title>Installing PostgreSQL</title>\r
+ <screen>\r
+ $ wget http://wwwmaster.postgresql.org/redir/198/h/source/v8.2.17/postgresql-8.2.17.tar.bz2\r
+ $ tar xzf postgresql-8.2.17.tar.gz\r
+ $ cd postgresql-8.2.17\r
+ $ ./configure --with-perl --enable-integer-datetimes --with-openssl --prefix=/usr/local/stow/pgsql\r
+ ...\r
+ $ make\r
+ ...\r
+ $ make install\r
+ ...\r
+ $ cd contrib\r
+ $ make\r
+ ...\r
+ $ make install\r
+ $ cd xml2\r
+ $ make\r
+ ...\r
+ $ make install\r
+ $ cd /usr/local/stow\r
+ $ stow pgsql\r
+ </screen>\r
+ </figure>\r
+ </step>\r
+ <step>\r
+ <para>Create the new user <systemitem class="username">postgres</systemitem> to run the PostgreSQL processes. As the <systemitem class="username">root</systemitem> user, execute this command:</para>\r
+ <figure>\r
+ <title>Adding <systemitem class="username">postgres</systemitem></title>\r
+ <screen>\r
+ $ adduser postgres\r
+ </screen>\r
+ </figure>\r
+ </step>\r
+ <step>\r
+ <para>Initialize the database directory and start up PostgreSQL. As the <systemitem class="username">root</systemitem> user, follow these steps:</para>\r
+ <figure>\r
+ <title>Adding <systemitem class="username">postgres</systemitem></title>\r
+ <screen>\r
+ $ mkdir -p /usr/local/pgsql/data\r
+ $ chown postgres /usr/local/pgsql/data\r
+ $ su - postgres\r
+ $ initdb -D /usr/local/pgsql/data -E UNICODE --locale=C\r
+ $ pg_ctl -D /usr/local/pgsql/data -l /home/postgres/logfile start\r
+ </screen>\r
+ </figure>\r
+ <note>\r
+ <para>If an error occurs during the final step above, review the path of the home directory for the <systemitem class="username">postgres</systemitem> user. It may be <literal>/var/lib/postresql</literal> instead of <literal>/home/postres</literal>.</para>\r
+ </note>\r
+ </step>\r
+ <step>\r
+ <para>The values of several PostreSQL configuration parameters may be changed for enhanced performance. The following table lists the default values and some suggested updates for several useful parameters:</para>\r
+ <table>\r
+ <title>Suggested configuration values</title>\r
+ <tgroup align="left" cols="3" colsep="1" rowsep="1">\r
+ <colspec colnum="1" colwidth="1.0*"/>\r
+ <colspec colnum="2" colwidth="1.0*"/>\r
+ <colspec colnum="3" colwidth="1.0*"/>\r
+ <thead>\r
+ <row>\r
+ <entry>Parameter</entry>\r
+ <entry>Default</entry>\r
+ <entry>Suggested</entry>\r
+ </row>\r
+ </thead>\r
+ <tbody>\r
+ <row>\r
+ <entry>default_statistics_target</entry>\r
+ <entry>10</entry>\r
+ <entry>100</entry>\r
+ </row>\r
+ <row>\r
+ <entry>work_mem</entry>\r
+ <entry>4Mb</entry>\r
+ <entry>128Mb</entry>\r
+ </row>\r
+ <row>\r
+ <entry>shared_buffers</entry>\r
+ <entry>8Mb</entry>\r
+ <entry>512Mb</entry>\r
+ </row>\r
+ <row>\r
+ <entry>effective_cache_size</entry>\r
+ <entry>128Mb</entry>\r
+ <entry>4Gb</entry>\r
+ </row>\r
+ </tbody>\r
+ </tgroup>\r
+ </table>\r
+ <indexterm>\r
+ <primary>ZZZ-REVIEW</primary>\r
+ <secondary>ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS</secondary>\r
+ </indexterm>\r
+ <caution>ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS </caution>\r
+ </step>\r
+ </procedure>\r
+ </section>\r
+ <section xml:id="serversideinstallation-apache">\r
+ <title>Installing Apache</title>\r
+ <section>\r
+ <title>Securing Apache (httpd)</title>\r
+ <para>The main consideration is to secure the directory <filename class="directory">cgi-bin</filename>. The only persons that need access to this directory are Evergreen system administrators. This directory should be restricted by both IP (to those workstations designated as Evergeen Administration systems), and by username/password.</para>\r
+ <indexterm>\r
+ <primary>ZZZ-REVIEW</primary>\r
+ <secondary>ADD CONTENT ON HOW TO RESTRICT APACHE BY IP AND USERNAME/PASSWORD </secondary>\r
+ </indexterm>\r
+ <caution>ADD CONTENT ON HOW TO RESTRICT APACHE BY IP AND USERNAME/PASSWORD </caution>\r
+ <para>A user could add new libraries, re-arrange consortia, or change user groups; or a staff member could access the directory, and change his associated security group to administrative level privileges.</para>\r
+ </section>\r
+ <indexterm>\r
+ <primary>ZZZ-REVIEW</primary>\r
+ <secondary>ADD MORE CONTENT FOR APACHE </secondary>\r
+ </indexterm>\r
+ <caution>ADD MORE CONTENT FOR APACHE </caution>\r
+ </section>\r
+ </chapter>\r
of the software is straightforward if you follow some simple directions.</para>\r
</abstract>\r
</info>\r
- <section xml:id="serversideinstallation-overview">\r
<para>Installing, configuring and testing the Evergreen server-side software is straightforward with the current stable software release. See \r
<xref linkend="serversideinstallation-all"/> for instructions tailored to installing on some particular distributions of the <systemitem class="osname">Linux</systemitem> \r
operating system. Earlier software distributions are described in <xref linkend="serversideinstallation-previousversions"/>.</para>\r
<systemitem class="osname">Linux</systemitem> environment). It can also be installed to run on other <systemitem class="osname">Linux</systemitem> systems via virtualized \r
environments (using, for example, <application>"VirtualBox"</application> or <application>"VMware"</application>). More information on virtualized environments can be \r
found in <xref linkend="serversideinstallation-virtual"/>.</para>\r
- <para>Installation of some sub-components of the Evergreen server-side software is mentioned only in abbreviated form in this section. More detailed information \r
- is available in <xref linkend="serversideinstallation-postgresql"/> and <xref linkend="serversideinstallation-apache"/>.</para>\r
- <para>Finally, installation of the Evergreen Staff Client software is reviewed in <xref linkend="serversideinstallation-staffclient"/>. </para>\r
- <simplesect>\r
- <title>Evergreen Software Dependencies</title>\r
+ <para>Installation of the Evergreen Staff Client software is reviewed in <xref linkend="serversideinstallation-staffclient"/>. </para>\r
<para>The Evergreen server-side software has dependencies on particular versions of certain major software sub-components. Successful installation of Evergreen \r
software requires that software versions agree with those listed here:</para>\r
<table xml:id="serversideinstall-software-dependencies">\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
- </simplesect> \r
- <simplesect>\r
- <title>Current Stable Software Release</title>\r
- <para>The current stable release of Evergreen is version <emphasis><emphasis role="bold">1.6.0.7</emphasis></emphasis>. Instructions for installing, configuring \r
- and testing that version on the <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> \r
- <systemitem class="osname">Linux</systemitem> systems are found in <xref linkend="serversideinstallation-ubuntudebian"/>.</para>\r
- <para>This release of Evergreen software is dependent on the Open Service Request Framework (OpenSRF). The current stable release of OpenSRF is \r
- version <emphasis><emphasis role="bold">1.2.2</emphasis></emphasis>. Instructions for installing, configuring and testing that version are found in \r
- <xref linkend="serversideinstallation-opensrf"/>.</para>\r
- </simplesect>\r
- <simplesect>\r
- <title>Previous Software Releases</title>\r
- <para>Earlier releases of Evergreen are also available. Instructions for installing, configuring and testing earlier versions are found in \r
- <xref linkend="serversideinstallation-previousversions"/>.</para>\r
- <para>The next most recent previous release of Evergreen is version <emphasis><emphasis role="bold">1.4.0.6</emphasis></emphasis>. Instructions for installing, configuring \r
- and testing that version are found in <xref linkend="serversideinstallation-evergreen-previous"/>.</para>\r
- <para>The accompanying previous release of OpenSRF is version <emphasis><emphasis role="bold">1.0.7</emphasis></emphasis>. Instructions for installing, configuring and testing \r
- that version are found in <xref linkend="serversideinstallation-opensrf-previous"/>.</para>\r
- </simplesect>\r
- </section>\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 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 \r
<command>/bin/bash</command> to inherit a reasonable environment:</para>\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>useradd -m -s /bin/bash opensrf</userinput>\r
<userinput>passwd opensrf</userinput>\r
</screen>\r
<para>As the <systemitem class="username">opensrf</systemitem> user, download and extract the latest version of OpenSRF. The latest version can be found here: \r
<ulink url="http://evergreen-ils.org/downloads/OpenSRF-1.2.2.tar.gz"></ulink></para>\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>wget http://evergreen-ils.org/downloads/OpenSRF-1.2.2.tar.gz</userinput>\r
<userinput>tar zxf OpenSRF-1.2.2.tar.gz</userinput>\r
</screen> \r
<systemitem class="osname">Linux</systemitem> distribution listed in the <link linkend="serversideinstallation-keywords-opensrf">distribution \r
keywords</link>table.</para>\r
<screen>\r
-<userinput>su - root</userinput>\r
<userinput>cd /home/opensrf/OpenSRF-1.2.2</userinput>\r
<userinput>make -f src/extras/Makefile.install [DISTRIBUTION]</userinput>\r
</screen>\r
utility to prepare for the next step of compiling and linking the software. You can include the <option>--enable-python</option> and \r
<option>--enable-java</option> configuration options if you wish to include support for Python and Java, respectively:</para>\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>cd /home/opensrf/OpenSRF-1.2.2</userinput>\r
<userinput>./configure --prefix=/openils --sysconfdir=/openils/conf</userinput>\r
<userinput>make</userinput>\r
<para>As the <systemitem class="username">root</systemitem> user, return to the OpenSRF build directory and use the <command>make</command> utility to compile, \r
link and install OpenSRF:</para> \r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>cd /home/opensrf/OpenSRF-1.2.2</userinput>\r
<userinput>make install</userinput>\r
</screen>\r
command <command>ldconfig</command> to automatically read the file and modify the system dynamic library path:</para>\r
\r
<screen>\r
-<userinput>su - root</userinput>\r
<userinput>echo "/openils/lib" > /etc/ld.so.conf.d/osrf.conf</userinput>\r
<userinput>ldconfig</userinput>\r
</screen>\r
<systemitem class="daemon">epmd</systemitem> processes, then edit the configuration file <filename>/etc/ejabberd/ejabberd.cfg</filename> to hardcode a \r
domain:</para>\r
<screen>\r
-<userinput>su - root</userinput>\r
<userinput>epmd -kill</userinput>\r
<userinput>killall beam; killall beam.smp</userinput>\r
<userinput>rm /var/lib/ejabberd/*</userinput>\r
<para>As the <systemitem class="username">opensrf</systemitem> user, use the example templates to create the configuration files \r
<filename>/openils/conf/opensrf_core.xml</filename> and <filename>/openils/conf/opensrf.xml</filename>:</para>\r
<screen>\r
-<userinput>su - root</userinput>\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
file.</emphasis>\r
</para>\r
</note>\r
- <title>Updates needed in the file <filename>/openils/conf/opensrf_core.xml</filename></title>\r
- <itemizedlist>\r
- <listitem>/config/opensrf/username = <systemitem class="username">opensrf</systemitem></listitem>\r
- <listitem>/config/opensrf/passwd = password for <systemitem class="domainname">private.localhost</systemitem> \r
- <systemitem class="username">opensrf</systemitem> user</listitem>\r
- <listitem>/config/opensrf/passwd = password for <systemitem class="domainname">private.localhost</systemitem> \r
- <systemitem class="username">opensrf</systemitem> user</listitem>\r
- <listitem>/config/gateway/username = <systemitem class="username">opensrf</systemitem></listitem>\r
- <listitem>/config/gateway/passwd = password for <systemitem class="domainname">public.localhost</systemitem> \r
- <systemitem class="username">opensrf</systemitem> user</listitem>\r
- <listitem>/config/routers/router/transport (first entry, where \r
- <quote>transport/server</quote> ==<systemitem class="domainname">public.localhost</systemitem>) \r
+ \r
+ <para>/config/opensrf/username = <systemitem class="username">opensrf</systemitem></para>\r
+ <para>/config/opensrf/passwd = password for <systemitem class="domainname">private.localhost</systemitem> \r
+ <systemitem class="username">opensrf</systemitem> user</para>\r
+ <para>/config/opensrf/passwd = password for <systemitem class="domainname">private.localhost</systemitem> \r
+ <systemitem class="username">opensrf</systemitem> user</para>\r
+ <para>/config/gateway/username = <systemitem class="username">opensrf</systemitem></para>\r
+ <para>/config/gateway/passwd = password for <systemitem class="domainname">public.localhost</systemitem>\r
+ <systemitem class="username">opensrf</systemitem> user</para>\r
+ <para>/config/routers/router/transport (first entry, where \r
+ <quote>transport/server</quote> ==<systemitem class="domainname">public.localhost</systemitem>)</para>\r
<itemizedlist>\r
<listitem>username = <systemitem class="username">router</systemitem></listitem> \r
<listitem>password = password for <systemitem class="domainname">public.localhost</systemitem> \r
<systemitem class="username">router</systemitem> \r
user</listitem>\r
</itemizedlist>\r
- </listitem>\r
- <listitem>/config/routers/router/transport (second entry, where \r
- <quote>transport/server</quote> == <systemitem class="domainname">private.localhost</systemitem>) \r
+ \r
+ <para>/config/routers/router/transport (second entry, where \r
+ <quote>transport/server</quote> == <systemitem class="domainname">private.localhost</systemitem>) </para>\r
<itemizedlist>\r
<listitem>username = <systemitem class="username">router</systemitem></listitem> \r
<listitem>password = password for <systemitem class="domainname">private.localhost</systemitem> \r
<systemitem class="username">router</systemitem> \r
user</listitem>\r
</itemizedlist>\r
- </listitem>\r
- </itemizedlist>\r
+ \r
<para>You also need to specify the domains from which <systemitem class="service">OpenSRF</systemitem> will accept and to which \r
<systemitem class="service">OpenSRF</systemitem> will make connections. If you are installing <application>OpenSRF</application> on a single server and using the \r
<systemitem class="domainname">private.localhost</systemitem> / <systemitem class="domainname">public.localhost</systemitem> domains, these will already be set to \r
<para>As the <systemitem class="username">opensrf</systemitem> user, modify the environmental variable <envar>PATH</envar> by adding a new file path to \r
the <systemitem class="username">opensrf</systemitem> user's shell configuration file <filename>.bashrc</filename>:</para>\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>echo "export PATH=/openils/bin:\$PATH" >> ~/.bashrc</userinput>\r
</screen>\r
\r
<para>As the <systemitem class="username">root</systemitem> user, start the <systemitem class="service">ejabberd</systemitem> and \r
<systemitem class="service">memcached</systemitem> services:</para> \r
<screen>\r
-<userinput>su - root</userinput>\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, start OpenSRF:</para>\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>start the OpenSRF service:</userinput>\r
<userinput>use "-l" to force hostname to be "localhost"</userinput>\r
<userinput>osrf_ctl.sh -l -a start_all</userinput> \r
<systemitem class="service">math</systemitem> service:</para>\r
\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>/openils/bin/srfsh</userinput>\r
<prompt>srfsh#</prompt> <userinput>request opensrf.math add 2 2</userinput>\r
Received Data: 4\r
<title>Stopping OpenSRF</title>\r
<para>As the <systemitem class="username">opensrf</systemitem> user, stop OpenSRF:</para>\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>osrf_ctl.sh -l -a stop_all</userinput>\r
</screen> \r
</step>\r
<para>As the <systemitem class="username">opensrf</systemitem> user, download 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.0.7.tar.gz"></ulink></para>\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.0.7.tar.gz</userinput>\r
<userinput>tar zxf Evergreen-ILS-1.6.0.7.tar.gz</userinput>\r
</screen>\r
<systemitem class="osname">Linux</systemitem> distribution listed in the \r
<link linkend="serversideinstallation-keywords-evergreen">distribution keywords</link> table.</para>\r
<screen>\r
-<userinput>su - root</userinput>\r
<userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7</userinput>\r
<userinput>make -f Open-ILS/src/extras/Makefile.install [distribution]</userinput>\r
</screen>\r
<title>(OPTIONAL) Install the PostgreSQL Server</title>\r
<para>Since the PostgreSQL server is usually a standalone server in multi-server production systems, the prerequisite installer Makefile in the previous step \r
does not automatically install PostgreSQL. If your PostgreSQL server is on a different system, just skip this step.</para>\r
- <para>For further information on manually installing PostgreSQL, see <xref linkend="serversideinstallation-postgresql"/>.</para>\r
+ <para>For further information on manually installing PostgreSQL, visit the <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 software, then as the <systemitem class="username">root</systemitem> user install the \r
required PostgreSQL server packages:</para>\r
<screen><userinput>su - root</userinput></screen>\r
<command>psql</command>. Then type <userinput>SELECT version();</userinput> to get detailed information of your version of PostgreSQL.</para>\r
</note>\r
</step>\r
- <step>\r
- <title>Install Perl Modules on PostgreSQL Server (OPTIONAL) </title>\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, then the Perl modules will automatically be available. Just skip this step.</para>\r
<para>Otherwise, if your PostgreSQL server is running on another system, then as the <systemitem class="username">root</systemitem> user install the following Perl \r
modules on that system:</para>\r
<para>ensure the gcc compiler is installed:</para>\r
<screen>\r
-<userinput>su - root</userinput>\r
<userinput>apt-get install gcc</userinput>\r
</screen>\r
<para>install the Perl modules</para>\r
<prompt>cpan></prompt> <userinput>install MARC::Record</userinput>\r
<prompt>cpan></prompt> <userinput>install MARC::File::XML</userinput>\r
</screen>\r
- <para>For more information on installing Perl Modules vist the <link xml:href="http://www.cpan.org/">CPAN</link> site.</para>\r
+ <para>For more information on installing Perl Modules vist the <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
<title>Restart the PostgreSQL Server</title>\r
<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 \r
PostgreSQL. If PostgreSQL is running on another system, you may skip this step.</para> \r
-<screen>\r
-<userinput>su - root</userinput>\r
-<userinput>/etc/init.d/postgresql-[PGSQL_VERSION] restart</userinput>\r
-</screen>\r
+ <screen><userinput>/etc/init.d/postgresql-[PGSQL_VERSION] restart</userinput></screen>\r
<para>Where <literal>PGSQL_VERSION</literal> is your installed PostgreSQL version (e.g. <literal>8.3</literal>).</para>\r
</step>\r
<step xml:id="serversideinstallation-configure">\r
<para>As the <systemitem class="username">opensrf</systemitem> user, return to the Evergreen build directory and use the <command>configure</command> utility to \r
prepare for the next step of compiling and linking the software:</para>\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7</userinput>\r
<userinput>./configure --prefix=/openils --sysconfdir=/openils/conf</userinput>\r
<userinput>make</userinput>\r
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>\r
<para>For further information on manually building the Staff Client, see <xref linkend="serversideinstallation-building-staffclient"/>.</para>\r
<screen>\r
-<userinput>su - root</userinput>\r
<userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7</userinput>\r
<userinput>make STAFF_CLIENT_BUILD_ID=rel_1_6_0_7 install</userinput>\r
</screen>\r
in the head of the Staff Client directory <filename class="directory">/openils/var/web/xul</filename> that points to the subdirectory \r
<filename class="directory">/server</filename> of the new Staff Client build:</para> \r
<screen>\r
-<userinput>su - root</userinput>\r
<userinput>cd /openils/var/web/xul</userinput>\r
<userinput>ln -sf rel_1_6_0_7/server server</userinput>\r
</screen>\r
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 \r
purposes. Finally, change the ownership on the installed files to the <systemitem class="username">opensrf</systemitem> user:</para>\r
<screen>\r
-<userinput>su - root</userinput>\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
paths:</para>\r
<para>Create the database:</para>\r
<screen>\r
-<userinput>su - postgres</userinput>\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</para>\r
+ <para>Adjust the paths:</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
<step>\r
<title>Create a new Evergreen superuser</title>\r
<para>As the <systemitem class="username">postgres</systemitem> user on the PostgreSQL system, create the new database \r
- <systemitem class="username">evergreen</systemitem> user and assign a password:</para>\r
- \r
-<screen>\r
-<userinput>su - postgres</userinput>\r
-<userinput>createuser -P -s evergreen</userinput>\r
-</screen> \r
+ <systemitem class="username">evergreen</systemitem> user and assign a password:</para> \r
+ <screen><userinput>createuser -P -s evergreen</userinput></screen> \r
<para>Enter the password twice for new role when prompted.</para> \r
</step>\r
<step>\r
<systemitem class="domainname">public.localhost</systemitem> domains, these will already be set to the correct values. Otherwise, search and replace to match \r
your customized values.</para>\r
<para>The following example uses common XPath syntax on the left-hand side to indicate the approximate position needing changes within the XML file:</para>\r
- <itemizedlist>\r
- <listitem>/config/opensrf/username = <systemitem class="username">opensrf</systemitem></listitem>\r
- <listitem>/config/opensrf/passwd = password for <systemitem class="domainname">private.localhost</systemitem> \r
- <systemitem class="username">opensrf</systemitem> user</listitem>\r
- <listitem>/config/opensrf/passwd = password for <systemitem class="domainname">private.localhost</systemitem> \r
- <systemitem class="username">opensrf</systemitem> user</listitem>\r
- <listitem>/config/gateway/username = <systemitem class="username">opensrf</systemitem></listitem>\r
- <listitem>/config/gateway/passwd = password for <systemitem class="domainname">public.localhost</systemitem> \r
- <systemitem class="username">opensrf</systemitem> user</listitem>\r
- <listitem>/config/routers/router/transport (first entry, where <quote>transport/server</quote> == <systemitem class="domainname">public.localhost</systemitem>) \r
+ <para>/config/opensrf/username = <systemitem class="username">opensrf</systemitem></para>\r
+ <para>/config/opensrf/passwd = password for <systemitem class="domainname">private.localhost</systemitem>\r
+ <systemitem class="username">opensrf</systemitem> user</para>\r
+ <para>/config/gateway/username = <systemitem class="username">opensrf</systemitem></para>\r
+ <para>/config/gateway/passwd = password for <systemitem class="domainname">public.localhost</systemitem> \r
+ <systemitem class="username">opensrf</systemitem> user</para>\r
+ <para>/config/routers/router/transport (first entry, where <quote>transport/server</quote> == <systemitem class="domainname">public.localhost</systemitem>)</para>\r
<itemizedlist>\r
<listitem>username = <systemitem class="username">router</systemitem></listitem> \r
<listitem>password = password for <systemitem class="domainname">public.localhost</systemitem> <systemitem class="username">router</systemitem> \r
user</listitem>\r
</itemizedlist>\r
- </listitem>\r
- <listitem>/config/routers/router/transport (second entry, where <quote>transport/server</quote> == <systemitem class="domainname">private.localhost</systemitem>) \r
+ <para>/config/routers/router/transport (second entry, where <quote>transport/server</quote> == <systemitem \r
+ class="domainname">private.localhost</systemitem>) </para>\r
<itemizedlist>\r
<listitem>username = <systemitem class="username">router</systemitem></listitem> \r
<listitem>password = password for <systemitem class="domainname">private.localhost</systemitem> <systemitem class="username">router</systemitem> \r
user</listitem>\r
</itemizedlist>\r
- </listitem>\r
- </itemizedlist>\r
+ \r
</step>\r
<step xml:id="serversideinstallation-srfsh">\r
<title>Create Configuration Files for Users Needing <application>"srfsh"</application></title>\r
<para>As the <systemitem class="username">root</systemitem> user, start the <systemitem class="service">ejabberd</systemitem> and \r
<systemitem class="service">memcached</systemitem> services (if they are not already running):</para>\r
<screen>\r
-<userinput>su - root</userinput>\r
<userinput>/etc/init.d/ejabberd start</userinput>\r
<userinput>/etc/init.d/memcached start</userinput>\r
</screen>\r
<?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
<title>Installing the Staff Client</title>\r
- <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 <systemitem class="osname">Windows</systemitem>, <systemitem class="osname">Mac OS X</systemitem>, and <systemitem class="osname">Linux</systemitem>. If you need to manually build the Staff Client, see <xref linkend="serversideinstallation-building-staffclient"/>.</para>\r
+ <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 \r
+ for <systemitem class="osname">Windows</systemitem>, <systemitem class="osname">Mac OS X</systemitem>, and <systemitem class="osname">Linux</systemitem>. If you need to manually build \r
+ the Staff Client, see <xref linkend="serversideinstallation-building-staffclient"/>.</para>\r
<section xml:id="serversideinstallation-prebuilt-staffclient">\r
<title>Installing a Pre-Built Staff Client</title>\r
<para>This section reviews the process of installing pre-built versions of the Staff Client in various environments.</para>\r
- <section>\r
+ <simplesect>\r
<title>Installing on <systemitem class="osname">Windows</systemitem></title>\r
- <para>A standard <systemitem class="osname">Windows</systemitem> 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>\r
- <figure>\r
- <title>Running the Staff Client installer</title>\r
- <mediaobject>\r
- <imageobject>\r
- <imagedata fileref="../media/serversideinstallation-staffclient-1.png" scalefit="1" width="70%"/>\r
- </imageobject>\r
- </mediaobject>\r
- </figure>\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 where to install the software, ask about where to place icons, and then will install the software on your workstation.</para>\r
+ <para>A standard <systemitem class="osname">Windows</systemitem> installer that contains the current version of the Staff Client is available from the downloads section \r
+ 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, \r
+ then run it.</para>\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 where to \r
+ 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
- <figure>\r
- <title>Running the Staff Client for the first time</title>\r
<mediaobject>\r
<imageobject>\r
<imagedata fileref="../media/serversideinstallation-staffclient-2.png" scalefit="1" width="70%"/>\r
</imageobject>\r
</mediaobject>\r
- </figure>\r
- <para>First, configure the server you would like to connect to in the <emphasis role="bold">Server</emphasis> section. For example, the PINES demo system is <systemitem class="domain">demo.gapines.org</systemitem>. After selecting a server, click <guibutton>Re-Test Server</guibutton>.</para>\r
- <para>Because this is the initial run of the Staff Client, the <emphasis role="bold">Workstation</emphasis> section in the upper-right states: <emphasis role="bold">Not yet configured for the specified server</emphasis>. The first thing that must be done to the Staff Client on every workstation is to assign it a workstation name. This is covered in <xref linkend="serversideinstallation-workstationnames"/>.</para>\r
- </section>\r
- <section>\r
+ <para>First, configure the server you would like to connect to in the <emphasis role="bold">Server</emphasis> section. For example, the PINES demo system is \r
+ <systemitem class="domain">demo.gapines.org</systemitem>. After selecting a server, click <guibutton>Re-Test Server</guibutton>.</para>\r
+ <para>Because this is the initial run of the Staff Client, the <emphasis role="bold">Workstation</emphasis> section in the upper-right states: <emphasis role="bold">Not \r
+ yet configured for the specified server</emphasis>. The first thing that must be done to the Staff Client on every workstation is to assign it a workstation name. This is \r
+ covered in <xref linkend="serversideinstallation-workstationnames"/>.</para>\r
+ </simplesect>\r
+ <simplesect>\r
<title>Installing on <systemitem class="osname">Mac OS X</systemitem></title>\r
- <para>A <systemitem class="osname">Mac OS X</systemitem> package that contains the current version of the Staff Client is available for use with <application>"xulrunner"</application>.</para>\r
- <section>\r
+ <para>A <systemitem class="osname">Mac OS X</systemitem> package that contains the current version of the Staff Client is available for use with \r
+ <application>"xulrunner"</application>.</para>\r
+ <simplesect>\r
<title>Evergreen Indiana Pkg file [Evergreen v1.2.3.0]</title>\r
<procedure>\r
- <step>Download and install the latest version of <application>"xulrunner"</application> for <systemitem class="osname">Mac OS X</systemitem>. Release notes for the latest version can be found here: <ulink url="http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes">http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes</ulink>. Note, later versions may not work correctly.</step>\r
- <step>Download and install the <systemitem class="osname">Mac OS X</systemitem> 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>.</step>\r
- <step>To upgrade to a more recent version of the Staff Client, you can copy the directory <emphasis>build</emphasis> from a working <systemitem class="osname">Windows</systemitem> 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 <systemitem class="osname">Windows</systemitem> machine: <filename class="directory">C:\Program Files\Evergreen Staff Client\build</filename>. Copy these files into the folder <filename class="directory">Resources</filename> within the Open-ILS package in your Applications directory on the Mac, overwriting files with the same names.</step>\r
+ <step>Download and install the latest version of <application>"xulrunner"</application> for <systemitem class="osname">Mac OS X</systemitem>. Release notes \r
+ for the latest version 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</ulink>.\r
+ Note, later versions may not work correctly.</step>\r
+ <step>Download and install the <systemitem class="osname">Mac OS X</systemitem> 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>.</step>\r
+ <step>To upgrade to a more recent version of the Staff Client, you can copy the directory <emphasis>build</emphasis> from a working \r
+ <systemitem class="osname">Windows</systemitem> installation of the desired version of the Staff Client to your Mac. The required files may be located in \r
+ a directory like this on the <systemitem class="osname">Windows</systemitem> machine: <filename class="directory">C:\Program Files\Evergreen Staff Client\build\r
+ </filename>. Copy these files into the folder <filename class="directory">Resources</filename> within the Open-ILS package in your Applications directory on \r
+ the Mac, overwriting files with the same names.</step>\r
<step>Drag the application's icon into your toolbar for easier access.</step>\r
</procedure>\r
<para/>\r
- <para>When you run the Staff Client installer, a screen will appear that looks similar to this:</para>\r
- <figure>\r
- <title>Running the Staff Client installer</title>\r
- <mediaobject>\r
- <imageobject>\r
- <imagedata fileref="../media/serversideinstallation-staffclient-3.png" scalefit="1" width="20%"/>\r
- </imageobject>\r
- </mediaobject>\r
- </figure>\r
- <caution> FIX BAD LINK: http://es.zionsville.lib.in.us/atheos/eg_osx_a.gif </caution>\r
- <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>\r
- <figure>\r
- <title>Finishing the installation</title>\r
- <mediaobject>\r
- <imageobject>\r
- <imagedata fileref="../media/serversideinstallation-staffclient-4.png" scalefit="1" width="20%"/>\r
- </imageobject>\r
- </mediaobject>\r
- </figure>\r
- <caution> FIX BAD LINK: http://es.zionsville.lib.in.us/atheos/eg_osx_a.gif </caution>\r
- </section>\r
- <section>\r
+ \r
+ <para>Click <guibutton>Continue</guibutton>, accept the license, then finish the installation. The application will be located at the destination you selected \r
+ during installation. You will then be able to drag the application into your toolbar for easier access.</para>\r
+ </simplesect>\r
+ <simplesect>\r
<title>Running directly using <application>"xulrunner"</application></title>\r
- <para>You must install an appropriate version of <application>"xulrunner"</application> to match the Evergreen version. See the following table for the recommended version of <application>"xulrunner"</application>:</para>\r
+ <para>You must install an appropriate version of <application>"xulrunner"</application> to match the Evergreen version. See the following table for the recommended \r
+ version of <application>xulrunner</application>:</para>\r
<table>\r
<title>Evergreen / XULRunner Dependencies</title>\r
<tgroup align="left" cols="2" colsep="1" rowsep="1">\r
</tbody>\r
</tgroup>\r
</table>\r
- <note>If you have issues removing previously installed <application>"xulrunner"</application> versions see <xref linkend="serversideinstallation-staffclient-remove-xulrunner"/> for information on removing previous <application>"XULRunner"</application> versions.</note>\r
- <para>The Staff Client data from the directory <filename class="directory">./staff_client/build</filename> must be placed somewhere on the machine (e.g. <emphasis>~/Desktop/Evergreen_Staff_Client</emphasis>). Remember to call <application>"XULRunner"</application> with the full path to the binary, followed by the install command and the path to the client data. See the following command:</para>\r
- <figure>\r
- <title>Executing <application>"xulrunner"</application></title>\r
- <screen>\r
- /Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_Client\r
- </screen>\r
- </figure>\r
- <para>This command should exit quietly. A folder will be created, named <emphasis>/Applications/OpenILS</emphasis>, containing a launcher named <emphasis>open_ils_staff_client</emphasis>.</para>\r
- </section>\r
- <section xml:id="serversideinstallation-staffclient-remove-xulrunner">\r
- <title>Removing previously installed <application>"xulrunner"</application> versions</title>\r
- <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>\r
+ <note><para>If you have issues removing previously installed <application>xulrunner</application> versions see \r
+ <xref linkend="serversideinstallation-staffclient-remove-xulrunner"/> for information on removing previous <application>"XULRunner"</application> versions.</para></note>\r
+ <para>The Staff Client data from the directory <filename class="directory">./staff_client/build</filename> must be placed somewhere on the machine (e.g. \r
+ <emphasis>~/Desktop/Evergreen_Staff_Client</emphasis>). Remember to call <application>XULRunner</application> with the full path to the binary, followed by \r
+ the 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. A folder will be created, named <emphasis>/Applications/OpenILS</emphasis>, containing a launcher \r
+ named <emphasis>open_ils_staff_client</emphasis>.</para>\r
+ </simplesect>\r
+ <simplesect xml:id="serversideinstallation-staffclient-remove-xulrunner">\r
+ <title>Removing previously installed <application>xulrunner</application> 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 there is no file <filename>/Library/Receipts/xulrunner-ver-mak.pkg</filename> (possibly in newer OSX releases) you need to flush the file <emphasis>receiptdb</emphasis>.</para>\r
- <note>If you install a newer version over a previous (older) install, the older one is not removed but the symlinks get changed to the newer one.</note>\r
+ <para>If there is no file <filename>/Library/Receipts/xulrunner-ver-mak.pkg</filename> (possibly in newer OSX releases) you need to flush the file \r
+ <emphasis>receiptdb</emphasis>.</para>\r
+ <note><para>If you install a newer version over a previous (older) install, the older one is not removed but the symlinks get changed to the newer one.</para></note>\r
<para>First, get the package identifier, then purge/forget the build that was initially installed:</para>\r
- <figure>\r
- <title>Purging previous build</title>\r
- <screen>\r
- sudo pkgutil --pkgs > /tmp/pkgs.txt\r
- sudo pkgutil --forget org.mozilla.xulrunner\r
- </screen>\r
- </figure>\r
- <note>It may not be necessary to edit the file <filename>/Library/Receipts/InstallHistory.plist</filename> after deleting the folder <emphasis>XUL.framework</emphasis>.</note>\r
- </section>\r
- <section>\r
+<screen>\r
+<userinput>sudo pkgutil --pkgs > /tmp/pkgs.txt</userinput>\r
+<userinput>sudo pkgutil --forget org.mozilla.xulrunner</userinput>\r
+</screen>\r
+ <note><para>It may not be necessary to edit the file <filename>/Library/Receipts/InstallHistory.plist</filename> after deleting the folder \r
+ <emphasis>XUL.framework</emphasis>.</para></note>\r
+ </simplesect>\r
+ <simplesect>\r
<title>Creating an APP file: Staff Client & <application>"xulrunner"</application> Bundled</title>\r
- <para>An APP file is basically a folder. Start with a folder structure like this:</para>\r
- <figure>\r
- <title>Sample APP file folder structure</title>\r
- <screen>\r
- * Evergreen.app\r
- * Contents\r
- * Frameworks\r
- * Resources\r
- * MacOS\r
- </screen>\r
- </figure>\r
+ <para>An APP file is basically a folder. Start with a folder structure 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
- <figure>\r
- <title>Creating a folder structure</title>\r
- <screen>\r
- mkdir -p Evergreen.app/Contents/Frameworks\r
- mkdir -p Evergreen.app/Contents/Resources\r
- mkdir -p Evergreen.app/Contents/MacOS\r
- </screen>\r
- </figure>\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
<procedure>\r
<step>\r
- <para>Create a new file in the folder <emphasis>Evergreen.app/Contents/Info.plist</emphasis> containing the following data (adjust for your version of Evergreen):</para>\r
- \r
- \r
+ <para>Create a new file in the folder <emphasis>Evergreen.app/Contents/Info.plist</emphasis> containing the following data (adjust for your \r
+ 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
]]></programlisting>\r
\r
</step>\r
- <step>Download and install an appropriate <systemitem class="osname">Mac OS X</systemitem>package of <application>"XULRunner"</application> from \r
- the Mozilla website (see above for recommendations).</step>\r
+ <step>\r
+ <para>Download and install an appropriate <systemitem class="osname">Mac OS X</systemitem>package of <application>"XULRunner"</application> from \r
+ the Mozilla website (see above for recommendations).</para></step>\r
<step>\r
<para>Make a copy of <emphasis>/Library/Frameworks/XUL.Framework</emphasis> inside your APP file. It should look something like this:</para>\r
\r
______* xulrunner-bin -> Versions/Current/xulrunner-bin\r
</screen>\r
</step>\r
- <step>Copy <emphasis>XUL.Framework/Versions/Current/xulrunner</emphasis> into <emphasis>Evergreen.app/MacOS</emphasis> \r
- (do not symlink; copy the file).</step>\r
+ <step><para>Copy <emphasis>XUL.Framework/Versions/Current/xulrunner</emphasis> into <emphasis>Evergreen.app/MacOS</emphasis> \r
+ (do not symlink; copy the file).</para></step>\r
<step>\r
<para>Make <emphasis>Evergreen.app/Resources</emphasis> the root of your Evergreen application files like this:</para>\r
- <figure>\r
- <title>Example APP file</title>\r
- <screen>\r
- * Evergreen.app/\r
- __* Contents/\r
- ____* Resources/\r
- ______* BUILD_ID\r
- ______* application.ini\r
- ______* chrome/\r
- ______* components/\r
- ______* etc.\r
- </screen>\r
- </figure>\r
+<screen>\r
+* Evergreen.app/\r
+__* Contents/\r
+____* Resources/\r
+______* BUILD_ID\r
+______* application.ini\r
+______* chrome/\r
+______* components/\r
+______* etc.\r
+</screen>\r
</step>\r
<step>Put a <systemitem class="osname">Mac</systemitem> format icon file named <emphasis>Evergreen.icns</emphasis> in Resources.</step>\r
</procedure>\r
- </section>\r
- </section>\r
- <section xml:id="serversideinstallation-staffclient">\r
+ </simplesect>\r
+ </simplesect>\r
+ <simplesect xml:id="serversideinstallation-staffclient">\r
<title>Installing on <systemitem class="osname">Linux</systemitem></title>\r
- <section>\r
+ <simplesect>\r
<title>Quick Upgrade of the Staff Client</title>\r
<para>A <systemitem class="osname">Linux</systemitem> Staff Client is automatically built on the server as part of the normal \r
<emphasis>make install</emphasis> process for Evergreen server-side software. To upgrade the Staff Client on a remote workstation with a new version, \r
<para>As the <systemitem class="username">opensrf</systemitem> user, change directory to the Staff Client source directory, then recursively copy \r
the entire directory tree to the remote workstation:</para> \r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7/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 \r
it as 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
- \r
- </section>\r
- <section>\r
+ <screen><userinput>xulrunner ~/eg-client-x.x.x.x/build/application.ini</userinput></screen> \r
+ </simplesect>\r
+ <simplesect>\r
<title>Building the Staff Client on the Server</title>\r
<para>A <systemitem class="osname">Linux</systemitem> Staff Client is automatically built on the server as part of the normal \r
<emphasis>make install</emphasis> process for Evergreen server-side software.</para>\r
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 \r
link to 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
- </section>\r
- <section>\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 <systemitem class="osname">Linux</systemitem> rather than \r
<systemitem class="osname">Windows</systemitem> for client machines, but have limited <systemitem class="osname">Linux</systemitem> experience. You can \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 system administrator, 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 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>\r
- <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 <guibutton>Visit</guibutton> 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>\r
+ <para>For most end-users, a specific version is required to communicate properly with the Evergreen server. Check with your \r
+ system administrator, 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 the \r
+ 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 \r
+ 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>. Look in the \r
+ <guibutton>Visit</guibutton> drop-down box; see the list of Branches and, further down, a list of Tags. You may have to do some \r
+ 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 \r
+ 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 \r
+ 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 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>\r
- \r
+ <para>As the <systemitem class="username">opensrf</systemitem> user, open a terminal (command-line prompt) and navigate to the directory \r
+ in which you wish to download the Staff Client. Use the following commands to download the proper version of the source code by tag \r
+ name:</para> \r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>cd /YOUR/DOWNLOAD/DIRECTORY</userinput>\r
<userinput>svn co svn://svn.open-ils.org/ILS/tags/rel_1_2_1_4/</userinput>\r
</screen>\r
<para>Build the Staff Client</para>\r
<section>\r
<title>Evergreen 1.2.x</title>\r
- <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 <command>make</command> 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 <literal>rel_1_2_1_4</literal>. Modify the following commands accordingly.</para>\r
+ <para>In the following example, navigate to the directory in which the source code was downloaded, then navigate to the proper subdirectory and \r
+ run the <command>make</command> utility to actually build the Staff Client. Remember to check with your system administrator about which \r
+ Staff Client BUILD_ID to use. The server checks the Staff Client BUILD_ID against itself to determine whether or not a connecting client \r
+ is supported. For instance, for the PINES installation (version 1.2.1.4) the supported BUILD_ID is <literal>rel_1_2_1_4</literal>. Modify \r
+ the following commands accordingly.</para>\r
<para>As the <systemitem class="username">opensrf</systemitem> user, run the following commands to build the Staff \r
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_2_1_4'</userinput>\r
</section>\r
<section>\r
<title>Evergreen 1.4.x</title>\r
- <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>\r
+ <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 \r
+ tar archive) of Evergreen, then your steps will resemble the following:</para>\r
<caution>FIXME -- Need instructions for getting certain Javascript files from OpenSRF, preferably without actually installing OpenSRF.\r
</caution> \r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.4.0.4.tar.gz</userinput>\r
<userinput>tar xfz Evergreen-ILS-1.4.0.4.tar.gz</userinput>\r
<userinput>cd Evergreen-ILS-1.4.0.4/</userinput>\r
<para>If you're installing from a Subversion checkout:</para>\r
\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>svn co svn://svn.open-ils.org/ILS/tags/rel_1_4_0_4/</userinput>\r
<userinput>cd rel_1_4_0_4</userinput>\r
<userinput>./autogen.sh</userinput> # If you downloaded a .tar.gz of Evergreen, you may skip this step\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 directory <filename class="directory">build/</filename> (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
+ <para>As the <systemitem class="username">opensrf</systemitem> user, navigate to the directory <filename class="directory">build/</filename> \r
+ (not <filename class="directory">staff_client/</filename>) and run the following command:</para> \r
+ <screen><userinput>xulrunner application.ini</userinput></screen>\r
</step>\r
<step>\r
<para>(OPTIONAL) 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 \r
wish to remove them to save space, or to create a clean directory containing the built Staff Client that can be copied to other machines. To \r
- create a clean "staging" directory in which to place the finished Staff Client, issue the following commands:</para> \r
+ create a clean "staging" directory in which to place the finished Staff Client, issue the following commands:</para> \r
+ \r
<screen>\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
- \r
+ \r
<screen>\r
<userinput>cd ~/<Destination Directory>/staff_client/build</userinput>\r
<userinput>xulrunner application.ini</userinput>\r
</screen>\r
- \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
- \r
+ <screen><userinput>rm -r -f ~/<Download Directory></userinput></screen>\r
<para>Finally, test the copied Staff Client. You can create "Desktop / Start Menu / K-Menu" shortcuts for the Staff Client by using the following command as the target:</para> \r
<screen>\r
<userinput>xulrunner ~/<Destination Directory>/staff_client/build/application.ini</userinput>\r
-</screen>\r
- \r
+</screen> \r
</step>\r
</procedure>\r
- </section>\r
- <section>\r
+ </simplesect>\r
+ <simplesect>\r
<title>Using <application>"Wine"</application> to Install On Linux</title>\r
- <para>The <systemitem class="osname">Linux</systemitem> application <application>"Wine"</application> is another alternative for those who wish to install the packaged <systemitem class="osname">Windows</systemitem> versions rather than building the Staff Client manually. <application>"Wine"</application> is a <systemitem class="osname">Linux</systemitem> application that allows users to directly run <systemitem class="osname">Windows</systemitem> executables, and is a simple way for casual <systemitem class="osname">Linux</systemitem> users to use the Staff Client. More information about <application>"Wine"</application> 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>\r
- <para>As the <systemitem class="username">root</systemitem> user, use <application>"apt-get"</application> to install the package for <application>"Wine"</application>. You can also use <application>"synaptic"</application>, the graphical user interface.</para>\r
+ <para>The <systemitem class="osname">Linux</systemitem> application <application>"Wine"</application> is another alternative for those who wish to install the \r
+ packaged <systemitem class="osname">Windows</systemitem> versions rather than building the Staff Client manually. <application>"Wine"</application> is a \r
+ <systemitem class="osname">Linux</systemitem> application that allows users to directly run <systemitem class="osname">Windows</systemitem> executables, and is a simple \r
+ way for casual <systemitem class="osname">Linux</systemitem> users to use the Staff Client. More information about <application>"Wine"</application> 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 <application>"apt-get"</application> to install the package for <application>"Wine"</application>. \r
+ You can also use <application>"synaptic"</application>, the graphical user interface.</para>\r
<procedure>\r
<step>\r
- <para>Install <application>"Wine"</application></para>\r
- \r
-<screen>\r
-<userinput>sudo apt-get install wine</userinput>\r
-</screen>\r
+ <para>Install <application>"Wine"</application></para> \r
+ <screen><userinput>sudo apt-get install wine</userinput></screen>\r
</step>\r
<step>\r
<para>Download <systemitem class="osname">Windows</systemitem> installer for the Staff Client</para>\r
<para>As the <systemitem class="username">opensrf</systemitem> user, run the following commands to download the <systemitem class="osname">Windows</systemitem> installer for the proper Staff Client from the <emphasis>open-ils.org</emphasis> 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
</step>\r
<step>\r
<para>Run the downloaded <systemitem class="osname">Windows</systemitem> installer</para>\r
- <para>As the <systemitem class="username">opensrf</systemitem> user, navigate to the directory where you downloaded the <systemitem class="osname">Windows</systemitem> executable file, then execute it:</para>\r
+ <para>As the <systemitem class="username">opensrf</systemitem> user, navigate to the directory where you downloaded the \r
+ <systemitem class="osname">Windows</systemitem> executable 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
\r
- <para>If this step fails, you may need to configure Wine first to properly emulate <systemitem class="osname">WindowsXP</systemitem>. To do so, type the command <command>winecfg</command> from the command line; in the <guibutton>Applications</guibutton> tab of the window that pops up, select <guibutton>Default Settings</guibutton> and choose <guibutton>Windows XP</guibutton> from the drop-down menu, then click <guibutton>Apply</guibutton>.</para>\r
+ <para>If this step fails, you may need to configure Wine first to properly emulate <systemitem class="osname">WindowsXP</systemitem>. To do so, type \r
+ the command <command>winecfg</command> from the command line; in the <guibutton>Applications</guibutton> tab of the window that pops up, \r
+ select <guibutton>Default Settings</guibutton> and choose <guibutton>Windows XP</guibutton> from the drop-down menu, then click \r
+ <guibutton>Apply</guibutton>.</para>\r
</step>\r
<step>\r
<para>Launch the Staff Client</para>\r
- <para>A new entry for the Staff Client should now appear somewhere in the <guibutton>All Applications</guibutton> menu of your <systemitem class="osname">Linux</systemitem> desktop. Also, find a new desktop shortcut for the Staff Client. To launch the Staff Client, visit the <guibutton>All Applications</guibutton> menu, find a section similar to <emphasis><menuchoice><guimenu>Wine</guimenu><guimenuitem>Program Files</guimenuitem><guimenuitem>Evergreen Staff Client</guimenuitem><guimenuitem>Evergreen Staff Client</guimenuitem></menuchoice></emphasis>\r
-, or else launch the Staff Client from the desktop shortcut.</para>\r
+ <para>A new entry for the Staff Client should now appear somewhere in the <guibutton>All Applications</guibutton> menu of your \r
+ <systemitem class="osname">Linux</systemitem> desktop. Also, find a new desktop shortcut for the Staff Client. To launch the Staff Client, visit \r
+ the <guibutton>All Applications</guibutton> menu, find a section similar to <emphasis><menuchoice><guimenu>Wine</guimenu>\r
+ <guimenuitem>Program Files</guimenuitem><guimenuitem>Evergreen Staff Client</guimenuitem><guimenuitem>Evergreen Staff Client</guimenuitem>\r
+ </menuchoice></emphasis>, or else launch the Staff Client from the desktop shortcut.</para>\r
</step>\r
</procedure>\r
- </section>\r
- <section>\r
+ </simplesect>\r
+ <simplesect>\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. For more details, see <xref linkend="serversideinstallation-proxy"/>.</para>\r
- </section>\r
- </section>\r
- <section xml:id="serversideinstallation-workstationnames">\r
+ </simplesect>\r
+ </simplesect>\r
+ <simplesect xml:id="serversideinstallation-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 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>\r
-<mediaobject>\r
-<imageobject>\r
- <imagedata fileref="../media/serversideinstallation-staffclient-workstationnames-1.png" scalefit="1" width="70%"/>\r
-</imageobject>\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 (OPSM) has the ability to assign workstation names in his or her library system. Library managers (LIBM's) have the ability within their branch. To assign a workstation a name, login to the system. You will be prompted to assign the workstation a library and a name:</para>\r
-<mediaobject>\r
-<imageobject>\r
- <imagedata fileref="../media/serversideinstallation-staffclient-workstationnames-2.png" scalefit="1" width="70%"/>\r
-</imageobject>\r
-</mediaobject>\r
- <para>Select the library this workstation physically operates in from the drop down menu. In this example, we have selected <literal>MGRL-MA</literal>. Type in a friendly name for the workstation. In this example, we are installing the Staff Client on the director's personal system, and have named it as such. Then hit <emphasis role="bold">Register</emphasis>.</para>\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 the \r
+ 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 \r
+ 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/serversideinstallation-staffclient-workstationnames-1.png" scalefit="1" width="70%"/>\r
+ </imageobject>\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 (OPSM) has the \r
+ ability to assign workstation names in his or her library system. Library managers (LIBM's) have the ability within their branch. To assign a workstation a name, login to \r
+ the system. You will be prompted to assign the workstation a library and a name:</para>\r
+ <mediaobject>\r
+ <imageobject>\r
+ <imagedata fileref="../media/serversideinstallation-staffclient-workstationnames-2.png" scalefit="1" width="70%"/>\r
+ </imageobject>\r
+ </mediaobject>\r
+ <para>Select the library this workstation physically operates in from the drop down menu. In this example, we have selected <literal>MGRL-MA</literal>. Type in a friendly name \r
+ for the workstation. In this example, we are installing the Staff Client on the director's personal system, and have named it as such. Then hit \r
+ <emphasis role="bold">Register</emphasis>.</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/serversideinstallation-staffclient-workstationnames-3.png" scalefit="1" width="70%"/>\r
-</imageobject>\r
-</mediaobject>\r
+ <mediaobject>\r
+ <imageobject>\r
+ <imagedata fileref="../media/serversideinstallation-staffclient-workstationnames-3.png" scalefit="1" width="70%"/>\r
+ </imageobject>\r
+ </mediaobject>\r
<para>You are now ready to log into the Staff Client for the first time. Type in your password again, and hit <emphasis role="bold">Login</emphasis>.</para>\r
- </section>\r
+ </simplesect>\r
</section>\r
<section xml:id="serversideinstallation-building-staffclient">\r
<title>Manually Building the Staff Client</title>\r
<para>This section reviews the process of manually building the Staff Client in various environments.</para>\r
- <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>\r
- <section>\r
+ <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 \r
+ <xref linkend="serversideinstallation-compilingevergreen"/> to review details related to building the Staff Client in the final compile/link/install phase of the default Evergreen \r
+ build process.</para>\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 <filename class="directory">/home/opensrf/Evergreen-ILS-1.6.0.7/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 <systemitem class="osname">Linux</systemitem> system. Following is a list of environment variables that can be passed to <command>make</command> to influence the manual build process:</para>\r
- <section>\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.7/Open-ILS/xul/staff_client</filename> for the current Evergreen version). There are a number of possible options \r
+ to manually build special versions of the Staff Client on a <systemitem class="osname">Linux</systemitem> system. Following is a list of environment variables that can be passed \r
+ to <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 date/time string, but you can also override the value of BUILD_ID.</para>\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-ILS-1.6.0.7</userinput>\r
<userinput>make STAFF_CLIENT_BUILD_ID=rel_1_6_0_7 install</userinput>\r
-...\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 \r
build the Staff Client:</para> \r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client</userinput>\r
<userinput>make STAFF_CLIENT_BUILD_ID=my_test_id build</userinput>\r
...\r
</screen> \r
- </section>\r
- <section>\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 in the Evergreen source root. The variable defaults to <emphasis>0trunk.revision</emphasis>, where the value of <literal>revision</literal> is automatically generated. You can override the value of VERSION similarly to the BUILD_ID.</para>\r
+ <para>During the normal <emphasis>make install</emphasis> Evergreen server-side software build process, the variable is pulled automatically from a README file in \r
+ the Evergreen source root. The variable defaults to <emphasis>0trunk.revision</emphasis>, where the value of <literal>revision</literal> 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-ILS-1.6.0.7</userinput>\r
<userinput>$ make STAFF_CLIENT_VERSION=0mytest.200 install</userinput>\r
...\r
\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" \r
+ <ulink url="https://developer.mozilla.org/en/Toolkit_version_format">Toolkit Version Format</ulink> and newer versions need to be higher \r
than older 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 the Staff Client:</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 the \r
+ Staff Client:</para>\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client</userinput>\r
<userinput>make STAFF_CLIENT_VERSION=0mytest.200 build</userinput>\r
-...\r
</screen>\r
- </section>\r
- <section>\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-ILS-1.6.0.7</userinput>\r
<userinput>make STAFF_CLIENT_STAMP_ID=my_test_stamp install</userinput>\r
-...\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
<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-ILS-1.6.0.7/Open-ILS/xul/staff_client</userinput>\r
<userinput>make STAFF_CLIENT_STAMP_ID=my_test_stamp build</userinput>\r
-...\r
</screen> \r
- </section>\r
- </section>\r
- <section>\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 \r
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 \r
<para>As the <systemitem class="username">opensrf</systemitem> user, run <command>make</command> from the Staff Client source directory:</para>\r
<title>Commands to do a "developer build"</title>\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client</userinput>\r
<userinput>make devbuild</userinput>\r
-...\r
</screen> \r
</listitem>\r
<listitem>\r
<para>Compressed Javascript</para>\r
- <para>You can execute the Google application <application>"Closure Compiler"</application> to automatically review and compress Javascript code after the build process completes, by substituting <literal>compress-javascript</literal> for <literal>build</literal> when running <command>make</command>. For more information see <ulink url="http://code.google.com/closure/compiler/">Google "Closure Compiler"</ulink>.</para>\r
+ <para>You can execute the Google application <application>"Closure Compiler"</application> to automatically review and compress Javascript code after the \r
+ build process completes, by substituting <literal>compress-javascript</literal> for <literal>build</literal> when running <command>make</command>. \r
+ For more information see <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
\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client</userinput>\r
<userinput>make compress-javascript</userinput>\r
-...\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
-\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client</userinput>\r
-\r
# order of options is important!\r
<userinput>make devbuild compress-javascript</userinput>\r
-...\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 AUTOUPDATE_HOST option. \r
The following commands could have been used during the normal build process:</para>\r
- <figure>\r
- <title>Commands to set AUTOUPDATE_HOST for normal Evergreen build</title>\r
- <screen>\r
- $ su - root\r
- $ cd /home/opensrf/Evergreen-ILS-1.6.0.7\r
- $ make AUTOUPDATE_HOST=localhost install\r
- ...\r
- </screen>\r
- </figure>\r
+<screen>\r
+<userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7</userinput>\r
+<userinput>make AUTOUPDATE_HOST=localhost install</userinput>\r
+</screen>\r
+ \r
<para>You can manually set AUTOUPDATE_HOST to set up automatic update checking. The following commands will manually build the Staff \r
Client using a different AUTOUPDATE_HOST.</para>\r
<para>As the <systemitem class="username">opensrf</systemitem> user, change directory to the Staff Client source directory, then set the \r
variable and build the Staff Client:</para>\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client</userinput>\r
<userinput>make AUTOUPDATE_HOST=localhost build</userinput>\r
-...\r
</screen>\r
\r
<para>For more information on Automatic Updates, see <xref linkend="serversideinstallation-staffclient-autoupdate"/>.</para>\r
</listitem>\r
</itemizedlist>\r
- </section>\r
- <section>\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 <emphasis>make install</emphasis> process for Evergreen server-side \r
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 \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>, \r
as 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-ILS-1.6.0.7/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
\r
- </section>\r
- <section>\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 targeted <command>make</command> commands in the Staff Client source directory.</para>\r
+ <para>Once the Staff Client has been built, you can create several forms of client packages by using some targeted <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 <emphasis>XULRunner</emphasis>. It requires that you already have the <application>"zip"</application> utility installed on your system. It will create the output file <filename>evergreen_staff_client.xpi</filename>, suitable for use with the <emphasis>XULRunner</emphasis> option <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 following commands:</para>\r
+ <para>This build creates a Staff Client packaged as an XPI file to use with <emphasis>XULRunner</emphasis>. It requires that you already have \r
+ the <application>"zip"</application> utility installed on your system. It will create the output file <filename>evergreen_staff_client.xpi</filename>, \r
+ suitable for use with the <emphasis>XULRunner</emphasis> option <option>--install-app</option>.</para>\r
+ <para>As the <systemitem class="username">opensrf</systemitem> user, change directory to the Staff Client source directory, \r
+ then execute the following commands:</para>\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client</userinput>\r
<userinput>make generic-client</userinput>\r
-...\r
</screen>\r
\r
</listitem>\r
<listitem>\r
<para>Packaging a <systemitem class="osname">Windows</systemitem> Client</para>\r
- <para>This build creates a Staff Client packaged as a <systemitem class="osname">Windows</systemitem> executable. It requires that you already have the <application>"unzip"</application> 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 <systemitem class="osname">Windows</systemitem> installers (the <application>"makensis"</application> utility is installed as part of the <application>"nsis"</application> package). We recommend using Version 2.45 or later. This build will create the output file <filename>evergreen_staff_client_setup.exe</filename>.</para>\r
- <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 <filename>xulrunner-stub.exe</filename>. Place it in the Staff Client source directory and <application>"make"</application> will automatically use it instead of the one that comes with the downloaded <emphasis>XULRunner</emphasis> release. The version of <filename>xulrunner-stub.exe</filename> need not match exactly.</para>\r
- <para>(OPTIONAL) You can also use a tool such as <ulink url="http://www.angusj.com/resourcehacker/">Resource Hacker</ulink> to embed icons. <application>"Resource Hacker"</application> is an open-source utility used to view, modify, rename, add, delete and extract resources in 32bit <systemitem class="osname">Windows</systemitem> executables. See the following table for some useful icon ID strings:</para>\r
+ <para>This build creates a Staff Client packaged as a <systemitem class="osname">Windows</systemitem> executable. It requires that you already have \r
+ the <application>"unzip"</application> utility installed on your system. It also requires that you install <ulink url="http://nsis.sourceforge.net/">NSIS \r
+ (Nullsoft Scriptable Install System)</ulink>, a professional open source utility package used to create <systemitem class="osname">Windows</systemitem> \r
+ installers (the <application>"makensis"</application> utility is installed as part of the <application>"nsis"</application> package). We recommend using \r
+ Version 2.45 or later. This build will create the output file <filename>evergreen_staff_client_setup.exe</filename>.</para>\r
+ <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 \r
+ <filename>xulrunner-stub.exe</filename>. Place it in the Staff Client source directory and <application>"make"</application> will automatically use it instead \r
+ of the one that comes with the downloaded <emphasis>XULRunner</emphasis> release. The version of <filename>xulrunner-stub.exe</filename> need not match \r
+ exactly.</para>\r
+ <para>(OPTIONAL) You can also use a tool such as <ulink url="http://www.angusj.com/resourcehacker/">Resource Hacker</ulink> to embed icons. \r
+ <application>Resource Hacker</application> is an open-source utility used to view, modify, rename, add, delete and extract resources in 32bit \r
+ <systemitem class="osname">Windows</systemitem> executables. See the following table for 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
</table>\r
<para>As 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-ILS-1.6.0.7/Open-ILS/xul/staff_client</userinput>\r
<userinput>make win-client</userinput>\r
-...\r
</screen>\r
</listitem>\r
<listitem>\r
\r
\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client</userinput>\r
<userinput>make linux-client</userinput>\r
-...\r
</screen>\r
\r
</listitem>\r
<para>As the <systemitem class="username">opensrf</systemitem> user, change directory to the Staff Client source directory, then \r
execute the following commands:</para> \r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client</userinput>\r
<userinput>make extension</userinput>\r
-...\r
</screen>\r
\r
</listitem>\r
</itemizedlist>\r
- </section>\r
- <section xml:id="serversideinstallation-staffclient-autoupdate">\r
+ </simplesect>\r
+ <simplesect xml:id="serversideinstallation-staffclient-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 \r
building the Staff Client with certain special options.</para>\r
- <section>\r
+ <simplesect>\r
<title>WARNINGS</title>\r
<para>Automatic update server certificate requirements are more strict than normal server requirements. Firefox and \r
<emphasis>XULRunner</emphasis> will both ignore any automatic update server that is not validated by a trusted certificate authority. \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
<emphasis>install.mccoy.rdf</emphasis>. If the latter exists it will be copied into the build instead of the original file \r
<filename>install.rdf</filename>.</para>\r
- </section>\r
- <section>\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
As the <systemitem class="username">opensrf</systemitem> user, use the <command>configure</command> utility as shown:</para>\r
\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7</userinput>\r
<userinput>./configure --prefix=/openils --sysconfdir=/openils/conf --with-updateshost=hostname</userinput>\r
<userinput>make</userinput>\r
-...\r
</screen>\r
\r
</listitem>\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
- </section>\r
- <section>\r
+ </simplesect>\r
+ <simplesect>\r
<title>Building Updates</title>\r
<para>Similar to building clients, the targets <literal>generic-updates</literal>, <literal>win-updates</literal>, <literal>linux-updates</literal>, \r
and <literal>extension-updates</literal> can be used individually with <command>make</command> to build the update files for the Staff Client. To build \r
all the targets at once, simply use the target <literal>updates</literal>.</para>\r
<para>A "full" update will be built for each specified target (or for all if you use the target <literal>updates</literal>). For all but extensions \r
- any previous "full" updates (archived by default in the directory <filename class="directory">/openils/var/updates/archives</filename>) will be used to \r
- 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 \r
+ any previous full updates (archived by default in the directory <filename class="directory">/openils/var/updates/archives</filename>) will be used to \r
+ 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 \r
full update will be used as a fallback. Extensions do not currently support partial updates.</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-ILS-1.6.0.7/Open-ILS/xul/staff_client</userinput>\r
+ <screen><userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client</userinput></screen>\r
+ <para>Command to build all updates at once:</para>\r
+ <screen><userinput>make updates</userinput></screen>\r
+ <para>Commands to build updates individually:</para>\r
\r
-# command to build all updates at once:\r
-<userinput>make updates</userinput>\r
-...\r
-\r
-# commands to build updates individually:\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
\r
- </section>\r
- <section>\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 the string "-client" to each target name. For instance, you can specify <literal>win-updates-client</literal>. You can also specify <literal>updates-client</literal> to build all the targets at once. This does not work for extension-updates.</para>\r
+ <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 \r
+ can specify <literal>win-updates-client</literal>. You can also specify <literal>updates-client</literal> to build all the targets at once. This does not work for \r
+ extension-updates.</para>\r
<para>The clients will be installed alongside the updates and listed on the web page <uri>manualupdate.html</uri>, rather than left in the Staff 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 commands:</para>\r
-\r
+ <screen><userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client</userinput></screen>\r
+ <para>Command to build all updates at once:</para>\r
+ <screen><userinput>make updates-client</userinput></screen>\r
+ <para>Commands to build updates individually:</para>\r
<screen>\r
-$ su - opensrf\r
-<userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client</userinput>\r
-\r
-# command to build all updates at once:\r
-<userinput>make updates-client</userinput>\r
-...\r
-\r
-# commands to build updates individually:\r
<userinput>make generic-updates-client</userinput>\r
-...\r
<userinput>make win-updates-client</userinput>\r
-...\r
<userinput>make linux-updates-client</userinput>\r
-...\r
</screen>\r
- </section>\r
- <section>\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 a directory <filename class="directory">updates</filename> that, by default, points to the directory \r
<para>The following scripts should be marked as executable: <emphasis>check, download, manualupdate.html, update.rdf</emphasis>. As the \r
<systemitem class="username">root</systemitem> user, change directory to the updates directory, then 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
\r
- </section>\r
- </section>\r
- <section>\r
+ </simplesect>\r
+ </simplesect>\r
+ <simplesect>\r
<title>Other tips</title>\r
- <section>\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 <emphasis>XULRunner</emphasis> you can specify the option <option>-profilemanager</option> or <option>-P</option> (uppercase "P") to force the Profile Manager to start. Unchecking the option <option>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 <literal>win-client</literal>, <literal>win-updates-client</literal>, or <literal>updates-client</literal>, you can specify <literal>NSIS_EXTRAOPTS=-DPROFILES</literal> to add an "Evergreen Staff Client Profile Manager" option to the start menu.</para>\r
+ <para>Multiple workstation registrations for the same server can be accomplished with a single Staff Client install by using multiple profiles. When \r
+ running <emphasis>XULRunner</emphasis> you can specify the option <option>-profilemanager</option> or <option>-P</option> (uppercase "P") to force the Profile Manager \r
+ to start. Unchecking the option <option>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 \r
+ for each profile.</para>\r
+ <para>When building targets <literal>win-client</literal>, <literal>win-updates-client</literal>, or <literal>updates-client</literal>, you can \r
+ specify <literal>NSIS_EXTRAOPTS=-DPROFILES</literal> to add an "Evergreen Staff Client Profile Manager" 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 commands:</para>\r
<screen>\r
-<userinput>su - opensrf</userinput>\r
<userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client</userinput>\r
<userinput>make NSIS_EXTRAOPTS=-DPROFILES win-client</userinput>\r
-...\r
</screen>\r
\r
- </section>\r
- <section>\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 <emphasis>XULRunner</emphasis> with the option <option>-no-remote</option> (in addition to \r
<option>-profilemanger</option> or <option>-P</option> if needed). Instead of <emphasis>XULRunner</emphasis> opening a new login window on your existing \r
session it will start a new session instead, which can then be logged in to a different server or workstation ID.</para>\r
- </section>\r
- </section>\r
+ </simplesect>\r
+ </simplesect>\r
</section>\r
<section xml:id="serversideinstallation-running-staffclient">\r
<title>Running the Staff Client</title>\r
default with Firefox version 3.0 and later on <systemitem class="osname">Ubuntu</systemitem> and <systemitem class="osname">Debian</systemitem> distributions).</para>\r
<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>, \r
start the Staff Client as shown in the following command example:</para>\r
-<screen>\r
-<userinput>su - opensrf</userinput>\r
-<userinput>xulrunner /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client/build/application.ini</userinput>\r
-</screen>\r
+ <screen><userinput>xulrunner /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client/build/application.ini</userinput></screen>\r
</section>\r
<section xml:id="serversideinstallation-proxy">\r
<title>Configuring a Proxy for the Staff Client</title>\r
servers. In addition to providing excellent data security, this method also buffers and caches data traveling to and from the Staff Client and can speed up access to resources \r
on remote Evergreen servers. This is important if your system architecture includes many Staff Clients and Evergreen servers in a busy environment, through network firewalls, \r
or must operate over insecure networks.</para>\r
- <section>\r
+ <simplesect>\r
<title>Why Use 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
This is especially true when wireless is otherwise the best option for connecting a staff machine to the network.</listitem>\r
<listitem>You may wish to buffer and cache data from remote Evergreen servers to speed up access from Staff Clients.</listitem>\r
</itemizedlist>\r
- </section>\r
- <section>\r
+ </simplesect>\r
+ <simplesect>\r
<title>Setting Up an SSH Tunnel</title>\r
<para>You will need a server that has network access to the Evergreen server you want to reach, and allows you to log in there via SSH. Use your username and \r
password for that SSH server to set up a tunnel.</para>\r
<step>Use the menu on the left to go back to "Session", and enter the host name of the SSH server.</step>\r
<step>A window will open up so that you can enter your username and password. Once you are logged in, the tunnel is open.</step>\r
</procedure>\r
- </section>\r
- <section>\r
+ </simplesect>\r
+ <simplesect>\r
<title>Configuring the Staff Client to Use the SSH Tunnel</title>\r
<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 \r
<filename>C:\Program Files\Evergreen Staff Client\greprefs\all.js</filename>. Search this file for the word <emphasis role="bold">socks</emphasis> to \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 SSH \r
tunnel you have just configured.</para>\r
- </section>\r
+ </simplesect>\r
</section>\r
</chapter>\r
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"\r
xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="upgradingevergreen">\r
<info>\r
- <title>Upgrading Evergreen from 1.4 to 1.6.0.8</title>\r
+ <title>Upgrading Evergreen from 1.4 to 1.6.1</title>\r
<abstract>\r
<para>This Chapter will explain the step-by-step process of upgrading <application>Evergreen\r
- </application> from version 1.4 to 1.6, including steps to upgrade <application>OpenSRF</application>. Before \r
+ </application> from version 1.4 to 1.6
.1, including steps to upgrade <application>OpenSRF</application>. Before
\r upgrading, it is important to carefully plan an upgrade strategy to minimize system downtime and \r
service interruptions. All of the steps in this chapter are to be completed from the command line.</para>\r
</abstract>\r
</info> \r
+ <para>In the following instructions, you are asked to perform certain steps as either the root <systemitem class="username"></systemitem> or <systemitem class="username">opensrf</systemitem> user.</para>\r
+ <itemizedlist>\r
+ <listitem>Debian: To become the <systemitem class="username">root</systemitem> user, issue the <command>su</command> command and enter the password of the \r
+ <systemitem class="username">root</systemitem> user.</listitem>\r
+ <listitem>Ubuntu: To become the <systemitem class="username">root</systemitem> user, issue the <command>sudo su</command> command and enter the password of your current user.</listitem>\r
+ </itemizedlist>\r
+ <para>To switch from the <systemitem class="username">root</systemitem> user to a different user, issue the <command>su - [user]</command> command; for example, \r
+ <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 exit command.</para> \r
+ <para>In the following instructions, <filename class='directory'>/path/to/OpenSRF/</filename> represents the path to the OpenSRF source directory.</para>\r
<simplesect>\r
<title>Stop Evergreen and back up data.</title>\r
<procedure>\r
</procedure>\r
</simplesect>\r
<simplesect>\r
- <title>Upgrade OpenSRF<indexterm><primary>OpenSRF</primary><secondary>1.2</secondary></indexterm> to 1.2</title>\r
+ <title>Upgrading OpenSRF to 1.4</title><indexterm><primary>OpenSRF</primary><secondary>1.2</secondary></indexterm>\r
<procedure>\r
<step>\r
<para>As the <systemitem class="username">opensrf</systemitem> user, download and extract the source files for <application>OpenSRF</application> \r
- 1.2:</para>\r
- <screen><userinput>wget http://open-ils.org/downloads/OpenSRF-1.2.2.tar.gz</userinput></screen>\r
- <screen><userinput>tar xzf OpenSRF-1.2.2.tar.gz</userinput></screen>\r
- <para>A new directory OpenSRF-1.2.2 will be created</para>\r
+ 1.4:</para>\r
+<screen><userinput>\r
+wget http://open-ils.org/downloads/OpenSRF-1.4.0.tar.gz\r
+tar xzf OpenSRF-1.4.0.tar.gz\r
+</userinput></screen>\r
+ <para>A new directory OpenSRF-1.4.0 is created.</para>\r
<note><para>For the latest edition of OpenSRF, check the Evergreen download page at \r
<ulink url="http://www.open-ils.org/downloads.php" />.\r
</para></note>\r
<step> \r
<para>As the <systemitem class="username">root</systemitem> user, install the software prerequisites using the automatic \r
prerequisite installer.</para> \r
- <screen><userinput>aptitude install make</userinput></screen>\r
- <screen><userinput>cd /home/opensrf/OpenSRF-1.2.2</userinput></screen>\r
- \r
+<screen><userinput>\r
+aptitude install make\r
+cd /home/opensrf/OpenSRF-1.4.0\r
+</userinput></screen> \r
<para>Replace <option>[distribution]</option> below with the following value \r
for your distribution:</para>\r
<itemizedlist>\r
<para><option>ubuntu-karmic</option> for <systemitem class="osname">Ubuntu Karmic Koala \r
(9.10)</systemitem></para>\r
</listitem>\r
+ <listitem>\r
+ <para><option>ubuntu-lucid</option> for <systemitem class="osname">Ubuntu Lucid Lynx\r
+ (10.04)</systemitem></para>\r
+ </listitem>\r
</itemizedlist>\r
- <screen><userinput>make -f src/extras/Makefile.install <option>[distribution]</option></userinput></screen>\r
+<screen><userinput>\r
+cd /path/to/OpenSRF\r
+make -f src/extras/Makefile.install [distribution]\r
+</userinput></screen>\r
<para>This will install a number of packages required by OpenSRF on your system, \r
including some Perl modules from <systemitem class="resource">CPAN</systemitem><indexterm><primary>Perl</primary><secondary>CPAN</secondary>\r
</indexterm>. You can type <userinput>no</userinput> to the initial <systemitem class="resource">CPAN</systemitem> \r
times whether it should install prerequisite modules - type <userinput>yes</userinput>.</para>\r
</step>\r
<step> \r
- <para>As the opensrf user, configure and compile OpenSRF:</para> \r
+ <para>As the <systemitem class="username">opensrf</systemitem> user, configure and compile OpenSRF:</para> \r
<note>You can include the <option>–enable-python</option> and <option>–enable-java</option> configure options if \r
you want to include support for Python<indexterm><primary>Python</primary></indexterm> and Java\r
<indexterm><primary>Java</primary></indexterm>, respectively.</note>\r
- <screen><userinput>cd /home/opensrf/OpenSRF-1.2.2</userinput></screen>\r
- <screen><userinput>./configure --prefix=/openils --sysconfdir=/openils/conf</userinput></screen>\r
- <screen><userinput>make</userinput></screen>\r
- \r
+<screen><userinput>\r
+cd /home/opensrf/OpenSRF-1.4.0\r
+./configure --prefix=/openils --sysconfdir=/openils/conf\r
+make\r
+</userinput></screen> \r
</step>\r
<step> \r
<para>As the <systemitem class="username">root</systemitem> user, return to your OpenSRF build directory and install \r
OpenSRF:</para>\r
- <screen><userinput>cd /home/opensrf/OpenSRF-1.2.2</userinput></screen>\r
- <screen><userinput>make install</userinput></screen>\r
+<screen><userinput>\r
+cd /home/opensrf/OpenSRF-1.4.0\r
+make install\r
+</userinput></screen>\r
</step>\r
<step>\r
- <para>As the root user, change the ownership of the installed files to the opensrf \r
- user:</para>\r
+ <para>As the <systemitem class="username">root</systemitem> user, change the ownership of the installed files to the \r
+ <systemitem class="username">opensrf</systemitem> user:</para>\r
<screen><userinput>chown -R opensrf:opensrf /openils</userinput></screen>\r
</step>\r
<step>\r
<para>Restart and Test OpenSRF</para>\r
- <screen><userinput>osrf_ctl.sh -l -a start_all</userinput></screen>\r
- <screen><userinput>/openils/bin/srfsh</userinput></screen>\r
- <screen><userinput>srfsh# request opensrf.math add 2 2</userinput></screen>\r
- <para>You should see output like:</para>\r
+<screen><userinput>\r
+osrf_ctl.sh -l -a start_all\r
+/openils/bin/srfsh\r
+srfsh# request opensrf.math add 2 2\r
+</userinput></screen>\r
+ <para>You should see output such as:</para>\r
<screen>\r
Received Data: 4\r
\r
\r
srfsh#\r
</screen> \r
- <para>If test completed successfully move onto next section. \r
+ <para>If test completed successfully move onto the next section. \r
Otherwise, refer to the <link linkend="troubleshooting">troubleshooting</link> chapter \r
of this documentation.</para> \r
</step> \r
</procedure> \r
</simplesect>\r
<simplesect>\r
- <title>Upgrade <application>Evergreen</application> to 1.6</title>\r
+ <title>Upgrade <application>Evergreen</application> to 1.6.1.2</title>\r
<procedure>\r
<step>\r
- <para>As the <systemitem class="username">opensrf</systemitem> user, download and extract <application>Evergreen 1.6</application>\r
+ <para>As the <systemitem class="username">opensrf</systemitem> user, download and extract <application>Evergreen 1.6.1.2</application>\r
</para>\r
- <screen><userinput>wget http://open-ils.org/downloads/Evergreen-ILS-1.6.0.8.tar.gz</userinput></screen>\r
- <screen><userinput>tar xzf Evergreen-ILS-1.6.0.8.tar.gz</userinput></screen>\r
+<screen><userinput>\r
+wget http://open-ils.org/downloads/Evergreen-ILS-1.6.1.2.tar.gz\r
+tar xzf Evergreen-ILS-1.6.1.2.tar.gz\r
+</userinput></screen>\r
<note><para>For the latest edition of Evergreen check the Evergreen download page at\r
<ulink url="http://www.open-ils.org/downloads.php" /> and adjust upgrading instructions accordingly.</para></note>\r
</step>\r
<step>\r
<para>As the <systemitem class="username">root</systemitem> user, install the prerequisites:</para> \r
- <screen><userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.8</userinput></screen> \r
+ <screen><userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2</userinput></screen> \r
<para>On the next command, replace <option>[distribution]</option> with one of \r
these values for your distribution of Debian or Ubuntu:</para>\r
<itemizedlist>\r
<para><option>ubuntu-karmic</option> for <systemitem class="osname">Ubuntu Karmic Koala \r
(9.10)</systemitem></para>\r
</listitem>\r
+ <listitem>\r
+ <para><option>ubuntu-lucid</option> for <systemitem class="osname">Ubuntu Lucid Lynx \r
+ (10.04)</systemitem></para>\r
+ </listitem>\r
</itemizedlist>\r
<screen><userinput>make -f Open-ILS/src/extras/Makefile.install <option>[distribution]</option></userinput></screen>\r
</step>\r
<step>\r
<para>As the <systemitem class="username">opensrf</systemitem> user, configure and compile \r
<application>Evergreen</application>:</para>\r
- <screen><userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.8</userinput></screen>\r
+ <screen><userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2</userinput></screen>\r
<screen><userinput>./configure --prefix=/openils --sysconfdir=/openils/conf</userinput></screen>\r
<screen><userinput>make</userinput></screen>\r
</step>\r
<step>\r
<para>As the <systemitem class="username">root</systemitem> user, install \r
<application>Evergreen</application>:</para>\r
- <screen><userinput>make STAFF_CLIENT_BUILD_ID=rel_1_6_0_8 install</userinput></screen>\r
+ <screen><userinput>make STAFF_CLIENT_BUILD_ID=rel_1_6_1_2 install</userinput></screen>\r
</step>\r
<step>\r
<para>Change to the <application>Evergreen</application> installation \r
directory:</para>\r
- <screen><userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.8</userinput></screen>\r
+ <screen><userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2</userinput></screen>\r
</step>\r
<step>\r
<para>As the <emphasis>root</emphasis> user, change all files to be owned by the \r
<step>\r
<para>As the <systemitem class="username">root</systemitem> user, build <filename>live-db-setup.pl</filename> for the cgi-bin \r
bootstrapping scripts and <filename>offline-config.pl</filename> for the offline staff client data uploader:</para>\r
- <screen><userinput>cd /home/opensrf/Evergreen-ILS-1.6.0.8</userinput></screen> \r
-<screen>\r
-<userinput>\r
+<screen><userinput>\r
+cd /home/opensrf/Evergreen-ILS-1.6.1.2\r
perl Open-ILS/src/support-scripts/eg_db_config.pl --create-bootstrap --create-offline --user evergreen \\r
--password evergreen --hostname localhost --port 5432 --database evergreen\r
-</userinput>\r
-</screen>\r
+</userinput></screen>\r
</step>\r
<step>\r
<para>As the <systemitem class="username">opensrf</systemitem> user, update server symlink in <filename class="directory">/openils/var/web/xul/</filename>:</para>\r
- <screen><userinput>cd /openils/var/web/xul/</userinput></screen>\r
- <screen><userinput>rm server</userinput></screen>\r
- <screen><userinput>ln -s rel_1_6_0_8/server</userinput></screen>\r
+<screen><userinput>\r
+cd /openils/var/web/xul/\r
+rm server\r
+ln -s rel_1_6_1_2/server\r
+</userinput></screen>\r
</step>\r
- \r
<step>\r
<para>Update the Evergreen database:</para>\r
<note><para>it is recommended that you <link linkend="backingup">back up your Evergreen database</link> in order to restore your data if anything goes wrong.</para></note>\r
psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.1-1.6.0.2-upgrade-db.sql evergreen\r
psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.2-1.6.0.3-upgrade-db.sql evergreen \r
psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.3-1.6.0.4-upgrade-db.sql evergreen\r
-psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.4-1.6.0.5-upgrade-db.sql evergreen\r
-psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.5-1.6.0.6-upgrade-db.sql evergreen\r
-psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.6-1.6.0.7-upgrade-db.sql evergreen \r
-psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.7-1.6.0.8-upgrade-db.sql evergreen\r
+psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.4-1.6.1.0-upgrade-db.sql evergreen\r
+psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.1.0-1.6.1.1-upgrade-db.sql evergreen\r
+psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.1.1-1.6.1.2-upgrade-db.sql evergreen\r
</userinput>\r
-</screen> \r
- <para>Download and run the the billing view hot-fix script</para> \r
- <screen><userinput>wget http://www.open-ils.org/downloads/1.6.0-mmbxs-cleanup.sql</userinput></screen>\r
- <screen><userinput>psql -U evergreen -h localhost -f 1.6.0-mmbxs-cleanup.sql</userinput></screen> \r
+</screen> \r
</step>\r
<step>\r
<para>As the <systemitem class="username">opensrf</systemitem> user, \r
</step>\r
<step>\r
<para>Update <filename>opensrf.xml</filename> with the database connection info:</para>\r
-<screen>\r
-<userinput>\r
+<screen><userinput>\r
perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config --service all --user evergreen \\r
--password evergreen --hostname localhost --port 5432 --database evergreen\r
-</userinput>\r
- </screen>\r
+</userinput></screen>\r
</step>\r
<step>\r
<para>Update /etc/apache2/startup.pl by copying the example from \r
<step>\r
<para>As the <systemitem class="username">opensrf</systemitem> user, run <command>autogen</command> to refresh the static \r
organizational data files:</para><indexterm><primary>autogen</primary></indexterm>\r
- <screen><userinput>cd /openils/bin</userinput></screen>\r
- <screen><userinput>./autogen.sh -c /openils/conf/opensrf_core.xml -u</userinput></screen>\r
+<screen><userinput>\r
+cd /openils/bin\r
+./autogen.sh -c /openils/conf/opensrf_core.xml -u\r
+</userinput></screen>\r
\r
</step>\r
<step>\r
<para>Start <command>srfsh</command> and try logging in using your <application>Evergreen</application>\r
username and password:</para>\r
- <screen><userinput>/openils/bin/srfsh</userinput></screen> \r
- <screen><prompt>srfsh%</prompt> <userinput>login <option>username</option> <option>password</option></userinput></screen> \r
+<screen>\r
+<userinput>/openils/bin/srfsh</userinput>\r
+<prompt>srfsh%</prompt> <userinput>login <option>username</option> <option>password</option></userinput>\r
+</screen> \r
</step> \r
<step>\r
<para>Start the <application>Apache</application> web server.</para>\r
</note>\r
</simplesect>\r
<simplesect>\r
- <title>Upgrading PostgreSQL from 8.2 to 8.3</title>\r
- <para>Evergreen 1.6 supports PostgreSQL version 8.3 and it is recommended that you upgrade PostgreSQL when you upgrade Evergreen to 1.6.</para>\r
+ <title>Upgrading PostgreSQL from 8.2 to 8.4</title>\r
+ <para>Evergreen 1.6.1 supports PostgreSQL version 8.4 and it is recommended that you upgrade PostgreSQL when you upgrade Evergreen to 1.6.</para>\r
<note><para>The order of the following steps is very important.</para></note><indexterm><primary>databases</primary><secondary>PostgreSQL</secondary></indexterm>\r
<procedure>\r
<step>\r
<step>\r
<para><link linkend="backingup">Backup the Evergreen database data</link></para>\r
</step>\r
+ <step>\r
+ <para>Upgrade to Postgresql 8.4 by removing old version and installing Postgresql 8.4</para>\r
+ </step>\r
<step> \r
- <para>Create an empty Evergreen database in postgresql 8.3 by issuing the following commands as the postgres user:</para>\r
+ <para>Create an empty Evergreen database in postgresql 8.4 by issuing the following commands as the postgres user:</para>\r
<screen>\r
<userinput>\r
createdb -E UNICODE evergreen\r
createlang plperl evergreen\r
createlang plperlu evergreen\r
createlang plpgsql evergreen\r
-psql -f /usr/share/postgresql/8.3/contrib/tablefunc.sql evergreen\r
-psql -f /usr/share/postgresql/8.3/contrib/tsearch2.sql evergreen\r
-psql -f /usr/share/postgresql/8.3/contrib/pgxml.sql evergreen\r
+psql -f /usr/share/postgresql/8.4/contrib/tablefunc.sql evergreen\r
+psql -f /usr/share/postgresql/8.4/contrib/tsearch2.sql evergreen\r
+psql -f /usr/share/postgresql/8.4/contrib/pgxml.sql evergreen\r
</userinput>\r
</screen> \r
</step>\r
<para>Restore data from backup created in step 1.</para>\r
</step>\r
<step>\r
- <para>To point tsearch2 to proper function names in 8.3, run the SQL script \r
+ <para>To point tsearch2 to proper function names in 8.4, run the SQL script \r
<filename>/home/opensrf/Evergreen-ILS*/Open-ILS/src/sql/Pg/000.english.pg83.fts-config.sql</filename> using the <command>psql</command> command.</para>\r
<screen><userinput>cd /home/opensrf/Evergreen-ILS*</userinput></screen>\r
<screen><userinput>psql -f /Open-ILS/src/sql/Pg/000.english.pg83.fts-config.sql evergreen</userinput></screen>\r
</step>\r
<step>\r
<para>For additional information regarding upgrading PostgreSQL, see the following documentation in PostgreSQL:</para>\r
- <para><ulink url="http://www.postgresql.org/docs/8.3/static/install-upgrading.html" /></para>\r
- <para><ulink url="http://www.postgresql.org/docs/8.3/interactive/textsearch-migration.html" /> \r
+ <para><ulink url="http://www.postgresql.org/docs/8.4/static/install-upgrading.html" /></para>\r
+ <para><ulink url="http://www.postgresql.org/docs/8.4/interactive/textsearch-migration.html" /> \r
</para>\r
<para><ulink url="http://www.postgresql.org/docs/current/static/tsearch2.html#AEN102824" /></para>\r
</step>\r
--- /dev/null
+<?xml version='1.0' encoding='UTF-8'?>\r
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"\r
+ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="installation-previousversions">\r
+\r
+ <title>Installing Previous Versions of Evergreen</title>\r
+ <para>Earlier releases of Evergreen are available. Instructions for installing, configuring and testing earlier versions are found below.</para>\r
+ <para>The next most recent previous release of Evergreen is version <emphasis><emphasis role="bold">1.4.0.6</emphasis></emphasis>. The accompanying previous release of OpenSRF \r
+ is version <emphasis><emphasis role="bold">1.0.7</emphasis></emphasis>.</para>\r
+ <section xml:id="serversideinstallation-evergreen-previous">\r
+ <title>Installing Evergreen 1.4.0.6 On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem></title>\r
+ <para>This section outlines the installation process for the previous version 1.4.0.6 of Evergreen.</para>\r
+ <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>\r
+ <note>\r
+ <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>\r
+ <para>If you are starting with a clean install of <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem>, you are strongly recommended <emphasis role="bold">not</emphasis> to install the packaged PostgreSQL server. This can confuse port numbers and system configuration. Evergreen 1.4 requires PostgreSQL 8.2.</para>\r
+ </note>\r
+ <section>\r
+ <title>Installing OpenSRF 1.0.7</title>\r
+ <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-previous"/>.</para>\r
+ <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>\r
+ </section>\r
+ <section>\r
+ <title>Download and Unpack Evergreen Version 1.4.0.6</title>\r
+ <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.4.0.6.tar.gz"></ulink></para>\r
+ <figure>\r
+ <title>Commands to download and unpack Evergreen</title>\r
+ <screen>\r
+ $ su - opensrf\r
+ $ wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.4.0.6.tar.gz\r
+ $ tar zxf Evergreen-ILS-1.4.0.6.tar.gz\r
+ </screen>\r
+ </figure>\r
+ <para>The new directory <filename class="directory">/home/opensrf/Evergreen-ILS-1.4.0.6</filename> will be created.</para>\r
+ </section>\r
+ <section>\r
+ <title>Install Prerequisites to Build Evergreen</title>\r
+ <para>In this section you will install and configure a set of prerequisites that will be used to build Evergreen. In a following step you will actually build the software using the <command>make</command> utility.</para>\r
+ <para>As the <systemitem class="username">root</systemitem> user, enter the commands show below to build the prerequisites from the software distribution that you just downloaded and unpacked. Remember to replace <emphasis>[distribution]</emphasis> in the example with the keyword corresponding to the actual <systemitem class="osname">Linux</systemitem> distribution listed in the <link linkend="serversideinstallation-keywords-figure-2-a">"Keywords"</link> figure below.</para>\r
+ <figure>\r
+ <title>Commands to install prerequisites for Evergreen</title>\r
+ <screen>\r
+ $ su - root\r
+ $ cd /home/opensrf/Evergreen-ILS-1.4.0.6\r
+ $ make -f Open-ILS/src/extras/Makefile.install [distribution]\r
+ ...\r
+ </screen>\r
+ </figure>\r
+ <table xml:id="serversideinstallation-keywords-figure-2-a">\r
+ <title>Keywords Targets for <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-lenny</entry>\r
+ <entry>for Debian Lenny (5.0)</entry>\r
+ </row>\r
+ <row>\r
+ <entry>debian-etch</entry>\r
+ <entry>for Debian Etch (4.0)</entry>\r
+ </row>\r
+ <row>\r
+ <entry>ubuntu-intrepid</entry>\r
+ <entry>for Ubuntu Intrepid (8.10)</entry>\r
+ </row>\r
+ <row>\r
+ <entry>ubuntu-hardy</entry>\r
+ <entry>for Ubuntu Hardy (8.04)</entry>\r
+ </row>\r
+ </tbody>\r
+ </tgroup>\r
+ </table>\r
+ </section>\r
+ <section>\r
+ <title>Update the System Dynamic Library Path</title>\r
+ <para>As the <systemitem class="username">root</systemitem> user, you must update the system dynamic library path to make your system recognize the newly installed libraries. Do this by creating the new file <filename>/etc/ld.so.conf.d/eg.conf</filename> containing two new library paths, then run the command <command>ldconfig</command> to automatically read the file and modify the system dynamic library path:</para>\r
+ <figure>\r
+ <title>Commands to modify system dynamic library path</title>\r
+ <screen>\r
+ $ su - root\r
+ $ cat > /etc/ld.so.conf.d/eg.conf << ENDOFFILE\r
+ /usr/local/lib\r
+ /usr/local/lib/dbd\r
+ ENDOFFILE\r
+ $ ldconfig\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Restart the PostgreSQL Server</title>\r
+ <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 the PostgreSQL server to avoid a problem where the library <filename>plperl.so</filename> cannot be found. If your PostgreSQL server is running on another system, just skip this step.</para>\r
+ <figure>\r
+ <title>Commands to restart PostgreSQL server</title>\r
+ <screen>\r
+ $ su - root\r
+ $ /etc/init.d/postgresql-8.2 restart\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Configure Evergreen</title>\r
+ <para>As the <systemitem class="username">opensrf</systemitem> user, return to the Evergreen build directory and use the <command>configure</command> utility to prepare for the next step of compiling and linking the software:</para>\r
+ <figure>\r
+ <title>Commands to configure Evergreen</title>\r
+ <screen>\r
+ $ su - opensrf\r
+ $ cd /home/opensrf/Evergreen-ILS-1.4.0.6\r
+ $ ./configure --prefix=/openils --sysconfdir=/openils/conf\r
+ $ make\r
+ ...\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Compile, Link and Install Evergreen</title>\r
+ <para>In this step you will actually compile, link and install Evergreen and the default Evergreen Staff Client.</para>\r
+ <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>\r
+ <para>For further information on manually building the Staff Client, see <xref linkend="serversideinstallation-building-staffclient"/>.</para>\r
+ <figure>\r
+ <title>Commands to build, link and install Evergreen</title>\r
+ <screen>\r
+ $ su - root\r
+ $ cd /home/opensrf/Evergreen-ILS-1.4.0.6\r
+ $ make STAFF_CLIENT_BUILD_ID=rel_1_4_0_6 install\r
+ ...\r
+ </screen>\r
+ <para>The above commands will create a new subdirectory <filename class="directory">/openils/var/web/xul/rel_1_4_0_6</filename> containing the Staff Client.</para>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Copy the OpenSRF Configuration Files</title>\r
+ <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>\r
+ <figure>\r
+ <title>Commands to copy OpenSRF configuration files</title>\r
+ <screen>\r
+ $ su - root\r
+ $ cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml\r
+ $ cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml\r
+ $ chown -R opensrf:opensrf /openils/\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Create and Configure PostgreSQL Database</title>\r
+ <para>As the <systemitem class="username">postgres</systemitem> user on your PostgreSQL server, create the Evergreen database.</para>\r
+ <para>In the commands below, remember to adjust the path of the <emphasis role="bold">contrib</emphasis> repository to match your PostgreSQL server layout. For example, if you built PostgreSQL from source the path would be <filename class="directory">/usr/local/share/contrib</filename>; if you installed the PostgreSQL 8.2 server packages on <systemitem class="osname">Ubuntu 8.04</systemitem>, the path would be <filename class="directory">/usr/share/postgresql/8.2/contrib/</filename>.</para>\r
+ <procedure>\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> user on the PostgreSQL system create the PostgreSQL database, then set some internal paths:</para>\r
+ <figure>\r
+ <title>Commands to create database and adjust the path</title>\r
+ <screen>\r
+ # create the database\r
+ $ su - postgres\r
+ $ createdb -E UNICODE evergreen\r
+ $ createlang plperl evergreen\r
+ $ createlang plperlu evergreen\r
+ $ createlang plpgsql evergreen\r
+ \r
+ # adjust the paths\r
+ $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tablefunc.sql evergreen\r
+ $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tsearch2.sql evergreen\r
+ $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/pgxml.sql evergreen\r
+ </screen>\r
+ </figure>\r
+ <emphasis>Where <literal>PGSQL_VERSION</literal> is your installed PostgreSQL version (e.g. <literal>8.2</literal>).</emphasis>\r
+ </step>\r
+ <step>\r
+ <para>\r
+ <emphasis role="bold">Create new Evergreen superuser</emphasis>\r
+ </para>\r
+ <para>As the <systemitem class="username">postgres</systemitem> user on the PostgreSQL system, create the \r
+ new database <systemitem class="username">evergreen</systemitem> user and assign a password:</para>\r
+<screen>\r
+# create superuser 'evergreen' and set the password\r
+<userinput>su - postgres</userinput>\r
+<userinput>createuser -P -s evergreen</userinput>\r
+<prompt>Enter password for new role:</prompt> <userinput>MYNEWPASSWORD</userinput>\r
+<prompt>Enter it again:</prompt><userinput>MYNEWPASSWORD</userinput>\r
+</screen>\r
+ <emphasis>Where <literal>MYNEWPASSWORD</literal> is the password chosen.</emphasis>\r
+ </step>\r
+ </procedure>\r
+ </section>\r
+ <section>\r
+ <title>Create Database Schema</title>\r
+ <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>\r
+ <para>Enter the following commands and replace <emphasis>HOSTNAME, PORT, PASSWORD</emphasis> and <emphasis>DATABASENAME</emphasis> with appropriate values.</para>\r
+ <figure>\r
+ <title>Commands to create Evergreen database schema</title>\r
+ <screen>\r
+ $ su - root\r
+ $ cd /home/opensrf/Evergreen-ILS-1.4.0.6\r
+ $ perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \\r
+ --service all --create-schema --create-bootstrap --create-offline \\r
+ --hostname HOSTNAME --port PORT \\r
+ --user evergreen --password PASSWORD --database DATABASENAME\r
+ </screen>\r
+ </figure>\r
+ <emphasis>Where, 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 those assigned when PostgreSQL was installed in the previous step.</emphasis>\r
+ <note>\r
+ <para>\r
+ <emphasis>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.</emphasis>\r
+ </para>\r
+ </note>\r
+ </section>\r
+ <section>\r
+ <title>Evergreen installation - (continued)</title>\r
+ <para><emphasis>The remainder of the Evergreen installation procedure is identical to that for installing the latest version of Evergreen. Continue with the instructions found in</emphasis> <xref linkend="serversideinstallation-modify-apache"/>.</para>\r
+ </section>\r
+ </section>\r
+ <section xml:id="serversideinstallation-opensrf-previous">\r
+ <title>Installing OpenSRF 1.0.7 On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem></title>\r
+ <para>This section describes the installation of the previous 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>\r
+ <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>\r
+ <note>\r
+ <para>The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) platforms. OpenSRF 1.0.7 has been tested on <systemitem class="osname">Debian Etch (4.0)</systemitem>, <systemitem class="osname">Debian Lenny</systemitem>, <systemitem class="osname">Ubuntu Hardy Heron (8.04)</systemitem>, and <systemitem class="osname">Ubuntu Intrepid Ibex (8.10)</systemitem>.</para>\r
+ <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>\r
+ <itemizedlist>\r
+ <listitem><systemitem class="osname">Debian</systemitem> -- To become the <systemitem class="username">root</systemitem> user, issue the command <command>su -</command> and enter the password of the <systemitem class="username">root</systemitem> user.</listitem>\r
+ <listitem><systemitem class="osname">Ubuntu</systemitem> -- To become the <systemitem class="username">root</systemitem> user, issue the command <command>sudo su -</command> and enter the password of the <systemitem class="username">root</systemitem> user.</listitem>\r
+ </itemizedlist>\r
+ <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>\r
+ </note>\r
+ <section>\r
+ <title>Add the OpenSRF User</title>\r
+ <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>\r
+ <figure>\r
+ <title>Commands to add <systemitem class="username">opensrf</systemitem> user</title>\r
+ <screen>\r
+ $ su - opensrf\r
+ $ useradd -m -s /bin/bash opensrf\r
+ $ passwd opensrf\r
+ Enter new UNIX password: ******\r
+ Retype new UNIX password: ******\r
+ passwd: password updated successfully\r
+ $\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Download and Unpack Latest OpenSRF Version</title>\r
+ <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.0.7.tar.gz"></ulink></para>\r
+ <figure>\r
+ <title>Commands to download and unpack OpenSRF</title>\r
+ <screen>\r
+ $ su - opensrf\r
+ $ wget http://evergreen-ils.org/downloads/OpenSRF-1.0.7.tar.gz\r
+ $ tar zxf OpenSRF-1.0.7.tar.gz\r
+ </screen>\r
+ </figure>\r
+ <para>The new directory <filename class="directory">/home/opensrf/OpenSRF-1.0.7</filename> will be created.</para>\r
+ </section>\r
+ <section>\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 used to build OpenSRF. In a following step you will actually build the software using the <command>make</command> utility.</para>\r
+ <para>As the <systemitem class="username">root</systemitem> user, enter the commands show below to build the prerequisites from the software distribution that you just downloaded and unpacked. Remember to replace <emphasis>[DISTRIBUTION]</emphasis> in the example with the keyword corresponding to the actual <systemitem class="osname">Linux</systemitem> distribution listed in the <link linkend="serversideinstallation-keywords-figure-1a">"Keywords"</link> figure below.</para>\r
+ <figure>\r
+ <title>Commands to install prerequisites for OpenSRF</title>\r
+ <screen>\r
+ $ su - root\r
+ $ cd /home/opensrf/OpenSRF-1.0.7\r
+ $ make -f src/extras/Makefile.install [DISTRIBUTION]\r
+ ...\r
+ </screen>\r
+ </figure>\r
+ <table xml:id="serversideinstallation-keywords-figure-1a">\r
+ <title>Keywords Targets for <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-lenny</entry>\r
+ <entry>for Debian Lenny (5.0)</entry>\r
+ </row>\r
+ <row>\r
+ <entry>debian-etch</entry>\r
+ <entry>for Debian Etch (4.0)</entry>\r
+ </row>\r
+ <row>\r
+ <entry>ubuntu-intrepid</entry>\r
+ <entry>for Intrepid (8.10)</entry>\r
+ </row>\r
+ <row>\r
+ <entry>ubuntu-hardy</entry>\r
+ <entry>for Ubuntu Hardy (8.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, 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>\r
+ </section>\r
+ <section>\r
+ <title>Configure OpenSRF</title>\r
+ <para>As the <systemitem class="username">opensrf</systemitem> user, return to the OpenSRF build directory and use the <command>configure</command> utility to prepare for the next step of compiling and linking the software. You can include the <option>--enable-python</option> and <option>--enable-java</option> configuration options if you wish to include support for Python and Java, respectively:</para>\r
+ <figure>\r
+ <title>Commands to configure OpenSRF</title>\r
+ <screen>\r
+ $ su - opensrf\r
+ $ cd /home/opensrf/OpenSRF-1.0.7\r
+ $ ./configure --prefix=/openils --sysconfdir=/openils/conf\r
+ $ make\r
+ ...\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Compile, Link and Install OpenSRF</title>\r
+ <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>\r
+ <figure>\r
+ <title>Commands to build, link and install OpenSRF</title>\r
+ <screen>\r
+ $ su - opensrf\r
+ $ cd /home/opensrf/OpenSRF-1.0.7\r
+ $ make install\r
+ ...\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Update the System Dynamic Library Path</title>\r
+ <para>As the <systemitem class="username">root</systemitem> user, you must update the system dynamic library path to make your system recognize the newly installed libraries. Do this by creating the new file <filename>/etc/ld.so.conf.d/osrf.conf</filename> containing a new library path, then run the command <command>ldconfig</command> to automatically read the file and modify the system dynamic library path:</para>\r
+ <figure>\r
+ <title>Commands to modify system dynamic library path</title>\r
+ <screen>\r
+ $ su - root\r
+ $ echo "/openils/lib" > /etc/ld.so.conf.d/osrf.conf\r
+ $ ldconfig\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Define Public and Private OpenSRF Domains</title>\r
+ <para>Define your public and private OpenSRF domains. For security purposes, OpenSRF uses Jabber domains to separate services into public and private realms. Throughout these instructions, we will use the example domains <systemitem class="domainname">public.localhost</systemitem> for the public domain and <systemitem class="domainname">private.localhost</systemitem> for the private domain. On a single-server system, the easiest way to define public and private domains is to define separate host names by adding entries to the file <filename>/etc/hosts</filename>.</para>\r
+ <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>\r
+ <figure>\r
+ <title>Example public and private domains in /etc/hosts</title>\r
+ <screen>\r
+ 127.0.1.2 public.localhost public\r
+ 127.0.1.3 private.localhost private\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Change File Ownerships</title>\r
+ <para>As the <systemitem class="username">root</systemitem> user, change the ownership of files installed in the directory <filename class="directory">/openils</filename> to the <systemitem class="username">opensrf</systemitem> user:</para>\r
+ <figure>\r
+ <title>Commands to change file ownerships</title>\r
+ <screen>\r
+ $ chown -R opensrf:opensrf /openils\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Stop the <systemitem class="service">ejabberd</systemitem> Service</title>\r
+ <para>As the <systemitem class="username">root</systemitem> user, stop the <systemitem class="service">ejabberd</systemitem> service:</para>\r
+ <figure>\r
+ <title>Commands to stop the <systemitem class="service">ejabberd</systemitem> service</title>\r
+ <screen>\r
+ $ /etc/init.d/ejabberd stop\r
+ </screen>\r
+ </figure>\r
+ <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>\r
+ <figure>\r
+ <title>Commands to recover from <systemitem class="service">ejabberd</systemitem> errors</title>\r
+ <screen>\r
+ $ su - root\r
+ $ epmd -kill\r
+ $ killall beam; killall beam.smp\r
+ $ rm /var/lib/ejabberd/*\r
+ $ echo 'ERLANG_NODE=ejabberd@localhost' >> /etc/default/ejabberd\r
+ </screen>\r
+ </figure>\r
+ </section>\r
+ <section>\r
+ <title>Edit the <systemitem class="service">ejabberd</systemitem> configuration</title>\r
+ <para>As the <systemitem class="username">root</systemitem> user, edit the file <filename>/etc/ejabberd/ejabberd.cfg</filename> and make the following changes:</para>\r
+ <itemizedlist>\r
+ <listitem>Change <literal>{hosts, ["localhost"]}.</literal> to <literal>{hosts, ["localhost", "private.localhost", "public.localhost"]}.</literal></listitem>\r
+ <listitem>Change <literal>{max_user_sessions, 10}.</literal> to <literal>{max_user_sessions, 1000}.</literal> If you see something like this instead: <literal>{access, max_user_sessions, [{10, all}]}.</literal>, then change it to <literal>{access, max_user_sessions, [{1000, all}]}.</literal></listitem>\r
+ <listitem>Change all three occurrences of <literal>max_stanza_size</literal> to <literal>2000000</literal>.</listitem>\r
+ <listitem>Change both occurrences of <literal>maxrate</literal> to <literal>500000</literal>.</listitem>\r
+ <listitem>Comment out the line <literal>{mod_offline, []}</literal> by placing two <literal>%</literal> comment signs in front.</listitem>\r
+ </itemizedlist>\r
+ </section>\r
+ <section>\r
+ <title>OpenSRF installation - (continued)</title>\r
+ <para>\r
+ <emphasis>The remainder of the OpenSRF installation procedure is identical to that for installing the latest version of OpenSRF. Continue with the instructions found in <xref linkend="serversideinstallation-opensrf-continued"/>.</emphasis>\r
+ </para>\r
+ </section>\r
+ </section>\r
+ </section>\r
+ <section xml:id="serversideinstallation-postgresql">\r
+ <title>Installing PostgreSQL</title>\r
+ <para>In production Evergreen systems, the PostgreSQL database server may reside on the same system on which Evergreen is installed or on another standalone system so, by default, PostgreSQL is not automatically installed along with Evergreen. This section details the steps needed to manually install PostgreSQL on a <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> system.</para>\r
+ <para>If your PostgreSQL server will be on the same system as your Evergreen software, return to the previous section <xref linkend="serversideinstallation-postgresql-default"/> and follow those instructions. Otherwise, to manually install PostgreSQL on a system, continue with the instructions below.</para>\r
+ <note>\r
+ <para>Some <systemitem class="osname">Linux</systemitem> distributions, such as <systemitem class="osname">Debian Etch (4.0)</systemitem>, do not offer PostgreSQL version 8.2 as an installable package. Before you continue, examine the software dependencies listed in <xref linkend="serversideinstall-software-dependencies"/> to ensure that your Linux distribution supports the required version of PostgreSQL.</para>\r
+ </note>\r
+ <procedure>\r
+ <step>\r
+ <para>Install the application <application>"stow"</application> on your system if it is not already installed. Issue the following command as the <systemitem class="username">root</systemitem> user:</para>\r
+ <figure>\r
+ <title>Installing <application>"stow"</application></title>\r
+ <screen>\r
+ $ apt-get install stow\r
+ ...\r
+ </screen>\r
+ </figure>\r
+ </step>\r
+ <step>\r
+ <para>Download, compile, and install the latest release for PostgreSQL 8.2 (which was version <literal>8.2.12</literal> at the time of this writing). As the <systemitem class="username">root</systemitem> user, follow these steps:</para>\r
+ <figure>\r
+ <title>Installing PostgreSQL</title>\r
+ <screen>\r
+ $ wget http://wwwmaster.postgresql.org/redir/198/h/source/v8.2.17/postgresql-8.2.17.tar.bz2\r
+ $ tar xzf postgresql-8.2.17.tar.gz\r
+ $ cd postgresql-8.2.17\r
+ $ ./configure --with-perl --enable-integer-datetimes --with-openssl --prefix=/usr/local/stow/pgsql\r
+ ...\r
+ $ make\r
+ ...\r
+ $ make install\r
+ ...\r
+ $ cd contrib\r
+ $ make\r
+ ...\r
+ $ make install\r
+ $ cd xml2\r
+ $ make\r
+ ...\r
+ $ make install\r
+ $ cd /usr/local/stow\r
+ $ stow pgsql\r
+ </screen>\r
+ </figure>\r
+ </step>\r
+ <step>\r
+ <para>Create the new user <systemitem class="username">postgres</systemitem> to run the PostgreSQL processes. As the <systemitem class="username">root</systemitem> user, execute this command:</para>\r
+ <figure>\r
+ <title>Adding <systemitem class="username">postgres</systemitem></title>\r
+ <screen>\r
+ $ adduser postgres\r
+ </screen>\r
+ </figure>\r
+ </step>\r
+ <step>\r
+ <para>Initialize the database directory and start up PostgreSQL. As the <systemitem class="username">root</systemitem> user, follow these steps:</para>\r
+ <figure>\r
+ <title>Adding <systemitem class="username">postgres</systemitem></title>\r
+ <screen>\r
+ $ mkdir -p /usr/local/pgsql/data\r
+ $ chown postgres /usr/local/pgsql/data\r
+ $ su - postgres\r
+ $ initdb -D /usr/local/pgsql/data -E UNICODE --locale=C\r
+ $ pg_ctl -D /usr/local/pgsql/data -l /home/postgres/logfile start\r
+ </screen>\r
+ </figure>\r
+ <note>\r
+ <para>If an error occurs during the final step above, review the path of the home directory for the <systemitem class="username">postgres</systemitem> user. It may be <literal>/var/lib/postresql</literal> instead of <literal>/home/postres</literal>.</para>\r
+ </note>\r
+ </step>\r
+ <step>\r
+ <para>The values of several PostreSQL configuration parameters may be changed for enhanced performance. The following table lists the default values and some suggested updates for several useful parameters:</para>\r
+ <table>\r
+ <title>Suggested configuration values</title>\r
+ <tgroup align="left" cols="3" colsep="1" rowsep="1">\r
+ <colspec colnum="1" colwidth="1.0*"/>\r
+ <colspec colnum="2" colwidth="1.0*"/>\r
+ <colspec colnum="3" colwidth="1.0*"/>\r
+ <thead>\r
+ <row>\r
+ <entry>Parameter</entry>\r
+ <entry>Default</entry>\r
+ <entry>Suggested</entry>\r
+ </row>\r
+ </thead>\r
+ <tbody>\r
+ <row>\r
+ <entry>default_statistics_target</entry>\r
+ <entry>10</entry>\r
+ <entry>100</entry>\r
+ </row>\r
+ <row>\r
+ <entry>work_mem</entry>\r
+ <entry>4Mb</entry>\r
+ <entry>128Mb</entry>\r
+ </row>\r
+ <row>\r
+ <entry>shared_buffers</entry>\r
+ <entry>8Mb</entry>\r
+ <entry>512Mb</entry>\r
+ </row>\r
+ <row>\r
+ <entry>effective_cache_size</entry>\r
+ <entry>128Mb</entry>\r
+ <entry>4Gb</entry>\r
+ </row>\r
+ </tbody>\r
+ </tgroup>\r
+ </table>\r
+ <indexterm>\r
+ <primary>ZZZ-REVIEW</primary>\r
+ <secondary>ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS</secondary>\r
+ </indexterm>\r
+ <caution>ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS </caution>\r
+ </step>\r
+ </procedure>\r
+ </section>\r
+ <section xml:id="serversideinstallation-apache">\r
+ <title>Installing Apache</title>\r
+ <section>\r
+ <title>Securing Apache (httpd)</title>\r
+ <para>The main consideration is to secure the directory <filename class="directory">cgi-bin</filename>. The only persons that need access to this directory are Evergreen system administrators. This directory should be restricted by both IP (to those workstations designated as Evergeen Administration systems), and by username/password.</para>\r
+ <indexterm>\r
+ <primary>ZZZ-REVIEW</primary>\r
+ <secondary>ADD CONTENT ON HOW TO RESTRICT APACHE BY IP AND USERNAME/PASSWORD </secondary>\r
+ </indexterm>\r
+ <caution>ADD CONTENT ON HOW TO RESTRICT APACHE BY IP AND USERNAME/PASSWORD </caution>\r
+ <para>A user could add new libraries, re-arrange consortia, or change user groups; or a staff member could access the directory, and change his associated security group to administrative level privileges.</para>\r
+ </section>\r
+ <indexterm>\r
+ <primary>ZZZ-REVIEW</primary>\r
+ <secondary>ADD MORE CONTENT FOR APACHE </secondary>\r
+ </indexterm>\r
+ <caution>ADD MORE CONTENT FOR APACHE </caution>\r
+ </section>\r
+ </chapter>\r
--- /dev/null
+<?xml version='1.0' encoding='UTF-8'?>\r
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"\r
+ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serversideinstallation-postgresql">\r
+ <title>Installing PostgreSQL</title>\r
+ <para>In production Evergreen systems, the PostgreSQL database server may reside on the same system on which Evergreen is installed or on another standalone system so, by default, PostgreSQL is not automatically installed along with Evergreen. This section details the steps needed to manually install PostgreSQL on a <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> system.</para>\r
+ <para>If your PostgreSQL server will be on the same system as your Evergreen software, return to the previous section <xref linkend="serversideinstallation-postgresql-default"/> and follow those instructions. Otherwise, to manually install PostgreSQL on a system, continue with the instructions below.</para>\r
+ <note>\r
+ <para>Some <systemitem class="osname">Linux</systemitem> distributions, such as <systemitem class="osname">Debian Etch (4.0)</systemitem>, do not offer PostgreSQL version 8.2 as an installable package. Before you continue, examine the software dependencies listed in <xref linkend="serversideinstall-software-dependencies"/> to ensure that your Linux distribution supports the required version of PostgreSQL.</para>\r
+ </note>\r
+ <procedure>\r
+ <step>\r
+ <para>Install the application <application>"stow"</application> on your system if it is not already installed. Issue the following command as the <systemitem class="username">root</systemitem> user:</para>\r
+ <figure>\r
+ <title>Installing <application>"stow"</application></title>\r
+ <screen>\r
+ $ apt-get install stow\r
+ ...\r
+ </screen>\r
+ </figure>\r
+ </step>\r
+ <step>\r
+ <para>Download, compile, and install the latest release for PostgreSQL 8.2 (which was version <literal>8.2.12</literal> at the time of this writing). As the <systemitem class="username">root</systemitem> user, follow these steps:</para>\r
+ <figure>\r
+ <title>Installing PostgreSQL</title>\r
+ <screen>\r
+ $ wget http://wwwmaster.postgresql.org/redir/198/h/source/v8.2.17/postgresql-8.2.17.tar.bz2\r
+ $ tar xzf postgresql-8.2.17.tar.gz\r
+ $ cd postgresql-8.2.17\r
+ $ ./configure --with-perl --enable-integer-datetimes --with-openssl --prefix=/usr/local/stow/pgsql\r
+ ...\r
+ $ make\r
+ ...\r
+ $ make install\r
+ ...\r
+ $ cd contrib\r
+ $ make\r
+ ...\r
+ $ make install\r
+ $ cd xml2\r
+ $ make\r
+ ...\r
+ $ make install\r
+ $ cd /usr/local/stow\r
+ $ stow pgsql\r
+ </screen>\r
+ </figure>\r
+ </step>\r
+ <step>\r
+ <para>Create the new user <systemitem class="username">postgres</systemitem> to run the PostgreSQL processes. As the <systemitem class="username">root</systemitem> user, execute this command:</para>\r
+ <figure>\r
+ <title>Adding <systemitem class="username">postgres</systemitem></title>\r
+ <screen>\r
+ $ adduser postgres\r
+ </screen>\r
+ </figure>\r
+ </step>\r
+ <step>\r
+ <para>Initialize the database directory and start up PostgreSQL. As the <systemitem class="username">root</systemitem> user, follow these steps:</para>\r
+ <figure>\r
+ <title>Adding <systemitem class="username">postgres</systemitem></title>\r
+ <screen>\r
+ $ mkdir -p /usr/local/pgsql/data\r
+ $ chown postgres /usr/local/pgsql/data\r
+ $ su - postgres\r
+ $ initdb -D /usr/local/pgsql/data -E UNICODE --locale=C\r
+ $ pg_ctl -D /usr/local/pgsql/data -l /home/postgres/logfile start\r
+ </screen>\r
+ </figure>\r
+ <note>\r
+ <para>If an error occurs during the final step above, review the path of the home directory for the <systemitem class="username">postgres</systemitem> user. It may be <literal>/var/lib/postresql</literal> instead of <literal>/home/postres</literal>.</para>\r
+ </note>\r
+ </step>\r
+ <step>\r
+ <para>The values of several PostreSQL configuration parameters may be changed for enhanced performance. The following table lists the default values and some suggested updates for several useful parameters:</para>\r
+ <table>\r
+ <title>Suggested configuration values</title>\r
+ <tgroup align="left" cols="3" colsep="1" rowsep="1">\r
+ <colspec colnum="1" colwidth="1.0*"/>\r
+ <colspec colnum="2" colwidth="1.0*"/>\r
+ <colspec colnum="3" colwidth="1.0*"/>\r
+ <thead>\r
+ <row>\r
+ <entry>Parameter</entry>\r
+ <entry>Default</entry>\r
+ <entry>Suggested</entry>\r
+ </row>\r
+ </thead>\r
+ <tbody>\r
+ <row>\r
+ <entry>default_statistics_target</entry>\r
+ <entry>10</entry>\r
+ <entry>100</entry>\r
+ </row>\r
+ <row>\r
+ <entry>work_mem</entry>\r
+ <entry>4Mb</entry>\r
+ <entry>128Mb</entry>\r
+ </row>\r
+ <row>\r
+ <entry>shared_buffers</entry>\r
+ <entry>8Mb</entry>\r
+ <entry>512Mb</entry>\r
+ </row>\r
+ <row>\r
+ <entry>effective_cache_size</entry>\r
+ <entry>128Mb</entry>\r
+ <entry>4Gb</entry>\r
+ </row>\r
+ </tbody>\r
+ </tgroup>\r
+ </table>\r
+ <indexterm>\r
+ <primary>ZZZ-REVIEW</primary>\r
+ <secondary>ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS</secondary>\r
+ </indexterm>\r
+ <caution>ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS </caution>\r
+ </step>\r
+ </procedure>\r
+</chapter>\r
<info>\r
<title>Languages and Localization</title>\r
</info>\r
-<section xml:id="enabling_and_disabling_localization"> \r
- <title>Enabling and Disabling Languages</title>\r
- <para>Evergreen 1.6 is bundled with support for a number of languages beyond American English (<emphasis role="bold">en-US</emphasis>). The translated interfaces are \r
- split between static files that are automatically installed with Evergreen, and dynamic labels that can be stored in the Evergreen database. Evergreen is \r
- installed with additional SQL files that contain translated dynamic labels for a number of languages, and to make the set of translated labels available in \r
- all interfaces. Only a few steps are required to enable or disable one or more languages.</para>\r
- <section>\r
- <title>Enabling a Localization</title>\r
- <para>To enable the translated labels for a given language to display in Evergreen, just populate the database with the translated labels and enable the localization. The following example illustrates how to enable Canadian French (<emphasis role="bold">fr-CA</emphasis>) support in the database. These same steps can be used with any of the languages bundled with Evergreen, or you can create and add your own localization.</para>\r
- <orderedlist>\r
- <listitem>\r
- <para>The translated labels for each locale are stored in SQL files named "950.data.seed-values-xx-YY.sql" where "xx-YY" represents the locale code for the translation. Load the translated labels into the Evergreen database using the command <command>psql</command>, substituting your user, host and database connection information accordingly:</para>\r
+ <section xml:id="enabling_and_disabling_localization"> \r
+ <title>Enabling and Disabling Languages</title>\r
+ <para>Evergreen 1.6 is bundled with support for a number of languages beyond American English (<emphasis role="bold">en-US</emphasis>). The translated interfaces are \r
+ split between static files that are automatically installed with Evergreen, and dynamic labels that can be stored in the Evergreen database. Evergreen is \r
+ installed with additional SQL files that contain translated dynamic labels for a number of languages, and to make the set of translated labels available in \r
+ all interfaces. Only a few steps are required to enable or disable one or more languages.</para>\r
+ <simplesect>\r
+ <title>Enabling a Localization</title>\r
+ <para>To enable the translated labels for a given language to display in Evergreen, just populate the database with the translated labels and enable the localization. The \r
+ following example illustrates how to enable Canadian French (<emphasis role="bold">fr-CA</emphasis>) support in the database. These same steps can be used with any of the \r
+ languages bundled with Evergreen, or you can create and add your own localization.</para>\r
+ <orderedlist>\r
+ <listitem>\r
+ <para>The translated labels for each locale are stored in SQL files named "950.data.seed-values-xx-YY.sql" where "xx-YY" represents the locale code for \r
+ the translation. Load the translated labels into the Evergreen database using the command <command>psql</command>, substituting your user, host and \r
+ database connection information accordingly:</para>\r
<programlisting language="xml"><![CDATA[\r
$ psql -U <username> -h <hostname> -d <database> -f /path/to/Evergreen-source/Open-ILS/src/sql/Pg/950.data.seed-values-fr-CA.sql\r
]]></programlisting>\r
- </listitem>\r
- <listitem>\r
- <para>Ensure the locale is enabled in the Evergreen database by using the utility <command>psql</command> to check for the existence of the locale in the table <literal>config.i18n_locale</literal>:</para>\r
- <figure>\r
- <title>Commands to check for localization</title>\r
- <screen>\r
- SELECT code, marc_code, name, description\r
- FROM config.i18n_locale\r
- WHERE code = 'fr-CA';\r
- </screen>\r
- </figure>\r
- <para>As shown in the following example, if one row of output is returned, then the locale is already enabled:</para>\r
- <figure>\r
- <title>Results of an installed localization</title>\r
- <screen>\r
- code | marc_code | name | description \r
- ------+-----------+-----------------+-----------------\r
- fr-CA | fre | French (Canada) | Canadian French\r
- (1 row)\r
- </screen>\r
- </figure>\r
- <para>If zero rows of output are returned, then the locale is not enabled:</para>\r
- <figure>\r
- <title>Results of no installed localizations</title>\r
- <screen>\r
- code | marc_code | name | description \r
- ------+-----------+------+-------------\r
- (0 rows)\r
- </screen>\r
- </figure>\r
- <para>To enable a locale, use <command>psql</command> to insert a row into the table <literal>config.i18n_locale</literal> as follows:</para>\r
- <figure>\r
- <title>Commands to enable a locale in the database</title>\r
- <screen>\r
- INSERT INTO config.i18n_locale (code, marc_code, name, description)\r
- VALUES ('fr-CA', 'fre', 'French (Canada)', 'Canadian French');\r
- </screen>\r
- </figure>\r
- </listitem>\r
- </orderedlist>\r
- </section>\r
- <section>\r
- <title>Disabling a Localization</title>\r
- <para>You might not want to offer all of the localizations that are preconfigured in Evergreen. If you choose to disable the dynamic labels for a locale, just delete those entries from the table <literal>config.i18n_locale</literal> using the <command>psql</command> utility:</para>\r
- <figure>\r
- <title>Commands to delete localization from table</title>\r
- <screen>\r
- DELETE FROM config.i18n_locale\r
- WHERE code = 'fr-CA';\r
- </screen>\r
- </figure>\r
- </section>\r
- </section>\r
+ </listitem>\r
+ <listitem>\r
+ <para>Ensure the locale is enabled in the Evergreen database by using the utility <command>psql</command> to check for the existence of the locale in the \r
+ table <literal>config.i18n_locale</literal>:</para>\r
+ \r
+<screen>\r
+<userinput>SELECT code, marc_code, name, description\r
+FROM config.i18n_locale\r
+WHERE code = 'fr-CA';</userinput>\r
+</screen>\r
+ \r
+ <para>As shown in the following example, if one row of output is returned, then the locale is already enabled:</para>\r
+<screen>\r
+code | marc_code | name | description \r
+------+-----------+-----------------+-----------------\r
+fr-CA | fre | French (Canada) | Canadian French\r
+(1 row)\r
+</screen>\r
+ <para>If zero rows of output are returned, then the locale is not enabled:</para>\r
+<screen>\r
+code | marc_code | name | description \r
+------+-----------+------+-------------\r
+(0 rows)\r
+</screen>\r
+ <para>To enable a locale, use <command>psql</command> to insert a row into the table <literal>config.i18n_locale</literal> as follows:</para>\r
+<screen>\r
+INSERT INTO config.i18n_locale (code, marc_code, name, description)\r
+VALUES ('fr-CA', 'fre', 'French (Canada)', 'Canadian French');\r
+</screen>\r
+ </listitem>\r
+ </orderedlist>\r
+ </simplesect>\r
+ <simplesect>\r
+ <title>Disabling a Localization</title>\r
+ <para>You might not want to offer all of the localizations that are preconfigured in Evergreen. If you choose to disable the dynamic labels for a locale, just delete those \r
+ entries from the table <literal>config.i18n_locale</literal> using the <command>psql</command> utility:</para>\r
+<screen>\r
+<userinput>DELETE FROM config.i18n_locale\r
+WHERE code = 'fr-CA';</userinput>\r
+</screen>\r
+ </simplesect>\r
+ </section>\r
</chapter>\r
projects / evergreen / masslnc.git / commitdiff