Bootstrap via "autoreconf -f -i" instead of "autogen.sh"
[working/Evergreen.git] / README
1 README for Evergreen master
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 -f -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.0 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 16 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`, `fedora16`, `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 ./configure --prefix=/openils --sysconfdir=/openils/conf
151 make
152 ------------------------------------------------------------------------------
153
154 Installation instructions
155 -------------------------
156
157 1. Once you have configured and compiled Evergreen, issue the following
158    command as the *root* Linux account to install Evergreen, build the server
159    portion of the staff client, and copy example configuration files to
160    `/openils/conf`.
161    Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version
162    of the staff client that you will use to connect to the Evergreen server.
163 +
164 [source, bash]
165 ------------------------------------------------------------------------------
166 make STAFF_CLIENT_STAMP_ID=rel_name install
167 ------------------------------------------------------------------------------
168 +
169 2. The server portion of the staff client expects `http://hostname/xul/server`
170    to resolve. Issue the following commands as the *root* Linux account to
171    create a symbolic link pointing to the `server` subdirectory of the server
172    portion of the staff client that we just built using the staff client ID
173    'rel_name':
174 +
175 [source, bash]
176 ------------------------------------------------------------------------------
177 cd /openils/var/web/xul
178 ln -sf rel_name/server server
179 ------------------------------------------------------------------------------
180
181 Change ownership of the Evergreen files
182 ---------------------------------------
183
184 All files in the `/openils/` directory and subdirectories must be owned by the
185 `opensrf` user. Issue the following command as the *root* Linux account to
186 change the ownership on the files:
187
188 [source, bash]
189 ------------------------------------------------------------------------------
190 chown -R opensrf:opensrf /openils
191 ------------------------------------------------------------------------------
192
193 Configure the Apache Web server
194 -------------------------------
195
196 1. Use the example configuration files in `Open-ILS/examples/apache/` to
197 configure your Web server for the Evergreen catalog, staff client, Web
198 services, and administration interfaces. Issue the following commands as the
199 *root* Linux account:
200 +
201 .Debian and Ubuntu
202 [source,bash]
203 ------------------------------------------------------------------------------
204 cp Open-ILS/examples/apache/eg.conf       /etc/apache2/sites-available/
205 cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
206 cp Open-ILS/examples/apache/startup.pl    /etc/apache2/
207 # Now set up SSL
208 mkdir /etc/apache2/ssl
209 cd /etc/apache2/ssl
210 ------------------------------------------------------------------------------
211 +
212 .Fedora
213 [source,bash]
214 ------------------------------------------------------------------------------
215 cp Open-ILS/examples/apache/eg.conf       /etc/httpd/conf.d/
216 cp Open-ILS/examples/apache/eg_vhost.conf /etc/httpd/
217 cp Open-ILS/examples/apache/startup.pl    /etc/httpd/
218 # Now set up SSL
219 mkdir /etc/httpd/ssl
220 cd /etc/httpd/ssl
221 ------------------------------------------------------------------------------
222 +
223 2. The `openssl` command cuts a new SSL key for your Apache server. For a
224 production server, you should purchase a signed SSL certificate, but you can
225 just use a self-signed certificate and accept the warnings in the staff client
226 and browser during testing and development. Create an SSL key for the Apache
227 server by issuing the following command as the *root* Linux account:
228 +
229 [source,bash]
230 ------------------------------------------------------------------------------
231 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
232 ------------------------------------------------------------------------------
233 +
234 3. As the *root* Linux account, edit the `eg.conf` file that you copied into
235 place.
236   a. Replace `Allow from 10.0.0.0/8` with `Allow from all` (to enable
237      access to the offline upload / execute interface from any workstation on
238      any network - note that you must secure this for a production instance)
239   b. (Fedora): Change references from the non-existent `/etc/apache2/` directory
240      to `/etc/httpd/`.
241 4. Change the user for the Apache server.
242   * (Debian and Ubuntu): As the *root* Linux account, edit
243     `/etc/apache2/envvars`.  Change `export APACHE_RUN_USER=www-data` to 
244     `export APACHE_RUN_USER=opensrf`.
245   * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`.
246     Change `User apache` to `User opensrf`.
247 5. Configure Apache with performance settings appropriate for Evergreen:
248   * (Debian and Ubuntu): As the *root* Linux account, edit
249     `/etc/apache2/apache2.conf`:
250   * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
251     a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
252        a request timing out unexpectedly, but increase the risk of using up
253        all available Apache child processes.
254     b. 'Optional': Change `MaxKeepAliveRequests` to `100`
255     c. Update the prefork configuration section to suit your environment. The
256        following settings apply to a busy system:
257 +
258 [source,bash]
259 ------------------------------------------------------------------------------
260 <IfModule mpm_prefork_module>
261    StartServers           20
262    MinSpareServers         5
263    MaxSpareServers        15
264    MaxClients            150
265    MaxRequestsPerChild 10000
266 </IfModule>
267 ------------------------------------------------------------------------------
268 +
269 6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf`
270    file to change references from the non-existent `/etc/apache2/` directory
271    to `/etc/httpd/`.
272 7. (Debian and Ubuntu): As the *root* Linux account, enable the Evergreen site:
273 +
274 [source,bash]
275 ------------------------------------------------------------------------------
276 a2dissite default  # OPTIONAL: disable the default site (the "It Works" page)
277 a2ensite eg.conf
278 ------------------------------------------------------------------------------
279
280 Configure OpenSRF for the Evergreen application
281 -----------------------------------------------
282 There are a number of example OpenSRF configuration files in `/openils/conf/`
283 that you can use as a template for your Evergreen installation. Issue the
284 following commands as the *opensrf* Linux account:
285
286 [source, bash]
287 ------------------------------------------------------------------------------
288 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
289 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
290 ------------------------------------------------------------------------------
291
292 When you installed OpenSRF, you created four Jabber users on two
293 separate domains and edited the `opensrf_core.xml` file accordingly. Please
294 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
295 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
296 and domains as you used while installing and testing OpenSRF.
297
298 [NOTE]
299 The `-b` flag tells the `cp` command to create a backup version of the
300 destination file. The backup version of the destination file has a tilde (`~`)
301 appended to the file name, so if you have forgotten the Jabber users and
302 domains, you can retrieve the settings from the backup version of the files.
303
304 `eg_db_config.pl`, described in the following section, sets the database
305 connection information in `opensrf.xml` for you.
306
307 Creating the Evergreen database
308 -------------------------------
309
310 By default, the `Makefile.install` prerequisite installer does not install
311 the PostgreSQL 9 database server required by every Evergreen system;
312 for production use, most libraries install the PostgreSQL database server on a
313 dedicated machine. You can install the packages required by Debian or Ubuntu Lucid
314 on the machine of your choice using the following commands as the *root*
315 Linux account:
316
317 .(Debian and Ubuntu Lucid) Installing PostgreSQL 9.1 server packages
318 [source, bash]
319 ------------------------------------------------------------------------------
320 make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_backport_debs_91
321 ------------------------------------------------------------------------------
322
323 .(Ubuntu Precise) Installing PostgreSQL 9.1 server packages
324 [source, bash]
325 ------------------------------------------------------------------------------
326 make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_91
327 ------------------------------------------------------------------------------
328
329 You can install the packages required by Fedora on the machine of your choice
330 using the following commands as the *root* Linux account:
331
332 .(Fedora 16) Installing PostgreSQL server packages
333 [source, bash]
334 ------------------------------------------------------------------------------
335 make -f Open-ILS/src/extras/Makefile.install install_fedora_pgsql_server
336 postgresql-setup initdb
337 ------------------------------------------------------------------------------
338
339 For a standalone PostgreSQL server, install the following Perl modules as the
340 *root* Linux account:
341
342 .(Debian / Ubuntu) Installing additional Perl modules on a standalone PostgreSQL 9 server
343 [source, bash]
344 ------------------------------------------------------------------------------
345 aptitude install gcc libxml-libxml-perl libxml-libxslt-perl
346 cpan Business::ISBN
347 cpan JSON::XS
348 cpan Library::CallNumber::LC
349 cpan MARC::Record
350 cpan MARC::File::XML
351 cpan UUID::Tiny
352 ------------------------------------------------------------------------------
353
354 .(Fedora 16) Installing additional Perl modules on a standalone PostgreSQL 9 server
355 [source, bash]
356 ------------------------------------------------------------------------------
357 yum install gcc perl-XML-LibXML perl-XML-LibXSLT perl-Business-ISBN
358 cpan Library::CallNumber::LC
359 cpan MARC::Record
360 cpan MARC::File::XML
361 cpan UUID::Tiny
362 ------------------------------------------------------------------------------
363
364 You need to create a PostgreSQL superuser to create and access the database.
365 Issue the following command as the *postgres* Linux account to create a new
366 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
367 password:
368
369 [source, bash]
370 ------------------------------------------------------------------------------
371 createuser -s -P evergreen
372 ------------------------------------------------------------------------------
373
374 Once you have created the *evergreen* PostgreSQL account, you also need to
375 create the database and schema, and configure your configuration files to point
376 at the database server. Issue the following command as the *root* Linux account
377 from inside the Evergreen source directory, replacing <user>, <password>,
378 <hostname>, <port>, and <dbname> with the appropriate values for your
379 PostgreSQL database (where <user> and <password> are for the *evergreen*
380 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
381 with the values you want for the *egadmin* Evergreen administrator account:
382
383 [source, bash]
384 ------------------------------------------------------------------------------
385 perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \
386        --service all --create-database --create-schema --create-offline \
387        --user <user> --password <password> --hostname <hostname> --port <port> \
388        --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
389 ------------------------------------------------------------------------------
390
391 This creates the database and schema and configures all of the services in
392 your `/openils/conf/opensrf.xml` configuration file to point to that database.
393 It also creates the configuration files required by the Evergreen `cgi-bin`
394 administration scripts, and sets the user name and password for the *egadmin*
395 Evergreen administrator account to your requested values.
396
397 Creating the database on a remote server
398 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
399 In a production instance of Evergreen, your PostgreSQL server should be
400 installed on a dedicated server.
401
402 PostgreSQL 9.1 and later
403 ^^^^^^^^^^^^^^^^^^^^^^^^
404 To create the database instance on a remote database server running PostgreSQL
405 9.1 or later, simply use the `--create-database` flag on `eg_db_config.pl`.
406
407 For PostgreSQL 9.0
408 ^^^^^^^^^^^^^^^^^^
409 To create the database instance on a remote database server running PostgreSQL
410 9.0, you can either:
411
412   *  Install the PostgreSQL contrib modules on the machine on which you
413      are installing the Evergreen code, and use the `--create-database`
414      option from that machine, or
415   *  Copy the `Open-ILS/src/sql/Pg/create_database.sql` script to your
416      PostgreSQL server and invoke it as the *postgres* Linux account:
417 +
418 [source, bash]
419 ------------------------------------------------------------------------------
420 psql -vdb_name=<dbname> -vcontrib_dir=`pg_config --sharedir`/contrib -f create_database.sql
421 ------------------------------------------------------------------------------
422
423 Then you can issue the `eg_db_config.pl` command as above _without_ the
424 `--create-database` argument to create your schema and configure your
425 configuration files.
426
427 Starting Evergreen
428 ------------------
429 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
430 (if they aren't already running):
431 +
432 [source, bash]
433 ------------------------------------------------------------------------------
434 /etc/init.d/ejabberd start
435 /etc/init.d/memcached start
436 ------------------------------------------------------------------------------
437 +
438 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
439 following command is only necessary if you want to force Evergreen to treat the
440 hostname as `localhost`; if you configured `opensrf.xml` using the real
441 hostname of your machine as returned by `perl -ENet::Domain 'print
442 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
443 +
444 [source, bash]
445 ------------------------------------------------------------------------------
446 osrf_ctl.sh -l -a start_all
447 ------------------------------------------------------------------------------
448 +
449   ** If you receive the error message `bash: osrf_ctl.sh: command not found`,
450      then your environment variable `PATH` does not include the `/openils/bin`
451      directory; this should have been set in the *opensrf* Linux account's
452      `.bashrc` configuration file. To manually set the `PATH` variable, edit the
453      configuration file `~/.bashrc` as the *opensrf* Linux account and add the
454      following line:
455 +
456 [source, bash]
457 ------------------------------------------------------------------------------
458 export PATH=$PATH:/openils/bin
459 ------------------------------------------------------------------------------
460 +
461 3. As the *opensrf* Linux account, generate the Web files needed by the staff
462    client and catalogue and update the organization unit proximity (you need to do
463    this the first time you start Evergreen, and after that each time you change
464    the library hierarchy in `config.cgi`):
465 +
466 [source, bash]
467 ------------------------------------------------------------------------------
468 autogen.sh -u
469 ------------------------------------------------------------------------------
470 +
471 4. As the *root* Linux account, restart the Apache Web server:
472 +
473 [source, bash]
474 ------------------------------------------------------------------------------
475 /etc/init.d/apache2 restart
476 ------------------------------------------------------------------------------
477 +
478 If the Apache Web server was running when you started the OpenSRF services, you
479 might not be able to successfully log in to the OPAC or staff client until the
480 Apache Web server is restarted.
481
482 Testing connections to Evergreen
483 --------------------------------
484
485 Once you have installed and started Evergreen, test your connection to
486 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
487 commands to start `srfsh` and try to log onto the Evergreen server using the
488 *egadmin* Evergreen administrator user name and password that you set using the
489 `eg_db_config.pl` command:
490
491 [source, bash]
492 ------------------------------------------------------------------------------
493 /openils/bin/srfsh
494 srfsh% login <admin-user> <admin-pass>
495 ------------------------------------------------------------------------------
496
497 You should see a result like:
498
499     Received Data: "250bf1518c7527a03249858687714376"
500     ------------------------------------
501     Request Completed Successfully
502     Request Time in seconds: 0.045286
503     ------------------------------------
504
505     Received Data: {
506        "ilsevent":0,
507        "textcode":"SUCCESS",
508        "desc":" ",
509        "pid":21616,
510        "stacktrace":"oils_auth.c:304",
511        "payload":{
512           "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
513           "authtime":420
514        }
515
516     }
517
518     ------------------------------------
519     Request Completed Successfully
520     Request Time in seconds: 1.336568
521     ------------------------------------
522
523 If this does not work, it's time to do some troubleshooting.
524
525   * As the *opensrf* Linux acccount, run the `settings-tester.pl` script to see
526     if it finds any system configuration problems. The script is found at
527     `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
528     tree.
529   * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
530   * If you have faithfully followed the entire set of installation steps
531     listed here, you are probably extremely close to a working system.
532     Gather your configuration files and log files and contact the
533     http://open-ils.org/listserv.php[Evergreen development mailing list]
534     for assistance before making any drastic changes to your system
535     configuration.
536
537 Getting help
538 ------------
539
540 Need help installing or using Evergreen? Join the mailing lists at
541 http://evergreen-ils.org/listserv.php or contact us on the Freenode
542 IRC network on the #evergreen channel.
543
544 License
545 -------
546 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
547 Unported License. To view a copy of this license, visit
548 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
549 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.