From fcb9426fdf4589666d7c382090b836b11be5bc76 Mon Sep 17 00:00:00 2001 From: Robert Soulliere Date: Sun, 12 Sep 2010 17:24:15 -0400 Subject: [PATCH] Git add server side installation. --- 1.6/admin/serversideInstallation.xml | 2388 ++++++++++++++++++++++++++ 1 file changed, 2388 insertions(+) create mode 100644 1.6/admin/serversideInstallation.xml diff --git a/1.6/admin/serversideInstallation.xml b/1.6/admin/serversideInstallation.xml new file mode 100644 index 0000000000..35f7495643 --- /dev/null +++ b/1.6/admin/serversideInstallation.xml @@ -0,0 +1,2388 @@ + + + + Server-side Installation of Evergreen Software + + This section describes installation of the Evergreen server-side software and its associated components. Installation, configuration, testing and verification of the software is straightforward if you follow some simple directions. + + +
+ Overview + Installing, configuring and testing the Evergreen server-side software is straightforward with the current stable software release. See the section "Installation of Server-Side Software" for instructions tailored to installing on some particular distributions of the Linux operating system. Earlier software distributions are described in the section "Installing Previous Versions of Evergreen". + The current version of the Evergreen server-side software runs as a native application on any of several well-known Linux distributions (e.g., Ubuntu and Debian). It does not currently run as a native application on the Windows operating system (e.g., WindowsXP, WindowsXP Professional, Windows7), but the software can still be installed and run on Windows via a so-called virtualized Unix-guest Operating System (using, for example, VirtualBox, or VMware, or VirtualPC to emulate a 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 the section "Installing Evergreen in Virtualized Unix Environments". + Installation of some sub-components of the Evergreen server-side software is mentioned only in abbreviated form in this section. More detailed information is available in the accompanying sections: +"Installing PostgreSQL", +"Apache" and +"memcached Servers". + + Finally, installation of the Evergreen Staff Client software is reviewed in the section "Installing the Evergreen Staff Client". +
+ Evergreen Software Dependencies + 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: + + Evergreen Software Dependencies + + + + Evergreen + OpenSRF + PostgreSQL + + + + + 1.6.x + 1.2 + 8.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 the section "Installing Evergreen on Ubuntu or Debian" . + + 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 the section "Installing OpenSRF On Ubuntu or Debian" . +
+
+ Previous Software Releases + Earlier releases of Evergreen are also available. Instructions for installing, configuring and testing earlier versions are found in the section "Installing Previous Versions of Evergreen" . + 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 section "Installing Evergreen 1.4.0.6 on Ubuntu or Debian" . + The accompanying previous release of OpenSRF is version 1.0.x. Instructions for installing, configuring and testing that version are found in the section "Installing OpenSRF 1.0.x" . +
+
+
+ Installing Server-Side Software + This section describes the installation of the major components of Evergreen server-side software. + As far as possible, you should perform the following steps in the exact order given since the success of many steps relies on the successful completion of earlier steps. You should make backup copies of files and environments when you are instructed to do so. In the event of installation problems those copies can allow you to back out of a step gracefully and resume the installation from a known state. See the section on "Backing Up" for further information. + Of course, after you successfully complete and test the entire Evergreen installation you should take a final snapshot backup of your system(s). This can be the first in the series of regularly scheduled system backups that you should probably also begin. +
+ Installing OpenSRF 1.2.x On Ubuntu or Debian + This section describes the installation of the latest 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.2.2 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 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 "opensrf" 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 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.2.2.tar.gz + $ tar zxf OpenSRF-1.2.2.tar.gz + +
+ The new directory /home/opensrf/OpenSRF-1.2.2 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.2.2 + $ make -f src/extras/Makefile.install [distribution] + ... + +
+ + Keywords Targets for "make" + + + + + + Keyword + Description + + + + + debian-lenny + for Debian Lenny (5.0) + + + debian-etch + for Debian Etch (4.0) + + + ubuntu-karmic + for Ubuntu Karmic (9.10) + + + ubuntu-intrepid + for Ubuntu Jaunty (9.04) or Intrepid (8.10) + + + ubuntu-hardy + for Ubuntu Hardy (8.04) + + + +
+ + ZZZ-REVIEW + ADD INFO FOR OTHER LINUX DISTRIBUTIONS + + ADD INFO FOR OTHER LINUX DISTRIBUTIONS + 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 user, return to the OpenSRF build directory and use the utility "configure" 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.2.2 +$ ./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 command to compile, link and install OpenSRF: +
+ Commands to build, link and install OpenSRF + +$ su - opensrf +$ cd /home/opensrf/OpenSRF-1.2.2 +$ 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 a new file named /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 hostnames 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 user "opensrf": +
+ Commands to change file ownerships + + $ chown -R opensrf:opensrf /openils + +
+
+
+ Stop the "ejabberd" Service + As the root user, stop the "ejabberd" service: +
+ Commands to stop the "ejabberd" 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 ejabberd configuration file to hardcode a domain: +
+ Commands to recover from "ejabberd" error + + $ su - root + $ epmd -kill + $ killall beam; killall beam.smp + $ rm /var/lib/ejabberd/* + $ echo 'ERLANG_NODE=ejabberd@localhost' >> /etc/default/ejabberd + +
+
+
+ Edit the "ejabberd" 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, 10000}. If you see something like this instead: {access, max_user_sessions, [{10, all}]}., then change it to {access, max_user_sessions, [{10000, 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. + +
+
+ Restart the "ejabberd" service + As the root user, restart the ejabberd service to test the configuration changes and to register your users: +
+ Commands to restart the "ejabberd" service + + $ /etc/init.d/ejabberd start + +
+
+
+ Register "router" and "ejabberd" users + On each domain, you need two "ejabberd" users to manage the OpenSRF communications: + + a "router" user, to whom all requests to connect to an OpenSRF service will be routed; this "ejabberd" user must be named "router" + an "opensrf" user, which clients use to connect to OpenSRF services; this user can be named anything you like, but we will use "opensrf" in our examples + + As the root user, use the utility "ejabberdctl" to register your ejabber users router and opensrf for the OpenSRF router service on each domain. The users should have different passwords on each domain. These users will correspond to those configured in the file /openils/conf/opensrf_core.xml: +
+ Commands to registe "router" and "ejabberd" users + + # Syntax for registering a user with ejabberdctl: + # ejabberdctl register <user> <domain> <password> + # + $ ejabberdctl register router private.localhost <password> + $ ejabberdctl register opensrf private.localhost <password> + $ ejabberdctl register router public.localhost <password> + $ ejabberdctl register opensrf public.localhost <password> + +
+
+
+ Create configuration files + As the opensrf user user, use the example templates to create the configuration files /openils/conf/opensrf_core.xml and /openils/conf/opensrf.xml: +
+ Commands to create configuration files + + $ su - root + $ cd /openils/conf + $ cp opensrf.xml.example opensrf.xml + $ cp opensrf_core.xml.example opensrf_core.xml + +
+
+
+ Edit opensrf_core.xml + Edit the file /openils/conf/opensrf_core.xml to change the "ejabberd" usernames and passwords as follows. + + + The following example uses common XPath syntax on the left-hand side to indicate the aproximage position needing changes within the XML file. + + +
+ Updates needed in the file "/openils/conf/opensrf_core.xml" + + /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 + + # first entry, where "transport/server" == "public.localhost" : + /config/routers/router/transport + username = router + password = password for "public.localhost" router user + + # second entry, where "transport/server" == "private.localhost" : + /config/routers/router/transport + username = router + password = password for "private.localhost" router user + +
+ 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 the correct values. Otherwise, search and replace to match your values. +
+
+ Modify the file <filename>opensrf.xml</filename> + Modify the file /openils/conf/opensrf.xml. + As the opensrf user, edit the file to set the location of the persistent database in the dbfile element near the end of the file: +
+ Example of the file "opensrf.xml" + + + + /tmp/persist.db + +]]> +
+
+
+ Create Configuration Files for Users Needing srfsh + In this section you will set up a special configuration file for each user who will need to run the srfsh (pronounced surf shell) utility. + The software installation will automatically create srfsh. This is a command line diagnostic tool for testing and interacting with the OpenSRF network software. It will be used in a future step to complete and test the Evergreen installation. See the section "Testing the Installation" for further information. + As the root user, copy the short sample configuration file /openils/conf/srfsh.xml.example to the file .srfsh.xml (note the leading dot!) in the home directory of each user who will use srfsh. Finally, edit each file .srfsh.xml file and make the following changes. When you finish, remember to change the owner of the file to match the owner of the home directory. + + Modify domain to be the router hostname (following our domain examples, private.localhost will give srfsh access to all OpenSRF services, while public.localhost will only allow access to those OpenSRF services that are publicly exposed). + Modify username and password to match the opensrf Jabber user for the chosen domain + Modify logfile to be the full path for a log file to which the user has write access + Modify loglevel as needed for testing + +
+ Example of the file "/openils/conf/srfsh.xml.example" + + + + +router +private.localhost +opensrf +privsrf +5222 +/tmp/srfsh.log + +4 +]]> +
+
+
+ Modify Environmental Variable PATH for "opensrf" User + As the opensrf user, modify the environmental variable PATH by adding a new file path to the opensrf user's shell configuration file .bashrc: +
+ Commands to add path to ".bashrc" configuration file + +$ su - opensrf +$ echo "export PATH=/openils/bin:\$PATH" >> ~/.bashrc + +
+
+
+ Starting OpenSRF + As the root user, start the ejabberd and memcached services: +
+ Commands to start "ejabberd" and "memcached" services + + $ su - root + $ /etc/init.d/ejabberd start + $ /etc/init.d/memcached start + +
+ + Finally, as the opensrf user user, start OpenSRF: +
+ Commands to start OpenSRF + + $ su - opensrf + + # ensure you have the needed path + $ export PATH=$PATH:/openils/bin + + # start the OpenSRF service: + # use "-l" to force hostname to be "localhost" + $ osrf_ctl.sh -l -a start_all + +
+ + + You can also start Evergreen without the -l flag, but osrf_ctl.sh must know the fully qualified domain name for the system on which it will execute. That hostname may have been specified in the configuration file opensrf.xml, which you configured in a previous step. + + +
+
+ Testing connections to OpenSRF + Once you have installed and started OpenSRF, as the root user, test your connection to OpenSRF using the utility srfsh and trying to call the add method on the OpenSRF "math" service: +
+ Commands to test OpenSRF with "srfsh" + + $ su - opensrf + $ /openils/bin/srfsh + srfsh# request opensrf.math add 2 2 + Received Data: 4 + ------------------------------------ + Request Completed Successfully + Request Time in seconds: 0.007519 + ------------------------------------ + srfsh# + +
+ + ZZZ-REVIEW + VERIFY THIS TEST + + VERIFY THIS TEST + For other srfsh commands, type 'help' in at the prompt. +
+
+ Stopping OpenSRF + As the opensrf user user, stop OpenSRF: +
+ Commands to stop OpenSRF + + $ su - opensrf + $ osrf_ctl.sh -l -a stop_all + +
+
+
+
+ Installing Evergreen 1.6.x.x On Ubuntu or Debian + This section outlines the installation process for the latest stable version 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. + In the following instructions, you are asked to perform certain steps as either the root user, the opensrf user 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 your current 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 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". + +
+ Installing OpenSRF + Evergreen software is integrated with and depends on the Open Service Request Framework (OpenSRF) software system. For further information on installing, configuring and testing OpenSRF, see the section "Installing OpenSRF". + 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 Latest Evergreen Version + As the opensrf user 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.6.0.7.tar.gz + $ tar zxf Evergreen-ILS-1.6.0.7.tar.gz + +
+ The new directory /home/opensrf/Evergreen-ILS-1.6.0.7 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.6.0.7 + $ make -f Open-ILS/src/extras/Makefile.install [distribution] + ... + +
+ + Keywords Targets for "make" + + + + + + Keyword + Description + + + + + debian-lenny + for Debian Lenny (5.0), the most recent version + + + debian-etch + for Debian Etch (4.0) + + + ubuntu-karmic + for Ubuntu Lucid (10.04) [same as for Karmic] + + + ubuntu-karmic + for Ubuntu Karmic (9.10) + + + ubuntu-intrepid + for Ubuntu Intrepid (8.10) + + + ubuntu-hardy + for Ubuntu Hardy (8.04) + + + ubuntu-gutsy + for Ubuntu Gutsy (7.10) + + + gentoo + generic for Gentoo versions + + + centos + generic for Centos versions + + + +
+ + ZZZ-REVIEW + ADD INFO FOR OTHER LINUX DISTRIBUTIONS + + ADD INFO FOR OTHER LINUX DISTRIBUTIONS +
+
+ (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 installing PostgreSQL, see the section "Installing PostgreSQL". + 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: +
+ Commands to install the PostgreSQL server + + $ su - root + + # Debian Lenny and Ubuntu Hardy (8.04) + $ make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_83 + ... + + # Ubuntu Karmic (9.10) and Ubuntu Lucid (10.04) + $ make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_84 + ... + +
+ + + PostgreSQL 8.1 is deprecated and will become unsupported in a future release, though existing installations upgrading from Evergreen 1.4 or before will work fine. However, consider upgrading your Postgres soon! + + + + ZZZ-REVIEW + VERIFY: IS THIS STILL TRUE? + + VERIFY: IS THIS STILL TRUE? + + ZZZ-REVIEW + ADD INFO ON HOW TO DETERMINE WHICH VERSION OF POSTGRESQL YOU HAVE + + ADD INFO ON HOW TO DETERMINE WHICH VERSION OF POSTGRESQL YOU HAVE +
+
+ (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: +
+ Commands to install Perl modules + + # ensure the gcc compiler is installed + $ su - root + $ aptitude install gcc + + # install the Perl modules + $ perl -MCPAN -e shell + cpan> install JSON::XS + cpan> install MARC::Record + cpan> install MARC::File::XML + +
+ + ZZZ-REVIEW + ADD INFO ON HOW TO INSTALL THE PERL MODULES + + ADD INFO ON HOW TO INSTALL THE PERL MODULES + + ZZZ-REVIEW + ADD INFO ON HOW TO VERIFY THAT THE PERL MODULES ARE INSTALLED + + ADD INFO ON HOW TO VERIFY THAT THE PERL MODULES ARE INSTALLED +
+
+ 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 a new file named /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 + +
+
+
+ (OPTIONAL) Restart the PostgreSQL Service + If PostgreSQL is running on the same system as the rest of Evergreen, as the root user you must restart the PostgreSQL service 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. + + ZZZ-REVIEW + ADD INFO ON OTHER VERSIONS OF POSTGRESQL + + ADD INFO ON OTHER VERSIONS OF POSTGRESQL +
+ Commands to restart PostgreSQL service + + $ su - root + $ /etc/init.d/postgresql-PGSQL_VERSION restart + +
+ Where "PGSQL_VERSION" is your installed PostgreSQL version (e.g. "8.3"). +
+
+ Configure Evergreen + As the opensrf user user, return to the Evergreen build directory and use the utility "configure" to prepare for the next step of compiling and linking the software: +
+ Commands to configure Evergreen + + $ su - opensrf + $ cd /home/opensrf/Evergreen-ILS-1.6.0.7 + $ ./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 command 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 the section "Building and Installing the Evergreen Staff Client". +
+ Commands to build, link and install Evergreen + + $ su - root + $ cd /home/opensrf/Evergreen-ILS-1.6.0.7 + $ make STAFF_CLIENT_BUILD_ID=rel_1_6_0_7 install + ... + + The above commands will create a new subdirectory /openils/var/web/xul/rel_1_6_0_7 containing the Staff Client. +
+ To complete the Staff Client installation, as the root user create a symbolic link named server in the head of the Staff Client directory /openils/var/web/xul that points to the /server subdirectory of the new Staff Client build: +
+ Commands to create symbolic link + + $ su - root + $ cd /openils/var/web/xul + $ ln -sf rel_1_6_0_7/server server + +
+
+
+ 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 user 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 + $ cp /openils/conf/oils_web.xml.example /openils/conf/oils_web.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.3 server packages on Ubuntu 8.04, the path would be /usr/share/postgresql/8.3/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.3"). + + + Create new Evergreen superuser + As the postgres user on the PostgreSQL system, create the new database user evergreen and assign a password: +
+ Commands to create the "evergreen" user + + # 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 database user evergreen 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.6.0.7 + $ perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \ + --service all --create-schema --create-bootstrap --create-offline \ + --hostname HOSTNAME --port PORT \ + --user 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. + + +
+
+ Configure the Apache Server + As the root user, configure the Apache server and copy several new configuration files to the Apache server directories: +
+ Commands to configure the Apache server + + # configure the Apache server + $ su - root + $ a2enmod ssl # enable mod_ssl + $ a2enmod rewrite # enable mod_rewrite + $ a2enmod expires # enable mod_expires + $ cd /home/opensrf/Evergreen-ILS-1.6.0.7 + + # copy files + $ cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/ + $ cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/ + $ cp Open-ILS/examples/apache/startup.pl /etc/apache2/ + +
+
+
+ Create a Security Certificate (SSL Key) + Use the command openssl to create a new SSL key for your Apache server. For a public production server you should configure or purchase a signed SSL certificate, but for now you can just use a self-signed certificate and accept the warnings in the Staff Client and browser during testing and development: +
+ Commands to create an SSL key + + $ mkdir /etc/apache2/ssl + $ cd /etc/apache2/ssl + $ openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key + +
+ + + This is only a temporary measure to expedite testing. You must get a proper SSL certificate for a public production system. + + + + ZZZ-REVIEW + ADD INFO ON HOW TO GET A SIGNED SSL CERTIFICATE + + ADD INFO ON HOW TO GET A SIGNED SSL CERTIFICATE +
+
+ Modify the Apache Configuration File + As the root user, edit the Apache configuration file /etc/apache2/sites-available/eg.conf and make the following changes: + + + Comment out the line Allow from 10.0.0.0/8, then uncomment the line Allow from all. + + This change allows access to your configuration CGI scripts from any workstation on any network. This is only a temporary change to expedite testing and should be removed after you have finished and successfully tested the Evergreen installation. + + + + You must remove these changes after testing is completed. See the section "Post-Installation Chores" for further details on removing this change after the Evergreen installation is complete. + + + + + Comment out the line Listen 443 as it conflicts with the same declaration in the configuration file: /etc/apache2/ports.conf. Debian etch users should not do this. + + ZZZ-REVIEW + ADD INFO ON WHY DEBIAN ETCH USERS SHOULD NOT DO THIS + + ADD INFO ON WHY DEBIAN ETCH USERS SHOULD NOT DO THIS + + + The following updates are needed to allow the logs to function properly, but it may break other Apache applications on your server. We hope to make this unnecessary in a future Evergreen release. + + + For the Linux distributions Ubuntu Hardy or Debian Etch, as the root user, edit the Apache configuration file /etc/apache2/apache2.conf and change the user: www-data to the user: opensrf user. + + + For the Linux distributions Ubuntu Karmic or Ubuntu Lucid or Debian Lenny, as the root user, edit the Apache configuration file /etc/apache2/envvars and change the phrase: export APACHE_RUN_USER=www-data to the phrase: export APACHE_RUN_USER=opensrf. + + + + + As the root user, edit the Apache configuration file /etc/apache2/apache2.conf and add the line KeepAliveTimeout 1, or modify an existing line if it already exists. + + +
+
+ (OPTIONAL) Performance Modifications for Apache + Some further configuration changes to Apache may be necessary for busy systems. These changes increase the number of Apache server processes that are started to support additional browser connections. + + As the root user, edit the Apache configuration file /etc/apache2/apache2.conf, locate and modify the section related to prefork configuration to suit the load on your system. + As the root user, edit the Apache configuration file /etc/apache2/apache2.conf and add the line MaxKeepAliveRequests 100, or modify an existing line if it already exists. +
(OPTIONAL) Example of updates to Apache configuration + <IfModule mpm_prefork_module> + StartServers 20 + MinSpareServers 5 + MaxSpareServers 15 + MaxClients 150 + MaxRequestsPerChild 10000 + </IfModule> + MaxKeepAliveRequests 100 +
+ +
+
+ Enable the Evergreen Site + As the root user, execute the following Apache configuration commands to disable the default "It Works" web page and to enable the Evergreen web site: +
+ Commands to enable the Evergreen Web Site + + $ su - root + + # disable the default site + $ a2dissite default + + # enable the Evergreen web site + $ a2ensite eg.conf + +
+
+
+ Modify the OpenSRF Configuration File + As the opensrf user user, edit the OpenSRF configuration file /openils/conf/opensrf_core.xml to update the Jabber usernames and passwords, and to specify the domain from which we will accept and to which we will make connections. + If you are installing Evergreen on a single server and using the private.localhost / 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: + + + + ZZZ-REVIEW + ADD A BETTER DIAGRAM HERE + + ADD A BETTER DIAGRAM HERE +
+ Updates needed in the file "/openils/conf/opensrf_core.xml" + + /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 + + # first entry, where "transport/server" == "public.localhost" : + /config/routers/router/transport + username = router + password = password for "public.localhost" router user + + # second entry, where "transport/server" == "private.localhost" : + /config/routers/router/transport + username = router + password = password for "private.localhost" router user + +
+
+
+ Create Configuration Files for Users Needing srfsh + The software installation will automatically create a utility named srfsh (surf shell). This is a command line diagnostic tool for testing and interacting with the OpenSRF network software. It will be used in a future step to complete and test the Evergreen installation. See the section "Testing the Installation" for further information. + In this section you will set up a special configuration file for each user who will need to run the utility. Copy the short sample configuration file /openils/conf/srfsh.xml.example to the file .srfsh.xml (note the leading dot!) in the home directory of each user who will use srfsh. Finally, edit each users' .srfsh.xml file and make the following changes: + + Modify domain to be the router hostname (following our domain examples, private.localhost will give srfsh access to all OpenSRF services, while public.localhost will only allow access to those OpenSRF services that are publicly exposed). + Modify username and password to match the opensrf user Jabber user for the chosen domain + Modify logfile to be the full path for a log file to which the user has write access + Modify loglevel as needed for testing + +
+ Example of user's file ".srfsh.xml" + + <?xml version="1.0"?> + <!-- This file follows the standard bootstrap config file layout --> + <!-- found in opensrf_core.xml --> + <srfsh> + <router_name>router</router_name> + <domain>private.localhost</domain> + <username>opensrf</username> + <passwd>evergreen</passwd> + <port>5222</port> + <logfile>/tmp/srfsh.log</logfile> + <!-- 0 None, 1 Error, 2 Warning, 3 Info, 4 debug, 5 Internal (Nasty) --> + <loglevel>4</loglevel> + </srfsh> + +
+
+
+ Modify the OpenSRF Environment + As the opensrf user user, change the permissions of .cgi files in the directory /openils/var/cgi-bin to executable, then modify the shell configuration file ~/.bashrc for opensrf by adding a Perl environmental variable. Finally, execute the shell configuration file to load the new variables into your current environment. + + + In a multi-server environment, you must add any modifications to ~/.bashrc to the top of the file before the line [ -z "$PS1" ] && return. This will allow headless (scripted) logins to load the correct environment. + + +
+ Commands to modify the OpenSRF environment + + # change permissions + $ su - opensrf + $ chmod 755 /openils/var/cgi-bin/*.cgi + + # add environmental variable + $ echo "export PERL5LIB=/openils/lib/perl5:\$PERL5LIB" >> ~/.bashrc + + # inherit the new environment + $ . ~/.bashrc + +
+
+
+ Starting Evergreen + + + As the root user, start the "ejabberd" and "memcached" services (if they are not already running): +
+ Commands to start "ejabberd" and "memcached" services + + $ su - root + $ /etc/init.d/ejabberd start + $ /etc/init.d/memcached start + +
+ + + As the opensrf user user, start Evergreen. + Use the flag -l to force Evergreen to use localhost (your current system) as the hostname. Using the start_all option will start the OpenSRF router, Perl services, and C services: +
+ Commands to start Evergreen + + $ su - opensrf + + # ensure you have the needed path + $ export PATH=$PATH:/openils/bin + + # start the OpenSRF service: + # use "-l" to force hostname to be "localhost" + $ osrf_ctl.sh -l -a start_all + +
+ + + You can also start Evergreen without the -l flag, but the utility osrf_ctl.sh must know the fully qualified domain name for the system on which it will execute. That hostname may have been specified in the configuration file opensrf.xml, which you configured in a previous step. + + + + ZZZ-REVIEW + ADD EXPLANATION FOR CONFIGURING "opensrf.xml" + + ADD EXPLANATION FOR CONFIGURING "opensrf.xml" + Execute the following command to determine the fully qualified domain name of your system: +
+ (OPTIONAL) Commands to determine the fully qualified domain name + + $ perl -e 'use Net::Domain qw(hostfqdn); print hostfqdn()."\n"' + +
+ + When you attempt to start Evergreen, if you receive an error message similar to osrf_ctl.sh: command not found, then your environment variable PATH does not include the directory /openils/bin. As the opensrf user user, edit the configuration file /home/opensrf/.bashrc and add the following line: export PATH=$PATH:/openils/bin + When you attempt to start Evergreen, if you receive an error message similar to Can't locate OpenSRF/System.pm in @INC ... BEGIN failed--compilation aborted, then your environment variable PERL5LIB does not include the directory /openils/lib/perl5. As the opensrf user user, edit the configuration file /home/opensrf/.bashrc and add the following line: export PERL5LIB=$PERL5LIB:/openils/lib/perl5 + + + + As the opensrf user user, generate the Web files needed by the Staff Client and catalogue, and calculate the proximity of locations in the Organizational Unit tree (which allows Holds to work properly). + You must do this the first time you start Evergreen, and after any changes you make to the library hierarchy in the configuration file config.cgi. +
+ Commands to generate web files + + $ su - opensrf + $ cd /openils/bin + $ ./autogen.sh -c /openils/conf/opensrf_core.xml -u + Updating Evergreen organization tree and IDL using '/openils/conf/opensrf_core.xml' + Updating fieldmapper + ... + + + ZZZ-REVIEW + ADD RESULTS OF TESTS FROM "autogen.sh" + + ADD RESULTS OF TESTS FROM "autogen.sh" +
+ + + As the root user, restart the Apache Web server: +
+ Commands to restart Apache web server + + $ su - root + $ /etc/init.d/apache2 restart + +
+ If the Apache Web server was running when you started the OpenSRF services, you might not be able to successfully log in to the OPAC or Staff Client until the Apache Web server is restarted. + + +
+
+ Testing the Installation + This section describes several simple tests you can perform to verify that the Evergreen server-side software has been installed and configured properly and is running as expected. +
+ Testing Connections to Evergreen + Once you have installed and started Evergreen, test your connection to Evergreen. As the opensrf user user start the utility srfsh and try logging onto the Evergreen server using the default administrator username and password. Following is sample output generated by executing that script after a successful Evergreen installation: +
+ Commands to test Evergreen with "srfsh" + + $ su - opensrf + $ /openils/bin/srfsh + srfsh% login admin open-ils + Received Data: "250bf1518c7527a03249858687714376" + ------------------------------------ + Request Completed Successfully + Request Time in seconds: 0.045286 + ------------------------------------ + Received Data: { + "ilsevent":0, + "textcode":"SUCCESS", + "desc":" ", + "pid":21616, + "stacktrace":"oils_auth.c:304", + "payload":{ + "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a", + "authtime":420 + } + } + ------------------------------------ + Request Completed Successfully + Request Time in seconds: 1.336568 + ------------------------------------ + +
+
+
+ Other Connection Tests with "srfsh" + + There is another srfsh command called math_bench that sends queries to the math servers. Note that the opensrf.math and opensrf.dbmath must be running for this command to work: + +srfsh# math_bench 10 +|.........|.........|.........|.........|.........|.........|.........|.........|.........|......... +++++++++++++++++++++++++++++++++++++++++ +Average round trip time: 0.033425 +srfsh# + + The first argument is how many sets of 4 queries (+ - * /) are sent to opensrf.math. When the response is successful, you will see the string of "+" symbols. If the system is not running correctly, you will either get an exception or no result at all. + For other srfsh commands, type help in at the prompt. + + If this does not work, try the troubleshooting steps in the following section. +
+
+ Testing with "settings-tester.pl" + As the opensrf user, run the script settings-tester.pl to see if it finds any system configuration problems. Following is sample output generated by executing that script after a successful Evergreen installation: + + ZZZ-REVIEW + REWORK THIS DIAGRAM TO USE SAME IMAGE STANDARDS AS OTHER CHAPTERS + + REWORK THIS DIAGRAM TO USE SAME IMAGE STANDARDS AS OTHER CHAPTERS +
+ Executing the script <command>settings-tester.pl</command> + + + + + + + + + + +
+ If the output from the script does not help you find the problem, please do not make any further significant changes to your configuration. Follow the steps in the troubleshooting guide, "Troubleshooting". + If you have followed the entire set of installation steps listed here closely, you are probably extremely close to a working system. Gather your configuration files and log files and contact the Evergreen development mailing list for assistance before making any drastic changes to your system configuration. +
+
+ Testing the Catalog + By default, the OPAC will live at the URL http://my.domain.com/. + Navigate to this URL and the front page of the OPAC should load. There is a basic text entry field with some extra search options. If you have any problems loading this page, check the Apache error logs. If the page loads but does not function correctly, then check for possible javascript errors. We hightly reccommend testing with the Firefox browser because of the helpful javascript debugging tools. + Assuming that the OPAC is functioning and there is data in your database, you can now perform other simple functional tests (e.g., searching the catalog). + + ZZZ-REVIEW + ADD OTHER SIMPLE FUNCTIONAL TESTS + + ADD OTHER SIMPLE FUNCTIONAL TESTS +
+
+ Running the Evergreen Staff Client + Run the Evergreen Staff Client by using the application XULRunner (installed automatically and by 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 follows: +
+ Commands to run the Staff Client + + $ su - opensrf + $ xulrunner /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client/build/application.ini + +
+
+
+ Testing the Apache Web Server + Once you have started Evergreen and confirmed that a basic login attempt works, you can test and start the Apache web server. + As the root user, execute the following commands. Note the use of restart to force the new Evergreen modules to be reloaded even if the Apache server is already running. Any problems found with your configuration files should be displayed: +
+ Commands to test the Apache Web Server + + $ su - root + $ apache2ctl configtest && /etc/init.d/apache2 restart + +
+
+
+
+ Stopping Evergreen + As the opensrf user user, stop all Evergreen services by using the following command: +
+ Commands to stop Evergreen + + $ su - opensrf + + # stop the server: + # use "-l" to force hostname to be "localhost" + $ osrf_ctl.sh -l -a stop_all + +
+ + + You can also stop Evergreen services without the -l flag, but the utility osrf_ctl.sh must know the fully qualified domain name for the system on which it will execute. That hostname may have been specified in the configuration file opensrf.xml, which you configured in a previous step. + + + + ZZZ-REVIEW + ADD EXPLANATION FOR CONFIGURING "opensrf.xml" + + ADD EXPLANATION FOR CONFIGURING "opensrf.xml" +
+
+ Post-Installation Chores +
+ Remove temporary changes from Apache configuration file + As the root user, edit the Apache configuration file /etc/apache2/sites-available/eg.conf again and make the following change: + Uncomment the line Allow from 10.0.0.0/8, then comment out the line Allow from all. You modified this file in an earlier step as a temporary measure to expedite testing (see the section "Modify the Apache Configuration File" for further information). Those changes must now be reversed in order to deny unwanted access to your CGI scripts from users on other public networks. You must secure this for a public production system. +
+
+ Configure a permanent SSL key + In a previous step, we used the command openssl to temporarily create a new SSL key for the Apache server. For a public production server you should configure or purchase a signed SSL certificate + + + The temporary SSL key was only created to expedite testing. You must get a proper SSL certificate for a public production system. + + + + ZZZ-REVIEW + ADD EXPLANATION OF HOW TO GET PERMANENT SSL CERTIFICATE + + ADD EXPLANATION OF HOW TO GET PERMANENT SSL CERTIFICATE +
+
+ Set Up Support For Reports + Evergreen reports are extremely powerful, but some configuration is required. See the section "Reports" for details. + + + Starting the Reporter Daemon + Once the open-ils.reporter process is running and enabled on the gateway, you can start the reporter daemon. That process periodically checks for requests for new reports or scheduled reports and gets them running. + As the opensrf user user, start the reporter daemon using the following command: +
+ Commands to start the Reporter daemon + + $ su - opensrf + $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/src/reporter + $ ./clark-kent.pl --daemon + +
+ You can also specify other options with this utility: + + --sleep=interval : number of seconds to sleep between checks for new reports to run; defaults to 10 + --lockfile=filename : where to place the lockfile for the process; defaults to /tmp/reporter-LOCK + --concurrency=integer : number of reporter daemon processes to run; defaults to "1" + --bootstrap=filename : OpenSRF bootstrap configuration file; defaults to /openils/conf/opensrf_core.xml + + + + Stopping the Reporter Daemon + To stop the Reporter daemon, you must kill the process and remove the lockfile. The daemon may have just a single associated process, with a lockfile in the default location. + + + It is possible that several processes are running; see the optional commands in the previous section. As the opensrf user user, perform the following commands to stop the Reporter daemon: + + +
+ Commands to stop the Reporter daemon + + $ su - opensrf + # find and kill the process ID number(s) + $ kill `ps wax | grep "Clark Kent" | grep -v grep | cut -b1-6` + # remove the lock file + $ rm /tmp/reporter-LOCK + +
+ + +
+
+
+
+ Installing In Virtualized Unix Environments + Evergreen software currently runs as a native application on any of several well-known Linux distributions (e.g., Ubuntu and Debian). It does not run as a native application on the Windows operating system (e.g., WindowsXP, WindowsXP Professional, Windows7), but the software can be installed and run on Windows via a virtualized Unix-guest Operating System (using, for example, VirtualBox or VMware to emulate a Linux environment). + + ZZZ-REVIEW + ADD CONTENT FOR INSTALLING EVERGREEN IN VIRTUALIZED UNIX ENVIRONMENTS + + ADD CONTENT FOR INSTALLING EVERGREEN IN VIRTUALIZED UNIX ENVIRONMENTS +
+ VirtualBox + + ZZZ-REVIEW + ADD CONTENT FOR VirtualBox + + ADD CONTENT FOR VirtualBox +
+
+ VMware + + ZZZ-REVIEW + ADD CONTENT FOR VMware + + ADD CONTENT FOR VMware +
+
+ VirtualPC + + ZZZ-REVIEW + ADD CONTENT FOR VirtualPC + + ADD CONTENT FOR VirtualPC +
+
+
+ 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.x. +
+ Installing Evergreen 1.4.0.6 on Ubuntu or Debian + + ZZZ-REVIEW + ADD CONTENT FOR INSTALLING EVERGREEN 1.4.0.6 ON UBUNTU OR DEBIAN + + ADD CONTENT FOR INSTALLING EVERGREEN 1.4.0.6 ON UBUNTU OR DEBIAN +
+
+ Installing OpenSRF 1.0.x + + ZZZ-REVIEW + ADD CONTENT FOR INSTALLING OPENSRF 1.0.x + + ADD CONTENT FOR INSTALLING OPENSRF 1.0.x +
+
+
+ Installing PostgreSQL + + ZZZ-REVIEW + ADD CONTENT FOR POSTGRESQL + + ADD CONTENT FOR POSTGRESQL +
+
+ 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 +
+
+
+ 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 the section "Manually Building the Staff Client". +
+ 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 Windows + A standard Microsoft 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 the Next button 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 the Re-Test Server button. + 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 the section "Assigning Workstation Names". +
+
+ Installing on Mac OS X + A Mac 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. 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 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 "build" directory 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 "Resources" folder 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 +
+
+ Running directly using XULRunner + You must install an apropriate version of XULRunner to match the Evergreen version. See the following table for the recommended version of XULRunner: + + Evergreen / XULRunner Dependencies + + + + + + Evergreen 1.6.x.x + XULrunner 1.9 + + + Evergreen 1.4.x.x + XULrunner 1.8.0.4 or XULrunner 1.8.0.3 + + + Evergreen 1.2.x.x + XULrunner 1.8.0.4 or XULrunner 1.8.0.3 + + + +
+ If you have issues removing previously installed XULRunner versions see the next section on removing previous XULRunner versions. + The staff client data from the ./staff_client/build directory 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 XULRunner + + /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 XULRunner 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 receiptdb file. + 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. +
+
+ Creating an APP file: Staff Client & XULRunner Bundled + An APP file is basically a folder. Start with a folder stucture like this: +
+ Sample APP file folder structure + + * 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 + +
+ + + + Create a new file in the folder Evergreen.app/Contents/Info.plist containing the following data (adjust for your version of Evergreen): +
+ Creating a new file + + <?xml version="1.0" encoding="UTF-8"?> + <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> + <plist version="1.0"> + <dict> + <key>CFBundleExecutable</key> + <string>xulrunner</string> + <key>CFBundleGetInfoString</key> + <string>OpenILS open_ils_staff_client rel_1_6_0_7</string> + <key>CFBundleInfoDictionaryVersion</key> + <string>6.0</string> + <key>CFBundleName</key> + <string>Evergreen Staff Client</string> + <key>CFBundlePackageType</key> + <string>APPL</string> + <key>CFBundleShortVersionString</key> + <string>rel_1_6_0_7</string> + <key>CFBundleVersion</key> + <string>rel_1_6_0_7.rel_1_6_0_7</string> + <key>NSAppleScriptEnabled</key> + <true/> + <key>CFBundleTypeIconFile</key> + <string>Evergreen.icns</string> + </dict> + </plist> + +
+ + Download and install an appropriate Mac OS package 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: +
+ Example of APP file framework + + * Evergreen.app/ + __* Contents/ + ____* Frameworks/ + ______* XUL.Framework/ + ______* Versions/ + ________* Current -> 1.9.1.3 (symlink) + ________* 1.9.1.3/ + ______* XUL -> Versions/Current/XUL + ______* 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). + + 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. + +
+ + Put a Mac format icon file named Evergreen.icns in Resources. + +
+
+
+ Installing on Linux +
+ 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, just copy the directory tree containing the Staff Client from the server to the remote workstation. + The following example assumes you already have an "opensrf" user account on both the server and the remote workstation. Remember to replace "user", "client.linux.machine" and "eg-client-x.x.x.x" with the proper user name, client machine name, and version number in the following example. + As the opensrf user user, change directory to the Staff Client source directory, then recursively copy the entire directory tree to the remote workstation: +
+ Copying the Staff Client to a 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 user log into the remote workstation and execute it as shown: +
+ Testing the copied Staff Client + + $ su - opensrf + $ 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. + In order to install a compatible Staff Client on another Linux system, just copy the applicable files from the server to that system, or even manually build it on that system. Ensure that the BUILD_ID you choose on the server matches the BUILD_ID for each staff client you use on other systems. + If you will be using a pre-packaged Windows version on some systems, you may want to choose the BUILD_ID on both server and other versions to match that of the Windows Staff Client. To determine which BUILD_ID is used in an existing Staff Client installation, just click "About this Client" on the running Staff Client. + If you are allowed to make changes on the Evergreen server, another option is to create a symbolic link. In order for a copy of the Staff Client and 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. +
+ Creating a symbolic link + + $ 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 build the Staff Client on a Linux system without installing the Evergreen Server component. This is a relatively simple process compared to server installation, but does require some command-line work. The following directions are for building Staff Client version 1.2.1.4 on Kubuntu 7.10; you must modify them for other distributions (the instructions should work as-is for Ubuntu or Ubuntu derivatives). + + + Prerequisites + Both "subversion" and "xulrunner" are required to build the Staff Client. As the root user, use "apt-get" to install packages for "subversion" and "xulrunner". You can also use "synaptic", the graphical user interface for "apt-get". For "subversion", select the latest version; for "xulrunner", select version 1.8.1.4-2ubuntu5. +
+ Installing subversion and xulrunner + + $ sudo apt-get install subversion + $ sudo apt-get install xulrunner + +
+ + + Download the Source Code + + + 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 admininstrator, 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 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: +
+ Downloading the source code + + $ su - opensrf + $ cd /YOUR/DOWNLOAD/DIRECTORY + $ svn co svn://svn.open-ils.org/ILS/tags/rel_1_2_1_4/ + +
+ Remember to change "rel_1_2_1_4" to the appropriate tag for your installation. + + + + + 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. + As the opensrf user user, run the following commands to build the Staff Client: +
+ Finding the downloaded source code + + $ su - opensrf + $ cd /YOUR/DOWNLOAD/DIRECTORY + $ cd Open-ILS/xul/staff_client + $ make STAFF_CLIENT_BUILD_ID='rel_1_2_1_4' + ... + +
+
+
+ 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: + FIXME -- Need instructions for getting certain Javascript files from OpenSRF, preferably without actually installing OpenSRF. + +
+ Building 1.4.x + + $ 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/ + $ ./configure --prefix=/openils --sysconfdir=/openils/conf + $ cd Open-ILS/xul/staff_client/ + $ make STAFF_CLIENT_BUILD_ID='rel_1_4_0_4' install + +
+ + If you're installing from a Subversion checkout: +
+ Building 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 + $ ./configure --prefix=/openils --sysconfdir=/openils/conf + $ cd Open-ILS/xul/staff_client/ + $ make STAFF_CLIENT_BUILD_ID='rel_1_4_0_4' install + +
+
+ + + Run the Staff Client (from the command line) + As the opensrf user user, navigate to the build/ subdirectory (not staff_client/) and run the following command: +
+ Running the Staff Client + + $ su - opensrf + $ 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: +
+ Creating a "staging" directory + + $ 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: +
+ Testing the copied Staff Client + + $ 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: +
+ Cleaning up + + $ 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: +
+ Running the copied Staff Client + + $ xulrunner ~/<Destination Directory>/staff_client/build/application.ini + +
+ + +
+
+ Using Wine 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. + + + Install wine +
+ Installing "wine" + + $ sudo apt-get install wine + +
+ + + Download Windows installer for the Staff Client + As the opensrf user 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: +
+ Downloading the Staff Client installer + + $ su - opensrf + $ cd /YOUR/DOWNLOAD/DIRECTORY + $ wget http://open-ils.org/downloads/evergreen-setup-rel_version-number.exe + +
+ + + Run the downloaded Windows installer + As the opensrf user user, navigate to the directory where you downloaded the Windows executable file, then execute it: +
+ Using Wine to run the Windows installer + + $ 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 Windows XP. To do so, type "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 "Wine->Program Files->Evergreen Staff Client->Evergreen 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 the section Configuring a Proxy for the Staff Client. +
+
+
+ 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. +
+ Example of unconfigured Staff Client + + + + + +
+ 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: +
+ Example of configured Staff Client + + + + + +
+ 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: +
+ Example of registered Staff Client + + + + + +
+ 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 the section "Compile, Link and Install Evergreen" 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.x/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. + The following commands could be used during the normal build process: +
+ Commands used during normal Evergreen build + + $ 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 user, change directory to the Staff Client source directory, then set the variable and build the Staff Client: +
+ Commands to manually 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. + The following commands could be used during the normal build process: +
+ Commands used during normal Evergreen build + + $ su - root + $ cd /home/opensrf/Evergreen-ILS-1.6.0.7 + $ make STAFF_CLIENT_VERSION=0mytest.200 install + ... + +
+ 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" than older versions. + As the opensrf user user, change directory to the Staff Client source directory, then set the variable and build the Staff Client: +
+ Commands to manually 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: +
+ Commands used during normal Evergreen build + + $ 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 client-side customizations. + As the opensrf user user, change directory to the Staff Client source directory, then set the variable and build the Staff Client: +
+ Commands to manually 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 make target keywords: + + Keywords Targets for "make" Command + + + + + + Keyword + Description + + + + + clients + Runs "make win-client", "make linux-client", and "make generic-client" individually + + + client_dir + Builds a client directory from the build directory, without doing a rebuild. The same as "copy everything but server/". + + + client_app + Prerequisite "client_dir"; removes "install.rdf" from client directory so an APP bundle can't be installed as an extension + + + client_ext + Prerequisite "client_dir"; remove "application.ini", "autoupdate.js", "standalone_xul_app.js" from client directory so an extension won't break Firefox + + + extension + Prerequisite "client_ext"; rewritten to use "client_ext" + + + generic-client + Prerequisite "client_app"; makes an XPI file suitable for use with "xulrunner --install-app"" + + + win-xulrunner + Prerequisite "client_app"; adds Windows xulrunner to client build + + + linux-xulrunner + Prerequisite "client_app"; adds Linux xulrunner to client build + + + win-client + Prerequisite "win-xulrunner"; builds "setup exe" (requires that "nsis" package be installed, will add options for automatic update if configured and developer options if client build was a "make devbuild") + + + linux-client + Prerequisite "linux_xulrunner"; builds a "tar.bz2" bundle of the Linux client + + + [generic-|win-|linux-|extension-]updates[-client] + Calls external/make_updates.sh to build full and partial updates generic/win/linux/extension prefix limit to that distribution; Adding "-client" builds clients and copies them to a subdirectory of the "updates" directory as well; "extension-updates-client" doesn't exist. + + + +
+ Descriptions of other special build options follow: + + + Developer Build + You can create a so-called "developer build" of the Staff Client by substituting "devbuild" for "build" when running make. The build will contain an extra configuration file that enables some developer options. + As the opensrf user 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 "Closure Compiler" utility 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 user, run the following commands from the Staff Client source directory: +
+ Commands to compress Javascript + + $ 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 user, run the following commands from the Staff Client source directory: +
+ Commands to compress Javascript and do a "developer build" + + $ 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 + ... + +
+ 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 user, change directory to the Staff Client source directory, then set the variable and build the Staff Client: +
+ Commands to manually specify AUTOUPDATE_HOST + + $ 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 the section "Automatic Updates". + + +
+
+ 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 of installing the Staff Client on the same machine it was built on, or on a different machine. + Assuming you have already built the Staff Client, and that your installation is in the directory /openils/var/web/xul, as the opensrf user user, change directory to the Staff Client source directory, then execute the following commands: +
+ Commands to install the Staff Client on the same machine + + $ 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 targetted 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 parameter --install-app. + As the opensrf user user, change directory to the Staff Client source directory, then execute the following commands: +
+ Commands to package a "generic" client + + $ 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: + + Useful icon ID strings + + + + + + IDI_APPICON + Tray icon + + + 32512 + Default window icon + + + +
+ As the opensrf user user, change directory to the Staff Client source directory, then execute the following commands: +
+ Commands to build a Windows client + + $ su - opensrf + $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client + $ make win-client + ... + +
+ + + Packaging a Linux Client + This build creates a Staff Client package for Linux as a "tar.bz2" file with XULRunner already bundled with it. It creates the output file "evergreen_staff_client.tar.bz2". + As the opensrf user user, change directory to the Staff Client source directory, then execute the following commands: +
+ Commands to build a Linux client + + $ su - opensrf + $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client + $ make linux-client + ... + +
+ + + Packaging a Firefox Extension + This build requires that you already have the "zip" utility installed on your system. It creates a Staff Client packaged as a Firefox extension and creates the output file "evergreen.xpi". + As the opensrf user user, change directory to the Staff Client source directory, then execute the following commands: +
+ Commands to build a Firefox extension + + $ 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. Servers with exceptions added to force the Staff Client to accept them WILL NOT WORK. + In addition, automatic updates have special requirements for the file update.rdf: + + It must be served from an SSL server, or + It must be signed with the McCoy tool. + + 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: + + At configuration time for the normal build of the Evergreen server-side software, or + During a manual Staff Client build process. + + + + + At configuration time for the normal build of Evergreen server-side software + This must be done when the Evergreen server-side software is first configured (see the section "Configure Evergreen" ). As the opensrf user user, use the utility "configure" as shown: +
+ Commands to configure Evergreen + + $ su - opensrf + $ cd /home/opensrf/Evergreen-ILS-1.6.0.7 + $ ./configure --prefix=/openils --sysconfdir=/openils/conf --with-updateshost=hostname + $ make + ... + +
+ + + During a manual Staff Client build process + You will used the variable AUTOUPDATE_HOST=hostname (see above). If you specify just a hostname (such as "example.com") then the URL will be a secure URL (such as "https://example.com". If you wish to use a non-HTTPS URL then prefix the hostname with "http://" (such as "http://example.com"). + 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 full update will be used as a fallback. Extensions do not currently support partial updates. + As the opensrf user user, change directory to the Staff Client source directory, then execute the following commands: +
+ Commands for building updates + + $ 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 + ... + + # 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. + The clients will be installed alongside the updates and listed on the "manualupdate.html" page, rather than left in the Staff Client directory. + As the opensrf user user, change directory to the Staff Client source directory, then execute the following commands: +
+ Commands for building updates + + $ 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 an "updates" directory that, by default, points to the directory /openils/var/updates/pub. This directory contains one HTML file and several specially-named script files. + The "updatedetails.html" file is the fallback web page for the update details. The "check" script is used for XULRunner updates. The "update.rdf" script is used for extension updates. The "manualupdate.html" script checks for clients to provide download links when automatic updates have failed and uses the download script to force a download of the generic client XPI (compared to Firefox trying to install it as an extension). + 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: +
+ Changing file permissions of scripts + + $ 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 "-profilemanager" or "-P" (uppercase "P") to force the Profile Manager to start. Unchecking the "Don't ask at startup" 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 user, change directory to the Staff Client source directory, then execute the following commands: +
+ Command to add start menu option + + $ 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 "-no-remote" (in addition to "-profilemanger" or "-P" if neeeded). 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 + Run the Staff Client on a Linux system by using the application XULRunner (installed automatically and by 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: +
+ Commands to run the Staff Client + + $ su - opensrf + $ xulrunner /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client/build/application.ini + +
+
+
+ Configuring a Proxy for the Staff Client +
+ Why Use a Proxy for the Staff Client? + There are several reasons for sending network traffic for the Staff Client through an SSH proxy: + + + Firewalls may prevent you from reaching the server. This may happen when you are connecting the Staff Client to a test server that should not be available generally, or it may be the result of network design priorities other than ease of use. + + + You may wish to improve security where Staff Client traffic may be susceptible to network eavesdropping. This is especially true when wireless is otherwise the best option for connecting a staff machine to the network. + + +
+
+ Setting Up an SSH Tunnel + You will need a server that allows you to log in via SSH and has network access to the Evergreen server you want to reach. You will use your username and password for that SSH server to set up a tunnel. + For Windows users, one good solution is the open-source utility PuTTY, a free telnet/SSH client]]. When setting up a PuTTY session: +
+ Setting up an SSH tunnel in PuTTY + + + + + +
+ + Use the menu on the left to go to Connection > SSH > Tunnels. + Enter ''9999'' in the "Source port". + Choose "Dynamic". Do not enter anything in the Destination text entry box. + Click the "Add" button. "D9999" will now appear in the "Forwarded ports" list. + 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 find the appropriate section for the following changes. +
+ The SOCKS section of "all.js" before changes + + + + + +
+ Make the following changes: + + Change the value of network.proxy.socks from "" to "localhost". + Change the value of network.proxy.socks_port from "0" to 9999. + +
+ The SOCKS section of "all.js" after changes + + + + + +
+ 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. +
+
+
+
+ memcached Servers + + ZZZ-REVIEW + ADD CONTENT FOR MEMCACHED + + ADD CONTENT FOR MEMCACHED +
+
+ Organization and Policy Editing + After installing Evergreen, you will want to make configuration changes to reflect the organizational hierarchy and the policies of your library or libraries. See the section "Organizational Unit Types and Organizational Units" for further information. Examples of what can be configured include: + + Adding a branch library + Changing circulation rules for an existing library + Adding a new staff position or user group + + + ZZZ-REVIEW + ADD CONTENT FOR ORGANIZATION AND POLICY EDITING + + ADD CONTENT FOR ORGANIZATION AND POLICY EDITING +
+
+ Installing the SIP Server + + ZZZ-REVIEW + ADD CONTENT FOR INSTALLING THE SIP SERVER + + ADD CONTENT FOR INSTALLING THE SIP SERVER +
+
+ Using nginx to serve static content + + ZZZ-REVIEW + ADD CONTENT FOR USING NGINX TO SERVE STATIC CONTENT + + ADD CONTENT FOR USING NGINX TO SERVE STATIC CONTENT +
+
+ (OPTIONAL) Configuration for Other Languages + This section describes how translations such as Armenian (hy-AM), Canadian French (fr-CA) and others are loaded into the database to complete the translations (default English) available in the OPAC and Staff Client. + + ZZZ-REVIEW + ADD SECTION ON LANGUAGE LOCALIZATION + + ADD SECTION ON LANGUAGE LOCALIZATION +
+ + + -- 2.43.2