From d608cabbdd878c60632ebfe0c00228b86087a7c4 Mon Sep 17 00:00:00 2001 From: Steve Sheppard Date: Fri, 10 Sep 2010 12:43:09 -0400 Subject: [PATCH] add temporary index and tags to mark up unfinished parts; --- 1.6/admin/ServersideInstallation.xml | 188 +++++++++++++++++++++++++++++------ 1 file changed, 156 insertions(+), 32 deletions(-) diff --git a/1.6/admin/ServersideInstallation.xml b/1.6/admin/ServersideInstallation.xml index 24d98c8e60..04ef2740bf 100644 --- a/1.6/admin/ServersideInstallation.xml +++ b/1.6/admin/ServersideInstallation.xml @@ -48,7 +48,6 @@ - VERIFY THE DEPENDENCIES IN THIS TABLE
Current Stable Software Release @@ -158,7 +157,11 @@ - ADD INFO FOR OTHER LINUX DISTRIBUTIONS + + ZZZ-REVIEW + ADD INFO FOR OTHER LINUX DISTRIBUTIONS + + ADD INFO FOR OTHER LINUX DISTRIBUTIONS This will install a number of packages on the system that are required by OpenSRF, including some Perl modules from CPAN. You can say "no" to the initial CPAN configuration prompt to allow it to automatically configure itself to download and install Perl modules from CPAN. The CPAN installer will ask you a number of times whether it should install prerequisite modules - say "yes".
@@ -436,7 +439,11 @@ srfsh# - VERIFY THIS TEST + + ZZZ-REVIEW + VERIFY THIS TEST + + VERIFY THIS TEST For other srfsh commands, type 'help' in at the prompt.
@@ -546,7 +553,11 @@ - ADD INFO FOR OTHER LINUX DISTRIBUTIONS + + ZZZ-REVIEW + ADD INFO FOR OTHER LINUX DISTRIBUTIONS + + ADD INFO FOR OTHER LINUX DISTRIBUTIONS
(OPTIONAL) Install the PostgreSQL Server @@ -572,8 +583,16 @@ PostgreSQL 8.1 is deprecated and will become unsupported in a future release, though existing installations upgrading from Evergreen 1.4 or before will work fine. However, consider upgrading your Postgres soon! - VERIFY: IS THIS STILL TRUE? - ADD INFO ON HOW TO DETERMINE WHICH VERSION OF POSTGRESQL YOU HAVE + + ZZZ-REVIEW + VERIFY: IS THIS STILL TRUE? + + VERIFY: IS THIS STILL TRUE? + + ZZZ-REVIEW + ADD INFO ON HOW TO DETERMINE WHICH VERSION OF POSTGRESQL YOU HAVE + + ADD INFO ON HOW TO DETERMINE WHICH VERSION OF POSTGRESQL YOU HAVE
(OPTIONAL) Install Perl Modules on PostgreSQL Server @@ -593,8 +612,16 @@ cpan> install MARC::File::XML - ADD INFO ON HOW TO INSTALL THE PERL MODULES - ADD INFO ON HOW TO VERIFY THAT THE PERL MODULES ARE INSTALLED + + ZZZ-REVIEW + ADD INFO ON HOW TO INSTALL THE PERL MODULES + + ADD INFO ON HOW TO INSTALL THE PERL MODULES + + ZZZ-REVIEW + ADD INFO ON HOW TO VERIFY THAT THE PERL MODULES ARE INSTALLED + + ADD INFO ON HOW TO VERIFY THAT THE PERL MODULES ARE INSTALLED
Update the System Dynamic Library Path @@ -614,7 +641,11 @@
(OPTIONAL) Restart the PostgreSQL Service If PostgreSQL is running on the same system as the rest of Evergreen, as the root user you must restart the PostgreSQL service to avoid a problem where the library plperl.so cannot be found. If your PostgreSQL server is running on another system, just skip this step. - ADD INFO ON OTHER VERSIONS OF POSTGRESQL + + ZZZ-REVIEW + ADD INFO ON OTHER VERSIONS OF POSTGRESQL + + ADD INFO ON OTHER VERSIONS OF POSTGRESQL
Commands to restart PostgreSQL service @@ -780,7 +811,11 @@ This is only a temporary measure to expedite testing. You must get a proper SSL certificate for a public production system. - ADD INFO ON HOW TO GET A 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
Modify the Apache Configuration File @@ -799,7 +834,11 @@ Comment out the line Listen 443 as it conflicts with the same declaration in the configuration file: /etc/apache2/ports.conf. Debian etch users should not do this. - ADD INFO ON WHY DEBIAN ETCH USERS SHOULD NOT DO THIS + + ZZZ-REVIEW + ADD INFO ON WHY DEBIAN ETCH USERS SHOULD NOT DO THIS + + ADD INFO ON WHY DEBIAN ETCH USERS SHOULD NOT DO THIS The following updates are needed to allow the logs to function properly, but it may break other Apache applications on your server. We hope to make this unnecessary in a future Evergreen release. @@ -860,7 +899,11 @@ The following example uses common XPath syntax on the left-hand side to indicate the approximate position needing changes within the XML file: - ADD A BETTER DIAGRAM HERE + + ZZZ-REVIEW + ADD A BETTER DIAGRAM HERE + + ADD A BETTER DIAGRAM HERE
Updates needed in the file "/openils/conf/opensrf_core.xml" @@ -971,7 +1014,11 @@ You can also start Evergreen without the -l flag, but the utility osrf_ctl.sh must know the fully qualified domain name for the system on which it will execute. That hostname may have been specified in the configuration file opensrf.xml, which you configured in a previous step. - ADD EXPLANATION FOR CONFIGURING "opensrf.xml" + + ZZZ-REVIEW + ADD EXPLANATION FOR CONFIGURING "opensrf.xml" + + ADD EXPLANATION FOR CONFIGURING "opensrf.xml" Execute the following command to determine the fully qualified domain name of your system:
(OPTIONAL) Commands to determine the fully qualified domain name @@ -997,7 +1044,11 @@ Updating fieldmapper ... - ADD RESULTS OF TESTS FROM "autogen.sh" + + ZZZ-REVIEW + ADD RESULTS OF TESTS FROM "autogen.sh" + + ADD RESULTS OF TESTS FROM "autogen.sh"
@@ -1067,7 +1118,11 @@
Testing with "settings-tester.pl" As the opensrf user, run the script settings-tester.pl to see if it finds any system configuration problems. Following is sample output generated by executing that script after a successful Evergreen installation: - REWORK THIS DIAGRAM TO USE SAME IMAGE STANDARDS AS OTHER CHAPTERS + + ZZZ-REVIEW + REWORK THIS DIAGRAM TO USE SAME IMAGE STANDARDS AS OTHER CHAPTERS + + REWORK THIS DIAGRAM TO USE SAME IMAGE STANDARDS AS OTHER CHAPTERS
Executing the script <emphasis>settings-tester.pl</emphasis> @@ -1089,7 +1144,11 @@ 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 hightly reccommend testing with the Firefox browser because of the helpful javascript debugging tools. Assuming that the OPAC is functioning and there is data in your database, you can now perform other simple functional tests (e.g., searching the catalog). - ADD OTHER SIMPLE FUNCTIONAL TESTS + + ZZZ-REVIEW + ADD OTHER SIMPLE FUNCTIONAL TESTS + + ADD OTHER SIMPLE FUNCTIONAL TESTS
Running the Evergreen Staff Client @@ -1134,7 +1193,11 @@ You can also stop Evergreen services without the -l flag, but the utility osrf_ctl.sh must know the fully qualified domain name for the system on which it will execute. That hostname may have been specified in the configuration file opensrf.xml, which you configured in a previous step. - ADD EXPLANATION FOR CONFIGURING "opensrf.xml" + + ZZZ-REVIEW + ADD EXPLANATION FOR CONFIGURING "opensrf.xml" + + ADD EXPLANATION FOR CONFIGURING "opensrf.xml"
Post-Installation Chores @@ -1151,7 +1214,11 @@ The temporary SSL key was only created to expedite testing. You must get a proper SSL certificate for a public production system. - ADD EXPLANATION OF HOW TO GET PERMANENT SSL CERTIFICATE + + ZZZ-REVIEW + ADD EXPLANATION OF HOW TO GET PERMANENT SSL CERTIFICATE + + ADD EXPLANATION OF HOW TO GET PERMANENT SSL CERTIFICATE
Set Up Support For Reports @@ -1203,18 +1270,34 @@
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). - ADD CONTENT FOR INSTALLING EVERGREEN IN VIRTUALIZED UNIX ENVIRONMENTS + + ZZZ-REVIEW + ADD CONTENT FOR INSTALLING EVERGREEN IN VIRTUALIZED UNIX ENVIRONMENTS + + ADD CONTENT FOR INSTALLING EVERGREEN IN VIRTUALIZED UNIX ENVIRONMENTS
VirtualBox - ADD CONTENT FOR VirtualBox + + ZZZ-REVIEW + ADD CONTENT FOR VirtualBox + + ADD CONTENT FOR VirtualBox
VMware - ADD CONTENT FOR VMware + + ZZZ-REVIEW + ADD CONTENT FOR VMware + + ADD CONTENT FOR VMware
VirtualPC - ADD CONTENT FOR VirtualPC + + ZZZ-REVIEW + ADD CONTENT FOR VirtualPC + + ADD CONTENT FOR VirtualPC
@@ -1223,26 +1306,46 @@ The next most recent previous release of Evergreen is version 1.4.0.6. The accompanying previous release of OpenSRF is version 1.0.x.
Installing Evergreen 1.4.0.6 on Ubuntu or Debian - ADD CONTENT FOR INSTALLING EVERGREEN 1.4.0.6 ON UBUNTU OR DEBIAN + + ZZZ-REVIEW + ADD CONTENT FOR INSTALLING EVERGREEN 1.4.0.6 ON UBUNTU OR DEBIAN + + ADD CONTENT FOR INSTALLING EVERGREEN 1.4.0.6 ON UBUNTU OR DEBIAN
Installing OpenSRF 1.0.x - ADD CONTENT FOR INSTALLING OPENSRF 1.0.x + + ZZZ-REVIEW + ADD CONTENT FOR INSTALLING OPENSRF 1.0.x + + ADD CONTENT FOR INSTALLING OPENSRF 1.0.x
Installing PostgreSQL - ADD CONTENT FOR POSTGRESQL + + ZZZ-REVIEW + ADD CONTENT FOR POSTGRESQL + + ADD CONTENT FOR POSTGRESQL
Installing Apache
Securing Apache (httpd) The main consideration is to secure the directory cgi-bin. The only persons that need access to this directory are Evergreen system administrators. This directory should be restricted by both IP (to those workstations designated as Evergeen Administration systems), and by username/password. - ADD CONTENT ON HOW TO RESTRICT APACHE BY IP AND USERNAME/PASSWORD + + ZZZ-REVIEW + ADD CONTENT ON HOW TO RESTRICT APACHE BY IP AND USERNAME/PASSWORD + + ADD CONTENT ON HOW TO RESTRICT APACHE BY IP AND USERNAME/PASSWORD A user could add new libraries, re-arrange consortia, or change user groups; or a staff member could access the directory, and change his associated security group to administrative level privileges.
- ADD MORE CONTENT FOR APACHE + + ZZZ-REVIEW + ADD MORE CONTENT FOR APACHE + + ADD MORE CONTENT FOR APACHE
@@ -2237,7 +2340,11 @@
memcached Servers - ADD CONTENT FOR MEMCACHED + + ZZZ-REVIEW + ADD CONTENT FOR MEMCACHED + + ADD CONTENT FOR MEMCACHED
Organization and Policy Editing @@ -2247,19 +2354,36 @@ Changing circulation rules for an existing library Adding a new staff position or user group - ADD CONTENT FOR ORGANIZATION AND POLICY EDITING + + ZZZ-REVIEW + ADD CONTENT FOR ORGANIZATION AND POLICY EDITING + + ADD CONTENT FOR ORGANIZATION AND POLICY EDITING
Installing the SIP Server - ADD CONTENT FOR INSTALLING THE SIP SERVER + + ZZZ-REVIEW + ADD CONTENT FOR INSTALLING THE SIP SERVER + + ADD CONTENT FOR INSTALLING THE SIP SERVER
Using nginx to serve static content - ADD CONTENT FOR USING NGINX TO SERVE STATIC CONTENT + + ZZZ-REVIEW + ADD CONTENT FOR USING NGINX TO SERVE STATIC CONTENT + + ADD CONTENT FOR USING NGINX TO SERVE STATIC CONTENT
(OPTIONAL) Configuration for Other Languages This section describes how translations such as Armenian (hy-AM), Canadian French (fr-CA) and others are loaded into the database to complete the translations (default English) available in the OPAC and Staff Client. - ADD SECTION ON LANGUAGE LOCALIZATION + + ZZZ-REVIEW + ADD SECTION ON LANGUAGE LOCALIZATION + + ADD SECTION ON LANGUAGE LOCALIZATION
+ -- 2.11.0