#
# Makefile to install prerequisites for OpenSRF and Evergreen
#
-# Currently supports Debian (lenny/squeeze), Ubuntu (hardy/lucid), and Fedora (13).
+# Currently supports Debian (squeeze), Ubuntu (lucid), and Fedora (14).
# Working towards support of CentOS 5 / RHEL 5.
# Installs Perl prereqs, libjs with Perl wrapper, libdbi, libdbi-drivers, and libyaz
#
# usage:
-# make -f Makefile.install debian-lenny
-# - or -
# make -f Makefile.install debian-squeeze
# - or -
-# make -f Makefile.install ubuntu-hardy
-# - or -
# make -f Makefile.install ubuntu-lucid
# - or -
# make -f Makefile.install fedora14
#
# Notes:
#
-# This makefile has been tested much more with Debian and Ubuntu than
-# Fedora, CentOS, or RHEL.
+# This makefile has been tested much more with Debian, Ubuntu, and
+# Fedora than CentOS, or RHEL.
#
# ---------------------------------------------------------------------
Net::XMPP \
Net::Z3950::ZOOM
-FEDORA_13_RPMS = \
+FEDORA_RPMS = \
aspell \
aspell-en \
libdbi \
perl-Text-CSV \
perl-Text-CSV_XS \
perl-XML-Writer \
- postgresql-devel \
+ postgresql90-devel \
readline-devel \
tcp_wrappers-devel \
wget \
# Note: B:O:AuthorizeNet 3.21 fails with https://rt.cpan.org/Public/Bug/Display.html?id=55172
# Should be fixed in 3.22
# MARC::Record 2.0.1 is required but only 2.0.0 is packaged
-FEDORA_13_CPAN = \
+FEDORA_CPAN = \
Business::OnlinePayment \
Business::OnlinePayment::AuthorizeNet \
MARC::Record \
UUID::Tiny
-PGSQL_84_RPMS = \
- postgresql-8.4* \
- postgresql-contrib-8.4* \
- postgresql-devel-8.4* \
- postgresql-plpe*-8.4* \
- postgresql-server-8.4*
-
-PGSQL_CLIENT_DEBS_82 = \
- postgresql-client
+PGSQL_90_RPMS = \
+ postgresql90 \
+ postgresql90-contrib \
+ postgresql90-devel \
+ postgresql90-libs \
+ postgresql90-plperl \
+ postgresql90-server
-PGSQL_CLIENT_DEBS_83 = \
+PGSQL_CLIENT_DEBS_90 = \
postgresql-client
-PGSQL_CLIENT_DEBS_84 = \
- postgresql-client-8.4
-
-PGSQL_SERVER_DEBS_84 = \
- postgresql-8.4 \
- postgresql-contrib-8.4 \
- postgresql-plperl-8.4 \
- postgresql-server-dev-8.4
+PGSQL_SERVER_DEBS_90 = \
+ postgresql-9.0 \
+ postgresql-contrib-9.0 \
+ postgresql-plperl-9.0 \
+ postgresql-server-dev-9.0
DEB_APACHE_MODS = \
expires\
rhel: install_redhat_pgsql centos_like
centos_like: install_centos_rpms install_yaz install_cpan_marc install install_centos_perl create_ld_local install_cpan_safe install_cpan_force
-fedora13: install_fedora_13_rpms install_cpan install_cpan_fedora install_cpan_marc install_js_sm install_cpan_force
-fedora14: fedora13
+fedora14: install_fedora_rpms install_cpan install_cpan_fedora install_cpan_marc install_js_sm install_cpan_force
-debian-lenny: lenny generic_debian install_cpan_more install_cpan_safe
debian-squeeze: squeeze generic_debian
-lenny: install_pgsql_client_debs_83 install_extra_debs
-squeeze: install_pgsql_client_debs_84 install_extra_debs_squeeze
+squeeze: install_pgsql_client_debs_90 install_extra_debs_squeeze
generic_debian: install_debs test_for_libdbi_pkg install debian_sys_config install_cpan_force
-ubuntu-hardy: hardy generic_ubuntu
ubuntu-lucid: lucid generic_ubuntu
-hardy: install_pgsql_client_debs_82 install_yaz install_cpan_marc install_extra_encode
-lucid: install_pgsql_client_debs_84 install_extra_debs
+lucid: install_pgsql_client_debs_90 install_extra_debs
generic_ubuntu: install_debs test_for_libdbi_pkg install debian_sys_config install_cpan_more install_cpan_safe install_cpan_force
# - COMMON TARGETS ---------------------------------------------------------
# Install the CPAN modules for Fedora 13
install_cpan_fedora:
- for m in $(FEDORA_13_CPAN); do \
+ for m in $(FEDORA_CPAN); do \
echo "force install $$m" | perl -MCPAN -e shell;\
done
install_debs:
$(APT_TOOL) install $(DEBS)
-install_pgsql_client_debs_84:
- $(APT_TOOL) install $(PGSQL_CLIENT_DEBS_84)
-
-install_pgsql_server_debs_84:
- $(APT_TOOL) install $(PGSQL_SERVER_DEBS_84)
-
-install_pgsql_client_debs_83:
- $(APT_TOOL) install $(PGSQL_CLIENT_DEBS_83)
+install_pgsql_client_debs_90:
+ $(APT_TOOL) install $(PGSQL_CLIENT_DEBS_90)
-install_pgsql_client_debs_82:
- $(APT_TOOL) install $(PGSQL_CLIENT_DEBS_82)
+install_pgsql_server_debs_90:
+ $(APT_TOOL) install $(PGSQL_SERVER_DEBS_90)
# Install the debian-specific dependencies for more modern distros
install_extra_debs_squeeze: install_extra_debs
# ------------------------------------------------------------------
# FEDORA 13
-install_fedora_13_rpms:
+install_fedora_rpms:
yum -y update
- yum -y install $(FEDORA_13_RPMS)
+ yum -y install $(FEDORA_RPMS)
-install_fedora_13_pgsql_server:
+install_fedora_pgsql_server:
yum -y install $(PGSQL_84_RPMS)
# CENTOS
README for Evergreen trunk
+========================
Installing prerequisites:
-========================
+-------------------------
+
Evergreen has a number of prerequisite packages that must be installed
before you can successfully configure, compile, and install Evergreen.
-1. Begin by installing the most recent version of OpenSRF (1.6.2 or later).
-You can download OpenSRF releases from
-http://evergreen-ils.org/downloads
-
-2. On Debian and Ubuntu, the easiest way to install the rest of the
-prerequisites for Evergreen is to use the Makefile.install prerequisite
-installer.
-
-Issue the following commands as the root user to install prerequisites
-using the Makefile.install prerequisite installer, substituting
-"debian-etch", "debian-lenny", "fedora-14", "ubuntu-hardy", "ubuntu-lucid",
-"centos", or "rhel" for <osname> below:
-
+1. Begin by installing the most recent version of OpenSRF (2.0 or later).
+ You can download OpenSRF releases from http://evergreen-ils.org/downloads
+2. On many distributions, it is necessary to install Postgres 9 from external
+ repositories.
++
+ * On Debian Squeeze, add the following line to `/etc/apt/sources.list`:
++
+[source, bash]
+------------------------------------------------------------------------------
+deb http://www.backports.org/debian squeeze-backports main contrib
+------------------------------------------------------------------------------
++
+ * On Ubuntu Lucid, add the following line to `/etc/apt/sources.list`:
++
+[source, bash]
+------------------------------------------------------------------------------
+deb http://archive.ubuntu.com/ubuntu lucid-backports main universe multiverse restricted
+------------------------------------------------------------------------------
++
+ * On Fedora 14, follow the http://yum.pgrpms.org/howtoyum.php[instructions
+ in the Yum HOWTO] to enable the PostgreSQL RPM Building Project yum
+ repository.
++
+3. On Debian and Ubuntu, the easiest way to install the rest of the
+ prerequisites for Evergreen is to use the Makefile.install prerequisite
+ installer.
+4. Issue the following commands as the root user to install prerequisites
+ using the Makefile.install prerequisite installer, substituting
+ `debian-squeeze`, `fedora-14`, `ubuntu-lucid`, `centos`, or `rhel` for
+ <osname> below:
++
+[source, bash]
+------------------------------------------------------------------------------
make -f Open-ILS/src/extras/Makefile.install <osname>
+------------------------------------------------------------------------------
-Note: "centos" and "rhel" are less tested than the debian, fedora,
-and ubuntu options. Your patches and suggestions for improvement are
+Note: `centos` and `rhel` are less tested than the `debian`, `fedora`,
+and `ubuntu` options. Your patches and suggestions for improvement are
welcome!
Configuration and compilation instructions:
-==========================================
+-------------------------------------------
-For the time being, we are still installing everything in the /openils/
+For the time being, we are still installing everything in the `/openils/`
directory. If you are working with a version of Evergreen taken directly
from the Subversion repository, rather than a packaged version of Evergreen,
-first see "Developer instructions" below.
+first see `Developer instructions` below.
Otherwise, issue the following commands to configure and build Evergreen:
+[source, bash]
+------------------------------------------------------------------------------
./configure --prefix=/openils --sysconfdir=/openils/conf
make
+------------------------------------------------------------------------------
Installation instructions:
-=========================
+--------------------------
Once you have configured and compiled Evergreen, issue the following
command as the root user to install Evergreen:
+[source, bash]
+------------------------------------------------------------------------------
make STAFF_CLIENT_STAMP_ID=rel_trunk install
+------------------------------------------------------------------------------
This will install Evergreen, including example configuration files in
-/openils/conf/ that you can use as templates for your own configuration files.
-The STAFF_CLIENT_STAMP_ID variable stamps the server-side and client-side files
+`/openils/conf/` that you can use as templates for your own configuration files.
+The `STAFF_CLIENT_STAMP_ID` variable stamps the server-side and client-side files
for the staff client to ensure that they match.
Install Dojo Toolkit:
-====================
+---------------------
Evergreen uses the Dojo Toolkit to support its Web and staff client interfaces.
files into the correct directory, adjusting the version number to match the
version of the Dojo Toolkit that you downloaded:
+[source, bash]
+------------------------------------------------------------------------------
wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
+------------------------------------------------------------------------------
Create the oils_web.xml configuration file:
-==========================================
+-------------------------------------------
Many administration interfaces, such as acquisitions, bookings, and various
configuration screens, depend on the correct configuration of HTML templates.
Copying the sample configuration file into place should work in most cases:
+[source, bash]
+------------------------------------------------------------------------------
cp /openils/conf/oils_web.xml.example /openils/conf/oils_web.xml
+------------------------------------------------------------------------------
Change ownership of the Evergreen files:
-=======================================
+----------------------------------------
-All files in the /openils/ directory and subdirectories must be owned by the
-"opensrf" user. Issue the following command as the root user to change the
+All files in the `/openils/` directory and subdirectories must be owned by the
+`opensrf` user. Issue the following command as the root user to change the
ownership on the files:
+[source, bash]
+------------------------------------------------------------------------------
chown -R opensrf:opensrf /openils
+------------------------------------------------------------------------------
Configure the Apache Web server:
-===============================
+--------------------------------
-Use the example configuration files in Open-ILS/examples/apache/ to configure
+Use the example configuration files in `Open-ILS/examples/apache/` to configure
your Web server for the Evergreen catalog, staff client, Web services, and
administration interfaces.
Configure OpenSRF for the Evergreen application:
-===============================================
+------------------------------------------------
-There are a number of example OpenSRF configuration files in /openils/conf/ that
-you can use as a template for your Evergreen installation.
+There are a number of example OpenSRF configuration files in `/openils/conf/`
+that you can use as a template for your Evergreen installation.
+[source, bash]
+------------------------------------------------------------------------------
cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
+------------------------------------------------------------------------------
When you installed OpenSRF, you will have created four Jabber users on two
-separate domains and edited the opensrf_core.xml file accordingly. Please
+separate domains and edited the `opensrf_core.xml` file accordingly. Please
refer back to the OpenSRF README and edit the Evergreen version of the
-opensrf_core.xml file using the same Jabber users and domains as you used
+`opensrf_core.xml` file using the same Jabber users and domains as you used
while installing and testing OpenSRF.
-eg_db_config.pl, described in the following section, will set the database
-connection information in opensrf.xml for you.
+`eg_db_config.pl`, described in the following section, will set the database
+connection information in `opensrf.xml` for you.
Creating the Evergreen database:
-===============================
+--------------------------------
-PostgreSQL 9.0 will be installed on your system by the Makefile.install
+PostgreSQL 9.0 will be installed on your system by the `Makefile.install`
prerequisite installer if packages are available for your distribution, or
you will have to compile PostgreSQL 9.0 from source and install it (which
is beyond the scope of this document).
Once the PostgreSQL database server has been installed, you will need to
create the database and add the appropriate languages and extensions to
-support Evergreen. Issue the following commands as the "postgres" user to set
-up a database called "evergreen". Note that the location of the PostgreSQL
-"contrib" packages may vary depending on your distribution. In the following
+support Evergreen. Issue the following commands as the `postgres` user to set
+up a database called `evergreen`. Note that the location of the PostgreSQL
+`contrib` packages may vary depending on your distribution. In the following
commands, we assume that you are working with PostgreSQL 9.0 on a Debian-based
system:
+[source, bash]
+------------------------------------------------------------------------------
createdb --template template0 --lc-ctype=C --lc-collate=C --encoding UNICODE evergreen
createlang plperl evergreen
createlang plperlu evergreen
psql -f /usr/share/postgresql/9.0/contrib/tsearch2.sql -d evergreen
psql -f /usr/share/postgresql/9.0/contrib/pgxml.sql -d evergreen
psql -f /usr/share/postgresql/9.0/contrib/hstore.sql -d evergreen
+------------------------------------------------------------------------------
Once you have created the Evergreen database, you need to create a PostgreSQL
-user to access the database. Issue the following command as the "postgres"
-user to create a new PostgreSQL user named "evergreen". When prompted, enter
-the new user's password and answer "yes" to make the new role a superuser:
+user to access the database. Issue the following command as the `postgres`
+user to create a new PostgreSQL user named `evergreen`. When prompted, enter
+the new user's password and answer `yes` to make the new role a superuser:
+[source, bash]
+------------------------------------------------------------------------------
createuser -P evergreen
+------------------------------------------------------------------------------
Once you have created the Evergreen database, you also need to create the
database schema and configure your configuration files to point at the
<admin-pass> with the values you want for the default Evergreen administrator
account:
+[source, bash]
+------------------------------------------------------------------------------
perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \
--service all --create-schema --create-offline \
--user <user> --password <password> --hostname <hostname> --port <port> \
--database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
+------------------------------------------------------------------------------
This will create the database schema and configure all of the services in
-your /openils/conf/opensrf.xml configuration file to point to that database.
+your `/openils/conf/opensrf.xml` configuration file to point to that database.
It also creates the configuration files required by the Evergreen cgi-bin
administration scripts, and set the user name and password for the default
Evergreen administrator account to your requested values.
Developer instructions:
-======================
+-----------------------
Developers working directly with the source code from the Subversion
repository will also need to install some extra packages and perform
-one more step before they can proceed with the "./configure" step.
+one more step before they can proceed with the `./configure` step.
Install the following packages:
* autoconf
Run the following command in the source directory to generate the configure
script and Makefiles:
+[source, bash]
+------------------------------------------------------------------------------
./autogen.sh
+------------------------------------------------------------------------------
-After running 'make install', developers also need to install the Dojo Toolkit
+After running `make install`, developers also need to install the Dojo Toolkit
set of JavaScript libraries. The appropriate version of Dojo is included
in Evergreen release tarballs; developers should install the Dojo 1.3.3
version of Dojo as follows:
+[source, bash]
+------------------------------------------------------------------------------
wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
tar xzf dojo-release-1.3.3.tar.gz
cp -r dojo-release-1.3.3/* /openils/var/web/js/dojo/.
+------------------------------------------------------------------------------
Getting help:
-============
+-------------
Need help installing or using Evergreen? Join the mailing lists at
http://evergreen-ils.org/listserv.php or contact us on the Freenode
projects / evergreen-equinox.git / commitdiff