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