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