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