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