From 3075349c8b5412476d76ddae3907a521a883f261 Mon Sep 17 00:00:00 2001 From: Steve Sheppard Date: Sat, 18 Sep 2010 11:43:07 -0400 Subject: [PATCH] expand the section 'Installing PostgreSQL'; --- 1.6/admin/ServersideInstallation.xml | 551 ++++++++++++++++----------- 1 file changed, 328 insertions(+), 223 deletions(-) diff --git a/1.6/admin/ServersideInstallation.xml b/1.6/admin/ServersideInstallation.xml index 878a72c940..3255d6ba00 100644 --- a/1.6/admin/ServersideInstallation.xml +++ b/1.6/admin/ServersideInstallation.xml @@ -9,13 +9,13 @@
Overview Installing, configuring and testing the Evergreen server-side software is straightforward with the current stable software release. See for instructions tailored to installing on some particular distributions of the Linux operating system. Earlier software distributions are described in . - 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 Unix-guest Operating System (using, for example, VirtualBox, or VMware, or VirtualPC to emulate a Linux environment). It can also be installed to run on other Linux systems via virtualized environments (using, for example, VirtualBox or VMware). More information on virtualized environments can be found in . + The 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 Unix-guest Operating System (using, for example, "VirtualBox", or "VMware", or "VirtualPC" to emulate a Linux environment). It can also be installed to run on other Linux systems via virtualized environments (using, for example, "VirtualBox" or "VMware"). More information on virtualized environments can be found in . Installation of some sub-components of the Evergreen server-side software is mentioned only in abbreviated form in this section. More detailed information is available in and . Finally, installation of the Evergreen Staff Client software is reviewed in .
Evergreen Software Dependencies 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 @@ -60,7 +60,7 @@
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. + 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.2.2 On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> @@ -118,7 +118,7 @@
- Keywords Targets for <application>make</application> Command + Keywords Targets for <application>"make"</application> Command @@ -344,12 +344,12 @@
- Create Configuration Files for Users Needing <application>srfsh</application> - In this section you will set up a special configuration file for each user who will need to run the srfsh (pronounced surf shell) utility. - The software installation will automatically create srfsh. This is a command line diagnostic tool for testing and interacting with the OpenSRF network software. It will be used in a future step to complete and test the Evergreen installation. See 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. + Create Configuration Files for Users Needing <application>"srfsh"</application> + In this section you will set up a special configuration file for each user who will need to run the "srfsh" (pronounced surf shell) utility. + The software installation will automatically create "srfsh". This is a command line diagnostic tool for testing and interacting with the OpenSRF network software. It will be used in a future step to complete and test the Evergreen installation. See 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 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 @@ -418,9 +418,9 @@
Testing 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: + 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:
- Commands to test OpenSRF with <application>srfsh</application> + Commands to test OpenSRF with <application>"srfsh"</application> $ su - opensrf $ /openils/bin/srfsh @@ -438,7 +438,7 @@ VERIFY THIS TEST VERIFY THIS TEST - For other srfsh commands, type help in at the prompt. + For other "srfsh" commands, type help in at the prompt.
Stopping OpenSRF @@ -497,7 +497,7 @@
- Keywords Targets for <application>make</application> Command + Keywords Targets for <application>"make"</application> Command @@ -553,10 +553,10 @@ ADD INFO FOR OTHER LINUX DISTRIBUTIONS -
+
(OPTIONAL) Install the PostgreSQL Server Since the PostgreSQL server is usually a standalone server in multi-server production systems, the prerequisite installer Makefile in the previous step does not automatically install PostgreSQL. If your PostgreSQL server is on a different system, just skip this step. - For further information on installing PostgreSQL, see . + For further information on manually installing PostgreSQL, see . If your PostgreSQL server will be on the same system as your Evergreen software, then as the root user install the required PostgreSQL server packages:
Commands to install the PostgreSQL server @@ -574,19 +574,14 @@
- PostgreSQL 8.1 is deprecated and will become unsupported in a future release, though existing installations upgrading from Evergreen 1.4 or before will work fine. However, consider upgrading your PostgreSQL installation soon! + PostgreSQL 8.1 is deprecated and will become unsupported in a future Evergreen release, though existing installations upgrading from Evergreen 1.4 or before will continue to work. Please upgrade your PostgreSQL installation soon. ZZZ-REVIEW - VERIFY: IS THIS STILL TRUE? + ADD INFO ON HOW TO DETERMINE WHICH VERSION OF POSTGRESQL YOU CURRENTLY HAVE - VERIFY: IS THIS STILL TRUE? - - ZZZ-REVIEW - ADD INFO ON HOW TO DETERMINE WHICH VERSION OF POSTGRESQL YOU HAVE - - ADD INFO ON HOW TO DETERMINE WHICH VERSION OF POSTGRESQL YOU HAVE + ADD INFO ON HOW TO DETERMINE WHICH VERSION OF POSTGRESQL YOU CURRENTLY HAVE
(OPTIONAL) Install Perl Modules on PostgreSQL Server @@ -597,7 +592,8 @@ # ensure the gcc compiler is installed $ su - root - $ aptitude install gcc + $ apt-get install gcc + ... # install the Perl modules $ perl -MCPAN -e shell @@ -927,11 +923,11 @@
- Create Configuration Files for Users Needing <application>srfsh</application> - 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 users' .srfsh.xml file and make the following changes: + Create Configuration Files for Users Needing <application>"srfsh"</application> + 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 users' .srfsh.xml file and make the following changes: - Modify domain to be the router hostname (following our domain examples, private.localhost> will give srfsh access to all OpenSRF services, while public.localhost will only allow access to those OpenSRF services that are publicly exposed). + Modify 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 @@ -1140,9 +1136,9 @@ 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 that script after a successful Evergreen installation: + 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 that script after a successful Evergreen installation:
- Commands to test Evergreen with <application>srfsh</application> + Commands to test Evergreen with <application>"srfsh"</application> $ su - opensrf $ /openils/bin/srfsh @@ -1171,9 +1167,9 @@
- Other Connection Tests with <application>srfsh</application> + Other Connection Tests with <application>"srfsh"</application> - There is another srfsh command called math_bench that sends queries to the math servers. Note that the opensrf.math and opensrf.dbmath must be running for this command to work: + There is another "srfsh" command called math_bench that sends queries to the math servers. Note that the opensrf.math and opensrf.dbmath must be running for this command to work:
Example of math_bench usage @@ -1185,12 +1181,12 @@
The first argument is how many sets of 4 queries (+ - * /) are sent to opensrf.math. When the response is successful, you will see the string of + symbols. If the system is not running correctly, you will either get an exception or no result at all. - For other srfsh commands, type help in at the prompt. + For other "srfsh" commands, type help in at the prompt. If this does not work, try the troubleshooting steps in the following section.
- Testing with <application>settings-tester.pl</application> + Testing with <application>"settings-tester.pl"</application> As the opensrf user, run the script settings-tester.pl to see if it finds any system configuration problems. Following is sample output generated by executing that script after a successful Evergreen installation:
Example of execution of <command>settings-tester.pl</command> @@ -1278,7 +1274,7 @@
Testing the Catalog By default, the OPAC will live at the URL http://my.domain.com/opac/. - Navigate to this URL and the front page of the OPAC should load. There is a basic text entry field with some extra search options. If you have any problems loading this page, check the Apache error logs. If the page loads but does not function correctly, then check for possible javascript errors. We highty recommend testing with the Firefox browser because of the helpful javascript debugging tools. + Navigate to this URL and the front page of the OPAC should load. There is a basic text entry field with some extra search options. If you have any problems loading this page, check the Apache error logs. If the page loads but does not function correctly, then check for possible javascript errors. We highty recommend testing with the "Firefox" browser because of the helpful javascript debugging tools. Assuming that the OPAC is functioning and there is data in your database, you can now perform other simple functional tests (e.g., searching the catalog). ZZZ-REVIEW @@ -1288,7 +1284,7 @@
Running the Evergreen Staff Client - Run the Evergreen Staff Client by using the application XULRunner (installed automatically and by default with Firefox version 3.0 and later on Ubuntu and Debian distributions). + Run the Evergreen Staff Client by using the application "XULRunner" (installed automatically and by default with Firefox version 3.0 and later on Ubuntu and Debian distributions). For example, if the source files for the Evergreen installation are in the directory /home/opensrf/Evergreen-ILS-1.6.0.7/, start the Staff Client as follows:
Commands to run the Staff Client @@ -1399,7 +1395,7 @@
Organization and Policy Editing - After installing Evergreen, you will want to make configuration changes to reflect the organizational hierarchy and the policies of your library or libraries. See for further information. Examples of what can be configured include: + After installing Evergreen, you will want to make configuration changes to reflect the organizational hierarchy and the policies of your library or libraries. See for further information. Examples of what can be configured include: Adding a branch library Changing circulation rules for an existing library @@ -1411,11 +1407,21 @@ ADD CONTENT FOR ORGANIZATION AND POLICY EDITING
+
+ Getting a Signed SSL Certificate + This section describes how to get a properly signed SSL certificate. + For temporary testing purposes, you can use the command openssl to create a new SSL key for your 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. + + ZZZ-REVIEW + ADD INFO ON HOW TO GET A SIGNED SSL CERTIFICATE + + ADD INFO ON HOW TO GET A SIGNED SSL CERTIFICATE +
Installing In Virtualized Unix Environments - Evergreen software currently runs as a native application on any of several well-known Linux distributions (e.g., Ubuntu and Debian). It does not run as a native application on the Windows operating system (e.g., WindowsXP, WindowsXP Professional, Windows7), but the software can be installed and run on Windows via a virtualized Unix-guest Operating System (using, for example, VirtualBox or VMware to emulate a Linux environment). + Evergreen software currently runs as a native application on any of several well-known Linux distributions (e.g., Ubuntu and Debian). It does not run as a native application on the Windows operating system (e.g., WindowsXP, WindowsXP Professional, Windows7), but the software can be installed and run on Windows via a virtualized Unix-guest Operating System (using, for example, "VirtualBox" or "VMware" to emulate a Linux environment). ZZZ-REVIEW ADD CONTENT FOR INSTALLING EVERGREEN IN VIRTUALIZED UNIX ENVIRONMENTS @@ -1490,7 +1496,7 @@
- Keywords Targets for <application>make</application> Command + Keywords Targets for <application>"make"</application> Command @@ -1664,26 +1670,25 @@ The remainder of the Evergreen installation procedure is identical to that for installing the latest version of Evergreen. Continue with the instructions found in . - -
- Installing OpenSRF 1.0.7 On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> - This section describes the installation of the previous version of the Open Service Request Framework (OpenSRF), a major component of the Evergreen server-side software, on Ubuntu or Debian systems. Evergreen software is integrated with and depends on the OpenSRF software system. - Follow the steps outlined here and run the specified tests to ensure that OpenSRF is properly installed and configured. Do not continue with any further Evergreen installation steps until you have verified that OpenSRF has been successfully installed. - - The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) platforms. OpenSRF 1.0.7 has been tested on Debian Etch (4.0), Debian Lenny, Ubuntu Hardy Heron (8.04), and Ubuntu Intrepid Ibex (8.10). - In the following instructions, you are asked to perform certain steps as either the root user, the opensrf user, or the postgres user. - - Debian -- To become the root user, issue the command su - and enter the password of the root user. - Ubuntu -- To become the root user, issue the command sudo su - and enter the password of the root user. - - To switch from the root user to a different user, issue the command su - USERNAME. For example, to switch from the root user to the opensrf user, issue the command su - opensrf. Once you have become a non-root user, to become the root user again, simply issue the command exit". - -
- Add the OpenSRF User - As the root user, add the opensrf user to the system. The default shell for the new user is automatically set to /bin/bash to inherit a reasonable environment: -
- Commands to add <systemitem class="username">opensrf</systemitem> user - +
+ Installing OpenSRF 1.0.7 On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> + This section describes the installation of the previous version of the Open Service Request Framework (OpenSRF), a major component of the Evergreen server-side software, on Ubuntu or Debian systems. Evergreen software is integrated with and depends on the OpenSRF software system. + Follow the steps outlined here and run the specified tests to ensure that OpenSRF is properly installed and configured. Do not continue with any further Evergreen installation steps until you have verified that OpenSRF has been successfully installed. + + The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) platforms. OpenSRF 1.0.7 has been tested on Debian Etch (4.0), Debian Lenny, Ubuntu Hardy Heron (8.04), and Ubuntu Intrepid Ibex (8.10). + In the following instructions, you are asked to perform certain steps as either the root user, the opensrf user, or the postgres user. + + Debian -- To become the root user, issue the command su - and enter the password of the root user. + Ubuntu -- To become the root user, issue the command sudo su - and enter the password of the root user. + + To switch from the root user to a different user, issue the command su - USERNAME. For example, to switch from the root user to the opensrf user, issue the command su - opensrf. Once you have become a non-root user, to become the root user again, simply issue the command exit". + +
+ Add the OpenSRF User + As the root user, add the opensrf user to the system. The default shell for the new user is automatically set to /bin/bash to inherit a reasonable environment: +
+ Commands to add <systemitem class="username">opensrf</systemitem> user + $ su - opensrf $ useradd -m -s /bin/bash opensrf $ passwd opensrf @@ -1692,184 +1697,284 @@ passwd: password updated successfully $ -
-
-
- Download and Unpack Latest OpenSRF Version - As the opensrf user, download and extract the latest version of OpenSRF. The latest version can be found here: -
- Commands to download and unpack OpenSRF - +
+
+
+ Download and Unpack Latest OpenSRF Version + As the opensrf user, download and extract the latest version of OpenSRF. The latest version can be found here: +
+ Commands to download and unpack OpenSRF + $ su - opensrf $ wget http://evergreen-ils.org/downloads/OpenSRF-1.0.7.tar.gz $ tar zxf OpenSRF-1.0.7.tar.gz -
- The new directory /home/opensrf/OpenSRF-1.0.7 will be created. -
-
- Install Prerequisites to Build OpenSRF - In this section you will install and configure a set of prerequisites that will be used to build OpenSRF. In a following step you will actually build the software using the make utility. - As the root user, enter the commands show below to build the prerequisites from the software distribution that you just downloaded and unpacked. Remember to replace [DISTRIBUTION] in the example with the keyword corresponding to the actual Linux distribution listed in the "Keywords" figure below. -
- Commands to install prerequisites for OpenSRF - +
+ The new directory /home/opensrf/OpenSRF-1.0.7 will be created. +
+
+ Install Prerequisites to Build OpenSRF + In this section you will install and configure a set of prerequisites that will be used to build OpenSRF. In a following step you will actually build the software using the make utility. + As the root user, enter the commands show below to build the prerequisites from the software distribution that you just downloaded and unpacked. Remember to replace [DISTRIBUTION] in the example with the keyword corresponding to the actual Linux distribution listed in the "Keywords" figure below. +
+ Commands to install prerequisites for OpenSRF + $ su - root $ cd /home/opensrf/OpenSRF-1.0.7 $ make -f src/extras/Makefile.install [DISTRIBUTION] ... -
-
- Keywords Targets for <application>make</application> Command - - - - - - Keyword - Description - - - - - debian-lenny - for Debian Lenny (5.0) - - - debian-etch - for Debian Etch (4.0) - - - ubuntu-intrepid - for Intrepid (8.10) - - - ubuntu-hardy - for Ubuntu Hardy (8.04) - - - -
- This will install a number of packages on the system that are required by OpenSRF, including some Perl modules from CPAN. You can say No to the initial CPAN configuration prompt to allow it to automatically configure itself to download and install Perl modules from CPAN. The CPAN installer will ask you a number of times whether it should install prerequisite modules - say Yes. -
-
- Configure OpenSRF - As the opensrf user, return to the OpenSRF build directory and use the configure utility to prepare for the next step of compiling and linking the software. You can include the and configuration options if you wish to include support for Python and Java, respectively: -
- Commands to configure OpenSRF - +
+ + Keywords Targets for <application>"make"</application> Command + + + + + + Keyword + Description + + + + + debian-lenny + for Debian Lenny (5.0) + + + debian-etch + for Debian Etch (4.0) + + + ubuntu-intrepid + for Intrepid (8.10) + + + ubuntu-hardy + for Ubuntu Hardy (8.04) + + + +
+ This will install a number of packages on the system that are required by OpenSRF, including some Perl modules from CPAN. You can say No to the initial CPAN configuration prompt to allow it to automatically configure itself to download and install Perl modules from CPAN. The CPAN installer will ask you a number of times whether it should install prerequisite modules - say Yes. +
+
+ Configure OpenSRF + As the opensrf user, return to the OpenSRF build directory and use the configure utility to prepare for the next step of compiling and linking the software. You can include the and configuration options if you wish to include support for Python and Java, respectively: +
+ Commands to configure OpenSRF + $ su - opensrf $ cd /home/opensrf/OpenSRF-1.0.7 $ ./configure --prefix=/openils --sysconfdir=/openils/conf $ make ... -
-
-
- Compile, Link and Install OpenSRF - As the root user, return to the OpenSRF build directory and use the make utility to compile, link and install OpenSRF: -
- Commands to build, link and install OpenSRF - +
+
+
+ Compile, Link and Install OpenSRF + As the root user, return to the OpenSRF build directory and use the make utility to compile, link and install OpenSRF: +
+ Commands to build, link and install OpenSRF + $ su - opensrf $ cd /home/opensrf/OpenSRF-1.0.7 $ make install ... -
-
-
- Update the System Dynamic Library Path - As the root user, you must update the system dynamic library path to make your system recognize the newly installed libraries. Do this by creating the new file /etc/ld.so.conf.d/osrf.conf containing a new library path, then run the command ldconfig to automatically read the file and modify the system dynamic library path: -
- Commands to modify system dynamic library path - +
+
+
+ Update the System Dynamic Library Path + As the root user, you must update the system dynamic library path to make your system recognize the newly installed libraries. Do this by creating the new file /etc/ld.so.conf.d/osrf.conf containing a new library path, then run the command ldconfig to automatically read the file and modify the system dynamic library path: +
+ Commands to modify system dynamic library path + $ su - root $ echo "/openils/lib" > /etc/ld.so.conf.d/osrf.conf $ ldconfig -
-
-
- Define Public and Private OpenSRF Domains - Define your public and private OpenSRF domains. For security purposes, OpenSRF uses Jabber domains to separate services into public and private realms. Throughout these instructions, we will use the example domains public.localhost for the public domain and private.localhost for the private domain. On a single-server system, the easiest way to define public and private domains is to define separate host names by adding entries to the file /etc/hosts. - As the root user, edit the file /etc/hosts and add the following entries for our example domains: -
- Example public and private domains in /etc/hosts - +
+
+
+ Define Public and Private OpenSRF Domains + Define your public and private OpenSRF domains. For security purposes, OpenSRF uses Jabber domains to separate services into public and private realms. Throughout these instructions, we will use the example domains public.localhost for the public domain and private.localhost for the private domain. On a single-server system, the easiest way to define public and private domains is to define separate host names by adding entries to the file /etc/hosts. + As the root user, edit the file /etc/hosts and add the following entries for our example domains: +
+ Example public and private domains in /etc/hosts + 127.0.1.2 public.localhost public 127.0.1.3 private.localhost private -
-
-
- Change File Ownerships - As the root user, change the ownership of files installed in the directory /openils to the opensrf user: -
- Commands to change file ownerships - +
+
+
+ Change File Ownerships + As the root user, change the ownership of files installed in the directory /openils to the opensrf user: +
+ Commands to change file ownerships + $ chown -R opensrf:opensrf /openils -
-
-
- Stop the <systemitem class="service">ejabberd</systemitem> Service - As the root user, stop the ejabberd service: -
- Commands to stop the <systemitem class="service">ejabberd</systemitem> service - +
+
+
+ Stop the <systemitem class="service">ejabberd</systemitem> Service + As the root user, stop the ejabberd service: +
+ Commands to stop the <systemitem class="service">ejabberd</systemitem> service + $ /etc/init.d/ejabberd stop -
- If ejabberd reports that it is already stopped, it may have run into a problem starting back at the installation stage. One possible fix is to kill any remaining beam and epmd processes, then edit the configuration file /etc/ejabberd/ejabberd.cfg to hardcode a domain: -
- Commands to recover from <systemitem class="service">ejabberd</systemitem> errors - +
+ If ejabberd reports that it is already stopped, it may have run into a problem starting back at the installation stage. One possible fix is to kill any remaining beam and epmd processes, then edit the configuration file /etc/ejabberd/ejabberd.cfg to hardcode a domain: +
+ Commands to recover from <systemitem class="service">ejabberd</systemitem> errors + $ su - root $ epmd -kill $ killall beam; killall beam.smp $ rm /var/lib/ejabberd/* $ echo 'ERLANG_NODE=ejabberd@localhost' >> /etc/default/ejabberd -
-
-
- Edit the <systemitem class="service">ejabberd</systemitem> configuration - As the root user, edit the file /etc/ejabberd/ejabberd.cfg and make the following changes: - - Change {hosts, ["localhost"]}. to {hosts, ["localhost", "private.localhost", "public.localhost"]}. - Change {max_user_sessions, 10}. to {max_user_sessions, 1000}. If you see something like this instead: {access, max_user_sessions, [{10, all}]}., then change it to {access, max_user_sessions, [{1000, all}]}. - Change all three occurrences of max_stanza_size to 2000000. - Change both occurrences of maxrate to 500000. - Comment out the line {mod_offline, []} by placing two % comment signs in front. - -
-
- OpenSRF installation - (continued) - - The remainder of the OpenSRF installation procedure is identical to that for installing the latest version of OpenSRF. Continue with the instructions found in . - + +
+
+ Edit the <systemitem class="service">ejabberd</systemitem> configuration + As the root user, edit the file /etc/ejabberd/ejabberd.cfg and make the following changes: + + Change {hosts, ["localhost"]}. to {hosts, ["localhost", "private.localhost", "public.localhost"]}. + Change {max_user_sessions, 10}. to {max_user_sessions, 1000}. If you see something like this instead: {access, max_user_sessions, [{10, all}]}., then change it to {access, max_user_sessions, [{1000, all}]}. + Change all three occurrences of max_stanza_size to 2000000. + Change both occurrences of maxrate to 500000. + Comment out the line {mod_offline, []} by placing two % comment signs in front. + +
+
+ OpenSRF installation - (continued) + + The remainder of the OpenSRF installation procedure is identical to that for installing the latest version of OpenSRF. Continue with the instructions found in . + +
-
- Getting a Signed SSL Certificate - This section describes how to get a properly signed SSL certificate. - For temporary testing purposes, you can use the command openssl to create a new SSL key for your 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. - - ZZZ-REVIEW - ADD INFO ON HOW TO GET A SIGNED SSL CERTIFICATE - - ADD INFO ON HOW TO GET A SIGNED SSL CERTIFICATE -
Installing PostgreSQL - - ZZZ-REVIEW - ADD CONTENT FOR POSTGRESQL - - ADD CONTENT FOR POSTGRESQL + In production Evergreen systems, the PostgreSQL database server may reside on the same system on which Evergreen is installed or on another standalone system so, by default, PostgreSQL is not automatically installed along with Evergreen. This section details the steps needed to manually install PostgreSQL on a Ubuntu or Debian system. + If your PostgreSQL server will be on the same system as your Evergreen software, return to the previous section and follow those instructions. Otherwise, to manually install PostgreSQL on a system, continue with the instructions below. + + Some Linux distributions, such as Debian Etch (4.0), do not offer PostgreSQL version 8.2 as an installable package. Before you continue, examine the software dependencies listed in to ensure that your Linux distribution supports the required version of PostgreSQL. + + + + Install the application "stow" on your system if it is not already installed. Issue the following command as the root user: +
+ Installing <application>"stow"</application> + + $ apt-get install stow + ... + +
+ + + Download, compile, and install the latest release for PostgreSQL 8.2 (which was version 8.2.12 at the time of this writing). As the root user, follow these steps: +
+ Installing PostgreSQL + + $ wget http://wwwmaster.postgresql.org/redir/198/h/source/v8.2.17/postgresql-8.2.17.tar.bz2 + $ tar xzf postgresql-8.2.17.tar.gz + $ cd postgresql-8.2.17 + $ ./configure --with-perl --enable-integer-datetimes --with-openssl --prefix=/usr/local/stow/pgsql + ... + $ make + ... + $ make install + ... + $ cd contrib + $ make + ... + $ make install + $ cd xml2 + $ make + ... + $ make install + $ cd /usr/local/stow + $ stow pgsql + +
+ + + Create the new user postgres to run the PostgreSQL processes. As the root user, execute this command: +
+ Adding <systemitem class="username">postgres</systemitem> + + $ adduser postgres + +
+ + + Initialize the database directory and start up PostgreSQL. As the root user, follow these steps: +
+ Adding <systemitem class="username">postgres</systemitem> + + $ mkdir -p /usr/local/pgsql/data + $ chown postgres /usr/local/pgsql/data + $ su - postgres + $ initdb -D /usr/local/pgsql/data -E UNICODE --locale=C + $ pg_ctl -D /usr/local/pgsql/data -l /home/postgres/logfile start + +
+ + If an error occurs during the final step above, review the path of the home directory for the postgres user. It may be /var/lib/postresql instead of /home/postres. + + + + The values of several PostreSQL configuration parameters may be changed for enhanced performance. The following table lists the default values and some suggested updates for several useful parameters: + + Suggested configuration values + + + + + + + Parameter + Default + Suggested + + + + + default_statistics_target + 10 + 100 + + + work_mem + 4Mb + 128Mb + + + shared_buffers + 8Mb + 512Mb + + + effective_cache_size + 128Mb + 4Gb + + + +
+ + ZZZ-REVIEW + ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS + + ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS + +
Installing Apache @@ -1922,11 +2027,11 @@
Installing on <systemitem class="osname">Mac OS X</systemitem> - A Mac OS X package that contains the current version of the Staff Client is available for use with xulrunner. + A Mac OS X package that contains the current version of the Staff Client is available for use with "xulrunner".
Evergreen Indiana Pkg file [Evergreen v1.2.3.0] - Download and install the latest version of xulrunner for Mac OS X. Release notes for the latest version can be found here: http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes. Note, later versions may not work correctly. + Download and install the latest version of "xulrunner" for Mac OS X. Release notes for the latest version can be found here: http://developer.mozilla.org/en/docs/XULRunner_1.8.0.4_Release_Notes. Note, later versions may not work correctly. Download and install the Mac OS X Installation package for the 1_2_3_0 Version Staff Client from http://evergreen.lib.in.us/opac/extras/files/evergreen_osx_staff_client_1_2_3.zip. To upgrade to a more recent version of the Staff Client, you can copy the directory build from a working Windows installation of the desired version of the Staff Client to your Mac. The required files may be located in a directory like this on the Windows machine: C:\Program Files\Evergreen Staff Client\build. Copy these files into the folder Resources within the Open-ILS package in your Applications directory on the Mac, overwriting files with the same names. Drag the application's icon into your toolbar for easier access. @@ -1954,8 +2059,8 @@ FIX BAD LINK: http://es.zionsville.lib.in.us/atheos/eg_osx_a.gif
- Running directly using <application>xulrunner</application> - You must install an appropriate version of xulrunner to match the Evergreen version. See the following table for the recommended version of xulrunner: + Running directly using <application>"xulrunner"</application> + You must install an appropriate version of "xulrunner" to match the Evergreen version. See the following table for the recommended version of "xulrunner": Evergreen / XULRunner Dependencies @@ -1977,10 +2082,10 @@
- If you have issues removing previously installed xulrunner versions see for information on removing previous XULRunner versions. - The Staff Client data from the directory ./staff_client/build must be placed somewhere on the machine (e.g. ~/Desktop/Evergreen_Staff_Client). Remember to call XULRunner with the full path to the binary, followed by the install command and the path to the client data. See the following command: + If you have issues removing previously installed "xulrunner" versions see for information on removing previous "XULRunner" versions. + The Staff Client data from the directory ./staff_client/build must be placed somewhere on the machine (e.g. ~/Desktop/Evergreen_Staff_Client). Remember to call "XULRunner" with the full path to the binary, followed by the install command and the path to the client data. See the following command:
- Executing <application>xulrunner</application> + Executing <application>"xulrunner"</application> /Library/Frameworks/XUL.framework/xulrunner-bin --install-app ~/Desktop/Evergreen_Staff_Client @@ -1988,7 +2093,7 @@ This command should exit quietly. A folder will be created, named /Applications/OpenILS, containing a launcher named open_ils_staff_client.
- Removing previously installed <application>xulrunner</application> versions + Removing previously installed <application>"xulrunner"</application> versions If you already have a newer version installed, per the release notes, you will need to remove the entire directory /Library/Frameworks/XUL.framework before downgrading. In addition, you may also need to remove the previous file /Library/Receipts/xulrunner-ver-mak.pkg. If there is no file /Library/Receipts/xulrunner-ver-mak.pkg (possibly in newer OSX releases) you need to flush the file receiptdb. @@ -2004,7 +2109,7 @@ It may not be necessary to edit the file /Library/Receipts/InstallHistory.plist after deleting the folder XUL.framework.
- Creating an APP file: Staff Client & <application>xulrunner</application> Bundled + Creating an APP file: Staff Client & <application>"xulrunner"</application> Bundled An APP file is basically a folder. Start with a folder structure like this:
Sample APP file folder structure @@ -2059,7 +2164,7 @@ ]]>
- Download and install an appropriate Mac OS Xpackage of XULRunner from the Mozilla website (see above for recommendations). + Download and install an appropriate Mac OS Xpackage of "XULRunner" from the Mozilla website (see above for recommendations). Make a copy of /Library/Frameworks/XUL.Framework inside your APP file. It should look something like this:
@@ -2140,11 +2245,11 @@
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). + 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 Debian 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. + 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 @@ -2214,7 +2319,7 @@ If you're installing from a Subversion checkout:
- Building from a <application>subversion</application> checkout + Building from a <application>"subversion"</application> checkout $ su - opensrf $ svn co svn://svn.open-ils.org/ILS/tags/rel_1_4_0_4/ @@ -2275,14 +2380,14 @@
- Using <application>Wine</application> to Install On Linux - The Linux application Wine is another alternative for those who wish to install the packaged Windows versions rather than building the Staff Client manually. Wine is a Linux application that allows users to directly run Windows executables, and is a simple way for casual Linux users to use the Staff Client. More information about Wine can be found at http://www.winehq.org/site/docs/wineusr-guide/getting-wine. - As the root user, use apt-get to install the package for Wine. You can also use synaptic, the graphical user interface. + Using <application>"Wine"</application> to Install On Linux + The Linux application "Wine" is another alternative for those who wish to install the packaged Windows versions rather than building the Staff Client manually. "Wine" is a Linux application that allows users to directly run Windows executables, and is a simple way for casual Linux users to use the Staff Client. More information about "Wine" can be found at http://www.winehq.org/site/docs/wineusr-guide/getting-wine. + As the root user, use "apt-get" to install the package for "Wine". You can also use "synaptic", the graphical user interface. - Install Wine + Install "Wine"
- Installing <application>Wine</application> + Installing <application>"Wine"</application> $ sudo apt-get install wine @@ -2447,7 +2552,7 @@ 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 <application>make</application> Command + Keywords Targets for <application>"make"</application> Command @@ -2523,7 +2628,7 @@ Compressed Javascript - You can execute the Google application Closure Compiler to automatically review and compress Javascript code after the build process completes, by substituting compress-javascript for build when running make. For more information see Google "Closure Compiler". + You can execute the Google application "Closure Compiler" to automatically review and compress Javascript code after the build process completes, by substituting compress-javascript for build when running make. For more information see Google "Closure Compiler". As the opensrf user, run the following commands from the Staff Client source directory:
Commands to compress Javascript @@ -2595,7 +2700,7 @@ Packaging a Generic Client - This build creates a Staff Client packaged as an XPI file to use with XULRunner. It requires that you already have the zip utility installed on your system. It will create the output file evergreen_staff_client.xpi, suitable for use with the XULRunner option . + This build creates a Staff Client packaged as an XPI file to use with XULRunner. It requires that you already have the "zip" utility installed on your system. It will create the output file evergreen_staff_client.xpi, suitable for use with the XULRunner option . As the opensrf user, change directory to the Staff Client source directory, then execute the following commands:
Commands to package a "generic" client @@ -2609,9 +2714,9 @@ Packaging a Windows Client - This build creates a Staff Client packaged as a Windows executable. It requires that you already have the unzip utility installed on your system. It also requires that you install NSIS (Nullsoft Scriptable Install System), a professional open source utility package used to create Windows installers (the makensis utility is installed as part of the nsis package). We recommend using Version 2.45 or later. This build will create the output file evergreen_staff_client_setup.exe. - (OPTIONAL) If you wish for the Staff Client to have a link icon/tray icon by default, you may wish to provide a pre-modified xulrunner-stub.exe. Place it in the Staff Client source directory and make will automatically use it instead of the one that comes with the downloaded XULRunner release. The version of xulrunner-stub.exe need not match exactly. - (OPTIONAL) You can also use a tool such as Resource Hacker to embed icons. Resource Hacker is an open-source utility used to view, modify, rename, add, delete and extract resources in 32bit Windows executables. See the following table for some useful icon ID strings: + This build creates a Staff Client packaged as a Windows executable. It requires that you already have the "unzip" utility installed on your system. It also requires that you install NSIS (Nullsoft Scriptable Install System), a professional open source utility package used to create Windows installers (the "makensis" utility is installed as part of the "nsis" package). We recommend using Version 2.45 or later. This build will create the output file evergreen_staff_client_setup.exe. + (OPTIONAL) If you wish for the Staff Client to have a link icon/tray icon by default, you may wish to provide a pre-modified xulrunner-stub.exe. Place it in the Staff Client source directory and "make" will automatically use it instead of the one that comes with the downloaded XULRunner release. The version of xulrunner-stub.exe need not match exactly. + (OPTIONAL) You can also use a tool such as Resource Hacker to embed icons. "Resource Hacker" is an open-source utility used to view, modify, rename, add, delete and extract resources in 32bit Windows executables. See the following table for some useful icon ID strings:
Useful icon ID strings @@ -2656,7 +2761,7 @@ 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. + 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 @@ -2769,7 +2874,7 @@ Activating the Update Server This section reviews scripts associated with the update server, and requires some final adjustments to file permissions. The Apache example configuration creates a directory updates that, by default, points to the directory /openils/var/updates/pub. This directory contains one HTML file and several specially-named script files. - The file updatedetails.html 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 file updatedetails.html 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 @@ -2833,7 +2938,7 @@
Setting Up an SSH Tunnel You will need a server that has network access to the Evergreen server you want to reach, and allows you to log in there via SSH. Use your username and password for that SSH server to set up a tunnel. - For Windows users, one good solution is the open-source utility PuTTY, a free telnet/SSH client. An example of setting up a PuTTY session follows: + For Windows users, one good solution is the open-source utility PuTTY, a free telnet/SSH client. An example of setting up a "PuTTY" session follows:
Setting up an SSH tunnel in PuTTY -- 2.43.2