From b01f55cfe1c54617692525e8be0aa2c96d0cc543 Mon Sep 17 00:00:00 2001 From: Steve Sheppard Date: Tue, 31 Aug 2010 11:20:56 -0400 Subject: [PATCH 1/1] review section "Installing OpenSRF", make simple tweaks; --- 1.6/admin/ServersideInstallation.xml | 229 ++++++++++++++------------- 1 file changed, 118 insertions(+), 111 deletions(-) diff --git a/1.6/admin/ServersideInstallation.xml b/1.6/admin/ServersideInstallation.xml index ea8202a455..1d3a9a0e40 100644 --- a/1.6/admin/ServersideInstallation.xml +++ b/1.6/admin/ServersideInstallation.xml @@ -8,18 +8,18 @@
Overview - Installing, configuring and testing the Evergreen server-side software is straightforward with the current stable software release. See the section "Installing Evergreen On Ubuntu or Debian" for instructions tailored to installing on some particular distributions of the Linux operating system. Earlier software distributions are described in the section "Installing Previous Versions of Evergreen" . - Current versions of the Evergreen server-side software run as native applications on any of several well-known Linux distributions (e.g., Ubuntu and Debian). It does not currently run as a native application on the 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 and run on other Linux systems via virtualized environments (using, for example, VirtualBox or VMware). More information on virtualized environments can be found in the section "Installing Evergreen in Virtualized Unix Environments". + Installing, configuring and testing the Evergreen server-side software is straightforward with the current stable software release. See the section "Installation of Server-Side Software" for instructions tailored to installing on some particular distributions of the Linux operating system. Earlier software distributions are described in the section "Installing Previous Versions of Evergreen" . + 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 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 section "Installing Evergreen in Virtualized Unix Environments". 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 the accompanying sections: - "Installing OpenSRF On Ubuntu or Debian" , "Installing PostgreSQL" , "Apache" and "memcached Servers" . - + + [[ FURTHER REFINEMENT NEEDED HERE ]] Finally, installation of the Evergreen Staff Client software is reviewed in the section "Running the Evergreen Staff Client" .
Evergreen Software Dependencies - The Evergreen server-side software is keyed to certain major software sub-components in the Evergreen environment. Successful installation of Evergreen software requires that software versions agree with those listed here: + 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 @@ -64,7 +64,7 @@ Current Stable Software Release The current stable release of Evergreen is version 1.6.0.7. Instructions for installing, configuring and testing that version on the Ubuntu or Debian Linux systems are found in the section "Installing Evergreen on Ubuntu or Debian" . - This release of Evergreen software is dependent on the Open Service Request Framework (OpenSRF) software framework. The current stable release of OpenSRF is version 1.2.2. Instructions for installing, configuring and testing that version are found in the section "Installing OpenSRF" . + This release of Evergreen software is dependent on the Open Service Request Framework (OpenSRF). The current stable release of OpenSRF is version 1.2.2. Instructions for installing, configuring and testing that version are found in the section "Installing OpenSRF On Ubuntu or Debian" .
Previous Software Releases @@ -143,8 +143,8 @@
Example System Architectures This sections describes examples of some working Evergreen system architectures, including both server-side software and Staff Client software. - A bare-minimum system Evergreen system requires only a single Server and a single Staff Client, both residing on a single server machine. In fact, that is a reasonable architecture for simple experiments or as a proof of concept in a conference-room pilot. But typical real-world systems will probably consist of at least one or two Evergreen servers plus multiple Staff Clients. - Another simple system may require only that you install one or more instances of the Staff Client software. For instance, if your consortium already provides the Evergreen server software or if you are using the hosted version provided by Equinox, you do not need to install the Evergreen server-side software at all. + A bare-minimum system requires only a single Evergreen Server and a single Evergreen Staff Client, both residing on a single server machine. In fact, that is a reasonable architecture for simple experiments or as a proof of concept in a conference-room pilot. But typical real-world systems will probably consist of at least one or two Evergreen Servers plus multiple Staff Clients. + Another simple system may require only that you install one or more instances of the Staff Client software. For instance, if your consortium already provides the Evergreen server software or if you are using the hosted version provided by Equinox, you do not need to install the Evergreen server-side software at all; you need only the Staff Client.
PINES In order to provide load balancing and high-availability at the OPAC and Staff Client level, PINES has implemented a Linux Virtual Server environment with five independent mini-clusters. This allows live updates of the entire system with no perceived downtime or interruption in service. @@ -162,8 +162,8 @@
Installation of Server-Side Software - This section describes the installation of the major components of Evergreen server-side software, including the Open Service Request Framework (OpenSRF), and Evergreen itself. - As far as possible, perform the following steps in the exact order they are 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 the section on "Backing Up" for further information. + 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 the section on "Backing Up" 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 On Ubuntu or Debian @@ -173,29 +173,32 @@ The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) platforms. OpenSRF 1.2.0 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 your current 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 your current 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. + 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:
- Add the user "opensrf" + Adding the user "opensrf" $ su - opensrf $ useradd -m -s /bin/bash opensrf $ passwd opensrf + Enter new UNIX password: ****** + Retype new UNIX password: ****** + 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: - [[ VERIFY LOCATION OF LATEST VERSION OF OPENSRF ]]
- Commands to download/extract OpenSRF + Commands to download and unpack OpenSRF $ su - opensrf $ wget http://evergreen-ils.org/downloads/OpenSRF-1.2.2.tar.gz @@ -206,9 +209,16 @@
Install Prerequisites to Build OpenSRF - In this step you will install and configure a set of prerequisites 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 in Figure 1.5 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 here: - [[ ADD INFO FOR OTHER LINUX DISTRIBUTIONS ]] + 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 Figure 1.5. +
+ Commands to install prerequisites for OpenSRF + + $ su - root + $ cd /home/opensrf/OpenSRF-1.2.2 + $ make -f src/extras/Makefile.install [distribution] + +
Keywords used with "make" @@ -224,7 +234,7 @@ debian-lenny - for Debian Lenny (5.0), the most recent version + for Debian Lenny (5.0) @@ -235,14 +245,14 @@ - ubuntu-intrepid - for Ubuntu Jaunty (9.04) + ubuntu-karmic + for Ubuntu Karmic (9.10) ubuntu-intrepid - for Ubuntu Intrepid (8.10) + for Ubuntu Jaunty (9.04) or Intrepid (8.10) @@ -254,21 +264,14 @@
-
- Commands to install prerequisites for OpenSRF - - $ su - root - $ cd /home/opensrf/OpenSRF-1.2.2 - $ make -f src/extras/Makefile.install [distribution] - -
+ [[ ADD INFO FOR OTHER LINUX DISTRIBUTIONS ]] This will install a number of packages required by OpenSRF on your system, 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, configure OpenSRF by preparing a "make" file to be used in the next step to compile and link OpenSRF. You can include the --enable-python and --enable-java configure options if you want to include support for Python and Java, respectively: + As the opensrf user, return to your build directory and configure OpenSRF by using the utility "configure" to prepare for the next step of compiling and linking the software. You can include the --enable-python and --enable-java configuration options if you want to include support for Python and Java, respectively:
- Commands to prepare make file for OpenSRF + Commands to configure OpenSRF $ su - opensrf $ cd /home/opensrf/OpenSRF-1.2.2 @@ -278,10 +281,10 @@
- Compile and link OpenSRF - As the root user, return to your OpenSRF build directory and compile, link and install OpenSRF: + Compile, Link and Install OpenSRF + As the root user, return to your build directory and compile, link and install OpenSRF:
- Commands to build OpenSRF + Commands to build, link and install OpenSRF $ su - opensrf $ cd /home/opensrf/OpenSRF-1.2.2 @@ -290,37 +293,36 @@
- 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 a new file named /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 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 a new file named /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 - $ cat > /etc/ld.so.conf.d/eg.conf << ENDOFFILE - /usr/local/lib - /usr/local/lib/dbd - ENDOFFILE + $ 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 hostnames by adding entries to the file /etc/hosts. Here are the entries to add to a stock file /etc/hosts for our example domains: + 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 hostnames 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:
- Entries to add to /etc/hosts + Adding public and private domains to /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 the installed files to the opensrf user: + As the root user, change the ownership of files installed in the directory /openils to the user "opensrf":
- Entries to add to /etc/hosts + Changing file ownerships in /openils - chown -R opensrf:opensrf /openils + $ chown -R opensrf:opensrf /openils
@@ -328,14 +330,14 @@ Stop the "ejabberd" service As the root user, stop the "ejabberd" service:
- Stop the "ejabberd" service + Stopping the "ejabberd" 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 ejabberd configuration file to hardcode a domain:
- Stop the "ejabberd" service + Recovering from "ejabberd" error $ su - root $ epmd -kill @@ -347,13 +349,13 @@
Edit the "ejabberd" configuration - As the root user, edit /etc/ejabberd/ejabberd.cfg : + 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 {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 all three occurrences of max_stanza_size to 2000000. Change both occurrences of maxrate to 500000. - Comment out the {mod_offline line by placing two % signs in front. + Comment out the line {mod_offline, []} by placing two % comment signs in front.
@@ -373,9 +375,9 @@ a "router" user, to whom all requests to connect to an OpenSRF service will be routed; this "ejabberd" user must be named "router" an "opensrf" user, which clients use to connect to OpenSRF services; this user can be named anything you like, but we will use "opensrf" in our examples - As the root user, register your ejabber users router and opensrf for the OpenSRF router service on each domain. The users should have different passwords on each domain. These users will correspond to your configuration in opensrf_core.xml: + As the root user, use the utility "ejabberdctl" to register your ejabber users router and opensrf for the OpenSRF router service on each domain. The users should have different passwords on each domain. These users will correspond to those configured in the file /openils/conf/opensrf_core.xml:
- Register "router" and "ejabberd" users + Registering "router" and "ejabberd" users # Syntax for registering a user with ejabberdctl: # ejabberdctl register <user> <domain> <password> @@ -389,13 +391,14 @@
Create configuration files - As the opensrf user, create the configuration files /openils/conf/opensrf_core.xml and /openils/conf/opensrf.xml from the example templates: + As the opensrf user, use the example templates to create the configuration files /openils/conf/opensrf_core.xml and /openils/conf/opensrf.xml:
- Commands to copy OpenSRF configuration files + Creating 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 + $ cd /openils/conf + $ cp opensrf.xml.example opensrf.xml + $ cp opensrf_core.xml.example opensrf_core.xml
@@ -410,13 +413,13 @@
Updates needed to the file "/openils/conf/opensrf_core.xml" - /config/opensrf/username = opensrf + /config/opensrf/username = opensrf - /config/opensrf/passwd = password for "private.localhost" opensrf user + /config/opensrf/passwd = password for "private.localhost" opensrf user - /config/gateway/username = opensrf + /config/gateway/username = opensrf - /config/gateway/passwd = password for "public.localhost" opensrf user + /config/gateway/passwd = password for "public.localhost" opensrf user # first entry, where "transport/server" == "public.localhost" : /config/routers/router/transport @@ -429,13 +432,14 @@ password = password for "private.localhost" router user
- You also need to specify the domains from which Evergreen will accept and to which Evergreen 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.
- Edit opensrf.xml - Edit the file /openils/conf/opensrf.xml to set the location of the persistent database in the <dbfile> element near the end of the file: + Modify the file "opensrf.xml" + Modify the file /openils/conf/opensrf.xml. + As the opensrf user, edit the file to set the location of the persistent database in the <dbfile> element near the end of the file:
- example of file "opensrf.xml" + Modify the file "opensrf.xml" <!-- Example of an app-specific setting override --> <opensrf.persist> @@ -447,10 +451,12 @@
- Copy srfsh.xml.example - In this step 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 file .srfsh.xml and make the following changes: + Create Configuration Files for Users Needing srfsh + In this section you will set up a special configuration file for each user who will need to run the srfsh (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 the section "Testing the Installation" 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 @@ -478,28 +484,28 @@ Modify environmental variable PATH for "opensrf" 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:
- Add path to ".bashrc" configuration file + Adding path to ".bashrc" configuration file + $ su - opensrf $ echo "export PATH=/openils/bin:\$PATH" >> ~/.bashrc - $ exit
Starting OpenSRF - Before starting OpenSRF, ensure that the "ejabberd" and "memcached" daemons are running. As the root user, start the "ejabberd" and "memcached" services:
- Start some services + Starting some services $ su - root $ /etc/init.d/ejabberd start $ /etc/init.d/memcached start
- As the root user, OpenSRF: + + Finally, as the opensrf user, start OpenSRF:
- Start OpenSRF + Starting OpenSRF $ su - opensrf @@ -513,15 +519,15 @@
- You can also start Evergreen without the -l flag, but 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. + You can also start Evergreen without the -l flag, but 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.
Testing connections to OpenSRF - As the root user, test your connection to OpenSRF by executing the utility srfsh 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 utility srfsh and trying to call the add method on the OpenSRF "math" service:
- Testing OpenSRF with the "math" method + Testing OpenSRF with "srfsh" $ su - opensrf $ /openils/bin/srfsh @@ -534,13 +540,14 @@ srfsh#
+ [[ VERIFY THIS TEST ]] For other srfsh commands, type 'help' in at the prompt.
Stopping OpenSRF - As the root user, stop OpenSRF: + As the opensrf user, stop OpenSRF:
- Testing OpenSRF with the "math" method + Stopping OpenSRF $ su - opensrf $ osrf_ctl.sh -l -a stop_all @@ -556,10 +563,10 @@ 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. - Ubuntu To become the root user, issue the command sudo su - and enter the password of your current 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 your current 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. + 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 @@ -569,9 +576,8 @@
Download and Unpack Latest Evergreen Version As the opensrf user, download and extract the latest version of Evergreen. The latest version can be found here: - [[ VERIFY LOCATION OF LATEST VERSION OF EVERGREEN ]]
- Commands to download/extract Evergreen + Commands to download and unpack Evergreen $ su - opensrf $ wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.6.0.7.tar.gz @@ -582,9 +588,16 @@
Install Prerequisites to Build Evergreen - In this step you will install and configure a set of prerequisites 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 in Figure 1.3 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 here: - [[ ADD INFO FOR OTHER LINUX DISTRIBUTIONS ]] + 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 Figure 1.26. +
+ Commands to install prerequisites for Evergreen + + $ su - root + $ cd /home/opensrf/Evergreen-ILS-1.6.0.7 + $ make -f Open-ILS/src/extras/Makefile.install [distribution] + +
Keywords used with "make" @@ -654,14 +667,7 @@
-
- Commands to install prerequisites for Evergreen - - $ su - root - $ cd /home/opensrf/Evergreen-ILS-1.6.0.7 - $ make -f Open-ILS/src/extras/Makefile.install [distribution] - -
+ [[ ADD INFO FOR OTHER LINUX DISTRIBUTIONS ]]
(OPTIONAL) Install the PostgreSQL Server @@ -710,8 +716,8 @@ [[ ADD INFO ON HOW TO VERIFY THAT THE PERL MODULES ARE INSTALLED ]]
- 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 a new file named /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 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 a new file named /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 @@ -737,10 +743,10 @@
- Configure and Compile Evergreen Sources - As the opensrf user, configure and compile the software from the prerequisites that were set up in previous steps: + Configure and Evergreen + As the opensrf user, return to your build directory and configure Evergreen by using the utility "configure" to prepare for the next step of compiling and linking the software:
- Commands to configure and compile Evergreen + Commands to configure Evergreen $ su - opensrf $ cd /home/opensrf/Evergreen-ILS-1.6.0.7 @@ -750,10 +756,11 @@
- Link and Install Evergreen - As the root user, link and install the compiled code. In the commands below, 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. Finally, create a symbolic link named server in /openils/var/web/xul to the /server subdirectory of your Staff Client build: + Compile, Link and Install Evergreen + As the root user, return to your build directory and compile, link and install Evergreen. + In the following commands, 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. Finally, create a symbolic link named server in the directory /openils/var/web/xul to the /server subdirectory of your Staff Client build:
- Commands to link and install Evergreen + Commands to build, link and install Evergreen $ su - root $ cd /home/opensrf/Evergreen-ILS-1.6.0.7 @@ -998,7 +1005,7 @@
Create Configuration Files for Users Needing srfsh 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 the section "Testing the Installation" for further information. - In this step 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 file .srfsh.xml and make the following changes: + 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 file .srfsh.xml 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 username and password to match the opensrf Jabber user for the chosen domain @@ -1061,7 +1068,7 @@ Testing Connections to Evergreen Once you have installed and started Evergreen, test your connection to Evergreen. As the opensrf user start the utility srfsh 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:
- Running the srfsh utility + Testing Evergreen with "srfsh" $ su - opensrf $ /openils/bin/srfsh @@ -1092,7 +1099,7 @@ 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: - [[ MAY NEED TO 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-test.pl</emphasis> @@ -1150,7 +1157,7 @@ As the root user, start the "ejabberd" and "memcached" services (if they aren't already running):
- Start some services + Starting some services $ su - root $ /etc/init.d/ejabberd start @@ -1162,7 +1169,7 @@ As the opensrf user, start Evergreen. Use the flag -l to force Evergreen to use localhost (your current system) as the hostname. Using the start_all option will start the OpenSRF router, Perl services, and C services:
- Start Evergreen + Starting Evergreen $ su - opensrf @@ -1231,7 +1238,7 @@ Stopping Evergreen As the opensrf user, stop all Evergreen services by using the following command:
- Stop all Evergreen services + Stopping all Evergreen services $ su - opensrf -- 2.43.2