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