Description for circ.holds.default_shelf_expire_interval
[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/downloads
41
42 Developers working directly with the source code from the Git repository,
43 rather than an official release tarball, must install some extra packages
44 and perform one step before they can proceed with the `./configure` step.
45
46 As the *root* Linux account, install the following packages:
47
48   * autoconf
49   * automake
50   * libtool
51
52 As the *user* Linux account, issue the following command in the Evergreen
53 source directory to generate the configure script and Makefiles:
54
55 [source, bash]
56 ------------------------------------------------------------------------------
57 autoreconf -i
58 ------------------------------------------------------------------------------
59
60 After running `make install`, developers also need to install the Dojo Toolkit
61 set of JavaScript libraries. The appropriate version of Dojo is included
62 in Evergreen release tarballs. Developers should install the Dojo 1.3.3
63 version of Dojo by issuing the following commands as the *opensrf* Linux
64 account:
65
66 [source, bash]
67 ------------------------------------------------------------------------------
68 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
69 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
70 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
71 ------------------------------------------------------------------------------
72
73 Installing prerequisites
74 ------------------------
75
76 Evergreen has a number of prerequisite packages that must be installed
77 before you can successfully configure, compile, and install Evergreen.
78
79 1. Begin by installing the most recent version of OpenSRF (2.2 or later).
80    You can download OpenSRF releases from http://evergreen-ils.org/opensrf.php
81 2. On many distributions, it is necessary to install PostgreSQL 9 from external
82    repositories.
83 +
84   * On Debian Squeeze, open `/etc/apt/sources.list` in a text editor as the
85     *root* Linux account and add the following line:
86 +
87 [source, bash]
88 ------------------------------------------------------------------------------
89 deb http://backports.debian.org/debian-backports squeeze-backports main contrib
90 ------------------------------------------------------------------------------
91 +
92   * On Ubuntu Lucid, you can use a PPA (personal package archive), which are 
93     package sources hosted on Launchpad. The one most commonly used by Evergreen
94     Community members is maintained by Martin Pitt, who also maintains the
95     official PostgreSQL packages for Ubuntu. As the *root* Linux account, issue
96     the following commands to add the PPA source:
97 +
98 [source, bash]
99 ------------------------------------------------------------------------------
100 apt-get install python-software-properties
101 add-apt-repository ppa:pitti/postgresql
102 ------------------------------------------------------------------------------
103 +
104   * Ubuntu Precise comes with PostgreSQL 9, so no additional steps are required.
105 +
106   * Fedora comes with PostgreSQL 9, so no additional steps are required.
107 +
108 3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
109    retrieve the new packages from the backports repository.
110 4. Issue the following commands as the *root* Linux account to install
111    prerequisites using the `Makefile.install` prerequisite installer,
112    substituting `debian-squeeze`, `fedora`, `ubuntu-lucid`, or
113    `ubuntu-precise` for <osname> below:
114 +
115 [source, bash]
116 ------------------------------------------------------------------------------
117 make -f Open-ILS/src/extras/Makefile.install <osname>
118 ------------------------------------------------------------------------------
119 +
120 5. Add the libdbi-libdbd libraries to the system dynamic library path by
121    issuing the following commands as the *root* Linux account:
122 +
123 [NOTE]
124 You should skip this step if installing on Ubuntu Precise. The ubuntu-precise
125 target uses libdbd-pgsql from packages.
126 +
127 .Debian / Ubuntu Lucid
128 [source, bash]
129 ------------------------------------------------------------------------------
130 echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
131 ldconfig
132 ------------------------------------------------------------------------------
133 +
134 .Fedora
135 [source, bash]
136 ------------------------------------------------------------------------------
137 echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf
138 ldconfig
139 ------------------------------------------------------------------------------
140
141 Configuration and compilation instructions
142 ------------------------------------------
143
144 For the time being, we are still installing everything in the `/openils/`
145 directory. From the Evergreen source directory, issue the following commands as
146 the *user* Linux account to configure and build Evergreen:
147
148 [source, bash]
149 ------------------------------------------------------------------------------
150 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
151 make
152 ------------------------------------------------------------------------------
153
154 These instructions assume that you have also installed OpenSRF under `/openils/`.
155 If not, please adjust PATH as needed so that the Evergreen `configure` script
156 can find `osrf_config`.
157
158 Installation instructions
159 -------------------------
160
161 1. Once you have configured and compiled Evergreen, issue the following
162    command as the *root* Linux account to install Evergreen, build the server
163    portion of the staff client, and copy example configuration files to
164    `/openils/conf`.
165    Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version
166    of the staff client that you will use to connect to the Evergreen server.
167 +
168 [source, bash]
169 ------------------------------------------------------------------------------
170 make STAFF_CLIENT_STAMP_ID=rel_name install
171 ------------------------------------------------------------------------------
172 +
173 2. The server portion of the staff client expects `http://hostname/xul/server`
174    to resolve. Issue the following commands as the *root* Linux account to
175    create a symbolic link pointing to the `server` subdirectory of the server
176    portion of the staff client that we just built using the staff client ID
177    'rel_name':
178 +
179 [source, bash]
180 ------------------------------------------------------------------------------
181 cd /openils/var/web/xul
182 ln -sf rel_name/server server
183 ------------------------------------------------------------------------------
184
185 Change ownership of the Evergreen files
186 ---------------------------------------
187
188 All files in the `/openils/` directory and subdirectories must be owned by the
189 `opensrf` user. Issue the following command as the *root* Linux account to
190 change the ownership on the files:
191
192 [source, bash]
193 ------------------------------------------------------------------------------
194 chown -R opensrf:opensrf /openils
195 ------------------------------------------------------------------------------
196
197 Configure the Apache Web server
198 -------------------------------
199
200 1. Use the example configuration files in `Open-ILS/examples/apache/` (for
201 Apache versions below 2.4) or `Open-ILS/examples/apache_24/` (for Apache
202 versions 2.4 or greater) to configure your Web server for the Evergreen
203 catalog, staff client, Web services, and administration interfaces. Issue the
204 following commands as the *root* Linux account:
205 +
206 .Debian and Ubuntu
207 [source,bash]
208 ------------------------------------------------------------------------------
209 cp Open-ILS/examples/apache/eg.conf       /etc/apache2/sites-available/
210 cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
211 cp Open-ILS/examples/apache/eg_startup    /etc/apache2/
212 # Now set up SSL
213 mkdir /etc/apache2/ssl
214 cd /etc/apache2/ssl
215 ------------------------------------------------------------------------------
216 +
217 .Fedora 17
218 [source,bash]
219 ------------------------------------------------------------------------------
220 cp Open-ILS/examples/apache/eg.conf       /etc/httpd/conf.d/
221 cp Open-ILS/examples/apache/eg_vhost.conf /etc/httpd/
222 cp Open-ILS/examples/apache/eg_startup    /etc/httpd/
223 # Now set up SSL
224 mkdir /etc/httpd/ssl
225 cd /etc/httpd/ssl
226 ------------------------------------------------------------------------------
227 +
228 .Fedora 18
229 [source,bash]
230 ------------------------------------------------------------------------------
231 cp Open-ILS/examples/apache_24/eg.conf       /etc/httpd/conf.d/
232 cp Open-ILS/examples/apache_24/eg_vhost.conf /etc/httpd/
233 cp Open-ILS/examples/apache/startup.pl       /etc/httpd/
234 # Now set up SSL
235 mkdir /etc/httpd/ssl
236 cd /etc/httpd/ssl
237 ------------------------------------------------------------------------------
238 +
239 2. The `openssl` command cuts a new SSL key for your Apache server. For a
240 production server, you should purchase a signed SSL certificate, but you can
241 just use a self-signed certificate and accept the warnings in the staff client
242 and browser during testing and development. Create an SSL key for the Apache
243 server by issuing the following command as the *root* Linux account:
244 +
245 [source,bash]
246 ------------------------------------------------------------------------------
247 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
248 ------------------------------------------------------------------------------
249 +
250 3. As the *root* Linux account, edit the `eg.conf` file that you copied into
251 place.
252   a. To enable access to the offline upload / execute interface from any
253      workstation on any network, make the following change (and note that
254      you *must* secure this for a production instance):
255      * (Apache 2.2): Replace `Allow from 10.0.0.0/8` with `Allow from all`
256      * (Apache 2.4): Replace `Require host 10.0.0.0/8` with `Require all granted`
257   b. (Fedora): Change references from the non-existent `/etc/apache2/` directory
258      to `/etc/httpd/`.
259 4. Change the user for the Apache server.
260   * (Debian and Ubuntu): As the *root* Linux account, edit
261     `/etc/apache2/envvars`.  Change `export APACHE_RUN_USER=www-data` to 
262     `export APACHE_RUN_USER=opensrf`.
263   * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`.
264     Change `User apache` to `User opensrf`.
265 5. Configure Apache with performance settings appropriate for Evergreen:
266   * (Debian and Ubuntu): As the *root* Linux account, edit
267     `/etc/apache2/apache2.conf`:
268   * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
269     a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
270        a request timing out unexpectedly, but increase the risk of using up
271        all available Apache child processes.
272     b. 'Optional': Change `MaxKeepAliveRequests` to `100`
273     c. Update the prefork configuration section to suit your environment. The
274        following settings apply to a busy system:
275 +
276 [source,bash]
277 ------------------------------------------------------------------------------
278 <IfModule mpm_prefork_module>
279    StartServers           20
280    MinSpareServers         5
281    MaxSpareServers        15
282    MaxClients            150
283    MaxRequestsPerChild 10000
284 </IfModule>
285 ------------------------------------------------------------------------------
286 +
287 6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf`
288    file to change references from the non-existent `/etc/apache2/` directory
289    to `/etc/httpd/`.
290 7. (Debian and Ubuntu): As the *root* Linux account, enable the Evergreen site:
291 +
292 [source,bash]
293 ------------------------------------------------------------------------------
294 a2dissite default  # OPTIONAL: disable the default site (the "It Works" page)
295 a2ensite eg.conf
296 ------------------------------------------------------------------------------
297
298 Configure OpenSRF for the Evergreen application
299 -----------------------------------------------
300 There are a number of example OpenSRF configuration files in `/openils/conf/`
301 that you can use as a template for your Evergreen installation. Issue the
302 following commands as the *opensrf* Linux account:
303
304 [source, bash]
305 ------------------------------------------------------------------------------
306 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
307 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
308 ------------------------------------------------------------------------------
309
310 When you installed OpenSRF, you created four Jabber users on two
311 separate domains and edited the `opensrf_core.xml` file accordingly. Please
312 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
313 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
314 and domains as you used while installing and testing OpenSRF.
315
316 [NOTE]
317 The `-b` flag tells the `cp` command to create a backup version of the
318 destination file. The backup version of the destination file has a tilde (`~`)
319 appended to the file name, so if you have forgotten the Jabber users and
320 domains, you can retrieve the settings from the backup version of the files.
321
322 `eg_db_config`, described in the following section, sets the database
323 connection information in `opensrf.xml` for you.
324
325 Creating the Evergreen database
326 -------------------------------
327
328 By default, the `Makefile.install` prerequisite installer does not install
329 the PostgreSQL 9 database server required by every Evergreen system;
330 for production use, most libraries install the PostgreSQL database server on a
331 dedicated machine. You can install the packages required by Debian or Ubuntu Lucid
332 on the machine of your choice using the following commands as the *root*
333 Linux account:
334
335 .(Debian and Ubuntu Lucid) Installing PostgreSQL 9.1 server packages
336 [source, bash]
337 ------------------------------------------------------------------------------
338 make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_backport_debs_91
339 ------------------------------------------------------------------------------
340
341 .(Ubuntu Precise) Installing PostgreSQL 9.1 server packages
342 [source, bash]
343 ------------------------------------------------------------------------------
344 make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_91
345 ------------------------------------------------------------------------------
346
347 You can install the packages required by Fedora on the machine of your choice
348 using the following commands as the *root* Linux account:
349
350 .(Fedora) Installing PostgreSQL server packages
351 [source, bash]
352 ------------------------------------------------------------------------------
353 make -f Open-ILS/src/extras/Makefile.install install_fedora_pgsql_server
354 postgresql-setup initdb
355 ------------------------------------------------------------------------------
356
357 For a standalone PostgreSQL server, install the following Perl modules as the
358 *root* Linux account:
359
360 .(Debian / Ubuntu) Installing additional Perl modules on a standalone PostgreSQL 9 server
361 [source, bash]
362 ------------------------------------------------------------------------------
363 aptitude install gcc libxml-libxml-perl libxml-libxslt-perl
364 cpan Business::ISBN
365 cpan JSON::XS
366 cpan Library::CallNumber::LC
367 cpan MARC::Record
368 cpan MARC::File::XML
369 cpan UUID::Tiny
370 cpan Rose::URI
371 ------------------------------------------------------------------------------
372
373 .(Fedora) Installing additional Perl modules on a standalone PostgreSQL 9 server
374 [source, bash]
375 ------------------------------------------------------------------------------
376 yum install gcc perl-XML-LibXML perl-XML-LibXSLT perl-Business-ISBN
377 cpan Library::CallNumber::LC
378 cpan MARC::Record
379 cpan MARC::File::XML
380 cpan UUID::Tiny
381 ------------------------------------------------------------------------------
382
383 You need to create a PostgreSQL superuser to create and access the database.
384 Issue the following command as the *postgres* Linux account to create a new
385 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
386 password:
387
388 [source, bash]
389 ------------------------------------------------------------------------------
390 createuser -s -P evergreen
391 ------------------------------------------------------------------------------
392
393 Once you have created the *evergreen* PostgreSQL account, you also need to
394 create the database and schema, and configure your configuration files to point
395 at the database server. Issue the following command as the *root* Linux account
396 from inside the Evergreen source directory, replacing <user>, <password>,
397 <hostname>, <port>, and <dbname> with the appropriate values for your
398 PostgreSQL database (where <user> and <password> are for the *evergreen*
399 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
400 with the values you want for the *egadmin* Evergreen administrator account:
401
402 [source, bash]
403 ------------------------------------------------------------------------------
404 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
405        --service all --create-database --create-schema --create-offline \
406        --user <user> --password <password> --hostname <hostname> --port <port> \
407        --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
408 ------------------------------------------------------------------------------
409
410 This creates the database and schema and configures all of the services in
411 your `/openils/conf/opensrf.xml` configuration file to point to that database.
412 It also creates the configuration files required by the Evergreen `cgi-bin`
413 administration scripts, and sets the user name and password for the *egadmin*
414 Evergreen administrator account to your requested values.
415
416 Creating the database on a remote server
417 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
418 In a production instance of Evergreen, your PostgreSQL server should be
419 installed on a dedicated server.
420
421 PostgreSQL 9.1 and later
422 ^^^^^^^^^^^^^^^^^^^^^^^^
423 To create the database instance on a remote database server running PostgreSQL
424 9.1 or later, simply use the `--create-database` flag on `eg_db_config`.
425
426 Starting Evergreen
427 ------------------
428 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
429 (if they aren't already running):
430 +
431 [source, bash]
432 ------------------------------------------------------------------------------
433 /etc/init.d/ejabberd start
434 /etc/init.d/memcached start
435 ------------------------------------------------------------------------------
436 +
437 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
438 following command is only necessary if you want to force Evergreen to treat the
439 hostname as `localhost`; if you configured `opensrf.xml` using the real
440 hostname of your machine as returned by `perl -ENet::Domain 'print
441 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
442 +
443 [source, bash]
444 ------------------------------------------------------------------------------
445 osrf_ctl.sh -l -a start_all
446 ------------------------------------------------------------------------------
447 +
448   ** If you receive the error message `bash: osrf_ctl.sh: command not found`,
449      then your environment variable `PATH` does not include the `/openils/bin`
450      directory; this should have been set in the *opensrf* Linux account's
451      `.bashrc` configuration file. To manually set the `PATH` variable, edit the
452      configuration file `~/.bashrc` as the *opensrf* Linux account and add the
453      following line:
454 +
455 [source, bash]
456 ------------------------------------------------------------------------------
457 export PATH=$PATH:/openils/bin
458 ------------------------------------------------------------------------------
459 +
460 3. As the *opensrf* Linux account, generate the Web files needed by the staff
461    client and catalogue and update the organization unit proximity (you need to do
462    this the first time you start Evergreen, and after that each time you change
463    the library hierarchy in `config.cgi`):
464 +
465 [source, bash]
466 ------------------------------------------------------------------------------
467 autogen.sh -u
468 ------------------------------------------------------------------------------
469 +
470 4. As the *root* Linux account, restart the Apache Web server:
471 +
472 [source, bash]
473 ------------------------------------------------------------------------------
474 /etc/init.d/apache2 restart
475 ------------------------------------------------------------------------------
476 +
477 If the Apache Web server was running when you started the OpenSRF services, you
478 might not be able to successfully log in to the OPAC or staff client until the
479 Apache Web server is restarted.
480
481 Testing connections to Evergreen
482 --------------------------------
483
484 Once you have installed and started Evergreen, test your connection to
485 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
486 commands to start `srfsh` and try to log onto the Evergreen server using the
487 *egadmin* Evergreen administrator user name and password that you set using the
488 `eg_db_config` command:
489
490 [source, bash]
491 ------------------------------------------------------------------------------
492 /openils/bin/srfsh
493 srfsh% login <admin-user> <admin-pass>
494 ------------------------------------------------------------------------------
495
496 You should see a result like:
497
498     Received Data: "250bf1518c7527a03249858687714376"
499     ------------------------------------
500     Request Completed Successfully
501     Request Time in seconds: 0.045286
502     ------------------------------------
503
504     Received Data: {
505        "ilsevent":0,
506        "textcode":"SUCCESS",
507        "desc":" ",
508        "pid":21616,
509        "stacktrace":"oils_auth.c:304",
510        "payload":{
511           "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
512           "authtime":420
513        }
514
515     }
516
517     ------------------------------------
518     Request Completed Successfully
519     Request Time in seconds: 1.336568
520     ------------------------------------
521
522 If this does not work, it's time to do some troubleshooting.
523
524   * As the *opensrf* Linux acccount, run the `settings-tester.pl` script to see
525     if it finds any system configuration problems. The script is found at
526     `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
527     tree.
528   * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
529   * If you have faithfully followed the entire set of installation steps
530     listed here, you are probably extremely close to a working system.
531     Gather your configuration files and log files and contact the
532     http://open-ils.org/listserv.php[Evergreen development mailing list]
533     for assistance before making any drastic changes to your system
534     configuration.
535
536 Getting help
537 ------------
538
539 Need help installing or using Evergreen? Join the mailing lists at
540 http://evergreen-ils.org/listserv.php or contact us on the Freenode
541 IRC network on the #evergreen channel.
542
543 License
544 -------
545 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
546 Unported License. To view a copy of this license, visit
547 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
548 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.