<info>
<title>Server-side Installation of Evergreen Software</title>
<abstract>
- <para>This section describes installation of the Evergreen server-side software. Installation, configuration, testing and verification of the Evergreen server-side software is straightforward if you follow some simple directions. Installation of the Evergreen Staff Client software is handled in the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-staffclient"> "Installing the Evergreen Staff Client" </link></emphasis></emphasis>. </para>
+ <para>This section describes installation of the Evergreen server-side software and its associated components. Installation, configuration, testing and verification of the software is straightforward if you follow some simple directions.</para>
</abstract>
</info>
<section xml:id="serversideinstallation-overview">
<title>Overview</title>
- <para>A bare-minimum system Evergreen system requires only a single Server and a single Staff Client, both residing on a single server machine. In fact, that is a reasonable architecture for simple experiments or as a proof of concept in a conference-room pilot. But typical real-world systems will probably consist of at least one or two Evergreen servers plus multiple Staff Clients.</para>
- <para>Another simple system may require only that you install one or more instances of the Staff Client software. For instance, if your consortium already provides the Evergreen server software or if you are using the hosted version provided by Equinox, you do not need to install the Evergreen server-side software at all.</para>
- <para>Current versions of Evergreen software run as native applications on any of several well-known Linux distributions (e.g., <emphasis>Ubuntu</emphasis> and <emphasis>Debian</emphasis>). It does not currently run as a native application on the Windows operating system (e.g., WindowsXP, WindowsXP Professional, Windows7), but the software can still be installed and run on Windows via a so-called <emphasis>virtualized</emphasis> Unix-guest Operating System (using, for example, VirtualBox or VMware to emulate a Linux environment). More information on running Evergreen in virtualized environments can be found in the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-virtual">"Installing Evergreen in Virtualized Unix Environments"</link></emphasis></emphasis>.</para>
- </section>
- <section xml:id="serversideinstallation-requirements">
- <title>System Requirements</title>
- <para>This section describes various requirements of the hardware and software environment that must be fulfilled to support a successful Evergreen installation. For a description of the installation process itself and for links to further instructions please review the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-process">"The Installation Process"</link></emphasis></emphasis> .</para>
- <para>The system requirements for running Evergreen really depend on what you want to do with it. For just evaluating the software, or for a very small library (for example, 1 circulation station, a few thousand items, and infrequent online catalog use), any modern desktop or laptop made within the last few years capable of running Linux, FreeBSD, etc. should suffice. We recommend at least 512mb of RAM.</para>
- <para> [[ ADD OTHER HARDWARE AND SOFTWARE REQUIREMENTS ]] </para>
- <para>
- <screen>
- From Dan Scott on [http://list.georgialibraries.org/pipermail/
- open-ils-general/2007-July/000316.html|OPEN-ILS-GENERAL]:
- On 8/11/07, lan ye <lye at mail.slcl.org> wrote:
- > We've been researching the Evergreen Open Source Library system,
- > and would like to have a list of hardware requirements for the
- > installation of a small test server. To keep things within a
- > small budget, I would like to just use an ordinary PC. Could you
- > send some information to us?
-
- For system requirements, it depends on how extensive you want your
- tests to be. Evergreen and all of the pieces it depends on
- (PostgreSQL, Apache, Ejabberd) run happily in a VMWare image
- allocated 512MB of RAM on my laptop with just the Project
- Gutenberg e-books loaded, and that's enough to evaluate the OPAC
- interface / try out the staff client / make some local changes and
- generally experiment. But I'm not going to load one million bib
- records into that system and expect it to perform. So, probably
- any hardware you have lying around would be adequate for a small
- test server.
-
- > It looks like Evergreen has been successfully installed on two
- > Linux systems: Gentoo and Ubuntu. Which one is the best for us
- > to test using what's already in place at other libraries? Are
- > there any differences / Advantages in functionality between
- > Gentoo and Ubuntu?
-
- As John said, GPLS is running on Debian, and that's the only
- Evergreen system that is in production at the moment. However, the
- documentation for installing on Debian is a bit scattered right
- now. The developers themselves used Gentoo originally, and that's
- what I'm using at the moment & have documented in the wiki;
- the install process on Ubuntu is very thoroughly documented and
- Ubuntu is reasonably close to Debian.
- See http://open-ils.org/dokuwiki/doku.php?id=server_installation
- for the list of install instructions for various distributions.
-
- As for advantages / disadvantages of particular distributions,
- that's a religious war that I don't want to step into... We'll try
- to help you out no matter what distribution you choose; just
- please choose a current release :)
-
- --
- Dan Scott
- Laurentian University
- </screen>
- <screen>
- And from James Fournie in that same [http://list.georgialibraries.org/
- pipermail/open-ils-general/2007-July/000317.html|thread]:
- We are running a test Ubuntu server on a ~1ghz Celeron PC with
- 512mb RAM. It seems to be ok handling the Gutenberg samples, and
- our collection of about 8000 records. We did have serious problems
- using anything less than 512mb RAM. Also, I tried Evergreen on a
- K6 II 350, but it wasn't pretty.
-
- James Fournie
- Digitization Librarian
- Union of B.C. Indian Chiefs
- </screen>
+ <para>Installing, configuring and testing the Evergreen server-side software is straightforward with the current stable software release. See the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-ubuntudebian"> "Installing Evergreen On Ubuntu or Debian" </link></emphasis></emphasis> for instructions tailored to installing on some particular distributions of the Linux operating system. Earlier software distributions are described in the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-previousversions"> "Installing Previous Versions of Evergreen" </link></emphasis></emphasis>.</para>
+ <para>Current versions of the Evergreen server-side software run as native applications on any of several well-known Linux distributions (e.g., <emphasis>Ubuntu</emphasis> and <emphasis>Debian</emphasis>). It does not currently run as a native application on the Windows operating system (e.g., WindowsXP, WindowsXP Professional, Windows7), but the software can still be installed and run on Windows via a so-called <emphasis>virtualized</emphasis> Unix-guest Operating System (using, for example, VirtualBox, or VMware, or VirtualPC to emulate a Linux environment). It can also be installed and run on other Linux systems via virtualized environments (using, for example, VirtualBox or VMware). More information on virtualized environments can be found in the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-virtual">"Installing Evergreen in Virtualized Unix Environments"</link></emphasis></emphasis>.</para>
+ <para>Installation of some sub-components of the Evergreen server-side software is mentioned only in abbreviated form in this section. More detailed information is available in the accompanying sections:
+<emphasis><emphasis role="bold"><link linkend="serversideinstallation-opensrf"> "OpenSRF" </link></emphasis></emphasis>,
+<emphasis><emphasis role="bold"><link linkend="serversideinstallation-postgresql"> "PostgreSQL Database" </link></emphasis></emphasis>,
+<emphasis><emphasis role="bold"><link linkend="serversideinstallation-apache"> "Apache" </link></emphasis></emphasis> and
+<emphasis><emphasis role="bold"><link linkend="serversideinstallation-memcached"> "memcached Servers" </link></emphasis></emphasis>.
</para>
- </section>
- <section xml:id="serversideinstallation-examples">
- <title>Example System Architectures</title>
- <para>This sections describes examples of some working Evergreen system architectures, including both server-side software and Staff Client software.</para>
- <section xml:id="serversideinstallation-example-pines">
- <title>PINES</title>
- <para>In order to provide load balancing and high-availability at the OPAC and Staff Client level, PINES has implemented a Linux Virtual Server environment with five independent mini-clusters. This allows live updates of the entire system with no perceived downtime or interruption in service.</para>
- <para>[[ ADD FURTHER INFORMATION ON PINES ]] </para>
- </section>
- <section xml:id="serversideinstallation-example-sitka">
- <title>Sitka</title>
- <para>[[ ADD FURTHER INFORMATION ON SITKA ]] </para>
- </section>
- <section xml:id="serversideinstallation-example-other">
- <title>Other working systems</title>
- <para>[[ ADD FURTHER INFORMATION ON OTHER WORKING SYSTEMS ]] </para>
- </section>
- </section>
- <section xml:id="serversideinstallation-process">
- <title>The Installation Process</title>
- <para>Installing, configuring and testing the Evergreen server-side software is straightforward with the current stable software release. Earlier software distributions are also available. In the following sections you will find instructions tailored to specific distributions.</para>
+ <para>Installation of the Evergreen Staff Client software is handled in the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-staffclient"> "Installing the Evergreen Staff Client" </link></emphasis></emphasis>. </para>
<section>
<title>Current Stable Software Release</title>
<para>The current stable release of Evergreen is version <emphasis><emphasis role="bold">1.6.0.7</emphasis></emphasis>. Instructions for installing, configuring and testing that version on the <emphasis>Ubuntu</emphasis> or <emphasis>Debian</emphasis> Linux systems are found in the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-ubuntudebian"> "Installing Evergreen on Ubuntu or Debian" </link></emphasis></emphasis> .
</section>
<section>
<title>Previous Software Releases</title>
- <para>Earlier releases of Evergreen are also available. Instructions for installing, configuring and testing earlier versions are found in the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-previousversions">Installing Previous Versions of Evergreen</link></emphasis></emphasis> .</para>
- <para>The next most recent previous release of Evergreen is version <emphasis><emphasis role="bold">1.4.0.6</emphasis></emphasis>. Instructions for installing, configuring and testing that version are found in the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-ubuntudebian-previous">Installing Evergreen 1.4.0.6 on Ubuntu or Debian</link></emphasis></emphasis> .
+ <para>Earlier releases of Evergreen are also available. Instructions for installing, configuring and testing earlier versions are found in the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-previousversions"> "Installing Previous Versions of Evergreen" </link></emphasis></emphasis> .</para>
+ <para>The next most recent previous release of Evergreen is version <emphasis><emphasis role="bold">1.4.0.6</emphasis></emphasis>. Instructions for installing, configuring and testing that version are found in the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-ubuntudebian-previous"> "Installing Evergreen 1.4.0.6 on Ubuntu or Debian" </link></emphasis></emphasis> .
</para>
- <para>The accompanying previous release of OpenSRF is version <emphasis><emphasis role="bold">1.0.x</emphasis></emphasis>. Instructions for installing, configuring and testing that version are found in the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-opensrf-previous">Installing OpenSRF 1.0.x</link></emphasis></emphasis> .
+ <para>The accompanying previous release of OpenSRF is version <emphasis><emphasis role="bold">1.0.x</emphasis></emphasis>. Instructions for installing, configuring and testing that version are found in the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-opensrf-previous"> "Installing OpenSRF 1.0.x" </link></emphasis></emphasis> .
</para>
</section>
+ <section>
+ <title>System Requirements</title>
+ <para>This section describes various requirements of the hardware and software environment that must be fulfilled to support a successful Evergreen installation. The system requirements for running Evergreen really depend on what you want to do with it. For just evaluating the software, or for a very small library (for example, 1 circulation station, a few thousand items, and infrequent online catalog use), any modern desktop or laptop made within the last few years capable of running Linux, FreeBSD, etc. should suffice. We recommend at least 512mb of RAM.</para>
+ <para> [[ ADD FURTHER CONTENT ON HARDWARE AND SOFTWARE REQUIREMENTS ]] </para>
+ <para>
+ <screen>
+ From Dan Scott on [http://list.georgialibraries.org/pipermail/
+ open-ils-general/2007-July/000316.html|OPEN-ILS-GENERAL]:
+ On 8/11/07, lan ye <lye at mail.slcl.org> wrote:
+ > We've been researching the Evergreen Open Source Library system,
+ > and would like to have a list of hardware requirements for the
+ > installation of a small test server. To keep things within a
+ > small budget, I would like to just use an ordinary PC. Could you
+ > send some information to us?
+
+ For system requirements, it depends on how extensive you want your
+ tests to be. Evergreen and all of the pieces it depends on
+ (PostgreSQL, Apache, Ejabberd) run happily in a VMWare image
+ allocated 512MB of RAM on my laptop with just the Project
+ Gutenberg e-books loaded, and that's enough to evaluate the OPAC
+ interface / try out the staff client / make some local changes and
+ generally experiment. But I'm not going to load one million bib
+ records into that system and expect it to perform. So, probably
+ any hardware you have lying around would be adequate for a small
+ test server.
+
+ > It looks like Evergreen has been successfully installed on two
+ > Linux systems: Gentoo and Ubuntu. Which one is the best for us
+ > to test using what's already in place at other libraries? Are
+ > there any differences / Advantages in functionality between
+ > Gentoo and Ubuntu?
+
+ As John said, GPLS is running on Debian, and that's the only
+ Evergreen system that is in production at the moment. However, the
+ documentation for installing on Debian is a bit scattered right
+ now. The developers themselves used Gentoo originally, and that's
+ what I'm using at the moment & have documented in the wiki;
+ the install process on Ubuntu is very thoroughly documented and
+ Ubuntu is reasonably close to Debian.
+ See http://open-ils.org/dokuwiki/doku.php?id=server_installation
+ for the list of install instructions for various distributions.
+
+ As for advantages / disadvantages of particular distributions,
+ that's a religious war that I don't want to step into... We'll try
+ to help you out no matter what distribution you choose; just
+ please choose a current release :)
+
+ --
+ Dan Scott
+ Laurentian University
+ </screen>
+ <screen>
+ And from James Fournie in that same [http://list.georgialibraries.org/
+ pipermail/open-ils-general/2007-July/000317.html|thread]:
+ We are running a test Ubuntu server on a ~1ghz Celeron PC with
+ 512mb RAM. It seems to be ok handling the Gutenberg samples, and
+ our collection of about 8000 records. We did have serious problems
+ using anything less than 512mb RAM. Also, I tried Evergreen on a
+ K6 II 350, but it wasn't pretty.
+
+ James Fournie
+ Digitization Librarian
+ Union of B.C. Indian Chiefs
+ </screen>
+ </para>
+ </section>
+ <section>
+ <title>Example System Architectures</title>
+ <para>This sections describes examples of some working Evergreen system architectures, including both server-side software and Staff Client software.</para>
+ <para>A bare-minimum system Evergreen system requires only a single Server and a single Staff Client, both residing on a single server machine. In fact, that is a reasonable architecture for simple experiments or as a proof of concept in a conference-room pilot. But typical real-world systems will probably consist of at least one or two Evergreen servers plus multiple Staff Clients.</para>
+ <para>Another simple system may require only that you install one or more instances of the Staff Client software. For instance, if your consortium already provides the Evergreen server software or if you are using the hosted version provided by Equinox, you do not need to install the Evergreen server-side software at all.</para>
+ <section xml:id="serversideinstallation-example-pines">
+ <title>PINES</title>
+ <para>In order to provide load balancing and high-availability at the OPAC and Staff Client level, PINES has implemented a Linux Virtual Server environment with five independent mini-clusters. This allows live updates of the entire system with no perceived downtime or interruption in service.</para>
+ <para>[[ ADD FURTHER INFORMATION ON PINES ]] </para>
+ </section>
+ <section xml:id="serversideinstallation-example-sitka">
+ <title>Sitka</title>
+ <para>[[ ADD FURTHER INFORMATION ON SITKA ]] </para>
+ </section>
+ <section xml:id="serversideinstallation-example-other">
+ <title>Other working systems</title>
+ <para>[[ ADD FURTHER INFORMATION ON OTHER WORKING SYSTEMS ]] </para>
+ </section>
+ </section>
</section>
<section xml:id="serversideinstallation-ubuntudebian">
<title>Installing Evergreen On Ubuntu or Debian</title>
<para>This section outlines the installation process for the latest stable version of Evergreen (1.6.0.7).</para>
+ <para>In this section you will download, unpack, install, configure and test the Evergreen system, including the Evergreen server and the PostgreSQL database system. You will make several configuration changes and adjustments to the software, including updates to configure the system for your own locale, and some updates needed to work around a few known issues.</para>
+ <para>As far as possible, perform the following steps in the order they are given since the success of many steps relies on the successful completion of earlier steps. You should make backup copies of files and environments when you are instructed to do so. In the event of installation problems those copies can allow you to back out of a step gracefully and resume the installation from a known state.</para>
+ <para>Of course, after you successfully complete and test the entire Evergreen installation you should take a final snapshot backup of your system(s). This can be the first in the series of regularly scheduled system backups that you should probably also begin.</para>
<para/>
- <para>The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) architectures. There may be differences between the Desktop and Server editions of Ubuntu. These instructions assume the Server edition.</para>
- <para>In the following instructions, you are asked to perform certain steps as either the <emphasis role="bold">root</emphasis> user, the <emphasis role="bold">opensrf</emphasis> user, or the <emphasis role="bold">postgres</emphasis> user.</para>
- <para>To become the <emphasis role="bold">root</emphasis> user, issue the command: <emphasis><emphasis role="bold">su - root</emphasis></emphasis>. To switch from the <emphasis role="bold">root</emphasis> user to a different user, issue a command like: <emphasis><emphasis role="bold">su - USERNAME</emphasis></emphasis>. For example, to switch from the <emphasis role="bold">root</emphasis> user to the <emphasis role="bold">opensrf</emphasis> user, issue this command: <emphasis><emphasis role="bold">su - opensrf</emphasis></emphasis>. Once you have become a non-root user, to become the <emphasis role="bold">root</emphasis> user again, simply issue the <emphasis><emphasis role="bold">exit</emphasis></emphasis> command.</para>
+ <note>
+ <para>The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) architectures. There may be differences between the Desktop and Server editions of Ubuntu. These instructions assume the Server edition.</para>
+ <para>In the following instructions, you are asked to perform certain steps as either the <emphasis role="bold">root</emphasis> user, the <emphasis role="bold">opensrf</emphasis> user, or the <emphasis role="bold">postgres</emphasis> user.</para>
+ <para>To become the <emphasis role="bold">root</emphasis> user, issue the command: <emphasis><emphasis role="bold">su - root</emphasis></emphasis>. To switch from the <emphasis role="bold">root</emphasis> user to a different user, issue a command like: <emphasis><emphasis role="bold">su - USERNAME</emphasis></emphasis>. For example, to switch from the <emphasis role="bold">root</emphasis> user to the <emphasis role="bold">opensrf</emphasis> user, issue this command: <emphasis><emphasis role="bold">su - opensrf</emphasis></emphasis>. Once you have become a non-root user, to become the <emphasis role="bold">root</emphasis> user again, simply issue the <emphasis><emphasis role="bold">exit</emphasis></emphasis> command.</para>
+ </note>
+ <section xml:id="serversideinstallation-opensrf-overview">
+ <title>Installing OpenSRF</title>
+ <para>Evergreen software is integrated with and depends on the Open Service Request Framework (OpenSRF) software system. For further information on installing, configuring and testing OpenSRF, see the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-opensrf"> "Installing OpenSRF" </link></emphasis></emphasis>.</para>
+ <para>Follow the steps outlined in that section and run the specified tests to ensure that OpenSRF is properly installed and configured. Do not continue with any further Evergreen installation steps until you have verified that OpenSRF has been successfully installed.</para>
+ </section>
<section>
- <title>Downloading and Building Evergreen </title>
- <para>In this section you will download, unpack, install, configure and test the Evergreen system, including the Evergreen server and the PostgreSQL database system. You will make several configuration changes and adjustments to the software, including updates to configure the system for your own locale, and some updates needed to work around a few known issues.</para>
- <para>As far as possible, perform the following steps in the order they are given, since the success of many steps relies on the successful completion of earlier steps. You should make backup copies of files and environments when you are instructed to do so. In the event of installation problems those copies can allow you to back out of a step gracefully and resume the installation from a known state.</para>
- <para>Of course, after you successfully complete and test the entire Evergreen installation you should take a final snapshot backup of your system(s). This can be the first in the series of regularly scheduled system backups that you should probably also begin.</para>
- <section>
- <title>Installing OpenSRF</title>
- <para>Evergreen software is integrated with and depends on the Open Service Request Framework (OpenSRF) software system. For further information on installing, configuring and testing OpenSRF, see the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-opensrf"> "Installing OpenSRF" </link></emphasis></emphasis>.</para>
- <para>Follow the steps outlined in that section and run the specified tests to ensure that OpenSRF is properly installed and configured. Do not continue with any further Evergreen installation steps until you have verified that OpenSRF has been successfully installed.</para>
- </section>
- <section>
- <title>Download and Unpack Latest Evergreen Version</title>
- <para>As the <emphasis role="bold">opensrf</emphasis> user, download and extract the latest version of Evergreen. The latest version can be found here: <emphasis><emphasis role="bold"><ulink url="http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.0.7.tar.gz"></ulink></emphasis></emphasis></para>
- <para>[[ VERIFY LOCATION OF LATEST VERSION OF EVERGREEN ]]</para>
- <figure>
- <title>Commands to download/extract Evergreen</title>
- <screen>
- $ su - opensrf
- $ wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.0.7.tar.gz
- $ tar zxf Evergreen-ILS-1.6.0.7.tar.gz
- </screen>
- </figure>
- </section>
- <section>
- <title>Install Prerequisites to Build Evergreen</title>
- <para>In this step you will install and configure a set of prerequisites used to build the Evergreen server-side software. In a following step you will actually build the software.</para>
- <para>As the <emphasis role="bold">root</emphasis> user, enter the commands show below to build the prerequisites from the software distribution that you just downloaded and unpacked. Remember to replace <emphasis>[distribution]</emphasis> in the following example with the keyword that corresponds to the actual Linux distribution listed here:</para>
- <itemizedlist>
- <listitem><emphasis>debian-lenny</emphasis> for Debian Lenny (5.0), the most recent version</listitem>
- <listitem><emphasis>debian-etch</emphasis> for Debian Etch (4.0)</listitem>
- <para/>
- <listitem><emphasis>ubuntu-karmic</emphasis> for Ubuntu Lucid (10.04) [same as for Karmic]</listitem>
- <listitem><emphasis>ubuntu-karmic</emphasis> for Ubuntu Karmic (9.10)</listitem>
- <listitem><emphasis>ubuntu-intrepid</emphasis> for Ubuntu Intrepid (8.10)</listitem>
- <listitem><emphasis>ubuntu-hardy</emphasis> for Ubuntu Hardy (8.04)</listitem>
- <listitem><emphasis>ubuntu-gutsy</emphasis> for Ubuntu Gutsy (7.10)</listitem>
- <para/>
- <listitem><emphasis>gentoo</emphasis> generic for Gentoo versions</listitem>
- <listitem><emphasis>centos</emphasis> generic for Centos versions</listitem>
- <para/>
- <listitem>[[ ADD INFO FOR OTHER LINUX DISTRIBUTIONS ]]</listitem>
- </itemizedlist>
- <figure>
- <title>Commands to install prerequisites for Evergreen</title>
- <screen>
- $ su - root
- $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
- $ make -f Open-ILS/src/extras/Makefile.install [distribution]
- </screen>
- </figure>
- </section>
- <section>
- <title>(OPTIONAL) Install the PostgreSQL Server</title>
- <para>Since the PostgreSQL server is usually a standalone server in multi-server production systems, the prerequisite installer Makefile in the previous step does not automatically install PostgreSQL. If your PostgreSQL server is on a different system, just skip this step.</para>
- <para>For further information on installing PostgreSQL, see the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-postgresql"> "Installing PostgreSQL" </link></emphasis></emphasis>.</para>
- <para>If your PostgreSQL server will be on the same system as your Evergreen software, then as the <emphasis role="bold">root</emphasis> user install the required PostgreSQL server packages:</para>
- <figure>
- <title>Commands to install the PostgreSQL server</title>
- <screen>
- $ su - root
+ <title>Download and Unpack Latest Evergreen Version</title>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, download and extract the latest version of Evergreen. The latest version can be found here: <emphasis><emphasis role="bold"><ulink url="http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.0.7.tar.gz"></ulink></emphasis></emphasis></para>
+ <para>[[ VERIFY LOCATION OF LATEST VERSION OF EVERGREEN ]]</para>
+ <figure>
+ <title>Commands to download/extract Evergreen</title>
+ <screen>
+ $ su - opensrf
+ $ wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.0.7.tar.gz
+ $ tar zxf Evergreen-ILS-1.6.0.7.tar.gz
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>Install Prerequisites to Build Evergreen</title>
+ <para>In this step you will install and configure a set of prerequisites used to build the Evergreen server-side software. In a following step you will actually build the software using the <emphasis>make</emphasis> utility.</para>
+ <para>As the <emphasis role="bold">root</emphasis> user, enter the commands show below in <emphasis> Figure 1.3</emphasis> to build the prerequisites from the software distribution that you just downloaded and unpacked. Remember to replace <emphasis>[distribution]</emphasis> in the example with the keyword corresponding to the actual Linux distribution listed here:
+ <figure><title>Keywords used with "make"</title><screen>
+ debian-lenny for Debian Lenny (5.0), the most recent version
+ debian-etch for Debian Etch (4.0)
- # Debian Lenny and Ubuntu Hardy (8.04)
- $ make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_83
+ ubuntu-karmic for Ubuntu Lucid (10.04) [same as for Karmic]
+ ubuntu-karmic for Ubuntu Karmic (9.10)
+ ubuntu-intrepid for Ubuntu Intrepid (8.10)
+ ubuntu-hardy for Ubuntu Hardy (8.04)
+ ubuntu-gutsy for Ubuntu Gutsy (7.10)
- # Ubuntu Karmic (9.10) and Ubuntu Lucid (10.04)
- $ make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_84
- </screen>
- </figure>
- <note>
- <para>
- <emphasis>PostgreSQL 8.1 is deprecated and will become unsupported in a future release, though existing installations upgrading from Evergreen 1.4 or before will work fine. However, consider upgrading your Postgres soon!</emphasis>
- </para>
- </note>
- <para>[[ VERIFY: IS THIS STILL TRUE? ]]</para>
- <para>[[ ADD INFO ON HOW TO DETERMINE WHICH VERSION OF POSTGRESQL YOU HAVE ]]</para>
- </section>
- <section>
- <title>(OPTIONAL) Install Perl Modules on PostgreSQL Server</title>
- <para>If PostgreSQL is running on the same system as your Evergreen software, then the Perl modules will automatically be available. Just skip this step.</para>
- <para>Otherwise, if your PostgreSQL server is running on another system, then as the <emphasis role="bold">root</emphasis> user install the following Perl modules on that system:</para>
- <figure>
- <title>Commands to install Perl modules</title>
- <screen>
- # ensure the gcc compiler is installed
- $ su - root
- $ aptitude install gcc
+ gentoo generic for Gentoo versions
+ centos generic for Centos versions
- # install the Perl modules
- $ perl -MCPAN -e shell
- cpan> install JSON::XS
- cpan> install MARC::Record
- cpan> install MARC::File::XML
- </screen>
- </figure>
- <para>[[ ADD INFO ON HOW TO INSTALL THE PERL MODULES ]]</para>
- <para>[[ ADD INFO ON HOW TO VERIFY THAT THE PERL MODULES ARE INSTALLED ]]</para>
- </section>
- <section>
- <title>Add Additional Library Paths on Evergreen System</title>
- <para>As the <emphasis role="bold">root</emphasis> user, you must update the system dynamic library path to ensure the system will recognize the newly installed libraries. Do this by creating a new file named <emphasis role="bold">/etc/ld.so.conf.d/eg.conf</emphasis> containing the two paths, then run the command <emphasis role="bold">ldconfig</emphasis> to automatically read the file and modify the dynamic library path:</para>
- <figure>
- <title>Commands to modify system dynamic library path</title>
- <screen>
- $ su - root
- $ cat > /etc/ld.so.conf.d/eg.conf << ENDOFFILE
- /usr/local/lib
- /usr/local/lib/dbd
- ENDOFFILE
- $ ldconfig
- </screen>
- </figure>
- </section>
- <section>
- <title>(OPTIONAL) Restart the PostgreSQL Service</title>
- <para>If PostgreSQL is running on the same system as the rest of Evergreen, as the <emphasis role="bold">root</emphasis> user you must restart the PostgreSQL service to avoid a problem where the library <emphasis role="bold">plperl.so</emphasis> cannot be found. If your PostgreSQL server is running on another system, just skip this step.</para>
- <para>[[ ADD INFO ON OTHER VERSIONS OF POSTGRESQL ]]</para>
- <figure>
- <title>Commands to restart PostgreSQL service</title>
- <screen>
- $ su - root
- $ /etc/init.d/postgresql-8.3 restart
- </screen>
- </figure>
- </section>
- <section>
- <title>Configure and Compile Evergreen Sources</title>
- <para>As the <emphasis role="bold">opensrf</emphasis> user, configure and compile the software from the prerequisites that were set up in previous steps:</para>
- <figure>
- <title>Commands to configure and compile Evergreen</title>
- <screen>
- $ su - opensrf
- $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
- $ ./configure --prefix=/openils --sysconfdir=/openils/conf
- $ make
- </screen>
- </figure>
- </section>
- <section>
- <title>Link and Install Evergreen</title>
- <para>As the <emphasis role="bold">root</emphasis> user, link and install the compiled code. In the commands below, remember to set the variable <emphasis role="bold"> STAFF_CLIENT_BUILD_ID </emphasis> to match the version of the Staff Client you will use to connect to the Evergreen server. Finally, create a symbolic link named <emphasis role="bold">server</emphasis> in <emphasis role="bold">/openils/var/web/xul</emphasis> to the <emphasis role="bold">/server</emphasis> subdirectory of your Staff Client build:</para>
- <figure>
- <title>Commands to link and install Evergreen</title>
- <screen>
- $ su - root
- $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
- $ make STAFF_CLIENT_BUILD_ID=rel_1_6_0_6 install
- $ cd /openils/var/web/xul
- $ ln -sf rel_1_6_0_7/server server
- </screen>
- </figure>
- </section>
- <section>
- <title>Copy the OpenSRF Configuration Files</title>
- <para>As the <emphasis role="bold">root</emphasis> user, copy the example OpenSRF configuration files into place. This will replace the OpenSRF configuration files that you set up while installing and testing OpenSRF. You should also create backup copies of the old files for troubleshooting purposes. Finally, change the ownership on the installed files to the user <emphasis role="bold">opensrf</emphasis>:</para>
- <figure>
- <title>Commands to copy OpenSRF configuration files</title>
- <screen>
- $ su - root
- $ cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
- $ cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
- $ cp /openils/conf/oils_web.xml.example /openils/conf/oils_web.xml
- $ chown -R opensrf:opensrf /openils/
- </screen>
- </figure>
- </section>
- <section>
- <title>Create and configure PostgreSQL Database</title>
- <para>As the <emphasis role="bold">postgres</emphasis> user on your PostgreSQL server, create the Evergreen database.</para>
- <para>Remember to adjust the path for the <emphasis role="bold">contrib</emphasis> repository to match your PostgreSQL server layout. For example, if you built PostgreSQL from source following the cheat sheet, the contrib directory will be located here: <emphasis role="bold">/usr/local/share/contrib</emphasis> . If you installed the PostgreSQL 8.3 server packages on Ubuntu 8.04, the directory will be located here: <emphasis role="bold">/usr/share/postgresql/8.3/contrib/</emphasis> .</para>
- <orderedlist>
- <listitem>
- <para>
- <emphasis role="bold">Create and configure the database</emphasis>
- </para>
- <para>As the <emphasis role="bold">postgres</emphasis> user on the PostgreSQL system create the PostgreSQL database, then set some internal paths:</para>
- <figure>
- <title>Commands to create database and adjust the path</title>
- <screen>
- # create the database
- $ su - postgres
- $ createdb -E UNICODE evergreen
- $ createlang plperl evergreen
- $ createlang plperlu evergreen
- $ createlang plpgsql evergreen
-
- # adjust the paths
- $ psql -f /usr/share/postgresql/8.3/contrib/tablefunc.sql evergreen
- $ psql -f /usr/share/postgresql/8.3/contrib/tsearch2.sql evergreen
- $ psql -f /usr/share/postgresql/8.3/contrib/pgxml.sql evergreen
- </screen>
- </figure>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Create new Evergreen superuser</emphasis> </para>
- <para>As the <emphasis role="bold">postgres</emphasis> user on the PostgreSQL system, create the new user <emphasis role="bold"> evergreen </emphasis>:</para>
- <figure>
- <title>Commands to create the 'evergreen' user</title>
- <screen>
- # create superuser 'evergreen' and set the password
- $ su - postgres
- $ createuser -P -s evergreen
- Enter password for new role: mynewpassword
- Enter it again: mynewpassword
- </screen>
- </figure>
- </listitem>
- </orderedlist>
- </section>
- <section>
- <title>Create Database Schema</title>
- <para>As the <emphasis role="bold">root</emphasis> user, create the database schema and configure your system with the corresponding database authentication details for the database user 'evergreen' that you created in the previous step.</para>
- <para>Enter the commands and replace <emphasis>[HOSTNAME], [PORT], [USER], [PASSWORD]</emphasis> and <emphasis>[DATABASENAME]</emphasis> with appropriate values.</para>
- <para>On most systems <emphasis>[HOSTNAME]</emphasis> will be <emphasis role="bold">localhost</emphasis>, and <emphasis>[PORT]</emphasis> will be <emphasis role="bold">5432</emphasis>.</para>
- <figure>
- <title>Commands to create Evergreen database schema</title>
- <screen>
- $ su - root
- $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
- $ perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \
- --service all --create-schema --create-bootstrap --create-offline \
- --hostname [HOSTNAME] --port [PORT] \
- --user [USER] --password [PASSWORD] --database [DATABASENAME]
- </screen>
- </figure>
- <note>
+ [[ ADD INFO FOR OTHER LINUX DISTRIBUTIONS ]]
+ </screen></figure></para>
+ <figure>
+ <title>Commands to install prerequisites for Evergreen</title>
+ <screen>
+ $ su - root
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
+ $ make -f Open-ILS/src/extras/Makefile.install [distribution]
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>(OPTIONAL) Install the PostgreSQL Server</title>
+ <para>Since the PostgreSQL server is usually a standalone server in multi-server production systems, the prerequisite installer Makefile in the previous step does not automatically install PostgreSQL. If your PostgreSQL server is on a different system, just skip this step.</para>
+ <para>For further information on installing PostgreSQL, see the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-postgresql"> "Installing PostgreSQL" </link></emphasis></emphasis>.</para>
+ <para>If your PostgreSQL server will be on the same system as your Evergreen software, then as the <emphasis role="bold">root</emphasis> user install the required PostgreSQL server packages:</para>
+ <figure>
+ <title>Commands to install the PostgreSQL server</title>
+ <screen>
+ $ su - root
+
+ # Debian Lenny and Ubuntu Hardy (8.04)
+ $ make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_83
+
+ # Ubuntu Karmic (9.10) and Ubuntu Lucid (10.04)
+ $ make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_84
+ </screen>
+ </figure>
+ <note>
+ <para>
+ <emphasis>PostgreSQL 8.1 is deprecated and will become unsupported in a future release, though existing installations upgrading from Evergreen 1.4 or before will work fine. However, consider upgrading your Postgres soon!</emphasis>
+ </para>
+ </note>
+ <para>[[ VERIFY: IS THIS STILL TRUE? ]]</para>
+ <para>[[ ADD INFO ON HOW TO DETERMINE WHICH VERSION OF POSTGRESQL YOU HAVE ]]</para>
+ </section>
+ <section>
+ <title>(OPTIONAL) Install Perl Modules on PostgreSQL Server</title>
+ <para>If PostgreSQL is running on the same system as your Evergreen software, then the Perl modules will automatically be available. Just skip this step.</para>
+ <para>Otherwise, if your PostgreSQL server is running on another system, then as the <emphasis role="bold">root</emphasis> user install the following Perl modules on that system:</para>
+ <figure>
+ <title>Commands to install Perl modules</title>
+ <screen>
+ # ensure the gcc compiler is installed
+ $ su - root
+ $ aptitude install gcc
+
+ # install the Perl modules
+ $ perl -MCPAN -e shell
+ cpan> install JSON::XS
+ cpan> install MARC::Record
+ cpan> install MARC::File::XML
+ </screen>
+ </figure>
+ <para>[[ ADD INFO ON HOW TO INSTALL THE PERL MODULES ]]</para>
+ <para>[[ ADD INFO ON HOW TO VERIFY THAT THE PERL MODULES ARE INSTALLED ]]</para>
+ </section>
+ <section>
+ <title>Add Additional Library Paths on Evergreen System</title>
+ <para>As the <emphasis role="bold">root</emphasis> user, you must update the system dynamic library path to ensure the system will recognize the newly installed libraries. Do this by creating a new file named <emphasis role="bold">/etc/ld.so.conf.d/eg.conf</emphasis> containing the two paths, then run the command <emphasis role="bold">ldconfig</emphasis> to automatically read the file and modify the dynamic library path:</para>
+ <figure>
+ <title>Commands to modify system dynamic library path</title>
+ <screen>
+ $ su - root
+ $ cat > /etc/ld.so.conf.d/eg.conf << ENDOFFILE
+ /usr/local/lib
+ /usr/local/lib/dbd
+ ENDOFFILE
+ $ ldconfig
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>(OPTIONAL) Restart the PostgreSQL Service</title>
+ <para>If PostgreSQL is running on the same system as the rest of Evergreen, as the <emphasis role="bold">root</emphasis> user you must restart the PostgreSQL service to avoid a problem where the library <emphasis role="bold">plperl.so</emphasis> cannot be found. If your PostgreSQL server is running on another system, just skip this step.</para>
+ <para>[[ ADD INFO ON OTHER VERSIONS OF POSTGRESQL ]]</para>
+ <figure>
+ <title>Commands to restart PostgreSQL service</title>
+ <screen>
+ $ su - root
+ $ /etc/init.d/postgresql-8.3 restart
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>Configure and Compile Evergreen Sources</title>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, configure and compile the software from the prerequisites that were set up in previous steps:</para>
+ <figure>
+ <title>Commands to configure and compile Evergreen</title>
+ <screen>
+ $ su - opensrf
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
+ $ ./configure --prefix=/openils --sysconfdir=/openils/conf
+ $ make
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>Link and Install Evergreen</title>
+ <para>As the <emphasis role="bold">root</emphasis> user, link and install the compiled code. In the commands below, remember to set the variable <emphasis role="bold"> STAFF_CLIENT_BUILD_ID </emphasis> to match the version of the Staff Client you will use to connect to the Evergreen server. Finally, create a symbolic link named <emphasis role="bold">server</emphasis> in <emphasis role="bold">/openils/var/web/xul</emphasis> to the <emphasis role="bold">/server</emphasis> subdirectory of your Staff Client build:</para>
+ <figure>
+ <title>Commands to link and install Evergreen</title>
+ <screen>
+ $ su - root
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
+ $ make STAFF_CLIENT_BUILD_ID=rel_1_6_0_6 install
+ $ cd /openils/var/web/xul
+ $ ln -sf rel_1_6_0_7/server server
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>Copy the OpenSRF Configuration Files</title>
+ <para>As the <emphasis role="bold">root</emphasis> user, copy the example OpenSRF configuration files into place. This will replace the OpenSRF configuration files that you set up while installing and testing OpenSRF. You should also create backup copies of the old files for troubleshooting purposes. Finally, change the ownership on the installed files to the user <emphasis role="bold">opensrf</emphasis>:</para>
+ <figure>
+ <title>Commands to copy OpenSRF configuration files</title>
+ <screen>
+ $ su - root
+ $ cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
+ $ cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
+ $ cp /openils/conf/oils_web.xml.example /openils/conf/oils_web.xml
+ $ chown -R opensrf:opensrf /openils/
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>Create and configure PostgreSQL Database</title>
+ <para>As the <emphasis role="bold">postgres</emphasis> user on your PostgreSQL server, create the Evergreen database.</para>
+ <para>Remember to adjust the path for the <emphasis role="bold">contrib</emphasis> repository to match your PostgreSQL server layout. For example, if you built PostgreSQL from source following the cheat sheet, the contrib directory will be located here: <emphasis role="bold">/usr/local/share/contrib</emphasis> . If you installed the PostgreSQL 8.3 server packages on Ubuntu 8.04, the directory will be located here: <emphasis role="bold">/usr/share/postgresql/8.3/contrib/</emphasis> .</para>
+ <orderedlist>
+ <listitem>
<para>
- <emphasis>If you are entering the above command on a single line, do not include the <emphasis><emphasis role="bold">\</emphasis></emphasis> (backslash) characters. If you are using the <emphasis role="bold"> bash </emphasis> shell, these should only be used at the end of a line at a bash prompt to indicate that the command is continued on the next line.</emphasis>
+ <emphasis role="bold">Create and configure the database</emphasis>
</para>
- </note>
- </section>
- <section>
- <title>Configure the Apache Server</title>
- <para>As the <emphasis role="bold">root</emphasis> user, configure the Apache server and copy several new configuration files to the Apache server directories:</para>
- <figure>
- <title>Commands to configure the Apache server</title>
- <screen>
- # configure the Apache server
- $ su - root
- $ a2enmod ssl # enable mod_ssl
- $ a2enmod rewrite # enable mod_rewrite
- $ a2enmod expires # enable mod_expires
- $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
+ <para>As the <emphasis role="bold">postgres</emphasis> user on the PostgreSQL system create the PostgreSQL database, then set some internal paths:</para>
+ <figure>
+ <title>Commands to create database and adjust the path</title>
+ <screen>
+ # create the database
+ $ su - postgres
+ $ createdb -E UNICODE evergreen
+ $ createlang plperl evergreen
+ $ createlang plperlu evergreen
+ $ createlang plpgsql evergreen
+
+ # adjust the paths
+ $ psql -f /usr/share/postgresql/8.3/contrib/tablefunc.sql evergreen
+ $ psql -f /usr/share/postgresql/8.3/contrib/tsearch2.sql evergreen
+ $ psql -f /usr/share/postgresql/8.3/contrib/pgxml.sql evergreen
+ </screen>
+ </figure>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Create new Evergreen superuser</emphasis> </para>
+ <para>As the <emphasis role="bold">postgres</emphasis> user on the PostgreSQL system, create the new user <emphasis role="bold"> evergreen </emphasis>:</para>
+ <figure>
+ <title>Commands to create the 'evergreen' user</title>
+ <screen>
+ # create superuser 'evergreen' and set the password
+ $ su - postgres
+ $ createuser -P -s evergreen
+ Enter password for new role: mynewpassword
+ Enter it again: mynewpassword
+ </screen>
+ </figure>
+ </listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>Create Database Schema</title>
+ <para>As the <emphasis role="bold">root</emphasis> user, create the database schema and configure your system with the corresponding database authentication details for the database user 'evergreen' that you created in the previous step.</para>
+ <para>Enter the commands and replace <emphasis>[HOSTNAME], [PORT], [USER], [PASSWORD]</emphasis> and <emphasis>[DATABASENAME]</emphasis> with appropriate values.</para>
+ <para>On most systems <emphasis>[HOSTNAME]</emphasis> will be <emphasis role="bold">localhost</emphasis>, and <emphasis>[PORT]</emphasis> will be <emphasis role="bold">5432</emphasis>.</para>
+ <figure>
+ <title>Commands to create Evergreen database schema</title>
+ <screen>
+ $ su - root
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
+ $ perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \
+ --service all --create-schema --create-bootstrap --create-offline \
+ --hostname [HOSTNAME] --port [PORT] \
+ --user [USER] --password [PASSWORD] --database [DATABASENAME]
+ </screen>
+ </figure>
+ <note>
+ <para>
+ <emphasis>If you are entering the above command on a single line, do not include the <emphasis><emphasis role="bold">\</emphasis></emphasis> (backslash) characters. If you are using the <emphasis role="bold"> bash </emphasis> shell, these should only be used at the end of a line at a bash prompt to indicate that the command is continued on the next line.</emphasis>
+ </para>
+ </note>
+ </section>
+ <section>
+ <title>Configure the Apache Server</title>
+ <para>As the <emphasis role="bold">root</emphasis> user, configure the Apache server and copy several new configuration files to the Apache server directories:</para>
+ <figure>
+ <title>Commands to configure the Apache server</title>
+ <screen>
+ # configure the Apache server
+ $ su - root
+ $ a2enmod ssl # enable mod_ssl
+ $ a2enmod rewrite # enable mod_rewrite
+ $ a2enmod expires # enable mod_expires
+ $ cd /home/opensrf/Evergreen-ILS-1.6.0.7
- # copy files
- $ cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/
- $ cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
- $ cp Open-ILS/examples/apache/startup.pl /etc/apache2/
- </screen>
- </figure>
- </section>
- <section>
- <title>Create a Security Certificate (SSL Key)</title>
- <para>Use the command <emphasis role="bold"> openssl </emphasis> to create a new SSL key for your Apache server. For a public production server you should configure or purchase a signed SSL certificate, but for now you can just use a self-signed certificate and accept the warnings in the Staff Client and browser during testing and development:</para>
- <figure>
- <title>Commands to create an SSL key</title>
- <screen>
- $ mkdir /etc/apache2/ssl
- $ cd /etc/apache2/ssl
- $ openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
- </screen>
- </figure>
- <warning>
+ # copy files
+ $ cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/
+ $ cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
+ $ cp Open-ILS/examples/apache/startup.pl /etc/apache2/
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>Create a Security Certificate (SSL Key)</title>
+ <para>Use the command <emphasis role="bold"> openssl </emphasis> to create a new SSL key for your Apache server. For a public production server you should configure or purchase a signed SSL certificate, but for now you can just use a self-signed certificate and accept the warnings in the Staff Client and browser during testing and development:</para>
+ <figure>
+ <title>Commands to create an SSL key</title>
+ <screen>
+ $ mkdir /etc/apache2/ssl
+ $ cd /etc/apache2/ssl
+ $ openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
+ </screen>
+ </figure>
+ <warning>
+ <para>
+ <emphasis> This is only a temporary measure to expedite testing. You <emphasis role="bold"> must </emphasis> get a proper SSL certificate for a public production system. See this section for further comments on setting up a properly signed SSL certificate: </emphasis>
+ </para>
+ </warning>
+ <para> [[ ADD INFO ON HOW TO GET A SIGNED SSL CERTIFICATE ]] </para>
+ </section>
+ <section xml:id="serversideinstallation-modify-apache">
+ <title>Modify the Apache Configuration File</title>
+ <para>As the <emphasis role="bold">root</emphasis> user, edit the Apache configuration file <emphasis>/etc/apache2/sites-available/eg.conf</emphasis> and make the following changes:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Comment out the line <emphasis role="bold">Allow from 10.0.0.0/8</emphasis>, then uncomment the line <emphasis role="bold">Allow from all</emphasis>.</para>
<para>
- <emphasis> This is only a temporary measure to expedite testing. You <emphasis role="bold"> must </emphasis> get a proper SSL certificate for a public production system. See this section for further comments on setting up a properly signed SSL certificate: </emphasis>
+ <emphasis>This change allows access to your configuration CGI scripts from <emphasis role="bold">any</emphasis> workstation on <emphasis role="bold">any</emphasis> network. This is only a temporary change to expedite testing and should be removed after you have finished and successfully tested the Evergreen installation.</emphasis>
</para>
- </warning>
- <para> [[ ADD INFO ON HOW TO GET A SIGNED SSL CERTIFICATE ]] </para>
- </section>
- <section>
- <title>Modify the Apache Configuration File</title>
- <para>As the <emphasis role="bold">root</emphasis> user, edit the Apache configuration file <emphasis>/etc/apache2/sites-available/eg.conf</emphasis> and make the following changes:</para>
- <itemizedlist>
- <listitem>
- <para>Comment out the line <emphasis role="bold">Allow from 10.0.0.0/8</emphasis>, then uncomment the line <emphasis role="bold">Allow from all</emphasis>.</para>
+ <warning>
<para>
- <emphasis>This change allows access to your configuration CGI scripts from <emphasis role="bold">any</emphasis> workstation on <emphasis role="bold">any</emphasis> network. It is a temporary change to expedite testing and should be removed after you have finished and successfully tested the Evergreen installation.</emphasis>
+ <emphasis>You must remove these changes after testing is completed. See the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-postinstallation"> "Post-Installation Chores" </link></emphasis></emphasis> for further details on removing this change after the Evergreen installation is complete.</emphasis>
</para>
- <warning>
- <para>
- <emphasis>You must remove these changes after testing is completed. See the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-postinstallation"> "Post-Installation Chores" </link></emphasis></emphasis> for further details on removing this change after the Evergreen installation is complete.</emphasis>
- </para>
- </warning>
- </listitem>
- <listitem>
- <para>Comment out the line <emphasis role="bold">Listen 443</emphasis> as it conflicts with the same declaration in the configuration file: <emphasis role="bold">/etc/apache2/ports.conf</emphasis> . Debian <emphasis>etch</emphasis> users should not do this.</para>
- <para> [[ ADD INFO ON WHY DEBIAN ETCH USERS SHOULD NOT DO THIS ]] </para>
- </listitem>
- <listitem>
- <para>The following updates are needed to allow the logs to function properly, but it may break other Apache applications on your server. We hope to make this unnecessary soon.</para>
- <para> [[ ADD INFO ON WHETHER THIS IS STILL NECESSARY ]] </para>
- <orderedlist>
- <listitem>
- <para>For the Linux distributions <emphasis>Ubuntu Hardy</emphasis> or <emphasis>Debian Etch</emphasis>, as the <emphasis role="bold">root</emphasis> user, edit the Apache configuration file <emphasis role="bold"> /etc/apache2/apache2.conf </emphasis> and change the user:</para>
- <screen>www-data</screen>
- <para>to the user:</para>
- <screen>opensrf</screen>
- </listitem>
- <listitem>
- <para>For the Linux distributions <emphasis>Ubuntu Karmic</emphasis> or <emphasis>Ubuntu Lucid</emphasis> or <emphasis>Debian Lenny</emphasis>, as the <emphasis role="bold">root</emphasis> user, edit the Apache configuration file <emphasis role="bold">/etc/apache2/envvars </emphasis> and change the phrase:</para>
- <screen>export APACHE_RUN_USER=www-data</screen>
- <para>to the phrase:</para>
- <screen>export APACHE_RUN_USER=opensrf</screen>
- </listitem>
- </orderedlist>
- </listitem>
- <listitem>
- <para>As the <emphasis role="bold">root</emphasis> user, edit the Apache configuration file <emphasis>/etc/apache2/apache2.conf</emphasis> and add the line <emphasis role="bold">KeepAliveTimeout 1</emphasis>, or modify an existing line if it already exists.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section>
- <title>(OPTIONAL) Performance Modifications for Apache</title>
- <para>Some further configuration changes to Apache may be necessary for busy systems. These changes increase the number of Apache server processes that can be started to support additional browser connections, and are made to the <emphasis>prefork configuration</emphasis> section of the Apache configuration file.</para>
- <itemizedlist>
- <listitem>As the <emphasis role="bold">root</emphasis> user, edit the Apache configuration file <emphasis>/etc/apache2/apache2.conf</emphasis> and add the line <emphasis role="bold">MaxKeepAliveRequests 100</emphasis>, or modify an existing line if it already exists.</listitem>
- <listitem>
- <para>As the <emphasis role="bold">root</emphasis> user, edit the Apache configuration file <emphasis>/etc/apache2/apache2.conf</emphasis>, locate and modify the section related to <emphasis>prefork configuration</emphasis> to suit the load on your system.</para>
- <figure>
- <title>(OPTIONAL) Updates to Apache configuration</title>
- <screen>
- <IfModule mpm_prefork_module>
- StartServers 20
- MinSpareServers 5
- MaxSpareServers 15
- MaxClients 150
- MaxRequestsPerChild 10000
- </IfModule>
-
- MaxKeepAliveRequests 100
- </screen>
- </figure>
- </listitem>
- </itemizedlist>
- </section>
- <section>
- <title>Enable the Evergreen Site</title>
- <para>You must run additional Apache configuration commands to enable the Evergreen web site. As the <emphasis role="bold">root</emphasis> user, run these commands:</para>
- <figure>
- <title>Apache Commands to Enable the Evergreen Web Site</title>
- <screen>
- $ su - root
+ </warning>
+ </listitem>
+ <listitem>
+ <para>Comment out the line <emphasis role="bold">Listen 443</emphasis> as it conflicts with the same declaration in the configuration file: <emphasis role="bold">/etc/apache2/ports.conf</emphasis> . Debian <emphasis>etch</emphasis> users should not do this.</para>
+ <para> [[ ADD INFO ON WHY DEBIAN ETCH USERS SHOULD NOT DO THIS ]] </para>
+ </listitem>
+ <listitem>
+ <para>The following updates are needed to allow the logs to function properly, but it may break other Apache applications on your server. We hope to make this unnecessary soon.</para>
+ <para> [[ ADD INFO ON WHETHER THIS IS STILL NECESSARY ]] </para>
+ <orderedlist>
+ <listitem>
+ <para>For the Linux distributions <emphasis>Ubuntu Hardy</emphasis> or <emphasis>Debian Etch</emphasis>, as the <emphasis role="bold">root</emphasis> user, edit the Apache configuration file <emphasis role="bold"> /etc/apache2/apache2.conf </emphasis> and change the user:</para>
+ <screen>www-data</screen>
+ <para>to the user:</para>
+ <screen>opensrf</screen>
+ </listitem>
+ <listitem>
+ <para>For the Linux distributions <emphasis>Ubuntu Karmic</emphasis> or <emphasis>Ubuntu Lucid</emphasis> or <emphasis>Debian Lenny</emphasis>, as the <emphasis role="bold">root</emphasis> user, edit the Apache configuration file <emphasis role="bold">/etc/apache2/envvars </emphasis> and change the phrase:</para>
+ <screen>export APACHE_RUN_USER=www-data</screen>
+ <para>to the phrase:</para>
+ <screen>export APACHE_RUN_USER=opensrf</screen>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ <listitem>
+ <para>As the <emphasis role="bold">root</emphasis> user, edit the Apache configuration file <emphasis>/etc/apache2/apache2.conf</emphasis> and add the line <emphasis role="bold">KeepAliveTimeout 1</emphasis>, or modify an existing line if it already exists.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section>
+ <title>(OPTIONAL) Performance Modifications for Apache</title>
+ <para>Some further configuration changes to Apache may be necessary for busy systems. These changes increase the number of Apache server processes that can be started to support additional browser connections, and are made to the <emphasis>prefork configuration</emphasis> section of the Apache configuration file.</para>
+ <itemizedlist>
+ <listitem>As the <emphasis role="bold">root</emphasis> user, edit the Apache configuration file <emphasis>/etc/apache2/apache2.conf</emphasis> and add the line <emphasis role="bold">MaxKeepAliveRequests 100</emphasis>, or modify an existing line if it already exists.</listitem>
+ <listitem>
+ <para>As the <emphasis role="bold">root</emphasis> user, edit the Apache configuration file <emphasis>/etc/apache2/apache2.conf</emphasis>, locate and modify the section related to <emphasis>prefork configuration</emphasis> to suit the load on your system.</para>
+ <figure>
+ <title>(OPTIONAL) Updates to Apache configuration</title>
+ <screen>
+ <IfModule mpm_prefork_module>
+ StartServers 20
+ MinSpareServers 5
+ MaxSpareServers 15
+ MaxClients 150
+ MaxRequestsPerChild 10000
+ </IfModule>
+
+ MaxKeepAliveRequests 100
+ </screen>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section>
+ <title>Enable the Evergreen Site</title>
+ <para>You must run additional Apache configuration commands to enable the Evergreen web site. As the <emphasis role="bold">root</emphasis> user, run these commands:</para>
+ <figure>
+ <title>Apache Commands to Enable the Evergreen Web Site</title>
+ <screen>
+ $ su - root
- # disables the default site (i.e., the "It Works" page).
- $ a2dissite default
+ # disables the default site (i.e., the "It Works" page).
+ $ a2dissite default
- # enables the Evergreen web site
- $ a2ensite eg.conf
- </screen>
- </figure>
- </section>
- <section>
- <title>Modify the OpenSRF Configuration File</title>
-
<para>As the <emphasis role="bold">opensrf</emphasis> user, edit the OpenSRF configuration file <emphasis>/openils/conf/opensrf_core.xml</emphasis> to update various usernames and passwords, and to specify the domains from which we will accept and to which we will make connections.</para>
-
<para>If you are installing Evergreen on a single server and using the <emphasis> private.localhost </emphasis> / <emphasis> public.localhost </emphasis> domains, these will already be set to the correct values. Otherwise, search and replace to match your customized values.</para>
- <note>
- <emphasis>The following example uses common XPath syntax on the left-hand side to indicate the aproximage position needing changes within the XML file.</emphasis>
- </para>
- </note>
-
<para>[[ ADD A BETTER DIAGRAM HERE ]]</para>
- <figure>
- <title>Updates needed to the file "/openils/conf/opensrf_core.xml"</title>
- <screen>
- /config/opensrf/username = opensrf
+ # enables the Evergreen web site
+ $ a2ensite eg.conf
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>Modify the OpenSRF Configuration File</title>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, edit the OpenSRF configuration file <emphasis>/openils/conf/opensrf_core.xml</emphasis> to update various usernames and passwords, and to specify the domains from which we will accept and to which we will make connections.</para>
+ <para>If you are installing Evergreen on a single server and using the <emphasis> private.localhost </emphasis> / <emphasis> public.localhost </emphasis> domains, these will already be set to the correct values. Otherwise, search and replace to match your customized values.</para>
+ <note>
+ <para>
+ <emphasis>The following example uses common XPath syntax on the left-hand side to indicate the aproximage position needing changes within the XML file.</emphasis>
+ </para>
+ </note>
+ <para>[[ ADD A BETTER DIAGRAM HERE ]]</para>
+ <figure>
+ <title>Updates needed to the file "/openils/conf/opensrf_core.xml"</title>
+ <screen>
+ /config/opensrf/username = opensrf
- /config/opensrf/passwd = password for "private.localhost" opensrf user
+ /config/opensrf/passwd = password for "private.localhost" opensrf user
- /config/gateway/username = opensrf
+ /config/gateway/username = opensrf
- /config/gateway/passwd = password for "public.localhost" opensrf user
+ /config/gateway/passwd = password for "public.localhost" opensrf user
- # first entry, where "transport/server" == "public.localhost" :
- /config/routers/router/transport
- username = router
- password = password for "public.localhost" router user
- # second entry, where "transport/server" == "private.localhost" :
- /config/routers/router/transport
- username = router
- password = password for "private.localhost" router user
- </screen>
- </figure>
- </section>
- <section>
- <title>Create Configuration Files for Users Needing srfsh</title>
-
<para>The software installation will automatically create a utility named <emphasis>srfsh</emphasis> (surf shell). This is a command line diagnostic tool for testing and interacting with the OpenSRF network software. It will be used in a future step to complete and test the Evergreen installation. See the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-testing"> "Testing the Installation" </link></emphasis></emphasis> for further information.</para>
-
<para>In this step you will set up a special configuration file for each user who will need to run the utility. Copy the short sample configuration file <emphasis>/openils/conf/srfsh.xml.example</emphasis> to the file <emphasis>.srfsh.xml</emphasis> (note the leading dot!) in the home directory of each user who will use <emphasis role="bold">srfsh</emphasis>. Finally, edit each file <emphasis>.srfsh.xml</emphasis> and make the following changes:</para>
- <itemizedlist>
- <listitem>Modify <emphasis role="bold">domain</emphasis> to be the router hostname (following our domain examples, <emphasis role="bold">private.localhost</emphasis> will give the utility <emphasis role="bold">srfsh</emphasis> access to all OpenSRF services, while <emphasis role="bold">public.localhost</emphasis> will only allow access to those OpenSRF services that are publicly exposed).</listitem>
- <listitem>Modify <emphasis role="bold">username</emphasis> and <emphasis role="bold">password</emphasis> to match the <emphasis role="bold">opensrf</emphasis> Jabber user for the chosen domain</listitem>
- <listitem>Modify <emphasis role="bold">logfile</emphasis> to be the full path for a log file to which the user has write access</listitem>
- <listitem>Modify <emphasis role="bold">loglevel</emphasis> as needed for testing</listitem>
- </itemizedlist>
- <figure>
- <title>Sample of configuration file /openils/conf/srfsh.xml.example</title>
- <screen>
- <?xml version="1.0"?>
- <!-- This file follows the standard bootstrap config file layout -->
- <!-- found in opensrf_core.xml -->
- <srfsh>
- <router_name>router</router_name>
- <domain>private.localhost</domain>
- <username>opensrf</username>
- <passwd>evergreen</passwd>
- <port>5222</port>
- <logfile>/tmp/srfsh.log</logfile>
- <!-- 0 None, 1 Error, 2 Warning, 3 Info, 4 debug, 5 Internal (Nasty) -->
- <loglevel>4</loglevel>
- </srfsh>
- </screen>
- </figure>
- </section>
- <section>
- <title>Modify the OpenSRF Environment</title>
-
<para>As the <emphasis role="bold">opensrf</emphasis> user, change the file permissions of the directory <emphasis>/openils/var/cgi-bin</emphasis> to <emphasis>executable</emphasis>, then modify the shell configuration file <emphasis>~/.bashrc</emphasis> of that user by adding a Perl environmental variable. Finally, execute the shell configuration file to load the new variables into your current environment.</para>
- <note>
- <emphasis>In a multi-server environment, you must add any modifications to <emphasis role="bold">~/.bashrc</emphasis> to the top of the file <emphasis>before</emphasis> the line <emphasis role="bold"> [ -z "$PS1" ] && return</emphasis>. This will allow headless (scripted) logins to load the correct environment.</emphasis>
- </para>
- </note>
- <figure>
- <title>Modify the OpenSRF environment</title>
- <screen>
- # change permissions
- $ su - opensrf
- $ chmod 755 /openils/var/cgi-bin/*.cgi
+ # first entry, where "transport/server" == "public.localhost" :
+ /config/routers/router/transport
+ username = router
+ password = password for "public.localhost" router user
+ # second entry, where "transport/server" == "private.localhost" :
+ /config/routers/router/transport
+ username = router
+ password = password for "private.localhost" router user
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>Create Configuration Files for Users Needing srfsh</title>
+ <para>The software installation will automatically create a utility named <emphasis>srfsh</emphasis> (surf shell). This is a command line diagnostic tool for testing and interacting with the OpenSRF network software. It will be used in a future step to complete and test the Evergreen installation. See the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-testing"> "Testing the Installation" </link></emphasis></emphasis> for further information.</para>
+ <para>In this step you will set up a special configuration file for each user who will need to run the utility. Copy the short sample configuration file <emphasis>/openils/conf/srfsh.xml.example</emphasis> to the file <emphasis>.srfsh.xml</emphasis> (note the leading dot!) in the home directory of each user who will use <emphasis role="bold">srfsh</emphasis>. Finally, edit each file <emphasis>.srfsh.xml</emphasis> and make the following changes:</para>
+ <itemizedlist>
+ <listitem>Modify <emphasis role="bold">domain</emphasis> to be the router hostname (following our domain examples, <emphasis role="bold">private.localhost</emphasis> will give the utility <emphasis role="bold">srfsh</emphasis> access to all OpenSRF services, while <emphasis role="bold">public.localhost</emphasis> will only allow access to those OpenSRF services that are publicly exposed).</listitem>
+ <listitem>Modify <emphasis role="bold">username</emphasis> and <emphasis role="bold">password</emphasis> to match the <emphasis role="bold">opensrf</emphasis> Jabber user for the chosen domain</listitem>
+ <listitem>Modify <emphasis role="bold">logfile</emphasis> to be the full path for a log file to which the user has write access</listitem>
+ <listitem>Modify <emphasis role="bold">loglevel</emphasis> as needed for testing</listitem>
+ </itemizedlist>
+ <figure>
+ <title>Sample of configuration file /openils/conf/srfsh.xml.example</title>
+ <screen>
+ <?xml version="1.0"?>
+ <!-- This file follows the standard bootstrap config file layout -->
+ <!-- found in opensrf_core.xml -->
+ <srfsh>
+ <router_name>router</router_name>
+ <domain>private.localhost</domain>
+ <username>opensrf</username>
+ <passwd>evergreen</passwd>
+ <port>5222</port>
+ <logfile>/tmp/srfsh.log</logfile>
+ <!-- 0 None, 1 Error, 2 Warning, 3 Info, 4 debug, 5 Internal (Nasty) -->
+ <loglevel>4</loglevel>
+ </srfsh>
+ </screen>
+ </figure>
+ </section>
+ <section>
+ <title>Modify the OpenSRF Environment</title>
+ <para>As the <emphasis role="bold">opensrf</emphasis> user, change the file permissions of the directory <emphasis>/openils/var/cgi-bin</emphasis> to <emphasis>executable</emphasis>, then modify the shell configuration file <emphasis>~/.bashrc</emphasis> of that user by adding a Perl environmental variable. Finally, execute the shell configuration file to load the new variables into your current environment.</para>
+ <note>
+ <para>
+ <emphasis>In a multi-server environment, you must add any modifications to <emphasis role="bold">~/.bashrc</emphasis> to the top of the file <emphasis>before</emphasis> the line <emphasis role="bold"> [ -z "$PS1" ] && return</emphasis>. This will allow headless (scripted) logins to load the correct environment.</emphasis>
+ </para>
+ </note>
+ <figure>
+ <title>Modify the OpenSRF environment</title>
+ <screen>
+ # change permissions
+ $ su - opensrf
+ $ chmod 755 /openils/var/cgi-bin/*.cgi
- # add environmental variable
- $ echo "export PERL5LIB=/openils/lib/perl5:\$PERL5LIB" >> ~/.bashrc
+ # add environmental variable
+ $ echo "export PERL5LIB=/openils/lib/perl5:\$PERL5LIB" >> ~/.bashrc
- # inherit the new environment
- $ . ~/.bashrc
- </screen>
- </figure>
- </section>
- <section xml:id="serversideinstallation-localization">
- <title>(OPTIONAL) Configuration for Other Languages</title>
- <para>This section describes how translations such as Armenian (hy-AM), Canadian French (fr-CA) and others are loaded into the database to complete the translations (default English) available in the OPAC and Staff Client.</para>
- <para> [[ ADD SECTION ON LANGUAGE LOCALIZATION ]] </para>
- </section>
+ # inherit the new environment
+ $ . ~/.bashrc
+ </screen>
+ </figure>
+ </section>
+ <section xml:id="serversideinstallation-localization">
+ <title>(OPTIONAL) Configuration for Other Languages</title>
+ <para>This section describes how translations such as Armenian (hy-AM), Canadian French (fr-CA) and others are loaded into the database to complete the translations (default English) available in the OPAC and Staff Client.</para>
+ <para> [[ ADD SECTION ON LANGUAGE LOCALIZATION ]] </para>
</section>
<section xml:id="serversideinstallation-starting">
<title>Starting Evergreen</title>
<itemizedlist>
<listitem>
<para>As the <emphasis role="bold">root</emphasis> user, edit the Apache configuration file <emphasis>/etc/apache2/sites-available/eg.conf</emphasis> again and make the following change:</para>
- <para>Uncomment the line <emphasis role="bold">Allow from 10.0.0.0/8</emphasis>, then comment out the line <emphasis role="bold">Allow from all</emphasis>. You modified this file earlier in step <emphasis role="bold">5.1.15</emphasis> as a temporary measure to expedite testing. Those changes must now be reversed in order to deny access to your CGI scripts by other public networks. You <emphasis role="bold"> must </emphasis> secure this for a public production system, preferably by explicitly specifying the allowed IP addresses and adding proper authentication.</para>
+ <para>Uncomment the line <emphasis role="bold">Allow from 10.0.0.0/8</emphasis>, then comment out the line <emphasis role="bold">Allow from all</emphasis>. You modified this file in an earlier step as a temporary measure to expedite testing (see the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-modify-apache"> "Modify the Apache Configuration File" </link></emphasis></emphasis> for further information). Those changes must now be reversed in order to deny unwanted access to your CGI scripts from users on other public networks. You <emphasis role="bold"> must </emphasis> secure this for a public production system.</para>
</listitem>
<listitem>
<warning>
- <para>
- <emphasis>This is only a temporary measure to expedite testing. You <emphasis role="bold"> must </emphasis> get a proper SSL certificate for a public production system. See this section for further comments on setting up a properly signed SSL certificate: </emphasis>
- </para>
+ <para><emphasis>This is only a temporary measure to expedite testing. You <emphasis role="bold"> must </emphasis> get a proper SSL certificate for a public production system. See this section for further comments on setting up a properly signed SSL certificate: <emphasis><emphasis role="bold"><link linkend="serversideinstallation-ssl"> "Getting a Signed SSL Security Certificate" </link></emphasis></emphasis> </emphasis>.
+
+ <title>Getting a Signed SSL Security Certificate</title></para>
</warning>
- <para> [[ ADD EXPLANATION OF HOW TO GET A SIGNED SSL CERTIFICATE ]] </para>
</listitem>
</itemizedlist>
</section>
</figure>
</section>
</section>
- <section xml:id="serversideinstallation-opensrf">
- <title>Installing OpenSRF</title>
- <para>[[ Installing OpenSRF 1.2.2 ]]</para>
- </section>
<section xml:id="serversideinstallation-otherlinux">
<title>Installing Evergreen On Other Linux Systems</title>
- <para>[[ Installing on Other Linux Systems ]]</para>
+ <para>[[ ADD CONTENT FOR INSTALLING ON OTHER LINUX SYSTEMS ]]</para>
</section>
<section xml:id="serversideinstallation-virtual">
<title>Installing Evergreen in Virtualized Unix Environments</title>
- <para>Evergreen software currently runs as a native application on any of several well-known Linux distributions (e.g., <emphasis>Ubuntu</emphasis> and <emphasis>Debian</emphasis>). It does not run as a native application on the Windows operating system (e.g., WindowsXP, WindowsXP Professional, Windows7), but the software can be installed and run on Windows via a virtualized Unix-guest Operating System (using, for example, VirtualBox or VMware to emulate a Linux environment). More information on virtualized environments can be found in the section <emphasis><emphasis role="bold"><link linkend="serversideinstallation-virtual">"Installing Evergreen in Virtualized Unix Environments"</link></emphasis></emphasis>.</para>
- <para>[[ Installing Evergreen in Virtualized Unix Environments ]]</para>
+ <para>Evergreen software currently runs as a native application on any of several well-known Linux distributions (e.g., <emphasis>Ubuntu</emphasis> and <emphasis>Debian</emphasis>). It does not run as a native application on the Windows operating system (e.g., WindowsXP, WindowsXP Professional, Windows7), but the software can be installed and run on Windows via a virtualized Unix-guest Operating System (using, for example, VirtualBox or VMware to emulate a Linux environment).</para>
+ <para>[[ ADD CONTENT FOR INSTALLING EVERGREEN IN VIRTUALIZED UNIX ENVIRONMENTS ]]</para>
<section xml:id="serversideinstallation-virtualized-virtualbox">
<title>VirtualBox</title>
- <para>[[ VirtualBox ]]</para>
+ <para>[[ ADD CONTENT FOR VirtualBox ]]</para>
</section>
<section xml:id="serversideinstallation-virtualized-vmware">
<title>VMware</title>
- <para>[[ VMware ]]</para>
+ <para>[[ ADD CONTENT FOR VMware ]]</para>
</section>
<section xml:id="serversideinstallation-virtualized-virtualpc">
<title>VirtualPC</title>
- <para>[[ VirtualPC ]]</para>
+ <para>[[ ADD CONTENT FOR VirtualPC ]]</para>
</section>
</section>
<section xml:id="serversideinstallation-previousversions">
<title>Installing Previous Versions of Evergreen</title>
<para>Earlier releases of Evergreen are available. Instructions for installing, configuring and testing earlier versions are found below.</para>
+ <para>The next most recent previous release of Evergreen is version <emphasis><emphasis role="bold">1.4.0.6</emphasis></emphasis>. The accompanying previous release of OpenSRF is version <emphasis><emphasis role="bold">1.0.x</emphasis></emphasis>.</para>
<section xml:id="serversideinstallation-ubuntudebian-previous">
<title>Installing Evergreen 1.4.0.6 on Ubuntu or Debian</title>
- <para>[[ Installing Evergreen 1.4.0.6 on Ubuntu or Debian ]]</para>
+ <para>[[ ADD CONTENT FOR INSTALLING EVERGREEN 1.4.0.6 ON UBUNTU OR DEBIAN ]]</para>
</section>
<section xml:id="serversideinstallation-opensrf-previous">
<title>Installing OpenSRF 1.0.x</title>
- <para>[[ Installing OpenSRF 1.0.x ]]</para>
+ <para>[[ ADD CONTECNT FOR INSTALLING OPENSRF 1.0.x ]]</para>
</section>
</section>
- <section xml:id="serversideinstallation-organizationandpolicy">
- <title>Organization and Policy Editing</title>
- <para>[[ Organization and Policy Editing ]] </para>
+ <section xml:id="serversideinstallation-opensrf">
+ <title>OpenSRF</title>
+ <para>[[ ADD CONTENT FOR OPENSRF ]] </para>
</section>
<section xml:id="serversideinstallation-staffclient">
- <title>Installing the Staff Client</title>
- <para>[[ Installing the Staff Client ]]</para>
+ <title>Installing the Evergreen Staff Client</title>
+ <para>[[ ADD CONTENT FOR INSTALLING THE EVERGREEN STAFF CLIENT ]]</para>
+ </section>
+ <section xml:id="serversideinstallation-postgresql">
+ <title>PostgreSQL</title>
+ <para>[[ ADD CONTENT FOR POSTGRESQL ]] </para>
+ </section>
+ <section xml:id="serversideinstallation-apache">
+ <title>Apache</title>
+ <para>[[ ADD CONTENT FOR APACHE ]] </para>
+ </section>
+ <section xml:id="serversideinstallation-memcached">
+ <title>memcached Servers</title>
+ <para>[[ ADD CONTENT FOR MEMCACHED ]] </para>
+ </section>
+ <section xml:id="serversideinstallation-organizationandpolicy">
+ <title>Organization and Policy Editing</title>
+ <para>[[ ADD CONTENT FOR ORGANIZATION AND POLICY EDITING ]] </para>
</section>
<section xml:id="serversideinstallation-sip">
<title>Installing the SIP Server</title>
- <para>[[ Installing the SIP Server ]]</para>
+ <para>[[ ADD CONTENT FOR INSTALLING THE SIP SERVER ]]</para>
</section>
<section xml:id="serversideinstallation-nginx">
<title>Using nginx to serve static content</title>
- <para>[[ Using nginx to serve static content ]]</para>
+ <para>[[ ADD CONTENT FOR USING NGINX TO SERVE STATIC CONTENT ]]</para>
+ </section>
+ <section xml:id="serversideinstallation-ssl">
+ <title>Getting a Signed SSL Security Certificate</title>
+ <para>[[ ADD EXPLANATION OF HOW TO GET A SIGNED SSL CERTIFICATE ]] </para>
</section>
</chapter>
projects / working / Evergreen.git / commitdiff