From ee9cd67ea19829596dccd1a584f8498ce820cd06 Mon Sep 17 00:00:00 2001 From: Robert Soulliere Date: Wed, 29 Sep 2010 16:04:47 -0400 Subject: [PATCH] Move PostgreSQL ifnormation from ServersideInstallation to Admin misc. chapter. This PostgreSQL isnstallation from information procedures is specific to older versions of Debian and Ubuntu. Also separated Installation and cConfiguraton of PostgreSQL ito 2 separate sections since one is specific to a specific situation while configuration is a good guide for any installation of PostgeSQL for Evergreen. --- 1.6/admin/AdminMisc.xml | 122 +++++ ...rversideInstallation-olderEvergreenVersions.xml | 545 +++++++++++++++++++ 1.6/admin/ServersideInstallation.xml | 140 ++--- 1.6/admin/StaffclientInstallation.xml | 604 ++++++++++----------- 1.6/admin/Upgrading-Evergreen_1.6.xml | 164 +++--- 1.6/admin/installation-previousversions.xml | 545 +++++++++++++++++++ 1.6/admin/installingpostgresql.xml | 119 ++++ 1.6/admin/localization.xml | 123 ++--- 8 files changed, 1807 insertions(+), 555 deletions(-) create mode 100644 1.6/admin/ServersideInstallation-olderEvergreenVersions.xml create mode 100644 1.6/admin/installation-previousversions.xml create mode 100644 1.6/admin/installingpostgresql.xml diff --git a/1.6/admin/AdminMisc.xml b/1.6/admin/AdminMisc.xml index cb66410..6430e72 100644 --- a/1.6/admin/AdminMisc.xml +++ b/1.6/admin/AdminMisc.xml @@ -198,4 +198,126 @@ size 50M and errors. +
+ Installing PostgreSQL from Source + Some Linux distributions, such as Debian Etch (4.0), do not offer PostgreSQL + version 8.2 as an installable package. Before you continue, examine the software dependencies listed in + to ensure that your Linux distribution supports the required version of PostgreSQL. + + + Some Linux distributions, such as Debian Etch (4.0), do not offer PostgreSQL + version 8.2 as an installable package. Before you continue, examine the software dependencies listed in + to ensure that your Linux distribution supports the required version of PostgreSQL. + + + + + Install the application stow on your system if it is not already installed. Issue the following command as + the root user: + + Installing <application>stow</application> + + $ apt-get install stow + ... + + + + Download, compile, and install the latest release for PostgreSQL 8.2 (which was version 8.2.12 at the time of this writing). + As the root user, follow these steps: +
+ Installing PostgreSQL + + $ wget http://wwwmaster.postgresql.org/redir/198/h/source/v8.2.17/postgresql-8.2.17.tar.bz2 + $ tar xzf postgresql-8.2.17.tar.gz + $ cd postgresql-8.2.17 + $ ./configure --with-perl --enable-integer-datetimes --with-openssl --prefix=/usr/local/stow/pgsql + ... + $ make + ... + $ make install + ... + $ cd contrib + $ make + ... + $ make install + $ cd xml2 + $ make + ... + $ make install + $ cd /usr/local/stow + $ stow pgsql + +
+ + + Create the new user postgres to run the PostgreSQL processes. + As the root user, execute this command: +
+ Adding <systemitem class="username">postgres</systemitem> + + $ adduser postgres + +
+ + + Initialize the database directory and start up PostgreSQL. As the root user, follow these steps: +
+ Adding <systemitem class="username">postgres</systemitem> + + $ mkdir -p /usr/local/pgsql/data + $ chown postgres /usr/local/pgsql/data + $ su - postgres + $ initdb -D /usr/local/pgsql/data -E UNICODE --locale=C + $ pg_ctl -D /usr/local/pgsql/data -l /home/postgres/logfile start + +
+ + If an error occurs during the final step above, review the path of the home directory for the + postgres user. It may be /var/lib/postresql instead of /home/postres. + + + +
+
+ Configuring PostgreSQL + The values of several PostreSQL configuration parameters may be changed for enhanced performance. The following table lists the default values + and some suggested updates for several useful parameters: + + Suggested configuration values + + + + + + + Parameter + Default + Suggested + + + + + default_statistics_target + 10 + 100 + + + work_mem + 4Mb + 128Mb + + + shared_buffers + 8Mb + 512Mb + + + effective_cache_size + 128Mb + 4Gb + + + +
+
diff --git a/1.6/admin/ServersideInstallation-olderEvergreenVersions.xml b/1.6/admin/ServersideInstallation-olderEvergreenVersions.xml new file mode 100644 index 0000000..2b436fd --- /dev/null +++ b/1.6/admin/ServersideInstallation-olderEvergreenVersions.xml @@ -0,0 +1,545 @@ + + + + Installing Previous Versions of Evergreen + Earlier releases of Evergreen are available. Instructions for installing, configuring and testing earlier versions are found below. + The next most recent previous release of Evergreen is version 1.4.0.6. The accompanying previous release of OpenSRF + is version 1.0.7. +
+ Installing Evergreen 1.4.0.6 On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> + This section outlines the installation process for the previous version 1.4.0.6 of Evergreen. + 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. + + 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. + If you are starting with a clean install of Ubuntu or Debian, you are strongly recommended not to install the packaged PostgreSQL server. This can confuse port numbers and system configuration. Evergreen 1.4 requires PostgreSQL 8.2. + +
+ Installing OpenSRF 1.0.7 + 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 . + 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. +
+
+ Download and Unpack Evergreen Version 1.4.0.6 + As the opensrf user, download and extract the latest version of Evergreen. The latest version can be found here: +
+ Commands to download and unpack Evergreen + + $ su - opensrf + $ wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.4.0.6.tar.gz + $ tar zxf Evergreen-ILS-1.4.0.6.tar.gz + +
+ The new directory /home/opensrf/Evergreen-ILS-1.4.0.6 will be created. +
+
+ Install Prerequisites to Build Evergreen + In this section you will install and configure a set of prerequisites that will be used to build Evergreen. In a following step you will actually build the software using the make utility. + As the root user, enter the commands show below to build the prerequisites from the software distribution that you just downloaded and unpacked. Remember to replace [distribution] in the example with the keyword corresponding to the actual Linux distribution listed in the "Keywords" figure below. +
+ Commands to install prerequisites for Evergreen + + $ su - root + $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 + $ make -f Open-ILS/src/extras/Makefile.install [distribution] + ... + +
+ + Keywords Targets for <application>"make"</application> Command + + + + + + Keyword + Description + + + + + debian-lenny + for Debian Lenny (5.0) + + + debian-etch + for Debian Etch (4.0) + + + ubuntu-intrepid + for Ubuntu Intrepid (8.10) + + + ubuntu-hardy + for Ubuntu Hardy (8.04) + + + +
+
+
+ Update the System Dynamic Library Path + As the root user, you must update the system dynamic library path to make your system recognize the newly installed libraries. Do this by creating the new file /etc/ld.so.conf.d/eg.conf containing two new library paths, then run the command ldconfig to automatically read the file and modify the system dynamic library path: +
+ Commands to modify system dynamic library path + + $ su - root + $ cat > /etc/ld.so.conf.d/eg.conf << ENDOFFILE + /usr/local/lib + /usr/local/lib/dbd + ENDOFFILE + $ ldconfig + +
+
+
+ Restart the PostgreSQL Server + If PostgreSQL is running on the same system as the rest of Evergreen, as the root user you must restart the PostgreSQL server to avoid a problem where the library plperl.so cannot be found. If your PostgreSQL server is running on another system, just skip this step. +
+ Commands to restart PostgreSQL server + + $ su - root + $ /etc/init.d/postgresql-8.2 restart + +
+
+
+ Configure Evergreen + As the opensrf user, return to the Evergreen build directory and use the configure utility to prepare for the next step of compiling and linking the software: +
+ Commands to configure Evergreen + + $ su - opensrf + $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 + $ ./configure --prefix=/openils --sysconfdir=/openils/conf + $ make + ... + +
+
+
+ Compile, Link and Install Evergreen + In this step you will actually compile, link and install Evergreen and the default Evergreen Staff Client. + As the root user, return to the Evergreen build directory and use the make utility as shown below. The Staff Client will also be automatically built, but you must remember to set the variable STAFF_CLIENT_BUILD_ID to match the version of the Staff Client you will use to connect to the Evergreen server. + For further information on manually building the Staff Client, see . +
+ Commands to build, link and install Evergreen + + $ su - root + $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 + $ make STAFF_CLIENT_BUILD_ID=rel_1_4_0_6 install + ... + + The above commands will create a new subdirectory /openils/var/web/xul/rel_1_4_0_6 containing the Staff Client. +
+
+
+ Copy the OpenSRF Configuration Files + As the root user, copy the example OpenSRF configuration files into place. This replaces the configuration files that you set up in a previous step when you installed and tested OpenSRF. You should also create backup copies of the old files for troubleshooting purposes. Finally, change the ownership on the installed files to the opensrf user: +
+ Commands to copy OpenSRF configuration files + + $ su - root + $ cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml + $ cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml + $ chown -R opensrf:opensrf /openils/ + +
+
+
+ Create and Configure PostgreSQL Database + As the postgres user on your PostgreSQL server, create the Evergreen database. + In the commands below, remember to adjust the path of the contrib repository to match your PostgreSQL server layout. For example, if you built PostgreSQL from source the path would be /usr/local/share/contrib; if you installed the PostgreSQL 8.2 server packages on Ubuntu 8.04, the path would be /usr/share/postgresql/8.2/contrib/. + + + + Create and configure the database + + As the postgres user on the PostgreSQL system create the PostgreSQL database, then set some internal paths: +
+ Commands to create database and adjust the path + + # 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/PGSQL_VERSION/contrib/tablefunc.sql evergreen + $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tsearch2.sql evergreen + $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/pgxml.sql evergreen + +
+ Where PGSQL_VERSION is your installed PostgreSQL version (e.g. 8.2). + + + + Create new Evergreen superuser + + As the postgres user on the PostgreSQL system, create the + new database evergreen user and assign a password: + +# create superuser 'evergreen' and set the password +su - postgres +createuser -P -s evergreen +Enter password for new role: MYNEWPASSWORD +Enter it again:MYNEWPASSWORD + + Where MYNEWPASSWORD is the password chosen. + + +
+
+ Create Database Schema + As the root user, create the database schema and configure your system with the corresponding database authentication details for the evergreen database user that you created in the previous step. + Enter the following commands and replace HOSTNAME, PORT, PASSWORD and DATABASENAME with appropriate values. +
+ Commands to create Evergreen database schema + + $ su - root + $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 + $ 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 evergreen --password PASSWORD --database DATABASENAME + +
+ Where, on most systems, HOSTNAME will be localhost, PORT will be 5432, and PASSWORD and DATABASENAME will be those assigned when PostgreSQL was installed in the previous step. + + + If you are entering the above command on a single line, do not include the \ (backslash) characters. If you are using the bash 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. + + +
+
+ Evergreen installation - (continued) + The remainder of the Evergreen installation procedure is identical to that for installing the latest version of Evergreen. Continue with the instructions found in . +
+
+
+ Installing OpenSRF 1.0.7 On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> + This section describes the installation of the previous version of the Open Service Request Framework (OpenSRF), a major component of the Evergreen server-side software, on Ubuntu or Debian systems. Evergreen software is integrated with and depends on the OpenSRF software system. + Follow the steps outlined here and run the specified tests to ensure that OpenSRF is properly installed and configured. Do not continue with any further Evergreen installation steps until you have verified that OpenSRF has been successfully installed. + + The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) platforms. OpenSRF 1.0.7 has been tested on Debian Etch (4.0), Debian Lenny, Ubuntu Hardy Heron (8.04), and Ubuntu Intrepid Ibex (8.10). + In the following instructions, you are asked to perform certain steps as either the root user, the opensrf user, or the postgres user. + + Debian -- To become the root user, issue the command su - and enter the password of the root user. + Ubuntu -- To become the root user, issue the command sudo su - and enter the password of the root user. + + To switch from the root user to a different user, issue the command su - USERNAME. For example, to switch from the root user to the opensrf user, issue the command su - opensrf. Once you have become a non-root user, to become the root user again, simply issue the command exit". + +
+ Add the OpenSRF User + As the root user, add the opensrf user to the system. The default shell for the new user is automatically set to /bin/bash to inherit a reasonable environment: +
+ Commands to add <systemitem class="username">opensrf</systemitem> user + + $ su - opensrf + $ useradd -m -s /bin/bash opensrf + $ passwd opensrf + Enter new UNIX password: ****** + Retype new UNIX password: ****** + passwd: password updated successfully + $ + +
+
+
+ Download and Unpack Latest OpenSRF Version + As the opensrf user, download and extract the latest version of OpenSRF. The latest version can be found here: +
+ Commands to download and unpack OpenSRF + + $ su - opensrf + $ wget http://evergreen-ils.org/downloads/OpenSRF-1.0.7.tar.gz + $ tar zxf OpenSRF-1.0.7.tar.gz + +
+ The new directory /home/opensrf/OpenSRF-1.0.7 will be created. +
+
+ Install Prerequisites to Build OpenSRF + In this section you will install and configure a set of prerequisites that will be used to build OpenSRF. In a following step you will actually build the software using the make utility. + As the root user, enter the commands show below to build the prerequisites from the software distribution that you just downloaded and unpacked. Remember to replace [DISTRIBUTION] in the example with the keyword corresponding to the actual Linux distribution listed in the "Keywords" figure below. +
+ Commands to install prerequisites for OpenSRF + + $ su - root + $ cd /home/opensrf/OpenSRF-1.0.7 + $ make -f src/extras/Makefile.install [DISTRIBUTION] + ... + +
+ + Keywords Targets for <application>"make"</application> Command + + + + + + Keyword + Description + + + + + debian-lenny + for Debian Lenny (5.0) + + + debian-etch + for Debian Etch (4.0) + + + ubuntu-intrepid + for Intrepid (8.10) + + + ubuntu-hardy + for Ubuntu Hardy (8.04) + + + +
+ This will install a number of packages on the system that are required by OpenSRF, including some Perl modules from CPAN. You can say No to the initial CPAN configuration prompt to allow it to automatically configure itself to download and install Perl modules from CPAN. The CPAN installer will ask you a number of times whether it should install prerequisite modules - say Yes. +
+
+ Configure OpenSRF + As the opensrf user, return to the OpenSRF build directory and use the configure utility to prepare for the next step of compiling and linking the software. You can include the and configuration options if you wish to include support for Python and Java, respectively: +
+ Commands to configure OpenSRF + + $ su - opensrf + $ cd /home/opensrf/OpenSRF-1.0.7 + $ ./configure --prefix=/openils --sysconfdir=/openils/conf + $ make + ... + +
+
+
+ Compile, Link and Install OpenSRF + As the root user, return to the OpenSRF build directory and use the make utility to compile, link and install OpenSRF: +
+ Commands to build, link and install OpenSRF + + $ su - opensrf + $ cd /home/opensrf/OpenSRF-1.0.7 + $ make install + ... + +
+
+
+ Update the System Dynamic Library Path + As the root user, you must update the system dynamic library path to make your system recognize the newly installed libraries. Do this by creating the new file /etc/ld.so.conf.d/osrf.conf containing a new library path, then run the command ldconfig to automatically read the file and modify the system dynamic library path: +
+ Commands to modify system dynamic library path + + $ su - root + $ echo "/openils/lib" > /etc/ld.so.conf.d/osrf.conf + $ ldconfig + +
+
+
+ Define Public and Private OpenSRF Domains + Define your public and private OpenSRF domains. For security purposes, OpenSRF uses Jabber domains to separate services into public and private realms. Throughout these instructions, we will use the example domains public.localhost for the public domain and private.localhost for the private domain. On a single-server system, the easiest way to define public and private domains is to define separate host names by adding entries to the file /etc/hosts. + As the root user, edit the file /etc/hosts and add the following entries for our example domains: +
+ Example public and private domains in /etc/hosts + + 127.0.1.2 public.localhost public + 127.0.1.3 private.localhost private + +
+
+
+ Change File Ownerships + As the root user, change the ownership of files installed in the directory /openils to the opensrf user: +
+ Commands to change file ownerships + + $ chown -R opensrf:opensrf /openils + +
+
+
+ Stop the <systemitem class="service">ejabberd</systemitem> Service + As the root user, stop the ejabberd service: +
+ Commands to stop the <systemitem class="service">ejabberd</systemitem> service + + $ /etc/init.d/ejabberd stop + +
+ If ejabberd reports that it is already stopped, it may have run into a problem starting back at the installation stage. One possible fix is to kill any remaining beam and epmd processes, then edit the configuration file /etc/ejabberd/ejabberd.cfg to hardcode a domain: +
+ Commands to recover from <systemitem class="service">ejabberd</systemitem> errors + + $ su - root + $ epmd -kill + $ killall beam; killall beam.smp + $ rm /var/lib/ejabberd/* + $ echo 'ERLANG_NODE=ejabberd@localhost' >> /etc/default/ejabberd + +
+
+
+ Edit the <systemitem class="service">ejabberd</systemitem> configuration + As the root user, edit the file /etc/ejabberd/ejabberd.cfg and make the following changes: + + Change {hosts, ["localhost"]}. to {hosts, ["localhost", "private.localhost", "public.localhost"]}. + Change {max_user_sessions, 10}. to {max_user_sessions, 1000}. If you see something like this instead: {access, max_user_sessions, [{10, all}]}., then change it to {access, max_user_sessions, [{1000, all}]}. + Change all three occurrences of max_stanza_size to 2000000. + Change both occurrences of maxrate to 500000. + Comment out the line {mod_offline, []} by placing two % comment signs in front. + +
+
+ OpenSRF installation - (continued) + + The remainder of the OpenSRF installation procedure is identical to that for installing the latest version of OpenSRF. Continue with the instructions found in . + +
+
+ +
+ Installing PostgreSQL + In production Evergreen systems, the PostgreSQL database server may reside on the same system on which Evergreen is installed or on another standalone system so, by default, PostgreSQL is not automatically installed along with Evergreen. This section details the steps needed to manually install PostgreSQL on a Ubuntu or Debian system. + If your PostgreSQL server will be on the same system as your Evergreen software, return to the previous section and follow those instructions. Otherwise, to manually install PostgreSQL on a system, continue with the instructions below. + + Some Linux distributions, such as Debian Etch (4.0), do not offer PostgreSQL version 8.2 as an installable package. Before you continue, examine the software dependencies listed in to ensure that your Linux distribution supports the required version of PostgreSQL. + + + + Install the application "stow" on your system if it is not already installed. Issue the following command as the root user: +
+ Installing <application>"stow"</application> + + $ apt-get install stow + ... + +
+ + + Download, compile, and install the latest release for PostgreSQL 8.2 (which was version 8.2.12 at the time of this writing). As the root user, follow these steps: +
+ Installing PostgreSQL + + $ wget http://wwwmaster.postgresql.org/redir/198/h/source/v8.2.17/postgresql-8.2.17.tar.bz2 + $ tar xzf postgresql-8.2.17.tar.gz + $ cd postgresql-8.2.17 + $ ./configure --with-perl --enable-integer-datetimes --with-openssl --prefix=/usr/local/stow/pgsql + ... + $ make + ... + $ make install + ... + $ cd contrib + $ make + ... + $ make install + $ cd xml2 + $ make + ... + $ make install + $ cd /usr/local/stow + $ stow pgsql + +
+ + + Create the new user postgres to run the PostgreSQL processes. As the root user, execute this command: +
+ Adding <systemitem class="username">postgres</systemitem> + + $ adduser postgres + +
+ + + Initialize the database directory and start up PostgreSQL. As the root user, follow these steps: +
+ Adding <systemitem class="username">postgres</systemitem> + + $ mkdir -p /usr/local/pgsql/data + $ chown postgres /usr/local/pgsql/data + $ su - postgres + $ initdb -D /usr/local/pgsql/data -E UNICODE --locale=C + $ pg_ctl -D /usr/local/pgsql/data -l /home/postgres/logfile start + +
+ + If an error occurs during the final step above, review the path of the home directory for the postgres user. It may be /var/lib/postresql instead of /home/postres. + + + + The values of several PostreSQL configuration parameters may be changed for enhanced performance. The following table lists the default values and some suggested updates for several useful parameters: + + Suggested configuration values + + + + + + + Parameter + Default + Suggested + + + + + default_statistics_target + 10 + 100 + + + work_mem + 4Mb + 128Mb + + + shared_buffers + 8Mb + 512Mb + + + effective_cache_size + 128Mb + 4Gb + + + +
+ + ZZZ-REVIEW + ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS + + ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS + + +
+
+ Installing Apache +
+ Securing Apache (httpd) + The main consideration is to secure the directory cgi-bin. The only persons that need access to this directory are Evergreen system administrators. This directory should be restricted by both IP (to those workstations designated as Evergeen Administration systems), and by username/password. + + ZZZ-REVIEW + ADD CONTENT ON HOW TO RESTRICT APACHE BY IP AND USERNAME/PASSWORD + + ADD CONTENT ON HOW TO RESTRICT APACHE BY IP AND USERNAME/PASSWORD + A user could add new libraries, re-arrange consortia, or change user groups; or a staff member could access the directory, and change his associated security group to administrative level privileges. +
+ + ZZZ-REVIEW + ADD MORE CONTENT FOR APACHE + + ADD MORE CONTENT FOR APACHE +
+ diff --git a/1.6/admin/ServersideInstallation.xml b/1.6/admin/ServersideInstallation.xml index 8d09eda..f0bd310 100644 --- a/1.6/admin/ServersideInstallation.xml +++ b/1.6/admin/ServersideInstallation.xml @@ -7,7 +7,6 @@ of the software is straightforward if you follow some simple directions. -
Installing, configuring and testing the Evergreen server-side software is straightforward with the current stable software release. See for instructions tailored to installing on some particular distributions of the Linux operating system. Earlier software distributions are described in . @@ -20,11 +19,7 @@ Linux environment). It can also be installed to run on other Linux systems via virtualized environments (using, for example, "VirtualBox" or "VMware"). More information on virtualized environments can be found in . - 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 and . - Finally, installation of the Evergreen Staff Client software is reviewed in . - - Evergreen Software Dependencies + Installation of the Evergreen Staff Client software is reviewed in . The Evergreen server-side software has dependencies on particular versions of certain major software sub-components. Successful installation of Evergreen software requires that software versions agree with those listed here: @@ -47,39 +42,9 @@ 1.28.2 / 8.3 - - 1.4.x - 1.0 - 8.1 / 8.2 - - - 1.2.x - 0.9 - 8.1 / 8.2 - -
- - - Current Stable Software Release - The current stable release of Evergreen is version 1.6.0.7. Instructions for installing, configuring - and testing that version on the Ubuntu or Debian - Linux systems are found in . - This release of Evergreen software is dependent on the Open Service Request Framework (OpenSRF). The current stable release of OpenSRF is - version 1.2.2. Instructions for installing, configuring and testing that version are found in - . - - - Previous Software Releases - Earlier releases of Evergreen are also available. Instructions for installing, configuring and testing earlier versions are found in - . - The next most recent previous release of Evergreen is version 1.4.0.6. Instructions for installing, configuring - and testing that version are found in . - The accompanying previous release of OpenSRF is version 1.0.7. Instructions for installing, configuring and testing - that version are found in . - -
+
Installing Server-Side Software This section describes the installation of the major components of Evergreen server-side software. @@ -118,7 +83,6 @@ As the root user, add the opensrf user to the system. The default shell for the new user is automatically set to /bin/bash to inherit a reasonable environment: -su - opensrf useradd -m -s /bin/bash opensrf passwd opensrf @@ -128,7 +92,6 @@ As the opensrf user, download and extract the latest version of OpenSRF. The latest version can be found here: -su - opensrf wget http://evergreen-ils.org/downloads/OpenSRF-1.2.2.tar.gz tar zxf OpenSRF-1.2.2.tar.gz @@ -143,7 +106,6 @@ Linux distribution listed in the distribution keywordstable. -su - root cd /home/opensrf/OpenSRF-1.2.2 make -f src/extras/Makefile.install [DISTRIBUTION] @@ -198,7 +160,6 @@ utility to prepare for the next step of compiling and linking the software. You can include the and configuration options if you wish to include support for Python and Java, respectively: -su - opensrf cd /home/opensrf/OpenSRF-1.2.2 ./configure --prefix=/openils --sysconfdir=/openils/conf make @@ -210,7 +171,6 @@ As the root user, return to the OpenSRF build directory and use the make utility to compile, link and install OpenSRF: -su - opensrf cd /home/opensrf/OpenSRF-1.2.2 make install @@ -222,7 +182,6 @@ command ldconfig to automatically read the file and modify the system dynamic library path: -su - root echo "/openils/lib" > /etc/ld.so.conf.d/osrf.conf ldconfig @@ -260,7 +219,6 @@ $ /etc/init.d/ejabberd stop epmd processes, then edit the configuration file /etc/ejabberd/ejabberd.cfg to hardcode a domain: -su - root epmd -kill killall beam; killall beam.smp rm /var/lib/ejabberd/* @@ -314,7 +272,6 @@ $ /etc/init.d/ejabberd stop As the opensrf user, use the example templates to create the configuration files /openils/conf/opensrf_core.xml and /openils/conf/opensrf.xml: -su - root cd /openils/conf cp opensrf.xml.example opensrf.xml cp opensrf_core.xml.example opensrf_core.xml @@ -330,35 +287,33 @@ $ /etc/init.d/ejabberd stop file. - Updates needed in the file <filename>/openils/conf/opensrf_core.xml</filename> - - /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/passwd = password for public.localhost - opensrf user - /config/routers/router/transport (first entry, where - transport/server ==public.localhost) + + /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/passwd = password for public.localhost + opensrf user + /config/routers/router/transport (first entry, where + transport/server ==public.localhost) username = router password = password for public.localhost router user - - /config/routers/router/transport (second entry, where - transport/server == private.localhost) + + /config/routers/router/transport (second entry, where + transport/server == private.localhost) username = router password = password for private.localhost router user - - + You also need to specify the domains from which OpenSRF will accept and to which OpenSRF will make connections. If you are installing OpenSRF on a single server and using the private.localhost / public.localhost domains, these will already be set to @@ -418,7 +373,6 @@ $ /etc/init.d/ejabberd stop As the opensrf user, modify the environmental variable PATH by adding a new file path to the opensrf user's shell configuration file .bashrc: -su - opensrf echo "export PATH=/openils/bin:\$PATH" >> ~/.bashrc @@ -428,13 +382,11 @@ $ /etc/init.d/ejabberd stop As the root user, start the ejabberd and memcached services: -su - root /etc/init.d/ejabberd start /etc/init.d/memcached start Finally, as the opensrf user, start OpenSRF: -su - opensrf start the OpenSRF service: use "-l" to force hostname to be "localhost" osrf_ctl.sh -l -a start_all @@ -459,7 +411,6 @@ $ /etc/init.d/ejabberd stop math service: -su - opensrf /openils/bin/srfsh srfsh# request opensrf.math add 2 2 Received Data: 4 @@ -476,7 +427,6 @@ Request Time in seconds: 0.007519 Stopping OpenSRF As the opensrf user, stop OpenSRF: -su - opensrf osrf_ctl.sh -l -a stop_all @@ -517,7 +467,6 @@ Request Time in seconds: 0.007519 As the opensrf user, download and extract the latest version of Evergreen. The latest version can be found here: -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 @@ -532,7 +481,6 @@ Request Time in seconds: 0.007519 Linux distribution listed in the distribution keywords table. -su - root cd /home/opensrf/Evergreen-ILS-1.6.0.7 make -f Open-ILS/src/extras/Makefile.install [distribution] @@ -596,7 +544,7 @@ Request Time in seconds: 0.007519 (OPTIONAL) Install the PostgreSQL Server 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. - For further information on manually installing PostgreSQL, see . + For further information on manually installing PostgreSQL, visit the PostgreSQL Site. If your PostgreSQL server will be on the same system as your Evergreen software, then as the root user install the required PostgreSQL server packages: su - root @@ -610,14 +558,13 @@ Request Time in seconds: 0.007519 psql. Then type SELECT version(); to get detailed information of your version of PostgreSQL. - - Install Perl Modules on PostgreSQL Server (OPTIONAL) + + Install Perl Modules on PostgreSQL Server If PostgreSQL is running on the same system as your Evergreen software, then the Perl modules will automatically be available. Just skip this step. Otherwise, if your PostgreSQL server is running on another system, then as the root user install the following Perl modules on that system: ensure the gcc compiler is installed: -su - root apt-get install gcc install the Perl modules @@ -627,7 +574,7 @@ Request Time in seconds: 0.007519 cpan> install MARC::Record cpan> install MARC::File::XML - For more information on installing Perl Modules vist the CPAN site. + For more information on installing Perl Modules vist the CPAN site. Update the System Dynamic Library Path @@ -646,10 +593,7 @@ Request Time in seconds: 0.007519 Restart the PostgreSQL Server If PostgreSQL is running on the same system as the rest of Evergreen, as the root user you must restart PostgreSQL. If PostgreSQL is running on another system, you may skip this step. - -su - root -/etc/init.d/postgresql-[PGSQL_VERSION] restart - + /etc/init.d/postgresql-[PGSQL_VERSION] restart Where PGSQL_VERSION is your installed PostgreSQL version (e.g. 8.3). @@ -657,7 +601,6 @@ Request Time in seconds: 0.007519 As the opensrf user, return to the Evergreen build directory and use the configure utility to prepare for the next step of compiling and linking the software: -su - opensrf cd /home/opensrf/Evergreen-ILS-1.6.0.7 ./configure --prefix=/openils --sysconfdir=/openils/conf make @@ -670,7 +613,6 @@ Request Time in seconds: 0.007519 shown below. The Staff Client will also be automatically built, but you must remember to set the variable STAFF_CLIENT_BUILD_ID to match the version of the Staff Client you will use to connect to the Evergreen server. For further information on manually building the Staff Client, see . -su - root cd /home/opensrf/Evergreen-ILS-1.6.0.7 make STAFF_CLIENT_BUILD_ID=rel_1_6_0_7 install @@ -679,7 +621,6 @@ Request Time in seconds: 0.007519 in the head of the Staff Client directory /openils/var/web/xul that points to the subdirectory /server of the new Staff Client build: -su - root cd /openils/var/web/xul ln -sf rel_1_6_0_7/server server @@ -690,7 +631,6 @@ Request Time in seconds: 0.007519 files that you set up in a previous step when you installed and tested OpenSRF. You should also create backup copies of the old files for troubleshooting purposes. Finally, change the ownership on the installed files to the opensrf user: -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 @@ -713,13 +653,12 @@ Request Time in seconds: 0.007519 paths: Create the database: -su - postgres createdb -E UNICODE evergreen createlang plperl evergreen createlang plperlu evergreen createlang plpgsql evergreen - Adjust the paths + Adjust the paths: psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tablefunc.sql evergreen psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tsearch2.sql evergreen @@ -730,12 +669,8 @@ Request Time in seconds: 0.007519 Create a new Evergreen superuser As the postgres user on the PostgreSQL system, create the new database - evergreen user and assign a password: - - -su - postgres -createuser -P -s evergreen - + evergreen user and assign a password: + createuser -P -s evergreen Enter the password twice for new role when prompted. @@ -869,30 +804,26 @@ Request Time in seconds: 0.007519 public.localhost domains, these will already be set to the correct values. Otherwise, search and replace to match your customized values. The following example uses common XPath syntax on the left-hand side to indicate the approximate position needing changes within the XML file: - - /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/passwd = password for public.localhost - opensrf user - /config/routers/router/transport (first entry, where transport/server == public.localhost) + /config/opensrf/username = opensrf + /config/opensrf/passwd = password for private.localhost + opensrf user + /config/gateway/username = opensrf + /config/gateway/passwd = password for public.localhost + opensrf user + /config/routers/router/transport (first entry, where transport/server == public.localhost) username = router password = password for public.localhost router user - - /config/routers/router/transport (second entry, where transport/server == private.localhost) + /config/routers/router/transport (second entry, where transport/server == private.localhost) username = router password = password for private.localhost router user - - + Create Configuration Files for Users Needing <application>"srfsh"</application> @@ -958,7 +889,6 @@ Request Time in seconds: 0.007519 As the root user, start the ejabberd and memcached services (if they are not already running): -su - root /etc/init.d/ejabberd start /etc/init.d/memcached start diff --git a/1.6/admin/StaffclientInstallation.xml b/1.6/admin/StaffclientInstallation.xml index 8463f7f..ead3d03 100644 --- a/1.6/admin/StaffclientInstallation.xml +++ b/1.6/admin/StaffclientInstallation.xml @@ -1,70 +1,61 @@ Installing the Staff Client - You can install the Staff Client from pre-built images and packages without actually having to first build it. Pre-built packages are currently available for Windows, Mac OS X, and Linux. If you need to manually build the Staff Client, see . + You can install the Staff Client from pre-built images and packages without actually having to first build it. Pre-built packages are currently available + for Windows, Mac OS X, and Linux. If you need to manually build + the Staff Client, see .
Installing a Pre-Built Staff Client This section reviews the process of installing pre-built versions of the Staff Client in various environments. -
+ Installing on <systemitem class="osname">Windows</systemitem> - A standard Windows installer that contains the current version of the Staff Client is available from the downloads section of the Evergreen website at http://www.evergreen-ils.org/downloads.php. Download the Staff Client installer, then run it. A screen that looks similar to this should appear: -
- Running the Staff Client installer - - - - - -
- Click Next to continue through the guided install process. The install wizard will ask you to agree to the end-user license, ask you where to install the software, ask about where to place icons, and then will install the software on your workstation. + A standard Windows installer that contains the current version of the Staff Client is available from the downloads section + of the Evergreen website at http://www.evergreen-ils.org/downloads.php. Download the Staff Client installer, + then run it. + Click Next to continue through the guided install process. The install wizard will ask you to agree to the end-user license, ask you where to + install the software, ask about where to place icons, and then will install the software on your workstation. When you run the Staff Client for the first time, a screen similar to this should appear: -
- Running the Staff Client for the first time -
- First, configure the server you would like to connect to in the Server section. For example, the PINES demo system is demo.gapines.org. After selecting a server, click Re-Test Server. - Because this is the initial run of the Staff Client, the Workstation section in the upper-right states: Not yet configured for the specified server. The first thing that must be done to the Staff Client on every workstation is to assign it a workstation name. This is covered in . -
-
+ First, configure the server you would like to connect to in the Server section. For example, the PINES demo system is + demo.gapines.org. After selecting a server, click Re-Test Server. + Because this is the initial run of the Staff Client, the Workstation section in the upper-right states: Not + yet configured for the specified server. The first thing that must be done to the Staff Client on every workstation is to assign it a workstation name. This is + covered in . + + Installing on <systemitem class="osname">Mac OS X</systemitem> - A Mac OS X package that contains the current version of the Staff Client is available for use with "xulrunner". -
+ A Mac OS X package that contains the current version of the Staff Client is available for use with + "xulrunner". + Evergreen Indiana Pkg file [Evergreen v1.2.3.0] - Download and install the latest version of "xulrunner" for Mac OS X. Release notes for the latest version can be found here: http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes. Note, later versions may not work correctly. - Download and install the Mac OS X Installation package for the 1_2_3_0 Version Staff Client from http://evergreen.lib.in.us/opac/extras/files/evergreen_osx_staff_client_1_2_3.zip. - To upgrade to a more recent version of the Staff Client, you can copy the directory build from a working Windows installation of the desired version of the Staff Client to your Mac. The required files may be located in a directory like this on the Windows machine: C:\Program Files\Evergreen Staff Client\build. Copy these files into the folder Resources within the Open-ILS package in your Applications directory on the Mac, overwriting files with the same names. + Download and install the latest version of "xulrunner" for Mac OS X. Release notes + for the latest version can be found here: + http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes. + Note, later versions may not work correctly. + Download and install the Mac OS X Installation package for the 1_2_3_0 Version Staff Client from + + http://evergreen.lib.in.us/opac/extras/files/evergreen_osx_staff_client_1_2_3.zip. + To upgrade to a more recent version of the Staff Client, you can copy the directory build from a working + Windows installation of the desired version of the Staff Client to your Mac. The required files may be located in + a directory like this on the Windows machine: C:\Program Files\Evergreen Staff Client\build + . Copy these files into the folder Resources within the Open-ILS package in your Applications directory on + the Mac, overwriting files with the same names. Drag the application's icon into your toolbar for easier access. - When you run the Staff Client installer, a screen will appear that looks similar to this: -
- Running the Staff Client installer - - - - - -
- FIX BAD LINK: http://es.zionsville.lib.in.us/atheos/eg_osx_a.gif - Click Continue, accept the license, then finish the installation. The application will be located at the destination you selected during installation. You will then be able to drag the application into your toolbar for easier access. -
- Finishing the installation - - - - - -
- FIX BAD LINK: http://es.zionsville.lib.in.us/atheos/eg_osx_a.gif -
-
+ + Click Continue, accept the license, then finish the installation. The application will be located at the destination you selected + during installation. You will then be able to drag the application into your toolbar for easier access. + + Running directly using <application>"xulrunner"</application> - You must install an appropriate version of "xulrunner" to match the Evergreen version. See the following table for the recommended version of "xulrunner": + You must install an appropriate version of "xulrunner" to match the Evergreen version. See the following table for the recommended + version of xulrunner: Evergreen / XULRunner Dependencies @@ -86,60 +77,54 @@
- If you have issues removing previously installed "xulrunner" versions see for information on removing previous "XULRunner" versions. - The Staff Client data from the directory ./staff_client/build must be placed somewhere on the machine (e.g. ~/Desktop/Evergreen_Staff_Client). Remember to call "XULRunner" with the full path to the binary, followed by the install command and the path to the client data. See the following command: -
- Executing <application>"xulrunner"</application> - - /Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_Client - -
- This command should exit quietly. A folder will be created, named /Applications/OpenILS, containing a launcher named open_ils_staff_client. -
-
- Removing previously installed <application>"xulrunner"</application> versions - If you already have a newer version installed, per the release notes, you will need to remove the entire directory /Library/Frameworks/XUL.framework before downgrading. + If you have issues removing previously installed xulrunner versions see + for information on removing previous "XULRunner" versions. + The Staff Client data from the directory ./staff_client/build must be placed somewhere on the machine (e.g. + ~/Desktop/Evergreen_Staff_Client). Remember to call XULRunner with the full path to the binary, followed by + the install command and the path to the client data: + +/Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_Client + + This command should exit quietly. A folder will be created, named /Applications/OpenILS, containing a launcher + named open_ils_staff_client. + + + Removing previously installed <application>xulrunner</application> versions + If you already have a newer version installed, per the release notes, you will need to remove the entire directory + /Library/Frameworks/XUL.framework before downgrading. In addition, you may also need to remove the previous file /Library/Receipts/xulrunner-ver-mak.pkg. - If there is no file /Library/Receipts/xulrunner-ver-mak.pkg (possibly in newer OSX releases) you need to flush the file receiptdb. - If you install a newer version over a previous (older) install, the older one is not removed but the symlinks get changed to the newer one. + If there is no file /Library/Receipts/xulrunner-ver-mak.pkg (possibly in newer OSX releases) you need to flush the file + receiptdb. + If you install a newer version over a previous (older) install, the older one is not removed but the symlinks get changed to the newer one. First, get the package identifier, then purge/forget the build that was initially installed: -
- Purging previous build - - sudo pkgutil --pkgs > /tmp/pkgs.txt - sudo pkgutil --forget org.mozilla.xulrunner - -
- It may not be necessary to edit the file /Library/Receipts/InstallHistory.plist after deleting the folder XUL.framework. -
-
+ +sudo pkgutil --pkgs > /tmp/pkgs.txt +sudo pkgutil --forget org.mozilla.xulrunner + + It may not be necessary to edit the file /Library/Receipts/InstallHistory.plist after deleting the folder + XUL.framework. + + Creating an APP file: Staff Client & <application>"xulrunner"</application> Bundled - An APP file is basically a folder. Start with a folder structure like this: -
- Sample APP file folder structure - - * Evergreen.app - * Contents - * Frameworks - * Resources - * MacOS - -
+ An APP file is basically a folder. Start with a folder structure like this: + +* Evergreen.app + * Contents + * Frameworks + * Resources + * MacOS + Create an APP folder structure with the following commands: -
- Creating a folder structure - - mkdir -p Evergreen.app/Contents/Frameworks - mkdir -p Evergreen.app/Contents/Resources - mkdir -p Evergreen.app/Contents/MacOS - -
+ +mkdir -p Evergreen.app/Contents/Frameworks +mkdir -p Evergreen.app/Contents/Resources +mkdir -p Evergreen.app/Contents/MacOS + - Create a new file in the folder Evergreen.app/Contents/Info.plist containing the following data (adjust for your version of Evergreen): - - + Create a new file in the folder Evergreen.app/Contents/Info.plist containing the following data (adjust for your + version of Evergreen): @@ -168,8 +153,9 @@ ]]> - Download and install an appropriate Mac OS Xpackage of "XULRunner" from - the Mozilla website (see above for recommendations). + + Download and install an appropriate Mac OS Xpackage of "XULRunner" from + the Mozilla website (see above for recommendations). Make a copy of /Library/Frameworks/XUL.Framework inside your APP file. It should look something like this: @@ -186,31 +172,28 @@ ______* libxpcom.dylib -> Versions/Current/libxpcom.dylib ______* xulrunner-bin -> Versions/Current/xulrunner-bin - Copy XUL.Framework/Versions/Current/xulrunner into Evergreen.app/MacOS - (do not symlink; copy the file). + Copy XUL.Framework/Versions/Current/xulrunner into Evergreen.app/MacOS + (do not symlink; copy the file). Make Evergreen.app/Resources the root of your Evergreen application files like this: -
- Example APP file - - * Evergreen.app/ - __* Contents/ - ____* Resources/ - ______* BUILD_ID - ______* application.ini - ______* chrome/ - ______* components/ - ______* etc. - -
+ +* Evergreen.app/ +__* Contents/ +____* Resources/ +______* BUILD_ID +______* application.ini +______* chrome/ +______* components/ +______* etc. + Put a Mac format icon file named Evergreen.icns in Resources. -
-
-
+ + + Installing on <systemitem class="osname">Linux</systemitem> -
+ Quick Upgrade of the Staff Client A Linux Staff Client is automatically built on the server as part of the normal make install process for Evergreen server-side software. To upgrade the Staff Client on a remote workstation with a new version, @@ -222,19 +205,14 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin As the opensrf user, change directory to the Staff Client source directory, then recursively copy the entire directory tree to the remote workstation: -su - opensrf cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client scp -r build user@client.linux.machine:~/eg-client-x.x.x.x/ To test the newly copied Staff Client, as the opensrf user log into the remote workstation and execute it as shown: - -su - opensrf -xulrunner ~/eg-client-x.x.x.x/build/application.ini - - -
-
+ xulrunner ~/eg-client-x.x.x.x/build/application.ini + + Building the Staff Client on the Server A Linux Staff Client is automatically built on the server as part of the normal make install process for Evergreen server-side software. @@ -248,12 +226,11 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin server to work together, the BUILD_ID must match the name of the directory containing the server components of the Staff Client, or the name of a symbolic link to that directory. -su - root cd /openils/var/web/xul ln -s SERVER_BUILD_ID/ CLIENT_BUILD_ID -
-
+ + Building the Staff Client on the client Machine This section is directed toward end-users who wish to use Linux rather than Windows for client machines, but have limited Linux experience. You can @@ -280,16 +257,24 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin Determine which version is needed - For most end-users, a specific version is required to communicate properly with the Evergreen server. Check with your system administrator, IT person, or HelpDesk to determine which Staff Client versions are supported. - Next, you need to determine which tag to use when downloading the source code. Tags are markers in the source code to create a snapshot of the code as it existed at a certain time; tags usually point to tested and stable code, or at least a community-recognized release version. - To determine which tag to use, browse to http://svn.open-ils.org/trac/ILS/browser. Look in the Visit drop-down box; see the list of Branches and, further down, a list of Tags. You may have to do some guesswork, but it is fairly straightforward to determine which tag to use. If the server is version 1.2.1.4, you will want to use the tag that looks most appropriate. For example, as you look through the tag list, notice the tag named 'rel_1_2_1_4'. This is the tag you need; make a note of it for the next step. + For most end-users, a specific version is required to communicate properly with the Evergreen server. Check with your + system administrator, IT person, or HelpDesk to determine which Staff Client versions are supported. + Next, you need to determine which tag to use when downloading the source code. Tags are markers in the + source code to create a snapshot of the code as it existed at a certain time; tags usually point to tested and stable code, or at + least a community-recognized release version. + To determine which tag to use, browse to + http://svn.open-ils.org/trac/ILS/browser. Look in the + Visit drop-down box; see the list of Branches and, further down, a list of Tags. You may have to do some + guesswork, but it is fairly straightforward to determine which tag to use. If the server is version 1.2.1.4, you will want to use the + tag that looks most appropriate. For example, as you look through the tag list, notice the tag named 'rel_1_2_1_4'. This is the + tag you need; make a note of it for the next step. Download the Code - As the opensrf user, open a terminal (command-line prompt) and navigate to the directory in which you wish to download the Staff Client. Use the following commands to download the proper version of the source code by tag name: - + As the opensrf user, open a terminal (command-line prompt) and navigate to the directory + in which you wish to download the Staff Client. Use the following commands to download the proper version of the source code by tag + name: -su - opensrf cd /YOUR/DOWNLOAD/DIRECTORY svn co svn://svn.open-ils.org/ILS/tags/rel_1_2_1_4/ @@ -301,11 +286,14 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin Build the Staff Client
Evergreen 1.2.x - In the following example, navigate to the directory in which the source code was downloaded, then navigate to the proper subdirectory and run the make utility to actually build the Staff Client. Remember to check with your system administrator about which Staff Client BUILD_ID to use. The server checks the Staff Client BUILD_ID against itself to determine whether or not a connecting client is supported. For instance, for the PINES installation (version 1.2.1.4) the supported BUILD_ID is rel_1_2_1_4. Modify the following commands accordingly. + In the following example, navigate to the directory in which the source code was downloaded, then navigate to the proper subdirectory and + run the make utility to actually build the Staff Client. Remember to check with your system administrator about which + Staff Client BUILD_ID to use. The server checks the Staff Client BUILD_ID against itself to determine whether or not a connecting client + is supported. For instance, for the PINES installation (version 1.2.1.4) the supported BUILD_ID is rel_1_2_1_4. Modify + the following commands accordingly. As the opensrf user, run the following commands to build the Staff Client: -su - opensrf cd /YOUR/DOWNLOAD/DIRECTORY cd Open-ILS/xul/staff_client make STAFF_CLIENT_BUILD_ID='rel_1_2_1_4' @@ -314,11 +302,11 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin
Evergreen 1.4.x - The 1.4 series of Evergreen has complicated the build process for the Staff Client a bit. If you downloaded a .tar.gz (compressed tar archive) of Evergreen, then your steps will resemble the following: + The 1.4 series of Evergreen has complicated the build process for the Staff Client a bit. If you downloaded a .tar.gz (compressed + tar archive) of Evergreen, then your steps will resemble the following: FIXME -- Need instructions for getting certain Javascript files from OpenSRF, preferably without actually installing OpenSRF. -su - opensrf wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.4.0.4.tar.gz tar xfz Evergreen-ILS-1.4.0.4.tar.gz cd Evergreen-ILS-1.4.0.4/ @@ -330,7 +318,6 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin If you're installing from a Subversion checkout: -su - opensrf svn co svn://svn.open-ils.org/ILS/tags/rel_1_4_0_4/ cd rel_1_4_0_4 ./autogen.sh # If you downloaded a .tar.gz of Evergreen, you may skip this step @@ -343,59 +330,54 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin Run the Staff Client (from the command line) - As the opensrf user, navigate to the directory build/ (not staff_client/) and run the following command: - -su - opensrf -xulrunner application.ini - + As the opensrf user, navigate to the directory build/ + (not staff_client/) and run the following command: + xulrunner application.ini (OPTIONAL) Cleaning Up / Creating Shortcuts The source code download included many files that are needed to build the Staff Client, but are not necessary to run it. You may wish to remove them to save space, or to create a clean directory containing the built Staff Client that can be copied to other machines. To - create a clean "staging" directory in which to place the finished Staff Client, issue the following commands: + create a clean "staging" directory in which to place the finished Staff Client, issue the following commands: + mkdir ~/<Destination Directory> cd ~/<Download Directory>/Open-ILS/xul/ cp -r staff_client ~/<Destination Directory~/> Finally, test the Staff Client to verify that all the necessary files were moved to the destination directory: - + cd ~/<Destination Directory>/staff_client/build xulrunner application.ini - If there were no problems, then finish the cleanup by removing the original download directory and all subdirectories: - -rm -r -f ~/<Download Directory> - - + rm -r -f ~/<Download Directory> Finally, test the copied Staff Client. You can create "Desktop / Start Menu / K-Menu" shortcuts for the Staff Client by using the following command as the target: xulrunner ~/<Destination Directory>/staff_client/build/application.ini - - + -
-
+ + Using <application>"Wine"</application> to Install On Linux - The Linux application "Wine" is another alternative for those who wish to install the packaged Windows versions rather than building the Staff Client manually. "Wine" is a Linux application that allows users to directly run Windows executables, and is a simple way for casual Linux users to use the Staff Client. More information about "Wine" can be found at http://www.winehq.org/site/docs/wineusr-guide/getting-wine. - As the root user, use "apt-get" to install the package for "Wine". You can also use "synaptic", the graphical user interface. + The Linux application "Wine" is another alternative for those who wish to install the + packaged Windows versions rather than building the Staff Client manually. "Wine" is a + Linux application that allows users to directly run Windows executables, and is a simple + way for casual Linux users to use the Staff Client. More information about "Wine" can be found at + http://www.winehq.org/site/docs/wineusr-guide/getting-wine. + As the root user, use "apt-get" to install the package for "Wine". + You can also use "synaptic", the graphical user interface. - Install "Wine" - - -sudo apt-get install wine - + Install "Wine" + sudo apt-get install wine Download Windows installer for the Staff Client As the opensrf user, run the following commands to download the Windows installer for the proper Staff Client from the open-ils.org website and place it in a temporary directory: -su - opensrf cd /YOUR/DOWNLOAD/DIRECTORY wget http://open-ils.org/downloads/evergreen-setup-rel_version-number.exe @@ -403,84 +385,100 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin Run the downloaded Windows installer - As the opensrf user, navigate to the directory where you downloaded the Windows executable file, then execute it: + As the opensrf user, navigate to the directory where you downloaded the + Windows executable file, then execute it: -su - opensrf cd /YOUR/DOWNLOAD/DIRECTORY wine evergreen-setup-rel_version-number.exe - If this step fails, you may need to configure Wine first to properly emulate WindowsXP. To do so, type the command winecfg from the command line; in the Applications tab of the window that pops up, select Default Settings and choose Windows XP from the drop-down menu, then click Apply. + If this step fails, you may need to configure Wine first to properly emulate WindowsXP. To do so, type + the command winecfg from the command line; in the Applications tab of the window that pops up, + select Default Settings and choose Windows XP from the drop-down menu, then click + Apply. Launch the Staff Client - A new entry for the Staff Client should now appear somewhere in the All Applications menu of your Linux desktop. Also, find a new desktop shortcut for the Staff Client. To launch the Staff Client, visit the All Applications menu, find a section similar to WineProgram FilesEvergreen Staff ClientEvergreen Staff Client -, or else launch the Staff Client from the desktop shortcut. + A new entry for the Staff Client should now appear somewhere in the All Applications menu of your + Linux desktop. Also, find a new desktop shortcut for the Staff Client. To launch the Staff Client, visit + the All Applications menu, find a section similar to Wine + Program FilesEvergreen Staff ClientEvergreen Staff Client + , or else launch the Staff Client from the desktop shortcut. -
-
+ + Running the Staff Client over an SSH Tunnel The Staff Client can use an SSH tunnel as a SOCKS 5 proxy. For more details, see . -
-
-
+ + + Assigning Workstation Names - The Staff Client must be assigned to a library and given a unique name before it will connect fully to the Evergreen server. The only restriction is that the workstation's name must be unique within the assigned library. Make sure to select a workstation name that you will remember later, and reflects the role, purpose, and/or location of a particular computer. These names will come up later in statistical reporting, and can also be handy when troubleshooting. - - - - - - In order to assign a workstation a name, a user with appropriate permissions must login to the Staff Client. In PINES, the local system administrator (OPSM) has the ability to assign workstation names in his or her library system. Library managers (LIBM's) have the ability within their branch. To assign a workstation a name, login to the system. You will be prompted to assign the workstation a library and a name: - - - - - - Select the library this workstation physically operates in from the drop down menu. In this example, we have selected MGRL-MA. Type in a friendly name for the workstation. In this example, we are installing the Staff Client on the director's personal system, and have named it as such. Then hit Register. + The Staff Client must be assigned to a library and given a unique name before it will connect fully to the Evergreen server. The only restriction is that the + workstation's name must be unique within the assigned library. Make sure to select a workstation name that you will remember later, and reflects the role, purpose, and/or + location of a particular computer. These names will come up later in statistical reporting, and can also be handy when troubleshooting. + + + + + + In order to assign a workstation a name, a user with appropriate permissions must login to the Staff Client. In PINES, the local system administrator (OPSM) has the + ability to assign workstation names in his or her library system. Library managers (LIBM's) have the ability within their branch. To assign a workstation a name, login to + the system. You will be prompted to assign the workstation a library and a name: + + + + + + Select the library this workstation physically operates in from the drop down menu. In this example, we have selected MGRL-MA. Type in a friendly name + for the workstation. In this example, we are installing the Staff Client on the director's personal system, and have named it as such. Then hit + Register. Once you have registered your workstation with the server, your screen will look like this: - - - - - + + + + + You are now ready to log into the Staff Client for the first time. Type in your password again, and hit Login. -
+
Manually Building the Staff Client This section reviews the process of manually building the Staff Client in various environments. - The Staff Client is automatically built by default as part of the normal make install process for Evergreen server-side software. See to review details related to building the Staff Client in the final compile/link/install phase of the default Evergreen build process. -
+ The Staff Client is automatically built by default as part of the normal make install process for Evergreen server-side software. See + to review details related to building the Staff Client in the final compile/link/install phase of the default Evergreen + build process. + Building the Staff Client - You can also manually build the Staff Client by using the make utility in the Staff Client source directory (e.g., the directory /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client for the current Evergreen version). There are a number of possible options to manually build special versions of the Staff Client on a Linux system. Following is a list of environment variables that can be passed to make to influence the manual build process: -
+ You can also manually build the Staff Client by using the make utility in the Staff Client source directory (e.g., the directory + /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client for the current Evergreen version). There are a number of possible options + to manually build special versions of the Staff Client on a Linux system. Following is a list of environment variables that can be passed + to make to influence the manual build process: + Option STAFF_CLIENT_BUILD_ID - During the normal make install Evergreen server-side software build process, the variable defaults to an automatically generated date/time string, but you can also override the value of BUILD_ID. + During the normal make install Evergreen server-side software build process, the variable defaults to an automatically generated + date/time string, but you can also override the value of BUILD_ID. The following commands could be used during the normal build process: -su - root cd /home/opensrf/Evergreen-ILS-1.6.0.7 make STAFF_CLIENT_BUILD_ID=rel_1_6_0_7 install -... The following commands will manually build the Staff Client using a different BUILD_ID. As the opensrf user, change directory to the Staff Client source directory, then set the variable and build the Staff Client: -su - opensrf cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client make STAFF_CLIENT_BUILD_ID=my_test_id build ... -
-
+ + Option STAFF_CLIENT_VERSION - During the normal make install Evergreen server-side software build process, the variable is pulled automatically from a README file in the Evergreen source root. The variable defaults to 0trunk.revision, where the value of revision is automatically generated. You can override the value of VERSION similarly to the BUILD_ID. + During the normal make install Evergreen server-side software build process, the variable is pulled automatically from a README file in + the Evergreen source root. The variable defaults to 0trunk.revision, where the value of revision is automatically generated. You + can override the value of VERSION similarly to the BUILD_ID. The following commands could be used during the normal build process: -$ su - root $ cd /home/opensrf/Evergreen-ILS-1.6.0.7 $ make STAFF_CLIENT_VERSION=0mytest.200 install ... @@ -488,26 +486,23 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin The following commands will manually build the Staff Client using a different VERSION. If you plan to make extensions update automatically, the VERSION needs to conform to the format recommended in - Toolkit Version Format and newer versions need to be "higher" + Toolkit Version Format and newer versions need to be higher than older versions. - As the opensrf user, change directory to the Staff Client source directory, then set the variable and build the Staff Client: + As the opensrf user, change directory to the Staff Client source directory, then set the variable and build the + Staff Client: -su - opensrf cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client make STAFF_CLIENT_VERSION=0mytest.200 build -... -
-
+ + Option STAFF_CLIENT_STAMP_ID variable During the normal make install Evergreen server-side software build process, this variable is generated from STAFF_CLIENT_VERSION. You can override the value of STAMP_ID similarly to the BUILD_ID. The following commands could be used during the normal build process: -su - root cd /home/opensrf/Evergreen-ILS-1.6.0.7 make STAFF_CLIENT_STAMP_ID=my_test_stamp install -... The following commands will manually build the Staff Client using a different STAMP_ID. It is possible to have multiple versions of the Staff Client by specifying a different STAMP_ID for each, possibly for different uses or @@ -515,14 +510,12 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin As the opensrf user, change directory to the Staff Client source directory, then set the variable and build the Staff Client: -su - opensrf cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client make STAFF_CLIENT_STAMP_ID=my_test_stamp build -... -
-
-
+ + + Advanced Build Options In addition to the basic options listed above, there are a number of advanced options for building the Staff Client. Most are target names for the make utility and require that you build the Staff Client from its source directory. See the following table for a list of possible @@ -599,64 +592,52 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin As the opensrf user, run make from the Staff Client source directory: Commands to do a "developer build" -su - opensrf cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client make devbuild -... Compressed Javascript - You can execute the Google application "Closure Compiler" to automatically review and compress Javascript code after the build process completes, by substituting compress-javascript for build when running make. For more information see Google "Closure Compiler". + You can execute the Google application "Closure Compiler" to automatically review and compress Javascript code after the + build process completes, by substituting compress-javascript for build when running make. + For more information see Google "Closure Compiler". As the opensrf user, run the following commands from the Staff Client source directory: -su - opensrf cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client make compress-javascript -... You can also combine Javascript review and compression, and also perform a "developer build". As the opensrf user, run the following commands from the Staff Client source directory: - -su - opensrf cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client - # order of options is important! make devbuild compress-javascript -... Automatic Update Host The host used to check for automatic Staff Client updates can be overridden by specifying the AUTOUPDATE_HOST option. The following commands could have been used during the normal build process: -
- Commands to set AUTOUPDATE_HOST for normal Evergreen build - - $ su - root - $ cd /home/opensrf/Evergreen-ILS-1.6.0.7 - $ make AUTOUPDATE_HOST=localhost install - ... - -
+ +cd /home/opensrf/Evergreen-ILS-1.6.0.7 +make AUTOUPDATE_HOST=localhost install + + You can manually set AUTOUPDATE_HOST to set up automatic update checking. The following commands will manually build the Staff Client using a different AUTOUPDATE_HOST. As the opensrf user, change directory to the Staff Client source directory, then set the variable and build the Staff Client: -su - opensrf cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client make AUTOUPDATE_HOST=localhost build -... For more information on Automatic Updates, see . -
-
+ + Installing and Activating a Manually Built Staff Client The Staff Client is automatically built, installed and activated as part of the normal make install process for Evergreen server-side software. However, if you manually build the Staff Client, then you need to take additional steps to properly install and activate it. You also have the option @@ -664,34 +645,44 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin Assuming you have already built the Staff Client, and that your installation is in the directory /openils/var/web/xul, as the opensrf user, change directory to the Staff Client source directory, then execute the following commands: -su - opensrf cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client mkdir -p "/openils/var/web/xul/$(cat build/BUILD_ID)" cp -R build/server "/openils/var/web/xul/$(cat build/BUILD_ID)" -
-
+ + Packaging the Staff Client - Once the Staff Client has been built, you can create several forms of client packages by using some targeted make commands in the Staff Client source directory. + Once the Staff Client has been built, you can create several forms of client packages by using some targeted make commands in the Staff + Client source directory. Packaging a Generic Client - This build creates a Staff Client packaged as an XPI file to use with XULRunner. It requires that you already have the "zip" utility installed on your system. It will create the output file evergreen_staff_client.xpi, suitable for use with the XULRunner option . - As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: + This build creates a Staff Client packaged as an XPI file to use with XULRunner. It requires that you already have + the "zip" utility installed on your system. It will create the output file evergreen_staff_client.xpi, + suitable for use with the XULRunner option . + As the opensrf user, change directory to the Staff Client source directory, + then execute the following commands: -su - opensrf cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client make generic-client -... Packaging a Windows Client - This build creates a Staff Client packaged as a Windows executable. It requires that you already have the "unzip" utility installed on your system. It also requires that you install NSIS (Nullsoft Scriptable Install System), a professional open source utility package used to create Windows installers (the "makensis" utility is installed as part of the "nsis" package). We recommend using Version 2.45 or later. This build will create the output file evergreen_staff_client_setup.exe. - (OPTIONAL) If you wish for the Staff Client to have a link icon/tray icon by default, you may wish to provide a pre-modified xulrunner-stub.exe. Place it in the Staff Client source directory and "make" will automatically use it instead of the one that comes with the downloaded XULRunner release. The version of xulrunner-stub.exe need not match exactly. - (OPTIONAL) You can also use a tool such as Resource Hacker to embed icons. "Resource Hacker" is an open-source utility used to view, modify, rename, add, delete and extract resources in 32bit Windows executables. See the following table for some useful icon ID strings: + This build creates a Staff Client packaged as a Windows executable. It requires that you already have + the "unzip" utility installed on your system. It also requires that you install NSIS + (Nullsoft Scriptable Install System), a professional open source utility package used to create Windows + installers (the "makensis" utility is installed as part of the "nsis" package). We recommend using + Version 2.45 or later. This build will create the output file evergreen_staff_client_setup.exe. + (OPTIONAL) If you wish for the Staff Client to have a link icon/tray icon by default, you may wish to provide a pre-modified + xulrunner-stub.exe. Place it in the Staff Client source directory and "make" will automatically use it instead + of the one that comes with the downloaded XULRunner release. The version of xulrunner-stub.exe need not match + exactly. + (OPTIONAL) You can also use a tool such as Resource Hacker to embed icons. + Resource Hacker is an open-source utility used to view, modify, rename, add, delete and extract resources in 32bit + Windows executables. See the following table for some useful icon ID strings: Useful icon ID strings @@ -711,10 +702,8 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin
As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: -su - opensrf cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client make win-client -... @@ -726,10 +715,8 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin -su - opensrf cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client make linux-client -... @@ -740,20 +727,18 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: -su - opensrf cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client make extension -... -
-
+ + Staff Client Automatic Updates It is possible to set up support for automatic Staff Client updates, either during the normal Evergreen server-side build process, or by manually building the Staff Client with certain special options. -
+ WARNINGS Automatic update server certificate requirements are more strict than normal server requirements. Firefox and XULRunner will both ignore any automatic update server that is not validated by a trusted certificate authority. @@ -766,8 +751,8 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin You can pre-install the signing key into the file install.rdf directly, or install it into a copy as install.mccoy.rdf. If the latter exists it will be copied into the build instead of the original file install.rdf. -
-
+ + Autoupdate Host The name of the automatic update host can be provided in either of two ways: @@ -782,11 +767,9 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin As the opensrf user, use the configure utility as shown: -su - opensrf cd /home/opensrf/Evergreen-ILS-1.6.0.7 ./configure --prefix=/openils --sysconfdir=/openils/conf --with-updateshost=hostname make -... @@ -798,62 +781,49 @@ ______* xulrunner-bin -> Versions/Current/xulrunner-bin If neither option is used then, by default, the Staff Client will not include the automatic update preferences. -
-
+ + Building Updates Similar to building clients, the targets generic-updates, win-updates, linux-updates, and extension-updates can be used individually with make to build the update files for the Staff Client. To build all the targets at once, simply use the target updates. A "full" update will be built for each specified target (or for all if you use the target updates). For all but extensions - any previous "full" updates (archived by default in the directory /openils/var/updates/archives) will be used to - make "partial" updates. Partial updates tend to be much smaller and will thus download more quickly, but if something goes wrong with a partial update the + any previous full updates (archived by default in the directory /openils/var/updates/archives) will be used to + make partial updates. Partial updates tend to be much smaller and will thus download more quickly, but if something goes wrong with a partial update the full update will be used as a fallback. Extensions do not currently support partial updates. As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: - -su - opensrf -cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client + cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client + Command to build all updates at once: + make updates + Commands to build updates individually: -# command to build all updates at once: -make updates -... - -# commands to build updates individually: + make generic-updates -... make win-updates -... make linux-updates -... make extension-updates -... -
-
+ + Building updates with clients - To save time and effort you can build updates and manual download clients at the same time by adding the string "-client" to each target name. For instance, you can specify win-updates-client. You can also specify updates-client to build all the targets at once. This does not work for extension-updates. + To save time and effort you can build updates and manual download clients at the same time by adding the string "-client" to each target name. For instance, you + can specify win-updates-client. You can also specify updates-client to build all the targets at once. This does not work for + extension-updates. The clients will be installed alongside the updates and listed on the web page manualupdate.html, rather than left in the Staff Client directory. As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: - + cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client + Command to build all updates at once: + make updates-client + Commands to build updates individually: -$ su - opensrf -cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client - -# command to build all updates at once: -make updates-client -... - -# commands to build updates individually: make generic-updates-client -... make win-updates-client -... make linux-updates-client -... -
-
+ + Activating the Update Server This section reviews scripts associated with the update server, and requires some final adjustments to file permissions. The Apache example configuration creates a directory updates that, by default, points to the directory @@ -865,38 +835,39 @@ $ su - opensrf The following scripts should be marked as executable: check, download, manualupdate.html, update.rdf. As the root user, change directory to the updates directory, then execute the following commands: -su - root cd /openils/var/updates/pub chmod +x check download manualupdate.html update.rdf -
-
-
+ + + Other tips -
+ Multiple workstations on one install - Multiple workstation registrations for the same server can be accomplished with a single Staff Client install by using multiple profiles. When running XULRunner you can specify the option or (uppercase "P") to force the Profile Manager to start. Unchecking the option will make this the default. - Once you have opened the Profile Manager you can create additional profiles, one for each workstation you wish to register. You may need to install SSL exceptions for each profile. - When building targets win-client, win-updates-client, or updates-client, you can specify NSIS_EXTRAOPTS=-DPROFILES to add an "Evergreen Staff Client Profile Manager" option to the start menu. + Multiple workstation registrations for the same server can be accomplished with a single Staff Client install by using multiple profiles. When + running XULRunner you can specify the option or (uppercase "P") to force the Profile Manager + to start. Unchecking the option will make this the default. + Once you have opened the Profile Manager you can create additional profiles, one for each workstation you wish to register. You may need to install SSL exceptions + for each profile. + When building targets win-client, win-updates-client, or updates-client, you can + specify NSIS_EXTRAOPTS=-DPROFILES to add an "Evergreen Staff Client Profile Manager" option to the start menu. As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: -su - opensrf cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client make NSIS_EXTRAOPTS=-DPROFILES win-client -... -
-
+ + Multiple Staff Clients This may be confusing if you are not careful, but you can log in to multiple Evergreen servers at the same time, or a single Evergreen server multiple times. In either case you will need to create an additional profile for each additional server or workstation you want to log in as (see previous tip). Once you have created the profiles, run XULRunner with the option (in addition to or if needed). Instead of XULRunner opening a new login window on your existing session it will start a new session instead, which can then be logged in to a different server or workstation ID. -
-
+ +
Running the Staff Client @@ -904,10 +875,7 @@ $ su - opensrf default with Firefox version 3.0 and later on Ubuntu and Debian distributions). For example, if the source files for the Evergreen installation are in the directory /home/opensrf/Evergreen-ILS-1.6.0.7/, start the Staff Client as shown in the following command example: - -su - opensrf -xulrunner /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client/build/application.ini - + xulrunner /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client/build/application.ini
Configuring a Proxy for the Staff Client @@ -915,7 +883,7 @@ $ su - opensrf servers. In addition to providing excellent data security, this method also buffers and caches data traveling to and from the Staff Client and can speed up access to resources on remote Evergreen servers. This is important if your system architecture includes many Staff Clients and Evergreen servers in a busy environment, through network firewalls, or must operate over insecure networks. -
+ Why Use a Proxy for the Staff Client? There are several reasons for sending network traffic for the Staff Client through an SSH proxy: @@ -925,8 +893,8 @@ $ su - opensrf This is especially true when wireless is otherwise the best option for connecting a staff machine to the network. You may wish to buffer and cache data from remote Evergreen servers to speed up access from Staff Clients. -
-
+ + Setting Up an SSH Tunnel You will need a server that has network access to the Evergreen server you want to reach, and allows you to log in there via SSH. Use your username and password for that SSH server to set up a tunnel. @@ -947,8 +915,8 @@ $ su - opensrf Use the menu on the left to go back to "Session", and enter the host name of the SSH server. A window will open up so that you can enter your username and password. Once you are logged in, the tunnel is open. -
-
+ + Configuring the Staff Client to Use the SSH Tunnel In order to tell the Staff Client that all traffic should be sent through the SSH tunnel just configured, you must edit the file C:\Program Files\Evergreen Staff Client\greprefs\all.js. Search this file for the word socks to @@ -972,6 +940,6 @@ $ su - opensrf If everything is working correctly, you should now be able to run the Staff Client and all its data will be sent encrypted through the SSH tunnel you have just configured. -
+
diff --git a/1.6/admin/Upgrading-Evergreen_1.6.xml b/1.6/admin/Upgrading-Evergreen_1.6.xml index a194b37..bd39174 100644 --- a/1.6/admin/Upgrading-Evergreen_1.6.xml +++ b/1.6/admin/Upgrading-Evergreen_1.6.xml @@ -2,14 +2,23 @@ - Upgrading Evergreen from 1.4 to 1.6.0.8 + Upgrading Evergreen from 1.4 to 1.6.1 This Chapter will explain the step-by-step process of upgrading Evergreen - from version 1.4 to 1.6, including steps to upgrade OpenSRF. Before + from version 1.4 to 1.6.1, including steps to upgrade OpenSRF. Before upgrading, it is important to carefully plan an upgrade strategy to minimize system downtime and service interruptions. All of the steps in this chapter are to be completed from the command line. + In the following instructions, you are asked to perform certain steps as either the root or opensrf user. + + Debian: To become the root user, issue the su command and enter the password of the + root user. + Ubuntu: To become the root user, issue the sudo su command and enter the password of your current user. + + To switch from the root user to a different user, issue the su - [user] command; for example, + su - opensrf. Once you have become a non-root user, to become the root user again simply issue the exit command. + In the following instructions, /path/to/OpenSRF/ represents the path to the OpenSRF source directory. Stop Evergreen and back up data. @@ -34,14 +43,16 @@ - Upgrade OpenSRF<indexterm><primary>OpenSRF</primary><secondary>1.2</secondary></indexterm> to 1.2 + Upgrading OpenSRF to 1.4OpenSRF1.2 As the opensrf user, download and extract the source files for OpenSRF - 1.2: - wget http://open-ils.org/downloads/OpenSRF-1.2.2.tar.gz - tar xzf OpenSRF-1.2.2.tar.gz - A new directory OpenSRF-1.2.2 will be created + 1.4: + +wget http://open-ils.org/downloads/OpenSRF-1.4.0.tar.gz +tar xzf OpenSRF-1.4.0.tar.gz + + A new directory OpenSRF-1.4.0 is created. For the latest edition of OpenSRF, check the Evergreen download page at . @@ -49,9 +60,10 @@ As the root user, install the software prerequisites using the automatic prerequisite installer. - aptitude install make - cd /home/opensrf/OpenSRF-1.2.2 - + +aptitude install make +cd /home/opensrf/OpenSRF-1.4.0 + Replace below with the following value for your distribution: @@ -78,8 +90,15 @@ for Ubuntu Karmic Koala (9.10) + + for Ubuntu Lucid Lynx + (10.04) + - make -f src/extras/Makefile.install + +cd /path/to/OpenSRF +make -f src/extras/Makefile.install [distribution] + This will install a number of packages required by OpenSRF on your system, including some Perl modules from CPANPerlCPAN . You can type no to the initial CPAN @@ -88,32 +107,37 @@ times whether it should install prerequisite modules - type yes. - As the opensrf user, configure and compile OpenSRF: + As the opensrf user, configure and compile OpenSRF: You can include the and configure options if you want to include support for PythonPython and Java Java, respectively. - cd /home/opensrf/OpenSRF-1.2.2 - ./configure --prefix=/openils --sysconfdir=/openils/conf - make - + +cd /home/opensrf/OpenSRF-1.4.0 +./configure --prefix=/openils --sysconfdir=/openils/conf +make + As the root user, return to your OpenSRF build directory and install OpenSRF: - cd /home/opensrf/OpenSRF-1.2.2 - make install + +cd /home/opensrf/OpenSRF-1.4.0 +make install + - As the root user, change the ownership of the installed files to the opensrf - user: + As the root user, change the ownership of the installed files to the + opensrf user: chown -R opensrf:opensrf /openils Restart and Test OpenSRF - osrf_ctl.sh -l -a start_all - /openils/bin/srfsh - srfsh# request opensrf.math add 2 2 - You should see output like: + +osrf_ctl.sh -l -a start_all +/openils/bin/srfsh +srfsh# request opensrf.math add 2 2 + + You should see output such as: Received Data: 4 @@ -124,26 +148,28 @@ Request Time in seconds: 0.007519 srfsh# - If test completed successfully move onto next section. + If test completed successfully move onto the next section. Otherwise, refer to the troubleshooting chapter of this documentation. - Upgrade <application>Evergreen</application> to 1.6 + Upgrade <application>Evergreen</application> to 1.6.1.2 - As the opensrf user, download and extract Evergreen 1.6 + As the opensrf user, download and extract Evergreen 1.6.1.2 - wget http://open-ils.org/downloads/Evergreen-ILS-1.6.0.8.tar.gz - tar xzf Evergreen-ILS-1.6.0.8.tar.gz + +wget http://open-ils.org/downloads/Evergreen-ILS-1.6.1.2.tar.gz +tar xzf Evergreen-ILS-1.6.1.2.tar.gz + For the latest edition of Evergreen check the Evergreen download page at and adjust upgrading instructions accordingly. As the root user, install the prerequisites: - cd /home/opensrf/Evergreen-ILS-1.6.0.8 + cd /home/opensrf/Evergreen-ILS-1.6.1.2 On the next command, replace with one of these values for your distribution of Debian or Ubuntu: @@ -169,25 +195,29 @@ srfsh# for Ubuntu Karmic Koala (9.10) + + for Ubuntu Lucid Lynx + (10.04) + make -f Open-ILS/src/extras/Makefile.install As the opensrf user, configure and compile Evergreen: - cd /home/opensrf/Evergreen-ILS-1.6.0.8 + cd /home/opensrf/Evergreen-ILS-1.6.1.2 ./configure --prefix=/openils --sysconfdir=/openils/conf make As the root user, install Evergreen: - make STAFF_CLIENT_BUILD_ID=rel_1_6_0_8 install + make STAFF_CLIENT_BUILD_ID=rel_1_6_1_2 install Change to the Evergreen installation directory: - cd /home/opensrf/Evergreen-ILS-1.6.0.8 + cd /home/opensrf/Evergreen-ILS-1.6.1.2 As the root user, change all files to be owned by the @@ -197,21 +227,20 @@ srfsh# As the root user, build live-db-setup.pl for the cgi-bin bootstrapping scripts and offline-config.pl for the offline staff client data uploader: - cd /home/opensrf/Evergreen-ILS-1.6.0.8 - - + +cd /home/opensrf/Evergreen-ILS-1.6.1.2 perl Open-ILS/src/support-scripts/eg_db_config.pl --create-bootstrap --create-offline --user evergreen \ --password evergreen --hostname localhost --port 5432 --database evergreen - - + As the opensrf user, update server symlink in /openils/var/web/xul/: - cd /openils/var/web/xul/ - rm server - ln -s rel_1_6_0_8/server + +cd /openils/var/web/xul/ +rm server +ln -s rel_1_6_1_2/server + - Update the Evergreen database: it is recommended that you back up your Evergreen database in order to restore your data if anything goes wrong. @@ -222,15 +251,11 @@ psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.0-1.6.0.1-upgrade-db psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.1-1.6.0.2-upgrade-db.sql evergreen psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.2-1.6.0.3-upgrade-db.sql evergreen psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.3-1.6.0.4-upgrade-db.sql evergreen -psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.4-1.6.0.5-upgrade-db.sql evergreen -psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.5-1.6.0.6-upgrade-db.sql evergreen -psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.6-1.6.0.7-upgrade-db.sql evergreen -psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.7-1.6.0.8-upgrade-db.sql evergreen +psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.4-1.6.1.0-upgrade-db.sql evergreen +psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.1.0-1.6.1.1-upgrade-db.sql evergreen +psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.1.1-1.6.1.2-upgrade-db.sql evergreen - - Download and run the the billing view hot-fix script - wget http://www.open-ils.org/downloads/1.6.0-mmbxs-cleanup.sql - psql -U evergreen -h localhost -f 1.6.0-mmbxs-cleanup.sql + As the opensrf user, @@ -249,12 +274,10 @@ psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.7-1.6.0.8-upgrade-db Update opensrf.xml with the database connection info: - - + perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config --service all --user evergreen \ --password evergreen --hostname localhost --port 5432 --database evergreen - - + Update /etc/apache2/startup.pl by copying the example from @@ -288,15 +311,19 @@ perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config --service all As the opensrf user, run autogen to refresh the static organizational data files:autogen - cd /openils/bin - ./autogen.sh -c /openils/conf/opensrf_core.xml -u + +cd /openils/bin +./autogen.sh -c /openils/conf/opensrf_core.xml -u + Start srfsh and try logging in using your Evergreen username and password: - /openils/bin/srfsh - srfsh% login + +/openils/bin/srfsh +srfsh% login + Start the Apache web server. @@ -309,8 +336,8 @@ perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config --service all - Upgrading PostgreSQL from 8.2 to 8.3 - Evergreen 1.6 supports PostgreSQL version 8.3 and it is recommended that you upgrade PostgreSQL when you upgrade Evergreen to 1.6. + Upgrading PostgreSQL from 8.2 to 8.4 + Evergreen 1.6.1 supports PostgreSQL version 8.4 and it is recommended that you upgrade PostgreSQL when you upgrade Evergreen to 1.6. The order of the following steps is very important.databasesPostgreSQL @@ -320,17 +347,20 @@ perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config --service all Backup the Evergreen database data + + Upgrade to Postgresql 8.4 by removing old version and installing Postgresql 8.4 + - Create an empty Evergreen database in postgresql 8.3 by issuing the following commands as the postgres user: + Create an empty Evergreen database in postgresql 8.4 by issuing the following commands as the postgres user: createdb -E UNICODE evergreen createlang plperl evergreen createlang plperlu evergreen createlang plpgsql evergreen -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 +psql -f /usr/share/postgresql/8.4/contrib/tablefunc.sql evergreen +psql -f /usr/share/postgresql/8.4/contrib/tsearch2.sql evergreen +psql -f /usr/share/postgresql/8.4/contrib/pgxml.sql evergreen @@ -343,7 +373,7 @@ psql -f /usr/share/postgresql/8.3/contrib/pgxml.sql evergreen Restore data from backup created in step 1. - To point tsearch2 to proper function names in 8.3, run the SQL script + To point tsearch2 to proper function names in 8.4, run the SQL script /home/opensrf/Evergreen-ILS*/Open-ILS/src/sql/Pg/000.english.pg83.fts-config.sql using the psql command. cd /home/opensrf/Evergreen-ILS* psql -f /Open-ILS/src/sql/Pg/000.english.pg83.fts-config.sql evergreen @@ -353,8 +383,8 @@ psql -f /usr/share/postgresql/8.3/contrib/pgxml.sql evergreen For additional information regarding upgrading PostgreSQL, see the following documentation in PostgreSQL: - - + + diff --git a/1.6/admin/installation-previousversions.xml b/1.6/admin/installation-previousversions.xml new file mode 100644 index 0000000..1424d5c --- /dev/null +++ b/1.6/admin/installation-previousversions.xml @@ -0,0 +1,545 @@ + + + + Installing Previous Versions of Evergreen + Earlier releases of Evergreen are available. Instructions for installing, configuring and testing earlier versions are found below. + The next most recent previous release of Evergreen is version 1.4.0.6. The accompanying previous release of OpenSRF + is version 1.0.7. +
+ Installing Evergreen 1.4.0.6 On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> + This section outlines the installation process for the previous version 1.4.0.6 of Evergreen. + 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. + + 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. + If you are starting with a clean install of Ubuntu or Debian, you are strongly recommended not to install the packaged PostgreSQL server. This can confuse port numbers and system configuration. Evergreen 1.4 requires PostgreSQL 8.2. + +
+ Installing OpenSRF 1.0.7 + 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 . + 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. +
+
+ Download and Unpack Evergreen Version 1.4.0.6 + As the opensrf user, download and extract the latest version of Evergreen. The latest version can be found here: +
+ Commands to download and unpack Evergreen + + $ su - opensrf + $ wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.4.0.6.tar.gz + $ tar zxf Evergreen-ILS-1.4.0.6.tar.gz + +
+ The new directory /home/opensrf/Evergreen-ILS-1.4.0.6 will be created. +
+
+ Install Prerequisites to Build Evergreen + In this section you will install and configure a set of prerequisites that will be used to build Evergreen. In a following step you will actually build the software using the make utility. + As the root user, enter the commands show below to build the prerequisites from the software distribution that you just downloaded and unpacked. Remember to replace [distribution] in the example with the keyword corresponding to the actual Linux distribution listed in the "Keywords" figure below. +
+ Commands to install prerequisites for Evergreen + + $ su - root + $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 + $ make -f Open-ILS/src/extras/Makefile.install [distribution] + ... + +
+ + Keywords Targets for <application>"make"</application> Command + + + + + + Keyword + Description + + + + + debian-lenny + for Debian Lenny (5.0) + + + debian-etch + for Debian Etch (4.0) + + + ubuntu-intrepid + for Ubuntu Intrepid (8.10) + + + ubuntu-hardy + for Ubuntu Hardy (8.04) + + + +
+
+
+ Update the System Dynamic Library Path + As the root user, you must update the system dynamic library path to make your system recognize the newly installed libraries. Do this by creating the new file /etc/ld.so.conf.d/eg.conf containing two new library paths, then run the command ldconfig to automatically read the file and modify the system dynamic library path: +
+ Commands to modify system dynamic library path + + $ su - root + $ cat > /etc/ld.so.conf.d/eg.conf << ENDOFFILE + /usr/local/lib + /usr/local/lib/dbd + ENDOFFILE + $ ldconfig + +
+
+
+ Restart the PostgreSQL Server + If PostgreSQL is running on the same system as the rest of Evergreen, as the root user you must restart the PostgreSQL server to avoid a problem where the library plperl.so cannot be found. If your PostgreSQL server is running on another system, just skip this step. +
+ Commands to restart PostgreSQL server + + $ su - root + $ /etc/init.d/postgresql-8.2 restart + +
+
+
+ Configure Evergreen + As the opensrf user, return to the Evergreen build directory and use the configure utility to prepare for the next step of compiling and linking the software: +
+ Commands to configure Evergreen + + $ su - opensrf + $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 + $ ./configure --prefix=/openils --sysconfdir=/openils/conf + $ make + ... + +
+
+
+ Compile, Link and Install Evergreen + In this step you will actually compile, link and install Evergreen and the default Evergreen Staff Client. + As the root user, return to the Evergreen build directory and use the make utility as shown below. The Staff Client will also be automatically built, but you must remember to set the variable STAFF_CLIENT_BUILD_ID to match the version of the Staff Client you will use to connect to the Evergreen server. + For further information on manually building the Staff Client, see . +
+ Commands to build, link and install Evergreen + + $ su - root + $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 + $ make STAFF_CLIENT_BUILD_ID=rel_1_4_0_6 install + ... + + The above commands will create a new subdirectory /openils/var/web/xul/rel_1_4_0_6 containing the Staff Client. +
+
+
+ Copy the OpenSRF Configuration Files + As the root user, copy the example OpenSRF configuration files into place. This replaces the configuration files that you set up in a previous step when you installed and tested OpenSRF. You should also create backup copies of the old files for troubleshooting purposes. Finally, change the ownership on the installed files to the opensrf user: +
+ Commands to copy OpenSRF configuration files + + $ su - root + $ cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml + $ cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml + $ chown -R opensrf:opensrf /openils/ + +
+
+
+ Create and Configure PostgreSQL Database + As the postgres user on your PostgreSQL server, create the Evergreen database. + In the commands below, remember to adjust the path of the contrib repository to match your PostgreSQL server layout. For example, if you built PostgreSQL from source the path would be /usr/local/share/contrib; if you installed the PostgreSQL 8.2 server packages on Ubuntu 8.04, the path would be /usr/share/postgresql/8.2/contrib/. + + + + Create and configure the database + + As the postgres user on the PostgreSQL system create the PostgreSQL database, then set some internal paths: +
+ Commands to create database and adjust the path + + # 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/PGSQL_VERSION/contrib/tablefunc.sql evergreen + $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tsearch2.sql evergreen + $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/pgxml.sql evergreen + +
+ Where PGSQL_VERSION is your installed PostgreSQL version (e.g. 8.2). + + + + Create new Evergreen superuser + + As the postgres user on the PostgreSQL system, create the + new database evergreen user and assign a password: + +# create superuser 'evergreen' and set the password +su - postgres +createuser -P -s evergreen +Enter password for new role: MYNEWPASSWORD +Enter it again:MYNEWPASSWORD + + Where MYNEWPASSWORD is the password chosen. + + +
+
+ Create Database Schema + As the root user, create the database schema and configure your system with the corresponding database authentication details for the evergreen database user that you created in the previous step. + Enter the following commands and replace HOSTNAME, PORT, PASSWORD and DATABASENAME with appropriate values. +
+ Commands to create Evergreen database schema + + $ su - root + $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 + $ 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 evergreen --password PASSWORD --database DATABASENAME + +
+ Where, on most systems, HOSTNAME will be localhost, PORT will be 5432, and PASSWORD and DATABASENAME will be those assigned when PostgreSQL was installed in the previous step. + + + If you are entering the above command on a single line, do not include the \ (backslash) characters. If you are using the bash 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. + + +
+
+ Evergreen installation - (continued) + The remainder of the Evergreen installation procedure is identical to that for installing the latest version of Evergreen. Continue with the instructions found in . +
+
+
+ Installing OpenSRF 1.0.7 On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> + This section describes the installation of the previous version of the Open Service Request Framework (OpenSRF), a major component of the Evergreen server-side software, on Ubuntu or Debian systems. Evergreen software is integrated with and depends on the OpenSRF software system. + Follow the steps outlined here and run the specified tests to ensure that OpenSRF is properly installed and configured. Do not continue with any further Evergreen installation steps until you have verified that OpenSRF has been successfully installed. + + The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) platforms. OpenSRF 1.0.7 has been tested on Debian Etch (4.0), Debian Lenny, Ubuntu Hardy Heron (8.04), and Ubuntu Intrepid Ibex (8.10). + In the following instructions, you are asked to perform certain steps as either the root user, the opensrf user, or the postgres user. + + Debian -- To become the root user, issue the command su - and enter the password of the root user. + Ubuntu -- To become the root user, issue the command sudo su - and enter the password of the root user. + + To switch from the root user to a different user, issue the command su - USERNAME. For example, to switch from the root user to the opensrf user, issue the command su - opensrf. Once you have become a non-root user, to become the root user again, simply issue the command exit". + +
+ Add the OpenSRF User + As the root user, add the opensrf user to the system. The default shell for the new user is automatically set to /bin/bash to inherit a reasonable environment: +
+ Commands to add <systemitem class="username">opensrf</systemitem> user + + $ su - opensrf + $ useradd -m -s /bin/bash opensrf + $ passwd opensrf + Enter new UNIX password: ****** + Retype new UNIX password: ****** + passwd: password updated successfully + $ + +
+
+
+ Download and Unpack Latest OpenSRF Version + As the opensrf user, download and extract the latest version of OpenSRF. The latest version can be found here: +
+ Commands to download and unpack OpenSRF + + $ su - opensrf + $ wget http://evergreen-ils.org/downloads/OpenSRF-1.0.7.tar.gz + $ tar zxf OpenSRF-1.0.7.tar.gz + +
+ The new directory /home/opensrf/OpenSRF-1.0.7 will be created. +
+
+ Install Prerequisites to Build OpenSRF + In this section you will install and configure a set of prerequisites that will be used to build OpenSRF. In a following step you will actually build the software using the make utility. + As the root user, enter the commands show below to build the prerequisites from the software distribution that you just downloaded and unpacked. Remember to replace [DISTRIBUTION] in the example with the keyword corresponding to the actual Linux distribution listed in the "Keywords" figure below. +
+ Commands to install prerequisites for OpenSRF + + $ su - root + $ cd /home/opensrf/OpenSRF-1.0.7 + $ make -f src/extras/Makefile.install [DISTRIBUTION] + ... + +
+ + Keywords Targets for <application>"make"</application> Command + + + + + + Keyword + Description + + + + + debian-lenny + for Debian Lenny (5.0) + + + debian-etch + for Debian Etch (4.0) + + + ubuntu-intrepid + for Intrepid (8.10) + + + ubuntu-hardy + for Ubuntu Hardy (8.04) + + + +
+ This will install a number of packages on the system that are required by OpenSRF, including some Perl modules from CPAN. You can say No to the initial CPAN configuration prompt to allow it to automatically configure itself to download and install Perl modules from CPAN. The CPAN installer will ask you a number of times whether it should install prerequisite modules - say Yes. +
+
+ Configure OpenSRF + As the opensrf user, return to the OpenSRF build directory and use the configure utility to prepare for the next step of compiling and linking the software. You can include the and configuration options if you wish to include support for Python and Java, respectively: +
+ Commands to configure OpenSRF + + $ su - opensrf + $ cd /home/opensrf/OpenSRF-1.0.7 + $ ./configure --prefix=/openils --sysconfdir=/openils/conf + $ make + ... + +
+
+
+ Compile, Link and Install OpenSRF + As the root user, return to the OpenSRF build directory and use the make utility to compile, link and install OpenSRF: +
+ Commands to build, link and install OpenSRF + + $ su - opensrf + $ cd /home/opensrf/OpenSRF-1.0.7 + $ make install + ... + +
+
+
+ Update the System Dynamic Library Path + As the root user, you must update the system dynamic library path to make your system recognize the newly installed libraries. Do this by creating the new file /etc/ld.so.conf.d/osrf.conf containing a new library path, then run the command ldconfig to automatically read the file and modify the system dynamic library path: +
+ Commands to modify system dynamic library path + + $ su - root + $ echo "/openils/lib" > /etc/ld.so.conf.d/osrf.conf + $ ldconfig + +
+
+
+ Define Public and Private OpenSRF Domains + Define your public and private OpenSRF domains. For security purposes, OpenSRF uses Jabber domains to separate services into public and private realms. Throughout these instructions, we will use the example domains public.localhost for the public domain and private.localhost for the private domain. On a single-server system, the easiest way to define public and private domains is to define separate host names by adding entries to the file /etc/hosts. + As the root user, edit the file /etc/hosts and add the following entries for our example domains: +
+ Example public and private domains in /etc/hosts + + 127.0.1.2 public.localhost public + 127.0.1.3 private.localhost private + +
+
+
+ Change File Ownerships + As the root user, change the ownership of files installed in the directory /openils to the opensrf user: +
+ Commands to change file ownerships + + $ chown -R opensrf:opensrf /openils + +
+
+
+ Stop the <systemitem class="service">ejabberd</systemitem> Service + As the root user, stop the ejabberd service: +
+ Commands to stop the <systemitem class="service">ejabberd</systemitem> service + + $ /etc/init.d/ejabberd stop + +
+ If ejabberd reports that it is already stopped, it may have run into a problem starting back at the installation stage. One possible fix is to kill any remaining beam and epmd processes, then edit the configuration file /etc/ejabberd/ejabberd.cfg to hardcode a domain: +
+ Commands to recover from <systemitem class="service">ejabberd</systemitem> errors + + $ su - root + $ epmd -kill + $ killall beam; killall beam.smp + $ rm /var/lib/ejabberd/* + $ echo 'ERLANG_NODE=ejabberd@localhost' >> /etc/default/ejabberd + +
+
+
+ Edit the <systemitem class="service">ejabberd</systemitem> configuration + As the root user, edit the file /etc/ejabberd/ejabberd.cfg and make the following changes: + + Change {hosts, ["localhost"]}. to {hosts, ["localhost", "private.localhost", "public.localhost"]}. + Change {max_user_sessions, 10}. to {max_user_sessions, 1000}. If you see something like this instead: {access, max_user_sessions, [{10, all}]}., then change it to {access, max_user_sessions, [{1000, all}]}. + Change all three occurrences of max_stanza_size to 2000000. + Change both occurrences of maxrate to 500000. + Comment out the line {mod_offline, []} by placing two % comment signs in front. + +
+
+ OpenSRF installation - (continued) + + The remainder of the OpenSRF installation procedure is identical to that for installing the latest version of OpenSRF. Continue with the instructions found in . + +
+
+
+
+ Installing PostgreSQL + In production Evergreen systems, the PostgreSQL database server may reside on the same system on which Evergreen is installed or on another standalone system so, by default, PostgreSQL is not automatically installed along with Evergreen. This section details the steps needed to manually install PostgreSQL on a Ubuntu or Debian system. + If your PostgreSQL server will be on the same system as your Evergreen software, return to the previous section and follow those instructions. Otherwise, to manually install PostgreSQL on a system, continue with the instructions below. + + Some Linux distributions, such as Debian Etch (4.0), do not offer PostgreSQL version 8.2 as an installable package. Before you continue, examine the software dependencies listed in to ensure that your Linux distribution supports the required version of PostgreSQL. + + + + Install the application "stow" on your system if it is not already installed. Issue the following command as the root user: +
+ Installing <application>"stow"</application> + + $ apt-get install stow + ... + +
+ + + Download, compile, and install the latest release for PostgreSQL 8.2 (which was version 8.2.12 at the time of this writing). As the root user, follow these steps: +
+ Installing PostgreSQL + + $ wget http://wwwmaster.postgresql.org/redir/198/h/source/v8.2.17/postgresql-8.2.17.tar.bz2 + $ tar xzf postgresql-8.2.17.tar.gz + $ cd postgresql-8.2.17 + $ ./configure --with-perl --enable-integer-datetimes --with-openssl --prefix=/usr/local/stow/pgsql + ... + $ make + ... + $ make install + ... + $ cd contrib + $ make + ... + $ make install + $ cd xml2 + $ make + ... + $ make install + $ cd /usr/local/stow + $ stow pgsql + +
+ + + Create the new user postgres to run the PostgreSQL processes. As the root user, execute this command: +
+ Adding <systemitem class="username">postgres</systemitem> + + $ adduser postgres + +
+ + + Initialize the database directory and start up PostgreSQL. As the root user, follow these steps: +
+ Adding <systemitem class="username">postgres</systemitem> + + $ mkdir -p /usr/local/pgsql/data + $ chown postgres /usr/local/pgsql/data + $ su - postgres + $ initdb -D /usr/local/pgsql/data -E UNICODE --locale=C + $ pg_ctl -D /usr/local/pgsql/data -l /home/postgres/logfile start + +
+ + If an error occurs during the final step above, review the path of the home directory for the postgres user. It may be /var/lib/postresql instead of /home/postres. + + + + The values of several PostreSQL configuration parameters may be changed for enhanced performance. The following table lists the default values and some suggested updates for several useful parameters: + + Suggested configuration values + + + + + + + Parameter + Default + Suggested + + + + + default_statistics_target + 10 + 100 + + + work_mem + 4Mb + 128Mb + + + shared_buffers + 8Mb + 512Mb + + + effective_cache_size + 128Mb + 4Gb + + + +
+ + ZZZ-REVIEW + ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS + + ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS + + +
+
+ Installing Apache +
+ Securing Apache (httpd) + The main consideration is to secure the directory cgi-bin. The only persons that need access to this directory are Evergreen system administrators. This directory should be restricted by both IP (to those workstations designated as Evergeen Administration systems), and by username/password. + + ZZZ-REVIEW + ADD CONTENT ON HOW TO RESTRICT APACHE BY IP AND USERNAME/PASSWORD + + ADD CONTENT ON HOW TO RESTRICT APACHE BY IP AND USERNAME/PASSWORD + A user could add new libraries, re-arrange consortia, or change user groups; or a staff member could access the directory, and change his associated security group to administrative level privileges. +
+ + ZZZ-REVIEW + ADD MORE CONTENT FOR APACHE + + ADD MORE CONTENT FOR APACHE +
+ diff --git a/1.6/admin/installingpostgresql.xml b/1.6/admin/installingpostgresql.xml new file mode 100644 index 0000000..1b312a5 --- /dev/null +++ b/1.6/admin/installingpostgresql.xml @@ -0,0 +1,119 @@ + + + Installing PostgreSQL + In production Evergreen systems, the PostgreSQL database server may reside on the same system on which Evergreen is installed or on another standalone system so, by default, PostgreSQL is not automatically installed along with Evergreen. This section details the steps needed to manually install PostgreSQL on a Ubuntu or Debian system. + If your PostgreSQL server will be on the same system as your Evergreen software, return to the previous section and follow those instructions. Otherwise, to manually install PostgreSQL on a system, continue with the instructions below. + + Some Linux distributions, such as Debian Etch (4.0), do not offer PostgreSQL version 8.2 as an installable package. Before you continue, examine the software dependencies listed in to ensure that your Linux distribution supports the required version of PostgreSQL. + + + + Install the application "stow" on your system if it is not already installed. Issue the following command as the root user: +
+ Installing <application>"stow"</application> + + $ apt-get install stow + ... + +
+ + + Download, compile, and install the latest release for PostgreSQL 8.2 (which was version 8.2.12 at the time of this writing). As the root user, follow these steps: +
+ Installing PostgreSQL + + $ wget http://wwwmaster.postgresql.org/redir/198/h/source/v8.2.17/postgresql-8.2.17.tar.bz2 + $ tar xzf postgresql-8.2.17.tar.gz + $ cd postgresql-8.2.17 + $ ./configure --with-perl --enable-integer-datetimes --with-openssl --prefix=/usr/local/stow/pgsql + ... + $ make + ... + $ make install + ... + $ cd contrib + $ make + ... + $ make install + $ cd xml2 + $ make + ... + $ make install + $ cd /usr/local/stow + $ stow pgsql + +
+ + + Create the new user postgres to run the PostgreSQL processes. As the root user, execute this command: +
+ Adding <systemitem class="username">postgres</systemitem> + + $ adduser postgres + +
+ + + Initialize the database directory and start up PostgreSQL. As the root user, follow these steps: +
+ Adding <systemitem class="username">postgres</systemitem> + + $ mkdir -p /usr/local/pgsql/data + $ chown postgres /usr/local/pgsql/data + $ su - postgres + $ initdb -D /usr/local/pgsql/data -E UNICODE --locale=C + $ pg_ctl -D /usr/local/pgsql/data -l /home/postgres/logfile start + +
+ + If an error occurs during the final step above, review the path of the home directory for the postgres user. It may be /var/lib/postresql instead of /home/postres. + + + + The values of several PostreSQL configuration parameters may be changed for enhanced performance. The following table lists the default values and some suggested updates for several useful parameters: + + Suggested configuration values + + + + + + + Parameter + Default + Suggested + + + + + default_statistics_target + 10 + 100 + + + work_mem + 4Mb + 128Mb + + + shared_buffers + 8Mb + 512Mb + + + effective_cache_size + 128Mb + 4Gb + + + +
+ + ZZZ-REVIEW + ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS + + ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS + + + diff --git a/1.6/admin/localization.xml b/1.6/admin/localization.xml index 8ba7edf..ee396e7 100644 --- a/1.6/admin/localization.xml +++ b/1.6/admin/localization.xml @@ -3,72 +3,65 @@ Languages and Localization -
- Enabling and Disabling Languages - Evergreen 1.6 is bundled with support for a number of languages beyond American English (en-US). The translated interfaces are - split between static files that are automatically installed with Evergreen, and dynamic labels that can be stored in the Evergreen database. Evergreen is - installed with additional SQL files that contain translated dynamic labels for a number of languages, and to make the set of translated labels available in - all interfaces. Only a few steps are required to enable or disable one or more languages. -
- Enabling a Localization - To enable the translated labels for a given language to display in Evergreen, just populate the database with the translated labels and enable the localization. The following example illustrates how to enable Canadian French (fr-CA) support in the database. These same steps can be used with any of the languages bundled with Evergreen, or you can create and add your own localization. - - - The translated labels for each locale are stored in SQL files named "950.data.seed-values-xx-YY.sql" where "xx-YY" represents the locale code for the translation. Load the translated labels into the Evergreen database using the command psql, substituting your user, host and database connection information accordingly: +
+ Enabling and Disabling Languages + Evergreen 1.6 is bundled with support for a number of languages beyond American English (en-US). The translated interfaces are + split between static files that are automatically installed with Evergreen, and dynamic labels that can be stored in the Evergreen database. Evergreen is + installed with additional SQL files that contain translated dynamic labels for a number of languages, and to make the set of translated labels available in + all interfaces. Only a few steps are required to enable or disable one or more languages. + + Enabling a Localization + To enable the translated labels for a given language to display in Evergreen, just populate the database with the translated labels and enable the localization. The + following example illustrates how to enable Canadian French (fr-CA) support in the database. These same steps can be used with any of the + languages bundled with Evergreen, or you can create and add your own localization. + + + The translated labels for each locale are stored in SQL files named "950.data.seed-values-xx-YY.sql" where "xx-YY" represents the locale code for + the translation. Load the translated labels into the Evergreen database using the command psql, substituting your user, host and + database connection information accordingly: -h -d -f /path/to/Evergreen-source/Open-ILS/src/sql/Pg/950.data.seed-values-fr-CA.sql ]]> - - - Ensure the locale is enabled in the Evergreen database by using the utility psql to check for the existence of the locale in the table config.i18n_locale: -
- Commands to check for localization - - SELECT code, marc_code, name, description - FROM config.i18n_locale - WHERE code = 'fr-CA'; - -
- As shown in the following example, if one row of output is returned, then the locale is already enabled: -
- Results of an installed localization - - code | marc_code | name | description - ------+-----------+-----------------+----------------- - fr-CA | fre | French (Canada) | Canadian French - (1 row) - -
- If zero rows of output are returned, then the locale is not enabled: -
- Results of no installed localizations - - code | marc_code | name | description - ------+-----------+------+------------- - (0 rows) - -
- To enable a locale, use psql to insert a row into the table config.i18n_locale as follows: -
- Commands to enable a locale in the database - - INSERT INTO config.i18n_locale (code, marc_code, name, description) - VALUES ('fr-CA', 'fre', 'French (Canada)', 'Canadian French'); - -
- - -
-
- Disabling a Localization - You might not want to offer all of the localizations that are preconfigured in Evergreen. If you choose to disable the dynamic labels for a locale, just delete those entries from the table config.i18n_locale using the psql utility: -
- Commands to delete localization from table - - DELETE FROM config.i18n_locale - WHERE code = 'fr-CA'; - -
-
-
+ + + Ensure the locale is enabled in the Evergreen database by using the utility psql to check for the existence of the locale in the + table config.i18n_locale: + + +SELECT code, marc_code, name, description +FROM config.i18n_locale +WHERE code = 'fr-CA'; + + + As shown in the following example, if one row of output is returned, then the locale is already enabled: + +code | marc_code | name | description +------+-----------+-----------------+----------------- +fr-CA | fre | French (Canada) | Canadian French +(1 row) + + If zero rows of output are returned, then the locale is not enabled: + +code | marc_code | name | description +------+-----------+------+------------- +(0 rows) + + To enable a locale, use psql to insert a row into the table config.i18n_locale as follows: + +INSERT INTO config.i18n_locale (code, marc_code, name, description) +VALUES ('fr-CA', 'fre', 'French (Canada)', 'Canadian French'); + + + + + + Disabling a Localization + You might not want to offer all of the localizations that are preconfigured in Evergreen. If you choose to disable the dynamic labels for a locale, just delete those + entries from the table config.i18n_locale using the psql utility: + +DELETE FROM config.i18n_locale +WHERE code = 'fr-CA'; + + +
-- 2.11.0