docs/installation/server_installation.adoc

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