webstaff: add session-stickiness for MARC template selector
[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), Debian Squeeze(6.0), Ubuntu Trusty Tahr (14.04), 
61     Ubuntu Precise Pangolin (12.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 many distributions, it is necessary to install PostgreSQL 9.1+ from external
74    repositories.
75 +
76   * On Debian Squeeze, open `/etc/apt/sources.list` in a text editor as the
77     *root* Linux account and add the following line:
78 +
79 [source, bash]
80 ------------------------------------------------------------------------------
81 deb http://backports.debian.org/debian-backports squeeze-backports main contrib
82 ------------------------------------------------------------------------------
83 +
84   * Ubuntu Precise and Trusty comes with PostgreSQL 9.1+, so no additional steps are required.
85   * Fedora 19 and 20 come with PostgreSQL 9.2+, so no additional steps are required.
86 +
87 3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
88    retrieve the new packages from the backports repository.
89 4. Issue the following commands as the *root* Linux account to install
90    prerequisites using the `Makefile.install` prerequisite installer,
91    substituting `debian-jessie`, `debian-wheezy`, `debian-squeeze`, `fedora`, 
92    `ubuntu-trusty`, or `ubuntu-precise` for <osname> below:
93 +
94 [source, bash]
95 ------------------------------------------------------------------------------
96 make -f Open-ILS/src/extras/Makefile.install <osname>
97 ------------------------------------------------------------------------------
98 +
99 5. Add the libdbi-libdbd libraries to the system dynamic library path by
100    issuing the following commands as the *root* Linux account:
101 +
102 [NOTE]
103 You should skip this step if installing on Ubuntu Precise, Trusty or Debian Jessie. The ubuntu
104 and Debian Jessie targets use libdbd-pgsql from packages.
105 +
106 .Debian Wheezy
107 [source, bash]
108 ------------------------------------------------------------------------------
109 echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
110 ldconfig
111 ------------------------------------------------------------------------------
112 +
113 .Fedora
114 [source, bash]
115 ------------------------------------------------------------------------------
116 echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf
117 ldconfig
118 ------------------------------------------------------------------------------
119
120 6. OPTIONAL: Developer additions
121 +
122 To perform certain developer tasks from a Git source code checkout, 
123 additional packages may be required.  As the *root* Linux account:
124 +
125  * To install packages needed for retriving and managing web dependencies,
126    use the <osname>-developer Makefile.install target.  Currently, 
127    this is only needed for building and installing the (preview) browser 
128    staff client.
129 +
130 [source, bash]
131 ------------------------------------------------------------------------------
132 make -f Open-ILS/src/extras/Makefile.install <osname>-developer
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 or Ubuntu Trusty 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 1. 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 and Ubuntu Precise
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 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 2. 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 3. 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 4. 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 5. Configure Apache with performance settings appropriate for Evergreen:
368   * (Debian and Ubuntu): As the *root* Linux account, edit
369     `/etc/apache2/apache2.conf`:
370   * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
371     a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
372        a request timing out unexpectedly, but increase the risk of using up
373        all available Apache child processes.
374     b. 'Optional': Change `MaxKeepAliveRequests` to `100`
375     c. (Debian Wheezy, Ubuntu Precise, and Fedora) Update the prefork configuration 
376        section to suit your environment. The following settings apply to a busy 
377        system:
378 +
379 [source,bash]
380 ------------------------------------------------------------------------------
381 <IfModule mpm_prefork_module>
382    StartServers           20
383    MinSpareServers         5
384    MaxSpareServers        15
385    MaxClients            150
386    MaxRequestsPerChild 10000
387 </IfModule>
388 ------------------------------------------------------------------------------
389     d. (Ubuntu Trusty, Debian Jessie) As the *root* user, edit 
390        /etc/apache2/mods-available/mpm_prefork.conf to match the above values.  
391        Then, also as the *root* user, enable the mpm_prefork module by doing:
392 +
393 [source,bash]
394 ------------------------------------------------------------------------------
395 a2dismod mpm_event
396 a2enmod mpm_prefork
397 ------------------------------------------------------------------------------
398 +
399 6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf`
400    file to change references from the non-existent `/etc/apache2/` directory
401    to `/etc/httpd/`.
402 7. (Debian Wheezy and Ubuntu Precise): As the *root* Linux account, enable the Evergreen site:
403 +
404 [source,bash]
405 ------------------------------------------------------------------------------
406 a2dissite default  # OPTIONAL: disable the default site (the "It Works" page)
407 a2ensite eg.conf
408 ------------------------------------------------------------------------------
409 +
410 (Ubuntu Trusty, Debian Jessie):
411 +
412 [source,bash]
413 ------------------------------------------------------------------------------
414 a2dissite 000-default  # OPTIONAL: disable the default site (the "It Works" page)
415 a2ensite eg.conf
416 ------------------------------------------------------------------------------
417 +
418 8. (Ubuntu): As the *root* Linux account, enable Apache to write
419    to the lock directory; this is currently necessary because Apache
420    is running as the `opensrf` user:
421 +
422 [source,bash]
423 ------------------------------------------------------------------------------
424 chown opensrf /var/lock/apache2
425 ------------------------------------------------------------------------------
426 +
427 9. Learn more about additional Apache options in the following sections:
428   * <<_apache_rewrite_tricks,Apache Rewrite Tricks>>
429   * <<_apache_access_handler_perl_module,Apache Access Handler Perl Module>>
430
431 Configure OpenSRF for the Evergreen application
432 -----------------------------------------------
433 There are a number of example OpenSRF configuration files in `/openils/conf/`
434 that you can use as a template for your Evergreen installation. Issue the
435 following commands as the *opensrf* Linux account:
436
437 [source, bash]
438 ------------------------------------------------------------------------------
439 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
440 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
441 ------------------------------------------------------------------------------
442
443 When you installed OpenSRF, you created four Jabber users on two
444 separate domains and edited the `opensrf_core.xml` file accordingly. Please
445 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
446 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
447 and domains as you used while installing and testing OpenSRF.
448
449 [NOTE]
450 The `-b` flag tells the `cp` command to create a backup version of the
451 destination file. The backup version of the destination file has a tilde (`~`)
452 appended to the file name, so if you have forgotten the Jabber users and
453 domains, you can retrieve the settings from the backup version of the files.
454
455 `eg_db_config`, described in the following section, sets the database
456 connection information in `opensrf.xml` for you.
457
458 Creating the Evergreen database
459 -------------------------------
460
461 Setting up the PostgreSQL server
462 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
463
464 For production use, most libraries install the PostgreSQL database server on a
465 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
466 installer does *not* install the PostgreSQL 9 database server that is required
467 by every Evergreen system. You can install the packages required by Debian or
468 Ubuntu on the machine of your choice using the following commands as the
469 *root* Linux account:
470
471 .(Debian / Ubuntu / Fedora) Installing PostgreSQL server packages
472
473 Each OS build target provides the postgres server installation packages
474 required for each operating system.  To install Postgres server packages, 
475 use the make target 'postgres-server-<OSTYPE>'.  Choose the most appropriate 
476 command below based on your operating system.
477
478 [source, bash]
479 ------------------------------------------------------------------------------
480 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-jessie
481 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-wheezy
482 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-squeeze
483 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-precise
484 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-trusty
485 make -f Open-ILS/src/extras/Makefile.install postgres-server-fedora
486 ------------------------------------------------------------------------------
487
488 .(Fedora) Postgres initialization
489
490 Installing Postgres on Fedora also requires you to initialize the PostgreSQL
491 cluster and start the service. Issue the following commands as the *root* user:
492
493 [source, bash]
494 ------------------------------------------------------------------------------
495 postgresql-setup initdb
496 systemctl start postgresql
497 ------------------------------------------------------------------------------
498
499 For a standalone PostgreSQL server, install the following Perl modules for your
500 distribution as the *root* Linux account:
501
502 .(Ubuntu Precise)
503 [source,bash]
504 ---------------------------------------------------------------------------------
505 cpan Rose::URI
506 ---------------------------------------------------------------------------------
507
508 .(Debian "wheezy" and Ubuntu Trusty) 
509 No extra modules required for these distributions.
510
511 .(Fedora)
512 [source, bash]
513 ------------------------------------------------------------------------------
514 cpan Rose::URI
515 ------------------------------------------------------------------------------
516
517 You need to create a PostgreSQL superuser to create and access the database.
518 Issue the following command as the *postgres* Linux account to create a new
519 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
520 password:
521
522 [source, bash]
523 ------------------------------------------------------------------------------
524 createuser -s -P evergreen
525 ------------------------------------------------------------------------------
526
527 .Enabling connections to the PostgreSQL database
528
529 Your PostgreSQL database may be configured by default to prevent connections,
530 for example, it might reject attempts to connect via TCP/IP or from other
531 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
532 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu, and in
533 the `/var/lib/pgsql/data/` directory on Fedora. A simple way to enable TCP/IP
534 connections from localhost to all databases with password authentication, which
535 would be suitable for a test install of Evergreen on a single server, is to
536 ensure the file contains the following entries _before_ any "host ... ident"
537 entries:
538
539 ------------------------------------------------------------------------------
540 host    all             all             ::1/128                 md5
541 host    all             all             127.0.0.1/32            md5
542 ------------------------------------------------------------------------------
543
544 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
545 make the changes take effect.  For more information on configuring connectivity
546 to PostgreSQL, see
547 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
548
549 Creating the Evergreen database and schema
550 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
551
552 Once you have created the *evergreen* PostgreSQL account, you also need to
553 create the database and schema, and configure your configuration files to point
554 at the database server. Issue the following command as the *root* Linux account
555 from inside the Evergreen source directory, replacing <user>, <password>,
556 <hostname>, <port>, and <dbname> with the appropriate values for your
557 PostgreSQL database (where <user> and <password> are for the *evergreen*
558 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
559 with the values you want for the *egadmin* Evergreen administrator account:
560
561 [source, bash]
562 ------------------------------------------------------------------------------
563 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
564        --service all --create-database --create-schema --create-offline \
565        --user <user> --password <password> --hostname <hostname> --port <port> \
566        --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
567 ------------------------------------------------------------------------------
568
569 This creates the database and schema and configures all of the services in
570 your `/openils/conf/opensrf.xml` configuration file to point to that database.
571 It also creates the configuration files required by the Evergreen `cgi-bin`
572 administration scripts, and sets the user name and password for the *egadmin*
573 Evergreen administrator account to your requested values.
574
575 You can get a complete set of options for `eg_db_config` by passing the
576 `--help` parameter.
577
578 Loading sample data
579 ~~~~~~~~~~~~~~~~~~~
580 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
581 a set of authority and bibliographic records, call numbers, copies, staff
582 and regular users, and transactions will be loaded into your target
583 database. This sample dataset is commonly referred to as the _concerto_
584 sample data, and can be useful for testing out Evergreen functionality and
585 for creating problem reports that developers can easily recreate with their
586 own copy of the _concerto_ sample data.
587
588 Creating the database on a remote server
589 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
590 In a production instance of Evergreen, your PostgreSQL server should be
591 installed on a dedicated server.
592
593 PostgreSQL 9.1 and later
594 ^^^^^^^^^^^^^^^^^^^^^^^^
595 To create the database instance on a remote database server running PostgreSQL
596 9.1 or later, simply use the `--create-database` flag on `eg_db_config`.
597
598 Starting Evergreen
599 ------------------
600 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
601 (if they aren't already running):
602 +
603 [source, bash]
604 ------------------------------------------------------------------------------
605 /etc/init.d/ejabberd start
606 /etc/init.d/memcached start
607 ------------------------------------------------------------------------------
608 +
609 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
610 following command is only necessary if you want to force Evergreen to treat the
611 hostname as `localhost`; if you configured `opensrf.xml` using the real
612 hostname of your machine as returned by `perl -ENet::Domain 'print
613 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
614 +
615 [source, bash]
616 ------------------------------------------------------------------------------
617 osrf_control -l --start-all
618 ------------------------------------------------------------------------------
619 +
620   ** If you receive the error message `bash: osrf_control: command not found`,
621      then your environment variable `PATH` does not include the `/openils/bin`
622      directory; this should have been set in the *opensrf* Linux account's
623      `.bashrc` configuration file. To manually set the `PATH` variable, edit the
624      configuration file `~/.bashrc` as the *opensrf* Linux account and add the
625      following line:
626 +
627 [source, bash]
628 ------------------------------------------------------------------------------
629 export PATH=$PATH:/openils/bin
630 ------------------------------------------------------------------------------
631 +
632 3. As the *opensrf* Linux account, generate the Web files needed by the staff
633    client and catalogue and update the organization unit proximity (you need to do
634    this the first time you start Evergreen, and after that each time you change the library org unit configuration.
635 ):
636 +
637 [source, bash]
638 ------------------------------------------------------------------------------
639 autogen.sh
640 ------------------------------------------------------------------------------
641 +
642 4. As the *root* Linux account, restart the Apache Web server:
643 +
644 [source, bash]
645 ------------------------------------------------------------------------------
646 /etc/init.d/apache2 restart
647 ------------------------------------------------------------------------------
648 +
649 If the Apache Web server was running when you started the OpenSRF services, you
650 might not be able to successfully log in to the OPAC or staff client until the
651 Apache Web server is restarted.
652
653 Testing connections to Evergreen
654 --------------------------------
655
656 Once you have installed and started Evergreen, test your connection to
657 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
658 commands to start `srfsh` and try to log onto the Evergreen server using the
659 *egadmin* Evergreen administrator user name and password that you set using the
660 `eg_db_config` command:
661
662 [source, bash]
663 ------------------------------------------------------------------------------
664 /openils/bin/srfsh
665 srfsh% login <admin-user> <admin-pass>
666 ------------------------------------------------------------------------------
667
668 You should see a result like:
669
670     Received Data: "250bf1518c7527a03249858687714376"
671     ------------------------------------
672     Request Completed Successfully
673     Request Time in seconds: 0.045286
674     ------------------------------------
675
676     Received Data: {
677        "ilsevent":0,
678        "textcode":"SUCCESS",
679        "desc":" ",
680        "pid":21616,
681        "stacktrace":"oils_auth.c:304",
682        "payload":{
683           "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
684           "authtime":420
685        }
686
687     }
688
689     ------------------------------------
690     Request Completed Successfully
691     Request Time in seconds: 1.336568
692     ------------------------------------
693 [[install-troubleshooting-1]]
694 If this does not work, it's time to do some troubleshooting.
695
696   * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
697     if it finds any system configuration problems. The script is found at
698     `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
699     tree.
700   * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
701   * If you have faithfully followed the entire set of installation steps
702     listed here, you are probably extremely close to a working system.
703     Gather your configuration files and log files and contact the
704     http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development 
705 mailing list] for assistance before making any drastic changes to your system
706     configuration.
707
708 Getting help
709 ------------
710
711 Need help installing or using Evergreen? Join the mailing lists at
712 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
713 IRC network on the #evergreen channel.
714
715 License
716 -------
717 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
718 Unported License. To view a copy of this license, visit
719 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
720 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.