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