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