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