From e5b3da38385053a41bea3bbeaf0e74bd0e3b760b Mon Sep 17 00:00:00 2001 From: Steve Sheppard Date: Tue, 16 Nov 2010 11:06:39 -0500 Subject: [PATCH] more updates to bring into line with a real installation attempt; --- 1.6/admin/serversideinstallation.xml | 259 ++++++++++++++++++++------- 1 file changed, 194 insertions(+), 65 deletions(-) diff --git a/1.6/admin/serversideinstallation.xml b/1.6/admin/serversideinstallation.xml index 18b0e319f2..8321bd4fca 100644 --- a/1.6/admin/serversideinstallation.xml +++ b/1.6/admin/serversideinstallation.xml @@ -167,7 +167,7 @@ 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 the following step you will actually build the OpenSRF software + used to build OpenSRF. In a following step you will actually build the OpenSRF software using the make utility. As the root user, enter the commands show below to build the prerequisites from the software distribution that you just downloaded @@ -221,6 +221,10 @@ centos for Centos + + rhel + for RHEL + gentoo for Gentoo @@ -468,8 +472,7 @@ ejabberdctl register opensrf public.localhost /config/opensrf/passwd password for - private.localhost - opensrf user + private.localhostopensrf user @@ -481,8 +484,7 @@ ejabberdctl register opensrf public.localhost /config/gateway/passwd password for - public.localhost - opensrf user + public.localhostopensrf user @@ -498,8 +500,7 @@ ejabberdctl register opensrf public.localhost first entry where transport/server == public.localhost: password password for - public.localhost - router user + public.localhostrouter user @@ -515,8 +516,7 @@ ejabberdctl register opensrf public.localhost second entry where transport/server == private.localhost: password password for - private.localhost - router user + private.localhostrouter user @@ -754,10 +754,12 @@ srfsh# As the root user, enter the commands show below to build the prerequisites from the software distribution that you just downloaded and unpacked. Remember to replace - [DISTRIBUTION] in the example with the keyword - corresponding to the name of the Linux - distribution listed in the distribution keywords table - . + [DISTRIBUTION] in the following example with the keyword + corresponding to the name of one of the Linux + distributions listed in the following distribution keywords table + . + For example, to install the prerequisites for Ubuntu version 9.10 (Karmic Koala) you would + enter this command: make -f Open-ILS/src/extras/Makefile.install ubuntu-karmic . cd /home/opensrf/Evergreen-ILS-1.6.1.2 make -f Open-ILS/src/extras/Makefile.install [DISTRIBUTION] @@ -776,23 +778,39 @@ srfsh# debian-etch - for Debian Etch (4.0) + for Debian "Etch" (4.0) debian-lenny - for Debian Lenny (5.0) + for Debian "Lenny" (5.0) ubuntu-hardy - for Ubuntu Hardy Heron (8.04) + for Ubuntu "Hardy Heron" (8.04) + + + ubuntu-intrepid + for Ubuntu "Intrepid Ibex" (8.10) ubuntu-karmic - for Ubuntu Karmic Koala (9.10) + for Ubuntu "Karmic Koala" (9.10) ubuntu-karmic - for Ubuntu Lucid Lynx (10.04) + for Ubuntu "Lucid Lynx" (10.04) + + + centos + for Centos + + + rhel + for RHEL + + + gentoo + for Gentoo @@ -865,7 +883,8 @@ srfsh# Update the System Dynamic Library Path You must update the system dynamic library path to force your system to recognize the newly installed libraries. As the root - user, create a file named /etc/ld.so.conf.d/eg.conf containing the new library paths: + user, create a file named /etc/ld.so.conf.d/eg.conf + containing these new library paths: /usr/local/lib /usr/local/lib/dbd @@ -901,32 +920,50 @@ srfsh# make - Compile, Link and Install EvergreenIn this step you will actually compile, link and install Evergreen and the default - Evergreen Staff Client.As the root - user, return to the Evergreen build directory and use the make utility - as shown below. The Staff Client will also be automatically built, but you must remember + + Compile, Link and Install Evergreen + In this step you will actually compile, link and install Evergreen and the + default Evergreen Staff Client. + As the root user, return to the + Evergreen build directory and use the make utility as shown below: + + cd /home/opensrf/Evergreen-ILS-1.6.1.2 + make STAFF_CLIENT_BUILD_ID=rel_1_6_1_2 install + + The Staff Client will also be automatically built, but you must remember to set the variable STAFF_CLIENT_BUILD_ID to match the version of the Staff - Client you will use to connect to the Evergreen server.For further information on manually building the Staff Client, see - .cd /home/opensrf/Evergreen-ILS-1.6.1.2make STAFF_CLIENT_BUILD_ID=rel_1_6_1_2 installThe above commands will create a new subdirectory + Client you will use to connect to the Evergreen server. For further information on manually + building the Staff Client, see + . + The above commands will create a new subdirectory /openils/var/web/xul/rel_1_6_1_2 - containing the Staff Client. To complete the Staff Client installation, + containing the Staff Client. + To complete the Staff Client installation, as the root user create a symbolic link named server in the head of the Staff Client directory /openils/var/web/xul that points to the subdirectory /server of the new Staff - Client build:cd /openils/var/web/xulln -sf rel_1_6_1_2/server server + Client build: + + cd /openils/var/web/xul + ln -sf rel_1_6_1_2/server server + + Copy the OpenSRF Configuration Files - As the root user, copy the - example OpenSRF configuration files into place. This replaces the configuration - files that you set up in a previous step when you installed and tested - OpenSRF. You should also create backup copies of the old files for - troubleshooting purposes. Finally, change the ownership on the installed files - to the opensrf user: + As the root user, execute the + following commands to copy the example OpenSRF configuration files into place + after first creating backup copies of the old files for troubleshooting purposes. + These files replace the configuration files that you set up in a previous step + when you installed and tested OpenSRF. Finally, change the ownership on + the installed files to the opensrf user: - cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml - cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml - cp /openils/conf/oils_web.xml.example /openils/conf/oils_web.xml + cd /openils/conf + cp opensrf.xml opensrf.xml.BAK + cp opensrf_core.xml opensrf_core.xml.BAK + cp opensrf.xml.example opensrf.xml + cp opensrf_core.xml.example opensrf_core.xml + cp oils_web.xml.example oils_web.xml chown -R opensrf:opensrf /openils/ @@ -952,14 +989,14 @@ srfsh# As the postgres user on the PostgreSQL system create the PostgreSQL database, then set some internal paths: - Create the database: - createdb -E UNICODE evergreen + createdb evergreen -E UTF8 -T template0 createlang plperl evergreen createlang plperlu evergreen createlang plpgsql evergreen - Adjust the paths as shown, where + Continue as user postgres + and execute the SQL scripts as shown below, adjusting the paths as needed, where [PGSQL_VERSION] is your installed PostgreSQL version (e.g. 8.3). @@ -976,8 +1013,8 @@ srfsh# assign a password: createuser -P -s evergreen - Enter password for new role: MYNEWPASSWORD - Enter it again: MYNEWPASSWORD + Enter password for new role: MYNEWPASSWORD + Enter it again: MYNEWPASSWORD @@ -1000,9 +1037,15 @@ srfsh# On most systems, HOSTNAME will be localhost, - PORT will be 5432, - and PASSWORD and DATABASENAME - will be evergreen. + PORT will be 5432. + Values for PASSWORD and DATABASENAME + will match the values you used in the previous step when you created the + database and and set a password for the + evergreen user. + Adjust the values to match your own systems. + As the command executes, you may see warnings similar to: + ERROR: schema SOMENAME does not exist (in fact, + you may see one warning per schema) but they can be safely ignored. If you are entering the above command on a single line, do not include the \ @@ -1036,11 +1079,13 @@ srfsh# a2enmod rewrite # enable mod_rewrite a2enmod expires # enable mod_expires + As the commands execute, you may see warnings similar to: + Module SOMEMODULE already enabled but you can safely ignore them. Copy Apache configuration files You must copy the Apache configuration - files from the Evergreen installation dierectory + files from the Evergreen installation directory to the Apache directory. As the root user, perform the following commands: @@ -1090,25 +1135,16 @@ srfsh# Comment out the line Allow from 10.0.0.0/8 and uncomment - the line Allow from - all. - This change allows access to your - configuration CGI scripts from - any workstation on - any - network. This is only a temporary change - to expedite testing and should be removed - after you have finished and successfully - tested the Evergreen installation. - - - You must remove these changes - after testing is completed. See - - for further details on removing this change - after the Evergreen installation is - complete. - + the line Allow from all. + This change allows access to your + configuration CGI scripts from any workstation on + any network. This is only a temporary change to + expedite testing and should be removed after you + have finished and successfully tested the Evergreen + installation. See + + for further details on removing this change after + the Evergreen installation is complete. @@ -1361,7 +1397,7 @@ srfsh# Perl , and C services: - $ osrf_ctl.sh -l -a start_all + osrf_ctl.sh -l -a start_all @@ -1499,6 +1535,99 @@ Updating fieldmapper +
+ Post-Installation Chores + There are several additional steps you may need to complete after Evergreen has been + successfully installed and tested. Some steps may not be needed (e.g., setting up support for + Reports). +
+ Remove temporary Apache configuration changes + You modified the Apache configuration file + /etc/apache2/sites-available/eg.conf in an earlier step as a + temporary measure to expedite testing (see + for further information). + Those changes must now be reversed in order to deny unwanted access to your CGI + scripts from users on other public networks. + + + This temporary network update was done to expedite + testing. You must correct + this for a public production system. + + + As the root user, edit the configuration + file again and comment out the line Allow from all and uncomment the + line Allow from 10.0.0.0/8, then change it to match your network + address scheme. +
+
+ Configure a permanent SSL key + In a previous step, you used the command openssl to temporarily + create a new SSL key for the Apache server. This self-signed certificate was adequate + during testing and development, but will continue to generate warnings in the Staff Client + and browser. For a public production server you should configure or purchase a signed SSL + certificate. + + + The temporary SSL key was only created to expedite + testing. You should install a proper SSL certificate for a public + production system. + + +
+
+ Set Up Support For Reports + Evergreen reports are extremely powerful but require some simple configuration. + This section describes starting and stopping the Reporter daemon processes. + + + Starting the Reporter Daemon + Once the open-ils.reporter + process is running and enabled on the gateway, you can start the + Reporter daemon. That process periodically checks for requests for new + or scheduled reports, then starts them as required. + As the opensrf user, + start the Reporter daemon using the following command: + + cd /home/opensrf/Evergreen-ILS-1.6.1.2/Open-ILS/src/reporter + ./clark-kent.pl --daemon + + You can control how the clark-kent.pl utility behaves + by specifying any of several command-line options: + + : number of seconds + to sleep between checks for new reports to run; defaults to + 10 + : where to place + the lockfile for the process; defaults to + /tmp/reporter-LOCK + : number of + Reporter daemon processes to run; defaults to + 1 + : OpenSRF + bootstrap configuration file; defaults to + /openils/conf/opensrf_core.xml + + + + Stopping the Reporter Daemon + To stop the Reporter daemon, you must kill the process and remove + the lockfile. The daemon may have just a single associated process or + there may be several processes if the daemon was started with the optional + --concurrency switch. It will also have a lockfile + in the default location. + As the opensrf user, + execute the following shell commands: + + # find and kill the process ID number(s) + kill `ps wax | grep "Clark Kent" | grep -v grep | cut -b1-6` + # remove the lock file + rm /tmp/reporter-LOCK + + + +
+
Installing In Virtualized <systemitem class="osname">Linux</systemitem> Environments This section describes the installation of Evergreen software in so-called "virtualized" -- 2.43.2