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