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