docs/installation/server_installation.adoc

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