From d7545acfb3e35c75cd8d52bf8ca16ca95df72832 Mon Sep 17 00:00:00 2001 From: Dan Scott Date: Sat, 11 Sep 2010 02:12:51 -0400 Subject: [PATCH] Move to more semantic markup --- 1.6/admin/ServersideInstallation.xml | 308 +++++++++++++-------------- 1 file changed, 153 insertions(+), 155 deletions(-) diff --git a/1.6/admin/ServersideInstallation.xml b/1.6/admin/ServersideInstallation.xml index 04ef2740bf..4381c8fbde 100644 --- a/1.6/admin/ServersideInstallation.xml +++ b/1.6/admin/ServersideInstallation.xml @@ -72,17 +72,17 @@ This section describes the installation of the latest version of the Open Service Request Framework (OpenSRF), a major component of the Evergreen server-side software, on Ubuntu or Debian systems. Evergreen software is integrated with and depends on the OpenSRF software system. Follow the steps outlined here and run the specified tests to ensure that OpenSRF is properly installed and configured. Do not continue with any further Evergreen installation steps until you have verified that OpenSRF has been successfully installed. - The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) platforms. OpenSRF 1.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. + The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) platforms. OpenSRF 1.2.2 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 the root user. - To switch from the root user to a different user, issue the command "su - USERNAME". For example, to switch from the root user to the opensrf user, issue the command "su - opensrf". Once you have become a non-root user, to become the root user again, simply issue the command "exit". + 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 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: + As the root user, add the opensrf user to the system. The default shell for the new user is automatically set to /bin/bash to inherit a reasonable environment:
Commands to add "opensrf" user @@ -98,7 +98,7 @@
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: + As the opensrf user user, download and extract the latest version of OpenSRF. The latest version can be found here:
Commands to download and unpack OpenSRF @@ -112,7 +112,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 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. + As the root user, enter the commands show below to build the prerequisites from the software distribution that you just downloaded and unpacked. Remember to replace [distribution] in the example with the keyword corresponding to the actual Linux distribution listed in the "Keywords" figure below.
Commands to install prerequisites for OpenSRF @@ -166,47 +166,47 @@
Configure OpenSRF - As the opensrf user, return to the OpenSRF build directory and use 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 wish to include support for Python and Java, respectively: + As the opensrf user user, return to the OpenSRF build directory and use the utility "configure" to prepare for the next step of compiling and linking the software. You can include the and configuration options if you wish to include support for Python and Java, respectively:
Commands to configure OpenSRF - - $ su - opensrf - $ cd /home/opensrf/OpenSRF-1.2.2 - $ ./configure --prefix=/openils --sysconfdir=/openils/conf - $ make - ... - + +$ su - opensrf +$ cd /home/opensrf/OpenSRF-1.2.2 +$ ./configure --prefix=/openils --sysconfdir=/openils/conf +$ make +... +
Compile, Link and Install OpenSRF - As the root user, return to the OpenSRF build directory and use the make command to compile, link and install OpenSRF: + As the root user, return to the OpenSRF build directory and use the make command to compile, link and install OpenSRF:
Commands to build, link and install OpenSRF - - $ su - opensrf - $ cd /home/opensrf/OpenSRF-1.2.2 - $ make install - ... - + +$ su - opensrf +$ cd /home/opensrf/OpenSRF-1.2.2 +$ make install +... +
Update the System Dynamic Library Path - As the root user, you must update the system dynamic library path to make your system recognize the newly installed libraries. Do this by creating 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: + 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 - $ echo "/openils/lib" > /etc/ld.so.conf.d/osrf.conf - $ ldconfig - + +$ su - root +$ echo "/openils/lib" > /etc/ld.so.conf.d/osrf.conf +$ ldconfig +
Define Public and Private OpenSRF Domains - Define your public and private OpenSRF domains. For security purposes, OpenSRF uses Jabber domains to separate services into public and private realms. Throughout these instructions, we will use the example domains public.localhost for the public domain and private.localhost for the private domain. On a single-server system, the easiest way to define public and private domains is to define separate 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: + 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:
Example public and private domains in /etc/hosts @@ -217,7 +217,7 @@
Change File Ownerships - As the root user, change the ownership of files installed in the directory /openils to the user "opensrf": + As the root user, change the ownership of files installed in the directory /openils to the user "opensrf":
Commands to change file ownerships @@ -227,7 +227,7 @@
Stop the "ejabberd" Service - As the root user, stop the "ejabberd" service: + As the root user, stop the "ejabberd" service:
Commands to stop the "ejabberd" service @@ -248,7 +248,7 @@
Edit the "ejabberd" configuration - As the root user, edit the file /etc/ejabberd/ejabberd.cfg and make the following changes: + 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}]}. @@ -259,7 +259,7 @@
Restart the "ejabberd" service - As the root user, restart the ejabberd service to test the configuration changes and to register your users: + As the root user, restart the ejabberd service to test the configuration changes and to register your users:
Commands to restart the "ejabberd" service @@ -274,7 +274,7 @@ 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, 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: + 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:
Commands to registe "router" and "ejabberd" users @@ -290,7 +290,7 @@
Create configuration files - As the opensrf user, use the example templates to create the configuration files /openils/conf/opensrf_core.xml and /openils/conf/opensrf.xml: + As the opensrf user user, use the example templates to create the configuration files /openils/conf/opensrf_core.xml and /openils/conf/opensrf.xml:
Commands to create configuration files @@ -334,65 +334,63 @@ 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 "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: + Modify the file <filename>opensrf.xml</filename> + 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 the file "opensrf.xml" - - <!-- Example of an app-specific setting override --> - <opensrf.persist> - <app_settings> - <dbfile>/tmp/persist.db</dbfile> - </app_settings> - </opensrf.persist> - + + + + /tmp/persist.db + +]]>
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. + 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 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 file 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 - Modify logfile to be the full path for a log file to which the user has write access - Modify loglevel as needed for testing + 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
Example of the file "/openils/conf/srfsh.xml.example" - - <?xml version="1.0"?> - <!-- This file follows the standard bootstrap config file layout --> - <!-- found in opensrf_core.xml --> - <srfsh> - <router_name>router</router_name> - <domain>private.localhost</domain> - <username>opensrf</username> - <passwd>privsrf</passwd> - <port>5222</port> - <logfile>/tmp/srfsh.log</logfile> - <!-- 0 None, 1 Error, 2 Warning, 3 Info, 4 debug, 5 Internal (Nasty) --> - <loglevel>4</loglevel> - </srfsh> - + + + + +router +private.localhost +opensrf +privsrf +5222 +/tmp/srfsh.log + +4 +]]>
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: + 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 ".bashrc" configuration file - - $ su - opensrf - $ echo "export PATH=/openils/bin:\$PATH" >> ~/.bashrc - + +$ su - opensrf +$ echo "export PATH=/openils/bin:\$PATH" >> ~/.bashrc +
Starting OpenSRF - As the root user, start the "ejabberd" and "memcached" services: + As the root user, start the ejabberd and memcached services:
Commands to start "ejabberd" and "memcached" services @@ -402,7 +400,7 @@
- Finally, as the opensrf user, start OpenSRF: + Finally, as the opensrf user user, start OpenSRF:
Commands to start OpenSRF @@ -424,7 +422,7 @@
Testing connections to OpenSRF - 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: + 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:
Commands to test OpenSRF with "srfsh" @@ -448,7 +446,7 @@
Stopping OpenSRF - As the opensrf user, stop OpenSRF: + As the opensrf user user, stop OpenSRF:
Commands to stop OpenSRF @@ -464,12 +462,12 @@ 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. - In the following instructions, you are asked to perform certain steps as either the root user, the opensrf user, or the postgres user. + In the following instructions, you are asked to perform certain steps as either the root user, the opensrf user 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. - 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 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 @@ -478,7 +476,7 @@
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: + As the opensrf user user, download and extract the latest version of Evergreen. The latest version can be found here:
Commands to download and unpack Evergreen @@ -492,7 +490,7 @@
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. + 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 @@ -563,7 +561,7 @@ (OPTIONAL) Install the PostgreSQL Server Since the PostgreSQL server is usually a standalone server in multi-server production systems, the prerequisite installer Makefile in the previous step does not automatically install PostgreSQL. If your PostgreSQL server is on a different system, just skip this step. For further information on installing PostgreSQL, see the section "Installing PostgreSQL". - If your PostgreSQL server will be on the same system as your Evergreen software, then as the root user install the required PostgreSQL server packages: + If your PostgreSQL server will be on the same system as your Evergreen software, then as the root user install the required PostgreSQL server packages:
Commands to install the PostgreSQL server @@ -597,7 +595,7 @@
(OPTIONAL) Install Perl Modules on PostgreSQL Server If PostgreSQL is running on the same system as your Evergreen software, then the Perl modules will automatically be available. Just skip this step. - Otherwise, if your PostgreSQL server is running on another system, then as the root user install the following Perl modules on that system: + Otherwise, if your PostgreSQL server is running on another system, then as the root user install the following Perl modules on that system:
Commands to install Perl modules @@ -625,7 +623,7 @@
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: + 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 @@ -640,7 +638,7 @@
(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. + 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. ZZZ-REVIEW ADD INFO ON OTHER VERSIONS OF POSTGRESQL @@ -657,7 +655,7 @@
Configure Evergreen - As the opensrf user, return to the Evergreen build directory and use the utility "configure" to prepare for the next step of compiling and linking the software: + As the opensrf user user, return to the Evergreen build directory and use the utility "configure" to prepare for the next step of compiling and linking the software:
Commands to configure Evergreen @@ -672,7 +670,7 @@
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 command 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. + As the root user, return to the Evergreen build directory and use the make command 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 the section "Building and Installing the Evergreen Staff Client".
Commands to build, link and install Evergreen @@ -684,7 +682,7 @@ The above commands will create a new subdirectory /openils/var/web/xul/rel_1_6_0_7 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 /server subdirectory of the new Staff Client build: + 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 /server subdirectory of the new Staff Client build:
Commands to create symbolic link @@ -696,7 +694,7 @@
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 user opensrf: + 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 user opensrf user:
Commands to copy OpenSRF configuration files @@ -755,7 +753,7 @@
Create Database Schema - As the root user, create the database schema and configure your system with the corresponding database authentication details for the database user evergreen that you created in the previous step. + As the root user, create the database schema and configure your system with the corresponding database authentication details for the database user evergreen 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 @@ -777,7 +775,7 @@
Configure the Apache Server - As the root user, configure the Apache server and copy several new configuration files to the Apache server directories: + 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 @@ -819,7 +817,7 @@
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: + 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. @@ -844,15 +842,15 @@ 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 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 user. - 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. + 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. + 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.
@@ -860,8 +858,8 @@ (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. + 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.
(OPTIONAL) Example of updates to Apache configuration <IfModule mpm_prefork_module> StartServers 20 @@ -876,7 +874,7 @@
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: + 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 @@ -892,7 +890,7 @@
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. + As the opensrf user 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. @@ -933,7 +931,7 @@ In this section you will set up a special configuration file for each user who will need to run the utility. Copy the short sample configuration file /openils/conf/srfsh.xml.example to the file .srfsh.xml (note the leading dot!) in the home directory of each user who will use srfsh. Finally, edit each users' .srfsh.xml file and make the following changes: Modify domain to be the router hostname (following our domain examples, private.localhost will give srfsh access to all OpenSRF services, while public.localhost will only allow access to those OpenSRF services that are publicly exposed). - Modify username and password to match the opensrf Jabber user for the chosen domain + Modify username and password to match the opensrf user 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 @@ -958,7 +956,7 @@
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. + As the opensrf user 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. In a multi-server environment, you must add any modifications to ~/.bashrc to the top of the file before the line [ -z "$PS1" ] && return. This will allow headless (scripted) logins to load the correct environment. @@ -983,7 +981,7 @@ Starting Evergreen - As the root user, start the "ejabberd" and "memcached" services (if they are not already running): + As the root user, start the "ejabberd" and "memcached" services (if they are not already running):
Commands to start "ejabberd" and "memcached" services @@ -994,7 +992,7 @@
- As the opensrf user, start Evergreen. + As the opensrf user 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:
Commands to start Evergreen @@ -1027,12 +1025,12 @@
- 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 - 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 + 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 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 user, edit the configuration file /home/opensrf/.bashrc and add the following line: export PERL5LIB=$PERL5LIB:/openils/lib/perl5 - As the opensrf user, generate the Web files needed by the Staff Client and catalogue, and calculate the proximity of locations in the Organizational Unit tree (which allows Holds to work properly). + As the opensrf user user, generate the Web files needed by the Staff Client and catalogue, and calculate the proximity of locations in the Organizational Unit tree (which allows Holds to work properly). You must do this the first time you start Evergreen, and after any changes you make to the library hierarchy in the configuration file config.cgi.
Commands to generate web files @@ -1052,7 +1050,7 @@
- As the root user, restart the Apache Web server: + As the root user, restart the Apache Web server:
Commands to restart Apache web server @@ -1069,7 +1067,7 @@ This section describes several simple tests you can perform to verify that the Evergreen server-side software has been installed and configured properly and is running as expected.
Testing Connections to Evergreen - Once you have installed and started Evergreen, test your connection to Evergreen. As the opensrf user start the 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: + Once you have installed and started Evergreen, test your connection to Evergreen. As the opensrf user 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:
Commands to test Evergreen with "srfsh" @@ -1102,29 +1100,29 @@
Other Connection Tests with "srfsh" - There is another srfsh command called math_bench that sends queries to the math servers. Note that opensrf.math and opensrf.dbmath must be running for this command to work: + There is another srfsh command called math_bench that sends queries to the math servers. Note that the opensrf.math and opensrf.dbmath must be running for this command to work: - srfsh# math_bench 10 - |.........|.........|.........|.........|.........|.........|.........|.........|.........|......... - ++++++++++++++++++++++++++++++++++++++++ - Average round trip time: 0.033425 - srfsh# +srfsh# math_bench 10 +|.........|.........|.........|.........|.........|.........|.........|.........|.........|......... +++++++++++++++++++++++++++++++++++++++++ +Average round trip time: 0.033425 +srfsh# - The first argument is how many sets of 4 queries (+ - * /) are sent to opensrf.math. When the response is successful, you will see the string of "+" symbols. If the system is not running correctly, you will either get an exception or no result at all. - For other srfsh commands, type 'help' in at the prompt. + The first argument is how many sets of 4 queries (+ - * /) are sent to opensrf.math. When the response is successful, you will see the string of "+" symbols. If the system is not running correctly, you will either get an exception or no result at all. + For other srfsh commands, type help in at the prompt. If this does not work, try the troubleshooting steps in the following section.
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: + 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: 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> + Executing the script <command>settings-tester.pl</command> @@ -1141,8 +1139,8 @@
Testing the Catalog - By default, the OPAC will live at the URL http://my.domain.com/opac/. - Navigate to this URL and the front page of the OPAC should load. There is a basic text entry field with some extra search options. If you have any problems loading this page, check the Apache error logs. If the page loads but does not function correctly, then check for possible javascript errors. We hightly reccommend testing with the Firefox browser because of the helpful javascript debugging tools. + By default, the OPAC will live at the URL http://my.domain.com/. + 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). ZZZ-REVIEW @@ -1157,15 +1155,15 @@
Commands to run the Staff Client - $ su - opensrf - $ xulrunner /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client/build/application.ini + $ su - opensrf + $ xulrunner /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/xul/staff_client/build/application.ini
Testing the Apache Web Server Once you have started Evergreen and confirmed that a basic login attempt works, you can test and start the Apache web server. - As the root user, execute the following commands. Note the use of restart to force the new Evergreen modules to be reloaded even if the Apache server is already running. Any problems found with your configuration files should be displayed: + As the root user, execute the following commands. Note the use of restart to force the new Evergreen modules to be reloaded even if the Apache server is already running. Any problems found with your configuration files should be displayed:
Commands to test the Apache Web Server @@ -1177,7 +1175,7 @@
Stopping Evergreen - As the opensrf user, stop all Evergreen services by using the following command: + As the opensrf user user, stop all Evergreen services by using the following command:
Commands to stop Evergreen @@ -1203,7 +1201,7 @@ Post-Installation Chores
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: + As the root user, edit the Apache configuration file /etc/apache2/sites-available/eg.conf again and make the following change: Uncomment the line Allow from 10.0.0.0/8, then comment out the line Allow from all. You modified this file in an earlier step as a temporary measure to expedite testing (see the section "Modify the Apache Configuration File" 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. You must secure this for a public production system.
@@ -1227,7 +1225,7 @@ 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 reports or scheduled reports and gets them running. - As the opensrf user, start the reporter daemon using the following command: + As the opensrf user user, start the reporter daemon using the following command:
Commands to start the Reporter daemon @@ -1249,7 +1247,7 @@ To stop the Reporter daemon, you must kill the process and remove the lockfile. The daemon may have just a single associated process, with a lockfile in the default location. - It is possible that several processes are running; see the optional commands in the previous section. As the opensrf user, perform the following commands to stop the Reporter daemon: + It is possible that several processes are running; see the optional commands in the previous section. As the opensrf user user, perform the following commands to stop the Reporter daemon:
@@ -1563,7 +1561,7 @@ Quick Upgrade of the Staff Client A Linux Staff Client is automatically built on the server as part of the normal make install process for Evergreen server-side software. To upgrade the Staff Client on a remote workstation with a new version, just copy the directory tree containing the Staff Client from the server to the remote workstation. The following example assumes you already have an "opensrf" user account on both the server and the remote workstation. Remember to replace "user", "client.linux.machine" and "eg-client-x.x.x.x" with the proper user name, client machine name, and version number in the following example. - As the opensrf user, change directory to the Staff Client source directory, then recursively copy the entire directory tree to the remote workstation: + As the opensrf user user, change directory to the Staff Client source directory, then recursively copy the entire directory tree to the remote workstation:
Copying the Staff Client to a remote workstation @@ -1572,7 +1570,7 @@ $ scp -r build user@client.linux.machine:~/eg-client-x.x.x.x/
- To test the newly copied Staff Client, as the opensrf user log into the remote workstation and execute it as shown: + To test the newly copied Staff Client, as the opensrf user user log into the remote workstation and execute it as shown:
Testing the copied Staff Client @@ -1602,7 +1600,7 @@ Prerequisites - Both "subversion" and "xulrunner" are required to build the Staff Client. As the root user, use "apt-get" to install packages for "subversion" and "xulrunner". You can also use "synaptic", the graphical user interface for "apt-get". For "subversion", select the latest version; for "xulrunner", select version 1.8.1.4-2ubuntu5. + Both "subversion" and "xulrunner" are required to build the Staff Client. As the root user, use "apt-get" to install packages for "subversion" and "xulrunner". You can also use "synaptic", the graphical user interface for "apt-get". For "subversion", select the latest version; for "xulrunner", select version 1.8.1.4-2ubuntu5.
Installing subversion and xulrunner @@ -1622,7 +1620,7 @@ Download the Code - As the opensrf user, open a terminal (command-line prompt) and navigate to the directory in which you wish to download the Staff Client. Use the following commands to download the proper version of the source code by tag name: + As the opensrf user user, open a terminal (command-line prompt) and navigate to the directory in which you wish to download the Staff Client. Use the following commands to download the proper version of the source code by tag name:
Downloading the source code @@ -1640,7 +1638,7 @@
Evergreen 1.2.x In the following example, navigate to the directory in which the source code was downloaded, then navigate to the proper subdirectory and run the "make" utility to actually build the Staff Client. Remember to check with your system administrator about which Staff Client BUILD_ID to use. The server checks the Staff Client BUILD_ID against itself to determine whether or not a connecting client is supported. For instance, for the PINES installation (version 1.2.1.4) the supported BUILD_ID is "rel_1_2_1_4". Modify the following commands accordingly. - As the opensrf user, run the following commands to build the Staff Client: + As the opensrf user user, run the following commands to build the Staff Client:
Finding the downloaded source code @@ -1687,7 +1685,7 @@ Run the Staff Client (from the command line) - As the opensrf user, navigate to the build/ subdirectory (not staff_client/) and run the following command: + As the opensrf user user, navigate to the build/ subdirectory (not staff_client/) and run the following command:
Running the Staff Client @@ -1735,7 +1733,7 @@
Using Wine to Install On Linux The Linux application Wine is another alternative for those who wish to install the packaged Windows versions rather than building the Staff Client manually. Wine is a Linux application that allows users to directly run Windows executables, and is a simple way for casual Linux users to use the Staff Client. More information about Wine can be found at http://www.winehq.org/site/docs/wineusr-guide/getting-wine. - As the root user, use "apt-get" to install the package for "wine". You can also use "synaptic", the graphical user interface. + As the root user, use "apt-get" to install the package for "wine". You can also use "synaptic", the graphical user interface. Install wine @@ -1748,7 +1746,7 @@ Download Windows installer for the Staff Client - As the opensrf user, run the following commands to download the Windows installer for the proper Staff Client from the open-ils.org website and place it in a temporary directory: + As the opensrf user user, run the following commands to download the Windows installer for the proper Staff Client from the open-ils.org website and place it in a temporary directory:
Downloading the Staff Client installer @@ -1760,7 +1758,7 @@ Run the downloaded Windows installer - As the opensrf user, navigate to the directory where you downloaded the Windows executable file, then execute it: + As the opensrf user user, navigate to the directory where you downloaded the Windows executable file, then execute it:
Using Wine to run the Windows installer @@ -1836,7 +1834,7 @@
The following commands will manually build the Staff Client using a different BUILD_ID. - As the opensrf user, change directory to the Staff Client source directory, then set the variable and build the Staff Client: + As the opensrf user user, change directory to the Staff Client source directory, then set the variable and build the Staff Client:
Commands to manually build the Staff Client @@ -1862,7 +1860,7 @@
The following commands will manually build the Staff Client using a different VERSION. If you plan to make extensions update automatically, the VERSION needs to conform to the format recommended in Toolkit Version Format and newer versions need to be "higher" than older versions. - As the opensrf user, change directory to the Staff Client source directory, then set the variable and build the Staff Client: + As the opensrf user user, change directory to the Staff Client source directory, then set the variable and build the Staff Client:
Commands to manually build the Staff Client @@ -1888,7 +1886,7 @@
The following commands will manually build the Staff Client using a different STAMP_ID. It is possible to have multiple versions of the Staff Client by specifying a different STAMP_ID for each, possibly for different uses or client-side customizations. - As the opensrf user, change directory to the Staff Client source directory, then set the variable and build the Staff Client: + As the opensrf user user, change directory to the Staff Client source directory, then set the variable and build the Staff Client:
Commands to manually build the Staff Client @@ -1967,7 +1965,7 @@ Developer Build You can create a so-called "developer build" of the Staff Client by substituting "devbuild" for "build" when running make. The build will contain an extra configuration file that enables some developer options. - As the opensrf user, run make from the Staff Client source directory: + As the opensrf user user, run make from the Staff Client source directory:
Commands to do a "developer build" @@ -1981,7 +1979,7 @@ Compressed Javascript You can execute the Google "Closure Compiler" utility to automatically review and compress Javascript code after the build process completes, by substituting "compress-javascript" for "build" when running make. For more information see Google "Closure Compiler". - As the opensrf user, run the following commands from the Staff Client source directory: + As the opensrf user user, run the following commands from the Staff Client source directory:
Commands to compress Javascript @@ -1992,7 +1990,7 @@
You can also combine Javascript review and compression, and also perform a "developer build". - As the opensrf user, run the following commands from the Staff Client source directory: + As the opensrf user user, run the following commands from the Staff Client source directory:
Commands to compress Javascript and do a "developer build" @@ -2018,7 +2016,7 @@
You can manually set AUTOUPDATE_HOST to set up automatic update checking. The following commands will manually build the Staff Client using a different AUTOUPDATE_HOST. - As the opensrf user, change directory to the Staff Client source directory, then set the variable and build the Staff Client: + As the opensrf user user, change directory to the Staff Client source directory, then set the variable and build the Staff Client:
Commands to manually specify AUTOUPDATE_HOST @@ -2035,7 +2033,7 @@
Installing and Activating a Manually Built Staff Client The Staff Client is automatically built, installed and activated as part of the normal make install process for Evergreen server-side software. However, if you manually build the Staff Client, then you need to take additional steps to properly install and activate it. You also have the option of installing the Staff Client on the same machine it was built on, or on a different machine. - Assuming you have already built the Staff Client, and that your installation is in the directory /openils/var/web/xul, as the opensrf user, change directory to the Staff Client source directory, then execute the following commands: + Assuming you have already built the Staff Client, and that your installation is in the directory /openils/var/web/xul, as the opensrf user user, change directory to the Staff Client source directory, then execute the following commands:
Commands to install the Staff Client on the same machine @@ -2053,7 +2051,7 @@ Packaging a Generic Client This build creates a Staff Client packaged as an XPI file to use with XULRunner. It requires that you already have the "zip" utility installed on your system. It will create the output file "evergreen_staff_client.xpi", suitable for use with the XULRunner parameter --install-app. - As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: + As the opensrf user user, change directory to the Staff Client source directory, then execute the following commands:
Commands to package a "generic" client @@ -2086,7 +2084,7 @@ - As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: + As the opensrf user user, change directory to the Staff Client source directory, then execute the following commands:
Commands to build a Windows client @@ -2100,7 +2098,7 @@ Packaging a Linux Client This build creates a Staff Client package for Linux as a "tar.bz2" file with XULRunner already bundled with it. It creates the output file "evergreen_staff_client.tar.bz2". - As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: + As the opensrf user user, change directory to the Staff Client source directory, then execute the following commands:
Commands to build a Linux client @@ -2114,7 +2112,7 @@ Packaging a Firefox Extension This build requires that you already have the "zip" utility installed on your system. It creates a Staff Client packaged as a Firefox extension and creates the output file "evergreen.xpi". - As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: + As the opensrf user user, change directory to the Staff Client source directory, then execute the following commands:
Commands to build a Firefox extension @@ -2151,7 +2149,7 @@ At configuration time for the normal build of Evergreen server-side software - This must be done when the Evergreen server-side software is first configured (see the section "Configure Evergreen" ). As the opensrf user, use the utility "configure" as shown: + This must be done when the Evergreen server-side software is first configured (see the section "Configure Evergreen" ). As the opensrf user user, use the utility "configure" as shown:
Commands to configure Evergreen @@ -2174,7 +2172,7 @@ Building Updates Similar to building clients, the targets "generic-updates", "win-updates", "linux-updates", and "extension-updates" can be used individually with make to build the update files for the Staff Client. To build all the targets at once, simply use the target "updates". A "full" update will be built for each specified target (or for all if you use the target "updates"). For all but extensions any previous "full" updates (archived by default in the directory /openils/var/updates/archives) will be used to make "partial" updates. Partial updates tend to be much smaller and will thus download more quickly, but if something goes wrong with a partial update the full update will be used as a fallback. Extensions do not currently support partial updates. - As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: + As the opensrf user user, change directory to the Staff Client source directory, then execute the following commands:
Commands for building updates @@ -2201,7 +2199,7 @@ Building updates with clients To save time and effort you can build updates and manual download clients at the same time by adding the string "-client" to each target name. For instance, you can specify "win-updates-client". You can also specify "updates-client" to build all the targets at once. This does not work for extension-updates. The clients will be installed alongside the updates and listed on the "manualupdate.html" page, rather than left in the Staff Client directory. - As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: + As the opensrf user user, change directory to the Staff Client source directory, then execute the following commands:
Commands for building updates @@ -2227,7 +2225,7 @@ This section reviews scripts associated with the update server, and requires some final adjustments to file permissions. The Apache example configuration creates an "updates" directory that, by default, points to the directory /openils/var/updates/pub. This directory contains one HTML file and several specially-named script files. The "updatedetails.html" file is the fallback web page for the update details. The "check" script is used for XULRunner updates. The "update.rdf" script is used for extension updates. The "manualupdate.html" script checks for clients to provide download links when automatic updates have failed and uses the download script to force a download of the generic client XPI (compared to Firefox trying to install it as an extension). - The following scripts should be marked as executable: check, download, manualupdate.html, update.rdf. As the root user, change directory to the updates directory, then execute the following commands: + The following scripts should be marked as executable: check, download, manualupdate.html, update.rdf. As the root user, change directory to the updates directory, then execute the following commands:
Changing file permissions of scripts @@ -2245,7 +2243,7 @@ Multiple workstation registrations for the same server can be accomplished with a single Staff Client install by using multiple profiles. When running XULRunner you can specify the option "-profilemanager" or "-P" (uppercase "P") to force the Profile Manager to start. Unchecking the "Don't ask at startup" option will make this the default. Once you have opened the Profile Manager you can create additional profiles, one for each workstation you wish to register. You may need to install SSL exceptions for each profile. When building targets "win-client", "win-updates-client", or "updates-client", you can specify "NSIS_EXTRAOPTS=-DPROFILES" to add an "Evergreen Staff Client Profile Manager" option to the start menu. - As the opensrf user, change directory to the Staff Client source directory, then execute the following commands: + As the opensrf user user, change directory to the Staff Client source directory, then execute the following commands:
Command to add start menu option -- 2.43.2