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