docs/installation/server_installation.txt

   1 Installing the Evergreen server
   2 ===============================
   3 :toc:
   4 :numbered:
   5
   6 Preamble: referenced user accounts
   7 ----------------------------------
   8
   9 In subsequent sections, we will refer to a number of different accounts, as
  10 follows:
  11
  12   * Linux user accounts:
  13     ** The *user* Linux account is the account that you use to log onto the
  14        Linux system as a regular user.
  15     ** The *root* Linux account is an account that has system administrator
  16        privileges. On Debian and Fedora you can switch to this account from
  17        your *user* account by issuing the `su -` command and entering the
  18        password for the *root* account when prompted. On Ubuntu you can switch
  19        to this account from your *user* account using the `sudo su -` command
  20        and entering the password for your *user* account when prompted.
  21     ** The *opensrf* Linux account is an account that you create when installing
  22        OpenSRF. You can switch to this account from the *root* account by
  23        issuing the `su - opensrf` command.
  24     ** The *postgres* Linux account is created automatically when you install
  25        the PostgreSQL database server. You can switch to this account from the
  26        *root* account by issuing the `su - postgres` command.
  27   * PostgreSQL user accounts:
  28     ** The *evergreen* PostgreSQL account is a superuser account that you will
  29        create to connect to the PostgreSQL database server.
  30   * Evergreen administrator account:
  31     ** The *egadmin* Evergreen account is an administrator account for
  32        Evergreen that you will use to test connectivity and configure your
  33        Evergreen instance.
  34
  35 Preamble: developer instructions
  36 --------------------------------
  37
  38 [NOTE]
  39 Skip this section if you are using an official release tarball downloaded
  40 from http://evergreen-ils.org/egdownloads
  41
  42 Developers working directly with the source code from the Git repository,
  43 rather than an official release tarball, must perform one step before they
  44 can proceed with the `./configure` step.
  45
  46 As the *user* Linux account, issue the following command in the Evergreen
  47 source directory to generate the configure script and Makefiles:
  48
  49 [source, bash]
  50 ------------------------------------------------------------------------------
  51 autoreconf -i
  52 ------------------------------------------------------------------------------
  53
  54 Installing prerequisites
  55 ------------------------
  56
  57   * **PostgreSQL**: Version 9.3 is recommended. The minimum supported version
  58     is 9.1.
  59   * **Linux**: Evergreen 2.8 has been tested on Debian Jessie (8.0),
  60     Debian Wheezy (7.0), Debian Squeeze(6.0), Ubuntu Trusty Tahr (14.04),
  61     Ubuntu Precise Pangolin (12.04), and Fedora.
  62     If you are running an older version of these distributions, you may want
  63     to upgrade before upgrading Evergreen. For instructions on upgrading these
  64     distributions, visit the Debian, Ubuntu or Fedora websites.
  65   * **OpenSRF**: The minimum supported version of OpenSRF is 2.4.0.
  66
  67
  68 Evergreen has a number of prerequisite packages that must be installed
  69 before you can successfully configure, compile, and install Evergreen.
  70
  71 1. Begin by installing the most recent version of OpenSRF (2.4.0 or later).
  72    You can download OpenSRF releases from http://evergreen-ils.org/opensrf-downloads/
  73 2. On many distributions, it is necessary to install PostgreSQL 9.1+ from external
  74    repositories.
  75 +
  76   * On Debian Squeeze, open `/etc/apt/sources.list` in a text editor as the
  77     *root* Linux account and add the following line:
  78 +
  79 [source, bash]
  80 ------------------------------------------------------------------------------
  81 deb http://backports.debian.org/debian-backports squeeze-backports main contrib
  82 ------------------------------------------------------------------------------
  83 +
  84   * Ubuntu Precise and Trusty comes with PostgreSQL 9.1+, so no additional steps are required.
  85   * Fedora 19 and 20 come with PostgreSQL 9.2+, so no additional steps are required.
  86 +
  87 3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
  88    retrieve the new packages from the backports repository.
  89 4. Issue the following commands as the *root* Linux account to install
  90    prerequisites using the `Makefile.install` prerequisite installer,
  91    substituting `debian-jessie`, `debian-wheezy`, `debian-squeeze`, `fedora`,
  92    `ubuntu-trusty`, or `ubuntu-precise` for <osname> below:
  93 +
  94 [source, bash]
  95 ------------------------------------------------------------------------------
  96 make -f Open-ILS/src/extras/Makefile.install <osname>
  97 ------------------------------------------------------------------------------
  98 +
  99 5. Add the libdbi-libdbd libraries to the system dynamic library path by
 100    issuing the following commands as the *root* Linux account:
 101 +
 102 [NOTE]
 103 You should skip this step if installing on Ubuntu Precise, Trusty or Debian Jessie. The ubuntu
 104 and Debian Jessie targets use libdbd-pgsql from packages.
 105 +
 106 .Debian Wheezy
 107 [source, bash]
 108 ------------------------------------------------------------------------------
 109 echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
 110 ldconfig
 111 ------------------------------------------------------------------------------
 112 +
 113 .Fedora
 114 [source, bash]
 115 ------------------------------------------------------------------------------
 116 echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf
 117 ldconfig
 118 ------------------------------------------------------------------------------
 119
 120 6. OPTIONAL: Developer additions
 121 +
 122 To perform certain developer tasks from a Git source code checkout,
 123 additional packages may be required.  As the *root* Linux account:
 124 +
 125  * To install packages needed for retriving and managing web dependencies,
 126    use the <osname>-developer Makefile.install target.  Currently,
 127    this is only needed for building and installing the (preview) browser
 128    staff client.
 129 +
 130 [source, bash]
 131 ------------------------------------------------------------------------------
 132 make -f Open-ILS/src/extras/Makefile.install <osname>-developer
 133 ------------------------------------------------------------------------------
 134 +
 135  * To install packages required for building Evergreen release bundles, use
 136    the <osname>-packager Makefile.install target.
 137 +
 138 [source, bash]
 139 ------------------------------------------------------------------------------
 140 make -f Open-ILS/src/extras/Makefile.install <osname>-packager
 141 ------------------------------------------------------------------------------
 142
 143 Optional: Extra steps for browser-based staff client
 144 ----------------------------------------------------
 145
 146 [NOTE]
 147 Skip this section if you are using an official release tarball downloaded
 148 from http://evergreen-ils.org/downloads
 149
 150 Install dependencies for browser-based staff client
 151 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 152
 153 1. Install Node.js.  For more information see also:
 154    https://github.com/joyent/node/wiki/installation[Node.js Installation]
 155 +
 156 [source,sh]
 157 ------------------------------------------------------------------------------
 158 # Go to a temporary directory
 159 cd /tmp
 160
 161 # Clone the code and checkout the necessary version
 162 git clone https://github.com/joyent/node.git
 163 cd node
 164 git checkout -b v0.10.28 v0.10.28
 165
 166 # set -j to the number of CPU cores on the server + 1
 167 ./configure && make -j2 && sudo make install
 168
 169 # update packages
 170 % sudo npm update
 171 ------------------------------------------------------------------------------
 172 +
 173 2. Install Grunt CLI
 174 +
 175 [source,sh]
 176 ------------------------------------------------------------------------------
 177 % sudo npm install -g grunt-cli
 178 ------------------------------------------------------------------------------
 179 +
 180 3. Install Bower
 181 +
 182 [source,sh]
 183 ------------------------------------------------------------------------------
 184 % sudo npm install -g bower
 185 ------------------------------------------------------------------------------
 186
 187 Install files for browser-based staff client
 188 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 189
 190 1. Building, Testing, Minification: The remaining steps all take place within
 191    the staff JS web root:
 192 +
 193 [source,sh]
 194 ------------------------------------------------------------------------------
 195 cd $EVERGREEN_ROOT/Open-ILS/web/js/ui/default/staff/
 196 ------------------------------------------------------------------------------
 197 +
 198 2. Install Project-local Dependencies. npm inspects the 'package.json' file
 199    for dependencies and fetches them from the Node package network.
 200 +
 201 [source,sh]
 202 ------------------------------------------------------------------------------
 203 npm install   # fetch Grunt dependencies
 204 bower install # fetch JS dependencies
 205 ------------------------------------------------------------------------------
 206 +
 207 3. Run the build script.
 208 +
 209 [source,sh]
 210 ------------------------------------------------------------------------------
 211 # build, run tests, concat+minify
 212 grunt all
 213 ------------------------------------------------------------------------------
 214
 215
 216 Configuration and compilation instructions
 217 ------------------------------------------
 218
 219 For the time being, we are still installing everything in the `/openils/`
 220 directory. From the Evergreen source directory, issue the following commands as
 221 the *user* Linux account to configure and build Evergreen:
 222
 223 [source, bash]
 224 ------------------------------------------------------------------------------
 225 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
 226 make
 227 ------------------------------------------------------------------------------
 228
 229 These instructions assume that you have also installed OpenSRF under `/openils/`.
 230 If not, please adjust PATH as needed so that the Evergreen `configure` script
 231 can find `osrf_config`.
 232
 233 Installation instructions
 234 -------------------------
 235
 236 1. Once you have configured and compiled Evergreen, issue the following
 237    command as the *root* Linux account to install Evergreen, build the server
 238    portion of the staff client, and copy example configuration files to
 239    `/openils/conf`.
 240    Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version
 241    of the staff client that you will use to connect to the Evergreen server.
 242 +
 243 [source, bash]
 244 ------------------------------------------------------------------------------
 245 make STAFF_CLIENT_STAMP_ID=rel_name install
 246 ------------------------------------------------------------------------------
 247 +
 248 2. The server portion of the staff client expects `http://hostname/xul/server`
 249    to resolve. Issue the following commands as the *root* Linux account to
 250    create a symbolic link pointing to the `server` subdirectory of the server
 251    portion of the staff client that we just built using the staff client ID
 252    'rel_name':
 253 +
 254 [source, bash]
 255 ------------------------------------------------------------------------------
 256 cd /openils/var/web/xul
 257 ln -sf rel_name/server server
 258 ------------------------------------------------------------------------------
 259
 260 Change ownership of the Evergreen files
 261 ---------------------------------------
 262
 263 All files in the `/openils/` directory and subdirectories must be owned by the
 264 `opensrf` user. Issue the following command as the *root* Linux account to
 265 change the ownership on the files:
 266
 267 [source, bash]
 268 ------------------------------------------------------------------------------
 269 chown -R opensrf:opensrf /openils
 270 ------------------------------------------------------------------------------
 271
 272 Additional Instructions for Developers
 273 --------------------------------------
 274
 275 [NOTE]
 276 Skip this section if you are using an official release tarball downloaded
 277 from http://evergreen-ils.org/egdownloads
 278
 279 Developers working directly with the source code from the Git repository,
 280 rather than an official release tarball, need to install the Dojo Toolkit
 281 set of JavaScript libraries. The appropriate version of Dojo is included in
 282 Evergreen release tarballs. Developers should install the Dojo 1.3.3 version
 283 of Dojo by issuing the following commands as the *opensrf* Linux account:
 284
 285 [source, bash]
 286 ------------------------------------------------------------------------------
 287 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
 288 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
 289 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
 290 ------------------------------------------------------------------------------
 291
 292
 293 Configure the Apache Web server
 294 -------------------------------
 295
 296 1. Use the example configuration files in `Open-ILS/examples/apache/` (for
 297 Apache versions below 2.4) or `Open-ILS/examples/apache_24/` (for Apache
 298 versions 2.4 or greater) to configure your Web server for the Evergreen
 299 catalog, staff client, Web services, and administration interfaces. Issue the
 300 following commands as the *root* Linux account:
 301 +
 302 .Debian Wheezy and Ubuntu Precise
 303 [source,bash]
 304 ------------------------------------------------------------------------------
 305 cp Open-ILS/examples/apache/eg.conf       /etc/apache2/sites-available/
 306 cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
 307 cp Open-ILS/examples/apache/eg_startup    /etc/apache2/
 308 # Now set up SSL
 309 mkdir /etc/apache2/ssl
 310 cd /etc/apache2/ssl
 311 ------------------------------------------------------------------------------
 312 +
 313 .Ubuntu Trusty and Debian Jessie
 314 [source,bash]
 315 ------------------------------------------------------------------------------------
 316 cp Open-ILS/examples/apache_24/eg_24.conf       /etc/apache2/sites-available/eg.conf
 317 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
 318 cp Open-ILS/examples/apache/eg_startup          /etc/apache2/
 319 # Now set up SSL
 320 mkdir /etc/apache2/ssl
 321 cd /etc/apache2/ssl
 322 ------------------------------------------------------------------------------------
 323 +
 324 .Fedora
 325 [source,bash]
 326 ------------------------------------------------------------------------------
 327 cp Open-ILS/examples/apache_24/eg_24.conf       /etc/httpd/conf.d/
 328 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/httpd/eg_vhost.conf
 329 cp Open-ILS/examples/apache/eg_startup          /etc/httpd/
 330 # Now set up SSL
 331 mkdir /etc/httpd/ssl
 332 cd /etc/httpd/ssl
 333 ------------------------------------------------------------------------------
 334 +
 335 2. The `openssl` command cuts a new SSL key for your Apache server. For a
 336 production server, you should purchase a signed SSL certificate, but you can
 337 just use a self-signed certificate and accept the warnings in the staff client
 338 and browser during testing and development. Create an SSL key for the Apache
 339 server by issuing the following command as the *root* Linux account:
 340 +
 341 [source,bash]
 342 ------------------------------------------------------------------------------
 343 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
 344 ------------------------------------------------------------------------------
 345 +
 346 3. As the *root* Linux account, edit the `eg.conf` file that you copied into
 347 place.
 348   a. To enable access to the offline upload / execute interface from any
 349      workstation on any network, make the following change (and note that
 350      you *must* secure this for a production instance):
 351      * (Apache 2.2): Replace `Allow from 10.0.0.0/8` with `Allow from all`
 352      * (Apache 2.4): Replace `Require host 10.0.0.0/8` with `Require all granted`
 353   b. (Fedora): Change references from the non-existent `/etc/apache2/` directory
 354      to `/etc/httpd/`.
 355 4. Change the user for the Apache server.
 356   * (Debian and Ubuntu): As the *root* Linux account, edit
 357     `/etc/apache2/envvars`.  Change `export APACHE_RUN_USER=www-data` to
 358     `export APACHE_RUN_USER=opensrf`.
 359   * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`.
 360     Change `User apache` to `User opensrf`.
 361 5. Configure Apache with performance settings appropriate for Evergreen:
 362   * (Debian and Ubuntu): As the *root* Linux account, edit
 363     `/etc/apache2/apache2.conf`:
 364   * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
 365     a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
 366        a request timing out unexpectedly, but increase the risk of using up
 367        all available Apache child processes.
 368     b. 'Optional': Change `MaxKeepAliveRequests` to `100`
 369     c. (Debian Wheezy, Ubuntu Precise, and Fedora) Update the prefork configuration
 370        section to suit your environment. The following settings apply to a busy
 371        system:
 372 +
 373 [source,bash]
 374 ------------------------------------------------------------------------------
 375 <IfModule mpm_prefork_module>
 376    StartServers           20
 377    MinSpareServers         5
 378    MaxSpareServers        15
 379    MaxClients            150
 380    MaxRequestsPerChild 10000
 381 </IfModule>
 382 ------------------------------------------------------------------------------
 383     d. (Ubuntu Trusty, Debian Jessie) As the *root* user, edit
 384        /etc/apache2/mods-available/mpm_prefork.conf to match the above values.
 385        Then, also as the *root* user, enable the mpm_prefork module by doing:
 386 +
 387 [source,bash]
 388 ------------------------------------------------------------------------------
 389 a2dismod mpm_event
 390 a2enmod mpm_prefork
 391 ------------------------------------------------------------------------------
 392 +
 393 6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf`
 394    file to change references from the non-existent `/etc/apache2/` directory
 395    to `/etc/httpd/`.
 396 7. (Debian Wheezy and Ubuntu Precise): As the *root* Linux account, enable the Evergreen site:
 397 +
 398 [source,bash]
 399 ------------------------------------------------------------------------------
 400 a2dissite default  # OPTIONAL: disable the default site (the "It Works" page)
 401 a2ensite eg.conf
 402 ------------------------------------------------------------------------------
 403 +
 404 (Ubuntu Trusty, Debian Jessie):
 405 +
 406 [source,bash]
 407 ------------------------------------------------------------------------------
 408 a2dissite 000-default  # OPTIONAL: disable the default site (the "It Works" page)
 409 a2ensite eg.conf
 410 ------------------------------------------------------------------------------
 411 +
 412 8. (Ubuntu): As the *root* Linux account, enable Apache to write
 413    to the lock directory; this is currently necessary because Apache
 414    is running as the `opensrf` user:
 415 +
 416 [source,bash]
 417 ------------------------------------------------------------------------------
 418 chown opensrf /var/lock/apache2
 419 ------------------------------------------------------------------------------
 420 +
 421 9. Learn more about additional Apache options in the following sections:
 422   * <<_apache_rewrite_tricks,Apache Rewrite Tricks>>
 423   * <<_apache_access_handler_perl_module,Apache Access Handler Perl Module>>
 424
 425 Configure OpenSRF for the Evergreen application
 426 -----------------------------------------------
 427 There are a number of example OpenSRF configuration files in `/openils/conf/`
 428 that you can use as a template for your Evergreen installation. Issue the
 429 following commands as the *opensrf* Linux account:
 430
 431 [source, bash]
 432 ------------------------------------------------------------------------------
 433 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
 434 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
 435 ------------------------------------------------------------------------------
 436
 437 When you installed OpenSRF, you created four Jabber users on two
 438 separate domains and edited the `opensrf_core.xml` file accordingly. Please
 439 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
 440 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
 441 and domains as you used while installing and testing OpenSRF.
 442
 443 [NOTE]
 444 The `-b` flag tells the `cp` command to create a backup version of the
 445 destination file. The backup version of the destination file has a tilde (`~`)
 446 appended to the file name, so if you have forgotten the Jabber users and
 447 domains, you can retrieve the settings from the backup version of the files.
 448
 449 `eg_db_config`, described in the following section, sets the database
 450 connection information in `opensrf.xml` for you.
 451
 452 Creating the Evergreen database
 453 -------------------------------
 454
 455 Setting up the PostgreSQL server
 456 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 457
 458 For production use, most libraries install the PostgreSQL database server on a
 459 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
 460 installer does *not* install the PostgreSQL 9 database server that is required
 461 by every Evergreen system. You can install the packages required by Debian or
 462 Ubuntu on the machine of your choice using the following commands as the
 463 *root* Linux account:
 464
 465 .(Debian / Ubuntu / Fedora) Installing PostgreSQL server packages
 466
 467 Each OS build target provides the postgres server installation packages
 468 required for each operating system.  To install Postgres server packages,
 469 use the make target 'postgres-server-<OSTYPE>'.  Choose the most appropriate
 470 command below based on your operating system.
 471
 472 [source, bash]
 473 ------------------------------------------------------------------------------
 474 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-jessie
 475 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-wheezy
 476 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-squeeze
 477 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-precise
 478 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-trusty
 479 make -f Open-ILS/src/extras/Makefile.install postgres-server-fedora
 480 ------------------------------------------------------------------------------
 481
 482 .(Fedora) Postgres initialization
 483
 484 Installing Postgres on Fedora also requires you to initialize the PostgreSQL
 485 cluster and start the service. Issue the following commands as the *root* user:
 486
 487 [source, bash]
 488 ------------------------------------------------------------------------------
 489 postgresql-setup initdb
 490 systemctl start postgresql
 491 ------------------------------------------------------------------------------
 492
 493 For a standalone PostgreSQL server, install the following Perl modules for your
 494 distribution as the *root* Linux account:
 495
 496 .(Ubuntu Precise)
 497 [source,bash]
 498 ---------------------------------------------------------------------------------
 499 cpan Rose::URI
 500 ---------------------------------------------------------------------------------
 501
 502 .(Debian "wheezy" and Ubuntu Trusty)
 503 No extra modules required for these distributions.
 504
 505 .(Fedora)
 506 [source, bash]
 507 ------------------------------------------------------------------------------
 508 cpan Rose::URI
 509 ------------------------------------------------------------------------------
 510
 511 You need to create a PostgreSQL superuser to create and access the database.
 512 Issue the following command as the *postgres* Linux account to create a new
 513 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
 514 password:
 515
 516 [source, bash]
 517 ------------------------------------------------------------------------------
 518 createuser -s -P evergreen
 519 ------------------------------------------------------------------------------
 520
 521 .Enabling connections to the PostgreSQL database
 522
 523 Your PostgreSQL database may be configured by default to prevent connections,
 524 for example, it might reject attempts to connect via TCP/IP or from other
 525 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
 526 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu, and in
 527 the `/var/lib/pgsql/data/` directory on Fedora. A simple way to enable TCP/IP
 528 connections from localhost to all databases with password authentication, which
 529 would be suitable for a test install of Evergreen on a single server, is to
 530 ensure the file contains the following entries _before_ any "host ... ident"
 531 entries:
 532
 533 ------------------------------------------------------------------------------
 534 host    all             all             ::1/128                 md5
 535 host    all             all             127.0.0.1/32            md5
 536 ------------------------------------------------------------------------------
 537
 538 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
 539 make the changes take effect.  For more information on configuring connectivity
 540 to PostgreSQL, see
 541 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
 542
 543 Creating the Evergreen database and schema
 544 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 545
 546 Once you have created the *evergreen* PostgreSQL account, you also need to
 547 create the database and schema, and configure your configuration files to point
 548 at the database server. Issue the following command as the *root* Linux account
 549 from inside the Evergreen source directory, replacing <user>, <password>,
 550 <hostname>, <port>, and <dbname> with the appropriate values for your
 551 PostgreSQL database (where <user> and <password> are for the *evergreen*
 552 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
 553 with the values you want for the *egadmin* Evergreen administrator account:
 554
 555 [source, bash]
 556 ------------------------------------------------------------------------------
 557 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
 558        --service all --create-database --create-schema --create-offline \
 559        --user <user> --password <password> --hostname <hostname> --port <port> \
 560        --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
 561 ------------------------------------------------------------------------------
 562
 563 This creates the database and schema and configures all of the services in
 564 your `/openils/conf/opensrf.xml` configuration file to point to that database.
 565 It also creates the configuration files required by the Evergreen `cgi-bin`
 566 administration scripts, and sets the user name and password for the *egadmin*
 567 Evergreen administrator account to your requested values.
 568
 569 You can get a complete set of options for `eg_db_config` by passing the
 570 `--help` parameter.
 571
 572 Loading sample data
 573 ~~~~~~~~~~~~~~~~~~~
 574 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
 575 a set of authority and bibliographic records, call numbers, copies, staff
 576 and regular users, and transactions will be loaded into your target
 577 database. This sample dataset is commonly referred to as the _concerto_
 578 sample data, and can be useful for testing out Evergreen functionality and
 579 for creating problem reports that developers can easily recreate with their
 580 own copy of the _concerto_ sample data.
 581
 582 Creating the database on a remote server
 583 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 584 In a production instance of Evergreen, your PostgreSQL server should be
 585 installed on a dedicated server.
 586
 587 PostgreSQL 9.1 and later
 588 ^^^^^^^^^^^^^^^^^^^^^^^^
 589 To create the database instance on a remote database server running PostgreSQL
 590 9.1 or later, simply use the `--create-database` flag on `eg_db_config`.
 591
 592 Starting Evergreen
 593 ------------------
 594 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
 595 (if they aren't already running):
 596 +
 597 [source, bash]
 598 ------------------------------------------------------------------------------
 599 /etc/init.d/ejabberd start
 600 /etc/init.d/memcached start
 601 ------------------------------------------------------------------------------
 602 +
 603 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
 604 following command is only necessary if you want to force Evergreen to treat the
 605 hostname as `localhost`; if you configured `opensrf.xml` using the real
 606 hostname of your machine as returned by `perl -ENet::Domain 'print
 607 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
 608 +
 609 [source, bash]
 610 ------------------------------------------------------------------------------
 611 osrf_control -l --start-all
 612 ------------------------------------------------------------------------------
 613 +
 614   ** If you receive the error message `bash: osrf_control: command not found`,
 615      then your environment variable `PATH` does not include the `/openils/bin`
 616      directory; this should have been set in the *opensrf* Linux account's
 617      `.bashrc` configuration file. To manually set the `PATH` variable, edit the
 618      configuration file `~/.bashrc` as the *opensrf* Linux account and add the
 619      following line:
 620 +
 621 [source, bash]
 622 ------------------------------------------------------------------------------
 623 export PATH=$PATH:/openils/bin
 624 ------------------------------------------------------------------------------
 625 +
 626 3. As the *opensrf* Linux account, generate the Web files needed by the staff
 627    client and catalogue and update the organization unit proximity (you need to do
 628    this the first time you start Evergreen, and after that each time you change the library org unit configuration.
 629 ):
 630 +
 631 [source, bash]
 632 ------------------------------------------------------------------------------
 633 autogen.sh
 634 ------------------------------------------------------------------------------
 635 +
 636 4. As the *root* Linux account, restart the Apache Web server:
 637 +
 638 [source, bash]
 639 ------------------------------------------------------------------------------
 640 /etc/init.d/apache2 restart
 641 ------------------------------------------------------------------------------
 642 +
 643 If the Apache Web server was running when you started the OpenSRF services, you
 644 might not be able to successfully log in to the OPAC or staff client until the
 645 Apache Web server is restarted.
 646
 647 Testing connections to Evergreen
 648 --------------------------------
 649
 650 Once you have installed and started Evergreen, test your connection to
 651 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
 652 commands to start `srfsh` and try to log onto the Evergreen server using the
 653 *egadmin* Evergreen administrator user name and password that you set using the
 654 `eg_db_config` command:
 655
 656 [source, bash]
 657 ------------------------------------------------------------------------------
 658 /openils/bin/srfsh
 659 srfsh% login <admin-user> <admin-pass>
 660 ------------------------------------------------------------------------------
 661
 662 You should see a result like:
 663
 664     Received Data: "250bf1518c7527a03249858687714376"
 665     ------------------------------------
 666     Request Completed Successfully
 667     Request Time in seconds: 0.045286
 668     ------------------------------------
 669
 670     Received Data: {
 671        "ilsevent":0,
 672        "textcode":"SUCCESS",
 673        "desc":" ",
 674        "pid":21616,
 675        "stacktrace":"oils_auth.c:304",
 676        "payload":{
 677           "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
 678           "authtime":420
 679        }
 680
 681     }
 682
 683     ------------------------------------
 684     Request Completed Successfully
 685     Request Time in seconds: 1.336568
 686     ------------------------------------
 687 [[install-troubleshooting-1]]
 688 If this does not work, it's time to do some troubleshooting.
 689
 690   * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
 691     if it finds any system configuration problems. The script is found at
 692     `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
 693     tree.
 694   * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
 695   * If you have faithfully followed the entire set of installation steps
 696     listed here, you are probably extremely close to a working system.
 697     Gather your configuration files and log files and contact the
 698     http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development
 699 mailing list] for assistance before making any drastic changes to your system
 700     configuration.
 701
 702 Getting help
 703 ------------
 704
 705 Need help installing or using Evergreen? Join the mailing lists at
 706 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
 707 IRC network on the #evergreen channel.
 708
 709 License
 710 -------
 711 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
 712 Unported License. To view a copy of this license, visit
 713 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
 714 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.