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