From cb0011e0f0477bd0fbe6245e40d511547ddd3065 Mon Sep 17 00:00:00 2001 From: Steve Sheppard Date: Tue, 14 Sep 2010 15:35:50 -0400 Subject: [PATCH] expand section "Installing Evergreen 1.4.x.x On Ubuntu or Debian"; --- 1.6/admin/ServersideInstallation.xml | 731 +++++++++++++++++++-------- 1 file changed, 522 insertions(+), 209 deletions(-) diff --git a/1.6/admin/ServersideInstallation.xml b/1.6/admin/ServersideInstallation.xml index 5b45423991..c3e001ab9c 100644 --- a/1.6/admin/ServersideInstallation.xml +++ b/1.6/admin/ServersideInstallation.xml @@ -53,7 +53,7 @@
Previous Software Releases Earlier releases of Evergreen are also available. Instructions for installing, configuring and testing earlier versions are found in . - The next most recent previous release of Evergreen is version 1.4.0.6. Instructions for installing, configuring and testing that version are found in . + The next most recent previous release of Evergreen is version 1.4.0.6. Instructions for installing, configuring and testing that version are found in . The accompanying previous release of OpenSRF is version 1.0.x. Instructions for installing, configuring and testing that version are found in .
@@ -246,13 +246,10 @@ As the root user, edit the file /etc/ejabberd/ejabberd.cfg and make the following changes: Change {hosts, ["localhost"]}. to {hosts, ["localhost", "private.localhost", "public.localhost"]}. - - Change {max_user_sessions, 10}. to {max_user_sessions, 10000}. - If you see something like this instead: {access, max_user_sessions, [{10, all}]}. then change it to {access, max_user_sessions, [{10000, all}]}. - + Change {max_user_sessions, 10}. to {max_user_sessions, 10000}. If you see something like this instead: {access, max_user_sessions, [{10, all}]}., then change it to {access, max_user_sessions, [{10000, all}]}. Change all three occurrences of max_stanza_size to 2000000. Change both occurrences of maxrate to 500000. - Comment out the line {mod_offline, []} by placing two comment signs %% in front. + Comment out the line {mod_offline, []} by placing two % comment signs in front.
@@ -276,14 +273,14 @@
Commands to register <systemitem class="username">router</systemitem> and <systemitem class="username">ejabberd</systemitem> users -# -$ ejabberdctl register router private.localhost -$ ejabberdctl register opensrf private.localhost -$ ejabberdctl register router public.localhost -$ ejabberdctl register opensrf public.localhost -]]> + # Syntax for registering a user with ejabberdctl: + # ejabberdctl register + # + $ ejabberdctl register router private.localhost + $ ejabberdctl register opensrf private.localhost + $ ejabberdctl register router public.localhost + $ ejabberdctl register opensrf public.localhost + ]]>
@@ -304,7 +301,7 @@ $ ejabberdctl register opensrf public.localhost Edit the file /openils/conf/opensrf_core.xml to change the ejabberd usernames and passwords as follows. - The following example uses common XPath syntax on the left-hand side to indicate the aproximage position needing changes within the XML file. + The following example uses common XPath syntax on the left-hand side to indicate the approximage position needing changes within the XML file.
@@ -329,7 +326,7 @@ $ ejabberdctl register opensrf public.localhost password = password for "private.localhost" router user
- You also need to specify the domains from which OpenSRF will accept and to which it will make connections. If you are installing OpenSRF on a single server and using the private.localhost / public.localhost domains, these will already be set to the correct values. Otherwise, search and replace to match your values. + You also need to specify the domains from which OpenSRF will accept and to which OpenSRF will make connections. If you are installing OpenSRF on a single server and using the private.localhost / public.localhost domains, these will already be set to the correct values. Otherwise, search and replace to match your values.
Modify the file <filename>opensrf.xml</filename> @@ -337,20 +334,20 @@ $ ejabberdctl register opensrf public.localhost
Example of the file <filename>opensrf.xml</filename> - - - /tmp/persist.db - - -]]> + + + + /tmp/persist.db + + + ]]>
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 file name!) 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. + As the root user, copy the short sample configuration file /openils/conf/srfsh.xml.example to the file .srfsh.xml (note the leading dot!) in the home directory of each user who will use srfsh. Finally, edit each file .srfsh.xml and make the following changes. When you finish, remember to change the owner of the file to match the owner of the home directory. Modify domain to be the router hostname (following our domain examples, private.localhost will give srfsh access to all OpenSRF services, while public.localhost will only allow access to those OpenSRF services that are publicly exposed). Modify username and password to match the opensrf Jabber user for the chosen domain @@ -360,23 +357,24 @@ $ ejabberdctl register opensrf public.localhost
Example of the file <filename>/openils/conf/srfsh.xml.example</filename> - - - -router -private.localhost -opensrf -privsrf -5222 -/tmp/srfsh.log - -4 -]]> + + + + + router + private.localhost + opensrf + privsrf + 5222 + /tmp/srfsh.log + + 4 + + ]]>
- Modify <envar>PATH</envar> Environment Variable for User <systemitem class="username">opensrf</systemitem> + Modify Environmental Variable PATH for <systemitem class="username">opensrf</systemitem> User As the opensrf user, modify the environmental variable PATH by adding a new file path to the opensrf user's shell configuration file .bashrc:
Commands to add path to <filename>.bashrc</filename> configuration file @@ -435,7 +433,12 @@ $ ejabberdctl register opensrf public.localhost srfsh#
- For other srfsh commands, type help at the prompt. + + ZZZ-REVIEW + VERIFY THIS TEST + + VERIFY THIS TEST + For other srfsh commands, type help in at the prompt.
Stopping OpenSRF @@ -454,7 +457,7 @@ $ ejabberdctl register opensrf public.localhost This section outlines the installation process for the latest stable version of Evergreen. In this section you will download, unpack, install, configure and test the Evergreen system, including the Evergreen server and the PostgreSQL database system. You will make several configuration changes and adjustments to the software, including updates to configure the system for your own locale, and some updates needed to work around a few known issues. - The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) architectures. There may be differences between the Desktop and Server editions of Ubuntu. These instructions assume the Server edition. + The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) architectures. There may be differences between the Desktop and Server editions of Ubuntu. These instructions assume the Server edition. In the following instructions, you are asked to perform certain steps as either the root user, the opensrf user, or the postgres user. Debian -- To become the root user, issue the command su - and enter the password of the root user. @@ -462,7 +465,7 @@ $ ejabberdctl register opensrf public.localhost 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. -
+
Installing OpenSRF Evergreen software is integrated with and depends on the Open Service Request Framework (OpenSRF) software system. For further information on installing, configuring and testing OpenSRF, see . Follow the steps outlined in that section and run the specified tests to ensure that OpenSRF is properly installed and configured. Do not continue with any further Evergreen installation steps until you have verified that OpenSRF has been successfully installed. @@ -702,7 +705,7 @@ $ ejabberdctl register opensrf public.localhost
Create and Configure PostgreSQL Database As the postgres user on your PostgreSQL server, create the Evergreen database. - In the commands below, remember to adjust the path of the contrib repository to match your PostgreSQL server layout. For example, if you built PostgreSQL from source the path would be /usr/local/share/contrib; if you installed the PostgreSQL 8.3 server packages on Ubuntu 8.04, the path would be /usr/share/postgresql/8.3/contrib/. + In the commands below, remember to adjust the path of the contrib repository to match your PostgreSQL server layout. For example, if you built PostgreSQL from source the path would be /usr/local/share/contrib; if you installed the PostgreSQL 8.3 server packages on Ubuntu 8.04, the path would be /usr/share/postgresql/8.3/contrib/. @@ -768,127 +771,125 @@ $ ejabberdctl register opensrf public.localhost
-
- Configure the Apache Server - As the root user, configure the Apache server and copy several new configuration files to the Apache server directories: -
- Commands to configure the Apache server - - # configure the Apache server - $ su - root - $ a2enmod ssl # enable mod_ssl - $ a2enmod rewrite # enable mod_rewrite - $ a2enmod expires # enable mod_expires - $ cd /home/opensrf/Evergreen-ILS-1.6.0.7 - - # copy files - $ cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/ - $ cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/ - $ cp Open-ILS/examples/apache/startup.pl /etc/apache2/ - -
-
-
- Create a Security Certificate (SSL Key) - Use the command openssl to create a new SSL key for your Apache server. For a public production server you should configure or purchase a signed SSL certificate, but for now you can just use a self-signed certificate and accept the warnings in the Staff Client and browser during testing and development: -
- Commands to create an SSL key - - $ mkdir /etc/apache2/ssl - $ cd /etc/apache2/ssl - $ openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key - -
- - - This is only a temporary measure to expedite testing. You must get a proper SSL certificate for a public production system. - - - - ZZZ-REVIEW - ADD INFO ON HOW TO GET A SIGNED SSL CERTIFICATE - - ADD INFO ON HOW TO GET A SIGNED SSL CERTIFICATE -
- Modify the Apache Configuration File - As the root user, edit the Apache configuration file /etc/apache2/sites-available/eg.conf and make the following changes: - - - Comment out the line Allow from 10.0.0.0/8, then uncomment the line Allow from all. + Modify the Apache Configuration + The Apache configuration must be updated in several ways to support Evergreen. +
+ Configure the Apache Server + Enable some built-in Apache modules with the utility a2enmod, and install some additional Apache configuration files. As the root user, enable some modules in the Apache server, then copy the new configuration files to the Apache server directories: +
+ Commands to configure the Apache server + + # configure the Apache server + $ su - root + $ a2enmod ssl # enable mod_ssl + $ a2enmod rewrite # enable mod_rewrite + $ a2enmod expires # enable mod_expires + $ cd /home/opensrf/Evergreen-ILS-1.6.0.7 + + # copy files + $ cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/ + $ cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/ + $ cp Open-ILS/examples/apache/startup.pl /etc/apache2/ + +
+
+
+ Create a Security Certificate (SSL Key) + Create a new SSL key for the Apache server with the command openssl. For a public production server you should configure or purchase a signed SSL certificate, but for now you can just use a self-signed certificate and accept the warnings in the Staff Client and browser during testing and development: +
+ Commands to create an SSL key + + $ mkdir /etc/apache2/ssl + $ cd /etc/apache2/ssl + $ openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key + +
+ - 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. + This is only a temporary measure to expedite testing. You must get a proper SSL certificate for a public production system. - + For further information on getting a proper SSL certificate, see . + +
+
+ Modify the Apache Configuration File + Several changes are needed in the new Apache configuration file /etc/apache2/sites-available/eg.conf. As the root user, edit the file and make the following changes: + + + Comment out the line Allow from 10.0.0.0/8, then uncomment the line Allow from all. - You must remove these changes after testing is completed. See for further details on removing this change after the Evergreen installation is complete. + 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. - - - - 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. - - 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. - - - For the Linux distributions Ubuntu Hardy or Debian Etch, as the root user, edit the Apache configuration file /etc/apache2/apache2.conf and change the user: www-data to the user: opensrf. - - - For the Linux distributions Ubuntu Karmic or Ubuntu Lucid or Debian Lenny, as the root user, edit the Apache configuration file /etc/apache2/envvars and change the phrase: export APACHE_RUN_USER=www-data to the phrase: export APACHE_RUN_USER=opensrf. - - - - - As the root user, edit the Apache configuration file /etc/apache2/apache2.conf and add the line KeepAliveTimeout 1, or modify an existing line if it already exists. - - -
-
- (OPTIONAL) Performance Modifications for Apache - Some further configuration changes to Apache may be necessary for busy systems. These changes increase the number of Apache server processes that are started to support additional browser connections. - - As the root user, edit the Apache configuration file /etc/apache2/apache2.conf, locate and modify the section related to prefork configuration to suit the load on your system. - - As the root user, edit the Apache configuration file /etc/apache2/apache2.conf and add the line MaxKeepAliveRequests 100, or modify an existing line if it already exists. + + + You must remove these changes after testing is completed. See for further details on removing this change after the Evergreen installation is complete. + + + + + Comment out the line Listen 443, since it conflicts with the same declaration in the configuration file: /etc/apache2/ports.conf. 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. + + + + For the Linux distributions Ubuntu Hardy or Debian Etch, as the root user, edit the Apache configuration file /etc/apache2/apache2.conf and change the phrase: User www-data to the phrase: User opensrf. + + + For the Linux distributions Ubuntu Karmic or Ubuntu Lucid or Debian Lenny, as the root user, edit the Apache configuration file /etc/apache2/envvars and change the phrase: export APACHE_RUN_USER=www-data to the phrase: export APACHE_RUN_USER=opensrf. + + + + + As the root user, edit the Apache configuration file /etc/apache2/apache2.conf and add the lines KeepAliveTimeout 1 and MaxKeepAliveRequests 100, or modify any existing lines. + + +
+
+ (OPTIONAL) Performance Modifications for Apache + Some further configuration changes to Apache may be necessary for busy systems. These changes increase the number of Apache server processes that are started to support additional browser connections. + + As the root user, edit the Apache configuration file /etc/apache2/apache2.conf, locate and modify the section related to prefork configuration to suit the load on your system.
(OPTIONAL) Example of updates to Apache configuration - StartServers 20 - MinSpareServers 5 - MaxSpareServers 15 - MaxClients 150 - MaxRequestsPerChild 10000 - -MaxKeepAliveRequests 100 -]]> + + StartServers 20 + MinSpareServers 5 + MaxSpareServers 15 + MaxClients 150 + MaxRequestsPerChild 10000 + + ]]>
- - -
-
- Enable the Evergreen Site - As the root user, execute the following Apache configuration commands to disable the default It Works web page and to enable the Evergreen web site: -
- Commands to enable the Evergreen Web Site - - $ su - root - - # disable the default site - $ a2dissite default + +
+
+ Enable the Evergreen Web Site + Finally, as the root user, execute the following Apache configuration commands to disable the default It Works web page and to enable the Evergreen web site: +
+ Commands to enable the Evergreen Web Site + + $ su - root - # enable the Evergreen web site - $ a2ensite eg.conf - -
+ # disable the default site + $ a2dissite default + + # enable the Evergreen web site + $ a2ensite eg.conf + + +
-
+
Modify the OpenSRF Configuration File As the opensrf user, edit the OpenSRF configuration file /openils/conf/opensrf_core.xml to update the Jabber usernames and passwords, and to specify the domain from which we will accept and to which we will make connections. If you are installing Evergreen on a single server and using the private.localhost / public.localhost domains, these will already be set to the correct values. Otherwise, search and replace to match your customized values. @@ -925,7 +926,7 @@ MaxKeepAliveRequests 100
-
+
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: @@ -938,23 +939,23 @@ MaxKeepAliveRequests 100
Example of user's file <filename>.srfsh.xml</filename> - - - -router -private.localhost -opensrf -evergreen -5222 -/tmp/srfsh.log - -4 - -]]> + + + + + router + private.localhost + opensrf + evergreen + 5222 + /tmp/srfsh.log + + 4 + + ]]>
-
+
Modify the OpenSRF Environment As the opensrf user, change the permissions of .cgi files in the directory /openils/var/cgi-bin to executable, then modify the shell configuration file ~/.bashrc for opensrf by adding a Perl environmental variable. Finally, execute the shell configuration file to load the new variables into your current environment. @@ -977,6 +978,74 @@ MaxKeepAliveRequests 100
+
+ (OPTIONAL) Enabling and Disabling Language Localizations + Current versions of Evergreen (after version 1.4) are bundled with support for a number of languages beyond American English (en-US). The translated interfaces are split between static files that are automatically installed with Evergreen, and dynamic labels that can be stored in the Evergreen database. Evergreen is installed with additional SQL files that contain translated dynamic labels for a number of languages, and to make the set of translated labels available in all interfaces. Only a few steps are required to enable or disable one or more languages. +
+ Enabling a Localization + To enable the translated labels for a given language to display in Evergreen, just populate the database with the translated labels and enable the localization. The following example illustrates how to enable Canadian French (fr-CA) support in the database. These same steps can be used with any of the languages bundled with Evergreen, or you can create and add your own localization. + + + The translated labels for each locale are stored in SQL files named "950.data.seed-values-xx-YY.sql" where "xx-YY" represents the locale code for the translation. Load the translated labels into the Evergreen database using the command psql, substituting your user, host and database connection information accordingly: +
+ Commands to load localizations into database + -h -d -f /path/to/Evergreen-source/Open-ILS/src/sql/Pg/950.data.seed-values-fr-CA.sql + ]]> +
+ + + Ensure the locale is enabled in the Evergreen database by using the utility psql to check for the existence of the locale in the table config.i18n_locale: +
+ Commands to check for localization + + SELECT code, marc_code, name, description + FROM config.i18n_locale + WHERE code = 'fr-CA'; + +
+ As shown in the following example, if one row of output is returned, then the locale is already enabled: +
+ Results of an installed localization + + code | marc_code | name | description + ------+-----------+-----------------+----------------- + fr-CA | fre | French (Canada) | Canadian French + (1 row) + +
+ If zero rows of output are returned, then the locale is not enabled: +
+ Results of no installed localizations + + code | marc_code | name | description + ------+-----------+------+------------- + (0 rows) + +
+ To enable a locale, use psql to insert a row into the table config.i18n_locale as follows: +
+ Commands to enable a locale in the database + + INSERT INTO config.i18n_locale (code, marc_code, name, description) + VALUES ('fr-CA', 'fre', 'French (Canada)', 'Canadian French'); + +
+ + +
+
+ Disabling a Localization + You might not want to offer all of the localizations that are preconfigured in Evergreen. If you choose to disable the dynamic labels for a locale, just delete those entries from the table config.i18n_locale using the psql utility: +
+ Commands to delete localization from table + + DELETE FROM config.i18n_locale + WHERE code = 'fr-CA'; + +
+
+
Starting Evergreen @@ -1026,10 +1095,10 @@ MaxKeepAliveRequests 100 ADD EXPLANATION FOR CONFIGURING "opensrf.xml" - When you attempt to start Evergreen, if you receive an error message similar to osrf_ctl.sh: command not found, then your environment variable PATH does not include the directory /openils/bin. As the opensrf user, edit the configuration file /home/opensrf/.bashrc and add the following line: export PATH=$PATH:/openils/bin + If you receive an error message similar to osrf_ctl.sh: command not found, then your environment variable PATH does not include the directory /openils/bin. As the opensrf user, edit the configuration file /home/opensrf/.bashrc and add the following line: export PATH=$PATH:/openils/bin - When you attempt to start Evergreen, if you receive an error message similar to Can't locate OpenSRF/System.pm in @INC ... BEGIN failed--compilation aborted, then your environment variable PERL5LIB does not include the directory /openils/lib/perl5. As the opensrf user, edit the configuration file /home/opensrf/.bashrc and add the following line: export PERL5LIB=$PERL5LIB:/openils/lib/perl5 + If you receive an error message similar to Can't locate OpenSRF/System.pm in @INC ... BEGIN failed--compilation aborted, then your environment variable PERL5LIB does not include the directory /openils/lib/perl5. As the opensrf user, edit the configuration file /home/opensrf/.bashrc and add the following line: export PERL5LIB=$PERL5LIB:/openils/lib/perl5 @@ -1268,6 +1337,7 @@ MaxKeepAliveRequests 100
Post-Installation Chores + There are a few additional steps to complete after Evergreen has been successfully installed and tested.
Remove temporary changes from Apache configuration file As the root user, edit the Apache configuration file /etc/apache2/sites-available/eg.conf again and make the following change: @@ -1275,17 +1345,12 @@ MaxKeepAliveRequests 100
Configure a permanent SSL key - In a previous step, we used the command openssl to temporarily create a new SSL key for the Apache server. For a public production server you should configure or purchase a signed SSL certificate + In a previous step, we used the command openssl to temporarily create a new SSL key for the Apache server. For a public production server you should configure or purchase a signed SSL certificate. For further information on getting a proper SSL certificate, see . The temporary SSL key was only created to expedite testing. You must get a proper SSL certificate for a public production system. - - ZZZ-REVIEW - ADD EXPLANATION OF HOW TO GET PERMANENT SSL CERTIFICATE - - ADD EXPLANATION OF HOW TO GET PERMANENT SSL CERTIFICATE
Set Up Support For Reports @@ -1385,13 +1450,251 @@ MaxKeepAliveRequests 100 Installing Previous Versions of Evergreen Earlier releases of Evergreen are available. Instructions for installing, configuring and testing earlier versions are found below. 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 <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> - - 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 Evergreen 1.4.x.x On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> + This section outlines the installation process for the previous version 1.4.0.6 of Evergreen. + In this section you will download, unpack, install, configure and test the Evergreen system, including the Evergreen server and the PostgreSQL database system. You will make several configuration changes and adjustments to the software, including updates to configure the system for your own locale, and some updates needed to work around a few known issues. + + The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) architectures. There may be differences between the Desktop and Server editions of Ubuntu. These instructions assume the Server edition. + If you are starting with a clean install of Ubuntu or Debian, you are strongly recommended not to install the packaged PostgreSQL server. This can confuse port numbers and system configuration. Evergreen 1.4 requires PostgreSQL 8.2. + +
+ Installing OpenSRF + Evergreen software is integrated with and depends on the Open Service Request Framework (OpenSRF) software system. For further information on installing, configuring and testing OpenSRF, see . + Follow the steps outlined in that section and run the specified tests to ensure that OpenSRF is properly installed and configured. Do not continue with any further Evergreen installation steps until you have verified that OpenSRF has been successfully installed. +
+
+ Download and Unpack Evergreen Version 1.4.0.6 + As the opensrf user, download and extract the latest version of Evergreen. The latest version can be found here: +
+ Commands to download and unpack Evergreen + + $ su - opensrf + $ wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.4.0.6.tar.gz + $ tar zxf Evergreen-ILS-1.4.0.6.tar.gz + +
+ The new directory /home/opensrf/Evergreen-ILS-1.4.0.6 will be created. +
+
+ Install Prerequisites to Build Evergreen + In this section you will install and configure a set of prerequisites that will be used to build Evergreen. In a following step you will actually build the 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 Evergreen + + $ su - root + $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 + $ make -f Open-ILS/src/extras/Makefile.install [distribution] + ... + +
+ + Keywords Targets for <application>make</application> + + + + + + Keyword + Description + + + + + debian-lenny + for Debian Lenny (5.0) + + + debian-etch + for Debian Etch (4.0) + + + ubuntu-intrepid + for Ubuntu Intrepid (8.10) + + + ubuntu-hardy + for Ubuntu Hardy (8.04) + + + +
+
+
+ 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/eg.conf containing two new library paths, 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 + $ cat > /etc/ld.so.conf.d/eg.conf << ENDOFFILE + /usr/local/lib + /usr/local/lib/dbd + ENDOFFILE + $ ldconfig + +
+
+
+ Restart the PostgreSQL Server + If PostgreSQL is running on the same system as the rest of Evergreen, as the root user you must restart the PostgreSQL server 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. +
+ Commands to restart PostgreSQL server + + $ su - root + $ /etc/init.d/postgresql-8.2 restart + +
+
+
+ Configure Evergreen + As the opensrf user, return to the Evergreen build directory and use the configure utility to prepare for the next step of compiling and linking the software: +
+ Commands to configure Evergreen + + $ su - opensrf + $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 + $ ./configure --prefix=/openils --sysconfdir=/openils/conf + $ make + ... + +
+
+
+ Compile, Link and Install Evergreen + In this step you will actually compile, link and install Evergreen and the default Evergreen Staff Client. + As the root user, return to the Evergreen build directory and use the make utility as shown below. The Staff Client will also be automatically built, but you must remember to set the variable STAFF_CLIENT_BUILD_ID to match the version of the Staff Client you will use to connect to the Evergreen server. + For further information on manually building the Staff Client, see . +
+ Commands to build, link and install Evergreen + + $ su - root + $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 + $ make STAFF_CLIENT_BUILD_ID=rel_1_4_0_6 install + ... + + The above commands will create a new subdirectory /openils/var/web/xul/rel_1_4_0_6 containing the Staff Client. +
+
+
+ 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: +
+ Commands to copy OpenSRF configuration files + + $ su - root + $ cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml + $ cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml + $ chown -R opensrf:opensrf /openils/ + +
+
+
+ Create and Configure PostgreSQL Database + As the postgres user on your PostgreSQL server, create the Evergreen database. + In the commands below, remember to adjust the path of the contrib repository to match your PostgreSQL server layout. For example, if you built PostgreSQL from source the path would be /usr/local/share/contrib; if you installed the PostgreSQL 8.2 server packages on Ubuntu 8.04, the path would be /usr/share/postgresql/8.2/contrib/. + + + + Create and configure the database + + As the postgres user on the PostgreSQL system create the PostgreSQL database, then set some internal paths: +
+ Commands to create database and adjust the path + + # create the database + $ su - postgres + $ createdb -E UNICODE evergreen + $ createlang plperl evergreen + $ createlang plperlu evergreen + $ createlang plpgsql evergreen + + # adjust the paths + $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tablefunc.sql evergreen + $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tsearch2.sql evergreen + $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/pgxml.sql evergreen + +
+ Where PGSQL_VERSION is your installed PostgreSQL version (e.g. 8.2). + + + + Create new Evergreen superuser + + As the postgres user on the PostgreSQL system, create the new database evergreen user and assign a password: +
+ Commands to create the <systemitem class="username">evergreen</systemitem> user + + # create superuser 'evergreen' and set the password + $ su - postgres + $ createuser -P -s evergreen + Enter password for new role: MYNEWPASSWORD + Enter it again: MYNEWPASSWORD + +
+ Where MYNEWPASSWORD is the password chosen. + + +
+
+ Create Database Schema + As the root user, create the database schema and configure your system with the corresponding database authentication details for the evergreen database user that you created in the previous step. + Enter the following commands and replace HOSTNAME, PORT, PASSWORD and DATABASENAME with appropriate values. +
+ Commands to create Evergreen database schema + + $ su - root + $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 + $ perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \ + --service all --create-schema --create-bootstrap --create-offline \ + --hostname HOSTNAME --port PORT \ + --user evergreen --password PASSWORD --database DATABASENAME + +
+ Where, on most systems, HOSTNAME will be localhost, PORT will be 5432, and PASSWORD and DATABASENAME will be those assigned when PostgreSQL was installed in the previous step. + + + If you are entering the above command on a single line, do not include the \ (backslash) characters. If you are using the bash shell, these should only be used at the end of a line at a bash prompt to indicate that the command is continued on the next line. + + +
+
+ Modify the Apache Configuration + The Apache configuration must be updated. See for further information. +
+
+ Modify the OpenSRF Configuration File + The OpenSRF configuration must be modified. See for further information. +
+
+ Create Configuration Files for Users Needing <application>srfsh</application> + Special configuration files are needed for all users who need to use the application srfsh for testing. See for further information. +
+
+ Modify the OpenSRF Environment + Several simple changes to the OpenSRF environment are required. See for further information. +
+
+ (OPTIONAL) Enabling and Disabling Language Localizations + Before starting Evergreen, you can add language localization for a number of languages beyond American English (en-US). For further information on language localization, see . +
+
+ Starting Evergreen + Start Evergreen according to the instructions in . +
+
+ Testing the Installation + Simple tests can be used to verify that Evergreen server-side software has been installed and configured properly and is running as expected. See for further information on testing the latest version of Evergreen. Earlier versions can be tested similarly. +
+
+ Stopping Evergreen + Stop Evergreen according to the instructions in . +
+
+ Post-Installation Chores + A few additional steps must be performed after Evergreen has been successfully installed and tested. See for the list of final steps. +
Installing OpenSRF 1.0.x @@ -1571,31 +1874,31 @@ MaxKeepAliveRequests 100
Creating a new file - - - - CFBundleExecutable - xulrunner - CFBundleGetInfoString - OpenILS open_ils_staff_client rel_1_6_0_7 - CFBundleInfoDictionaryVersion - 6.0 - CFBundleName - Evergreen Staff Client - CFBundlePackageType - APPL - CFBundleShortVersionString - rel_1_6_0_7 - CFBundleVersion - rel_1_6_0_7.rel_1_6_0_7 - NSAppleScriptEnabled - - CFBundleTypeIconFile - Evergreen.icns - - -]]> + + + + + CFBundleExecutable + xulrunner + CFBundleGetInfoString + OpenILS open_ils_staff_client rel_1_6_0_7 + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + Evergreen Staff Client + CFBundlePackageType + APPL + CFBundleShortVersionString + rel_1_6_0_7 + CFBundleVersion + rel_1_6_0_7.rel_1_6_0_7 + NSAppleScriptEnabled + + CFBundleTypeIconFile + Evergreen.icns + + + ]]>
Download and install an appropriate Mac OS Xpackage of XULRunner from the Mozilla website (see above for recommendations). @@ -1679,7 +1982,7 @@ MaxKeepAliveRequests 100
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 Ubuntu derivatives). Prerequisites @@ -2420,5 +2723,15 @@ MaxKeepAliveRequests 100
+
+ 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 +
-- 2.43.2