README

   1 README for Evergreen master
   2 ===========================
   3
   4 Preamble: referenced user accounts
   5 ----------------------------------
   6
   7 In subsequent sections, we will refer to a number of different accounts, as
   8 follows:
   9
  10   * Linux user accounts:
  11     ** The *user* Linux account is the account that you use to log onto the
  12        Linux system as a regular user.
  13     ** The *root* Linux account is an account that has system administrator
  14        privileges. On Debian and Fedora you can switch to this account from
  15        your *user* account by issuing the `su -` command and entering the
  16        password for the *root* account when prompted. On Ubuntu you can switch
  17        to this account from your *user* account using the `sudo su -` command
  18        and entering the password for your *user* account when prompted.
  19     ** The *opensrf* Linux account is an account that you create when installing
  20        OpenSRF. You can switch to this account from the *root* account by
  21        issuing the `su - opensrf` command.
  22     ** The *postgres* Linux account is created automatically when you install
  23        the PostgreSQL database server. You can switch to this account from the
  24        *root* account by issuing the `su - postgres` command.
  25   * PostgreSQL user accounts:
  26     ** The *evergreen* PostgreSQL account is a superuser account that you will
  27        create to connect to the PostgreSQL database server.
  28   * Evergreen administrator account:
  29     ** The *egadmin* Evergreen account is an administrator account for
  30        Evergreen that you will use to test connectivity and configure your
  31        Evergreen instance.
  32
  33 Preamble: Developer instructions
  34 --------------------------------
  35
  36 [NOTE]
  37 Skip this section if you are using an official release tarball downloaded
  38 from http://evergreen-ils.org/downloads
  39
  40 Developers working directly with the source code from the Git repository,
  41 rather than an official release tarball, must install some extra packages
  42 and perform one step before they can proceed with the `./configure` step.
  43
  44 As the *root* Linux account, install the following packages:
  45
  46   * autoconf
  47   * automake
  48   * libtool
  49
  50 As the *user* Linux account, issue the following command in the Evergreen
  51 source directory to generate the configure script and Makefiles:
  52
  53 [source, bash]
  54 ------------------------------------------------------------------------------
  55 ./autogen.sh
  56 ------------------------------------------------------------------------------
  57
  58 After running `make install`, developers also need to install the Dojo Toolkit
  59 set of JavaScript libraries. The appropriate version of Dojo is included
  60 in Evergreen release tarballs. Developers should install the Dojo 1.3.3
  61 version of Dojo by issuing the following commands as the *opensrf* Linux
  62 account:
  63
  64 [source, bash]
  65 ------------------------------------------------------------------------------
  66 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
  67 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
  68 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
  69 ------------------------------------------------------------------------------
  70
  71 Installing prerequisites:
  72 -------------------------
  73
  74 Evergreen has a number of prerequisite packages that must be installed
  75 before you can successfully configure, compile, and install Evergreen.
  76
  77 1. Begin by installing the most recent version of OpenSRF (2.0 or later).
  78    You can download OpenSRF releases from http://evergreen-ils.org/opensrf.php
  79 2. On many distributions, it is necessary to install PostgreSQL 9 from external
  80    repositories.
  81 +
  82   * On Debian Squeeze, open `/etc/apt/sources.list` in a text editor as the
  83     *root* Linux account and add the following line:
  84 +
  85 [source, bash]
  86 ------------------------------------------------------------------------------
  87 deb http://backports.debian.org/debian-backports squeeze-backports main contrib
  88 ------------------------------------------------------------------------------
  89 +
  90   * On Ubuntu Lucid, open `/etc/apt/sources.list` in a text editor as the
  91     *root* Linux account and add the following line:
  92 +
  93 [source, bash]
  94 ------------------------------------------------------------------------------
  95 deb http://archive.ubuntu.com/ubuntu lucid-backports main universe multiverse restricted
  96 ------------------------------------------------------------------------------
  97 +
  98   * Fedora 15 comes with PostgreSQL 9, so no additional steps are required.
  99 +
 100 3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
 101    retrieve the new packages from the backports repository.
 102 4. Issue the following commands as the *root* Linux account to install
 103    prerequisites using the `Makefile.install` prerequisite installer,
 104    substituting `debian-squeeze`, `fedora15`, `ubuntu-lucid`, `centos`, or
 105    `rhel` for <osname> below:
 106 +
 107 [source, bash]
 108 ------------------------------------------------------------------------------
 109 make -f Open-ILS/src/extras/Makefile.install <osname>
 110 ------------------------------------------------------------------------------
 111 +
 112 [NOTE]
 113 `centos` and `rhel` are less tested than the `debian`, `fedora`,
 114 and `ubuntu` options.  Your patches and suggestions for improvement are
 115 welcome!
 116 +
 117 5. Add the libdbi-libdbd libraries to the system dynamic library path by
 118    issuing the following commands as the *root* Linux account:
 119 +
 120 .Debian / Ubuntu
 121 [source, bash]
 122 ------------------------------------------------------------------------------
 123 echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
 124 ldconfig
 125 ------------------------------------------------------------------------------
 126 +
 127 .Fedora
 128 [source, bash]
 129 ------------------------------------------------------------------------------
 130 echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf
 131 ldconfig
 132 ------------------------------------------------------------------------------
 133
 134 Configuration and compilation instructions:
 135 -------------------------------------------
 136
 137 For the time being, we are still installing everything in the `/openils/`
 138 directory. From the Evergreen source directory, issue the following commands as
 139 the *user* Linux account to configure and build Evergreen:
 140
 141 [source, bash]
 142 ------------------------------------------------------------------------------
 143 ./configure --prefix=/openils --sysconfdir=/openils/conf
 144 make
 145 ------------------------------------------------------------------------------
 146
 147 Installation instructions:
 148 --------------------------
 149
 150 1. Once you have configured and compiled Evergreen, issue the following
 151    command as the *root* Linux account to install Evergreen, build the server
 152    portion of the staff client, and copy example configuration files to
 153    `/openils/conf`.
 154    Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version
 155    of the staff client that you will use to connect to the Evergreen server.
 156 +
 157 [source, bash]
 158 ------------------------------------------------------------------------------
 159 make STAFF_CLIENT_STAMP_ID=rel_name install
 160 ------------------------------------------------------------------------------
 161 +
 162 2. The server portion of the staff client expects `http://hostname/xul/server`
 163    to resolve. Issue the following commands as the *root* Linux account to
 164    create a symbolic link pointing to the `server` subdirectory of the server
 165    portion of the staff client that we just built using the staff client ID
 166    'rel_name':
 167 +
 168 [source, bash]
 169 ------------------------------------------------------------------------------
 170 cd /openils/var/web/xul
 171 ln -sf rel_name/server server
 172 ------------------------------------------------------------------------------
 173
 174 Change ownership of the Evergreen files:
 175 ----------------------------------------
 176
 177 All files in the `/openils/` directory and subdirectories must be owned by the
 178 `opensrf` user. Issue the following command as the *root* Linux account to
 179 change the ownership on the files:
 180
 181 [source, bash]
 182 ------------------------------------------------------------------------------
 183 chown -R opensrf:opensrf /openils
 184 ------------------------------------------------------------------------------
 185
 186 Configure the Apache Web server:
 187 --------------------------------
 188
 189 1. Use the example configuration files in `Open-ILS/examples/apache/` to
 190 configure your Web server for the Evergreen catalog, staff client, Web
 191 services, and administration interfaces. Issue the following commands as the
 192 *root* Linux account:
 193 +
 194 .Debian and Ubuntu
 195 [source,bash]
 196 ------------------------------------------------------------------------------
 197 cp Open-ILS/examples/apache/eg.conf       /etc/apache2/sites-available/
 198 cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
 199 cp Open-ILS/examples/apache/startup.pl    /etc/apache2/
 200 # Now set up SSL
 201 mkdir /etc/apache2/ssl
 202 cd /etc/apache2/ssl
 203 ------------------------------------------------------------------------------
 204 +
 205 .Fedora
 206 [source,bash]
 207 ------------------------------------------------------------------------------
 208 cp Open-ILS/examples/apache/eg.conf       /etc/httpd/sites-available/
 209 cp Open-ILS/examples/apache/eg_vhost.conf /etc/httpd/
 210 cp Open-ILS/examples/apache/startup.pl    /etc/httpd/
 211 # Now set up SSL
 212 mkdir /etc/httpd/ssl
 213 cd /etc/httpd/ssl
 214 ------------------------------------------------------------------------------
 215 +
 216 2. The `openssl` command cuts a new SSL key for your Apache server. For a
 217 production server, you should purchase a signed SSL certificate, but you can
 218 just use a self-signed certificate and accept the warnings in the staff client
 219 and browser during testing and development. Create an SSL key for the Apache
 220 server by issuing the following command as the *root* Linux account:
 221 +
 222 [source,bash]
 223 ------------------------------------------------------------------------------
 224 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
 225 ------------------------------------------------------------------------------
 226 +
 227 3. As the *root* Linux account, edit the `eg.conf` file that you copied into
 228 place.
 229   a. Replace `Allow from 10.0.0.0/8` with `Allow from all` (to enable
 230      access to the offline upload / execute interface from any workstation on
 231      any network - note that you must secure this for a production instance)
 232 4. Change the user for the Apache server.
 233   * (Debian and Ubuntu): As the *root* Linux account, edit
 234     `/etc/apache2/envvars`.  Change `export APACHE_RUN_USER=www-data` to
 235     `export APACHE_RUN_USER=opensrf`.
 236   * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`.
 237     Change `User apache` to `User opensrf`.
 238 5. Configure Apache with performance settings appropriate for Evergreen:
 239   * (Debian and Ubuntu): As the *root* Linux account, edit
 240     `/etc/apache2/apache2.conf`:
 241   * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
 242     a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
 243        a request timing out unexpectedly, but increase the risk of using up
 244        all available Apache child processes.
 245     b. 'Optional': Change `MaxKeepAliveRequests` to `100`
 246     c. Update the prefork configuration section to suit your environment. The
 247        following settings apply to a busy system:
 248 +
 249 [source,bash]
 250 ------------------------------------------------------------------------------
 251 <IfModule mpm_prefork_module>
 252    StartServers           20
 253    MinSpareServers         5
 254    MaxSpareServers        15
 255    MaxClients            150
 256    MaxRequestsPerChild 10000
 257 </IfModule>
 258 ------------------------------------------------------------------------------
 259 +
 260 6. (Debian and Ubuntu): As the *root* Linux account, enable the Evergreen site:
 261 +
 262 [source,bash]
 263 ------------------------------------------------------------------------------
 264 a2dissite default  # OPTIONAL: disable the default site (the "It Works" page)
 265 a2ensite eg.conf
 266 ------------------------------------------------------------------------------
 267
 268 Configure OpenSRF for the Evergreen application:
 269 ------------------------------------------------
 270 There are a number of example OpenSRF configuration files in `/openils/conf/`
 271 that you can use as a template for your Evergreen installation. Issue the
 272 following commands as the *opensrf* Linux account:
 273
 274 [source, bash]
 275 ------------------------------------------------------------------------------
 276 cp /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
 277 cp /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
 278 ------------------------------------------------------------------------------
 279
 280 When you installed OpenSRF, you created four Jabber users on two
 281 separate domains and edited the `opensrf_core.xml` file accordingly. Please
 282 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
 283 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
 284 and domains as you used while installing and testing OpenSRF.
 285
 286 `eg_db_config.pl`, described in the following section, sets the database
 287 connection information in `opensrf.xml` for you.
 288
 289 Creating the Evergreen database:
 290 --------------------------------
 291
 292 By default, the `Makefile.install` prerequisite installer does not install
 293 the PostgreSQL 9.0 database server required by every Evergreen system;
 294 for production use, most libraries install the PostgreSQL database server on a
 295 dedicated machine. You can install the packages required by Debian, Ubuntu, or
 296 Fedora on the machine of your choice using the following commands as the *root*
 297 Linux account:
 298
 299 .(Debian / Ubuntu) Installing PostgreSQL 9.0 server packages
 300 [source, bash]
 301 ------------------------------------------------------------------------------
 302 make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_90
 303 ------------------------------------------------------------------------------
 304
 305 .(Fedora 15) Installing PostgreSQL 9.0 server packages
 306 [source, bash]
 307 ------------------------------------------------------------------------------
 308 make -f Open-ILS/src/extras/Makefile.install install_fedora_pgsql_server
 309 ------------------------------------------------------------------------------
 310
 311 For a standalone PostgreSQL server, install the following Perl modules as the
 312 *root* Linux account:
 313
 314 .(Debian / Ubuntu) Installing additional Perl modules on a standalone PostgreSQL 9.0 server
 315 [source, bash]
 316 ------------------------------------------------------------------------------
 317 aptitude install gcc libxml-libxml-perl libxml-libxslt-perl
 318 cpan Business::ISBN
 319 cpan JSON::XS
 320 cpan Library::CallNumber::LC
 321 cpan MARC::Record
 322 cpan MARC::File::XML
 323 cpan UUID::Tiny
 324 ------------------------------------------------------------------------------
 325
 326 .(Fedora 15) Installing additional Perl modules on a standalone PostgreSQL 9.0 server
 327 [source, bash]
 328 ------------------------------------------------------------------------------
 329 yum install gcc perl-XML-LibXML perl-XML-LibXSLT perl-Business-ISBN
 330 cpan JSON::XS
 331 cpan Library::CallNumber::LC
 332 cpan MARC::Record
 333 cpan MARC::File::XML
 334 cpan UUID::Tiny
 335 ------------------------------------------------------------------------------
 336
 337 You need to create a PostgreSQL superuser to create and access the database.
 338 Issue the following command as the *postgres* Linux account to create a new
 339 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
 340 password:
 341
 342 [source, bash]
 343 ------------------------------------------------------------------------------
 344 createuser -s -P evergreen
 345 ------------------------------------------------------------------------------
 346
 347 Once you have created the *evergreen* PostgreSQL account, you also need to
 348 create the database and schema, and configure your configuration files to point
 349 at the database server. Issue the following command as the *root* Linux account
 350 from inside the Evergreen source directory, replacing <user>, <password>,
 351 <hostname>, <port>, and <dbname> with the appropriate values for your
 352 PostgreSQL database (where <user> and <password> are for the *evergreen*
 353 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
 354 with the values you want for the *egadmin* Evergreen administrator account:
 355
 356 [source, bash]
 357 ------------------------------------------------------------------------------
 358 perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \
 359        --service all --create-database --create-schema --create-offline \
 360        --user <user> --password <password> --hostname <hostname> --port <port> \
 361        --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
 362 ------------------------------------------------------------------------------
 363
 364 This creates the database and schema and configures all of the services in
 365 your `/openils/conf/opensrf.xml` configuration file to point to that database.
 366 It also creates the configuration files required by the Evergreen `cgi-bin`
 367 administration scripts, and sets the user name and password for the *egadmin*
 368 Evergreen administrator account to your requested values.
 369
 370 Creating the database on a remote server
 371 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 372 In a production instance of Evergreen, your PostgreSQL server should be
 373 installed on a dedicated server. To create the database in that case, you
 374 can either:
 375
 376   *  Install the PostgreSQL contrib modules on the machine on which you
 377      are installing the Evergreen code, and use the --create-database
 378      option from that machine, or
 379   *  Copy the `Open-ILS/src/sql/Pg/create-database.sql` script to your
 380      PostgreSQL server and invoke it as the *postgres* Linux account:
 381 +
 382 [source, bash]
 383 ------------------------------------------------------------------------------
 384 psql -vdb_name=<dbname> -vcontrib_dir=`pg_config --sharedir`/contrib
 385 ------------------------------------------------------------------------------
 386
 387 Then you can issue the `eg_db_config.pl` command as above _without_ the
 388 `--create-database` argument to create your schema and configure your
 389 configuration files.
 390
 391 Starting Evergreen
 392 ------------------
 393 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
 394 (if they aren't already running):
 395 +
 396 [source, bash]
 397 ------------------------------------------------------------------------------
 398 /etc/init.d/ejabberd start
 399 /etc/init.d/memcached start
 400 ------------------------------------------------------------------------------
 401 +
 402 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
 403 following command is only necessary if you want to force Evergreen to treat the
 404 hostname as `localhost`; if you configured `opensrf.xml` using the real
 405 hostname of your machine as returned by `perl -ENet::Domain 'print
 406 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
 407 +
 408 [source, bash]
 409 ------------------------------------------------------------------------------
 410 osrf_ctl.sh -l -a start_all</code>
 411 ------------------------------------------------------------------------------
 412 +
 413   ** If you receive the error message `bash: osrf_ctl.sh: command not found`,
 414      then your environment variable `PATH` does not include the `/openils/bin`
 415      directory; this should have been set in the *opensrf* Linux account's
 416      `.bashrc` configuration file. To manually set the `PATH` variable, edit the
 417      configuration file `~/.bashrc` as the *opensrf* Linux account and add the
 418      following line:
 419 +
 420 [source, bash]
 421 ------------------------------------------------------------------------------
 422 export PATH=$PATH:/openils/bin
 423 ------------------------------------------------------------------------------
 424 +
 425 3. As the *opensrf* Linux account, generate the Web files needed by the staff
 426    client and catalogue and update the organization unit proximity (you need to do
 427    this the first time you start Evergreen, and after that each time you change
 428    the library hierarchy in `config.cgi`):
 429 +
 430 [source, bash]
 431 ------------------------------------------------------------------------------
 432 autogen.sh -u
 433 ------------------------------------------------------------------------------
 434 +
 435 4. As the *root* Linux account, restart the Apache Web server:
 436 +
 437 [source, bash]
 438 ------------------------------------------------------------------------------
 439 /etc/init.d/apache2 restart
 440 ------------------------------------------------------------------------------
 441 +
 442 If the Apache Web server was running when you started the OpenSRF services, you
 443 might not be able to successfully log in to the OPAC or staff client until the
 444 Apache Web server is restarted.
 445
 446 Testing connections to Evergreen
 447 --------------------------------
 448
 449 Once you have installed and started Evergreen, test your connection to
 450 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
 451 commands to start `srfsh` and try to log onto the Evergreen server using the
 452 *egadmin* Evergreen administrator user name and password that you set using the
 453 `eg_db_config.pl` command:
 454
 455 [source, bash]
 456 ------------------------------------------------------------------------------
 457 /openils/bin/srfsh
 458 srfsh% login <admin-user> <admin-pass>
 459 ------------------------------------------------------------------------------
 460
 461 You should see a result like:
 462
 463     Received Data: "250bf1518c7527a03249858687714376"
 464     ------------------------------------
 465     Request Completed Successfully
 466     Request Time in seconds: 0.045286
 467     ------------------------------------
 468
 469     Received Data: {
 470        "ilsevent":0,
 471        "textcode":"SUCCESS",
 472        "desc":" ",
 473        "pid":21616,
 474        "stacktrace":"oils_auth.c:304",
 475        "payload":{
 476           "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
 477           "authtime":420
 478        }
 479
 480     }
 481
 482     ------------------------------------
 483     Request Completed Successfully
 484     Request Time in seconds: 1.336568
 485     ------------------------------------
 486
 487 If this does not work, it's time to do some troubleshooting.
 488
 489   * As the *opensrf* Linux acccount, run the `settings-tester.pl` script to see
 490     if it finds any system configuration problems. The script is found at
 491     `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
 492     tree.
 493   * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
 494   * If you have faithfully followed the entire set of installation steps
 495     listed here, you are probably extremely close to a working system.
 496     Gather your configuration files and log files and contact the
 497     http://open-ils.org/listserv.php[Evergreen development mailing list]
 498     for assistance before making any drastic changes to your system
 499     configuration.
 500
 501 Getting help:
 502 -------------
 503
 504 Need help installing or using Evergreen? Join the mailing lists at
 505 http://evergreen-ils.org/listserv.php or contact us on the Freenode
 506 IRC network on the #evergreen channel.