1 <?xml version="1.0" encoding="UTF-8"?>
2 <chapter version="5.0" xml:id="serversideinstallation" xml:lang="EN" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xl="http://www.w3.org/1999/xlink">
4 <title>Server-side Installation of Evergreen Software</title>
6 <para>This section describes installation of the Evergreen server-side software and its associated components.
7 Installation, configuration, testing and verification
8 of the software is straightforward if you follow some simple directions.</para>
11 <para>Installing, configuring and testing the Evergreen server-side software is straightforward with the current
12 stable software release. See <xref linkend="serversideinstallation-all"/> for instructions tailored to
13 installing on some particular distributions of the <systemitem class="osname">Linux</systemitem> operating
15 <para>The current version of the Evergreen server-side software runs as a native application on any of several
16 well-known <systemitem class="osname">Linux</systemitem> distributions
17 (e.g., <systemitem class="osname">Ubuntu</systemitem> and <systemitem class="osname">Debian</systemitem>).
18 It does not currently run as a native application on the <systemitem class="osname">Microsoft Windows</systemitem>
19 operating system (e.g., <systemitem class="osname">WindowsXP</systemitem>, <systemitem class="osname">WindowsXP
20 Professional</systemitem>, <systemitem class="osname">Windows7</systemitem>), but the software can still be
21 installed and run on <systemitem class="osname">Windows</systemitem> via a so-called
22 <emphasis>virtualized</emphasis> Linux-guest Operating System (using, for example,
23 <application>"VirtualBox"</application>, or <application>"VMware"</application>, or
24 <application>"VirtualPC"</application> to emulate a <systemitem class="osname">Linux</systemitem>
25 environment). It can also be installed to run on other <systemitem class="osname">Linux</systemitem>
26 systems via virtualized environments (using, for example, <application>"VirtualBox"</application> or
27 <application>"VMware"</application>). More information on virtualized environments can be found in
28 <xref linkend="serversideinstallation-virtual"/>.</para>
29 <para>Installation of the Evergreen Staff Client software is reviewed in <xref linkend="staffclientinstallation"/>. </para>
30 <para>The Evergreen server-side software has dependencies on particular versions of certain major software
31 sub-components. Successful installation of Evergreen software requires that software versions agree with those
33 <table xml:id="serversideinstall-software-dependencies">
34 <title>Evergreen Software Dependencies</title>
36 <primary>Evergreen software dependencies</primary>
38 <tgroup align="left" cols="3" colsep="1" rowsep="1">
39 <colspec colname="Evergreen" colnum="1" colwidth="1.0*"/>
40 <colspec colname="OpenSRF" colnum="2" colwidth="1.0*"/>
41 <colspec colname="PostgreSQL" colnum="3" colwidth="1.0*"/>
44 <entry>Evergreen</entry>
45 <entry>OpenSRF</entry>
46 <entry>PostgreSQL</entry>
51 <entry>1.6.1.x</entry>
53 <entry>8.2 / 8.3</entry>
56 <entry>1.6.0.x</entry>
58 <entry>8.2 / 8.3</entry>
63 <entry>8.1 / 8.2</entry>
68 <entry>8.1 / 8.2</entry>
73 <section xml:id="serversideinstallation-all">
74 <title>Installing Server-Side Software</title>
75 <para>This section describes the installation of the major components of Evergreen server-side software.</para>
76 <para>As far as possible, you should perform the following steps in the exact order given since the
77 success of many steps relies on the successful completion of earlier steps. You should make backup
78 copies of files and environments when you are instructed to do so. In the event of installation problems
79 those copies can allow you to back out of a step gracefully and resume the installation from a known
80 state. See <xref linkend="backingup"/> for further information.</para>
81 <para>Of course, after you successfully complete and test the entire Evergreen installation you should
82 take a final snapshot backup of your system(s). This can be the first in the series of regularly
83 scheduled system backups that you should probably also begin.</para>
84 <section xml:id="serversideinstallation-opensrf">
86 <primary>OpenSRF</primary>
87 <secondary>installation</secondary>
89 <title>Installing OpenSRF 1.4.x On <systemitem class="osname">Ubuntu</systemitem> or
90 <systemitem class="osname">Debian</systemitem></title>
92 <primary>Linux</primary>
93 <secondary>Debian</secondary>
96 <primary>Linux</primary>
97 <secondary>Ubuntu</secondary>
99 <para>This section describes the installation of the latest version of the Open Service Request
100 Framework (OpenSRF), a major component of the Evergreen server-side software, on
101 <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem>
102 systems. Evergreen software is integrated with and depends on the OpenSRF software
104 <para>Follow the steps outlined here and run the specified tests to ensure that OpenSRF is
105 properly installed and configured. Do <emphasis><emphasis role="bold">not</emphasis></emphasis>
106 continue with any further Evergreen installation steps
107 until you have verified that OpenSRF has been successfully installed and tested.</para>
109 <para>The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit)
110 platforms. OpenSRF 1.4.0 has been tested on <systemitem class="osname">Debian Etch
111 (4.0)</systemitem>, <systemitem class="osname">Debian Lenny (5.0)</systemitem> and
112 <systemitem class="osname">Ubuntu Lucid Lynx (10.04)</systemitem>.</para>
113 <para>In the following instructions, you are asked to perform certain steps as
114 either the <systemitem class="username">root</systemitem> user, the
115 <systemitem class="username">opensrf</systemitem> user, or the
116 <systemitem class="username">postgres</systemitem> user.</para>
119 <para><systemitem class="osname">Debian</systemitem> -- To become the
120 <systemitem class="username">root</systemitem> user, issue the command
121 <command>su -</command> and enter the password of the
122 <systemitem class="username">root</systemitem> user.</para>
125 <para><systemitem class="osname">Ubuntu</systemitem> -- To become the
126 <systemitem class="username">root</systemitem> user, issue the command
127 <command>sudo su -</command> and enter the password of the
128 <systemitem class="username">root</systemitem> user.</para>
131 <para>To switch from the <systemitem class="username">root</systemitem> user to a
132 different user, issue the command <command>su - USERNAME</command>. For example, to
133 switch from the <systemitem class="username">root</systemitem> user to the
134 <systemitem class="username">opensrf</systemitem> user, issue the command
135 <command>su - opensrf</command>. Once you have become a non-root user, to become
136 the <systemitem class="username">root</systemitem> user again, simply issue the command
137 <command>exit</command>.</para>
141 <title>Add New <systemitem class="username">opensrf</systemitem> User</title>
142 <para>As the <systemitem class="username">root</systemitem> user, add the
143 <systemitem class="username">opensrf</systemitem> user to the system.
144 The default shell for the new user is automatically
145 set to <command>/bin/bash</command> to inherit a reasonable environment:</para>
147 <userinput>useradd -m -s /bin/bash opensrf</userinput>
148 <userinput>passwd opensrf</userinput>
152 <title>Download and Unpack Latest OpenSRF Version</title>
154 <primary>OpenSRF</primary>
155 <secondary>download</secondary>
157 <para>As the <systemitem class="username">opensrf</systemitem> user, change to
158 the directory <filename class="directory">/home/opensrf</filename> then download
159 and extract the latest version of OpenSRF. The latest version can be found here:
160 <ulink url="http://evergreen-ils.org/downloads/OpenSRF-1.4.0.tar.gz"></ulink></para>
162 <userinput>cd /home/opensrf</userinput>
163 <userinput>wget http://evergreen-ils.org/downloads/OpenSRF-1.4.0.tar.gz</userinput>
164 <userinput>tar zxf OpenSRF-1.4.0.tar.gz</userinput>
166 <para>The new directory
167 <filename class="directory">/home/opensrf/OpenSRF-1.4.0</filename> will be created.</para>
170 <title>Install Prerequisites to Build OpenSRF</title>
171 <para>In this section you will install and configure a set of prerequisites that will be
172 used to build OpenSRF. In a following step you will actually build the OpenSRF software
173 using the <command>make</command> utility.</para>
174 <para>As the <systemitem class="username">root</systemitem> user, enter the commands show
175 below to build the prerequisites from the software distribution that you just downloaded
176 and unpacked. Remember to replace <emphasis>[DISTRIBUTION]</emphasis> in the following
177 example with the keyword corresponding to the name of one of the
178 <systemitem class="osname">Linux</systemitem> distributions listed in the following
179 distribution keywords table <xref linkend="serversideinstallation-keywords-opensrf"/> .
180 For example, to install the prerequisites for Ubuntu version 10.04 (Lucid Lynx) you would
181 enter this command: <command>make -f src/extras/Makefile.install ubuntu-lucid</command> .</para>
183 <userinput>cd /home/opensrf/OpenSRF-1.4.0</userinput>
184 <userinput>make -f src/extras/Makefile.install [DISTRIBUTION]</userinput>
186 <table xml:id="serversideinstallation-keywords-opensrf">
187 <title>Keyword Targets for OpenSRF <application>"make"</application> Command</title>
188 <tgroup align="left" cols="2" colsep="1" rowsep="1">
189 <colspec colnum="1" colwidth="1.0*"/>
190 <colspec colnum="2" colwidth="3.0*"/>
193 <entry>Keyword</entry>
194 <entry>Linux Version</entry>
199 <entry>debian-etch</entry>
200 <entry>Debian "Etch" (4.0)</entry>
203 <entry>debian-lenny</entry>
204 <entry>Debian "Lenny" (5.0)</entry>
207 <entry>ubuntu-hardy</entry>
208 <entry>Ubuntu "Hardy Heron" (8.04)</entry>
211 <entry>ubuntu-karmic</entry>
212 <entry>Ubuntu "Karmic Koala" (9.10)</entry>
215 <entry>ubuntu-lucid</entry>
216 <entry>Ubuntu "Lucid Lynx" (10.04)</entry>
219 <entry>fedora13</entry>
220 <entry>Fedora "Goddard" (13)</entry>
223 <entry>centos</entry>
224 <entry>Centos</entry>
231 <entry>gentoo</entry>
232 <entry>Gentoo</entry>
237 <para>This will install a number of packages on the system that are required by OpenSRF,
238 including some Perl modules from CPAN. You can say <literal>No</literal> to the initial
239 CPAN configuration prompt to allow it to automatically configure itself to download and
240 install Perl modules from CPAN. The CPAN installer will ask you a number of times whether
241 it should install prerequisite modules - say <literal>Yes</literal>.</para>
244 <title>Build OpenSRF</title>
245 <para>In this section you will configure, build and install the OpenSRF
246 components that support other Evergreen services.</para>
249 <title>Configure OpenSRF</title>
251 <primary>OpenSRF</primary>
252 <secondary>configure</secondary>
254 <para>As the <systemitem class="username">opensrf</systemitem>
255 user, return to the OpenSRF build directory and use the
256 <command>configure</command> utility to prepare for the next
257 step of compiling and linking the software. If you wish to
258 include support for Python and Java, add the configuration
259 options <option>--enable-python</option> and
260 <option>--enable-java</option>, respectively:</para>
262 <userinput>cd /home/opensrf/OpenSRF-1.4.0</userinput>
263 <userinput>./configure --prefix=/openils --sysconfdir=/openils/conf</userinput>
264 <userinput>make</userinput>
268 <title>Compile, Link and Install OpenSRF</title>
269 <para>As the <systemitem class="username">root</systemitem>
270 user, return to the OpenSRF build directory and use the
271 <command>make</command> utility to compile, link and install
274 <userinput>cd /home/opensrf/OpenSRF-1.4.0</userinput>
275 <userinput>make install</userinput>
279 <title>Update the System Dynamic Library Path</title>
280 <para>You must update the system dynamic library path to force
281 your system to recognize the newly installed libraries. As the
282 <systemitem class="username">root</systemitem> user, do this by
283 creating the new file
284 <filename>/etc/ld.so.conf.d/osrf.conf</filename> containing a
285 new library path, then run the command
286 <command>ldconfig</command> to automatically read the file and
287 modify the system dynamic library path:</para>
289 <userinput>echo "/openils/lib" > /etc/ld.so.conf.d/osrf.conf</userinput>
290 <userinput>ldconfig</userinput>
293 <step xml:id="serversideinstallation-definedomains">
294 <title>Define Public and Private OpenSRF Domains</title>
295 <para>For security purposes, OpenSRF uses Jabber domains to separate services
296 into public and private realms. On a single-server system the easiest way to
297 define public and private OpenSRF domains is to define separate host names by
298 adding entries to the file <filename>/etc/hosts</filename>.</para>
299 <para>In the following steps we will use the example domains
300 <systemitem class="domainname">public.localhost</systemitem> for the public
301 domain and <systemitem class="domainname">private.localhost</systemitem>
302 for the private domain. In an upcoming step, you will configure two special
303 <systemitem class="service">ejabberd</systemitem> users
304 to handle communications for these two domains.</para>
305 <para>As the <systemitem class="username">root</systemitem> user, edit the file
306 <filename>/etc/hosts</filename> and add the following example domains:</para>
308 <primary>Jabber</primary>
311 <userinput>127.0.1.2 public.localhost public</userinput>
312 <userinput>127.0.1.3 private.localhost private</userinput>
316 <title>Change File Ownerships</title>
317 <para>Finally, as the <systemitem class="username">root</systemitem>
318 user, change the ownership of all files installed in the
319 directory <filename class="directory">/openils</filename> to the
320 user <systemitem class="username">opensrf</systemitem>:</para>
322 <userinput>chown -R opensrf:opensrf /openils</userinput>
327 <step xml:id="stop-ejabberd-service">
328 <title>Stop the <systemitem class="service">ejabberd</systemitem> Service</title>
330 <primary>ejabberd</primary>
332 <para>Before continuing with configuration of <systemitem class="service">ejabberd</systemitem>
333 you must stop that service. As the <systemitem class="username">root</systemitem> user,
334 execute the following command to stop the service:</para>
336 <userinput>/etc/init.d/ejabberd stop</userinput>
338 <para>If <systemitem class="service">ejabberd</systemitem> reports that it
339 is already stopped, there may have been a problem when it started back
340 in the installation step. If there are any remaining daemon processes such as
341 <systemitem class="daemon">beam</systemitem> or
342 <systemitem class="daemon">epmd</systemitem>
343 you may need to perform the following commands to kill them:</para>
345 <userinput>epmd -kill</userinput>
346 <userinput>killall beam; killall beam.smp</userinput>
347 <userinput>rm /var/lib/ejabberd/*</userinput>
348 <userinput>echo 'ERLANG_NODE=ejabberd@localhost' >> /etc/default/ejabberd</userinput>
352 <title>Edit the <systemitem class="service">ejabberd</systemitem> configuration</title>
353 <para>You must make several configuration changes for the
354 <systemitem class="service">ejabberd</systemitem> service before
356 As the <systemitem class="username">root</systemitem> user, edit the file
357 <filename>/etc/ejabberd/ejabberd.cfg</filename> and make the following changes:</para>
360 <para>Change the line:
361 <screen><userinput>{hosts, ["localhost"]}.</userinput></screen>
363 <screen><userinput>{hosts, ["localhost", "private.localhost", "public.localhost"]}.</userinput></screen></para>
366 <para>Change the line:
367 <screen><userinput>{max_user_sessions, 10}.</userinput></screen> to:
368 <screen><userinput>{max_user_sessions, 10000}.</userinput></screen></para>
369 <para>If the line looks something like this:
370 <screen><userinput>{access, max_user_sessions, [{10, all}]}.</userinput></screen>
372 <screen><userinput>{access, max_user_sessions, [{10000, all}]}</userinput></screen></para>
375 <para>Change all three occurrences of: <literal>max_stanza_size</literal>
376 to: <literal>2000000</literal>.</para>
379 <para>Change both occurrences of: <literal>maxrate</literal> to:
380 <literal>500000</literal>.</para>
383 <para>Comment out the line <literal>{mod_offline, []}</literal>
384 by placing two <literal>%</literal> comment signs in front.</para>
388 <step xml:id="serversideinstallation-opensrf-continued">
389 <title>Restart the <systemitem class="service">ejabberd</systemitem> service</title>
390 <para>As the <systemitem class="username">root</systemitem> user, restart the
391 <systemitem class="service">ejabberd</systemitem> service to test the
392 configuration changes and to register your users:</para>
394 <userinput>/etc/init.d/ejabberd start</userinput>
398 <title>Register <systemitem class="username">router</systemitem> and
399 <systemitem class="username">ejabberd</systemitem> users</title>
400 <para>The two <systemitem class="service">ejabberd</systemitem> users
401 <systemitem class="username">router</systemitem> and
402 <systemitem class="username">opensrf</systemitem> must be registered
403 and configured to manage OpenSRF router service and communications
404 for the two domains <literal>public.localhost</literal> and
405 <literal>private.localhost</literal> that you added to the file
406 <filename>/etc/hosts</filename> in a previous step
407 (see <xref linkend="serversideinstallation-definedomains"/>).
408 The users include:</para>
411 <para>the <systemitem class="username">router</systemitem> user,
412 to whom all requests to connect to an OpenSRF service will be
416 <para>the <systemitem class="username">opensrf</systemitem> user,
417 which clients use to connect to OpenSRF services (you may name
418 the user anything you like, but we use
419 <literal>opensrf</literal> in these examples)</para>
422 <para>As the <systemitem class="username">root</systemitem> user, execute the
423 <command>ejabberdctl</command> utility as shown below to register and create passwords
424 for the users <systemitem class="username">router</systemitem> and
425 <systemitem class="username">opensrf</systemitem> on each domain:</para>
427 <prompt># The syntax for registering a user with ejabberdctl is:</prompt>
428 <prompt># ejabberdctl register USER DOMAIN PASSWORD</prompt>
429 <userinput>ejabberdctl register router private.localhost NEWPASSWORD</userinput>
430 <userinput>ejabberdctl register router public.localhost NEWPASSWORD</userinput>
431 <userinput>ejabberdctl register opensrf private.localhost NEWPASSWORD</userinput>
432 <userinput>ejabberdctl register opensrf public.localhost NEWPASSWORD</userinput>
434 <para>Note that the users <systemitem class="username">router</systemitem> and
435 <systemitem class="username">opensrf</systemitem> and their respective passwords
436 will be used again in the file <filename>/openils/conf/opensrf_core.xml</filename>
437 in the next steps.</para>
439 <step xml:id="serversideinstallation-opensrf-createconfig">
440 <title>Create OpenSRF configuration files</title>
441 <para>As the <systemitem class="username">opensrf</systemitem> user,
442 execute the following commands to create the new configuration files
443 <filename>/openils/conf/opensrf_core.xml</filename> and
444 <filename>/openils/conf/opensrf.xml</filename> from the example templates:</para>
446 <userinput>cd /openils/conf</userinput>
447 <userinput>cp opensrf.xml.example opensrf.xml</userinput>
448 <userinput>cp opensrf_core.xml.example opensrf_core.xml</userinput>
452 <title>Update usernames and passwords in the OpenSRF configuration file</title>
453 <para>As the <systemitem class="username">opensrf</systemitem> user, edit the
454 OpenSRF configuration file <filename>/openils/conf/opensrf_core.xml</filename>
455 and update the usernames and passwords to match the values shown in the
456 following table. The left-hand side of <xref linkend="serversideinstallation-xpath-table-1"/>
457 shows common XPath syntax to indicate the approximate position within the XML
458 file that needs changes. The right-hand side of the table shows the replacement
460 <table xml:id="serversideinstallation-xpath-table-1">
461 <title>Sample XPath syntax for editing "opensrf_core.xml"</title>
462 <tgroup align="left" cols="2" colsep="1" rowsep="1">
463 <colspec colname="Xpath" colnum="1" colwidth="1.6*"/>
464 <colspec colname="Value" colnum="2" colwidth="2.0*"/>
467 <entry>XPath location</entry>
473 <entry>/config/opensrf/username</entry>
475 <systemitem class="username">opensrf</systemitem>
479 <entry>/config/opensrf/passwd </entry>
480 <entry><systemitem class="domainname">private.localhost</systemitem>
482 <systemitem class="username">opensrf</systemitem> user
486 <entry>/config/gateway/username</entry>
488 <systemitem class="username">opensrf</systemitem>
492 <entry>/config/gateway/passwd</entry>
493 <entry><systemitem class="domainname">public.localhost</systemitem>
495 <systemitem class="username">opensrf</systemitem> user
499 <entry>/config/routers/router/transport/username,
500 first entry where server == public.localhost</entry>
502 <systemitem class="username">router</systemitem>
506 <entry>/config/routers/router/transport/password,
507 first entry where server == public.localhost</entry>
508 <entry><systemitem class="domainname">public.localhost</systemitem>
510 <systemitem class="username">router</systemitem> user
514 <entry>/config/routers/router/transport/username,
515 second entry where server == private.localhost</entry>
517 <systemitem class="username">router</systemitem>
521 <entry>/config/routers/router/transport/password,
522 second entry where server == private.localhost</entry>
523 <entry><systemitem class="domainname">private.localhost</systemitem>
525 <systemitem class="username">router</systemitem> user
531 <para>You may also need to modify the file to specify the domains from which
532 <systemitem class="service">OpenSRF</systemitem> will accept connections,
533 and to which it will make connections.
534 If you are installing <application>OpenSRF</application> on a single server
535 and using the <systemitem class="domainname">private.localhost</systemitem> and
536 <systemitem class="domainname">public.localhost</systemitem> domains,
537 these will already be set to the correct values. Otherwise, search and replace
538 to match values for your own systems.</para>
541 <title>Set location of the persistent database</title>
542 <para>As the <systemitem class="username">opensrf</systemitem> user, edit the
543 file <filename>/openils/conf/opensrf.xml</filename>, then find and modify the
544 element <literal>dbfile</literal> (near the end of the file) to set the
545 location of the persistent database:</para>
546 <programlisting language="xml"><![CDATA[
547 <!-- Example of an app-specific setting override -->
550 <dbfile>/tmp/persist.db</dbfile>
555 <step xml:id="serversideinstallation-srfsh">
556 <title>Create configuration files for users needing <command>srfsh</command></title>
557 <para>In this section you will set up a special configuration file for each user
558 who will need to run the <command>srfsh</command> (pronounced <emphasis>surf
559 shell</emphasis>) utility.</para>
561 <primary>srfsh</primary>
563 <para>The software installation will automatically create the utility
564 <command>srfsh</command> (surf shell), a command line diagnostic tool for
565 testing and interacting with <application>OpenSRF</application>. It will be used
566 in a future step to complete and test the Evergreen installation. See
567 <xref linkend="serversideinstallation-testing"/> for further information.</para>
568 <para>As the <systemitem class="username">root</systemitem> user, copy the
569 sample configuration file <filename>/openils/conf/srfsh.xml.example</filename>
570 to the home directory of each user who will use <command>srfsh</command>.
571 For instance, do the following for the
572 <systemitem class="username">opensrf</systemitem> user:</para>
574 <userinput>cp /openils/conf/srfsh.xml.example /home/opensrf/.srfsh.xml</userinput>
576 <para>Edit each user's file <filename>~/.srfsh.xml</filename> and make the
577 following changes:</para>
580 <para>Modify <literal>domain</literal> to be the router hostname
581 (following our domain examples,
582 <systemitem class="domainname">private.localhost</systemitem> will give
583 <command>srfsh</command> access to all OpenSRF services, while
584 <systemitem class="domainname">public.localhost</systemitem>
585 will only allow access to those OpenSRF services that are
586 publicly exposed).</para>
589 <para>Modify <literal>username</literal> and
590 <literal>password</literal> to match the
591 <literal>opensrf</literal> Jabber user for the chosen
595 <para>Modify <literal>logfile</literal> to be the full path for
596 a log file to which the user has write access</para>
599 <para>Modify <literal>loglevel</literal> as needed for testing</para>
602 <para>Change the owner of the file to match the owner of the home directory</para>
605 <para>Following is a sample of the file:</para>
606 <programlisting language="xml"><![CDATA[
607 <?xml version="1.0"?>
608 <!-- This file follows the standard bootstrap config file layout -->
609 <!-- found in opensrf_core.xml -->
611 <router_name>router</router_name>
612 <domain>private.localhost</domain>
613 <username>opensrf</username>
614 <passwd>SOMEPASSWORD</passwd>
616 <logfile>/tmp/srfsh.log</logfile>
617 <!-- 0 None, 1 Error, 2 Warning, 3 Info, 4 debug, 5 Internal (Nasty) -->
618 <loglevel>4</loglevel>
623 <title>Modify the environmental variable <envar>PATH</envar> for the
624 <systemitem class="username">opensrf</systemitem> user</title>
625 <para>As the <systemitem class="username">opensrf</systemitem> user, modify the
626 environmental variable <envar>PATH</envar> by adding a new file path to the
627 <systemitem class="username">opensrf</systemitem> user's shell configuration
628 file <filename>~/.bashrc</filename>:</para>
630 <userinput>echo "export PATH=/openils/bin:\$PATH" >> ~/.bashrc</userinput>
634 <title>Start OpenSRF</title>
635 <para>As the <systemitem class="username">root</systemitem> user, start the
636 <systemitem class="service">ejabberd</systemitem> and
637 <systemitem class="service">memcached</systemitem> services:</para>
639 <userinput>/etc/init.d/ejabberd start</userinput>
640 <userinput>/etc/init.d/memcached start</userinput>
642 <para>As the <systemitem class="username">opensrf</systemitem> user,
643 start OpenSRF as follows:</para>
645 <userinput>osrf_ctl.sh -l -a start_all</userinput>
647 <para>The flag <option>-l</option> forces Evergreen to use
648 <systemitem class="domainname">localhost</systemitem> (your current system)
649 as the hostname. The flag <option>-a start_all</option> starts the other
650 OpenSRF <systemitem class="service">router</systemitem> ,
651 <systemitem class="service">Perl</systemitem> , and
652 <systemitem class="service">C</systemitem> services.</para>
655 <para>You can also start Evergreen without the
656 <option>-l</option> flag, but the <command>osrf_ctl.sh</command>
657 utility must know the fully qualified domain name for the system
658 on which it will execute. That hostname was probably specified
659 in the configuration file <filename>opensrf.xml</filename> which
660 you configured in a previous step.</para>
663 <para>If you receive an error message similar to
664 <emphasis>osrf_ctl.sh: command not found</emphasis>, then your
665 environment variable <envar>PATH</envar> does not include the
666 directory <filename class="directory">/openils/bin</filename>.
667 As the <systemitem class="username">opensrf</systemitem> user,
668 edit the configuration file <filename>~/.bashrc</filename> and
669 add the following line:
670 <literal>export PATH=$PATH:/openils/bin</literal></para>
675 <title>Test connections to OpenSRF</title>
676 <para>Once you have installed and started OpenSRF, as the
677 <systemitem class="username">root</systemitem> user, test your connection to
678 <systemitem class="service">OpenSRF</systemitem> using the <command>srfsh</command>
679 utility and trying to call the <command>add</command> method on the OpenSRF
680 <systemitem class="service">math</systemitem> service:</para>
682 <userinput>/openils/bin/srfsh</userinput>
683 <computeroutput>srfsh# <userinput>request opensrf.math add 2 2</userinput></computeroutput>
684 <computeroutput>Received Data: 4</computeroutput>
685 <computeroutput>------------------------------------</computeroutput>
686 <computeroutput>Request Completed Successfully</computeroutput>
687 <computeroutput>Request Time in seconds: 0.007519</computeroutput>
688 <computeroutput>------------------------------------</computeroutput>
690 <para>For other <command>srfsh</command> commands, type in
691 <userinput>help</userinput> at the prompt.</para>
694 <title>Stop OpenSRF</title>
695 <para>After OpenSRF has started, you can stop it at any time by using the
696 <command>osrf_ctl.sh</command> again. As the
697 <systemitem class="username">opensrf</systemitem>
698 user, stop OpenSRF as follows:</para>
700 <userinput>osrf_ctl.sh -l -a stop_all</userinput>
705 <section xml:id="serversideinstallation-ubuntudebian">
706 <title>Installing Evergreen 1.6.1.x On <systemitem class="osname">Ubuntu</systemitem> or
707 <systemitem class="osname">Debian</systemitem></title>
709 <primary>Linux</primary>
710 <secondary>Debian</secondary>
713 <primary>Linux</primary>
714 <secondary>Ubuntu</secondary>
716 <para>This section outlines the installation process for the latest stable version of
718 <para>In this section you will download, unpack, install, configure and test the Evergreen
719 system, including the Evergreen server and the PostgreSQL database system. You will make several
720 configuration changes and adjustments to the software, including updates to configure the system
721 for your own locale, and some updates needed to work around a few known issues.</para>
723 <para>The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit)
724 architectures. There may be differences between the Desktop and Server editions of
725 <systemitem class="osname">Ubuntu</systemitem>. These instructions assume the Server
727 <para>In the following instructions, you are asked to perform certain steps as
728 either the <systemitem class="username">root</systemitem> user, the
729 <systemitem class="username">opensrf</systemitem> user, or the
730 <systemitem class="username">postgres</systemitem> user.</para>
733 <para><systemitem class="osname">Debian</systemitem> -- To become the
734 <systemitem class="username">root</systemitem> user, issue the command
735 <command>su -</command> and enter the password of the
736 <systemitem class="username">root</systemitem> user.</para>
739 <para><systemitem class="osname">Ubuntu</systemitem> -- To become the
740 <systemitem class="username">root</systemitem> user, issue the command
741 <command>sudo su -</command> and enter the password of the
742 <systemitem class="username">root</systemitem> user.</para>
745 <para>To switch from the <systemitem class="username">root</systemitem> user to a
746 different user, issue the command <command>su - USERNAME</command>. For example, to
747 switch from the <systemitem class="username">root</systemitem> user to the
748 <systemitem class="username">opensrf</systemitem> user, issue the command
749 <command>su - opensrf</command>. Once you have become a non-root user, to become the
750 <systemitem class="username">root</systemitem> user again, simply issue the command
751 <command>exit</command>.</para>
755 <title>Install OpenSRF</title>
756 <para>Evergreen software is integrated with and depends on the Open Service
757 Request Framework (OpenSRF) software system. For further information on
758 installing, configuring and testing OpenSRF, see
759 <xref linkend="serversideinstallation-opensrf"/>.</para>
760 <para>Follow the steps outlined in that section and run the specified tests to
761 ensure that OpenSRF is properly installed and configured. Do
762 <emphasis><emphasis role="bold">not</emphasis></emphasis> continue with
763 any further Evergreen installation steps until you have verified that OpenSRF
764 has been successfully installed and tested.</para>
767 <title>Download and Unpack Latest Evergreen Version</title>
768 <para>As the <systemitem class="username">opensrf</systemitem> user, download
769 and extract the latest version of Evergreen. The latest version can be found here:
770 <ulink url="http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.1.2.tar.gz"></ulink></para>
772 <userinput>wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.1.2.tar.gz</userinput>
773 <userinput>tar zxf Evergreen-ILS-1.6.1.2.tar.gz</userinput>
775 <para>The new directory
776 <filename class="directory">/home/opensrf/Evergreen-ILS-1.6.1.2</filename>
777 will be created.</para>
779 <step xml:id="serversideinstallation-installprereq">
780 <title>Install Prerequisites to Build Evergreen</title>
781 <para>In this section you will install and configure a set of prerequisites that
782 will be used to build Evergreen. In a following step you will actually build the
783 Evergreen software using the <command>make</command> utility.</para>
784 <para>As the <systemitem class="username">root</systemitem> user, enter the commands show
785 below to build the prerequisites from the software distribution that you just downloaded
786 and unpacked. Remember to replace <emphasis>[DISTRIBUTION]</emphasis> in the following
787 example with the keyword corresponding to the name of one of the
788 <systemitem class="osname">Linux</systemitem> distributions listed in the following distribution
789 keywords table <xref linkend="serversideinstallation-keywords-evergreen"/> . For example,
790 to install the prerequisites for Ubuntu version 9.10 (Karmic Koala) you would enter this
791 command: <command>make -f Open-ILS/src/extras/Makefile.install ubuntu-karmic</command>.</para>
793 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2</userinput>
794 <userinput>make -f Open-ILS/src/extras/Makefile.install [DISTRIBUTION]</userinput>
796 <table xml:id="serversideinstallation-keywords-evergreen">
797 <title>Keyword Targets for Evergreen <application>"make"</application> Command</title>
798 <tgroup align="left" cols="2" colsep="1" rowsep="1">
799 <colspec colnum="1" colwidth="1.0*"/>
800 <colspec colnum="2" colwidth="3.0*"/>
803 <entry>Keyword</entry>
804 <entry>Linux Version</entry>
809 <entry>debian-etch</entry>
810 <entry>Debian "Etch" (4.0)</entry>
813 <entry>debian-lenny</entry>
814 <entry>Debian "Lenny" (5.0)</entry>
817 <entry>ubuntu-hardy</entry>
818 <entry>Ubuntu "Hardy Heron" (8.04)</entry>
821 <entry>ubuntu-intrepid</entry>
822 <entry>Ubuntu "Intrepid Ibex" (8.10)</entry>
825 <entry>ubuntu-karmic</entry>
826 <entry>Ubuntu "Karmic Koala" (9.10)</entry>
829 <entry>ubuntu-karmic</entry>
830 <entry>Ubuntu "Lucid Lynx" (10.04)</entry>
833 <entry>centos</entry>
834 <entry>Centos</entry>
841 <entry>gentoo</entry>
842 <entry>Gentoo</entry>
848 <step performance="optional" xml:id="serversideinstallation-postgresql-default">
849 <title>(OPTIONAL) Install the PostgreSQL Server</title>
851 <primary>databases</primary>
852 <secondary>PostgreSQL</secondary>
854 <para>Since the PostgreSQL server is usually a standalone server in multi-server
855 production systems, the prerequisite installer Makefile in the previous section
856 (see <xref linkend="serversideinstallation-installprereq"/>)
857 does not automatically install PostgreSQL. You must install the PostgreSQL server
858 yourself, either on the same system as Evergreen itself or on another system.
859 If your PostgreSQL server is on a different system, just skip this step.</para>
860 <para>For further information on manually installing PostgreSQL, visit the official
861 <link xl:href="http://www.postgresql.org/">PostgreSQL Site</link>.</para>
862 <para>If your PostgreSQL server will be on the same system as your Evergreen
863 software, then as the <systemitem class="username">root</systemitem> user
864 install the required PostgreSQL server packages:</para>
865 <para>For <systemitem class="osname">Debian Lenny</systemitem> and
866 <systemitem class="osname">Ubuntu Hardy (8.04)</systemitem>:</para>
868 <userinput>make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_83</userinput>
870 <para>For <systemitem class="osname">Ubuntu Karmic (9.10)</systemitem> and
871 <systemitem class="osname">Ubuntu Lucid (10.04)</systemitem>:</para>
873 <userinput>make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_84</userinput>
876 <para>PostgreSQL versions 8.3 or 8.4 are the recommended versions to work
877 with Evergreen 1.6. If you have an older version of PostgreSQL, you should
878 upgrade before installing Evergreen. To find the running version of
879 PostgreSQL, as the <systemitem class="username">postgres</systemitem>
880 user, run the <command>psql</command>. Then type <userinput>SELECT
881 version();</userinput> to get detailed information about your version
882 of PostgreSQL.</para>
885 <step performance="optional">
886 <title>Install Perl Modules on PostgreSQL Server</title>
887 <para>If PostgreSQL is running on the same system as your Evergreen software,
888 then the Perl modules will automatically be available. Just skip this step.
889 Otherwise, continue if your PostgreSQL server is running on another system.</para>
890 <para>You will need to install several Perl modules on the other system. As the
891 <systemitem class="username">root</systemitem> user install the following Perl
894 <prompt># first, ensure the gcc compiler is installed:</prompt>
895 <userinput>apt-get install gcc</userinput>
896 <prompt># then install the Perl modules:</prompt>
897 <userinput>perl -MCPAN -e shell</userinput>
898 <computeroutput>cpan></computeroutput>
899 <userinput>install JSON::XS</userinput>
900 <computeroutput>cpan></computeroutput>
901 <userinput>install MARC::Record</userinput>
902 <computeroutput>cpan></computeroutput>
903 <userinput>install MARC::File::XML</userinput>
905 <para>For more information on installing Perl Modules vist the official
906 <link xl:href="http://www.cpan.org/">CPAN</link> site.</para>
908 <primary>Perl</primary>
909 <secondary>CPAN</secondary>
913 <title>Update the System Dynamic Library Path</title>
914 <para>You must update the system dynamic library path to force your system to recognize
915 the newly installed libraries. As the <systemitem class="username">root</systemitem> user,
916 do this by creating the new file <filename>/etc/ld.so.conf.d/osrf.conf</filename>
917 containing a new library path, then run the command <command>ldconfig</command> to
918 automatically read the file and modify the system dynamic library path:</para>
920 <userinput>echo "/usr/local/lib" >> /etc/ld.so.conf.d/osrf.conf</userinput>
921 <userinput>echo "/usr/local/lib/dbd" >> /etc/ld.so.conf.d/osrf.conf</userinput>
922 <userinput>ldconfig</userinput>
925 <step performance="optional">
926 <title>Restart the PostgreSQL Server</title>
927 <para>If PostgreSQL is running on the same system as the rest of Evergreen, as
928 the <systemitem class="username">root</systemitem> user you must restart
929 PostgreSQL to re-read the new library paths just configured. If PostgreSQL is
930 running on another system, you may skip this step.
931 As the <systemitem class="username">opensrf</systemitem> user,
932 execute the following command, where
933 <literal>[PGSQL_VERSION]</literal> is your installed PostgreSQL version
934 (e.g. <literal>8.3</literal>):</para>
936 <userinput>/etc/init.d/postgresql-[PGSQL_VERSION] restart</userinput>
939 <step xml:id="serversideinstallation-configure">
940 <title>Configure Evergreen</title>
941 <para>As the <systemitem class="username">opensrf</systemitem> user, return to
942 the Evergreen build directory and use the <command>configure</command> and
943 <command>make</command> utilities to configure Evergreen so it can be compiled
944 and linked in the next step:</para>
946 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2</userinput>
947 <userinput>./configure --prefix=/openils --sysconfdir=/openils/conf</userinput>
948 <userinput>make</userinput>
952 <title>Compile, Link and Install Evergreen</title>
953 <para>In this step you will actually compile, link and install Evergreen and the
954 default Evergreen Staff Client.</para>
955 <para>As the <systemitem class="username">root</systemitem> user, return to the
956 Evergreen build directory and use the <command>make</command> utility as shown below:</para>
958 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2</userinput>
959 <userinput>make STAFF_CLIENT_BUILD_ID=rel_1_6_1_2 install</userinput>
961 <para>The Staff Client will also be automatically built, but you must remember
962 to set the variable <envar>STAFF_CLIENT_BUILD_ID</envar> to match the version of the Staff
963 Client you will use to connect to the Evergreen server. For further information on manually
964 building the Staff Client, see
965 <xref linkend="staffclientinstallation-building-staffclient"/>.</para>
966 <para>The above commands will create a new subdirectory
967 <filename class="directory">/openils/var/web/xul/rel_1_6_1_2</filename>
968 containing the Staff Client.</para>
969 <para>To complete the Staff Client installation,
970 as the <systemitem class="username">root</systemitem> user create a symbolic link
971 named <emphasis>server</emphasis> in the head of the Staff Client directory
972 <filename class="directory">/openils/var/web/xul</filename> that points to the
973 subdirectory <filename class="directory">/server</filename> of the new Staff
976 <userinput>cd /openils/var/web/xul</userinput>
977 <userinput>ln -sf rel_1_6_1_2/server server</userinput>
981 <title>Copy the OpenSRF Configuration Files</title>
982 <para>You must copy several example OpenSRF configuration files into place after first
983 creating backup copies for troubleshooting purposes, then change all the file ownerships
984 to <systemitem class="username">opensrf</systemitem>. These files replace the
985 configuration files that you set up in a previous step
986 (see <xref linkend="serversideinstallation-opensrf-createconfig"/>)
987 when you installed and tested OpenSRF.
988 As the <systemitem class="username">root</systemitem> user, execute the
989 following commands:</para>
991 <userinput>cd /openils/conf</userinput>
992 <userinput>cp opensrf.xml opensrf.xml.BAK</userinput>
993 <userinput>cp opensrf_core.xml opensrf_core.xml.BAK</userinput>
994 <userinput>cp opensrf.xml.example opensrf.xml</userinput>
995 <userinput>cp opensrf_core.xml.example opensrf_core.xml</userinput>
996 <userinput>cp oils_web.xml.example oils_web.xml</userinput>
997 <userinput>chown -R opensrf:opensrf /openils/</userinput>
1001 <title>Create and Configure PostgreSQL Database</title>
1003 <primary>databases</primary>
1004 <secondary>PostgreSQL</secondary>
1006 <para>In this step you will create the Evergreen database. In the commands
1007 below, remember to adjust the path of the <emphasis role="bold">contrib</emphasis>
1008 repository to match your PostgreSQL server
1009 layout. For example, if you built PostgreSQL from source the path would be
1010 <filename class="directory">/usr/local/share/contrib</filename>; if you
1011 installed the PostgreSQL 8.3 server packages on <systemitem class="osname">Ubuntu 8.04</systemitem>,
1013 <systemitem class="directory">/usr/share/postgresql/8.3/contrib/</systemitem>.</para>
1017 <emphasis role="bold">Create and configure the database</emphasis>
1019 <para>As the <systemitem class="username">postgres</systemitem>
1020 user on the PostgreSQL system create the PostgreSQL database,
1021 then set some internal paths:</para>
1023 <userinput>createdb evergreen -E UTF8 -T template0</userinput>
1024 <userinput>createlang plperl evergreen</userinput>
1025 <userinput>createlang plperlu evergreen</userinput>
1026 <userinput>createlang plpgsql evergreen</userinput>
1028 <para>Continue as user <systemitem class="username">postgres</systemitem>
1029 and execute the SQL scripts as shown below, adjusting the paths as needed, where
1030 <literal>[PGSQL_VERSION]</literal> is your installed PostgreSQL
1031 version (e.g. <literal>8.3</literal>).</para>
1033 <userinput>psql -f /usr/share/postgresql/[PGSQL_VERSION]/contrib/tablefunc.sql evergreen</userinput>
1034 <userinput>psql -f /usr/share/postgresql/[PGSQL_VERSION]/contrib/tsearch2.sql evergreen</userinput>
1035 <userinput>psql -f /usr/share/postgresql/[PGSQL_VERSION]/contrib/pgxml.sql evergreen</userinput>
1038 <step xml:id="serversideinstallation-postgresqlcreateuser">
1039 <title>Create <systemitem class="username">evergreen</systemitem> PostgreSQL user</title>
1040 <para>As the <systemitem class="username">postgres</systemitem>
1041 user on the PostgreSQL system, create a new PostgreSQL user
1042 named <systemitem class="username">evergreen</systemitem> and
1043 assign a password:</para>
1045 <userinput>createuser -P -s evergreen</userinput>
1046 <computeroutput>Enter password for new role: <userinput>MYNEWPASSWORD</userinput></computeroutput>
1047 <computeroutput>Enter it again: <userinput>MYNEWPASSWORD</userinput></computeroutput>
1051 <title>Create database schema</title>
1052 <para>As the <systemitem class="username">root</systemitem>
1053 user, create the database schema and configure your system with
1054 the corresponding database authentication details for the
1055 <emphasis>evergreen</emphasis> database user that you just created
1056 in the previous step
1057 (see <xref linkend="serversideinstallation-postgresqlcreateuser"/>).</para>
1058 <para>Enter the following commands and replace
1059 <emphasis>HOSTNAME, PORT, PASSWORD</emphasis> and
1060 <emphasis>DATABASENAME</emphasis> with appropriate
1063 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2</userinput>
1064 <userinput>perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \</userinput>
1065 <userinput> --service all --create-schema --create-bootstrap --create-offline \</userinput>
1066 <userinput> --hostname HOSTNAME --port PORT \</userinput>
1067 <userinput> --user evergreen --password PASSWORD --database DATABASENAME</userinput>
1069 <para>On most systems, <emphasis>HOSTNAME</emphasis> will be
1070 <emphasis role="bold">localhost</emphasis> and
1071 <emphasis>PORT</emphasis> will be <emphasis role="bold">5432</emphasis>.
1072 Of course, values for <emphasis>PASSWORD</emphasis> and
1073 <emphasis>DATABASENAME</emphasis> must match the values you used in the
1075 (see <xref linkend="serversideinstallation-postgresqlcreateuser"/>)
1076 when you created the database and and set a password for the
1077 <systemitem class="username">evergreen</systemitem> user.</para>
1078 <para>As the command executes, you may see warnings similar to:
1079 <literal>ERROR: schema SOMENAME does not exist</literal> (in fact,
1080 you may see one warning per schema) but they can be safely ignored.</para>
1082 <para>If you are entering the above command on a single line, do
1083 not include the <literal>\</literal> (backslash) characters. If
1084 you are using the <command>bash</command> shell, these should only
1085 be used at the end of a line at a <command>bash</command> prompt
1086 to indicate that the command is continued on the next line.</para>
1091 <step><title>Configure the Apache web server</title><indexterm><primary>web server</primary><secondary>Apache</secondary></indexterm><para>In this step you will configure the Apache web server to support Evergreen
1092 software.</para> <para>First, you must enable some built-in Apache modules and
1093 install some additional Apache configuration files. Then you will create a new
1094 Security Certificate. Finally, you must make several changes to the Apache
1095 configuration file.</para><substeps><step><title>Enable the required Apache Modules</title><para>As the <systemitem class="username">root</systemitem>
1096 user, enable some modules in the Apache server, then copy the
1097 new configuration files to the Apache server directories:</para><indexterm><primary>Apache</primary></indexterm><screen><userinput>a2enmod ssl # enable mod_ssl</userinput><userinput>a2enmod rewrite # enable mod_rewrite</userinput><userinput>a2enmod expires # enable mod_expires</userinput></screen><para>As the commands execute, you may see warnings similar to:
1098 <literal>Module SOMEMODULE already enabled</literal> but you can
1099 safely ignore them.</para></step><step><title>Copy Apache configuration files</title><para>You must copy the Apache configuration files from the
1100 Evergreen installation directory to the Apache directory. As the
1101 <systemitem class="username">root</systemitem> user, perform the
1102 following commands:</para><screen><userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2</userinput><userinput>cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/</userinput><userinput>cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/</userinput><userinput>cp Open-ILS/examples/apache/startup.pl /etc/apache2/</userinput></screen></step><step xml:id="serversideinstallation-createsslcertificate"><title>Create a Security Certificate</title><para>You must create a new Security Certificate (SSL Key) for
1103 the Apache server using the <command>openssl</command>
1104 command. For a public production server you must configure or
1105 purchase a signed SSL certificate, but for now you can just use
1106 a self-signed certificate and accept the warnings in the Staff
1107 Client and browser during testing and development. As the
1108 <systemitem class="username">root</systemitem> user, perform the
1109 following commands:</para><screen><userinput>mkdir /etc/apache2/ssl</userinput><userinput>cd /etc/apache2/ssl</userinput><userinput>openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key</userinput></screen><note><para>This step generates a self-signed SSL
1110 certificate. You must install a proper SSL certificate
1111 for a public production system to avoid warning messages
1112 when users login to their account through the OPAC or
1113 when staff login through the Staff Client.</para><para>For further information on installing a proper SSL
1114 certificate, see <xref linkend="serversideinstallation-ssl"/>.</para></note></step><step xml:id="serversideinstallation-modify-apache"><title>Update Apache configuration file</title><para>You must make several changes to the new Apache
1116 <filename>/etc/apache2/sites-available/eg.conf</filename> .
1117 As the <systemitem class="username">root</systemitem> user,
1118 edit the file and make the following changes:</para><itemizedlist><listitem><para>In the section
1119 <literal><Directory "/openils/var/cgi-bin"></literal>
1121 <literal>Allow from 10.0.0.0/8</literal>
1122 with this line: <literal>Allow from all</literal>.</para><warning>This change allows access to your configuration
1123 CGI scripts from any workstation on any network. This is
1124 only a temporary change to expedite testing and should be
1125 removed after you have finished and successfully tested
1126 the Evergreen installation. See
1127 <xref linkend="serversideinstallation-postinstallation"/>
1128 for further details on removing this change after the
1129 Evergreen installation is complete.
1130 </warning></listitem><listitem><para>Comment out the line <literal>Listen 443</literal>,
1131 since it conflicts with the same declaration in the
1133 <filename>/etc/apache2/ports.conf</filename>. Note that
1134 <systemitem class="osname">Debian </systemitem> users
1135 should not do this since the conflict does not apply to
1136 that operating system.</para></listitem><listitem><para>The following updates are needed to allow the logs
1137 to function properly, but it may break other Apache
1138 applications on your server:</para><para>For the
1139 <systemitem class="osname">Linux</systemitem> distributions
1140 <systemitem class="osname">Ubuntu Hardy</systemitem> or
1141 <systemitem class="osname">Debian Etch</systemitem>, as
1142 the <systemitem class="username">root</systemitem> user,
1143 edit the Apache configuration file
1144 <filename>/etc/apache2/apache2.conf</filename> and change
1145 the line <literal>User www-data</literal> to <literal>User
1146 opensrf</literal>.</para> <para>For the
1147 <systemitem class="osname">Linux</systemitem> distributions
1148 <systemitem class="osname">Ubuntu Karmic</systemitem>,
1149 <systemitem class="osname">Ubuntu Lucid</systemitem> or
1150 <systemitem class="osname">Debian Lenny</systemitem>, as
1151 the <systemitem class="username">root</systemitem> user,
1152 edit the Apache configuration file and change these
1153 lines:</para><screen><userinput>export APACHE_RUN_USER=www-data</userinput><userinput>export APACHE_RUN_GROUP=www-data</userinput></screen><para>to instead read:</para><screen><userinput>export APACHE_RUN_USER=opensrf</userinput><userinput>export APACHE_RUN_GROUP=opensrf</userinput></screen></listitem><listitem><para>As the
1154 <systemitem class="username">root</systemitem> user,
1155 edit the Apache configuration file
1156 <filename>/etc/apache2/apache2.conf</filename> and
1157 modify the values for <literal>KeepAliveTimeout</literal>
1158 and <literal>MaxKeepAliveRequests</literal> to match
1159 the following:</para><screen><userinput>KeepAliveTimeout 1</userinput><userinput>MaxKeepAliveRequests 100</userinput></screen></listitem><listitem><para>Further configuration changes to Apache may be
1160 necessary for busy systems. These changes increase the
1161 number of Apache server processes that are started to
1162 support additional browser connections.</para><para>As the
1163 <systemitem class="username">root</systemitem> user,
1164 edit the Apache configuration file
1165 <filename>/etc/apache2/apache2.conf</filename>, locate
1166 and modify the section related to <emphasis>prefork
1167 configuration</emphasis> to suit the load on your
1168 system:</para><programlisting language="xml"><![CDATA[
1169 <IfModule mpm_prefork_module>
1174 MaxRequestsPerChild 10000
1176 ]]></programlisting></listitem></itemizedlist></step><step><title>Enable the Evergreen web site</title><para>Finally, you must enable the Evergreen web site. As the
1177 <systemitem class="username">root</systemitem> user, execute the
1178 following Apache configuration commands to disable the default
1179 <emphasis>It Works</emphasis> web page and enable the Evergreen
1180 web site, and then restart the Apache server:</para><screen><prompt># disable/enable web sites</prompt><userinput>a2dissite default</userinput><userinput>a2ensite eg.conf</userinput><prompt># restart the server</prompt><userinput>/etc/init.d/apache2 reload</userinput></screen></step></substeps></step>
1181 <step xml:id="serversideinstallation-opensrf-config">
1182 <title>Update the OpenSRF Configuration File</title>
1183 <para>As the <systemitem class="username">opensrf</systemitem> user, edit the
1184 OpenSRF configuration file <filename>/openils/conf/opensrf_core.xml</filename>
1185 to update the Jabber usernames and passwords, and to specify the domain from
1186 which we will accept and to which we will make connections.</para>
1187 <para>If you are installing Evergreen on a single server and using the
1188 <systemitem class="domainname">private.localhost</systemitem> /
1189 <systemitem class="domainname">public.localhost</systemitem> domains,
1190 these will already be set to the correct values. Otherwise, search and replace
1191 to match your customized values.</para>
1192 <para>The left-hand side of <xref linkend="serversideinstallation-xpath-table-2"/>
1193 shows common XPath syntax to indicate the approximate position within the XML
1194 file that needs changes. The right-hand side of the table shows the replacement
1196 <table xml:id="serversideinstallation-xpath-table-2">
1197 <title>Sample XPath syntax for editing "opensrf_core.xml"</title>
1198 <tgroup align="left" cols="2" colsep="1" rowsep="1">
1199 <colspec colname="Xpath" colnum="1" colwidth="1.6*"/>
1200 <colspec colname="Value" colnum="2" colwidth="2.0*"/>
1203 <entry>XPath location</entry>
1204 <entry>Value</entry>
1209 <entry>/config/opensrf/username</entry>
1211 <systemitem class="username">opensrf</systemitem>
1215 <entry>/config/opensrf/passwd </entry>
1216 <entry><systemitem class="domainname">private.localhost</systemitem>
1218 <systemitem class="username">opensrf</systemitem> user
1222 <entry>/config/gateway/username</entry>
1224 <systemitem class="username">opensrf</systemitem>
1228 <entry>/config/gateway/passwd</entry>
1229 <entry><systemitem class="domainname">public.localhost</systemitem>
1231 <systemitem class="username">opensrf</systemitem> user
1235 <entry>/config/routers/router/transport/username,
1236 first entry where server == public.localhost</entry>
1238 <systemitem class="username">router</systemitem>
1242 <entry>/config/routers/router/transport/password,
1243 first entry where server == public.localhost</entry>
1244 <entry><systemitem class="domainname">public.localhost</systemitem>
1246 <systemitem class="username">router</systemitem> user
1250 <entry>/config/routers/router/transport/username,
1251 second entry where server == private.localhost</entry>
1253 <systemitem class="username">router</systemitem>
1257 <entry>/config/routers/router/transport/password,
1258 second entry where server == private.localhost</entry>
1259 <entry><systemitem class="domainname">private.localhost</systemitem>
1261 <systemitem class="username">router</systemitem> user
1269 <title>Create Configuration Files for Users Needing <command>srfsh</command></title>
1270 <para>When OpenSRF was installed in a previous step (see
1271 <xref linkend="serversideinstallation-opensrf"/> for further information),
1272 the software installation automatically created a utility named
1273 <command>srfsh</command> (surf shell). This is a command line diagnostic tool
1274 for testing and interacting with <application>OpenSRF</application> It will be used
1275 in a future step to complete and test the Evergreen installation. See
1276 <xref linkend="serversideinstallation-testing"/> for further information.</para>
1278 <step xml:id="serversideinstallation-opensrf-env">
1279 <title>Modify the OpenSRF Environment</title>
1280 <para>Modify the shell configuration file <filename>~/.bashrc</filename> for
1281 user <systemitem class="username">opensrf</systemitem> by adding a Perl environmental
1282 variable, then execute the shell configuration file to load the new variables into
1283 your current environment.</para>
1286 <emphasis>In a multi-server environment, you must add any
1287 modifications to <filename>~/.bashrc</filename> to the top of
1288 the file <emphasis>before</emphasis> the line
1289 <literal>[ -z "$PS1" ] && return </literal>.
1290 This will allow headless (scripted) logins to load the correct
1291 environment.</emphasis>
1295 <userinput>echo "export PERL5LIB=/openils/lib/perl5:\$PERL5LIB" >> ~/.bashrc</userinput>
1296 <userinput>. ~/.bashrc</userinput>
1300 <title>(OPTIONAL) Enable and Disable Language Localizations</title>
1301 <para>You can load translations such as Armenian (hy-AM), Canadian French
1302 (fr-CA), and others into the database to complete the translations available in
1303 the OPAC and Staff Client. For further information, see <xref linkend="enabling_and_disabling_localization"/>.</para>
1307 <section xml:id="serversideinstallation-starting">
1308 <title>Starting Evergreen</title>
1311 <para>As the <systemitem class="username">root</systemitem>
1312 user, start the <systemitem class="service">ejabberd</systemitem> and
1313 <systemitem class="service">memcached</systemitem> services as follows:</para>
1315 <userinput>/etc/init.d/ejabberd start</userinput>
1316 <userinput>/etc/init.d/memcached start</userinput>
1320 <para>As the <systemitem class="username">opensrf</systemitem> user,
1321 start Evergreen as follows:</para>
1323 <userinput>osrf_ctl.sh -l -a start_all</userinput>
1325 <para>The flag <option>-l</option> forces Evergreen to use
1326 <systemitem class="domainname">localhost</systemitem> (your current system)
1327 as the hostname. The flag <option>-a start_all</option> starts the other
1328 OpenSRF <systemitem class="service">router</systemitem> ,
1329 <systemitem class="service">Perl</systemitem> , and
1330 <systemitem class="service">C</systemitem> services.</para>
1333 <para>You can also start Evergreen without the
1334 <option>-l</option> flag, but the <command>osrf_ctl.sh</command>
1335 utility must know the fully qualified domain name for the system
1336 on which it will execute. That hostname was probably specified
1337 in the configuration file <filename>opensrf.xml</filename> which
1338 you configured in a previous step.</para>
1341 <para>If you receive an error message similar to
1342 <emphasis>osrf_ctl.sh: command not found</emphasis>, then your
1343 environment variable <envar>PATH</envar> does not include the
1344 directory <filename class="directory">/openils/bin</filename>.
1345 As the <systemitem class="username">opensrf</systemitem> user,
1346 edit the configuration file <filename>~/.bashrc</filename> and
1347 add the following line:
1348 <literal>export PATH=$PATH:/openils/bin</literal></para>
1351 <para>If you receive an error message similar to <emphasis>Can't
1352 locate OpenSRF/System.pm in @INC ... BEGIN failed--compilation
1353 aborted</emphasis>, then your environment variable
1354 <emphasis role="bold">PERL5LIB</emphasis> does not include the
1355 directory <filename class="directory">/openils/lib/perl5</filename>.
1356 As the <systemitem class="username">opensrf</systemitem> user,
1357 edit the configuration file <filename>~/.bashrc</filename> and
1358 add the following line:
1359 <literal>export PERL5LIB=$PERL5LIB:/openils/lib/perl5</literal></para>
1364 <para>In this step you will generate the Web files needed by the Staff Client
1365 and catalog, and calculate the proximity of locations in the Organizational Unit
1366 tree (which allows <emphasis>Holds</emphasis> to work properly). You must do
1367 this the first time you start Evergreen and after making any changes to the
1368 library hierarchy. As the <systemitem class="username">opensrf</systemitem>
1369 user, execute the following commands:</para>
1371 <userinput>cd /openils/bin</userinput>
1372 <userinput>./autogen.sh -c /openils/conf/opensrf_core.xml -u</userinput>
1373 <computeroutput>Updating Evergreen organization tree and IDL using '/openils/conf/opensrf_core.xml'</computeroutput>
1374 <computeroutput>Updating fieldmapper</computeroutput>
1378 <para>As the <systemitem class="username">root</systemitem> user, restart the
1379 Apache Web server:</para>
1381 <userinput>/etc/init.d/apache2 restart</userinput>
1384 <para>If the Apache Web server was running when you started the OpenSRF
1385 services, you might not be able to successfully log into the OPAC or
1386 Staff Client until the Apache Web server has been restarted.</para>
1391 <section xml:id="serversideinstallation-testing">
1392 <title>Testing Your Evergreen Installation</title>
1393 <para>This section describes several simple tests you can perform to verify that the Evergreen
1394 server-side software has been installed and configured properly and is running as
1396 <simplesect xml:id="serversideinstallation-testing-connections">
1397 <title>Testing Connections to Evergreen</title>
1398 <para>Once you have installed and started Evergreen, test your connection to Evergreen. Start the
1399 <command>srfsh</command> application and try logging onto the Evergreen server using the default
1400 administrator username and password. Following is sample output generated by executing
1401 <command>srfsh</command> after a successful Evergreen installation. For help with
1402 <command>srfsh</command> commands, type <userinput>help</userinput> at the prompt.
1403 Execute the following commands to test your Evergreen connection:</para>
1405 <userinput>/openils/bin/srfsh</userinput>
1406 <computeroutput>srfsh%</computeroutput>
1407 <userinput>login admin open-ils</userinput>
1408 <computeroutput>Received Data: "250bf1518c7527a03249858687714376"</computeroutput>
1409 <computeroutput>------------------------------------</computeroutput>
1410 <computeroutput>Request Completed Successfully</computeroutput>
1411 <computeroutput>Request Time in seconds: 0.045286</computeroutput>
1412 <computeroutput>------------------------------------</computeroutput>
1413 <computeroutput>Received Data: {</computeroutput>
1414 <computeroutput> "ilsevent":0,</computeroutput>
1415 <computeroutput> "textcode":"SUCCESS",</computeroutput>
1416 <computeroutput> "desc":" ",</computeroutput>
1417 <computeroutput> "pid":21616,</computeroutput>
1418 <computeroutput> "stacktrace":"oils_auth.c:304",</computeroutput>
1419 <computeroutput> "payload":{</computeroutput>
1420 <computeroutput> "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",</computeroutput>
1421 <computeroutput> "authtime":420</computeroutput>
1422 <computeroutput> }</computeroutput>
1423 <computeroutput>}</computeroutput>
1424 <computeroutput>------------------------------------</computeroutput>
1425 <computeroutput>Request Completed Successfully</computeroutput>
1426 <computeroutput>Request Time in seconds: 1.336568</computeroutput>
1427 <computeroutput>------------------------------------</computeroutput>
1429 <para>If this does not work, try the following:</para>
1432 <para>As the <systemitem class="username">opensrf</systemitem> user, run the
1433 <filename>settings-tester.pl</filename> utility to review your Evergreen
1434 installation for any system configuration problems:</para>
1436 <userinput>cd /home/opensrf</userinput>
1437 <userinput>./Evergreen-ILS-1.6.1.2/Open-ILS/src/support-scripts/settings-tester.pl</userinput>
1439 <para>If the output of <command>settings-tester.pl</command> does not help you
1440 find the problem, please do not make any significant changes to your
1441 configuration.</para>
1444 <para>Follow the steps in the troubleshooting guide in
1445 <xref linkend="troubleshooting"/>.</para>
1448 <para>If you have followed the entire set of installation steps listed here
1449 closely, you are probably extremely close to a working system. Gather your
1450 configuration files and log files and contact the
1451 <ulink url="http://open-ils.org/listserv.php">Evergreen Development Mailing List</ulink>
1452 list for assistance before making any drastic changes to your system
1453 configuration.</para>
1458 <section xml:id="serversideinstallation-postinstallation">
1459 <title>Post-Installation Chores</title>
1460 <para>There are several additional steps you may need to complete after Evergreen has been
1461 successfully installed and tested. Some steps may not be needed (e.g., setting up support for
1464 <title>Remove temporary Apache configuration changes</title>
1465 <para>You modified the Apache configuration file
1466 <filename>/etc/apache2/sites-available/eg.conf</filename> in an earlier step as a
1467 temporary measure to expedite testing (see
1468 <xref linkend="serversideinstallation-modify-apache"/> for further information).
1469 Those changes must now be reversed in order to deny unwanted access to your
1470 CGI scripts from users on other public networks.</para>
1473 <emphasis>This temporary network update was done to expedite
1474 testing. You <emphasis role="bold"> must</emphasis> correct
1475 this for a public production system.</emphasis>
1478 <para>As the <systemitem class="username">root</systemitem> user, edit the configuration
1479 file again and comment out the line <literal>Allow from all</literal> and uncomment the
1480 line <literal>Allow from 10.0.0.0/8</literal>, then change it to match your network
1481 address scheme.</para>
1483 <section xml:id="serversideinstallation-ssl">
1484 <title>Configure a permanent SSL key</title>
1485 <para>In a previous step (see <xref linkend="serversideinstallation-createsslcertificate"/>)
1486 you used the command <command>openssl</command> to temporarily
1487 create a new SSL key for the Apache server. This self-signed security certificate was adequate
1488 during testing and development, but will continue to generate warnings in the Staff Client
1489 and browser. For a public production server you should configure or purchase a signed SSL
1491 <para>There are several open source software solutions that provide schemes to generate and
1492 maintain public key security certificates for your library system. Some popular projects are
1493 listed below; please review them for background information on why you need such a system and
1494 how you can provide it:</para>
1497 <ulink url="http://www.openca.org/projects/openca/">http://www.openca.org/projects/openca/</ulink>
1500 <ulink url="http://sourceforge.net/projects/ejbca/">http://sourceforge.net/projects/ejbca/</ulink>
1503 <ulink url="http://pki.fedoraproject.org">http://pki.fedoraproject.org</ulink>
1508 <emphasis>The temporary SSL key was only created to expedite
1509 testing. You should install a proper SSL certificate for a public
1510 production system.</emphasis>
1515 <title>Set Up Support For Reports</title>
1516 <para>Evergreen reports are extremely powerful but require some simple configuration.
1517 This section describes starting and stopping the Reporter daemon processes.</para>
1520 <para>Starting the Reporter Daemon</para>
1521 <para>Once the <systemitem class="daemon">open-ils.reporter</systemitem>
1522 process is running and enabled on the gateway, you can start the
1523 Reporter daemon. That process periodically checks for requests for new
1524 or scheduled reports, then starts them as required.</para>
1525 <para>As the <systemitem class="username">opensrf</systemitem> user,
1526 start the Reporter daemon using the following command:</para>
1528 <userinput>cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/src/reporter</userinput>
1529 <userinput>./clark-kent.pl --daemon</userinput>
1531 <para>You can control how the <command>clark-kent.pl</command> utility behaves
1532 by specifying any of several command-line options:</para>
1534 <listitem><option>--sleep=interval</option> : number of seconds
1535 to sleep between checks for new reports to run; defaults to
1536 <literal>10</literal></listitem>
1537 <listitem><option>--lockfile=filename</option> : where to place
1538 the lockfile for the process; defaults to
1539 <filename>/tmp/reporter-LOCK</filename></listitem>
1540 <listitem><option>--concurrency=integer</option> : number of
1541 Reporter daemon processes to run; defaults to
1542 <literal>1</literal></listitem>
1543 <listitem><option>--bootstrap=filename</option> : OpenSRF
1544 bootstrap configuration file; defaults to
1545 <filename>/openils/conf/opensrf_core.xml</filename></listitem>
1549 <para>Stopping the Reporter Daemon</para>
1550 <para>To stop the Reporter daemon, you must kill the process and remove
1551 the lockfile. The daemon may have just a single associated process or
1552 there may be several processes if the daemon was started with the optional
1553 <literal>--concurrency</literal> switch. It will also have a lockfile
1554 in the default location.</para>
1555 <para>As the <systemitem class="username">opensrf</systemitem> user,
1556 execute the following shell commands:</para>
1558 <prompt># find and kill the process ID number(s)</prompt>
1559 <userinput>kill `ps wax | grep "Clark Kent" | grep -v grep | cut -b1-6`</userinput>
1560 <prompt># remove the lock file</prompt>
1561 <userinput>rm /tmp/reporter-LOCK</userinput>
1567 <section xml:id="serversideinstallation-virtual">
1568 <title>Installing In Virtualized <systemitem class="osname">Linux</systemitem> Environments</title>
1569 <para>This section describes the installation of Evergreen software in so-called "virtualized"
1570 software environments. Evergreen software runs as a native application on any of several
1571 well-known x86 (32-bit) and x86-64 (64-bit) <systemitem class="osname">Linux</systemitem>
1572 distributions including <systemitem class="osname">Ubuntu</systemitem> and
1573 <systemitem class="osname">Debian</systemitem> but it does not run as a native application
1574 on the <systemitem class="osname">Microsoft Windows</systemitem> operating system.
1575 However, it is possible to execute Evergreen on a <systemitem class="osname">Windows</systemitem>
1576 host system by running it within a virtual Linux-guest installation, which itself executes
1577 on the <systemitem class="osname">Windows</systemitem> system.
1578 The <systemitem class="osname">Linux</systemitem> environment is fully emulated and acts
1579 (within limits) just as if it were executing on a real standalone system.</para>
1580 <para>This technique of emulating a <systemitem class="osname">Linux</systemitem> environment on
1581 a <systemitem class="osname">Windows</systemitem> host is a practical way to install and run an
1582 Evergreen system if it is not possible to dedicate a physical machine solely as a
1583 <systemitem class="osname">Linux</systemitem> host for Evergreen. This architecture is not
1584 recommended for large scale systems since there are performance limitations to running Evergreen
1585 in a virtualized environment. However, it is a reasonable architecture for smaller experimental
1586 systems, as a proof of concept, or as a conference-room pilot.</para>
1588 <title>Installing Virtualization Software</title>
1589 <para>As described above, Evergreen can be installed on top of an emulated
1590 <systemitem class="osname">Linux</systemitem> environment. The
1591 <systemitem class="osname">Linux</systemitem> environment, in turn, is installed
1592 on top of a software application such as <application>"VirtualBox"</application>,
1593 <application>"VMware"</application> or <application>"VirtualPC"</application> which must
1594 first be installed on the <systemitem class="osname">Windows</systemitem> system. This
1595 section contains step-by-step examples that show installing popular virtualization
1596 applications on a <systemitem class="osname">Windows</systemitem> host system. Following
1597 this section are further descriptions of installing
1598 <systemitem class="osname">Linux</systemitem> and Evergreen systems using that
1599 virtualization software.</para>
1601 <title>Installing <application>"VirtualBox"</application> Virtualization Software</title>
1602 <para>This section reviews installation of the
1603 <application>"VirtualBox"</application> application on
1604 <systemitem class="osname">WindowsXP Professional (SP2)</systemitem>.
1605 Download the latest edition of <application>VirtualBox</application> from their official website:
1606 <link xl:href="http://virtualbox.org" xl:title="virtual box">http://virtualbox.org</link>
1607 and follow the on screen instructions to install the software.</para>
1610 <title>Installing VMware Virtualization Software</title>
1612 <primary>virtualization software</primary>
1613 <secondary>VMware</secondary>
1615 <para>This section reviews installation of the
1616 <application>"VMware"</application> application on
1617 <systemitem class="osname">WindowsXP Professional (SP2)</systemitem>.
1618 Find and Download the free virtual machine software of from the VMware
1620 <ulink url="http://downloads.vmware.com">http://downloads.vmware.com</ulink>
1621 and follow the on-screen instructions.</para>
1624 <simplesect xml:id="serversideinstallation-virtual-install-linux-ev">
1625 <title>Installing <systemitem class="osname">Linux</systemitem> /
1626 Evergreen on Virtualization Software</title>
1627 <para>After the virtualization software is installed and running, there are two ways to
1628 continue with installing <systemitem class="osname">Linux</systemitem> and Evergreen
1629 software in the new virtualized environment:</para>
1632 <para>Download and install a prebuilt software image that contains a
1633 working <systemitem class="osname">Linux</systemitem> / Evergreen system
1634 (see <xref linkend="serversideinstall-virtual-prebuilt"/> for
1638 <para>Manually install a <systemitem class="osname">Linux</systemitem>
1639 guest system, then manually install Evergreen on it.</para>
1642 <para>We review each method in the following sections.</para>
1643 <simplesect xml:id="serversideinstall-virtual-prebuilt">
1644 <title>Download and install a prebuilt software image</title>
1645 <para>You can download a prebuilt software image that, when installed with your
1646 virtualization software, emulates a
1647 <systemitem class="osname">Linux</systemitem> guest system containing a running
1648 Evergreen distribution. The image is essentially a snapshot of a hard disk from
1649 a fully configured, functional <systemitem class="osname">Linux</systemitem>
1650 system with Evergreen already installed.</para>
1651 <para>We recommend this approach if you wish to get Evergreen running quickly
1652 with minimal attention to configuration. After reviewing only a few
1653 configuration details you can have a working Evergreen system that integrates
1654 smoothly with the rest of your network. See
1655 <xref linkend="serversideinstall-virtual-versions"/> for a list of prebuilt
1656 software images that are currently available to download and install</para>
1657 <note>DISCLAIMER: The following virtual images have been contributed by members
1658 of the Evergreen community for the purposes of testing, evaluation, training,
1659 and development.</note>
1660 <table xml:id="serversideinstall-virtual-versions">
1661 <title>Linux / Evergreen Virtual Images</title>
1662 <tgroup align="left" cols="4" colsep="1" rowsep="1">
1663 <colspec colnum="1" colwidth="1.0*"/>
1664 <colspec colnum="2" colwidth="1.0*"/>
1665 <colspec colnum="3" colwidth="3.0*"/>
1666 <colspec colnum="4" colwidth="1.0*"/>
1669 <entry>Linux Version</entry>
1670 <entry>Evergreen Version</entry>
1671 <entry>Image</entry>
1672 <entry>Comments</entry>
1677 <entry>Debian lenny (5.0)</entry>
1678 <entry>1.6.0.1</entry>
1680 <ulink url="http://www.open-ils.org/~denials/Evergreen1601_DebianLenny.zip"> download </ulink>
1682 <entry>VirtualBox image</entry>
1685 <entry>Ubuntu karmic koala (9.10)</entry>
1686 <entry>1.6.0.0</entry>
1688 <ulink url="http://www.open-ils.org/~denials/Evergreen-1600-Karmic.zip"> download </ulink>
1690 <entry>VirtualBox image</entry>
1696 <title>VirtualBox Example</title>
1698 <primary>virtualization software</primary>
1699 <secondary>VirtualBox</secondary>
1702 <para>Start VirtualBox for the first time and select
1703 <menuchoice><guimenu>File</guimenu><guimenuitem>VirtualBox Media
1704 Manager</guimenuitem><guimenuitem>Add</guimenuitem></menuchoice>
1705 to locate the prebuilt software image just downloaded (the
1706 example shows it was extracted from the original
1707 <filename class="extension">zip</filename> file into a temporary directory
1708 <filename class="directory">C:\temp</filename>).</para>
1711 <para>After selecting the file, click <guibutton>Open</guibutton> to import it.</para>
1714 <para>Then click <guibutton>OK</guibutton> to save the selection
1715 and return to the VirtualBox Media Manager</para>
1718 <para>Click <guibutton>New</guibutton>, then <guibutton>Next</guibutton> to continue
1719 and create a new virtual machine (VM).</para>
1722 <para>Create a new name for the VM and set the operating system
1723 type, then click <guibutton>Next</guibutton>.</para>
1726 <para>Set the memory size (at least 512Mb),
1727 then click <guibutton>Next</guibutton>.</para>
1730 <para>Edit the Virtual Hard Disk configuration settings; click
1731 the radio boxes <guilabel>Boot Hard Disk</guilabel> and
1732 <guilabel>Use existing hard disk</guilabel>
1733 and ensure that the disk name <guilabel>Evergreen1601_DebianLenny.vmdk</guilabel>
1734 is selected. Click <guibutton>Finish</guibutton> to finish the
1738 <para>Install the <application>VirtualBox Guest
1739 Additions</application> (really a required upgrade to
1743 <para>Return to VirtualBox and see the summary of the VM just
1744 created. Click <guibutton>Start</guibutton> to boot the new VM.</para>
1747 <para>See the start of the <systemitem class="osname">Linux</systemitem>
1748 boot sequence. Choose <guimenuitem>Debian Gnu/Linux, kernel
1749 2.6.26-2-686</guimenuitem> from the startup menu and click
1750 <guibutton>Enter</guibutton> to start
1751 <systemitem class="osname">Linux</systemitem> and Evergreen.
1752 After some delay you should see the command line prompt
1753 <prompt>debian-lenny login:</prompt>. Log in with username
1754 <userinput>root</userinput> and password <userinput>evergreen</userinput>
projects / working / Evergreen.git / blob