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