installation/server_installation.txt

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