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