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