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