README

   1 README for Evergreen trunk
   2
   3 Installing prerequisites:
   4 ========================
   5 Evergreen has a number of prerequisite packages that must be installed
   6 before you can successfully configure, compile, and install Evergreen.
   7
   8 1. Begin by installing the most recent version of OpenSRF (1.4.0 or later).
   9 You can download OpenSRF releases from
  10 http://evergreen-ils.org/downloads
  11
  12 2. On Debian and Ubuntu, the easiest way to install the rest of the
  13 prerequisites for Evergreen is to use the Makefile.install prerequisite
  14 installer.
  15
  16 Issue the following commands as the root user to install prerequisites
  17 using the Makefile.install prerequisite installer, substituting
  18 "debian-etch", "debian-lenny", "fedora-13", "ubuntu-hardy", "ubuntu-lucid",
  19 "centos", or "rhel" for <osname> below:
  20
  21 make -f Open-ILS/src/extras/Makefile.install <osname>
  22
  23 Note: "centos" and "rhel" are less tested than the debian, fedora,
  24 and ubuntu options.  Your patches and suggestions for improvement are
  25 welcome!
  26
  27 Configuration and compilation instructions:
  28 ==========================================
  29
  30 For the time being, we are still installing everything in the /openils/
  31 directory. Issue the following commands to configure and build Evergreen:
  32
  33 ./configure --prefix=/openils --sysconfdir=/openils/conf
  34 make
  35
  36 Installation instructions:
  37 =========================
  38
  39 Once you have configured and compiled Evergreen, issue the following
  40 command as the root user to install Evergreen:
  41
  42 make STAFF_CLIENT_BUILD_ID=rel_trunk install
  43
  44 This will install Evergreen, including example configuration files in
  45 /openils/conf/ that you can use as templates for your own configuration files.
  46 The STAFF_CLIENT_BUILD_ID variable stamps the server-side and client-side files
  47 for the staff client to ensure that they match.
  48
  49 Install Dojo Toolkit:
  50 ====================
  51
  52 Evergreen uses the Dojo Toolkit to support its Web and staff client interfaces.
  53
  54 Download the Dojo Toolkit (Dojo + Dijit + DojoX) from
  55 http://dojotoolkit.org/downloads
  56
  57 Issue the following commands as the root user to fetch, extract, and copy the
  58 files into the correct directory, adjusting the version number to match the
  59 version of the Dojo Toolkit that you downloaded:
  60
  61 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
  62 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
  63 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
  64
  65 Create the oils_web.xml configuration file:
  66 ==========================================
  67 Many administration interfaces, such as acquisitions, bookings, and various
  68 configuration screens, depend on the correct configuration of HTML templates.
  69 Copying the sample configuration file into place should work in most cases:
  70
  71 cp /openils/conf/oils_web.xml.example /openils/conf/oils_web.xml
  72
  73 Change ownership of the Evergreen files:
  74 =======================================
  75
  76 All files in the /openils/ directory and subdirectories must be owned by the
  77 "opensrf" user. Issue the following command as the root user to change the
  78 ownership on the files:
  79
  80 chown -R opensrf:opensrf /openils
  81
  82 Configure the Apache Web server:
  83 ===============================
  84
  85 Use the example configuration files in Open-ILS/examples/apache/ to configure
  86 your Web server for the Evergreen catalog, staff client, Web services, and
  87 administration interfaces.
  88
  89 Configure OpenSRF for the Evergreen application:
  90 ===============================================
  91
  92 There are a number of example OpenSRF configuration files in /openils/conf/ that
  93 you can use as a template for your Evergreen installation.
  94
  95 cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
  96 cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
  97
  98 When you installed OpenSRF, you will have created four Jabber users on two
  99 separate domains and edited the opensrf_core.xml file accordingly. Please
 100 refer back to the OpenSRF README and edit the Evergreen version of the
 101 opensrf_core.xml file using the same Jabber users and domains as you used
 102 while installing and testing OpenSRF.
 103
 104 eg_db_config.pl, described in the following section, will set the database
 105 connection information in opensrf.xml for you.
 106
 107 Creating the Evergreen database:
 108 ===============================
 109
 110 PostgreSQL 8.3 or 8.4 will be installed on your system by the Makefile.install
 111 prerequisite installer if packages are available for your distribution, or
 112 you will have to compile PostgreSQL 8.3 or 8.4 from source and install it (which
 113 is beyond the scope of this document). PostgreSQL 8.4 is recommended if you have
 114 the option.
 115
 116 Once the PostgreSQL database server has been installed, you will need to
 117 create the database and add the appropriate languages and extensions to
 118 support Evergreen. Issue the following commands as the "postgres" user to set
 119 up a database called "evergreen". Note that the location of the PostgreSQL
 120 "contrib" packages may vary depending on your distribution. In the following
 121 commands, we assume that you are working with PostgreSQL 8.4 on a Debian-based
 122 system:
 123
 124 createdb -E UNICODE evergreen
 125 createlang plperl evergreen
 126 createlang plperlu evergreen
 127 createlang plpgsql evergreen
 128 psql -f /usr/share/postgresql/8.4/contrib/tablefunc.sql -d evergreen
 129 psql -f /usr/share/postgresql/8.4/contrib/tsearch2.sql -d evergreen
 130 psql -f /usr/share/postgresql/8.4/contrib/pgxml.sql -d evergreen
 131 psql -f /usr/share/postgresql/8.4/contrib/isn.sql -d evergreen
 132
 133 Once you have created the Evergreen database, you need to create a PostgreSQL
 134 user to access the database. Issue the following command as the "postgres"
 135 user to create a new PostgreSQL user named "evergreen". When prompted, enter
 136 the new user's password and answer "yes" to make the new role a superuser:
 137
 138 createuser -P evergreen
 139
 140 Once you have created the Evergreen database, you also need to create the
 141 database schema and configure your configuration files to point at the
 142 database server. Issue the following command as root from inside the Evergreen
 143 source directory, replacing <user>, <password>, <hostname>, <port>, and <dbname>
 144 with the appropriate values for your PostgreSQL database:
 145
 146 perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \
 147        --service all --create-schema --create-bootstrap --create-offline \
 148        --user <user> --password <password> --hostname <hostname> --port <port> \
 149        --database <dbname>
 150
 151 This will create the database schema and configure all of the services in
 152 your /openils/conf/opensrf.xml configuration file to point to that database.
 153 It also creates the configuration files required by the Evergreen cgi-bin
 154 administration scripts.
 155
 156 Getting help:
 157 ============
 158
 159 Need help installing or using Evergreen? Join the mailing lists at
 160 http://evergreen-ils.org/listserv.php or contact us on the Freenode
 161 IRC network on the #evergreen channel.