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