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