1 <?xml version='1.0' encoding='UTF-8'?>
\r
2 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
\r
3 xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="upgradingevergreen-2.0">
\r
5 <title>Upgrading Evergreen to 2.0</title>
\r
7 <para>This Chapter will explain the step-by-step process of upgrading <application>Evergreen
\r
8 </application> to 2.0, including steps to upgrade <application>OpenSRF</application>. Before
\r
9 upgrading, it is important to carefully plan an upgrade strategy to minimize system downtime and
\r
10 service interruptions. All of the steps in this chapter are to be completed from the command line.</para>
\r
14 <para>Evergreen 2.0 has several software requirements:</para>
\r
16 <listitem>PostgreSQL: Version 8.4 is the minimum supported version of PostgreSQL. </listitem>
\r
17 <listitem>Linux: Evergreen 2.0 has been tested on Debian Squeeze (6.0) and Ubuntu Lucid Lynx (10.04). If you are running an older version of these distributions,
\r
18 you may want to upgrade befor installing Evergreen 2.0. For instructions on upgrading these distributions, visit the
\r
19 <ulink url="http://www.debian.org/releases/squeeze/">Debian</ulink> or <ulink url="https://help.ubuntu.com/community/LucidUpgrades">Ubuntu</ulink> websites.</listitem>
\r
21 <para>In the following instructions, you are asked to perform certain steps as either the <systemitem class="username">root</systemitem> or
\r
22 <systemitem class="username">opensrf</systemitem> user.</para>
\r
24 <listitem>Debian: To become the <systemitem class="username">root</systemitem> user, issue the <command>su</command> command and enter the password of the
\r
25 <systemitem class="username">root</systemitem> user.</listitem>
\r
26 <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
28 <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
29 <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
30 <para>In the following instructions, <filename class='directory'>/path/to/OpenSRF/</filename> represents the path to the OpenSRF source directory.</para>
\r
31 <section xml:id="upgradingevergreen-stop_evergreen">
\r
32 <title>Backing Up Data</title>
\r
35 <para>As <systemitem class="username">root</systemitem>, stop the <application>Apache</application>
\r
36 web server<indexterm><primary>web server</primary><secondary>Apache</secondary></indexterm>.</para>
\r
39 <para>As the <systemitem class="username">opensrf</systemitem> user, stop all
\r
40 <application>Evergreen</application>
\r
41 and <application>OpenSRF</application> services:</para>
\r
42 <screen><userinput>osrf_ctl.sh -l -a stop_all</userinput></screen>
\r
45 <para>Back up of the <filename class='directory'>/openils</filename>
\r
49 <para><link linkend="backingup">Back up the <application>evergreen
\r
50 </application> database</link>.</para>
\r
54 <section xml:id="upgradingevergreen-upgradingOpenSRF">
\r
55 <title>Upgrading OpenSRF to 2.0</title><indexterm><primary>OpenSRF</primary></indexterm>
\r
58 <para>As the <systemitem class="username">opensrf</systemitem> user, download and extract the source files for <application>OpenSRF</application>
\r
61 wget http://open-ils.org/downloads/opensrf-2.0.1.tar.gz
\r
62 tar xzf opensrf-2.0.1.tar.gz
\r
63 </userinput></screen>
\r
64 <para>A new directory opensrf-2.0.1 is created.</para>
\r
65 <note><para>For the latest edition of OpenSRF, check the Evergreen download page at
\r
66 <ulink url="http://www.open-ils.org/downloads.php" />.
\r
70 <para>As the <systemitem class="username">root</systemitem> user, install the software prerequisites using the automatic
\r
71 prerequisite installer.</para>
\r
73 aptitude install make
\r
74 cd /home/opensrf/opensrf-2.0.1
\r
75 </userinput></screen>
\r
76 <para>Replace <option>[distribution]</option> below with the following value
\r
77 for your distribution:</para>
\r
80 <para><option>debian-squeeze</option> for <systemitem class="osname">Debian Squeeze (6.0)</systemitem>
\r
81 <indexterm><primary>Linux</primary><secondary>Debian</secondary></indexterm></para>
\r
84 <para><option>fedora13</option> for <systemitem class="osname">Fedora 13</systemitem>
\r
85 <indexterm><primary>Linux</primary><secondary>Fedora</secondary></indexterm></para>
\r
88 <para><option>ubuntu-lucid</option> for <systemitem class="osname">Ubuntu Lucid Lynx
\r
89 (10.04)</systemitem><indexterm><primary>Linux</primary><secondary>Ubuntu</secondary></indexterm></para>
\r
92 <para><option>centos</option> for <systemitem class="osname">CentOS 5</systemitem>
\r
93 <indexterm><primary>Linux</primary><secondary>CentOS</secondary></indexterm></para>
\r
96 <para><option>rhel</option> for <systemitem class="osname">Red Hat Enterprise Linux 5</systemitem>
\r
97 <indexterm><primary>Linux</primary><secondary>Red Hat</secondary></indexterm></para>
\r
100 <screen><userinput>
\r
101 make -f src/extras/Makefile.install [distribution]
\r
102 </userinput></screen>
\r
103 <para>This will install a number of packages required by OpenSRF on your system,
\r
104 including some Perl modules from <systemitem class="resource">CPAN</systemitem><indexterm><primary>Perl</primary><secondary>CPAN</secondary>
\r
105 </indexterm>. You can type <userinput>no</userinput> to the initial <systemitem class="resource">CPAN</systemitem>
\r
106 configuration prompt to allow it to automatically configure itself to download
\r
107 and install Perl modules from <systemitem class="resource">CPAN</systemitem>. The <systemitem class="resource">CPAN</systemitem> installer will ask you a number of
\r
108 times whether it should install prerequisite modules - type <userinput>yes</userinput>.</para>
\r
111 <para>As the <systemitem class="username">opensrf</systemitem> user, configure and compile OpenSRF:</para>
\r
112 <note>You can include the <option>–enable-python</option> and <option>–enable-java</option> configure options if
\r
113 you want to include support for Python<indexterm><primary>Python</primary></indexterm> and Java
\r
114 <indexterm><primary>Java</primary></indexterm>, respectively.</note>
\r
115 <screen><userinput>
\r
116 cd /home/opensrf/opensrf-2.0.1
\r
117 ./configure --prefix=/openils --sysconfdir=/openils/conf
\r
119 </userinput></screen>
\r
122 <para>As the <systemitem class="username">root</systemitem> user, return to your OpenSRF build directory and install
\r
124 <screen><userinput>
\r
125 cd /home/opensrf/opensrf-2.0.1
\r
127 </userinput></screen>
\r
130 <para>As the <systemitem class="username">root</systemitem> user, change the ownership of the installed files to the
\r
131 <systemitem class="username">opensrf</systemitem> user:</para>
\r
132 <screen><userinput>chown -R opensrf:opensrf /openils</userinput></screen>
\r
135 <para>Jot down the usernames/passwords of the two Jabber users created when OpenSRF was previously installed these users will correspond to
\r
136 entries in opensrf_core.xml. </para>
\r
139 <para>Important: Backup your current opensrf.xml and opensrf_core.xml configuration files.</para>
\r
141 <userinput>cp -p /openils/conf/opensrf.xml /openils/conf/opensrf.xml.backup</userinput>
\r
142 <userinput>cp -p /openils/conf/opensrf_core.xml /openils/conf/opensrf_core.xml.backup</userinput>
\r
146 <para>As the <systemitem class="username">opensrf</systemitem> user, copy the <filename>/openils/conf/opensrf_core.xml</filename> and
\r
147 <filename>/openils/conf/opensrf.xml</filename> configuration files from the example templates:</para>
\r
149 <userinput>cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml</userinput>
\r
150 <userinput>cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml</userinput>
\r
152 <para>Edit <filename>/openils/conf/opensrf_core.xml</filename> to change the Jabber usernames and passwords you jotted down earlier.</para>
\r
155 <para>As the <systemitem class="username">root</systemitem> user, Run the following command:</para>
\r
157 <userinput>ldconfig</userinput>
\r
161 <para>Restart and Test OpenSRF</para>
\r
162 <screen><userinput>
\r
163 osrf_ctl.sh -l -a start_all
\r
165 srfsh# request opensrf.math add 2 2
\r
166 </userinput></screen>
\r
167 <para>You should see output such as:</para>
\r
171 ------------------------------------
\r
172 Request Completed Successfully
\r
173 Request Time in seconds: 0.007519
\r
174 ------------------------------------
\r
180 <para>If test completed successful restore your Evergreen configuration files:</para>
\r
181 <screen><userinput>
\r
182 cp /openils/conf/opensrf.xml.backup /openils/conf/opensrf.xml
\r
183 cp /openils/conf/opensrf_core.xml.backup /openils/conf/opensrf_core.xml
\r
184 </userinput></screen>
\r
186 <para>and move on to the next section to upgrade Evergreen. Otherwise, refer to the <link linkend="troubleshooting">troubleshooting</link> chapter
\r
187 of this documentation.</para>
\r
191 <section xml:id="upgradingevergreen-upgrading_from_1.6_to_2.0">
\r
192 <title>Upgrade <application>Evergreen</application> from 1.6.1 to 2.0</title>
\r
194 <para>PostgreSQL 8.4 is the minimum supported version of PostgreSQL.</para>
\r
195 <para>Evergreen 2.0 has been tested on Debian Squeeze (6.0) and Ubuntu Lucid (10.04). If you are runnung an older version of
\r
196 these distributions, you may want to upgrade befor installing Evergreen 2.0. For instructions on upgrading these distribuitions, visit the
\r
197 <ulink url="http://www.debian.org/releases/squeeze/">Debian</ulink> or <ulink url="https://help.ubuntu.com/community/LucidUpgrades">Ubuntu</ulink> websites.</para>
\r
201 <para>As the <systemitem class="username">opensrf</systemitem> user, download and extract <application>Evergreen 2.0</application>
\r
203 <screen><userinput>
\r
204 wget http://www.open-ils.org/downloads/Evergreen-ILS-2.0.9.tar.gz
\r
205 tar xzf Evergreen-ILS-2.0.9.tar.gz
\r
206 </userinput></screen>
\r
207 <note><para>For the latest edition of Evergreen 2.0, check the Evergreen download page at
\r
208 <ulink url="http://www.open-ils.org/downloads.php" /> and adjust upgrading instructions accordingly.</para></note>
\r
211 <para>As the <systemitem class="username">root</systemitem> user, install the prerequisites:</para>
\r
212 <screen><userinput>cd /home/opensrf/Evergreen-ILS-2.0.9</userinput></screen>
\r
213 <para>On the next command, replace <option>[distribution]</option> with one of
\r
214 these values for your distribution of Debian or Ubuntu:</para>
\r
218 <para><option>debian-squeeze</option> for <systemitem class="osname">Debian Squeeze (6.0)</systemitem></para>
\r
222 <para><option>ubuntu-lucid</option> for <systemitem class="osname">Ubuntu Lucid Lynx
\r
223 (10.04)</systemitem></para>
\r
226 <screen><userinput>make -f Open-ILS/src/extras/Makefile.install <option>[distribution]</option></userinput></screen>
\r
229 <para>As the <systemitem class="username">opensrf</systemitem> user, configure and compile
\r
230 <application>Evergreen</application>:</para>
\r
231 <screen><userinput>cd /home/opensrf/Evergreen-ILS-2.0.9</userinput></screen>
\r
232 <screen><userinput>./configure --prefix=/openils --sysconfdir=/openils/conf</userinput></screen>
\r
233 <screen><userinput>make</userinput></screen>
\r
236 <para>As the <systemitem class="username">root</systemitem> user, install
\r
237 <application>Evergreen</application>:</para>
\r
238 <screen><userinput>make STAFF_CLIENT_BUILD_ID=rel_2_0_9 install</userinput></screen>
\r
241 <para>As the <emphasis>root</emphasis> user, change all files to be owned by the
\r
242 <emphasis>opensrf</emphasis> user and group:</para>
\r
243 <screen><userinput>chown -R opensrf:opensrf /openils</userinput></screen>
\r
246 <para>As the <systemitem class="username">opensrf</systemitem> user, update server symlink in <filename class="directory">/openils/var/web/xul/</filename>:</para>
\r
247 <screen><userinput>
\r
248 cd /openils/var/web/xul/
\r
250 ln -s rel_2_0_9/server
\r
251 </userinput></screen>
\r
254 <para>Change to the <application>Evergreen</application> installation
\r
256 <screen><userinput>cd /home/opensrf/Evergreen-ILS-2.0.9</userinput></screen>
\r
260 <para>Update the <database>evergreen</database> database:</para>
\r
261 <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
262 <note><para>The <filename>1.6.1-2.0-upgrade-db.sql</filename> upgrade script may take a long time (hours) to process
\r
263 on larger systems.</para></note>
\r
266 psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.1-2.0-upgrade-db.sql evergreen
\r
267 psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/2.0.0-2.0.1-upgrade-db.sql evergreen
\r
268 psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/2.0.1-2.0.2-upgrade-db.sql evergreen
\r
269 psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/2.0.2-2.0.3-upgrade-db.sql evergreen
\r
270 psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/2.0.3-2.0.4-upgrade-db.sql evergreen
\r
271 psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/2.0.4-2.0.5-upgrade-db.sql evergreen
\r
272 psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/2.0.5-2.0.6-upgrade-db.sql evergreen
\r
273 psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/2.0.6-2.0.7-upgrade-db.sql evergreen
\r
274 psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/2.0.7-2.0.8-upgrade-db.sql evergreen
\r
275 psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/2.0.8-2.0.9-upgrade-db.sql evergreen
\r
282 <para>Run the <filename>reingest-1.6-2.0.pl</filename> script to generate an sql script. Then use the sql file to reingest bib records into your
\r
283 <database>evergreen</database> database. This is required to make the new facet sidebar in OPAC search results work and to upgrade the keyword indexes to use
\r
284 the revised NACO normalization routine.</para>
\r
285 <note><para>If you are running a large Evergreen installation, it is recommend that you examine the script first. Reingesting a large number of bibliographic records
\r
286 may take several hours.</para></note>
\r
287 <screen><userinput>perl Open-ILS/src/sql/Pg/reingest-1.6-2.0.pl</userinput></screen>
\r
288 <screen><userinput>psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/reingest-1.6-2.0.sql evergreen</userinput></screen>
\r
291 <para>As the <systemitem class="username">opensrf</systemitem> user,
\r
292 copy <filename>/openils/conf/oils_web.xml.example</filename> to <filename>/openils/conf/oils_web.xml</filename>
\r
293 . (If upgrading from 1.6.1.x, <filename>oils_web.xml</filename> should already exist.)</para>
\r
294 <indexterm><primary>configuration files</primary><secondary>oils_web.xml</secondary></indexterm>
\r
295 <screen><userinput>cp /openils/conf/oils_web.xml.example /openils/conf/oils_web.xml</userinput></screen>
\r
298 <para>Update <filename>opensrf_core.xml</filename> and <filename>opensrf.xml</filename> by copying the new example files
\r
299 (<filename>/openils/conf/opensrf_core.xml.example</filename> and <filename>/openils/conf/opensrf.xml</filename>).</para>
\r
300 <indexterm><primary>configuration files</primary><secondary>opensrf.xml</secondary></indexterm>
\r
301 <screen><userinput>cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml</userinput></screen>
\r
302 <indexterm><primary>configuration files</primary><secondary>opensrf_core.xml</secondary></indexterm>
\r
303 <screen><userinput>cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml</userinput></screen>
\r
304 <caution><para>Copying these configuration files will remove any customizations you have made to them. Remember to redo your customizations after copying
\r
305 them.</para></caution>
\r
308 <para>Update <filename>opensrf.xml</filename> with the database connection info:</para>
\r
309 <screen><userinput>
\r
310 perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \
\r
311 --service all --create-offline --user evergreen --password evergreen \
\r
312 --hostname localhost --port 5432 --database evergreen
\r
313 </userinput></screen>
\r
316 <para>Update /etc/apache2/startup.pl by copying the example from
\r
317 Open-ILS/examples/apache/startup.pl.</para><indexterm><primary>configuration files</primary><secondary>startup.pl</secondary></indexterm>
\r
320 <para>Update /etc/apache2/eg_vhost.conf by copying the example from
\r
321 Open-ILS/examples/apache/eg_vhost.conf.</para><indexterm><primary>configuration files</primary><secondary>eg_vhost.conf</secondary></indexterm>
\r
324 <para>Update /etc/apache2/sites-available/eg.conf by copying the example from Open-ILS/
\r
325 examples/apache/eg.conf.</para><indexterm><primary>configuration files</primary><secondary>eg.conf</secondary></indexterm>
\r
328 <para>Copying these Apache configuration files will remove any customizations you have made to them. Remember to redo your customizations after copying
\r
329 them. For example, if you purchased an SSL certificate, you
\r
330 will need to edit <filename>eg.conf</filename> to point to the appropriate SSL certificate files.</para>
\r
331 <indexterm><primary>SSL</primary><secondary>certificates</secondary></indexterm>
\r
335 <section xml:id="testing_after_upgrade">
\r
336 <title>Restart Evergreen and Test</title>
\r
339 <para>As the <systemitem class="username">opensrf</systemitem> user, start all
\r
340 <application>Evergreen</application> and <application>OpenSRF</application>
\r
342 <screen><userinput>osrf_ctl.sh -l -a start_all</userinput></screen>
\r
345 <para>As the <systemitem class="username">opensrf</systemitem> user, run <command>autogen</command> to refresh the static
\r
346 organizational data files:</para><indexterm><primary>autogen</primary></indexterm>
\r
347 <screen><userinput>
\r
349 ./autogen.sh -c /openils/conf/opensrf_core.xml -u
\r
350 </userinput></screen>
\r
354 <para>Start <command>srfsh</command> and try logging in using your <application>Evergreen</application>
\r
355 username and password:</para>
\r
357 <userinput>/openils/bin/srfsh</userinput>
\r
358 <prompt>srfsh%</prompt> <userinput>login <option>username</option> <option>password</option></userinput>
\r
362 <para>Start the <application>Apache</application> web server.</para>
\r
366 <para>If you encounter errors, refer to the <link linkend="troubleshooting">troubleshooting
\r
367 section</link> of this documentation for tips
\r
368 on finding solutions and seeking further assistance from the Evergreen community.</para>
\r
371 <section xml:id="upgrading_Postgresqlto9.0">
\r
372 <title>Upgrading PostgreSQL from 8.4 to 9.0</title>
\r
374 <title>Upgrading PostgreSQL on Debian Squeez</title>
\r
377 <para>Stop Evergreen and disconnect clients from database.</para>
\r
380 <para>Add the following line to <filename>/etc/apt/sources.list</filename>:</para>
\r
382 deb http://www.backports.org/debian squeeze-backports main contrib non-free
\r
386 <para>Update the sources list on your server.</para>
\r
387 <screen><userinput>
\r
389 </userinput></screen>
\r
392 <para>Backup your databases</para>
\r
393 <screen><userinput>
\r
394 $ pg_dump [db connect args] [db name] > evergreen-backup.sql
\r
395 </userinput></screen>
\r
398 <para>Install PostgreSQL 9.0 as well as the client, contrib and plperl support packages.</para>
\r
399 <screen><userinput>
\r
400 apt-get -t squeeze-backports install postgresql-9.0 postgresql-client-9.0 postgresql-contrib-9.0 postgresql-plperl-9.0
\r
401 </userinput></screen>
\r
404 <para>Drop the empty 9.0 cluster.</para>
\r
405 <screen><userinput>
\r
406 pg_dropcluster --stop 9.0 main
\r
407 </userinput></screen>
\r
410 <para>Update the 8.4 cluster (with evergreen database) to 9.0</para>
\r
411 <screen><userinput>
\r
412 pg_upgradecluster 8.4 main
\r
413 </userinput></screen>
\r
416 <para>Test by logging into psql, checking the postgrSQL version and running a simple SELECT query.</para>
\r
417 <screen><userinput>
\r
419 evergreen=# select version();
\r
420 evergreen=# select count(*) from biblio.record_entry;
\r
421 </userinput></screen>
\r
424 <para>Restart Evergreen and Apache.</para>
\r
427 <para>Drop old 8.4 cluster (optional).</para>
\r
428 <screen><userinput>
\r
429 pg_dropcluster 8.4 main
\r
430 </userinput></screen>
\r
435 <title>Upgrading PostgreSQL on Ubuntu 10.04</title>
\r
438 <para>Stop Evergreen and disconnect clients from database.</para>
\r
441 <para>Add the backport repository to your repository sources list:</para>
\r
442 <screen><userinput>
\r
443 sudo add-apt-repository ppa:pitti/postgresql
\r
444 </userinput></screen>
\r
447 <para>Update the sources list on your server.</para>
\r
448 <screen><userinput>
\r
450 </userinput></screen>
\r
453 <para>As the <systemitem class="username">postgres</systemitem> user, backup your PostgreSQL databases.</para>
\r
454 <screen><userinput><![CDATA[
\r
456 ]]></userinput></screen>
\r
459 <para>As <systemitem class="username">root</systemitem>, remove PostgreSQL 8.4 and install 9.0.</para>
\r
460 <screen><userinput>
\r
461 aptitude purge postgresql-8.4
\r
462 aptitude install postgresql-9.0 postgresql-client-9.0 postgresql-contrib-9.0 postgresql-plperl-9.0
\r
463 </userinput></screen>
\r
466 <para>as the <systemitem class="username">postgres</systemitem> user, recreate empty evergreen databases with required language supports.</para>
\r
467 <screen><userinput>
\r
469 createdb -T template0 --lc-ctype=C --lc-collate=C -E UNICODE evergreen
\r
470 createlang plperl evergreen
\r
471 createlang plperlu evergreen
\r
472 createlang plpgsql evergreen
\r
473 psql -f /usr/share/postgresql/9.0/contrib/tablefunc.sql evergreen
\r
474 psql -f /usr/share/postgresql/9.0/contrib/tsearch2.sql evergreen
\r
475 psql -f /usr/share/postgresql/9.0/contrib/pgxml.sql evergreen
\r
476 </userinput></screen>
\r
479 <para>Update the 8.4 cluster (with evergreen database) to 9.0.</para>
\r
480 <screen><userinput>
\r
481 pg_upgradecluster 8.4 main
\r
482 </userinput></screen>
\r
485 <para>as the <systemitem class="username">postgres</systemitem> user, load data from backup into PostgreSQL 9.0.</para>
\r
486 <screen><userinput><![CDATA[
\r
488 ]]></userinput></screen>
\r
491 <para>Restart Evergreen and Apache.</para>
\r
494 <para>Test by logging into psql, checking the postgrSQL version and running a simple SELECT query.</para>
\r
495 <screen><userinput>
\r
497 evergreen=# select version();
\r
498 evergreen=# select count(*) from biblio.record_entry;
\r
499 </userinput></screen>
\r