From 888da76ac57158319ea138dd8e1a7cb518c7d78a Mon Sep 17 00:00:00 2001 From: Steve Sheppard Date: Mon, 30 Aug 2010 22:34:35 -0400 Subject: [PATCH] minor reorg in Post-Installation section to relocate "Set Up Support for Reports"; --- 1.6/admin/ServersideInstallation.xml | 130 +++++++++++++-------------- 1 file changed, 64 insertions(+), 66 deletions(-) diff --git a/1.6/admin/ServersideInstallation.xml b/1.6/admin/ServersideInstallation.xml index 54e8fd7e0e..ea8202a455 100644 --- a/1.6/admin/ServersideInstallation.xml +++ b/1.6/admin/ServersideInstallation.xml @@ -11,12 +11,12 @@ 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". 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: - "OpenSRF" , - "PostgreSQL Database" , + "Installing OpenSRF On Ubuntu or Debian" , + "Installing PostgreSQL" , "Apache" and "memcached Servers" . - Installation of the Evergreen Staff Client software is handled in the section "Installing the Evergreen Staff Client" . + 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: @@ -486,7 +486,7 @@
- Start OpenSRF + Starting OpenSRF Before starting OpenSRF, ensure that the "ejabberd" and "memcached" daemons are running. As the root user, start the "ejabberd" and "memcached" services:
@@ -864,7 +864,7 @@
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: + 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 @@ -1249,20 +1249,65 @@
Post-Installation Chores - - - 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. - - - - This is only a temporary measure to expedite testing. You must get a proper SSL certificate for a public production system. See this section for further comments on setting up a properly signed SSL certificate: "Getting a Signed SSL Security Certificate" . - - - +
+ 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: + 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. +
+
+ 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 + + The temporary SSL key was only created to expedite testing. You must get a proper SSL certificate for a public production system. See this section for further comments on setting up a properly signed SSL certificate: "Getting a Signed SSL Security Certificate" . + +
+
+ Set Up Support For Reports + Evergreen reports are extremely powerful, but some configuration is required. See the section "Reports" for details. +
+ 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: +
+ Starting the Reporter Daemon + + $ su - opensrf + $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/src/reporter + $ ./clark-kent.pl --daemon + +
+ You can also specify other options with this utility: + + --sleep=interval : number of seconds to sleep between checks for new reports to run; defaults to 10 + --lockfile=filename : where to place the lockfile for the process; defaults to /tmp/reporter-LOCK + --concurrency=integer : number of reporter daemon processes to run; defaults to "1" + --boostrap=filename : OpenSRF bootstrap configuration file; defaults to /openils/conf/opensrf_core.xml + +
+
+ Stopping the Reporter Daemon + To stop the Reporter daemon, you must kill the process and remove the lockfile. The daemon may have just a single associated process, 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: + + +
+ Stopping the Reporter Daemon + + $ su - opensrf + # find and kill the process ID number(s) + $ kill `ps wax | grep "Clark Kent" | grep -v grep | cut -b1-6` + # remove the lock file + $ rm /tmp/reporter-LOCK + +
+
+
-
- Running the Staff Client on Linux +
+ Running the Evergreen Staff Client + [[ ADD CONTENT: LINUX VS WINDOWS STAFF CLIENT ]] Run the Evergreen Staff Client on a Linux system by using the application XULRunner (installed automatically and by default with Firefox version 3.0 and later on Ubuntu and Debian distributions). For example, if the source files for the Evergreen installation are in the directory /home/opensrf/Evergreen-ILS-1.6.0.7/, start the Staff Client as shown in the following command example:
@@ -1273,49 +1318,6 @@
-
- Setting Up Support For Reports - Evergreen reports are extremely powerful, but some configuration is required. See the section "Reports" for details. -
- 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: -
- Starting the Reporter Daemon - - $ su - opensrf - $ cd /home/opensrf/Evergreen-ILS-1.6.0.7/Open-ILS/src/reporter - $ ./clark-kent.pl --daemon - -
- You can also specify other options with this utility: - - --sleep=interval : number of seconds to sleep between checks for new reports to run; defaults to 10 - --lockfile=filename : where to place the lockfile for the process; defaults to /tmp/reporter-LOCK - --concurrency=integer : number of reporter daemon processes to run; defaults to "1" - --boostrap=filename : OpenSRF bootstrap configuration file; defaults to /openils/conf/opensrf_core.xml - -
-
- Stopping the Reporter Daemon - To stop the Reporter daemon, you must kill the process and remove the lockfile. The daemon may have just a single associated process, 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: - - -
- Stopping the Reporter Daemon - - $ su - opensrf - # find and kill the process ID number(s) - $ kill `ps wax | grep "Clark Kent" | grep -v grep | cut -b1-6` - # remove the lock file - $ rm /tmp/reporter-LOCK - -
-
-
Installing Evergreen On Other Linux Systems [[ ADD CONTENT FOR INSTALLING ON OTHER LINUX SYSTEMS ]] @@ -1350,12 +1352,8 @@ [[ ADD CONTENT FOR INSTALLING OPENSRF 1.0.x ]]
-
- Installing the Evergreen Staff Client - [[ ADD CONTENT FOR INSTALLING THE EVERGREEN STAFF CLIENT ]] -
- PostgreSQL + Installing PostgreSQL [[ ADD CONTENT FOR POSTGRESQL ]]
-- 2.43.2