From 2f990cea64d8b0b9f1454e8fe5ac6125833b61d8 Mon Sep 17 00:00:00 2001 From: Robert Soulliere Date: Tue, 2 Nov 2010 17:41:47 -0400 Subject: [PATCH] DocBook Formatting and clean up. --- 1.6/admin/serversideinstallation.xml | 3719 +++++++++++-------------- 1.6/admin/staffclientinstallation.xml | 2046 +++++++------- 2 files changed, 2642 insertions(+), 3123 deletions(-) diff --git a/1.6/admin/serversideinstallation.xml b/1.6/admin/serversideinstallation.xml index b86d97ed59..1ba1848cae 100644 --- a/1.6/admin/serversideinstallation.xml +++ b/1.6/admin/serversideinstallation.xml @@ -1,2079 +1,1640 @@ - - - - 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. - - - Installing, configuring and testing the Evergreen server-side software is straightforward with the current - stable software release. See for instructions tailored to - installing on some particular distributions of the Linux operating - system. - 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 Microsoft 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 Linux-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 - . - Installation of the Evergreen Staff Client software is reviewed in . - The Evergreen server-side software has dependencies on particular versions of certain major software - sub-components. Successful installation of Evergreen software requires that software versions agree with those - listed here: - - Evergreen Software Dependencies - - - - - - - Evergreen - OpenSRF - PostgreSQL - - - - - 1.6.1.x - 1.4.0 - 8.2 / 8.3 - - - 1.6.0.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 - - - -
-
- 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 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.4.x On <systemitem class="osname">Ubuntu</systemitem> or - <systemitem class="osname">Debian</systemitem> - 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.4.0 has been tested on Debian Etch - (4.0), Debian Lenny (5.0) and - Ubuntu Lucid Lynx (10.04). - In the following instructions, you are asked to perform certain steps as either - the root user, the - opensrf user, or the - postgres user. - - - Debian -- To become the - root user, issue the command - su - and enter the password of the - root user. - - - Ubuntu -- To become the - root user, issue the command - sudo su - and enter the password of the - root user. - - - To switch from the root user to a - different user, issue the command su - USERNAME. For example, to - switch from the root user to the - opensrf user, issue the command - su - opensrf. Once you have become a non-root user, to become - the root user again, simply issue the command - exit. - - - - Add the OpenSRF User - As the root user, add the - opensrf user to the system. The default shell for the new user is automatically - set to /bin/bash to inherit a reasonable environment: - - useradd -m -s /bin/bash opensrf - passwd opensrf - - - - Download and Unpack Latest OpenSRF Version - As the opensrf user, download - and extract the latest version of OpenSRF. The latest version can be found here: - - - wget http://evergreen-ils.org/downloads/OpenSRF-1.4.0.tar.gz - tar zxf OpenSRF-1.4.0.tar.gz - - The new directory - /home/opensrf/OpenSRF-1.4.0 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 OpenSRF 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 name of the Linux - distribution listed in the distribution keywords table - . - - cd /home/opensrf/OpenSRF-1.4.0 - make -f src/extras/Makefile.install [DISTRIBUTION] - - - Keyword Targets for OpenSRF <application>"make"</application> Command - - - - - - Keyword - Description - - - - - debian-etch - for Debian Etch (4.0) - - - debian-lenny - for Debian Lenny (5.0) - - - ubuntu-hardy - for Ubuntu Hardy Heron (8.04) - - - ubuntu-karmic - for Ubuntu Karmic Koala (9.10) - - - ubuntu-lucid - for Ubuntu Lucid Lynx (10.04) - - - -
- This will install a number of packages on the system that are required by OpenSRF, - including some Perl modules from CPAN. You can say No to the initial - CPAN configuration prompt to allow it to automatically configure itself to download and - install Perl modules from CPAN. The CPAN installer will ask you a number of times whether - it should install prerequisite modules - say Yes. - - - Build OpenSRF - - - Configure OpenSRF - As the opensrf - user, return to the OpenSRF build directory and use the - configure utility to prepare for the next - step of compiling and linking the software. If you wish to - include support for Python and Java, add the configuration - options and - , respectively: - - cd /home/opensrf/OpenSRF-1.4.0 - ./configure --prefix=/openils --sysconfdir=/openils/conf - make - - - - Compile, Link and Install OpenSRF - As the root - user, return to the OpenSRF build directory and use the - make utility to compile, link and install - OpenSRF: - - cd /home/opensrf/OpenSRF-1.4.0 - make install - - - - Update the System Dynamic Library Path - You must update the system dynamic library path to force - your system to recognize the newly installed libraries. As the - root user, do this by - creating the new file - /etc/ld.so.conf.d/osrf.conf containing a - new library path, then run the command - ldconfig to automatically read the file and - modify the system dynamic library path: - - echo "/openils/lib" > /etc/ld.so.conf.d/osrf.conf - ldconfig - - - Define Public and Private OpenSRF DomainsYou must define your public and private OpenSRF - domains. For security purposes, OpenSRF uses Jabber domains to - separate services into public and private realms. Throughout - these instructions, we will use the example domains public.localhost for the public - domain and private.localhost for the - private domain. On a single-server system, the easiest way to - define public and private domains is to define separate host - names by adding entries to the file - /etc/hosts. As the root user, edit the file - /etc/hosts and add the following entries - for our example domains:127.0.1.2 public.localhost public127.0.1.3 private.localhost private - - Change File Ownerships - As the root - user, change the ownership of all files installed in the - directory /openils to the - user opensrf: - - chown -R opensrf:opensrf /openils - - - - - - Stop the <systemitem class="service">ejabberd</systemitem> Service - As the root user, 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 - configuration file /etc/ejabberd/ejabberd.cfg - to hardcode a domain: - - epmd -kill - killall beam; killall beam.smp - rm /var/lib/ejabberd/* - echo 'ERLANG_NODE=ejabberd@localhost' >> /etc/default/ejabberd - - - - Edit the <systemitem class="service">ejabberd</systemitem> configuration - As the root user, edit the file - /etc/ejabberd/ejabberd.cfg and make the following - changes: - - - Change - {hosts, ["localhost"]}. - to: - {hosts, ["localhost", "private.localhost", "public.localhost"]}. - - - Change - {max_user_sessions, 10}. to - {max_user_sessions, 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 - to2000000. - - - Change both occurrences of maxrate to - 500000. - - - Comment out the line {mod_offline, []} - by placing two % comment signs in front. - - - - - Restart the <systemitem class="service">ejabberd</systemitem> service - As the root user, restart the - ejabberd service to test the - configuration changes and to register your users: - - /etc/init.d/ejabberd start - - - - Register <systemitem class="username">router</systemitem> and - <systemitem class="username">ejabberd</systemitem> 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 - ejabberdctl utility 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: - - # - ejabberdctl register router private.localhost - ejabberdctl register opensrf private.localhost - ejabberdctl register router public.localhost - ejabberdctl register opensrf public.localhost - ]]> - - - Create configuration files - As the opensrf user, use the - example templates to create the configuration files - /openils/conf/opensrf_core.xml and - /openils/conf/opensrf.xml from the example templates: - - cd /openils/conf - cp opensrf.xml.example opensrf.xml - cp opensrf_core.xml.example opensrf_core.xml - - - - Change Jabber usernames and passwords - As the opensrf user, edit the - OpenSRF configuration file /openils/conf/opensrf_core.xml - to update the Jabber usernames and passwords to match the values shown in the - following table. The left-hand side of - shows common XPath syntax to indicate the approximate position within the XML - file that needs changes. The right-hand side of the table shows the replacement - values. - - Sample XPath syntax for editing "opensrf_core.xml" - - - - - - XPath location - Value - - - - - /config/opensrf/username - - opensrf - - - - /config/opensrf/passwd - password for - private.localhostopensrf user - - - - /config/gateway/username - - opensrf - - - - /config/gateway/passwd - password for - public.localhostopensrf user - - - - /config/routers/router/transport, - first entry where transport/server == public.localhost: - username - - router - - - - /config/routers/router/transport, - first entry where transport/server == public.localhost: - password - password for - public.localhostrouter user - - - - /config/routers/router/transport, - second entry where transport/server == private.localhost: - username - - router - - - - /config/routers/router/transport, - second entry where transport/server == private.localhost: - password - password for - private.localhostrouter 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. - - - Set location of persistent database - As the opensrf user, edit the - file /openils/conf/opensrf.xml to set the location of the - persistent database in the dbfile element near the end of the - file: - - - - /tmp/persist.db - - - ]]> - - - Create Configuration Files for Users Needing <command>srfsh</command> - 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 OpenSRF. It will be used in a future - step to complete and test the Evergreen installation. See - 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 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 - - - - - - router - private.localhost - opensrf - privsrf - 5222 - /tmp/srfsh.log - - 4 - - ]]> - - - Modify Environmental Variable PATH for - <systemitem class="username">opensrf</systemitem> 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: - - echo "export PATH=/openils/bin:\$PATH" >> ~/.bashrc - - - - Start OpenSRF - As the root user, start the - ejabberd and - memcached services: - - /etc/init.d/ejabberd start - /etc/init.d/memcached start - - Finally, as the opensrf user, - start OpenSRF. Use "-l" to force hostname to be "localhost": - - osrf_ctl.sh -l -a start_all - - - If you receive the error message bash: osrf_ctl.sh: - command not found, then your environment variable - PATH does not include the - /openils/bin directory; - this should have been set by .bashrc when you - logged in as the opensrf user, - but you can manually set it using the following command: - - export PATH=$PATH:/openils/bin - - - You can also start Evergreen without the - 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. - - - Test connections to OpenSRF - Once you have installed and started OpenSRF, as the - root user, test your connection to - OpenSRF using the srfsh - utility and trying to call the add method on the OpenSRF - math service: - - /openils/bin/srfsh - srfsh# - request opensrf.math add 2 2 - Received Data: 4 - ------------------------------------ - Request Completed Successfully - Request Time in seconds: 0.007519 - ------------------------------------ - srfsh# - - For other srfsh commands, type in - help at the prompt. - - - Stopping OpenSRF - As the opensrf user, stop OpenSRF: - - osrf_ctl.sh -l -a stop_all - - - -
-
- Installing Evergreen 1.6.1.x On <systemitem class="osname">Ubuntu</systemitem> or - <systemitem class="osname">Debian</systemitem> - 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, or the - postgres user. - - - Debian -- To become the - root user, issue the command - su - and enter the password of the - root user. - - - Ubuntu -- To become the - root user, issue the command - sudo su - and enter the password of the - root user. - - - To switch from the root user to a - different user, issue the command su - USERNAME. For example, to - switch from the root user to the - opensrf user, issue the command - su - opensrf. Once you have become a non-root user, to become the - root user again, simply issue the command - exit. - - - - Install 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 - . - 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, download - and extract the latest version of Evergreen. The latest version can be found here: - - - wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.1.2.tar.gz - tar zxf Evergreen-ILS-1.6.1.2.tar.gz - - The new directory - /home/opensrf/Evergreen-ILS-1.6.1.2 - 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 - Evergreen 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 name of the Linux - distribution listed in the distribution keywords table - . - - cd /home/opensrf/Evergreen-ILS-1.6.1.2 - make -f Open-ILS/src/extras/Makefile.install [DISTRIBUTION] - - - Keyword Targets for Evergreen <application>"make"</application> Command - - - - - - Keyword - Description - - - - - debian-etch - for Debian Etch (4.0) - - - debian-lenny - for Debian Lenny (5.0) - - - ubuntu-hardy - for Ubuntu Hardy Heron (8.04) - - - ubuntu-karmic - for Ubuntu Karmic Koala (9.10) - - - ubuntu-karmic - for Ubuntu Lucid Lynx (10.04) - - - -
- - - (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. You must install the PostgreSQL server - yourself, either on the same system as Evergreen itself or on another system. - If your PostgreSQL server is on a different system, just skip this step. - For further information on manually installing PostgreSQL, visit the official - PostgreSQL Site. - If your PostgreSQL server will be on the same system as your Evergreen - software, then as the root user - install the required PostgreSQL server packages: - For Debian Lenny and - Ubuntu Hardy (8.04): - - make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_83 - - For Ubuntu Karmic (9.10) and - Ubuntu Lucid (10.04): - - make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_84 - - - PostgreSQL versions 8.3 or 8.4 are the recommended versions to work - with Evergreen 1.6. If you have an older version of PostgreSQL, you should - upgrade before installing Evergreen. To find the running version of - PostgreSQL, as the postgres - user, run the psql. Then type SELECT - version(); to get detailed information about your version - of PostgreSQL. - - - - 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, continue if your PostgreSQL server is running on another system. - You will need to install several Perl modules on the other system. As the - root user install the following Perl - modules: - - # first, ensure the gcc compiler is installed: - apt-get install gcc - # then install the Perl modules: - perl -MCPAN -e shell - cpan> - install JSON::XS - cpan> - install MARC::Record - cpan> - install MARC::File::XML - - For more information on installing Perl Modules vist the official - CPAN site. - - - Update the System Dynamic Library Path - You must update the system dynamic library path to force your system to - recognize the newly installed libraries. As the root user, create a file named - /etc/ld.so.conf.d/eg.conf containing the new library paths: - - /usr/local/lib - /usr/local/lib/dbd - - Then run the command ldconfig to automatically read the - file and modify the system dynamic library path: - - ldconfig - - - - (OPTIONAL) Restart the PostgreSQL Server - If PostgreSQL is running on the same system as the rest of Evergreen, as - the root user you must restart - PostgreSQL to re-read the new library paths just configured. If PostgreSQL is - running on another system, you may skip this step. As the opensrf user, execute the following command, where - [PGSQL_VERSION] is your installed PostgreSQL version - (e.g. 8.3): - - /etc/init.d/postgresql-[PGSQL_VERSION] restart - - - - Configure Evergreen - As the opensrf user, return to - the Evergreen build directory and use the configure and - make utilities to configure Evergreen so it can be compiled - and linked in the next step: - - cd /home/opensrf/Evergreen-ILS-1.6.1.2 - ./configure --prefix=/openils --sysconfdir=/openils/conf - make - - - - Compile, Link and Install Evergreen - In this step you will actually compile, link and install Evergreen and the - default Evergreen Staff Client. - As the root user, return to the - Evergreen build directory and use the make utility as shown - below. The Staff Client will also be automatically built, but you must remember - to set the variable STAFF_CLIENT_BUILD_ID to match the version of - the Staff Client you will use to connect to the Evergreen server. - For further information on manually building the Staff Client, see - . - - cd /home/opensrf/Evergreen-ILS-1.6.1.2 - make STAFF_CLIENT_BUILD_ID=rel_1_6_1_2 install - - The above commands will create a new subdirectory /openils/var/web/xul/rel_1_6_1_2 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 - subdirectory /server of the new Staff - Client build: - - cd /openils/var/web/xul - ln -sf rel_1_6_1_2/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 opensrf user: - - 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 - In this step you will 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: - Create the database: - - createdb -E UNICODE evergreen - createlang plperl evergreen - createlang plperlu evergreen - createlang plpgsql evergreen - - Adjust the paths as shown, where - [PGSQL_VERSION] is your installed PostgreSQL - version (e.g. 8.3). - - 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 - - - - Create <systemitem class="username">evergreen</systemitem> PostgreSQL user - As the postgres - user on the PostgreSQL system, create a new PostgreSQL user - named evergreen and - assign a password: - - createuser -P -s evergreen - Enter password for new role: MYNEWPASSWORD - Enter it again: MYNEWPASSWORD - - - - Create Database Schema - As the root - user, create the database schema and configure your system with - the corresponding database authentication details for the - evergreen database user that you created in - the previous step. - Enter the following commands and replace - HOSTNAME, PORT, PASSWORD and - DATABASENAME with appropriate - values: - - cd /home/opensrf/Evergreen-ILS-1.6.1.2 - 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 - - On most systems, HOSTNAME will be - localhost, - PORT will be 5432, - and PASSWORD and DATABASENAME - will be evergreen. - - 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 web server - In this step you will configure the Apache web server to - support Evergreen software. - First, you must enable some built-in Apache modules and install - some additional Apache configuration files. Then you will create a new - Security Certificate. Finally, you must make several changes to the Apache - configuration file. - - - Enable the required Apache Modules - As the root user, enable - some modules in the Apache server, then copy the - new configuration files to the Apache server - directories: - - a2enmod ssl # enable mod_ssl - a2enmod rewrite # enable mod_rewrite - a2enmod expires # enable mod_expires - - - - Copy Apache configuration files - You must copy the Apache configuration - files from the Evergreen installation dierectory - to the Apache directory. As the root user, perform - the following commands: - - cd /home/opensrf/Evergreen-ILS-1.6.1.2 - 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 - You must create a new Security Certificate (SSL Key) - for the Apache server using the openssl - command. For a public production server you must 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. As the - root user, - perform the following commands: - - mkdir /etc/apache2/ssl - cd /etc/apache2/ssl - openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key - - - This step generates a self-signed SSL - certificate. You must install a proper SSL - certificate for a public production system to - avoid warning messages when users login to their - account through the OPAC or when staff login - through the staff client. - For further information on getting a proper - SSL certificate, see - . - - - - Update Apache configuration file - You must make several changes to the new Apache - configuration file - /etc/apache2/sites-available/eg.conf. As - the root user, - edit the file and make the following changes: - - - Comment out the line Allow - from 10.0.0.0/8 and 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 - - for further details on removing this change - after the Evergreen installation is - complete. - - - - - Comment out the line Listen - 443, since it conflicts with the - same declaration in the configuration file: - /etc/apache2/ports.conf. - Note that Debian - users should not do this - since the conflict does not apply to that - operating system. - - - The following updates are needed to allow - the logs to function properly, but it may break - other Apache applications on your server: - 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 line User www-data - to User opensrf. - 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 line export - APACHE_RUN_USER=www-data to - export - APACHE_RUN_USER=opensrf. - - - - - (OPTIONAL) Apache Performance Modifications - 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 and add the - lines KeepAliveTimeout 1 and - MaxKeepAliveRequests 100, or modify any - existing lines. Then locate the section related to - prefork configuration and modify it - to suit the load on your system: - - StartServers 20 - MinSpareServers 5 - MaxSpareServers 15 - MaxClients 150 - MaxRequestsPerChild 10000 - - ]]> - - - Enable the Evergreen web site - Finally, you must enable the Evergreen web site. As the - root user, execute - the following Apache configuration commands to disable the default - It Works web page and enable the - Evergreen web site: - - a2dissite default - a2ensite eg.conf - - - - - - - - Modify the OpenSRF Configuration File - As the opensrf 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 left-hand side of - shows common XPath syntax to indicate the approximate position within the XML - file that needs changes. The right-hand side of the table shows the replacement - values: - - Sample XPath syntax for editing "opensrf_core.xml" - - - - - - XPath location - Value - - - - - /config/opensrf/username - - opensrf - - - - /config/opensrf/passwd - password for - private.localhostopensrf user - - - - /config/gateway/username - - opensrf - - - - /config/gateway/passwd - password for - public.localhostopensrf user - - - - /config/routers/router/transport, - first entry where transport/server == public.localhost: - username - - router - - - - /config/routers/router/transport, - first entry where transport/server == public.localhost: - password - password for - public.localhostrouter user - - - - /config/routers/router/transport, - second entry where transport/server == private.localhost: - username - - router - - - - /config/routers/router/transport, - second entry where transport/server == private.localhost: - password - password for - private.localhostrouter user - - - - -
- - - Create Configuration Files for Users Needing <command>srfsh</command> - 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 - 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 user's - .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 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. - - - - - - - router - private.localhost - opensrf - evergreen - 5222 - /tmp/srfsh.log - - 4 - - ]]> - - - Modify the OpenSRF Environment - Modify the shell configuration file ~/.bashrc for - user opensrf by adding a Perl environmental - variable, then 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. - - - - echo "export PERL5LIB=/openils/lib/perl5:\$PERL5LIB" >> ~/.bashrc - . ~/.bashrc - - - - (OPTIONAL) Enable and Disable Language Localizations - You can load translations such as Armenian (hy-AM), Canadian French - (fr-CA), and others into the database to complete the translations available in - the OPAC and staff client. For further information, see . - - -
-
- Starting Evergreen - - - As the root - user, start the ejabberd and - memcached services - (if they are not already running): - - /etc/init.d/ejabberd start - /etc/init.d/memcached start - - - - As the opensrf - user, start Evergreen. - Use the flag to force Evergreen to use - localhost (your - current system) as the hostname. Using the - option will start the OpenSRF - router , - Perl , and - C services: - - $ osrf_ctl.sh -l -a start_all - - - - You can also start Evergreen - without - the flag, but the - osrf_ctl.sh utility 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. - - Use the hostname command to - determine the fully qualified domain name of your - system. - - - - 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, edit the configuration file - /home/opensrf/.bashrc and - add the following line: - export PATH=$PATH:/openils/bin - - - 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, edit the configuration file - /home/opensrf/.bashrc and - add the following line: - export PERL5LIB=$PERL5LIB:/openils/lib/perl5 - - - - - As the opensrf - user, generate the Web files needed by the Staff Client and - catalog, and calculate the proximity of locations in the - Organizational Unit tree (which allows - Holds to work properly): - - 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 - - You must do this the first time you start Evergreen, and - after making any changes to the library hierarchy. - - - As the root - user, restart the Apache Web server: - - /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 start the - srfsh application and try logging onto the Evergreen server using the - default administrator username and password. Following is sample output generated by - executing srfsh after a successful Evergreen installation. - For help with srfsh commands, type help - at the prompt: - - /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 - ------------------------------------ - - If this does not work, try the following: - - As the opensrf user, run the - script Open-ILS/src/support-scripts/settings-tester.pl to - see if it finds any system configuration problems. If the output of - settings-tester.pl does not help you find the problem, please - do not make any significant changes to your configuration. - Follow the steps in the troubleshooting guide in - . - 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 - list for assistance before making any drastic changes to your - system configuration. - - -
-
- Running the Staff Client - You can run the Staff Client on Linux by using the - application XULRunner (installed automatically and by default with Firefox - version 3.0 and later on Ubuntu and Debian distributions). - As the opensrf user, start the Staff Client as - shown: - - xulrunner /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/xul/staff_client/build/application.ini - -
-
- Starting 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. Use the command 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: - - apache2ctl configtest && /etc/init.d/apache2 restart - -
-
- Stopping Evergreen - As the opensrf user, stop all Evergreen services - by using the following command: - - # stop the server: - # use "-l" to force hostname to be "localhost" - osrf_ctl.sh -l -a stop_all - -
-
- Post-Installation Chores - There are a few additional steps that you must complete after Evergreen has been - successfully installed and tested. These remaining chores include removing temporary changes to - the Apache configuration files that helped with Evergreen installation and testing, setting up - Reports, and configuring a permanent Security Certificate (SSL Key). -
- 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 - 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. -
-
- Setting Up Support For Reports - Evergreen reports are extremely powerful but some configuration is required. See - for a more detailed description of Reports. -
- Starting the Reporter Daemon - Once the open-ils.reporter process is running and - enabled on the gateway, you can start the reporter daemon. The reporter daemon - periodically checks for requests for new reports or scheduled reports and gets - them running. As the opensrf user, - start the reporter daemon using the following command: - - cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/src/reporter - ./clark-kent.pl --daemon - - You can also specify other options with the reporter daemone: - - --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. Assuming the daemon has just a single process and a lockfile in the default - location, as the opensrf user perform the following - commands to stop the Reporter daemon: - - # find and kill the process ID - kill `ps wax | grep "Clark Kent" | grep -v grep | cut -b1-6` - # remove the lock file - rm /tmp/reporter-LOCK - -
-
-
- Configure a permanent SSL key - This section describes how to get a properly signed SSL certificate. - In a previous step, we used the command openssl to temporarily - create a new SSL key for the Apache server. This is just a self-signed certificate and - will generate warnings in the Staff Client and browser during testing and - development. For a public production server you should configure or purchase a properly - signed SSL certificate. 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 INFO ON HOW TO GET A SIGNED SSL CERTIFICATE - - ADD INFO ON HOW TO GET A SIGNED SSL CERTIFICATE -
-
-
- (OPTIONAL) Installing In Virtualized <systemitem class="osname">Linux</systemitem> Environments - This section describes the installation of Evergreen software in so-called "virtualized" - software environments. Evergreen software runs as a native application on any of several - well-known x86 (32-bit) and x86-64 (64-bit) Linux - distributions including Ubuntu and - Debian but it does not run as a native application - on the Microsoft Windows operating system. - However, it is possible to execute Evergreen on a Windows - host system by running it within a virtual Linux-guest installation, which itself executes - on the Windows system. - The Linux environment is fully emulated and acts - (within limits) just as if it were executing on a real standalone system. - This technique of emulating a Linux environment on - a Windows host is a practical way to install and run an - Evergreen system if it is not possible to dedicate a physical machine solely as a - Linux host for Evergreen. This architecture is not - recommended for large scale systems since there are performance limitations to running Evergreen - in a virtualized environment. However, it is a reasonable architecture for smaller experimental - systems, as a proof of concept, or as a conference-room pilot. - - Installing Virtualization Software - As described above, Evergreen can be installed on top of an emulated - Linux environment. The - Linux environment, in turn, is installed - on top of a software application such as "VirtualBox", - "VMware" or "VirtualPC" which must - first be installed on the Windows system. This - section contains step-by-step examples that show installing popular virtualization - applications on a Windows host system. Following - this section are further descriptions of installing - Linux and Evergreen systems using that - virtualization software. -
- Installing <application>"VirtualBox"</application> Virtualization Software - This section reviews installation of the - "VirtualBox" application on - WindowsXP Professional (SP2). - Download VirtualBox from their official website: - - http://download.virtualbox.org/virtualbox/3.2.8/VirtualBox-3.2.8-64453-Win.exe, - then run the executable file. Continue with the steps shown in the next five - figures until the software has been successfully installed: -
- Starting the Windows installation file - - - - - - Starting the Windows installation file - - -
-
- Welcome to <application>VirtualBox</application> setup wizard - - - - - - Welcome to VirtualBox setup wizard - - -
-
- Accept the license agreement - - - - - - Accept the license agreement - - -
-
- Waiting for files to be copied - - - - - - Waiting for files to be copied - - -
-
- Installation is complete - - - - - - Installation is complete - - -
-
-
- Installing <application>"VMware"</application> Virtualization Software - This section reviews installation of the - "VMware" application on WindowsXP Professional (SP2). Download - VMware from their official website: link, then run the executable file. Continue with the steps shown - in the figures until the software has been successfully installed: -
- Starting the Windows installation file - - - - - - Starting the Windows installation file - - -
- - ZZZ-REVIEW - ADD INFO ON VMWARE - - ADD INFO ON VMWARE - At this point, VirtualBox has been installed, - started for the first time, and a new virtual machine (VM) has been - created. This VM is the environment in which the - Linux / Evergreen installation will - execute. Please continue in - with the - installation of the Linux / Evergreen - distribution. -
-
- Installing <application>"VirtualPC"</application> Virtualization Software - This section reviews installation of the - "VirtualPC" application on WindowsXP Professional (SP2). Download - VMware from their official website: link, then run the executable file. Continue with the steps shown - in the figures until the software has been successfully installed: -
- Starting the Windows installation file - - - - - - Starting the Windows installation file - - -
- - ZZZ-REVIEW - ADD INFO ON VIRTUALPC - - ADD INFO ON VIRTUALPC - At this point, VirtualBox has been installed, - started for the first time, and a new virtual machine (VM) has been - created. This VM is the environment in which the - Linux / Evergreen installation will - execute. Please continue in - with the - installation of the Linux / Evergreen - distribution. -
- - - Installing <systemitem class="osname">Linux</systemitem> / - Evergreen on Virtualization Software - After the virtualization software is installed and running, there are two ways to - continue with installing Linux and Evergreen - software in the new virtualized environment: - - - Download and install a prebuilt software image that contains a - working Linux / Evergreen system - (see for - details) - - - Manually install a Linux - guest system, then manually install Evergreen on it (see - for details) - - - We review each method in the following sections. -
- Download and install a prebuilt software image - You can download a prebuilt software image that, when installed with your - virtualization software, emulates a - Linux guest system containing a running - Evergreen distribution. The image is essentially a snapshot of a hard disk from - a fully configured, functional Linux - system with Evergreen already installed. - We recommend this approach if you wish to get Evergreen running quickly - with minimal attention to configuration. After reviewing only a few - configuration details you can have a working Evergreen system that integrates - smoothly with the rest of your network. See - for a list of prebuilt - software images that are currently available to download and install - DISCLAIMER: The following virtual images have been contributed by members - of the Evergreen community for the purposes of testing, evaluation, training, - and development. - - Linux / Evergreen Virtual Images - - - - Linux Version - Evergreen Version - Image - Comments - - - - - Debian lenny (5.0) - 1.6.0.1 - - download - - VirtualBox image - - - Ubuntu karmic koala (9.10) - 1.6.0.0 - - download - - VirtualBox image - - - Ubuntu hardy heron (8.04) - 1.2.3.1 - - download - - VirtualBox image; no preloaded data - - - Debian etch (4.0) - 1.2.2.3 - - download - - VMware image; preloaded with 13,000 Gutenberg records - - - Ubuntu gutsy gibbon (7.10) - 1.2.1.4 - - download - - VMware image - - - Gentoo - 1.1.5 - - download - - VMware image - - - -
- - ZZZ-REVIEW - EXPAND LIST OF OTHER PREBUILT IMAGES - - EXPAND LIST OF OTHER PREBUILT IMAGES - For the following example, we have already installed the - VirtualBox application (see for details). Continue - with the steps as shown; refer to the accompanying figures for further - information: - - - Start VirtualBox for the first time and select - FileVirtualBox Media - ManagerAdd - to locate the prebuilt software image just downloaded (the - example shows it was extracted from the original - .ZIP file into a temporary directory - C:\temp). - See - for details. - - - After selecting the file, click - Open to import it (see for - details). - - - Then click OK to save the selection - and return to the VirtualBox Media Manager (see for - details). - - - Click New to start the "Virtual - Machine Wizard", then Next to continue - and create a new virtual machine (VM) ). - - - Create a new name for the VM and set the operating system - type, then click Next (see ). - - - Set the memory size (we chose the default value of 512Mb), - then click Next (see ). - - - Edit the Virtual Hard Disk configuration settings; click - the radio boxes "Boot Hard Disk" and "Use existing hard disk" - and ensure that the disk name "Evergreen1601_DebianLenny.vmdk" - is selected. Click Finish to finish the - setup (see ). - - - Install the VirtualBox Guest - Additions (really a required upgrade to - VirtualBox) - - ZZZ-REVIEW - ADD INFO ON INSTALLING VIRTUALBOX GUEST ADDITIONS - - ADD INFO ON INSTALLING VIRTUALBOX GUEST ADDITIONS - - - Return to VirtualBox and see the summary of the VM just - created. Click Start to boot the new VM - (see ). - - - See the start of the Linux boot sequence. Choose "Debian - Gnu/Linux, kernel 2.6.26-2-686" from the startup menu and type - Enter to start Linux and Evergreen (see ). After - some delay you should see the command line prompt: - debian-lenny login: . Log in with username - root and password - evergreen to continue (see ). - - - At this point you have a running Linux / Evergreen system. If you need to modify the - Evergreen configuration in any way, review the standard Evergreen installation - instructions in that deal - with configuration. -
- Starting <application>VirtualBox</application> for the first time - - - - - - Starting VirtualBox for the first time - - -
-
- Selecting the software image in Virtual Media Manager - - - - - - Selecting the software image in Virtual Media Manager - - -
-
- New software image added to <application>VirtualBox</application> - - - - - - New software image added to VirtualBox - - -
-
- Creating a new VM - - - - - - Creating a new VM - - -
-
- Setting the VM name and OS type - - - - - - Setting the VM name and OS type - - -
-
- Setting memory size - - - - - - Setting memory size - - -
-
- Setting up the Virtual Hard Disk - - - - - - Setting up the Virtual Hard Disk - - -
-
- Finishing definition of new VM - - - - - - Finishing definition of new VM - - -
-
- Summary of the new VM - - - - - - Summary of the new VM - - -
-
- Selecting VM from startup menu - - - - - - Selecting VM from startup menu - - -
-
- Starting the new VM - - - - - - Starting the new VM - - -
-
- Starting the new VM (continued) - - - - - - Starting the new VM (continued) - - -
-
- Logging into the new VM - - - - - - Logging into the new VM - - -
-
-
Manually install <systemitem class="osname">Linux</systemitem> and EvergreenYou can manually install a Linux - guest system and Evergreen on your virtualization software.We recommend this approach if you need to specially configure either the - Linux system or Evergreen itself. This - will require a detailed review of both Linux and Evergreen configuration details. You are - essentially doing a normal Evergreen installation on a Linux system; it just happens that Linux is running within a virtualized - environment. Refer to for - information on the normal Evergreen installation, then continue with this - section. For the following example, we have already installed the - VirtualBox application (see for details). Continue - with the steps as shown; refer to the accompanying figures for further - information:Download and install a standard Ubuntu distribution in - "VirtualBox". You can - download a software image of a prebuilt Ubuntu distribution and immediately - import it into "VirtualBox" , or you - can download and installZZZ-REVIEWADD DETAILS ON MANUAL INSTALLATION OF LINUXADD DETAILS ON MANUAL INSTALLATION OF LINUXStart (boot) Ubuntu.ZZZ-REVIEWADD DETAILS ON VM LINUX BOOT SEQUENCEADD DETAILS ON VM LINUX BOOT SEQUENCEInstall Evergreen on Ubuntu.ZZZ-REVIEWADD DETAILS ON MANUAL INSTALLATION OF EVERGREENADD DETAILS ON MANUAL INSTALLATION OF EVERGREENAt this point, the Windows system - is hosting an Ubuntu system, which - itself is hosting the Evergreen distribution. So far as Evergreen is concerned, - it is happily executing in a standard - Ubuntu environment and behaves exactly - as if it were executing on a standalone - Ubuntu system.Of course, there are limitations to how well a virtualized - Ubuntu system emulates a real one. - The "VirtualBox" application itself consumes memory, - and it contributes to the CPU load on the - Windows host system. The emulated - Ubuntu system will have less available - memory and will execute more slowly than if it were a standalone system, - therefore Evergreen itself will inherit some limitations from this overall - environment.However, this technique of using a - Windows host to emulate a - Linux environment is a practical way - to install and run an Evergreen system even if it isn't possible to dedicate a - real machine solely as a Linux host for - testing. This is a reasonable architecture for simple experiments, or as a proof - of concept, or as a conference-room pilot.
- -
-
- + + + + 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. + + + Installing, configuring and testing the Evergreen server-side software is straightforward with the current + stable software release. See for instructions tailored to + installing on some particular distributions of the Linux operating + system. + 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 Microsoft 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 Linux-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 + . + Installation of the Evergreen Staff Client software is reviewed in . + The Evergreen server-side software has dependencies on particular versions of certain major software + sub-components. Successful installation of Evergreen software requires that software versions agree with those + listed here: + + Evergreen Software Dependencies + + + + + + + Evergreen + OpenSRF + PostgreSQL + + + + + 1.6.1.x + 1.4.0 + 8.2 / 8.3 + + + 1.6.0.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 + + + +
+
+ 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 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.4.x On <systemitem class="osname">Ubuntu</systemitem> or + <systemitem class="osname">Debian</systemitem> + 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.4.0 has been tested on Debian Etch + (4.0), Debian Lenny (5.0) and + Ubuntu Lucid Lynx (10.04). + In the following instructions, you are asked to perform certain steps as either + the root user, the + opensrf user, or the + postgres user. + + + Debian -- To become the + root user, issue the command + su - and enter the password of the + root user. + + + Ubuntu -- To become the + root user, issue the command + sudo su - and enter the password of the + root user. + + + To switch from the root user to a + different user, issue the command su - USERNAME. For example, to + switch from the root user to the + opensrf user, issue the command + su - opensrf. Once you have become a non-root user, to become + the root user again, simply issue the command + exit. + + + + Add the OpenSRF User + As the root user, add the + opensrf user to the system. The default shell for the new user is automatically + set to /bin/bash to inherit a reasonable environment: + +useradd -m -s /bin/bash opensrf +passwd opensrf + + + + Download and Unpack Latest OpenSRF Version + As the opensrf user, download + and extract the latest version of OpenSRF. The latest version can be found here: + + +wget http://evergreen-ils.org/downloads/OpenSRF-1.4.0.tar.gz +tar zxf OpenSRF-1.4.0.tar.gz + + The new directory + /home/opensrf/OpenSRF-1.4.0 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 OpenSRF 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 name of the Linux + distribution listed in the distribution keywords table + . + +cd /home/opensrf/OpenSRF-1.4.0 +make -f src/extras/Makefile.install [DISTRIBUTION] + + + Keyword Targets for OpenSRF <application>"make"</application> Command + + + + + + Keyword + Description + + + + + debian-etch + for Debian Etch (4.0) + + + debian-lenny + for Debian Lenny (5.0) + + + ubuntu-hardy + for Ubuntu Hardy Heron (8.04) + + + ubuntu-karmic + for Ubuntu Karmic Koala (9.10) + + + ubuntu-lucid + for Ubuntu Lucid Lynx (10.04) + + + +
+ This will install a number of packages on the system that are required by OpenSRF, + including some Perl modules from CPAN. You can say No to the initial + CPAN configuration prompt to allow it to automatically configure itself to download and + install Perl modules from CPAN. The CPAN installer will ask you a number of times whether + it should install prerequisite modules - say Yes. + + + Build OpenSRF + + + Configure OpenSRF + As the opensrf + user, return to the OpenSRF build directory and use the + configure utility to prepare for the next + step of compiling and linking the software. If you wish to + include support for Python and Java, add the configuration + options and + , respectively: + +cd /home/opensrf/OpenSRF-1.4.0 +./configure --prefix=/openils --sysconfdir=/openils/conf +make + + + + Compile, Link and Install OpenSRF + As the root + user, return to the OpenSRF build directory and use the + make utility to compile, link and install + OpenSRF: + +cd /home/opensrf/OpenSRF-1.4.0 +make install + + + + Update the System Dynamic Library Path + You must update the system dynamic library path to force + your system to recognize the newly installed libraries. As the + root user, do this by + creating the new file + /etc/ld.so.conf.d/osrf.conf containing a + new library path, then run the command + ldconfig to automatically read the file and + modify the system dynamic library path: + +echo "/openils/lib" > /etc/ld.so.conf.d/osrf.conf +ldconfig + + + Define Public and Private OpenSRF DomainsYou must define your public and private OpenSRF + domains. For security purposes, OpenSRF uses Jabber domains to + separate services into public and private realms. Throughout + these instructions, we will use the example domains public.localhost for the public + domain and private.localhost for the + private domain. On a single-server system, the easiest way to + define public and private domains is to define separate host + names by adding entries to the file + /etc/hosts. As the root user, edit the file + /etc/hosts and add the following entries + for our example domains: + +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 all files installed in the + directory /openils to the + user opensrf: + + chown -R opensrf:opensrf /openils + + + + + + Stop the <systemitem class="service">ejabberd</systemitem> Service + As the root user, 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 + configuration file /etc/ejabberd/ejabberd.cfg + to hardcode a domain: + +epmd -kill +killall beam; killall beam.smp +rm /var/lib/ejabberd/* +echo 'ERLANG_NODE=ejabberd@localhost' >> /etc/default/ejabberd + + + + Edit the <systemitem class="service">ejabberd</systemitem> configuration + As the root user, edit the file + /etc/ejabberd/ejabberd.cfg and make the following + changes: + + + Change + {hosts, ["localhost"]}. + to: + {hosts, ["localhost", "private.localhost", "public.localhost"]}. + + + Change + {max_user_sessions, 10}. to + {max_user_sessions, 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 + to2000000. + + + Change both occurrences of maxrate to + 500000. + + + Comment out the line {mod_offline, []} + by placing two % comment signs in front. + + + + + Restart the <systemitem class="service">ejabberd</systemitem> service + As the root user, restart the + ejabberd service to test the + configuration changes and to register your users: + +/etc/init.d/ejabberd start + + + + Register <systemitem class="username">router</systemitem> and + <systemitem class="username">ejabberd</systemitem> 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 + ejabberdctl utility 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: + + +# +ejabberdctl register router private.localhost +ejabberdctl register opensrf private.localhost +ejabberdctl register router public.localhost +ejabberdctl register opensrf public.localhost +]]> + + + + Create configuration files + As the opensrf user, use the + example templates to create the configuration files + /openils/conf/opensrf_core.xml and + /openils/conf/opensrf.xml from the example templates: + +cd /openils/conf +cp opensrf.xml.example opensrf.xml +cp opensrf_core.xml.example opensrf_core.xml + + + + Change Jabber usernames and passwords + As the opensrf user, edit the + OpenSRF configuration file /openils/conf/opensrf_core.xml + to update the Jabber usernames and passwords to match the values shown in the + following table. The left-hand side of + shows common XPath syntax to indicate the approximate position within the XML + file that needs changes. The right-hand side of the table shows the replacement + values. + + Sample XPath syntax for editing "opensrf_core.xml" + + + + + + XPath location + Value + + + + + /config/opensrf/username + + opensrf + + + + /config/opensrf/passwd + password for + private.localhostopensrf user + + + + /config/gateway/username + + opensrf + + + + /config/gateway/passwd + password for + public.localhostopensrf user + + + + /config/routers/router/transport, + first entry where transport/server == public.localhost: + username + + router + + + + /config/routers/router/transport, + first entry where transport/server == public.localhost: + password + password for + public.localhostrouter user + + + + /config/routers/router/transport, + second entry where transport/server == private.localhost: + username + + router + + + + /config/routers/router/transport, + second entry where transport/server == private.localhost: + password + password for + private.localhostrouter 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. + + + Set location of persistent database + As the opensrf user, edit the + file /openils/conf/opensrf.xml to set the location of the + persistent database in the dbfile element near the end of the + file: + + + + + /tmp/persist.db + + +]]> + + + + Create Configuration Files for Users Needing <command>srfsh</command> + 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 OpenSRF. It will be used in a future + step to complete and test the Evergreen installation. See + 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 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 + + + + + + +router +private.localhost +opensrf +privsrf +5222 +/tmp/srfsh.log + +4 + +]]> + + + + Modify Environmental Variable PATH for + <systemitem class="username">opensrf</systemitem> 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: + +echo "export PATH=/openils/bin:\$PATH" >> ~/.bashrc + + + + Start OpenSRF + As the root user, start the + ejabberd and + memcached services: + + /etc/init.d/ejabberd start + /etc/init.d/memcached start + + Finally, as the opensrf user, + start OpenSRF. Use "-l" to force hostname to be "localhost": + +osrf_ctl.sh -l -a start_all + + + If you receive the error message bash: osrf_ctl.sh: + command not found, then your environment variable + PATH does not include the + /openils/bin directory; + this should have been set by .bashrc when you + logged in as the opensrf user, + but you can manually set it using the following command: + +export PATH=$PATH:/openils/bin + + + You can also start Evergreen without the + 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. + + + Test connections to OpenSRF + Once you have installed and started OpenSRF, as the + root user, test your connection to + OpenSRF using the srfsh + utility and trying to call the add method on the OpenSRF + math service: + +/openils/bin/srfsh + +srfsh# +request opensrf.math add 2 2 +Received Data: 4 +------------------------------------ +Request Completed Successfully +Request Time in seconds: 0.007519 +------------------------------------ + +srfsh# + + + For other srfsh commands, type in + help at the prompt. + + + Stopping OpenSRF + As the opensrf user, stop OpenSRF: + +osrf_ctl.sh -l -a stop_all + + + +
+
+ Installing Evergreen 1.6.1.x On <systemitem class="osname">Ubuntu</systemitem> or + <systemitem class="osname">Debian</systemitem> + 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, or the + postgres user. + + + Debian -- To become the + root user, issue the command + su - and enter the password of the + root user. + + + Ubuntu -- To become the + root user, issue the command + sudo su - and enter the password of the + root user. + + + To switch from the root user to a + different user, issue the command su - USERNAME. For example, to + switch from the root user to the + opensrf user, issue the command + su - opensrf. Once you have become a non-root user, to become the + root user again, simply issue the command + exit. + + + + Install 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 + . + 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, download + and extract the latest version of Evergreen. The latest version can be found here: + + +wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.1.2.tar.gz +tar zxf Evergreen-ILS-1.6.1.2.tar.gz + + The new directory + /home/opensrf/Evergreen-ILS-1.6.1.2 + 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 + Evergreen 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 name of the Linux + distribution listed in the distribution keywords table + . + +cd /home/opensrf/Evergreen-ILS-1.6.1.2 +make -f Open-ILS/src/extras/Makefile.install [DISTRIBUTION] + + + Keyword Targets for Evergreen <application>"make"</application> Command + + + + + + Keyword + Description + + + + + debian-etch + for Debian Etch (4.0) + + + debian-lenny + for Debian Lenny (5.0) + + + ubuntu-hardy + for Ubuntu Hardy Heron (8.04) + + + ubuntu-karmic + for Ubuntu Karmic Koala (9.10) + + + ubuntu-karmic + for Ubuntu Lucid Lynx (10.04) + + + +
+ + + (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. You must install the PostgreSQL server + yourself, either on the same system as Evergreen itself or on another system. + If your PostgreSQL server is on a different system, just skip this step. + For further information on manually installing PostgreSQL, visit the official + PostgreSQL Site. + If your PostgreSQL server will be on the same system as your Evergreen + software, then as the root user + install the required PostgreSQL server packages: + For Debian Lenny and + Ubuntu Hardy (8.04): + +make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_83 + + For Ubuntu Karmic (9.10) and + Ubuntu Lucid (10.04): + +make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_84 + + + PostgreSQL versions 8.3 or 8.4 are the recommended versions to work + with Evergreen 1.6. If you have an older version of PostgreSQL, you should + upgrade before installing Evergreen. To find the running version of + PostgreSQL, as the postgres + user, run the psql. Then type SELECT + version(); to get detailed information about your version + of PostgreSQL. + + + + 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, continue if your PostgreSQL server is running on another system. + You will need to install several Perl modules on the other system. As the + root user install the following Perl + modules: + +# first, ensure the gcc compiler is installed: +apt-get install gcc +# then install the Perl modules: +perl -MCPAN -e shell +cpan> +install JSON::XS +cpan> +install MARC::Record +cpan> +install MARC::File::XML + + For more information on installing Perl Modules vist the official + CPAN site. + + + Update the System Dynamic Library Path + You must update the system dynamic library path to force your system to + recognize the newly installed libraries. As the root user, create a file named + /etc/ld.so.conf.d/eg.conf containing the new library paths: + +/usr/local/lib +/usr/local/lib/dbd + + Then run the command ldconfig to automatically read the + file and modify the system dynamic library path: + +ldconfig + + + + (OPTIONAL) Restart the PostgreSQL Server + If PostgreSQL is running on the same system as the rest of Evergreen, as + the root user you must restart + PostgreSQL to re-read the new library paths just configured. If PostgreSQL is + running on another system, you may skip this step. As the opensrf user, execute the following command, where + [PGSQL_VERSION] is your installed PostgreSQL version + (e.g. 8.3): + +/etc/init.d/postgresql-[PGSQL_VERSION] restart + + + + Configure Evergreen + As the opensrf user, return to + the Evergreen build directory and use the configure and + make utilities to configure Evergreen so it can be compiled + and linked in the next step: + +cd /home/opensrf/Evergreen-ILS-1.6.1.2 +./configure --prefix=/openils --sysconfdir=/openils/conf +make + + + + Compile, Link and Install Evergreen + In this step you will actually compile, link and install Evergreen and the + default Evergreen Staff Client. + As the root user, return to the + Evergreen build directory and use the make utility as shown + below. The Staff Client will also be automatically built, but you must remember + to set the variable STAFF_CLIENT_BUILD_ID to match the version of + the Staff Client you will use to connect to the Evergreen server. + For further information on manually building the Staff Client, see + . + +cd /home/opensrf/Evergreen-ILS-1.6.1.2 +make STAFF_CLIENT_BUILD_ID=rel_1_6_1_2 install + + The above commands will create a new subdirectory /openils/var/web/xul/rel_1_6_1_2 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 + subdirectory /server of the new Staff + Client build: + +cd /openils/var/web/xul +ln -sf rel_1_6_1_2/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 opensrf user: + +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 + In this step you will 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: + Create the database: + +createdb -E UNICODE evergreen +createlang plperl evergreen +createlang plperlu evergreen +createlang plpgsql evergreen + + Adjust the paths as shown, where + [PGSQL_VERSION] is your installed PostgreSQL + version (e.g. 8.3). + +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 + + + + Create <systemitem class="username">evergreen</systemitem> PostgreSQL user + As the postgres + user on the PostgreSQL system, create a new PostgreSQL user + named evergreen and + assign a password: + +createuser -P -s evergreen +Enter password for new role: MYNEWPASSWORD +Enter it again: MYNEWPASSWORD + + + + Create Database Schema + As the root + user, create the database schema and configure your system with + the corresponding database authentication details for the + evergreen database user that you created in + the previous step. + Enter the following commands and replace + HOSTNAME, PORT, PASSWORD and + DATABASENAME with appropriate + values: + +cd /home/opensrf/Evergreen-ILS-1.6.1.2 +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 + + On most systems, HOSTNAME will be + localhost, + PORT will be 5432, + and PASSWORD and DATABASENAME + will be evergreen. + + 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 web server + In this step you will configure the Apache web server to + support Evergreen software. + First, you must enable some built-in Apache modules and install + some additional Apache configuration files. Then you will create a new + Security Certificate. Finally, you must make several changes to the Apache + configuration file. + + + Enable the required Apache Modules + As the root user, enable + some modules in the Apache server, then copy the + new configuration files to the Apache server + directories: + + a2enmod ssl # enable mod_ssl + a2enmod rewrite # enable mod_rewrite + a2enmod expires # enable mod_expires + + + + Copy Apache configuration files + You must copy the Apache configuration + files from the Evergreen installation dierectory + to the Apache directory. As the root user, perform + the following commands: + + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + 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 + You must create a new Security Certificate (SSL Key) + for the Apache server using the openssl + command. For a public production server you must 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. As the + root user, + perform the following commands: + +mkdir /etc/apache2/ssl +cd /etc/apache2/ssl +openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key + + + This step generates a self-signed SSL + certificate. You must install a proper SSL + certificate for a public production system to + avoid warning messages when users login to their + account through the OPAC or when staff login + through the staff client. + For further information on getting a proper + SSL certificate, see + . + + + + Update Apache configuration file + You must make several changes to the new Apache + configuration file + /etc/apache2/sites-available/eg.conf. As + the root user, + edit the file and make the following changes: + + + Comment out the line Allow + from 10.0.0.0/8 and 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 + + for further details on removing this change + after the Evergreen installation is + complete. + + + + + Comment out the line Listen + 443, since it conflicts with the + same declaration in the configuration file: + /etc/apache2/ports.conf. + Note that Debian + users should not do this + since the conflict does not apply to that + operating system. + + + The following updates are needed to allow + the logs to function properly, but it may break + other Apache applications on your server: + 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 line User www-data + to User opensrf. + 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 line export + APACHE_RUN_USER=www-data to + export + APACHE_RUN_USER=opensrf. + + + + + (OPTIONAL) Apache Performance Modifications + 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 and add the + lines KeepAliveTimeout 1 and + MaxKeepAliveRequests 100, or modify any + existing lines. Then locate the section related to + prefork configuration and modify it + to suit the load on your system: + + + StartServers 20 + MinSpareServers 5 + MaxSpareServers 15 + MaxClients 150 + MaxRequestsPerChild 10000 + +]]> + + + + Enable the Evergreen web site + Finally, you must enable the Evergreen web site. As the + root user, execute + the following Apache configuration commands to disable the default + It Works web page and enable the + Evergreen web site: + +a2dissite default +a2ensite eg.conf + + + + + + + + Modify the OpenSRF Configuration File + As the opensrf 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 left-hand side of + shows common XPath syntax to indicate the approximate position within the XML + file that needs changes. The right-hand side of the table shows the replacement + values: + + Sample XPath syntax for editing "opensrf_core.xml" + + + + + + XPath location + Value + + + + + /config/opensrf/username + + opensrf + + + + /config/opensrf/passwd + password for + private.localhostopensrf user + + + + /config/gateway/username + + opensrf + + + + /config/gateway/passwd + password for + public.localhostopensrf user + + + + /config/routers/router/transport, + first entry where transport/server == public.localhost: + username + + router + + + + /config/routers/router/transport, + first entry where transport/server == public.localhost: + password + password for + public.localhostrouter user + + + + /config/routers/router/transport, + second entry where transport/server == private.localhost: + username + + router + + + + /config/routers/router/transport, + second entry where transport/server == private.localhost: + password + password for + private.localhostrouter user + + + + +
+ + + Create Configuration Files for Users Needing <command>srfsh</command> + 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 + 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 user's + .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 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. + + + + + + + +router +private.localhost +opensrf +evergreen +5222 +/tmp/srfsh.log + +4 + +]]> + + + + Modify the OpenSRF Environment + Modify the shell configuration file ~/.bashrc for + user opensrf by adding a Perl environmental + variable, then 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. + + + +echo "export PERL5LIB=/openils/lib/perl5:\$PERL5LIB" >> ~/.bashrc +. ~/.bashrc + + + + (OPTIONAL) Enable and Disable Language Localizations + You can load translations such as Armenian (hy-AM), Canadian French + (fr-CA), and others into the database to complete the translations available in + the OPAC and staff client. For further information, see . + + +
+
+ Starting Evergreen + + + As the root + user, start the ejabberd and + memcached services + (if they are not already running): + +/etc/init.d/ejabberd start +/etc/init.d/memcached start + + + + As the opensrf + user, start Evergreen. + Use the flag to force Evergreen to use + localhost (your + current system) as the hostname. Using the + option will start the OpenSRF + router , + Perl , and + C services: + +$ osrf_ctl.sh -l -a start_all + + + + You can also start Evergreen + without + the flag, but the + osrf_ctl.sh utility 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. + + Use the hostname command to + determine the fully qualified domain name of your + system. + + + + 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, edit the configuration file + /home/opensrf/.bashrc and + add the following line: + export PATH=$PATH:/openils/bin + + + 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, edit the configuration file + /home/opensrf/.bashrc and + add the following line: + export PERL5LIB=$PERL5LIB:/openils/lib/perl5 + + + + + As the opensrf + user, generate the Web files needed by the Staff Client and + catalog, and calculate the proximity of locations in the + Organizational Unit tree (which allows + Holds to work properly): + +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 + + + You must do this the first time you start Evergreen, and + after making any changes to the library hierarchy. + + + As the root + user, restart the Apache Web server: + +/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 start the + srfsh application and try logging onto the Evergreen server using the + default administrator username and password. Following is sample output generated by + executing srfsh after a successful Evergreen installation. + For help with srfsh commands, type help + at the prompt: + + /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 + ------------------------------------ + + If this does not work, try the following: + + As the opensrf user, run the + script Open-ILS/src/support-scripts/settings-tester.pl to + see if it finds any system configuration problems. If the output of + settings-tester.pl does not help you find the problem, please + do not make any significant changes to your configuration. + Follow the steps in the troubleshooting guide in + . + 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 + list for assistance before making any drastic changes to your + system configuration. + + +
+
+ (OPTIONAL) Installing In Virtualized <systemitem class="osname">Linux</systemitem> Environments + This section describes the installation of Evergreen software in so-called "virtualized" + software environments. Evergreen software runs as a native application on any of several + well-known x86 (32-bit) and x86-64 (64-bit) Linux + distributions including Ubuntu and + Debian but it does not run as a native application + on the Microsoft Windows operating system. + However, it is possible to execute Evergreen on a Windows + host system by running it within a virtual Linux-guest installation, which itself executes + on the Windows system. + The Linux environment is fully emulated and acts + (within limits) just as if it were executing on a real standalone system. + This technique of emulating a Linux environment on + a Windows host is a practical way to install and run an + Evergreen system if it is not possible to dedicate a physical machine solely as a + Linux host for Evergreen. This architecture is not + recommended for large scale systems since there are performance limitations to running Evergreen + in a virtualized environment. However, it is a reasonable architecture for smaller experimental + systems, as a proof of concept, or as a conference-room pilot. + + Installing Virtualization Software + As described above, Evergreen can be installed on top of an emulated + Linux environment. The + Linux environment, in turn, is installed + on top of a software application such as "VirtualBox", + "VMware" or "VirtualPC" which must + first be installed on the Windows system. This + section contains step-by-step examples that show installing popular virtualization + applications on a Windows host system. Following + this section are further descriptions of installing + Linux and Evergreen systems using that + virtualization software. + + Installing <application>"VirtualBox"</application> Virtualization Software + This section reviews installation of the + "VirtualBox" application on + WindowsXP Professional (SP2). + Download the latest edition of VirtualBox from their official website: + http://virtualbox.org and follow the on screen instructions to install the software. + + + Installing <application>"VMware"</application> Virtualization Software + This section reviews installation of the + "VMware" application on WindowsXP Professional (SP2). Find and Download the free virtual + machine software of from the VMware official website: http://downloads.vmware.com and follow the on + screen instructions. + + + + Installing <systemitem class="osname">Linux</systemitem> / + Evergreen on Virtualization Software + After the virtualization software is installed and running, there are two ways to + continue with installing Linux and Evergreen + software in the new virtualized environment: + + + Download and install a prebuilt software image that contains a + working Linux / Evergreen system + (see for + details) + + + Manually install a Linux + guest system, then manually install Evergreen on it (see + for details) + + + We review each method in the following sections. + + Download and install a prebuilt software image + You can download a prebuilt software image that, when installed with your + virtualization software, emulates a + Linux guest system containing a running + Evergreen distribution. The image is essentially a snapshot of a hard disk from + a fully configured, functional Linux + system with Evergreen already installed. + We recommend this approach if you wish to get Evergreen running quickly + with minimal attention to configuration. After reviewing only a few + configuration details you can have a working Evergreen system that integrates + smoothly with the rest of your network. See + for a list of prebuilt + software images that are currently available to download and install + DISCLAIMER: The following virtual images have been contributed by members + of the Evergreen community for the purposes of testing, evaluation, training, + and development. + + Linux / Evergreen Virtual Images + + + + + + + + Linux Version + Evergreen Version + Image + Comments + + + + + Debian lenny (5.0) + 1.6.0.1 + + download + + VirtualBox image + + + Ubuntu karmic koala (9.10) + 1.6.0.0 + + download + + VirtualBox image + + + +
+ + + VirtualBox Example + + Start VirtualBox for the first time and select + FileVirtualBox Media + ManagerAdd + to locate the prebuilt software image just downloaded (the + example shows it was extracted from the original + zip file into a temporary directory + C:\temp). + + + After selecting the file, click Open to import it. + + + Then click OK to save the selection + and return to the VirtualBox Media Manager + + + Click New, then Next to continue + and create a new virtual machine (VM). + + + Create a new name for the VM and set the operating system + type, then click Next. + + + Set the memory size (at least 512Mb), + then click Next. + + + Edit the Virtual Hard Disk configuration settings; click + the radio boxes Boot Hard Disk and Use existing hard disk + and ensure that the disk name Evergreen1601_DebianLenny.vmdk + is selected. Click Finish to finish the + setup. + + + Install the VirtualBox Guest + Additions (really a required upgrade to + VirtualBox) + + + Return to VirtualBox and see the summary of the VM just + created. Click Start to boot the new VM. + + + See the start of the Linux boot sequence. Choose Debian + Gnu/Linux, kernel 2.6.26-2-686 from the startup menu and click + Enter to start Linux and Evergreen. After + some delay you should see the command line prompt debian-lenny login:. Log in with username + root and password evergreen to continue. + + + + +
+
+ diff --git a/1.6/admin/staffclientinstallation.xml b/1.6/admin/staffclientinstallation.xml index e72f3ffe26..5df07afdaa 100644 --- a/1.6/admin/staffclientinstallation.xml +++ b/1.6/admin/staffclientinstallation.xml @@ -1,1044 +1,1002 @@ - - - - Installation of Evergreen Staff Client Software - - This section describes installation of the Evergreen Staff Client software. - - -
- Installing the Staff Client - The Staff Client is automatically built by default as part of the normal make install process for Evergreen server-side software. See to review details related to building the Staff Client in the final compile/link/install phase of the default Evergreen build process. See for help on manually building the Staff Client. Otherwise, continue with the following sections to install a pre-built Staff Client. - - Installing a Pre-Built 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, and Linux. If you need to manually build the Staff Client, see . -
- 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 - - - - - - Running the Staff Client installer - - -
- Click Next to continue through the guided install process. The Install Wizard will ask you to agree to the end-user license, ask you where to install the software, ask about where to place icons, and then will install the software on your workstation. - 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 - - - - - - Running the Staff Client for the first time - - -
- First, add the name of your Evergreen server to the field Hostname in the Server section. For example, the PINES demo system is http://demo.gapines.org. After adding the server name, click Re-Test Server. - Because this is the initial run of the Staff Client, the Workstation section in the upper-right will state: Not yet configured for the specified server. The first thing you must do to the Staff Client on every workstation is to assign it a workstation name. This is covered in . -
-
- Installing on Mac OS - 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 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 - - - - - - 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 - - - - - - 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 for further information. - The Staff Client data from the directory ./staff_client/build must be placed somewhere on the machine (e.g. ~/Desktop/Evergreen_Staff_Client). Remember to call XULRunner with the full path to the binary, followed by the install command and the path to the client data. See the following command: -
- Executing XULRunner - - /Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_Client - -
- This command should exit quietly. The folder /Applications/OpenILS will be created, 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 file /Library/Receipts/xulrunner-ver-mak.pkg does not exist (possibly in newer OSX releases), you need to flush the file receiptdb. - If you install a newer version over a previous (older) install, the older one is not removed but the symlinks are changed to the newer one. -
- Flush Receiptdb file: - 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. See http://lists.apple.com/archives/Installer-dev/2009/Jul/msg00008.html for more information. -
-
-
- 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 - - - - - CFBundleExecutable - xulrunner - CFBundleGetInfoString - OpenILS open_ils_staff_client rel_1_6_0_7 - CFBundleInfoDictionaryVersion - 6.0 - CFBundleName - Evergreen Staff Client - CFBundlePackageType - APPL - CFBundleShortVersionString - rel_1_6_0_7 - CFBundleVersion - rel_1_6_0_7.rel_1_6_0_7 - NSAppleScriptEnabled - - CFBundleTypeIconFile - Evergreen.icns - - -]]> -
- - Download and install an appropriate Mac OS package of XULRunner from the Mozilla website (see above for recommendations). - - Make a copy of the folder /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 the folder 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, 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 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, using a procedure similar to this: -
- Building the Staff Client on the Server - - $ cd ~/ILS/Open-ILS/xul/staff_client - $ make STAFF_CLIENT_BUILD_ID='12345' - $ mkdir /openils/var/web/xul/ - $ mkdir /openils/var/web/xul/12345/ - $ cd build/ - $ cp -R server/ /openils/var/web/xul/12345/ - -
- The Staff Client can be run from the build directory using this command: -
- Running the Staff Client on the Server - - $ su - opensrf - $ xulrunner application.ini - -
- 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, 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, 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, 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. As the opensrf user, issue the following commands to create a clean "staging" directory in which to place the finished Staff Client, and to copy into it the "staff_client" directory: -
- Creating a "staging" directory - - $ su - opensrf - $ 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> - -
- You may wish to create DesktopStart MenuK-Menu shortcuts for the Staff Client using the command xulrunner ~/<Destination Directory>/staff_client/build/application.ini as the target. - - -
-
- Using Wine to Install On Linux - The Linux application Wine is another alternative if you 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, 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, 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. - - -
-
- 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 - - - - - - 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 their 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 - - - - - - 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 click Register. - Once you have registered your workstation with the server, your screen will look like this: -
- Example of registered Staff Client - - - - - - 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 click Login. -
-
- - - Manually Building the Staff Client - The Staff Client is automatically built by default as part of the normal make install process for Evergreen server-side software. See to review details related to building the Staff Client in the final compile/link/install phase of the default Evergreen build process. -
- Building the Staff Client - You can also manually build the Staff Client by using the make utility in the Staff Client source directory (e.g., the directory /home/opensrf/Evergreen-ILS-1.6.0.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, 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, 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, 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, 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, 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, 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, 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 . - - -
-
- 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, 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, 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, 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, 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, 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 ). As the opensrf 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, 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, change directory to the Staff Client source directory, then execute the following commands: -
- Commands for building updates with clients - - $ 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, 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 - -
- - Running the Staff Client over an SSH Tunnel - The Staff Client can use an SSH tunnel as a SOCKS 5 proxy. -
- Configuring 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 - - - - - - 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 Add; "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. - - See How to set up SSH (for the beginner) for information on setting up SSH for other client operating systems, -
-
- 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 - - - - - - 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 - - - - - - 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. -
- -
- + + + + Installation of Evergreen Staff Client Software + + This section describes installation of the Evergreen Staff Client software. + + +
+ Installing the Staff Client + + Installing a Pre-Built Staff Client + You can install the pre-built Staff Client available for Windows, MAC or Linux. + + 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 Next to continue through the guided install process. The Install Wizard will ask you to agree to the end-user license, ask you + where to install the software, ask about where to place icons, and then will install the software on your workstation. + When you run the Staff Client for the first time, a screen similar to this should appear: + + + + + + Running the Staff Client for the first time + + + First, add the name of your Evergreen server to the field Hostname in the Server section. + For example, the PINES demo system is http://demo.gapines.org. After adding the server name, click Re-Test + Server. + Because this is the initial run of the Staff Client, you will see a warning in the upper-right indicating that the Workstation is + Not yet configured for the specified server. The first thing you must do to the Staff Client on every workstation is to assign + it a workstation name. This is covered in . + + + Installing on Mac OS + 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 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 + + + 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 + + + + + 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 for further information. + + The Staff Client data from the directory ./staff_client/build must be placed somewhere on the machine + (e.g. ~/Desktop/Evergreen_Staff_Client). Remember to call XULRunner with the full path to the binary, followed by the + install command and the path to the client data: + + /Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_Client + + This command should exit quietly. The folder /Applications/OpenILS will be created, 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 file /Library/Receipts/xulrunner-ver-mak.pkg does not exist (possibly in newer OSX releases), you need to flush the + file receiptdb. + If you install a newer version over a previous (older) install, the older one is not removed but the symlinks are changed to the newer one. + + Flush Receiptdb file: + First, get the package identifier, then purge/forget the build that was initially installed: + + 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. + See + http://lists.apple.com/archives/Installer-dev/2009/Jul/msg00008.html for more information. + + + + Creating an APP file: Staff Client & XULRunner Bundled + An APP file is basically a folder. Start with a folder stucture like this: + + * Evergreen.app + * Contents + * Frameworks + * Resources + * MacOS + + Create an APP folder structure with the following commands: + + 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): + + + + + CFBundleExecutable + xulrunner + CFBundleGetInfoString + OpenILS open_ils_staff_client rel_1_6_0_7 + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + Evergreen Staff Client + CFBundlePackageType + APPL + CFBundleShortVersionString + rel_1_6_0_7 + CFBundleVersion + rel_1_6_0_7.rel_1_6_0_7 + NSAppleScriptEnabled + + CFBundleTypeIconFile + Evergreen.icns + + + ]]> + + + Download and install an appropriate Mac OS package of XULRunner from the Mozilla website (see above for recommendations). + + Make a copy of the folder /Library/Frameworks/XUL.Framework inside your APP file. It should + look something like this: + + * 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 the folder Evergreen.app/MacOS + (do not symlink; copy the file). + + Make Evergreen.app/Resources the root of your Evergreen application files like this: + + * 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, change directory to the Staff Client source directory, then recursively copy the + entire directory tree to the remote workstation: + + su - opensrf + cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client + scp -r build user@client.linux.machine:~/eg-client-x.x.x.x/ + + To test the newly copied Staff Client, as the opensrf user log into the remote workstation and execute it as + shown: + + su - opensrf + xulrunner ~/eg-client-x.x.x.x/build/application.ini + + + + 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, using a procedure similar to this: + + cd ~/ILS/Open-ILS/xul/staff_client + make STAFF_CLIENT_BUILD_ID='12345' + mkdir /openils/var/web/xul/ + mkdir /openils/var/web/xul/12345/ + cd build/ + cp -R server/ /openils/var/web/xul/12345/ + + The Staff Client can be run from the build directory using this command: + + su - opensrf + xulrunner application.ini + + 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. + + 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. + + 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.6.1.2, 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_6_1_2'. This is the tag you need; make a note of it for the next step. + + + Download the Code + As the opensrf user, open a terminal (command-line prompt) and navigate + to the directory in which you wish to download the Staff Client. Use the following commands to download the proper version of + the source code by tag name: + + su - opensrf + cd /YOUR/DOWNLOAD/DIRECTORY + svn co rel_1_2_1_4/ + + Remember to change "rel_1_6_1_2" 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, run the following commands to build the Staff Client: + + su - opensrf + cd /YOUR/DOWNLOAD/DIRECTORY + cd Open-ILS/xul/staff_client + make STAFF_CLIENT_BUILD_ID='rel_1_6_1_2' + + + + + + Run the Staff Client (from the command line) + As the opensrf user, navigate to the build/ subdirectory + (not staff_client/) and run the following command: + + su - opensrf + xulrunner application.ini + + + + 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. As + the opensrf user, issue the following commands to create a clean "staging" directory in which to place + the finished Staff Client, and to copy into it the "staff_client" directory: + + su - opensrf + mkdir ~/<Destination Directory> + cd ~/<Download Directory>/Open-ILS/xul/ + cp -r staff_client ~/<Destination Directory> + + Finally, test the Staff Client to verify that all the necessary files were moved to the destination directory: + + cd ~/<Destination Directory>/staff_client/build + xulrunner application.ini + + If there were no problems, then finish the cleanup by removing the original download directory and all subdirectories: + + rm -r -f ~/<Download Directory> + + You may wish to create DesktopStart MenuK-Menu + shortcuts for the Staff Client using the command xulrunner ~/<Destination Directory>/staff_client/build/application.ini + as the target. + + + + + Using Wine to Install On Linux + The Linux application Wine is another alternative if you wish to install the packaged Windows versions rather than building + the Staff Client manually. Wine is a Linux application that allows users to directly run Windows executables, and is a simple way for casual Linux users to use + the Staff Client. More information about Wine can be found at + http://www.winehq.org/site/docs/wineusr-guide/getting-wine. + As the root user, use apt-get to install the package for Wine. + You can also use synaptic, the graphical user interface. + + + Install wine + + sudo apt-get install wine + + + + Download Windows installer for the Staff Client + As the opensrf user, run the following commands to download the Windows installer for the + proper Staff Client from the open-ils.org website and place it in a temporary directory: + + su - opensrf + cd /YOUR/DOWNLOAD/DIRECTORY + wget http://open-ils.org/downloads/evergreen-setup-rel_version-number.exe + + + + Run the downloaded Windows installer + As the opensrf user, navigate to the directory where you downloaded the Windows executable + file, then execute it: + + su - opensrf + cd /YOUR/DOWNLOAD/DIRECTORY + wine evergreen-setup-rel_version-number.exe + + If this step fails, you may need to configure Wine first to properly emulate 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. + + + + + 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 their 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 + click 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 click Login. + + + + 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: + + su - root + cd /home/opensrf/[Evergreen Install Directory] + make STAFF_CLIENT_BUILD_ID=[version ID] install + + The following commands will manually build the Staff Client using a different BUILD_ID. + As the opensrf user, change directory to the Staff Client source directory, then set the variable and build + the Staff Client: + + su - opensrf + cd /home/opensrf/[Evergreen Install Directory]/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: + + su - root + cd /home/opensrf/[Evergreen Install Directory] + 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, change directory to the Staff Client source directory, then set the variable and build + the Staff Client: + + su - opensrf + cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client + make STAFF_CLIENT_VERSION=0mytest.200 build + + + + Option STAFF_CLIENT_STAMP_ID variable + During the normal make install Evergreen server-side software build process, this variable is generated from STAFF_CLIENT_VERSION. + You can override the value of STAMP_ID similarly to the BUILD_ID. + The following commands could be used during the normal build process: + + su - root + cd /home/opensrf/[Evergreen Install Directory] + 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, change directory to the Staff Client source directory, then set the variable and build + the Staff Client: + + su - opensrf + cd /home/opensrf/[Evergreen Install Directory]/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 builds clients and copies them to a subdirectory of the + updates directory as well; + 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, run make from the Staff Client source directory: + + su - opensrf + cd /home/opensrf/[Evergreen Install Directory]/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 for "build" when running make. For more information see + Google Closure Compiler. + As the opensrf user, run the following commands from the Staff Client source directory: + + su - opensrf + cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client + make compress-javascript + + You can also combine Javascript review and compression, and also perform a "developer build". + As the opensrf user, run the following commands from the Staff Client source directory: + In the following make below, the order of options is important! + + su - opensrf + cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client + make devbuild compress-javascript + + + + Automatic Update Host + The host used to check for automatic Staff Client updates can be overridden by specifying the option. The + following commands could have been used during the normal build process: + + su - root + cd /home/opensrf/[Evergreen Install Directory] + make AUTOUPDATE_HOST=localhost install + + You can manually set to set up automatic update checking. The following commands will manually build the Staff + Client using a different . + As the opensrf user, change directory to the Staff Client source directory, then set the variable and + build the Staff Client: + + su - opensrf + cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client + make AUTOUPDATE_HOST=localhost build + + For more information on Automatic Updates, see . + + + + + Installing and Activating a Manually Built Staff Client + The Staff Client is automatically built, installed and activated as part of the normal make 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, change directory to the Staff Client source directory, then execute the following commands: + + su - opensrf + cd /home/opensrf/[Evergreen Install Directory]/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 >. + As the opensrf user, change directory to the Staff Client source directory, then execute the + following commands: + + su - opensrf + cd /home/opensrf/[Evergreen Install Directory]/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". + 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. + 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, change directory to the Staff Client source directory, then execute the + following commands: + + su - opensrf + cd /home/opensrf/[Evergreen Install Directory]/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, change directory to the Staff Client source directory, then execute the + following commands: + + su - opensrf + cd /home/opensrf/[Evergreen Install Directory]/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, change directory to the Staff Client source directory, then execute the + following commands: + + su - opensrf + cd /home/opensrf/[Evergreen Install Directory]/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 ). As + the opensrf user, use the utility "configure" as shown: + + su - opensrf + cd /home/opensrf/[Evergreen Install Directory] + ./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 , , , and + 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 . + A full update will be built for each specified target (or for all if you use the target ). 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 currentlysupport partial updates. + As the opensrf user, change directory to the Staff Client source directory, then execute the following + commands: + + +su - opensrf +cd /home/opensrf/[Evergreen Install Directory]/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 to each target + name. For instance, you can specify . You can also specify to build all the targets at once. + This does not work for . + 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, change directory to the Staff Client source directory, then execute the following + commands: + +su - opensrf +cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client + + + Command to build all updates at once: + +make updates-client + + + Command 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 file 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. Execute the following commands: + +su - root +cd /openils/var/updates/pub +chmod +x check download manualupdate.html update.rdf + + + + + Other tips + + Multiple workstations on one install + Multiple workstation registrations for the same server can be accomplished with a single Staff Client install by using multiple profiles. When running XULRunner you can specify the option "-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 , , or , you can + specify to add an Evergreen Staff Client Profile Manager option to the start menu. + As the opensrf user, change directory to the Staff Client source directory, then execute the following + commands: + + su - opensrf + cd /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client + make NSIS_EXTRAOPTS=-DPROFILES win-client + + + + Multiple Staff Clients + This may be confusing if you are not careful, but you can log in to multiple Evergreen servers at the same time, or a single Evergreen server multiple + times. In either case you will need to create an additional profile for each additional server or workstation you want to log in as (see previous tip). + Once you have created the profiles, run XULRunner with the option (in addition to + or + if 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 Install Directory]/, start + the Staff Client as shown in the following example: + + su - opensrf + xulrunner /home/opensrf/[Evergreen Install Directory]/Open-ILS/xul/staff_client/build/application.ini + + + Running the Staff Client over an SSH Tunnel + The Staff Client can use an SSH tunnel as a SOCKS 5 proxy. + + Configuring 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 Add; "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. + + See How to set up SSH (for the beginner) + for information on setting up SSH for other client operating systems, + + + Configuring the Staff Client to Use the <systemitem class="protocal">SSH</systemitem> 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. + + +
+ -- 2.43.2