From: Robert Soulliere Date: Tue, 9 Nov 2010 19:53:44 +0000 (-0500) Subject: delete files which have been moved or no longer used. X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=51e6ba20d0a1b67c8ba587e0cd104ac239c6f3d7;p=contrib%2FConifer.git delete files which have been moved or no longer used. --- diff --git a/1.6/admin/ServersideInstallation-olderEvergreenVersions.xml b/1.6/admin/ServersideInstallation-olderEvergreenVersions.xml deleted file mode 100644 index 2b436fd914..0000000000 --- a/1.6/admin/ServersideInstallation-olderEvergreenVersions.xml +++ /dev/null @@ -1,545 +0,0 @@ - - - - Installing Previous Versions of Evergreen - Earlier releases of Evergreen are available. Instructions for installing, configuring and testing earlier versions are found below. - The next most recent previous release of Evergreen is version 1.4.0.6. The accompanying previous release of OpenSRF - is version 1.0.7. -
- Installing Evergreen 1.4.0.6 On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> - This section outlines the installation process for the previous version 1.4.0.6 of Evergreen. - In this section you will download, unpack, install, configure and test the Evergreen system, including the Evergreen server and the PostgreSQL database system. You will make several configuration changes and adjustments to the software, including updates to configure the system for your own locale, and some updates needed to work around a few known issues. - - The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) architectures. There may be differences between the Desktop and Server editions of Ubuntu. These instructions assume the Server edition. - If you are starting with a clean install of Ubuntu or Debian, you are strongly recommended not to install the packaged PostgreSQL server. This can confuse port numbers and system configuration. Evergreen 1.4 requires PostgreSQL 8.2. - -
- Installing OpenSRF 1.0.7 - Evergreen software is integrated with and depends on the Open Service Request Framework (OpenSRF) software system. For further information on installing, configuring and testing OpenSRF, see . - Follow the steps outlined in that section and run the specified tests to ensure that OpenSRF is properly installed and configured. Do not continue with any further Evergreen installation steps until you have verified that OpenSRF has been successfully installed. -
-
- Download and Unpack Evergreen Version 1.4.0.6 - As the opensrf user, download and extract the latest version of Evergreen. The latest version can be found here: -
- Commands to download and unpack Evergreen - - $ su - opensrf - $ wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.4.0.6.tar.gz - $ tar zxf Evergreen-ILS-1.4.0.6.tar.gz - -
- The new directory /home/opensrf/Evergreen-ILS-1.4.0.6 will be created. -
-
- Install Prerequisites to Build Evergreen - In this section you will install and configure a set of prerequisites that will be used to build Evergreen. In a following step you will actually build the software using the make utility. - As the root user, enter the commands show below to build the prerequisites from the software distribution that you just downloaded and unpacked. Remember to replace [distribution] in the example with the keyword corresponding to the actual Linux distribution listed in the "Keywords" figure below. -
- Commands to install prerequisites for Evergreen - - $ su - root - $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 - $ make -f Open-ILS/src/extras/Makefile.install [distribution] - ... - -
- - Keywords Targets for <application>"make"</application> Command - - - - - - Keyword - Description - - - - - debian-lenny - for Debian Lenny (5.0) - - - debian-etch - for Debian Etch (4.0) - - - ubuntu-intrepid - for Ubuntu Intrepid (8.10) - - - ubuntu-hardy - for Ubuntu Hardy (8.04) - - - -
-
-
- Update the System Dynamic Library Path - As the root user, you must update the system dynamic library path to make your system recognize the newly installed libraries. Do this by creating the new file /etc/ld.so.conf.d/eg.conf containing two new library paths, then run the command ldconfig to automatically read the file and modify the system dynamic library path: -
- Commands to modify system dynamic library path - - $ su - root - $ cat > /etc/ld.so.conf.d/eg.conf << ENDOFFILE - /usr/local/lib - /usr/local/lib/dbd - ENDOFFILE - $ ldconfig - -
-
-
- Restart the PostgreSQL Server - If PostgreSQL is running on the same system as the rest of Evergreen, as the root user you must restart the PostgreSQL server to avoid a problem where the library plperl.so cannot be found. If your PostgreSQL server is running on another system, just skip this step. -
- Commands to restart PostgreSQL server - - $ su - root - $ /etc/init.d/postgresql-8.2 restart - -
-
-
- Configure Evergreen - As the opensrf user, return to the Evergreen build directory and use the configure utility to prepare for the next step of compiling and linking the software: -
- Commands to configure Evergreen - - $ su - opensrf - $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 - $ ./configure --prefix=/openils --sysconfdir=/openils/conf - $ make - ... - -
-
-
- Compile, Link and Install Evergreen - In this step you will actually compile, link and install Evergreen and the default Evergreen Staff Client. - As the root user, return to the Evergreen build directory and use the make utility as shown below. The Staff Client will also be automatically built, but you must remember to set the variable STAFF_CLIENT_BUILD_ID to match the version of the Staff Client you will use to connect to the Evergreen server. - For further information on manually building the Staff Client, see . -
- Commands to build, link and install Evergreen - - $ su - root - $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 - $ make STAFF_CLIENT_BUILD_ID=rel_1_4_0_6 install - ... - - The above commands will create a new subdirectory /openils/var/web/xul/rel_1_4_0_6 containing the Staff Client. -
-
-
- Copy the OpenSRF Configuration Files - As the root user, copy the example OpenSRF configuration files into place. This replaces the configuration files that you set up in a previous step when you installed and tested OpenSRF. You should also create backup copies of the old files for troubleshooting purposes. Finally, change the ownership on the installed files to the opensrf user: -
- Commands to copy OpenSRF configuration files - - $ su - root - $ cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml - $ cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml - $ chown -R opensrf:opensrf /openils/ - -
-
-
- Create and Configure PostgreSQL Database - As the postgres user on your PostgreSQL server, create the Evergreen database. - In the commands below, remember to adjust the path of the contrib repository to match your PostgreSQL server layout. For example, if you built PostgreSQL from source the path would be /usr/local/share/contrib; if you installed the PostgreSQL 8.2 server packages on Ubuntu 8.04, the path would be /usr/share/postgresql/8.2/contrib/. - - - - Create and configure the database - - As the postgres user on the PostgreSQL system create the PostgreSQL database, then set some internal paths: -
- Commands to create database and adjust the path - - # create the database - $ su - postgres - $ createdb -E UNICODE evergreen - $ createlang plperl evergreen - $ createlang plperlu evergreen - $ createlang plpgsql evergreen - - # adjust the paths - $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tablefunc.sql evergreen - $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tsearch2.sql evergreen - $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/pgxml.sql evergreen - -
- Where PGSQL_VERSION is your installed PostgreSQL version (e.g. 8.2). - - - - Create new Evergreen superuser - - As the postgres user on the PostgreSQL system, create the - new database evergreen user and assign a password: - -# create superuser 'evergreen' and set the password -su - postgres -createuser -P -s evergreen -Enter password for new role: MYNEWPASSWORD -Enter it again:MYNEWPASSWORD - - Where MYNEWPASSWORD is the password chosen. - - -
-
- Create Database Schema - As the root user, create the database schema and configure your system with the corresponding database authentication details for the evergreen database user that you created in the previous step. - Enter the following commands and replace HOSTNAME, PORT, PASSWORD and DATABASENAME with appropriate values. -
- Commands to create Evergreen database schema - - $ su - root - $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 - $ perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \ - --service all --create-schema --create-bootstrap --create-offline \ - --hostname HOSTNAME --port PORT \ - --user evergreen --password PASSWORD --database DATABASENAME - -
- Where, on most systems, HOSTNAME will be localhost, PORT will be 5432, and PASSWORD and DATABASENAME will be those assigned when PostgreSQL was installed in the previous step. - - - If you are entering the above command on a single line, do not include the \ (backslash) characters. If you are using the bash shell, these should only be used at the end of a line at a bash prompt to indicate that the command is continued on the next line. - - -
-
- Evergreen installation - (continued) - The remainder of the Evergreen installation procedure is identical to that for installing the latest version of Evergreen. Continue with the instructions found in . -
-
-
- Installing OpenSRF 1.0.7 On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> - This section describes the installation of the previous 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.0.7 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 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". - -
- 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: -
- Commands to add <systemitem class="username">opensrf</systemitem> user - - $ 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: -
- Commands to download and unpack OpenSRF - - $ su - opensrf - $ wget http://evergreen-ils.org/downloads/OpenSRF-1.0.7.tar.gz - $ tar zxf OpenSRF-1.0.7.tar.gz - -
- The new directory /home/opensrf/OpenSRF-1.0.7 will be created. -
-
- 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. -
- Commands to install prerequisites for OpenSRF - - $ su - root - $ cd /home/opensrf/OpenSRF-1.0.7 - $ make -f src/extras/Makefile.install [DISTRIBUTION] - ... - -
- - Keywords Targets for <application>"make"</application> Command - - - - - - Keyword - Description - - - - - debian-lenny - for Debian Lenny (5.0) - - - debian-etch - for Debian Etch (4.0) - - - ubuntu-intrepid - for Intrepid (8.10) - - - ubuntu-hardy - for Ubuntu Hardy (8.04) - - - -
- This will install a number of packages on the system that are required by OpenSRF, 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, return to the OpenSRF build directory and use the configure utility 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.0.7 - $ ./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 utility to compile, link and install OpenSRF: -
- Commands to build, link and install OpenSRF - - $ su - opensrf - $ cd /home/opensrf/OpenSRF-1.0.7 - $ 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 the new file /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 - -
-
-
- 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 host names 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 - - 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 files installed in the directory /openils to the opensrf user: -
- Commands to change file ownerships - - $ chown -R opensrf:opensrf /openils - -
-
-
- Stop the <systemitem class="service">ejabberd</systemitem> Service - As the root user, stop the ejabberd service: -
- Commands to stop the <systemitem class="service">ejabberd</systemitem> 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 configuration file /etc/ejabberd/ejabberd.cfg to hardcode a domain: -
- Commands to recover from <systemitem class="service">ejabberd</systemitem> errors - - $ su - root - $ epmd -kill - $ killall beam; killall beam.smp - $ rm /var/lib/ejabberd/* - $ echo 'ERLANG_NODE=ejabberd@localhost' >> /etc/default/ejabberd - -
-
-
- Edit the <systemitem class="service">ejabberd</systemitem> configuration - 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, 1000}. If you see something like this instead: {access, max_user_sessions, [{10, all}]}., then change it to {access, max_user_sessions, [{1000, all}]}. - Change all three occurrences of max_stanza_size to 2000000. - Change both occurrences of maxrate to 500000. - Comment out the line {mod_offline, []} by placing two % comment signs in front. - -
-
- OpenSRF installation - (continued) - - The remainder of the OpenSRF installation procedure is identical to that for installing the latest version of OpenSRF. Continue with the instructions found in . - -
-
- -
- Installing PostgreSQL - In production Evergreen systems, the PostgreSQL database server may reside on the same system on which Evergreen is installed or on another standalone system so, by default, PostgreSQL is not automatically installed along with Evergreen. This section details the steps needed to manually install PostgreSQL on a Ubuntu or Debian system. - If your PostgreSQL server will be on the same system as your Evergreen software, return to the previous section and follow those instructions. Otherwise, to manually install PostgreSQL on a system, continue with the instructions below. - - Some Linux distributions, such as Debian Etch (4.0), do not offer PostgreSQL version 8.2 as an installable package. Before you continue, examine the software dependencies listed in to ensure that your Linux distribution supports the required version of PostgreSQL. - - - - Install the application "stow" on your system if it is not already installed. Issue the following command as the root user: -
- Installing <application>"stow"</application> - - $ apt-get install stow - ... - -
- - - Download, compile, and install the latest release for PostgreSQL 8.2 (which was version 8.2.12 at the time of this writing). As the root user, follow these steps: -
- Installing PostgreSQL - - $ wget http://wwwmaster.postgresql.org/redir/198/h/source/v8.2.17/postgresql-8.2.17.tar.bz2 - $ tar xzf postgresql-8.2.17.tar.gz - $ cd postgresql-8.2.17 - $ ./configure --with-perl --enable-integer-datetimes --with-openssl --prefix=/usr/local/stow/pgsql - ... - $ make - ... - $ make install - ... - $ cd contrib - $ make - ... - $ make install - $ cd xml2 - $ make - ... - $ make install - $ cd /usr/local/stow - $ stow pgsql - -
- - - Create the new user postgres to run the PostgreSQL processes. As the root user, execute this command: -
- Adding <systemitem class="username">postgres</systemitem> - - $ adduser postgres - -
- - - Initialize the database directory and start up PostgreSQL. As the root user, follow these steps: -
- Adding <systemitem class="username">postgres</systemitem> - - $ mkdir -p /usr/local/pgsql/data - $ chown postgres /usr/local/pgsql/data - $ su - postgres - $ initdb -D /usr/local/pgsql/data -E UNICODE --locale=C - $ pg_ctl -D /usr/local/pgsql/data -l /home/postgres/logfile start - -
- - If an error occurs during the final step above, review the path of the home directory for the postgres user. It may be /var/lib/postresql instead of /home/postres. - - - - The values of several PostreSQL configuration parameters may be changed for enhanced performance. The following table lists the default values and some suggested updates for several useful parameters: - - Suggested configuration values - - - - - - - Parameter - Default - Suggested - - - - - default_statistics_target - 10 - 100 - - - work_mem - 4Mb - 128Mb - - - shared_buffers - 8Mb - 512Mb - - - effective_cache_size - 128Mb - 4Gb - - - -
- - ZZZ-REVIEW - ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS - - ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS - - -
-
- Installing Apache -
- Securing Apache (httpd) - The main consideration is to secure the directory cgi-bin. The only persons that need access to this directory are Evergreen system administrators. This directory should be restricted by both IP (to those workstations designated as Evergeen Administration systems), and by username/password. - - ZZZ-REVIEW - ADD CONTENT ON HOW TO RESTRICT APACHE BY IP AND USERNAME/PASSWORD - - ADD CONTENT ON HOW TO RESTRICT APACHE BY IP AND USERNAME/PASSWORD - A user could add new libraries, re-arrange consortia, or change user groups; or a staff member could access the directory, and change his associated security group to administrative level privileges. -
- - ZZZ-REVIEW - ADD MORE CONTENT FOR APACHE - - ADD MORE CONTENT FOR APACHE -
- diff --git a/1.6/admin/installation-previousversions.xml b/1.6/admin/installation-previousversions.xml deleted file mode 100644 index 1424d5cd49..0000000000 --- a/1.6/admin/installation-previousversions.xml +++ /dev/null @@ -1,545 +0,0 @@ - - - - Installing Previous Versions of Evergreen - Earlier releases of Evergreen are available. Instructions for installing, configuring and testing earlier versions are found below. - The next most recent previous release of Evergreen is version 1.4.0.6. The accompanying previous release of OpenSRF - is version 1.0.7. -
- Installing Evergreen 1.4.0.6 On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> - This section outlines the installation process for the previous version 1.4.0.6 of Evergreen. - In this section you will download, unpack, install, configure and test the Evergreen system, including the Evergreen server and the PostgreSQL database system. You will make several configuration changes and adjustments to the software, including updates to configure the system for your own locale, and some updates needed to work around a few known issues. - - The following steps have been tested on the x86 (32-bit) and x86-64 (64-bit) architectures. There may be differences between the Desktop and Server editions of Ubuntu. These instructions assume the Server edition. - If you are starting with a clean install of Ubuntu or Debian, you are strongly recommended not to install the packaged PostgreSQL server. This can confuse port numbers and system configuration. Evergreen 1.4 requires PostgreSQL 8.2. - -
- Installing OpenSRF 1.0.7 - Evergreen software is integrated with and depends on the Open Service Request Framework (OpenSRF) software system. For further information on installing, configuring and testing OpenSRF, see . - Follow the steps outlined in that section and run the specified tests to ensure that OpenSRF is properly installed and configured. Do not continue with any further Evergreen installation steps until you have verified that OpenSRF has been successfully installed. -
-
- Download and Unpack Evergreen Version 1.4.0.6 - As the opensrf user, download and extract the latest version of Evergreen. The latest version can be found here: -
- Commands to download and unpack Evergreen - - $ su - opensrf - $ wget http://evergreen-ils.org/downloads/Evergreen-ILS-1.4.0.6.tar.gz - $ tar zxf Evergreen-ILS-1.4.0.6.tar.gz - -
- The new directory /home/opensrf/Evergreen-ILS-1.4.0.6 will be created. -
-
- Install Prerequisites to Build Evergreen - In this section you will install and configure a set of prerequisites that will be used to build Evergreen. In a following step you will actually build the software using the make utility. - As the root user, enter the commands show below to build the prerequisites from the software distribution that you just downloaded and unpacked. Remember to replace [distribution] in the example with the keyword corresponding to the actual Linux distribution listed in the "Keywords" figure below. -
- Commands to install prerequisites for Evergreen - - $ su - root - $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 - $ make -f Open-ILS/src/extras/Makefile.install [distribution] - ... - -
- - Keywords Targets for <application>"make"</application> Command - - - - - - Keyword - Description - - - - - debian-lenny - for Debian Lenny (5.0) - - - debian-etch - for Debian Etch (4.0) - - - ubuntu-intrepid - for Ubuntu Intrepid (8.10) - - - ubuntu-hardy - for Ubuntu Hardy (8.04) - - - -
-
-
- Update the System Dynamic Library Path - As the root user, you must update the system dynamic library path to make your system recognize the newly installed libraries. Do this by creating the new file /etc/ld.so.conf.d/eg.conf containing two new library paths, then run the command ldconfig to automatically read the file and modify the system dynamic library path: -
- Commands to modify system dynamic library path - - $ su - root - $ cat > /etc/ld.so.conf.d/eg.conf << ENDOFFILE - /usr/local/lib - /usr/local/lib/dbd - ENDOFFILE - $ ldconfig - -
-
-
- Restart the PostgreSQL Server - If PostgreSQL is running on the same system as the rest of Evergreen, as the root user you must restart the PostgreSQL server to avoid a problem where the library plperl.so cannot be found. If your PostgreSQL server is running on another system, just skip this step. -
- Commands to restart PostgreSQL server - - $ su - root - $ /etc/init.d/postgresql-8.2 restart - -
-
-
- Configure Evergreen - As the opensrf user, return to the Evergreen build directory and use the configure utility to prepare for the next step of compiling and linking the software: -
- Commands to configure Evergreen - - $ su - opensrf - $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 - $ ./configure --prefix=/openils --sysconfdir=/openils/conf - $ make - ... - -
-
-
- Compile, Link and Install Evergreen - In this step you will actually compile, link and install Evergreen and the default Evergreen Staff Client. - As the root user, return to the Evergreen build directory and use the make utility as shown below. The Staff Client will also be automatically built, but you must remember to set the variable STAFF_CLIENT_BUILD_ID to match the version of the Staff Client you will use to connect to the Evergreen server. - For further information on manually building the Staff Client, see . -
- Commands to build, link and install Evergreen - - $ su - root - $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 - $ make STAFF_CLIENT_BUILD_ID=rel_1_4_0_6 install - ... - - The above commands will create a new subdirectory /openils/var/web/xul/rel_1_4_0_6 containing the Staff Client. -
-
-
- Copy the OpenSRF Configuration Files - As the root user, copy the example OpenSRF configuration files into place. This replaces the configuration files that you set up in a previous step when you installed and tested OpenSRF. You should also create backup copies of the old files for troubleshooting purposes. Finally, change the ownership on the installed files to the opensrf user: -
- Commands to copy OpenSRF configuration files - - $ su - root - $ cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml - $ cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml - $ chown -R opensrf:opensrf /openils/ - -
-
-
- Create and Configure PostgreSQL Database - As the postgres user on your PostgreSQL server, create the Evergreen database. - In the commands below, remember to adjust the path of the contrib repository to match your PostgreSQL server layout. For example, if you built PostgreSQL from source the path would be /usr/local/share/contrib; if you installed the PostgreSQL 8.2 server packages on Ubuntu 8.04, the path would be /usr/share/postgresql/8.2/contrib/. - - - - Create and configure the database - - As the postgres user on the PostgreSQL system create the PostgreSQL database, then set some internal paths: -
- Commands to create database and adjust the path - - # create the database - $ su - postgres - $ createdb -E UNICODE evergreen - $ createlang plperl evergreen - $ createlang plperlu evergreen - $ createlang plpgsql evergreen - - # adjust the paths - $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tablefunc.sql evergreen - $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/tsearch2.sql evergreen - $ psql -f /usr/share/postgresql/PGSQL_VERSION/contrib/pgxml.sql evergreen - -
- Where PGSQL_VERSION is your installed PostgreSQL version (e.g. 8.2). - - - - Create new Evergreen superuser - - As the postgres user on the PostgreSQL system, create the - new database evergreen user and assign a password: - -# create superuser 'evergreen' and set the password -su - postgres -createuser -P -s evergreen -Enter password for new role: MYNEWPASSWORD -Enter it again:MYNEWPASSWORD - - Where MYNEWPASSWORD is the password chosen. - - -
-
- Create Database Schema - As the root user, create the database schema and configure your system with the corresponding database authentication details for the evergreen database user that you created in the previous step. - Enter the following commands and replace HOSTNAME, PORT, PASSWORD and DATABASENAME with appropriate values. -
- Commands to create Evergreen database schema - - $ su - root - $ cd /home/opensrf/Evergreen-ILS-1.4.0.6 - $ perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \ - --service all --create-schema --create-bootstrap --create-offline \ - --hostname HOSTNAME --port PORT \ - --user evergreen --password PASSWORD --database DATABASENAME - -
- Where, on most systems, HOSTNAME will be localhost, PORT will be 5432, and PASSWORD and DATABASENAME will be those assigned when PostgreSQL was installed in the previous step. - - - If you are entering the above command on a single line, do not include the \ (backslash) characters. If you are using the bash shell, these should only be used at the end of a line at a bash prompt to indicate that the command is continued on the next line. - - -
-
- Evergreen installation - (continued) - The remainder of the Evergreen installation procedure is identical to that for installing the latest version of Evergreen. Continue with the instructions found in . -
-
-
- Installing OpenSRF 1.0.7 On <systemitem class="osname">Ubuntu</systemitem> or <systemitem class="osname">Debian</systemitem> - This section describes the installation of the previous 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.0.7 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 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". - -
- 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: -
- Commands to add <systemitem class="username">opensrf</systemitem> user - - $ 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: -
- Commands to download and unpack OpenSRF - - $ su - opensrf - $ wget http://evergreen-ils.org/downloads/OpenSRF-1.0.7.tar.gz - $ tar zxf OpenSRF-1.0.7.tar.gz - -
- The new directory /home/opensrf/OpenSRF-1.0.7 will be created. -
-
- 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. -
- Commands to install prerequisites for OpenSRF - - $ su - root - $ cd /home/opensrf/OpenSRF-1.0.7 - $ make -f src/extras/Makefile.install [DISTRIBUTION] - ... - -
- - Keywords Targets for <application>"make"</application> Command - - - - - - Keyword - Description - - - - - debian-lenny - for Debian Lenny (5.0) - - - debian-etch - for Debian Etch (4.0) - - - ubuntu-intrepid - for Intrepid (8.10) - - - ubuntu-hardy - for Ubuntu Hardy (8.04) - - - -
- This will install a number of packages on the system that are required by OpenSRF, 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, return to the OpenSRF build directory and use the configure utility 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.0.7 - $ ./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 utility to compile, link and install OpenSRF: -
- Commands to build, link and install OpenSRF - - $ su - opensrf - $ cd /home/opensrf/OpenSRF-1.0.7 - $ 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 the new file /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 - -
-
-
- 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 host names 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 - - 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 files installed in the directory /openils to the opensrf user: -
- Commands to change file ownerships - - $ chown -R opensrf:opensrf /openils - -
-
-
- Stop the <systemitem class="service">ejabberd</systemitem> Service - As the root user, stop the ejabberd service: -
- Commands to stop the <systemitem class="service">ejabberd</systemitem> 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 configuration file /etc/ejabberd/ejabberd.cfg to hardcode a domain: -
- Commands to recover from <systemitem class="service">ejabberd</systemitem> errors - - $ su - root - $ epmd -kill - $ killall beam; killall beam.smp - $ rm /var/lib/ejabberd/* - $ echo 'ERLANG_NODE=ejabberd@localhost' >> /etc/default/ejabberd - -
-
-
- Edit the <systemitem class="service">ejabberd</systemitem> configuration - 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, 1000}. If you see something like this instead: {access, max_user_sessions, [{10, all}]}., then change it to {access, max_user_sessions, [{1000, all}]}. - Change all three occurrences of max_stanza_size to 2000000. - Change both occurrences of maxrate to 500000. - Comment out the line {mod_offline, []} by placing two % comment signs in front. - -
-
- OpenSRF installation - (continued) - - The remainder of the OpenSRF installation procedure is identical to that for installing the latest version of OpenSRF. Continue with the instructions found in . - -
-
- -
- Installing PostgreSQL - In production Evergreen systems, the PostgreSQL database server may reside on the same system on which Evergreen is installed or on another standalone system so, by default, PostgreSQL is not automatically installed along with Evergreen. This section details the steps needed to manually install PostgreSQL on a Ubuntu or Debian system. - If your PostgreSQL server will be on the same system as your Evergreen software, return to the previous section and follow those instructions. Otherwise, to manually install PostgreSQL on a system, continue with the instructions below. - - Some Linux distributions, such as Debian Etch (4.0), do not offer PostgreSQL version 8.2 as an installable package. Before you continue, examine the software dependencies listed in to ensure that your Linux distribution supports the required version of PostgreSQL. - - - - Install the application "stow" on your system if it is not already installed. Issue the following command as the root user: -
- Installing <application>"stow"</application> - - $ apt-get install stow - ... - -
- - - Download, compile, and install the latest release for PostgreSQL 8.2 (which was version 8.2.12 at the time of this writing). As the root user, follow these steps: -
- Installing PostgreSQL - - $ wget http://wwwmaster.postgresql.org/redir/198/h/source/v8.2.17/postgresql-8.2.17.tar.bz2 - $ tar xzf postgresql-8.2.17.tar.gz - $ cd postgresql-8.2.17 - $ ./configure --with-perl --enable-integer-datetimes --with-openssl --prefix=/usr/local/stow/pgsql - ... - $ make - ... - $ make install - ... - $ cd contrib - $ make - ... - $ make install - $ cd xml2 - $ make - ... - $ make install - $ cd /usr/local/stow - $ stow pgsql - -
- - - Create the new user postgres to run the PostgreSQL processes. As the root user, execute this command: -
- Adding <systemitem class="username">postgres</systemitem> - - $ adduser postgres - -
- - - Initialize the database directory and start up PostgreSQL. As the root user, follow these steps: -
- Adding <systemitem class="username">postgres</systemitem> - - $ mkdir -p /usr/local/pgsql/data - $ chown postgres /usr/local/pgsql/data - $ su - postgres - $ initdb -D /usr/local/pgsql/data -E UNICODE --locale=C - $ pg_ctl -D /usr/local/pgsql/data -l /home/postgres/logfile start - -
- - If an error occurs during the final step above, review the path of the home directory for the postgres user. It may be /var/lib/postresql instead of /home/postres. - - - - The values of several PostreSQL configuration parameters may be changed for enhanced performance. The following table lists the default values and some suggested updates for several useful parameters: - - Suggested configuration values - - - - - - - Parameter - Default - Suggested - - - - - default_statistics_target - 10 - 100 - - - work_mem - 4Mb - 128Mb - - - shared_buffers - 8Mb - 512Mb - - - effective_cache_size - 128Mb - 4Gb - - - -
- - ZZZ-REVIEW - ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS - - ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS - - -
-
- Installing Apache -
- Securing Apache (httpd) - The main consideration is to secure the directory cgi-bin. The only persons that need access to this directory are Evergreen system administrators. This directory should be restricted by both IP (to those workstations designated as Evergeen Administration systems), and by username/password. - - ZZZ-REVIEW - ADD CONTENT ON HOW TO RESTRICT APACHE BY IP AND USERNAME/PASSWORD - - ADD CONTENT ON HOW TO RESTRICT APACHE BY IP AND USERNAME/PASSWORD - A user could add new libraries, re-arrange consortia, or change user groups; or a staff member could access the directory, and change his associated security group to administrative level privileges. -
- - ZZZ-REVIEW - ADD MORE CONTENT FOR APACHE - - ADD MORE CONTENT FOR APACHE -
- diff --git a/1.6/admin/installingpostgresql.xml b/1.6/admin/installingpostgresql.xml deleted file mode 100644 index 1b312a5e42..0000000000 --- a/1.6/admin/installingpostgresql.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - Installing PostgreSQL - In production Evergreen systems, the PostgreSQL database server may reside on the same system on which Evergreen is installed or on another standalone system so, by default, PostgreSQL is not automatically installed along with Evergreen. This section details the steps needed to manually install PostgreSQL on a Ubuntu or Debian system. - If your PostgreSQL server will be on the same system as your Evergreen software, return to the previous section and follow those instructions. Otherwise, to manually install PostgreSQL on a system, continue with the instructions below. - - Some Linux distributions, such as Debian Etch (4.0), do not offer PostgreSQL version 8.2 as an installable package. Before you continue, examine the software dependencies listed in to ensure that your Linux distribution supports the required version of PostgreSQL. - - - - Install the application "stow" on your system if it is not already installed. Issue the following command as the root user: -
- Installing <application>"stow"</application> - - $ apt-get install stow - ... - -
- - - Download, compile, and install the latest release for PostgreSQL 8.2 (which was version 8.2.12 at the time of this writing). As the root user, follow these steps: -
- Installing PostgreSQL - - $ wget http://wwwmaster.postgresql.org/redir/198/h/source/v8.2.17/postgresql-8.2.17.tar.bz2 - $ tar xzf postgresql-8.2.17.tar.gz - $ cd postgresql-8.2.17 - $ ./configure --with-perl --enable-integer-datetimes --with-openssl --prefix=/usr/local/stow/pgsql - ... - $ make - ... - $ make install - ... - $ cd contrib - $ make - ... - $ make install - $ cd xml2 - $ make - ... - $ make install - $ cd /usr/local/stow - $ stow pgsql - -
- - - Create the new user postgres to run the PostgreSQL processes. As the root user, execute this command: -
- Adding <systemitem class="username">postgres</systemitem> - - $ adduser postgres - -
- - - Initialize the database directory and start up PostgreSQL. As the root user, follow these steps: -
- Adding <systemitem class="username">postgres</systemitem> - - $ mkdir -p /usr/local/pgsql/data - $ chown postgres /usr/local/pgsql/data - $ su - postgres - $ initdb -D /usr/local/pgsql/data -E UNICODE --locale=C - $ pg_ctl -D /usr/local/pgsql/data -l /home/postgres/logfile start - -
- - If an error occurs during the final step above, review the path of the home directory for the postgres user. It may be /var/lib/postresql instead of /home/postres. - - - - The values of several PostreSQL configuration parameters may be changed for enhanced performance. The following table lists the default values and some suggested updates for several useful parameters: - - Suggested configuration values - - - - - - - Parameter - Default - Suggested - - - - - default_statistics_target - 10 - 100 - - - work_mem - 4Mb - 128Mb - - - shared_buffers - 8Mb - 512Mb - - - effective_cache_size - 128Mb - 4Gb - - - -
- - ZZZ-REVIEW - ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS - - ADD CONTENT ON HOW TO UPDATE POSTRESQL PARAMETERS - - - diff --git a/1.6/development/actiontriggers.xml b/1.6/development/actiontriggers.xml deleted file mode 100644 index 0d532a51b7..0000000000 --- a/1.6/development/actiontriggers.xml +++ /dev/null @@ -1,315 +0,0 @@ - - - - Action Triggers - - Action Triggers were introduced to Evergreen in 1.6. They allow administrators the ability to set up actions for specific events. They are useful for notification events such as - hold notifications. - - - To access the Action Triggers module, select - - Admin - Local Administration - Notifications / Action triggers - - - You must have Local Administrator permissions to access the Action Triggers module. - You will notice four tabs on this page: Event Definitions, Hooks, - Reactors and Validators. - -
- Event Definitions - Event Definitions is the main tab and contains the key fields when working with action triggers. These fields include: - - Action Trigger Event Definitions - - - - - - Field - Description - - - - - Owning library - The shortname of the library for which the action / trigger / hook is defined. - - - Name - The name of the trigger event, that links to a trigger event environment containing a set of fields - that will be returned to the Validators / Reactors for processing. - - - Hooks - The name of the trigger for the trigger event. The underlying action_trigger.hook table defines the Fieldmapper - class in the core_type column off of which the rest of the field definitions hang. - - - Enabled - Sets the given trigger as enabled or disabled. This must be set to enabled for the Action trigger to run. - - - Processing Delay - Defines how long after a given trigger / hook event has occurred before the associated action (Reactor) - will be taken. - - - Processing Delay Field - Defines the field associated with the event on which the processing delay is calculated. For example, the processing delay - context field on the hold.capture hook (which has a core_type of ahr) is capture_time. - - - Processing Group Context Field - Used to batch actions based on its associated group. - - - Validators - The subroutines receive the trigger environment as an argument (see the linked Name for - the environment definition) and returns either 1 if the validator is true or 0 - if the validator returns false. - - - Reactors - Links the action trigger to the Reactor. - - - Max Event Validity Delay - Define the threshold for how far back the action_trigger_runner.pl script should reach to generate - a batch of events. - - - -
- - - Creating New Action Triggers - - From the top menu, select - - Admin - Local Administration - Notifications / Action triggers - - - - Click on the New button. - Select an Owning Library. - Create a unique Name for your new action trigger. - Select the Hook. - Check the Enabled check box. - - Create a unique Name for your new action trigger. - Set the Processing Delay in the appropriate format. Eg. 7 days to run 7 days from the trigger event - or 00:01:00 to run 1 hour after the Processing Delay Context Field. - Set the Processing Delay Context Field and Processing Group Context Field. - Select the Validator, Reactor, Failure Cleanup and Success Cleanup. - - Set the Processing Delay Context Field and Processing Group Context Field. - Enter text in the Template text box if required. These are for email messages. Here is an sample - template for sending 90 day overdue notices: - - - - Once you are satisfied with your new event trigger , click the Save button located at the bottom of the - form - - A quick and easy way to create new action triggers is to clone an existing action trigger. - - Cloning Existing Action Triggers - - Check the check box next to the action trigger you wish to clone - - - Click the Clone Selected on the top left of the page. - - - An editing window with open. Notice that the fields will be populated with content from the cloned action trigger. Edit as necessary and - give the new action trigger a unique Name. - - - Click Save. - - - - Editing Action Triggers - - Check the check box next to the action trigger you wish to delete - - - Click the Delete Selected on the top left of the page. - - - - Before deleting an action trigger, you should consider disabling it through the editing form. This way you can simply enable it if you decide that you would like to use - the action trigger in the future. - - Deleting Action Triggers - - Check the check box next to the action trigger you wish to delete - - - Click the Delete Selected on the top left of the page. - - -
-
- Hooks - Hooks define the Fieldmapper class in the core_type column off of which the rest of the field definitions hang. - - Hooks - - - - - - Field - Description - - - - - Hook Key - A unique name given to the hook. - - - Core Type - Used to link the action trigger to the IDL class in fm_IDL.xml - - - Description - Text to describe the purpose of the hook. - - - Passive - Indicates whether or not an event is created by direct user action or is circumstantial. - - - -
- You may also create, edit and delete Hooks but the Core Type must refer to an IDL class in the fm_IDL.xml file. -
-
- Reactors - Reactors link the trigger definition to the action to be carried out. - - Action Trigger Reactors - - - - - - Field - Description - - - - - Module Name - The name of the Module to run if the action trigger is validated. It must be defined as a subroutine in - /openils/lib/perl5/OpenILS/Application/Trigger/Reactor.pm or as a module - in /openils/lib/perl5/OpenILS/Application/Trigger/Reactor/*.pm. - - - Description - Description of the Action to be carried out. - - - -
- You may also create, edit and delete Reactors. Just remember that their must be an associated subroutine or module in the Reactor Perl module. -
-
- Validators - Validators set the validation test to be preformed to determine whether the action trigger is executed. - - Action Trigger Validators - - - - - - - Field - Description - - - - - Module Name - The name of the subroutine in - /openils/lib/perl5/OpenILS/Application/Trigger/Reactor.pm to validate the action trigger. - - - Description - Description of validation test to run. - - - -
- You may also create, edit and delete Validators. Just remember that their must be an associated subroutine in the Reactor.pm Perl module. -
-
- Processing Action Triggers - To run the action triggers, an Evergreen administrator will need to run the trigger processing script /openils/bin/action_trigger_runner.pl - . This should be set up as a cron job to run - periodically. - You have several options when running the script: - - : Run the pending events. - : Create hook events - : OpenSRF core config file. Defaults to: - /openils/conf/opensrf_core.xml. - : File containing a JSON Object which describes any hooks that should - use a user-defined filter to find their target objects. Defaults to: /openils/conf/action_trigger_filters.json - : When in process-hooks mode, wait up to [seconds] for the lock file to go away. - Defaults to 3600 (1 hour). - : Define which hooks to create events for. If none are defined, it defaults to the list of hooks defined - in the option. - : Print server responses to stdout (as JSON) for debugging. - : Sets the lock file for the process. - : Show help information. - -
- -