From cd716ddd492299af3e5347f0e9d63947b0c87fd4 Mon Sep 17 00:00:00 2001 From: Robert Soulliere Date: Tue, 7 Sep 2010 12:27:19 -0400 Subject: [PATCH] Fix many of my typos and misspellings in admin section. change id of staffclient chapter to usingstaffclient. Add some index terms in several admin chapters. --- 1.6/admin/AdminMisc.xml | 386 ++++++++++---------- 1.6/admin/Upgrading-Evergreen_1.6.xml | 586 ++++++++++++++++--------------- 1.6/admin/requirements-configuration.xml | 2 +- 1.6/admin/serveradministration.xml | 139 ++++---- 1.6/admin/troubleshooting.xml | 393 ++++++++++----------- 1.6/stafftasks/staffclient.xml | 2 +- 6 files changed, 750 insertions(+), 758 deletions(-) diff --git a/1.6/admin/AdminMisc.xml b/1.6/admin/AdminMisc.xml index ce2b571727..3de62217ea 100644 --- a/1.6/admin/AdminMisc.xml +++ b/1.6/admin/AdminMisc.xml @@ -1,193 +1,193 @@ - - - - - Server Operations and Maintenance - - This chapter deals with basic server operations such as starting and stopping Evergreen as well wall security, backing up and troubleshooting Evergreen. - - -
- Starting, Stopping and Restarting - Occasionally, you may need to restart Evergreen. It is imperative that you understand the basic - commands to stop and start the Evergreen server. You can start and stop Evergreen from the command line of - the server using the osrf_ctl.sh script located in the - openils/bin directory. - The osrf_ctl.sh script must be run as the opensrf user. - To view help on osrf_ctl.sh and get all of its options, - run: - osrf_ctl.sh -h - To start Evergreen, run: - osrf_ctl.sh -l -a start_all - The -l flag is used to indicate that Evergreen is configured to use localhost as - the host. If you have configured opensrf.xml to use your real hostname, do not use the -l flag. The -a - option is required and indicates the action of the command. In this case - 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. - You can set it using the following command: - export PATH=$PATH:/openils/bin - If you receive the error message Can't locate OpenSRF/System.pm in @INC … BEGIN - failed–compilation aborted, then your environment variable PERL5LIB does not - include the /openils/lib/perl5 directory. You can set it - using the following command: - export PERL5LIB=$PERL5LIB:/openils/lib/perl5 - - It is also possible to start a specific service. For example: - osrf_ctl.sh -l -a start_router - will only start the router service. - - If you decide to start each service individually, you need to start them in a specific order - for Evergreen to start correctly. Run the commands in this exact order: - osrf_ctl.sh -l -a start_router - osrf_ctl.sh -l -a start_perl - osrf_ctl.sh -l -a start_c - - After starting or restarting Evergreen, it is also necessary to restart the Apache web server for the - OPAC to work correctly. - To stop Evergreen, run: - osrf_ctl.sh -l -a stop_all - As with starting, you can choose to stop one service - To restart Evergreen, run: - osrf_ctl.sh -l -a restart_all -
-
- Backing Up - Backing up your system files and data is a critical task for server and database adminstrators. - Having a strategy for backing up and recovery could be the difference between a minor annoyance for users and - a a complete catastrophy. - - Backing up the Evergreen Database - Most of the critical data for an Evergreen system – patrons, bibliographic records, holdings, - transactions, bills – is stored in the PostgreSQL database. You can therefore use normal PostgreSQL - backup procedures to backup this data. For example, the simplest method of backing up the Evergreen - database is to use the pg_dump command to create a live backup of the database without having to - interrupt any Evergreen services as follows: - # pg_dump -U [username] -h [hostname] -f [output-file] [database-name] - pg_dump -U evergreen -h localhost -f evergreen_db.backup evergreen - To restore the backed up database into a new database, create a new database using the - template0 database template and the UTF8 encoding, and run the psql command, specifying the new - database as your target: - createdb -T template0 -E UTF8 -U evergreen -h localhost new_evergreen - psql -U evergreen -h localhost -f evergreen_db.backup new_evergreen - - This method of backup is only suitable for small Evergreen instances. Larger sites - should consider implementing continuous archiving (also known as “log shipping”) to provide - more granular backups with lower system overhead. More information on backing up PostgreSQL - databases can be found in the official PostgreSQL documentation. - - - - Backing up Evergreen Files - When you deploy Evergreen, you will probably customize many aspects of your system includung - the system configuration files, Apache configuration files, OPAC and Staff Client. In order to - protect your investment of time, you should carefully consider the best approach to backing up - files. - There are a number of ways of tackling this problem. You could create a script that regularly - creates a time-stamped tarball of all of these files and copies it to a remote server - but that - would build up over time to hundreds of files. You could use rsync to ensure that the files of - interest are regularly updated on a remote server - but then you would lose track of the changes to - the files, should you make a change that introduces a problem down the road. - Perhaps one of the best options is to use a version control system like Bazaar, git, - Subversion, or CVS to regularly push updates of the files you care about to a repository on a - remote server. This gives you the advantage of quickly being able to run through the history of the - changes you made, with a commenting system that reminds you why each change was made, combined with - remote storage of the pertinent files in case of disaster on site. In addition, your team can create - local copies of the repository and test their own changes in isolation from the production - system. Using a version control system also helps to recover system customizations after an - upgrade. - - - Full System Backup - A full system backup archives every file on the file system. Some basic methods require you - to shut down most system processes; other methods can use mirrored RAID setups or SAN storage to - take “snapshot” backups of your full system while the system continues to run. The subject of how - to implement full system backups is beyond the scope of this documentation. - -
-
- Security - As with an ILS and resource accessible from the world wilde web careful consideration needs to be - given to the security of your Evergreen servers and database. While it is impossible to cover all aspects - of security, it is important to take several percautions when setting up production Evergreen site. - - - Change the Evergreen Admin password and keep it secure. The - default Admin password is known by anyone who has installed Evergreen. It is not a secret - and needs to be changed by the Administrator. It should also only be shared by those who - need the highest level access to Evergreen. - - - Create strong passwords using a combination of numerican and alphatbetical characters - for all of the Administrative passwords used by Evergreen including the Evergreen - postgresql user, opensrf linux account, and Admin evergreen users, and of course, any - superusers on your server. - - - Open ports in the firewall with Caution - It is necessary to open some ports to the - server such as port 80 for http and 443 for ssl, and it can be helpful to open ports for - remote access to the database or staff client. It is also critical for an administrator to - understand the concepts of network security and take precautions to not allow the server to - be vulnerable to the outside world. - - - - Use permissions and permission groups wisely - it is important to understand the - purpose of the permissions and to only give users the level of access that they require. - - - -
-
- Managing Log Files - Evergreen comes with a sophisticated logging system, but it is important to manage the OpenSRF and Evergreen logs. This section will provide a couple of log management techniques - and tools. - - Using the Log Rotate Utility to Manage Log Size - Fortunately, this is not a new problem for Unix administrators, and there are a number of ways of keeping your logs under control. On Debian and Ubuntu, for example, - the logrotate utility controls when old log files are compressed and a new log file is started. logrotate runs once a day and checks all log files that it knows about to see if a - threshold of time or size has been reached and rotates the log files if a threshold condition has been met. - To teach logrotate to rotate Evergreen logs on a weekly basis, or if they are > 50MB in size, create a new file /etc/logrotate.d/evergreen with the - following contents: - compress - /openils/var/log/*.log { - # keep the last 4 archived log files along with the current log file - # log log.1.gz log.2.gz log.3.gz log.4.gz - # and delete the oldest log file (what would have been log.5.gz) - rotate 5 - # if the log file is > 50MB in size, rotate it immediately - size 50M - # for those logs that don't grow fast, rotate them weekly anyway - weekly - } - - - Chaning Logging Level for Evergreen - Change the Log Levels in your config files. Changing the level of logging will help - narrow down errors. - - A high logging level is not wise to do in a production environment since it - will produce vastly larger log files and thus reduce server performance. - - Change logging levels by editing the configuration file - /openils/conf/opensrf_core.xml - you will want to search for lines containing <loglevel>. - the default setting for loglevel is 3 which will log errors, - warnings and information. - The next level is 4 which is for debugging and provides additional information - helpful for the debugging process. - Thus, lines with: - <loglevel>3</loglevel> - Should be changed to: - <loglevel>4</loglevel> - to allow debugging level logging - Other logging levels inclide 0 for no logging, - 1 for logging errors and 2 for logging warnings - and errors. - -
- + + + + + Server Operations and Maintenance + + This chapter deals with basic server operations such as starting and stopping Evergreen as well wall security, backing up and troubleshooting Evergreen. + + +
+ Starting, Stopping and Restarting + Occasionally, you may need to restart Evergreen. It is imperative that you understand the basic + commands to stop and start the Evergreen server. You can start and stop Evergreen from the command line of + the server using the osrf_ctl.sh script located in the + openils/bin directory. + The osrf_ctl.sh script must be run as the opensrf user. + To view help on osrf_ctl.sh and get all of its options, + run: + osrf_ctl.sh -h + To start Evergreen, run: + osrf_ctl.sh -l -a start_all + The -l flag is used to indicate that Evergreen is configured to use localhost as + the host. If you have configured opensrf.xml to use your real hostname, do not use the -l flag. The -a + option is required and indicates the action of the command. In this case + 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. + You can set it using the following command: + export PATH=$PATH:/openils/bin + If you receive the error message Can't locate OpenSRF/System.pm in @INC … BEGIN + failed–compilation aborted, then your environment variable PERL5LIB does not + include the /openils/lib/perl5 directory. You can set it + using the following command: + export PERL5LIB=$PERL5LIB:/openils/lib/perl5 + + It is also possible to start a specific service. For example: + osrf_ctl.sh -l -a start_router + will only start the router service. + + If you decide to start each service individually, you need to start them in a specific order + for Evergreen to start correctly. Run the commands in this exact order: + osrf_ctl.sh -l -a start_router + osrf_ctl.sh -l -a start_perl + osrf_ctl.sh -l -a start_c + + After starting or restarting Evergreen, it is also necessary to restart the Apache web server for the + OPAC to work correctly. + To stop Evergreen, run: + osrf_ctl.sh -l -a stop_all + As with starting, you can choose to stop one service + To restart Evergreen, run: + osrf_ctl.sh -l -a restart_all +
+
+ Backing Up + Backing up your system files and data is a critical task for server and database administrators. + Having a strategy for backing up and recovery could be the difference between a minor annoyance for users and + a a complete catastrophe. + + Backing up the Evergreen Database + Most of the critical data for an Evergreen system – patrons, bibliographic records, holdings, + transactions, bills – is stored in the PostgreSQL database. You can therefore use normal PostgreSQL + backup procedures to backup this data. For example, the simplest method of backing up the Evergreen + database is to use the pg_dump command to create a live backup of the database without having to + interrupt any Evergreen services as follows: + # pg_dump -U [username] -h [hostname] -f [output-file] [database-name] + pg_dump -U evergreen -h localhost -f evergreen_db.backup evergreen + To restore the backed up database into a new database, create a new database using the + template0 database template and the UTF8 encoding, and run the psql command, specifying the new + database as your target: + createdb -T template0 -E UTF8 -U evergreen -h localhost new_evergreen + psql -U evergreen -h localhost -f evergreen_db.backup new_evergreen + + This method of backup is only suitable for small Evergreen instances. Larger sites + should consider implementing continuous archiving (also known as “log shipping”) to provide + more granular backups with lower system overhead. More information on backing up PostgreSQL + databases can be found in the official PostgreSQL documentation. + + + + Backing up Evergreen Files + When you deploy Evergreen, you will probably customize many aspects of your system including + the system configuration files, Apache configuration files, OPAC and Staff Client. In order to + protect your investment of time, you should carefully consider the best approach to backing up + files. + There are a number of ways of tackling this problem. You could create a script that regularly + creates a time-stamped tarball of all of these files and copies it to a remote server - but that + would build up over time to hundreds of files. You could use rsync to ensure that the files of + interest are regularly updated on a remote server - but then you would lose track of the changes to + the files, should you make a change that introduces a problem down the road. + Perhaps one of the best options is to use a version control system like Bazaar, git, + Subversion, or CVS to regularly push updates of the files you care about to a repository on a + remote server. This gives you the advantage of quickly being able to run through the history of the + changes you made, with a commenting system that reminds you why each change was made, combined with + remote storage of the pertinent files in case of disaster on site. In addition, your team can create + local copies of the repository and test their own changes in isolation from the production + system. Using a version control system also helps to recover system customizations after an + upgrade. + + + Full System Backup + A full system backup archives every file on the file system. Some basic methods require you + to shut down most system processes; other methods can use mirrored RAID setups or SAN storage to + take “snapshot” backups of your full system while the system continues to run. The subject of how + to implement full system backups is beyond the scope of this documentation. + +
+
+ Security + As with an ILS and resource accessible from the world wide web careful consideration needs to be + given to the security of your Evergreen servers and database. While it is impossible to cover all aspects + of security, it is important to take several precautions when setting up production Evergreen site. + + + Change the Evergreen Admin password and keep it secure. The + default Admin password is known by anyone who has installed Evergreen. It is not a secret + and needs to be changed by the Administrator. It should also only be shared by those who + need the highest level access to Evergreen. + + + Create strong passwords using a combination of numerical and alphabetical characters + for all of the Administrative passwords used by Evergreen including the Evergreen + postgresql user, opensrf Linux account, and Admin evergreen users, and of course, any + superusers on your server. + + + Open ports in the firewall with Caution - It is necessary to open some ports to the + server such as port 80 for http and 443 for ssl, and it can be helpful to open ports for + remote access to the database or staff client. It is also critical for an administrator to + understand the concepts of network security and take precautions to not allow the server to + be vulnerable to the outside world. + + + + Use permissions and permission groups wisely - it is important to understand the + purpose of the permissions and to only give users the level of access that they require. + + + +
+
+ Managing Log Files + Evergreen comes with a sophisticated logging system, but it is important to manage the OpenSRF and Evergreen logs. This section will provide a couple of log management techniques + and tools. + + Using the Log Rotate Utility to Manage Log Size + Fortunately, this is not a new problem for Unix administrators, and there are a number of ways of keeping your logs under control. On Debian and Ubuntu, for example, + the logrotate utility controls when old log files are compressed and a new log file is started. logrotate runs once a day and checks all log files that it knows about to see if a + threshold of time or size has been reached and rotates the log files if a threshold condition has been met. + To teach logrotate to rotate Evergreen logs on a weekly basis, or if they are > 50MB in size, create a new file /etc/logrotate.d/evergreen with the + following contents: + compress + /openils/var/log/*.log { + # keep the last 4 archived log files along with the current log file + # log log.1.gz log.2.gz log.3.gz log.4.gz + # and delete the oldest log file (what would have been log.5.gz) + rotate 5 + # if the log file is > 50MB in size, rotate it immediately + size 50M + # for those logs that don't grow fast, rotate them weekly anyway + weekly + } + + + Changing Logging Level for Evergreen + Change the Log Levels in your config files. Changing the level of logging will help + narrow down errors. + + A high logging level is not wise to do in a production environment since it + will produce vastly larger log files and thus reduce server performance. + + Change logging levels by editing the configuration file + /openils/conf/opensrf_core.xml + you will want to search for lines containing <loglevel>. + the default setting for loglevel is 3 which will log errors, + warnings and information. + The next level is 4 which is for debugging and provides additional information + helpful for the debugging process. + Thus, lines with: + <loglevel>3</loglevel> + Should be changed to: + <loglevel>4</loglevel> + to allow debugging level logging + Other logging levels include 0 for no logging, + 1 for logging errors and 2 for logging warnings + and errors. + +
+ diff --git a/1.6/admin/Upgrading-Evergreen_1.6.xml b/1.6/admin/Upgrading-Evergreen_1.6.xml index 4ba6ca6b06..aa7807e7c8 100644 --- a/1.6/admin/Upgrading-Evergreen_1.6.xml +++ b/1.6/admin/Upgrading-Evergreen_1.6.xml @@ -1,292 +1,294 @@ - - - - Upgrading Evergreen from 1.4 to 1.6 - - This Chapter will explain the step-by-step process of upgrading Evergreen - from version 1.4 to 1.6, including steps to upgrade OpenSRF. Before - upgrading, it is important to carefully plan an upgrade strategy to minimise system downtime and - service interruptions. All of the steps in this chapter are to be completed from the command line. - - - - - Stop Evergreen and back up data. - - - As root, stop the Apache - web serverweb serverApache. - - - As the opensrf user, stop all - Evergreen - and OpenSRF services: - osrf_ctl.sh -l -a stop_all - - - Back up of the /openils - directory. - - - Back up the evergreen - database. - - - - - Upgrade OpenSRFOpenSRF to 1.2 - - - As the opensrf user, download and extract the source files for OpenSRF - 1.2: - wget \ - http://open-ils.org/downloads/OpenSRF-1.2.2.tar.gz - tar xzf OpenSRF-1.2.2.tar.gz - A new directory OpenSRF-1.2.2 will be created - For the latest edition of OpenSRF, check the Evergreen download page at - . - - - - As the root user, install the software prerequisites using the automatic - prerequisite installer. - aptitude install make - cd /home/opensrf/OpenSRF-1.2.2 - Replace [distribution] below with the following value - for your distribution: - - - debian-etch for Debian Etch (4.0)LinuxDebian - - - debian-lenny for Debian Lenny (5.0) - - - ubuntu-hardy for Ubuntu Hardy Heron (8.04)LinuxUbuntu - - - ubuntu-intrepid for Ubuntu Intrepid Ibex - (8.10) - - - ubuntu-jaunty for Ubuntu Jaunty Jackalope - (9.04) - - - ubuntu-karmic for Ubuntu Karmic Koala - (9.10) - - - make -f src/extras/Makefile.install [distribution] - - This will install a number of packages required by OpenSRF on your system, - including some Perl modules from CPANprogramming languagePerlCPAN -. 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”. - - - As the opensrf user, configure and compile OpenSRF: - You can include the –enable-python and –enable-java configure options if - you want to include support for Pythonprogramming languagePython - and Javaprogramming languageJava -, respectively. - cd /home/opensrf/OpenSRF-1.2.2 - ./configure --prefix=/openils --sysconfdir=/openils/conf - make - - - As the root user, return to your OpenSRF build directory and install - OpenSRF: - cd /home/opensrf/OpenSRF-1.2.2 - make install - - - As the root user, change the ownership of the installed files to the opensrf - user: - chown -R opensrf:opensrf /openils - - - Restart and Test OpenSRF - osrf_ctl.sh -l -a start_all - /openils/bin/srfsh - srfsh# request opensrf.math add 2 2 - You should see output like: - Received Data: 4 - - ------------------------------------ - Request Completed Successfully - Request Time in seconds: 0.007519 - ------------------------------------ - - srfsh# - If test Completed Successfully move onto next section. - If not, refer to troubleshooting section - of this documentation. - - - - - Upgrade Evergreen to 1.6 - - - As the opensrf user, download and extract Evergreen 1.6 - - wget \ - http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.0.3.tar.gz - tar xzf Evergreen-ILS-1.6.0.3.tar.gz - For the latest edition of Evergreen check the Evergreen download page at - - - - As the root user, install the prerequisites: - cd /home/opensrf/Evergreen-ILS-1.6.0.3 - On the next command, replace [distribution] with one of - these values for your distribution of Debian or Ubuntu: - - - debian-etch for Debian Etch (4.0) - - - debian-lenny for Debian Lenny (5.0) - - - ubuntu-hardy for Ubuntu Hardy Heron - (8.04) - - - ubuntu-intrepid for Ubuntu Intrepid Ibex - (8.10) - - - ubuntu-jaunty for Ubuntu Jaunty Jackalope - (9.04) - - - ubuntu-karmic for Ubuntu Karmic Koala - (9.10) - - - make -f Open-ILS/src/extras/Makefile.install [distribution] - - - As the opensrf user, configure and compile - Evergreen: - cd /home/opensrf/Evergreen-ILS-1.6.0.3 - ./configure --prefix=/openils --sysconfdir=/openils/conf - make - - - As the root user, install - Evergreen: - make STAFF_CLIENT_BUILD_ID=rel_1_6_0_3 install - - - Change to the Evergreen installation - directory: - cd /home/opensrf/Evergreen-ILS-1.6.0.3 - - - As the root user, build live-db-setup.pl for the cgi-bin - bootstrapping scripts and offline-config.pl for the offline staff client data - uploader: - perl Open-ILS/src/support-scripts/eg_db_config.pl \ - --create-bootstrap --create-offline --user evergreen \ - --password evergreen --hostname localhost --port 5432 \ - --database evergreen - - - As the root user, change all files to be owned by the - opensrf user and group: - chown -R opensrf:opensrf /openils - - - Update the Evergreen database - psql -U evergreen -h localhost \ - -f Open-ILS/src/sql/Pg/1.4.0.5-1.6.0.0-upgrade-db.sql evergreen - psql -U evergreen -h localhost \ - -f Open-ILS/src/sql/Pg/1.6.0.0-1.6.0.1-upgrade-db.sql evergreen - psql -U evergreen -h localhost \ - -f Open-ILS/src/sql/Pg/1.6.0.1-1.6.0.2-upgrade-db.sql evergreen - psql -U evergreen -h localhost \ - -f Open-ILS/src/sql/Pg/1.6.0.2-1.6.0.3-upgrade-db.sql evergreen - psql -U evergreen -h localhost \ - psql -U evergreen -h localhost -f 1.6.0-mmbxs-cleanup.sql \ - evergreen - - - As the opensrf user, - copy /openils/conf/oils_web.xml.example to /openils/conf/oils_web.xml - (needed for acquisitions templates). - cp /openils/conf/oils_web.xml.example \ - /openils/conf/oils_web.xml - - - Update opensrf_core.xml and opensrf.xml by copying the new example files (/ - openils/conf/opensrf_core.xml.example and /openils/conf/opensrf.xml). - cp /openils/conf/opensrf_core.xml.example \ - /openils/conf/opensrf_core.xml - cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml - - - Update opensrf.xml with the database connection info: - perl Open-ILS/src/support-scripts/eg_db_config.pl \ - --update-config --service all --user evergreen \ - --password evergreen --hostname localhost --port 5432 \ - --database evergreen - - - Update /etc/apache2/startup.pl by copying the example from - Open-ILS/examples/apache/startup.pl. - - - Update /etc/apache2/eg_vhost.conf by copying the example from - Open-ILS/examples/apache/eg_vhost.conf. - - - Update /etc/apache2/sites-available/eg.conf by copying the example from Open-ILS/ - examples/apache/eg.conf. - - - Recover customizations you have made to the Apache - configuration files. For example, if you purchased an SSL certificate, you - will need to edit eg.conf to point to the appropriate SSL certificate files. - - - - - Restart Evergreen and Test - - - As the opensrf user, start all - Evergreen and OpenSRF - services: - osrf_ctl.sh -l -a start_all - - - As the opensrf user, run autogen to refresh the static - organizational data files: - cd /openils/bin - ./autogen.sh -c /openils/conf/opensrf_core.xml -u - - - Start srfsh and try logging in using your Evergreen - username and password: - /openils/bin/srfsh - srfsh% login username password - - - Start the Apache web server. - - - - - - Troubleshooting: - If you encounter errors, refer to the troubleshooting - section of this documentation for tips - on finding solutions and seeking further assistance from the Evergreen community. - - + + + + Upgrading Evergreen from 1.4 to 1.6.0.8 + + This Chapter will explain the step-by-step process of upgrading Evergreen + from version 1.4 to 1.6, including steps to upgrade OpenSRF. Before + upgrading, it is important to carefully plan an upgrade strategy to minimize system downtime and + service interruptions. All of the steps in this chapter are to be completed from the command line. + + + + Stop Evergreen and back up data. + + + As root, stop the Apache + web serverweb serverApache. + + + As the opensrf user, stop all + Evergreen + and OpenSRF services: + osrf_ctl.sh -l -a stop_all + + + Back up of the /openils + directory. + + + Back up the evergreen + database. + + + + + Upgrade OpenSRF<indexterm><primary>OpenSRF</primary><secondary>1.2</secondary></indexterm> to 1.2 + + + As the opensrf user, download and extract the source files for OpenSRF + 1.2: + wget http://open-ils.org/downloads/OpenSRF-1.2.2.tar.gz + tar xzf OpenSRF-1.2.2.tar.gz + A new directory OpenSRF-1.2.2 will be created + For the latest edition of OpenSRF, check the Evergreen download page at + . + + + + As the root user, install the software prerequisites using the automatic + prerequisite installer. + aptitude install make + cd /home/opensrf/OpenSRF-1.2.2 + + Replace [distribution] below with the following value + for your distribution: + + + debian-etch for Debian Etch (4.0)LinuxDebian + + + debian-lenny for Debian Lenny (5.0) + + + ubuntu-hardy for Ubuntu Hardy Heron (8.04)LinuxUbuntu + + + ubuntu-intrepid for Ubuntu Intrepid Ibex + (8.10) + + + ubuntu-jaunty for Ubuntu Jaunty Jackalope + (9.04) + + + ubuntu-karmic for Ubuntu Karmic Koala + (9.10) + + + make -f src/extras/Makefile.install [distribution] + This will install a number of packages required by OpenSRF on your system, + including some Perl modules from CPANprogramming languagePerl + 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. + + + As the opensrf user, configure and compile OpenSRF: + You can include the –enable-python and –enable-java configure options if + you want to include support for Pythonprogramming languagePython + and Javaprogramming languageJava + , respectively. + cd /home/opensrf/OpenSRF-1.2.2 + ./configure --prefix=/openils --sysconfdir=/openils/conf + make + + + + As the root user, return to your OpenSRF build directory and install + OpenSRF: + cd /home/opensrf/OpenSRF-1.2.2 + make install + + + As the root user, change the ownership of the installed files to the opensrf + user: + chown -R opensrf:opensrf /openils + + + Restart and Test OpenSRF + osrf_ctl.sh -l -a start_all + /openils/bin/srfsh + srfsh# request opensrf.math add 2 2 + You should see output like: + Received Data: 4 + + ------------------------------------ + Request Completed Successfully + Request Time in seconds: 0.007519 + ------------------------------------ + + srfsh# + If test Completed Successfully move onto next section. + If not, refer to troubleshooting section + of this documentation. + + + + + Upgrade <application>Evergreen</application> to 1.6 + + + As the opensrf user, download and extract Evergreen 1.6 + + wget http://open-ils.org/downloads/Evergreen-ILS-1.6.0.8.tar.gz + tar xzf Evergreen-ILS-1.6.0.8.tar.gz + For the latest edition of Evergreen check the Evergreen download page at + and adjust upgrading instructions accordingly. + + + As the root user, install the prerequisites: + cd /home/opensrf/Evergreen-ILS-1.6.0.8 + On the next command, replace [distribution] with one of + these values for your distribution of Debian or Ubuntu: + + + debian-etch for Debian Etch (4.0) + + + debian-lenny for Debian Lenny (5.0) + + + ubuntu-hardy for Ubuntu Hardy Heron + (8.04) + + + ubuntu-intrepid for Ubuntu Intrepid Ibex + (8.10) + + + ubuntu-jaunty for Ubuntu Jaunty Jackalope + (9.04) + + + ubuntu-karmic for Ubuntu Karmic Koala + (9.10) + + + make -f Open-ILS/src/extras/Makefile.install [distribution] + + + As the opensrf user, configure and compile + Evergreen: + cd /home/opensrf/Evergreen-ILS-1.6.0.8 + ./configure --prefix=/openils --sysconfdir=/openils/conf + make + + + As the root user, install + Evergreen: + make STAFF_CLIENT_BUILD_ID=rel_1_6_0_8 install + + + Change to the Evergreen installation + directory: + cd /home/opensrf/Evergreen-ILS-1.6.0.8 + + + As the root user, change all files to be owned by the + opensrf user and group: + chown -R opensrf:opensrf /openils + + + As the root user, build live-db-setup.pl for the cgi-bin + bootstrapping scripts and offline-config.pl for the offline staff client data + uploader: + cd /home/opensrf/Evergreen-ILS-1.6.0.8 + perl Open-ILS/src/support-scripts/eg_db_config.pl --create-bootstrap --create-offline --user evergreen \ + --password evergreen --hostname localhost --port 5432 --database evergreen + + + As the opensrf user, update server symlink in /openils/var/web/xul/: + cd /openils/var/web/xul/ + rm server + ln -s rel_1_6_0_8/server + + + + Update the Evergreen database: + it is recommended that you back up your Evergreen database in order to restore your data if anything goes wrong. + psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.4.0.5-1.6.0.0-upgrade-db.sql evergreen + psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.0-1.6.0.1-upgrade-db.sql evergreen + psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.1-1.6.0.2-upgrade-db.sql evergreen + psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.2-1.6.0.3-upgrade-db.sql evergreen + psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.3-1.6.0.4-upgrade-db.sql evergreen + psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.4-1.6.0.5-upgrade-db.sql evergreen + psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.5-1.6.0.6-upgrade-db.sql evergreen + psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.6-1.6.0.7-upgrade-db.sql evergreen + psql -U evergreen -h localhost -f Open-ILS/src/sql/Pg/1.6.0.7-1.6.0.8-upgrade-db.sql evergreen + Download and run the the billing view hot-fix script + wget http://www.open-ils.org/downloads/1.6.0-mmbxs-cleanup.sql + psql -U evergreen -h localhost -f 1.6.0-mmbxs-cleanup.sql + + + As the opensrf user, + copy /openils/conf/oils_web.xml.example to /openils/conf/oils_web.xml + (needed for acquisitions templates). + cp /openils/conf/oils_web.xml.example /openils/conf/oils_web.xml + + + Update opensrf_core.xml and opensrf.xml by copying the new example files (/ + openils/conf/opensrf_core.xml.example and /openils/conf/opensrf.xml). + cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml + cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml + + + Update opensrf.xml with the database connection info: + perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config --service all --user evergreen \ + --password evergreen --hostname localhost --port 5432 --database evergreen + + + Update /etc/apache2/startup.pl by copying the example from + Open-ILS/examples/apache/startup.pl. + + + Update /etc/apache2/eg_vhost.conf by copying the example from + Open-ILS/examples/apache/eg_vhost.conf. + + + Update /etc/apache2/sites-available/eg.conf by copying the example from Open-ILS/ + examples/apache/eg.conf. + + + Recover customizations you have made to the ApacheApache + configuration files. For example, if you purchased an SSL certificateSSL certificate, you + will need to edit eg.conf to point to the appropriate SSL certificate files. + + + + + Restart Evergreen and Test + + + As the opensrf user, start all + Evergreen and OpenSRF + services: + osrf_ctl.sh -l -a start_all + + + As the opensrf user, run autogen to refresh the static + organizational data files: + cd /openils/bin + ./autogen.sh -c /openils/conf/opensrf_core.xml -u + + + + Start srfsh and try logging in using your Evergreen + username and password: + /openils/bin/srfsh + srfsh% login username password + + + Start the Apache web server. + + + + + If you encounter errors, refer to the troubleshooting + section of this documentation for tips + on finding solutions and seeking further assistance from the Evergreen community. + + diff --git a/1.6/admin/requirements-configuration.xml b/1.6/admin/requirements-configuration.xml index c31a4d165f..a9295f0574 100644 --- a/1.6/admin/requirements-configuration.xml +++ b/1.6/admin/requirements-configuration.xml @@ -60,7 +60,7 @@ minimum: Windows (XP, Vista, or 7), Mac OS X, or Linux operating system - a reliable high speed internet connection + a reliable high speed Internet connection 512Mb of RAM diff --git a/1.6/admin/serveradministration.xml b/1.6/admin/serveradministration.xml index 6a44d49968..394e35de79 100644 --- a/1.6/admin/serveradministration.xml +++ b/1.6/admin/serveradministration.xml @@ -43,21 +43,21 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - Adding Organization Types + Adding Organization Types<indexterm><primary>organization types</primary><secondary>adding</secondary></indexterm> Select an organization type from the organization type tree on the left and click New Child. Make sure your new type is selected and edit the Type Name, OPAC Label and Parent Type. Change the Parent Type if necessary. - Check the Can Have Volumes and Copies checkbox if the + Check the Can Have Volumes and Copies check box if the organization units of this type will have volumes and copies assigned to it. - Check the Can Have Users checkbox if you will allow users + Check the Can Have Users check box if you will allow users to be have the organization units of this type as their home unit. Click Save to save your new organization type. - Deleting Organization Types + Deleting Organization Types<indexterm><primary>organization types</primary><secondary>deleting</secondary></indexterm> Select the organization type from the Organization Type tree. Click Delete. @@ -70,7 +70,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - Editing Organization Types + Editing Organization Types<indexterm><primary>organization types</primary><secondary>editing</secondary></indexterm> Select the organization type you wish to edit from the organization type tree. Make the changes in the right pane. @@ -79,14 +79,14 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - Organizational Units + Organizational Units<indexterm><primary>organization units</primary></indexterm> Organizational Units are the specific instances of the organization unit types that make up your library's hierarchy. These can include consortia, systems, branches, - etc. The organizational units should have distictive proper names such as + etc. The organizational units should have distinctive proper names such as Main Street Branch or Townsville Campus. - To navigate to the organizational units adminstration page in the staff client select + To navigate to the organizational units administration page in the staff client select Admin Server Administration @@ -94,7 +94,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - Adding Organizational Units + Adding Organizational Units<indexterm><primary>organization units</primary><secondary>adding</secondary></indexterm> Select an Organizational Unit from the organizational unit tree on the left and click New Child. Make sure your new unit is selected and edit the Organizational Unit @@ -108,15 +108,15 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati Select the Organization Unit Type and Parent Organization Unit. - Check the Can Have Volumes and Copies checkbox if the - organization units of this type will have volumes and copies assigned to it. - Check the OPAC Visible checkbox if you want this location to be - visible in the OPAC for searching. + Check the Can Have Volumes and Copies check box if the + organization units of this type will have volumes and copies assigned to it.organization unitsvolumes and copies + Check the OPAC Visible check box if you want this location to be + visible in the OPAC for searching.Organization Unitsopac visible Click Save to save your new organizational unit. - Deleting Organizational Units - Select the organizational unit you wish to delete from the organzational unit tree in the left pane. + Deleting Organizational Units <indexterm><primary>organization units</primary><secondary>deleting</secondary></indexterm> + Select the organizational unit you wish to delete from the organizational unit tree in the left pane. ClickDelete. Click OK on the warning alert box. @@ -127,7 +127,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - Editing Organizational Units + Editing Organizational Units<indexterm><primary>organization units</primary><secondary>editing</secondary></indexterm> Select the organizational unit you wish to edit from the organizational unit tree in the left pane. Edit the fields in the right pane. @@ -137,7 +137,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - Library Hours of Operation + Library Hours of Operation<indexterm><primary>hours of operation</primary><secondary>setting</secondary></indexterm> Local System Administrators can use the Organizational Units interface to set the library's hours of operation. These are regular weekly hours; @@ -149,7 +149,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - Due dates + Due dates<indexterm><primary>hours of operation</primary><secondary>due dates policy</secondary></indexterm> Due dates that would fall on closed days are automatically pushed forward to the next open day. Likewise, if an item is checked out at 8pm, for example, and would normally be due on a day when the library closes before 8pm, Evergreen @@ -158,7 +158,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - Overdue fines + Overdue fines <indexterm><primary>hours of operation</primary><secondary>overdue fines policy</secondary></indexterm> Overdue fines are not charged on days when the library is closed. @@ -217,7 +217,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - Library Addresses + Library Addresses <indexterm><primary>library addresses </primary><secondary>setting</secondary></indexterm> Addresses set in @@ -225,7 +225,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati Server Administrations Organizational Units appear in patron email notifications, hold slips, and transit slips. Local - System Adminstrators should ensure that the Physical, + System Administrators should ensure that the Physical, Holds, and Mailing addresses are set correctly. @@ -233,7 +233,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati Open the Organizational Units interface as described in the previous simplesect. + linkend="server-main">previous section. @@ -254,8 +254,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati There are four address tabs: Physical, Holds, Mailing, and - ILL. Sitka Support recommends setting the first three at a - minimum. The Holds Address appears on transit slips when items are sent to fulfill holds at another branch. + ILL. The Holds Address appears on transit slips when items are sent to fulfill holds at another branch. @@ -267,9 +266,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - The Valid checkbox is an optional setting that does not affect - current Evergreen functions, but the Sitka Support team recommends checking it for all - correct addresses. + The Valid check box is an optional setting that does not affect current Evergreen functions. @@ -279,8 +276,8 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati Adjusting Search Relevancy Rankings - This simplesect describes indexed field weighting and matchpoint weighting, which - control relevance ranking in Evergreen catalog search results. Adjusting relavancy can only be completed through access to the Evergreen database as of version 1.6. + This section describes indexed field weighting and matchpoint weighting, which + control relevance ranking in Evergreen catalog search results. Adjusting relevancy can only be completed through access to the Evergreen database as of version 1.6. In tuning search relevance, it is good practice to make incremental adjustments, capture search logs, and assess results before making further @@ -289,7 +286,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - Indexed-field Weighting + Indexed-field Weighting<indexterm><primary>relevancy</primary><secondary>indexed-field weighting</secondary></indexterm> Indexed-field weighting is configured in the Evergreen database in the weight column of the config.metabib_field table, which follows the other four columns in this table: field_class, name, xpath, and format. @@ -304,8 +301,8 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati jaguar in another indexed field. - Matchpoint Weighting - Matchpoint weighting provides another way to fine-tune Evergreen relevance ranking, + Match point Weighting<indexterm><primary>relevancy</primary><secondary>match point weighting</secondary></indexterm> + Match point weighting provides another way to fine-tune Evergreen relevance ranking, and is configured through floating-point multipliers in the multiplier column of the search.relevance_adjustment table. Weighting can be adjusted for one, more, or all multiplier fields in @@ -313,20 +310,20 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati You can adjust the following three matchpoints: - first_word boosts relevance if the query is + first_wordboosts relevance if the query is one term long and matches the first term in the indexed field (search for twain, get a bonus for twain, mark but not mark twain) - word_order increases relevance for words + word_order increases relevance for words matching the order of search terms, so that the results for the search legend suicide would match higher for the book Legend of a Suicide than for the book, Suicide Legend - full_match boosts relevance when the full + full_match boosts relevance when the full query exactly matches the entire indexed field (after space, case, and diacritics are normalized). So a title search for The Future of Ice would get a relevance boost above Ice>Ages of the @@ -483,7 +480,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - Combining Index Weighting and Matchpoint Weighting + Combining Index Weighting and Match point Weighting Index weighting and matchpoint weighting may be combined. The relevance boost of the combined weighting is equal to the product of the two multiplied values. If the relevance setting in the config.metabib_field were increased to 2, and the multiplier @@ -496,7 +493,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - Adjusting Relevancy for Keyword Searches + Adjusting Relevancy for Keyword Searches<indexterm><primary>relevancy</primary><secondary>keyword searches</secondary></indexterm> Searching the out of the box keyword does not boost the ranking for terms appearing in, the title or subject fields since there is just one keyword index which does not distinguish terms that appear in the title field from those in the notes field for example. In comparison, the title index is actually composed of a number of separate indexes: title|proper, title|uniform, title|alternative, title|translated, etc, that collectively form the title index. You can see this in the @@ -504,7 +501,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati other fields. - From the command line, access the PorstgreSQL command line interface + From the command line, access the PostgreSQL command line interface psql -U evergreen @@ -547,11 +544,11 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati -
- User and Group Permissions +
+ User and Group Permissions <indexterm><primary>permissions</primary><secondary>group</secondary></indexterm> It is essential to understand how user and group permissions can be used to allow staff - to fulfil their roles while ensuring that they only have access to the appropriate level. + to fulfill their roles while ensuring that they only have access to the appropriate level. Permissions in Evergreen are applied to a specific location and system depth based on the home library of the user. The user will only have that permission within the scope provided by the Depth field in relation to his/her working locations. @@ -561,18 +558,17 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati User Permissions - Ihe User permissions editor allows an administrator to set up permission fopr an individual user. However, In most cases, permissions can be controlled more + The User permissions editor allows an administrator to set up permission for an individual user. However, In most cases, permissions can be controlled more efficiently at the group level with individuals being assigned to specific groups based on their roles in the library. To open the user permission editor, select Admin User Permission Editor. Type the user's barcode when prompted. Working Locations - The first simplesect of the User Permission Editor is the the Working Locations - simplesect. You may select more than one working location for a user. This will effect + You may select more than one working location for a user. This will effect the availability of certain permissions which are dependent on the user having the working location. - User Permission Settings + User Permission Settings<indexterm><primary>permissions</primary><secondary>user</secondary></indexterm> Below the working locations is the long list of all the permissions available on your system. For each permission you can apply it by checking the Applied check box. You can also select a depth to which the @@ -581,12 +577,12 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - Group Permissions + Group Permissions <indexterm><primary>permissions</primary><secondary>group</secondary></indexterm> Most permissions should be assigned at the group level. Here you can create new groups based on the roles and responsibilities of the users in your system. Staff will be able to assign users to these groups when they register patrons. It is a good idea to create your groups soon after creating your organizational units. - It is also imprtaant to give careful consideration to the hierarchy of your groups to make + It is also important to give careful consideration to the hierarchy of your groups to make permission assignment as efficient as possible. To enter the Group Permission module from the staff client menu, select Admin Server Administration @@ -603,7 +599,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati their groups Selecting an Editing Permission will determine the group level the user will have for editing other users. Select the Parent Group for the group. - The group will inherit its parent group's permissions so it is unecessary to assign permissions already inherited from its parent. + The group will inherit its parent group's permissions so it is unnecessary to assign permissions already inherited from its parent. Click the Save button. @@ -662,7 +658,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - ABORT_REMOTE_TRANIST + ABORT_REMOTE_TRANSIT Allows user to abort a copy transit if the user is not at the transit source or destination @@ -709,7 +705,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati COPY_BAD_STATUS.override - Allows user to check out an item in a non-circulatable + Allows user to check out an item in a non-circulating status @@ -779,7 +775,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati CREATE_COPY_STAT_CAT - Allows user to create a statisitcal category for + Allows user to create a statistical category for copies @@ -954,7 +950,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati EVERYTHING - Every permssion is granted (for sysadmins and developers + Every permission is granted (for sysadmins and developers only!) @@ -977,7 +973,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati MAX_RENEWALS_REACHED.override - Allows user to renew an item past the maximun renewal + Allows user to renew an item past the maximum renewal count @@ -1111,7 +1107,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati UPDATE_HOLD Allows user to edit holds (such as change notification phone - number or pickup library, as well as retarget the hold and capture + number or pickup library, as well as re-target the hold and capture an item for hold or pickup) @@ -1327,7 +1323,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
- Staff Accounts + Staff Accounts <indexterm><primary>staff accounts</primary></indexterm> @@ -1341,7 +1337,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati Group drop-down menu. - User permissions screenshot + User permissions screen shot @@ -1353,7 +1349,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati Each new staff account must be assigned a Working - Location which determines its access level in staff client interfaces. + Locationstaff accountsworking location which determines its access level in staff client interfaces. Accounts migrated from legacy systems or created before the upgrade to Evergreen 1.6 already have working locations assigned. @@ -1373,7 +1369,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - User permissions screenshot + User permissions screen shot @@ -1400,7 +1396,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - Staff Account Permissions + Staff Account Permissions <indexterm><primary>staff accounts</primary><secondary>permissions</secondary></indexterm> Below is a general outline of staff account permission levels. To view a detailed list of permissions for a particular Evergreen account go to @@ -1678,7 +1674,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati available to any staff account, including LSAs. - User permissions screenshot + User permissions screen shot @@ -1691,8 +1687,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - List of permission names. For help correlating permissions to specific Evergreen - functions please contact Sitka support. + List of permission names. @@ -1707,7 +1702,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - Depth limits application to the staff member's library and should be left at the default. Evergreen blocks attempts to set Federation- or Sitka-wide privileges. + Depth limits application to the staff member's library and should be left at the default. @@ -1726,7 +1721,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati To allow processing of offline transactions check the Applied column next to OFFLINE_EXECUTE. - User permissions screenshot + User permissions screen shot @@ -1742,7 +1737,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati Scroll down and click Save to apply the changes. - User permissions screenshot + User permissions screen shot @@ -1882,9 +1877,9 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati Click Add. Locate you new status and check the Holdable check box if you wish to all users to place holds on items in this status. Check - OPAC Visble if you wish for this status to appear in the public + OPAC Visible if you wish for this status to appear in the public OPAC. - Click Save Changes at the bottum of the screen to + Click Save Changes at the bottom of the screen to save changes to the new status. @@ -1927,7 +1922,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati Deleting Billing Types - Check the checkbox of the billing type(s) you wish to delete. + Check the check box of the billing type(s) you wish to delete. Click Delete Selected. The selected billing types will be deleted without a verification alert. @@ -1958,7 +1953,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati Enter a Code, Name and Description. Select the SIP 2 Media Type. - Check the Magnetic Media check box if the item is magnetic media such as a casette + Check the Magnetic Media check box if the item is magnetic media such as a cassette tape. Click Save to save the new circulation modifier. @@ -1974,7 +1969,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati Editing Circulation Modifiers - Double click on the row of the cirlation modifier you wish to + Double click on the row of the circulation modifier you wish to edit. Make desired changes. Once you have finished editing, click @@ -1983,7 +1978,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati
Cataloging Templates - Cataloging templates are essential for making the cataloguing process more efficient. Templates are used that that the basic structure of specific types of cataloguing records can loaded when the cataloguer adds a new record + Cataloging templates are essential for making the cataloging process more efficient. Templates are used that that the basic structure of specific types of cataloging records can loaded when the cataloger adds a new record Adding Cataloging Templates @@ -2002,7 +1997,7 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="serveradministrati - Add the template to the to the marctemplates list in the open-ils.cat simplesect of the evergreen configuration file opensrf.xml + Add the template to the to the marctemplates list in the open-ils.cat section of the evergreen configuration file opensrf.xml Restart perl services for changes to take effect. diff --git a/1.6/admin/troubleshooting.xml b/1.6/admin/troubleshooting.xml index f0536ddd15..79c1c445e0 100644 --- a/1.6/admin/troubleshooting.xml +++ b/1.6/admin/troubleshooting.xml @@ -1,199 +1,194 @@ - - - Troubleshooting System Errors - If you have Evergreen installed and are encountering systematic errors, here is the steps to find the - cause and solution to most problems. These instructions assume standard locations and file names for Evergreen - installations, and may also include commands for specific Linux distributions. - - Systematic Evergreen Restart to isolate Errors - - Stop Apache: - /etc/init.d/apache2 stop - or - apache2ctl stop - - - Stop OpenSRF: - osrf_ctl.sh -l -a stop_all - You should get either output resembling this: - Stopping OpenSRF C process 12515... - Stopping OpenSRF C process 12520... - Stopping OpenSRF C process 12526... - Stopping OpenSRF Perl process 12471... - Stopping OpenSRF Router process 12466... - Or, if services have already been stopped, output maay look like this: - OpenSRF C not running - OpenSRF Perl not running - OpenSRF Router not running - Occasionally osrf_ctl.sh fails to kill OpenSRF processes, so we should check to make - sure that none are still running with the command: - ps -aef | grep OpenSRF - You should manually kill any OpenSRF processes. - If you were unable to stop OpenSRF with the above methods, you could also try this - command: - rm –R /openils/var/run/*.pid - This will remove the temporary OpenSRF process files from the run directory which may - have been left over from a previous system boot cycle. - - - Restart Ejabberd and Memcached with the following commands: - sudo /etc/init.d/ejabberd restart - sudo /etc/init.d/memcached restart - - - Start the OpenSRF router and check for errors - /openils/bin/osrf_ctl.sh -l -a start_router - If the router started correctly, output will be: - Starting OpenSRF Router - If router does not start correcltly, you should check the router error log files - for error information. - Evergreen 1.6 uses two routers, a public one and a private one, with two different - logfiles: - /openils/var/log/private.router.log - /openils/var/log/public.router.log - A quick way to find error information in the logs is with the grep command. - grep ERR /openils/var/log/*router.log - As a final sanity check, look for router processes using the process status - command: - ps -aef | grep Router - - - Start the OpenSRF perl services and check for errors - /openils/bin/osrf_ctl.sh -l -a start_perl - You should see the following output: - Starting OpenSRF Perl - * starting all services for norcrossfx.norcross.esi - * starting servivce pid=7484 opensrf.settings - * starting servivce pid=7493 open-ils.cat - * starting servivce pid=7495 open-ils.supercat - * starting servivce pid=7497 open-ils.search - * starting servivce pid=7499 open-ils.circ - * starting servivce pid=7501 open-ils.actor - * starting servivce pid=7502 open-ils.storage - * starting servivce pid=7509 open-ils.penalty - * starting servivce pid=7512 open-ils.collections - * starting servivce pid=7514 open-ils.ingest - * starting servivce pid=7517 open-ils.permacrud - * starting servivce pid=7522 open-ils.fielder - * starting servivce pid=7527 open-ils.vandelay - * starting servivce pid=7516 open-ils.reporter - If the perl services do not start correclty or you receive errors, search for errors - in the following log files: - /openils/var/log/router.log - /openils/var/log/osrfsys.log - At this point you can use the grep command to find errors in - any of the Evrgreen log files: - grep ERR /openils/var/log/*.log - As a final sanity check, look for OpenSRF processes: - ps -aef | grep -i opensrf - - - Start the OpenSRF C services and check for errors: - /openils/bin/osrf_ctl.sh -l -a start_c - And output should be: - Starting OpenSRF C (host=localhost) - If the c service does not start, check for errors by grepping - the log files for errors: - grep ERR /openils/var/log/*.log - Check for OpenSRF processes: - ps -aef | grep -i opensrf - - - Smoke test with autogen.sh - The Autogen tool will take some dynamic information from the database and generate - static Javascript files for use by the OPAC and staff client. It is also able to refresh - the proximity map between libraries for the purpose of efficiently routing hold - requests. - As user opensrf, you invoke Autogen with the command: - /openils/bin/autogen.sh -c /openils/conf/opensrf_core.xml -u - If Autogen completes successfully, the output will be: - Updating fieldmapper - Updating web_fieldmapper - Updating OrgTree - removing OrgTree from the cache... - Updating OrgTree HTML - Updating locales selection HTML - Updating Search Groups - Refreshing proximity of org units - Successfully updated the organization proximity - Done - If Autogen does not complete its task and you recieve errors, use - grep to find errors in the log files: - grep ERR /openils/var/log/*.log - - - Connect to Evergreen using the srfsh command-line OpenSRF client - /openils/bin/srfsh - - In order for you to connect using srfsh, you will need to - have set up the .srfsh.xml configuration file in your home directory as as - described in the installation chapter. - - You will then see the srfsh prompt: - srfsh# - At the srfsh prompt, enter this command: - login admin open-ils - You should the request verification: - Received Data: "6f63ff5542da1fead4431c6c280efc75" - ------------------------------------ - Request Completed Successfully - Request Time in seconds: 0.018414 - ------------------------------------ - - Received Data: { - "ilsevent":0, - "textcode":"SUCCESS", - "desc":" ", - "pid":7793, - "stacktrace":"oils_auth.c:312", - "payload":{ - "authtoken":"28804ebf99508496e2a4d2593aaa930e", - "authtime":420.000000 - } - } - - ------------------------------------ - Request Completed Successfully - Request Time in seconds: 0.552430 - ------------------------------------ - Login Session: 28804. Session timeout: 420.000 - srfsh# - If you encounter errors or if you are unable to connect, you should consult the - srfsh.log file. The location of this file is configured in your - .srfsh.xml configuration file and is - /openils/var/log/srfsh.log by default. - Pressing - - Ctrl - D - - or entering exit will terminate srfsh. - - - Start Apache and check for errors: - /etc/init.d/apache2 start - or - apache2ctl start - You should see output: - * Starting web server apache2 - ...done. - the Apache OpenSRF modules write to the - /openils/var/log/gateway.log - However, you should check all of the log files for errors: - grep ERR /openils/var/log/*.log - Another place to check for erros is the Apache error logs - generally located in in the /var/log/Apapche2 - directory - If you encounter errors with Apache, a common source of potential problems are the - Evergreen site configuration files /etc/apache2/eg_vhost.conf and - /etc/apache2/sites-available/eg.conf - - - Try to authenticate with the staff client - - - Try to authenticate with the OPAC - - - + + + Troubleshooting System Errors + If you have Evergreen installed and are encountering systematic errors, here is the steps to find the + cause and solution to most problems. These instructions assume standard locations and file names for Evergreen + installations, and may also include commands for specific Linux distributions. + + Systematic Evergreen Restart to Isolate Errors + + Stop Apache: + /etc/init.d/apache2 stop + or + apache2ctl stop + + + Stop OpenSRF: + osrf_ctl.sh -l -a stop_all + You should get either output simlar to this: + Stopping OpenSRF C process 12515... + Stopping OpenSRF C process 12520... + Stopping OpenSRF C process 12526... + Stopping OpenSRF Perl process 12471... + Stopping OpenSRF Router process 12466... + Or, if services have already been stopped, output may look like this: + OpenSRF C not running + OpenSRF Perl not running + OpenSRF Router not running + Occasionally osrf_ctl.sh fails to kill OpenSRF processes, so we should check to make + sure that none are still running with the command: + ps -aef | grep OpenSRF + You should manually kill any OpenSRF processes. + If you were unable to stop OpenSRF with the above methods, you could also try this + command: + rm –R /openils/var/run/*.pid + This will remove the temporary OpenSRF process files from the run directory which may + have been left over from a previous system boot cycle. + + + Restart Ejabberd and Memcached with the following commands: + sudo /etc/init.d/ejabberd restart + sudo /etc/init.d/memcached restart + + + Start the OpenSRF router and check for errors + /openils/bin/osrf_ctl.sh -l -a start_router + If the router started correctly, output will be: + Starting OpenSRF Router + If router does not start correctly, you should check the router error log files + for error information. + Evergreen 1.6 uses two routers, a public one and a private one, with two different + logfiles: + /openils/var/log/private.router.log + /openils/var/log/public.router.log + A quick way to find error information in the logs is with the grep command. + grep ERR /openils/var/log/*router.log + As a final sanity check, look for router processes using the process status + command: + ps -aef | grep Router + + + Start the OpenSRF perl services and check for errors + /openils/bin/osrf_ctl.sh -l -a start_perl + You should see the output similar to the following: + Starting OpenSRF Perl + * starting all services for ... + * starting service pid=7484 opensrf.settings + * starting service pid=7493 open-ils.cat + * starting service pid=7495 open-ils.supercat + * starting service pid=7497 open-ils.search + * starting service pid=7499 open-ils.circ + * starting service pid=7501 open-ils.actor + * starting service pid=7502 open-ils.storage + ... + + If the perl services do not start correctly or you receive errors, search for errors + in the following log files: + /openils/var/log/router.log + /openils/var/log/osrfsys.log + At this point you can use the grep command to find errors in + any of the Evergreen log files: + grep ERR /openils/var/log/*.log + As a final sanity check, look for OpenSRF processes: + ps -aef | grep -i opensrf + + + Start the OpenSRF C services and check for errors: + /openils/bin/osrf_ctl.sh -l -a start_c + And output should be: + Starting OpenSRF C (host=localhost) + If the c service does not start, check for errors by grepping + the log files for errors: + grep ERR /openils/var/log/*.log + Check for OpenSRF processes: + ps -aef | grep -i opensrf + + + Smoke test with autogen.shautogen + The Autogen tool will take some dynamic information from the database and generate + static JavaScript files for use by the OPAC and staff client. It is also able to refresh + the proximity map between libraries for the purpose of efficiently routing hold + requests. + As user opensrf, you invoke Autogen with the command: + /openils/bin/autogen.sh -c /openils/conf/opensrf_core.xml -u + If Autogen completes successfully, the output will be: + Updating fieldmapper + Updating web_fieldmapper + Updating OrgTree + removing OrgTree from the cache... + Updating OrgTree HTML + Updating locales selection HTML + Updating Search Groups + Refreshing proximity of org units + Successfully updated the organization proximity + Done + If Autogen does not complete its task and you receive errors, use + grep to find errors in the log files: + grep ERR /openils/var/log/*.log + + + Connect to Evergreen using the srfsh command-line OpenSRF clientsrfsh (command-line OpenSRF client) + /openils/bin/srfsh + + In order for you to connect using srfsh, you will need to + have set up the .srfsh.xml configuration file in your home directory as as + described in the installation chapter. + + You will then see the srfsh prompt: + srfsh# + At the srfsh prompt, enter this command: + login admin open-ils + You should the request verification: + Received Data: "6f63ff5542da1fead4431c6c280efc75" + ------------------------------------ + Request Completed Successfully + Request Time in seconds: 0.018414 + ------------------------------------ + + Received Data: { + "ilsevent":0, + "textcode":"SUCCESS", + "desc":" ", + "pid":7793, + "stacktrace":"oils_auth.c:312", + "payload":{ + "authtoken":"28804ebf99508496e2a4d2593aaa930e", + "authtime":420.000000 + } + } + + ------------------------------------ + Request Completed Successfully + Request Time in seconds: 0.552430 + ------------------------------------ + Login Session: 28804. Session timeout: 420.000 + srfsh# + If you encounter errors or if you are unable to connect, you should consult the + srfsh.log file. The location of this file is configured in your + .srfsh.xml configuration file and is + /openils/var/log/srfsh.log by default. + Pressing + + Ctrl + D + + or entering exit will terminate srfsh. + + + Start Apache and check for errors: + /etc/init.d/apache2 start + or + apache2ctl start + You should see output: + * Starting web server apache2 + ...done. + the Apache OpenSRF modules write to the + /openils/var/log/gateway.log + However, you should check all of the log files for errors: + grep ERR /openils/var/log/*.log + Another place to check for errors is the Apache error logs + generally located in in the /var/log/Apache2 + directory + If you encounter errors with Apache, a common source of potential problems are the + Evergreen site configuration files /etc/apache2/eg_vhost.conf and + /etc/apache2/sites-available/eg.conf + + + Try to login from the staff client + + + Try to access the catalog from the OPAC + + + diff --git a/1.6/stafftasks/staffclient.xml b/1.6/stafftasks/staffclient.xml index 343ccfeac7..6e10a9ae65 100644 --- a/1.6/stafftasks/staffclient.xml +++ b/1.6/stafftasks/staffclient.xml @@ -1,5 +1,5 @@ - -- 2.11.0