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